DEPRECATED. Managed student holds assigned to specific student IDs.

Workday Resource Information

Retrieves a collection of student holds assigned to the specified student ID. This method also returns the student hold reasons and the processes that the holds apply to. You can filter student holds by their hold reason (exact match), hold type (any in common), and whether or not the hold is inactive.

DEPRECATED as of 2024-04-05. Workday recommends that you use the holds resource in the studentCore REST service instead.

Secured by: Manage: Holds, Self-Service: Holds

Scope: Action Items and Holds

Columns

Name	Type	Description
Id [KEY]	String	Unique identifier for this instance.
Students_Id [KEY]	String	Workday-generated unique ID linking this record to the associated student.
CreatedBy	String	The user who assigned the hold to the student.
CreatedOn	Datetime	The date when the hold was created.
Descriptor	String	A brief, human-readable summary of the instance.
OverrideEvent_AppliedOn	Datetime	The date when the hold override was applied.
OverrideEvent_CreatedBy	String	The user who applied the hold override.
OverrideEvent_EndDate	Datetime	The date when the hold override expires.
OverrideEvent_Id	String	Unique identifier for the hold override event.
OverrideEvent_StartDate	Datetime	The date when the hold override becomes active.
Reason_Description	String	A detailed description of the reason for the hold.
Reason_Descriptor	String	A brief, human-readable summary of the hold reason.
Reason_Id	String	Unique identifier for the hold reason.
Reason_ResolutionInstructions	String	Instructions for resolving the hold, as defined by the institution.
RemovedOn	Datetime	The date when the hold will be removed from the student's record.
HoldType_Prompt	String	Filter to retrieve holds that match the specified hold types.
Reason_Prompt	String	Filter to retrieve holds that match the specified hold reason.
ShowInactive_Prompt	Bool	If true, returns both active and inactive holds; if false, returns only active holds.
AcademicLevel_Prompt	String	Reference prompt for selecting an academic level associated with the student.
AcademicUnit_Prompt	String	Reference prompt for selecting an academic unit associated with the student.
ActiveOnly_Prompt	Bool	If true, returns only active students.
ProgramOfStudy_Prompt	String	For non-matriculated students, the program they applied to or were admitted to; for matriculated students, their primary program of study.
Search_Prompt	String	A search string that performs fuzzy matching on student IDs and names. Example: 'bri%20book' returns the student Brian Booker.