/workday-business-process | Type: Application | PCID required: Yes
Tools
| Tool | Description |
|---|---|
workday_business_process_get_events | Retrieves business process events. |
workday_business_process_get_events_by_id | Retrieves a business process event. |
workday_business_process_get_events_by_id_attachments | Retrieves attachments for a business process event. |
workday_business_process_get_events_by_id_comments | Retrieves comments for a business process event. |
workday_business_process_get_events_by_id_completedsteps | Retrieves completed steps for a business process event. |
workday_business_process_get_events_by_id_inprogresssteps | Retrieves in progress steps for a business process event. |
workday_business_process_get_events_by_id_remainingsteps | Retrieves remaining steps for a business process event. |
workday_business_process_get_eventsteps | Retrieves business process event steps. |
workday_business_process_get_eventsteps_by_id | Retrieves a business process event step. |
workday_business_process_get_types | Retrieves all business process types. |
workday_business_process_get_types_by_id | Retrieves a business process type. |
workday_business_process_get_types_by_id_attachmentcategories | Retrieves attachment categories for a business process type. |
workday_business_process_get_values_sendback_to | Retrieves instances that can be used as values for other endpoint parameters in this service. <b>Secured by:</b> Public Business Processes <b>Scope:</b> Tenant Non-Configurable |
workday_business_process_post_events_by_id_cancel | Cancels a business process event. |
workday_business_process_post_events_by_id_rescind | Rescinds a business process event. |
workday_business_process_post_eventsteps_by_id_approve | Approves a business process event step. |
workday_business_process_post_eventsteps_by_id_deny | Denies a business process event step. |
workday_business_process_post_eventsteps_by_id_questionnaire | Post an action for a Complete Questionnaire step in a business process. |
workday_business_process_post_eventsteps_by_id_sendback | Sends back a business process event step. |
workday_business_process_post_eventsteps_by_id_todo | Post an action for a To Do step in a business process. |
workday_business_process_get_events
Retrieves business process events. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
businessProcess | any[] | No | — | businessProcess |
completedOnOrAfter | string | No | — | completedOnOrAfter |
completedOnOrBefore | string | No | — | completedOnOrBefore |
initiatedOnOrAfter | string | No | — | initiatedOnOrAfter |
initiatedOnOrBefore | string | No | — | initiatedOnOrBefore |
initiator | any[] | No | — | initiator |
limit | integer | No | — | The maximum number of objects in a single response. The default is 20. The maximum is 100. |
offset | integer | No | — | The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object. |
status | any[] | No | — | status |
worker | string | No | — | worker |
workday_business_process_get_events_by_id
Retrieves a business process event. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ID | string | Yes | — | The Workday ID of the resource. |
workday_business_process_get_events_by_id_attachments
Retrieves attachments for a business process event. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ID | string | Yes | — | The Workday ID of the resource. |
limit | integer | No | — | The maximum number of objects in a single response. The default is 20. The maximum is 100. |
offset | integer | No | — | The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object. |
workday_business_process_get_events_by_id_comments
Retrieves comments for a business process event. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ID | string | Yes | — | The Workday ID of the resource. |
limit | integer | No | — | The maximum number of objects in a single response. The default is 20. The maximum is 100. |
offset | integer | No | — | The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object. |
workday_business_process_get_events_by_id_completedsteps
Retrieves completed steps for a business process event. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ID | string | Yes | — | The Workday ID of the resource. |
limit | integer | No | — | The maximum number of objects in a single response. The default is 20. The maximum is 100. |
offset | integer | No | — | The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object. |
workday_business_process_get_events_by_id_inprogresssteps
Retrieves in progress steps for a business process event. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ID | string | Yes | — | The Workday ID of the resource. |
limit | integer | No | — | The maximum number of objects in a single response. The default is 20. The maximum is 100. |
offset | integer | No | — | The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object. |
workday_business_process_get_events_by_id_remainingsteps
Retrieves remaining steps for a business process event. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ID | string | Yes | — | The Workday ID of the resource. |
limit | integer | No | — | The maximum number of objects in a single response. The default is 20. The maximum is 100. |
offset | integer | No | — | The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object. |
workday_business_process_get_eventsteps
Retrieves business process event steps. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
businessProcess | any[] | No | — | businessProcess |
createdOnOrAfter | string | No | — | createdOnOrAfter |
createdOnOrBefore | string | No | — | createdOnOrBefore |
dueDateOnOrAfter | string | No | — | dueDateOnOrAfter |
dueDateOnOrBefore | string | No | — | dueDateOnOrBefore |
limit | integer | No | — | The maximum number of objects in a single response. The default is 20. The maximum is 100. |
offset | integer | No | — | The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object. |
stepType | any[] | No | — | stepType |
workday_business_process_get_eventsteps_by_id
Retrieves a business process event step. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ID | string | Yes | — | The Workday ID of the resource. |
workday_business_process_get_types
Retrieves all business process types. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | integer | No | — | The maximum number of objects in a single response. The default is 20. The maximum is 100. |
offset | integer | No | — | The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object. |
workday_business_process_get_types_by_id
Retrieves a business process type. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ID | string | Yes | — | The Workday ID of the resource. |
workday_business_process_get_types_by_id_attachmentcategories
Retrieves attachment categories for a business process type. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ID | string | Yes | — | The Workday ID of the resource. |
eventTarget | string | No | — | The Workday ID of the event target that this business process is about. You can use a returned id from an API that returns instances of the event target type. For example, if your event target is a worker, use GET /workers in the Staffing service. |
limit | integer | No | — | The maximum number of objects in a single response. The default is 20. The maximum is 100. |
offset | integer | No | — | The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object. |
workday_business_process_get_values_sendback_to
Retrieves instances that can be used as values for other endpoint parameters in this service. <b>Secured by:</b> Public Business Processes <b>Scope:</b> Tenant Non-Configurable Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
eventStep | string | No | — | eventStep |
limit | integer | No | — | The maximum number of objects in a single response. The default and maximum is 1000. |
offset | integer | No | — | The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object. |
search | string | No | — | A search string that matches display IDs. The search is case-insensitive and matches words that start with the given string. |
workday_business_process_post_events_by_id_cancel
Cancels a business process event. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ID | string | Yes | — | The Workday ID of the resource. |
comment | string | No | — | comment |
descriptor | string | No | — | The display name of the instance |
id | string | No | — | Workday Id or Reference Id of the instance. |
status | string | No | — | status |
workday_business_process_post_events_by_id_rescind
Rescinds a business process event. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ID | string | Yes | — | The Workday ID of the resource. |
comment | string | No | — | comment |
descriptor | string | No | — | The display name of the instance |
id | string | No | — | Workday Id or Reference Id of the instance. |
status | string | No | — | status |
workday_business_process_post_eventsteps_by_id_approve
Approves a business process event step. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ID | string | Yes | — | The Workday ID of the resource. |
comment | string | No | — | Returns user’s comment for Event Record. |
descriptor | string | No | — | The display name of the instance |
eventStatus | object | No | — | Returns the Workflow State of the current Action Event |
id | string | No | — | Workday Id or Reference Id of the instance. |
workday_business_process_post_eventsteps_by_id_deny
Denies a business process event step. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ID | string | Yes | — | The Workday ID of the resource. |
comment | string | No | — | Returns user’s comment for Event Record. |
descriptor | string | No | — | The display name of the instance |
eventStatus | object | No | — | Returns the Workflow State of the current Action Event |
id | string | No | — | Workday Id or Reference Id of the instance. |
stepAction | object | No | — | The status of this business process step. |
workday_business_process_post_eventsteps_by_id_questionnaire
Post an action for a Complete Questionnaire step in a business process. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ID | string | Yes | — | The Workday ID of the resource. |
descriptor | string | No | — | The display name of the instance |
id | string | No | — | Workday Id or Reference Id of the instance. |
questionnaireResponse | object | No | — | Questionnaire Response |
stepAction | object | No | — | The status of the step |
workday_business_process_post_eventsteps_by_id_sendback
Sends back a business process event step. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ID | string | Yes | — | The Workday ID of the resource. |
descriptor | string | No | — | The display name of the instance |
id | string | No | — | Workday Id or Reference Id of the instance. |
reason | string | Yes | — | Returns user’s comment for Event Record. |
status | object | No | — | The status of this business process step. |
to | object | Yes | — | a set containing no instances |
workday_business_process_post_eventsteps_by_id_todo
Post an action for a To Do step in a business process. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ID | string | Yes | — | The Workday ID of the resource. |
comment | string | No | — | Last Comment |
descriptor | string | No | — | The display name of the instance |
id | string | No | — | Workday Id or Reference Id of the instance. |
stepAction | object | Yes | — | The status of the step |

