HoldsReasonsValuesHoldType
Reads /holdType entries from the HoldsReasonsValues table.
Workday Resource Information
All of the active hold reasons, optionally filtered by student and academic unit query parms. Call these endpoints for valid filter values:- GET /values/holds/reasons?student={id}
- GET /values/holds/reasons?academicUnit={id}
- GET /values/holds/reasons?student={id}&academicUnit={id}
Columns
| Name | Type | Description |
| Id [KEY] | String | Id of the instance |
| HoldsReasonsValues_Id [KEY] | String | The Workday ID of the HoldsReasonsValues that contains this. |
| Descriptor | String | The display name of the instance |
| ValidForAcademicPeriod | Bool | If true, the academic period context is valid for this hold type. |
| ValidForAcademicRecord | Bool | If true, the academic record context is valid for this hold type. |
| ValidForAppliesToAll | Bool | If true, the applies to all context is valid for this hold type. |
| ValidForAwardItem | Bool | If true, the financial aid award year context is valid for this hold type. |
| ValidForAwardYear | Bool | If true, the financial aid award year context is valid for this hold type. |
| ValidForFederalSchoolCode | Bool | If true, the federal school code context is valid for this hold type. |
| ValidForInstitution | Bool | If true, the institution context is valid for this hold type. |
| AcademicRecord_Prompt | String | The academic record of the student the hold applies to. |
| AcademicUnit_Prompt | String | The academic unit of the hold reason. |
| Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
| Reason_Prompt | String | The hold reason for the hold. |
| Student_Prompt | String | The student to apply the hold to. |