Cmdlets for Workday

Build 24.0.9060

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 Supported for: SELECT. A description of the instance
AcademicPeriod_Href String Supported for: SELECT. A link to the instance
AcademicPeriod_Id String Supported for: SELECT. wid / id / reference id
AcademicRecord_Descriptor String Supported for: SELECT. A description of the instance
AcademicRecord_Href String Supported for: SELECT. A link to the instance
AcademicRecord_Id String Supported for: SELECT. wid / id / reference id
FederalSchoolCodeRuleSet_Descriptor String Supported for: SELECT. A description of the instance
FederalSchoolCodeRuleSet_Href String Supported for: SELECT. A link to the instance
FederalSchoolCodeRuleSet_Id String Supported for: SELECT. wid / id / reference id
FinancialAidAwardYear_Descriptor String Supported for: SELECT. A description of the instance
FinancialAidAwardYear_Href String Supported for: SELECT. A link to the instance
FinancialAidAwardYear_Id String Supported for: SELECT. wid / id / reference id
HoldType_Descriptor String Supported for: SELECT. A preview of the instance
HoldType_Id String Supported for: SELECT. Id of the instance
Institution_Descriptor String Supported for: SELECT. A description of the instance
Institution_Href String Supported for: SELECT. A link to the instance
Institution_Id String Supported for: SELECT. wid / id / reference id
HoldType_Prompt String Accepts multiple inputs. 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 Only used when a Students_Id filter is not provided. Accepts multiple inputs. No description available.
AcademicUnit_Prompt String Only used when a Students_Id filter is not provided. Accepts multiple inputs. Derived Academic Units.
ActiveOnly_Prompt Bool Only used when a Students_Id filter is not provided. Only return active students.
ProgramOfStudy_Prompt String Only used when a Students_Id filter is not provided. Accepts multiple inputs. 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 Only used when a Students_Id filter is not provided. A fuzzy search string that matches student IDs and names. Example: search=bri%20book returns the student Brian Booker.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060