Cmdlets for Workday

Build 24.0.9060

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 Supported for: SELECT. The user who assigned the hold.
CreatedOn Datetime Supported for: SELECT. Date the Hold was created.
Descriptor String Supported for: SELECT. A preview of the instance
OverrideEvent_AppliedOn Datetime Supported for: SELECT. The Date the Hold Override was placed.
OverrideEvent_CreatedBy String Supported for: SELECT. The person who applied the override.
OverrideEvent_EndDate Datetime Supported for: SELECT. The date the override ends.
OverrideEvent_Id String Supported for: SELECT. Id of the instance
OverrideEvent_StartDate Datetime Supported for: SELECT. The date the override starts.
Reason_Description String Supported for: SELECT. The description of the hold reason.
Reason_Descriptor String Supported for: SELECT. A preview of the instance
Reason_Id String Supported for: SELECT. Id of the instance
Reason_ResolutionInstructions String Supported for: SELECT. The resolution instructions defined for this hold reason.
RemovedOn Datetime Supported for: SELECT. Date when the Hold will be removed from the Student.
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