StudentsHolds
DEPRECATED. Retrieves a collection of student holds assigned to the specified student ID.
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 |
Id [KEY] | String | Id of the instance |
Students_Id [KEY] | String | The Workday ID of the Students that owns this. |
CreatedBy | String | The user who assigned the hold. |
CreatedOn | Datetime | Date the Hold was created. |
Descriptor | String | A preview of the instance |
OverrideEvent_AppliedOn | Datetime | The Date the Hold Override was placed. |
OverrideEvent_CreatedBy | String | The person who applied the override. |
OverrideEvent_EndDate | Datetime | The date the override ends. |
OverrideEvent_Id | String | Id of the instance |
OverrideEvent_StartDate | Datetime | The date the override starts. |
Reason_Description | String | The description of the hold reason. |
Reason_Descriptor | String | A preview of the instance |
Reason_Id | String | Id of the instance |
Reason_ResolutionInstructions | String | The resolution instructions defined for this hold reason. |
RemovedOn | Datetime | Date when the Hold will be removed from the Student. |
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. |