Get Term List Action

A field marked with an asterisk "*" indicates the field is a required input for this action.

This action returns a list of objects of which each is a term.

This action can be used as input for actions that require term information.

Input Fields

Field Description

Registration

The registration status for the academic period.

Options include "All", "Open" and "Closed". Selecting one of these will filter the results by the selected option. The "All" option will return all terms.

This input is optional.

  • If this input is added and left blank, the input value will be treated as an empty string. In this case, workflow will not pass input validation since an empty string is not a valid option.
  • If this input is added and passed with an empty token, an empty result will be returned.
  • If this input is not added, the action will return all terms.

Output Fields

This action may return multiple results.

Field Description

Term ID (Value)

The Guid identifier of the academic term.

This field is best used as the value for a term drop-down.

Title

The full name of an academic term (for example, 'Fall 2014').

This field is best used as the display for a term drop-down.

Code

A unique identifier for an academic period.

Registration

The registration status for the academic period. The value can be open or closed.

If this field has been selected as the dropdown display value, there will be an issue with the dropdown due to duplicate display values.

Start On

The date the term under the Student Term starts/started (for example, ‘2015-01-05T00:00:00+00:00’)

End On

The date the term under the Student Term ends/ended (for example, ‘2016-01-05T00:00:00+00:00’)

Note: The results will be sorted by Code in descending order.