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 本製品 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.

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

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

BusinessProcessParameters_Comments_Aggregate

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

Days_Aggregate

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

Input

Name	Type	Description
Workers_Id	String	The ID of the resource to execute this process on
BusinessProcessParameters_Action_Id	String	wid / id / reference id
BusinessProcessParameters_Attachments_Aggregate	String	A JSON aggregate. Returns attachments associated with this business process that are uploaded from the toolbar and are accessible to the processing person. Returns blank if either of these conditions are not met.
BusinessProcessParameters_Comment	String	Returns a null.
BusinessProcessParameters_For_Id	String	wid / id / reference id
BusinessProcessParameters_OverallBusinessProcess_Id	String	wid / id / reference id
BusinessProcessParameters_TransactionStatus_Id	String	wid / id / reference id
Days_Aggregate	String	A JSON aggregate. Time Off Entries

Result Set Columns

Name	Type	Description
BusinessProcessParameters_Action_Descriptor	String	A description of the instance
BusinessProcessParameters_Action_Href	String	A link to the instance
BusinessProcessParameters_Action_Id	String	wid / id / reference id
BusinessProcessParameters_Attachments_Aggregate	String	A JSON aggregate. Returns attachments associated with this business process that are uploaded from the toolbar and are accessible to the processing person. Returns blank if either of these conditions are not met.
BusinessProcessParameters_Comment	String	Returns a null.
BusinessProcessParameters_Comments_Aggregate	String	A JSON aggregate. Returns the comments for the current business process.
BusinessProcessParameters_CriticalValidations	String	Validation message for an action event triggered by a condition.
BusinessProcessParameters_For_Descriptor	String	A description of the instance
BusinessProcessParameters_For_Href	String	A link to the instance
BusinessProcessParameters_For_Id	String	wid / id / reference id
BusinessProcessParameters_OverallBusinessProcess_Descriptor	String	A description of the instance
BusinessProcessParameters_OverallBusinessProcess_Href	String	A link to the instance
BusinessProcessParameters_OverallBusinessProcess_Id	String	wid / id / reference id
BusinessProcessParameters_OverallStatus	String	The current status of the business process. For example: Successfully Completed, Denied, Terminated.
BusinessProcessParameters_TransactionStatus_Descriptor	String	A description of the instance
BusinessProcessParameters_TransactionStatus_Href	String	A link to the instance
BusinessProcessParameters_TransactionStatus_Id	String	wid / id / reference id
BusinessProcessParameters_WarningValidations	String	Warning message for an action event triggered by a condition.
Days_Aggregate	String	A JSON aggregate. Time Off Entries