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

Workday Resource Information

Use this to create a time off request for the specified worker ID and initiate the Request Time Off business process.

Requesting time off is a multistep process. To do so, call these endpoints:
1. GET /workers/{worker ID}/eligibleAbsenceTypes
2. GET /workers/{worker ID}/validTimeOffDates?timeOff={Time Off Type ID from step 1}&date={first date requested off}&date={second date requested off}
3. POST /workers/{worker ID}/requestTimeOff {...}

If you specify businessProcessParameters in the request body:
* You must specify action.id.
* To submit the event, specify action.id as Submitted, d9e4223e446c11de98360015c5e6daf6.

Example:
{
"businessProcessParameters": {
"action": {
"id": "d9e4223e446c11de98360015c5e6daf6"
}
},
"days": [ ... ]
}

Secured by: FLW Service, Request Time Off (REST Service)

Scope: Time Off and Leave

Aggregate Fields

The connector 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 /* The display name of the instance */
     -href: Text /* A link to the instance */
     *id: Text /* wid / id / reference id */
  }
  contentType: { /* Content type of the attachment */
     -descriptor: Text /* The display name 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 /* The display name 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 /* The display name 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 /* The number of days or hours for this time off entry. */
  date: Date /* The date of the Time Off Entry. */
  descriptor: Text /* The display name of the instance */
  end: Date /* The end time of the time off entry. */
  id: Text /* Id of the instance */
  position: { /* Specify this value if a worker has multiple positions that they could request time off for. */
      descriptor: Text /* The display name of the instance */
      id: Text /* Id of the instance */
  }
  reason: { /* The reason for the time off entry. */
     -descriptor: Text /* The display name 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 /* The display name 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	The display name of the instance
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	The display name of the instance
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	The display name of the instance
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	The display name of the instance
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.