Links student holds to their respective type contexts.

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
StudentsHolds_Id	String	Workday-generated unique ID linking this record to a specific student hold instance.
Students_Id	String	Workday-generated unique ID linking this record to the associated student.
AcademicPeriod_Descriptor	String	A human-readable description of the academic period.
AcademicPeriod_Href	String	A URL or reference link to the academic period instance.
AcademicPeriod_Id	String	Unique identifier associated with the academic period.
AcademicRecord_Descriptor	String	A brief description of the student's academic record.
AcademicRecord_Href	String	A URL or reference link to the academic record instance.
AcademicRecord_Id	String	Unique identifier associated with the academic record.
FederalSchoolCodeRuleSet_Descriptor	String	A description of the federal school code rule set applied to the student.
FederalSchoolCodeRuleSet_Href	String	A URL or reference link to the federal school code rule set instance.
FederalSchoolCodeRuleSet_Id	String	Unique identifier associated with the federal school code rule set.
FinancialAidAwardYear_Descriptor	String	A description of the financial aid award year.
FinancialAidAwardYear_Href	String	A URL or reference link to the financial aid award year instance.
FinancialAidAwardYear_Id	String	Unique identifier associated with the financial aid award year.
HoldType_Descriptor	String	A brief, human-readable summary of the hold type.
HoldType_Id	String	Unique identifier for the hold type instance.
Institution_Descriptor	String	A description of the institution associated with the student's record.
Institution_Href	String	A URL or reference link to the institution instance.
Institution_Id	String	Unique identifier associated with the institution.
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.