StudentsHoldsTypeContexts
Reads /typeContexts entries from the StudentsHolds table.
Workday Resource Information
Retrieves a student hold assigned to the specified student ID.Secured by: Manage: Holds, Self-Service: Holds
Scope: Action Items and Holds
Columns
| Name | Type | Description |
| StudentsHolds_Id [KEY] | String | The Workday ID of the StudentsHolds that contains this. |
| Students_Id [KEY] | String | The Workday ID of the Students that owns this. |
| AcademicPeriod_Descriptor | String | A description of the instance |
| AcademicPeriod_Href | String | A link to the instance |
| AcademicPeriod_Id | String | wid / id / reference id |
| AcademicRecord_Descriptor | String | A description of the instance |
| AcademicRecord_Href | String | A link to the instance |
| AcademicRecord_Id | String | wid / id / reference id |
| FederalSchoolCodeRuleSet_Descriptor | String | A description of the instance |
| FederalSchoolCodeRuleSet_Href | String | A link to the instance |
| FederalSchoolCodeRuleSet_Id | String | wid / id / reference id |
| FinancialAidAwardYear_Descriptor | String | A description of the instance |
| FinancialAidAwardYear_Href | String | A link to the instance |
| FinancialAidAwardYear_Id | String | wid / id / reference id |
| HoldType_Descriptor | String | A preview of the instance |
| HoldType_Id | String | Id of the instance |
| Institution_Descriptor | String | A description of the instance |
| Institution_Href | String | A link to the instance |
| Institution_Id | String | wid / id / reference id |
| HoldType_Prompt | String | Filter for holds matching these hold types. |
| Reason_Prompt | String | Filter for holds matching this hold reason. |
| ShowInactive_Prompt | Bool | Parameter that will include inactive holds along with the active ones. |
| AcademicLevel_Prompt | String | |
| AcademicUnit_Prompt | String | Derived Academic Units. |
| ActiveOnly_Prompt | Bool | Only return active students. |
| ProgramOfStudy_Prompt | String | For students who haven't matriculated, the program of study they either applied to or have been admitted to. For matriculated students, the primary program of study from their reporting record. |
| Search_Prompt | String | A fuzzy search string that matches student IDs and names. Example: search=bri%20book returns the student Brian Booker. |