StudentsApplyHold

Creates an Apply Student Hold Event.

Workday Resource Information

Creates a single Apply Student Hold Event instance with the specified data. In the request body, specify these required fields: reason, typeContext.

Secured by: Apply Student Hold (REST Service)+TG

Scope: Action Items and Holds

Aggregate Fields

The cmdlet represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.

This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.

TypeContext_Aggregate

[{
  academicPeriod: { /* The academic period of the student hold type context. */
     -descriptor: Text /* A description of the instance */
     -href: Text /* A link to the instance */
     *id: Text /* wid / id / reference id */
  }
  academicRecord: { /* The academic record of the student hold type context. */
     -descriptor: Text /* A description of the instance */
     -href: Text /* A link to the instance */
     *id: Text /* wid / id / reference id */
  }
  descriptor: Text /* A preview of the instance */
  federalSchoolCode: { /* The Federal school code of the student hold type context. */
     -descriptor: Text /* A description of the instance */
     -href: Text /* A link to the instance */
     *id: Text /* wid / id / reference id */
  }
  financialAidAwardYear: { /* The financial aid award year of the student hold type context. */
     -descriptor: Text /* A description of the instance */
     -href: Text /* A link to the instance */
     *id: Text /* wid / id / reference id */
  }
  holdType: { /* The hold type of the student hold type context. */
     -descriptor: Text /* A description of the instance */
     -href: Text /* A link to the instance */
     *id: Text /* wid / id / reference id */
  }
  id: Text /* Id of the instance */
  institution: { /* The institution of the student hold type context. */
     -descriptor: Text /* A description of the instance */
     -href: Text /* A link to the instance */
     *id: Text /* wid / id / reference id */
  }
  studentAwardItem: { /* The award item of the student hold context. */
     -descriptor: Text /* A description of the instance */
     -href: Text /* A link to the instance */
     *id: Text /* wid / id / reference id */
  }
}]

Input


Name	Type	Description
Students_Id	String	The ID of the resource to execute this process on.
Descriptor	String	A preview of the instance
Id	String	Id of the instance
Reason_Id	String	wid / id / reference id
Student_Id	String	wid / id / reference id
TypeContext_Aggregate	String	A JSON aggregate. The hold type of the apply student hold event.

Result Set Columns