Creates a time off request for the specified worker ID and initiates the business process.

Workday Resource Information

Creates a time off request for the specified worker ID and initiates the Request Time Off business process.

In the request body, if using business process parameters, specify at least the required field: action {id}. You must specify the submit action WID: d9e4223e446c11de98360015c5e6daf6

Secured by: Request Time Off (REST Service)

Scope: Time Off and Leave

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.

BusinessProcessParameters_Attachments_Aggregate

[{
  category: { /* Returns the category of a Business Process Attachment. */
     -descriptor: Text /* A description of the instance */
     -href: Text /* A link to the instance */
     *id: Text /* wid / id / reference id */
  }
  contentType: { /* Content type of the attachment */
     -descriptor: Text /* A description of the instance */
     -href: Text /* A link to the instance */
     *id: Text /* wid / id / reference id */
  }
  description: Text /* Event attachment description */
  fileLength: Numeric /* File length of the attachment */
  fileName: Text /* File name of the attachment */
  id: Text /* Id of the instance */
 -uploadDate: Date /* Returns Date the Business Process Attachment was updated. */
  uploadedBy: { /* Returns the primary Role of the person who uploaded the Attachment. */
     -descriptor: Text /* A description of the instance */
     -href: Text /* A link to the instance */
     *id: Text /* wid / id / reference id */
  }
}]

BusinessProcessParameters_Comments_Aggregate

[{
  comment: Text /* Comment */
  commentDate: Date /* Gives the moment at which the instance was originally created. */
  person: { /* Comment made by Person */
     -descriptor: Text /* A description of the instance */
     -href: Text /* A link to the instance */
     *id: Text /* wid / id / reference id */
  }
}]

Days_Aggregate

[{
  comment: Text /* The comment on the time off entry. */
  dailyQuantity: Numeric /* Time Off Entry hours */
  date: Date /* Time Off Entry date */
  descriptor: Text /* A preview of the instance */
  end: Date /* The end time of the time off entry. */
  id: Text /* Id of the instance */
  position: { /* The position of the time off entry. */
      descriptor: Text /* A preview of the instance */
      id: Text /* Id of the instance */
  }
  reason: { /* The reason for the time off entry. */
     -descriptor: Text /* A description of the instance */
     -href: Text /* A link to the instance */
     *id: Text /* wid / id / reference id */
  }
  start: Date /* The start time of the time off entry. */
  timeOffType: { /* The time off type name or absence table name. */
      descriptor: Text /* A preview of the instance */
      id: Text /* Id of the instance */
  }
}]

Input

Name	Type	Description
Workers_Id	String	Unique identifier for the worker requesting time off.
BusinessProcessParameters_Action_Id	String	Unique identifier for the action related to the time-off request.
BusinessProcessParameters_Attachments_Aggregate	String	Attachments uploaded during the time-off request process.
BusinessProcessParameters_Comment	String	A comment related to the time-off request.
BusinessProcessParameters_For_Id	String	Unique identifier for the worker the time-off request applies to.
BusinessProcessParameters_OverallBusinessProcess_Id	String	Unique identifier for the overall business process managing the time-off request.
BusinessProcessParameters_TransactionStatus_Id	String	Unique identifier for the transaction status of the request.
Days_Aggregate	String	All time-off entries associated with the request.

Result Set Columns

Name	Type	Description
BusinessProcessParameters_Action_Descriptor	String	A brief description of the action related to the time-off request.
BusinessProcessParameters_Action_Href	String	A link to the action instance.
BusinessProcessParameters_Action_Id	String	Unique identifier for the action related to the time-off request.
BusinessProcessParameters_Attachments_Aggregate	String	Attachments uploaded during the time-off request process.
BusinessProcessParameters_Comment	String	A comment related to the time-off request.
BusinessProcessParameters_Comments_Aggregate	String	Comments provided as part of the time-off request process.
BusinessProcessParameters_CriticalValidations	String	Validation messages triggered by conditions during the process.
BusinessProcessParameters_For_Descriptor	String	A description of the worker associated with the request.
BusinessProcessParameters_For_Href	String	A link to the worker instance.
BusinessProcessParameters_For_Id	String	Unique identifier for the worker the time-off request applies to.
BusinessProcessParameters_OverallBusinessProcess_Descriptor	String	A description of the overall business process for the time-off request.
BusinessProcessParameters_OverallBusinessProcess_Href	String	A link to the overall business process instance.
BusinessProcessParameters_OverallBusinessProcess_Id	String	Unique identifier for the overall business process managing the time-off request.
BusinessProcessParameters_OverallStatus	String	Current status of the business process (e.g., Completed, Denied, Terminated).
BusinessProcessParameters_TransactionStatus_Descriptor	String	A description of the transaction status.
BusinessProcessParameters_TransactionStatus_Href	String	A link to the transaction status instance.
BusinessProcessParameters_TransactionStatus_Id	String	Unique identifier for the transaction status of the request.
BusinessProcessParameters_WarningValidations	String	Warning messages triggered by conditions during the process.
Days_Aggregate	String	All time-off entries associated with the request.