Skip to main content
Server path: /workday-business-process | Type: Application | PCID required: Yes

Tools

ToolDescription
workday_business_process_get_eventsRetrieves business process events.
workday_business_process_get_events_by_idRetrieves a business process event.
workday_business_process_get_events_by_id_attachmentsRetrieves attachments for a business process event.
workday_business_process_get_events_by_id_commentsRetrieves comments for a business process event.
workday_business_process_get_events_by_id_completedstepsRetrieves completed steps for a business process event.
workday_business_process_get_events_by_id_inprogressstepsRetrieves in progress steps for a business process event.
workday_business_process_get_events_by_id_remainingstepsRetrieves remaining steps for a business process event.
workday_business_process_get_eventstepsRetrieves business process event steps.
workday_business_process_get_eventsteps_by_idRetrieves a business process event step.
workday_business_process_get_typesRetrieves all business process types.
workday_business_process_get_types_by_idRetrieves a business process type.
workday_business_process_get_types_by_id_attachmentcategoriesRetrieves attachment categories for a business process type.
workday_business_process_get_values_sendback_toRetrieves 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_cancelCancels a business process event.
workday_business_process_post_events_by_id_rescindRescinds a business process event.
workday_business_process_post_eventsteps_by_id_approveApproves a business process event step.
workday_business_process_post_eventsteps_by_id_denyDenies a business process event step.
workday_business_process_post_eventsteps_by_id_questionnairePost an action for a Complete Questionnaire step in a business process.
workday_business_process_post_eventsteps_by_id_sendbackSends back a business process event step.
workday_business_process_post_eventsteps_by_id_todoPost an action for a To Do step in a business process.

workday_business_process_get_events

Retrieves business process events. Parameters:
ParameterTypeRequiredDefaultDescription
businessProcessany[]NobusinessProcess
completedOnOrAfterstringNocompletedOnOrAfter
completedOnOrBeforestringNocompletedOnOrBefore
initiatedOnOrAfterstringNoinitiatedOnOrAfter
initiatedOnOrBeforestringNoinitiatedOnOrBefore
initiatorany[]Noinitiator
limitintegerNoThe maximum number of objects in a single response. The default is 20. The maximum is 100.
offsetintegerNoThe 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.
statusany[]Nostatus
workerstringNoworker

workday_business_process_get_events_by_id

Retrieves a business process event. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe Workday ID of the resource.

workday_business_process_get_events_by_id_attachments

Retrieves attachments for a business process event. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe Workday ID of the resource.
limitintegerNoThe maximum number of objects in a single response. The default is 20. The maximum is 100.
offsetintegerNoThe 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:
ParameterTypeRequiredDefaultDescription
IDstringYesThe Workday ID of the resource.
limitintegerNoThe maximum number of objects in a single response. The default is 20. The maximum is 100.
offsetintegerNoThe 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:
ParameterTypeRequiredDefaultDescription
IDstringYesThe Workday ID of the resource.
limitintegerNoThe maximum number of objects in a single response. The default is 20. The maximum is 100.
offsetintegerNoThe 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:
ParameterTypeRequiredDefaultDescription
IDstringYesThe Workday ID of the resource.
limitintegerNoThe maximum number of objects in a single response. The default is 20. The maximum is 100.
offsetintegerNoThe 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:
ParameterTypeRequiredDefaultDescription
IDstringYesThe Workday ID of the resource.
limitintegerNoThe maximum number of objects in a single response. The default is 20. The maximum is 100.
offsetintegerNoThe 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:
ParameterTypeRequiredDefaultDescription
businessProcessany[]NobusinessProcess
createdOnOrAfterstringNocreatedOnOrAfter
createdOnOrBeforestringNocreatedOnOrBefore
dueDateOnOrAfterstringNodueDateOnOrAfter
dueDateOnOrBeforestringNodueDateOnOrBefore
limitintegerNoThe maximum number of objects in a single response. The default is 20. The maximum is 100.
offsetintegerNoThe 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.
stepTypeany[]NostepType

workday_business_process_get_eventsteps_by_id

Retrieves a business process event step. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe Workday ID of the resource.

workday_business_process_get_types

Retrieves all business process types. Parameters:
ParameterTypeRequiredDefaultDescription
limitintegerNoThe maximum number of objects in a single response. The default is 20. The maximum is 100.
offsetintegerNoThe 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:
ParameterTypeRequiredDefaultDescription
IDstringYesThe Workday ID of the resource.

workday_business_process_get_types_by_id_attachmentcategories

Retrieves attachment categories for a business process type. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe Workday ID of the resource.
eventTargetstringNoThe 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.
limitintegerNoThe maximum number of objects in a single response. The default is 20. The maximum is 100.
offsetintegerNoThe 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:
ParameterTypeRequiredDefaultDescription
eventStepstringNoeventStep
limitintegerNoThe maximum number of objects in a single response. The default and maximum is 1000.
offsetintegerNoThe 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.
searchstringNoA 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:
ParameterTypeRequiredDefaultDescription
IDstringYesThe Workday ID of the resource.
commentstringNocomment
descriptorstringNoThe display name of the instance
idstringNoWorkday Id or Reference Id of the instance.
statusstringNostatus

workday_business_process_post_events_by_id_rescind

Rescinds a business process event. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe Workday ID of the resource.
commentstringNocomment
descriptorstringNoThe display name of the instance
idstringNoWorkday Id or Reference Id of the instance.
statusstringNostatus

workday_business_process_post_eventsteps_by_id_approve

Approves a business process event step. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe Workday ID of the resource.
commentstringNoReturns user’s comment for Event Record.
descriptorstringNoThe display name of the instance
eventStatusobjectNoReturns the Workflow State of the current Action Event
idstringNoWorkday Id or Reference Id of the instance.

workday_business_process_post_eventsteps_by_id_deny

Denies a business process event step. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe Workday ID of the resource.
commentstringNoReturns user’s comment for Event Record.
descriptorstringNoThe display name of the instance
eventStatusobjectNoReturns the Workflow State of the current Action Event
idstringNoWorkday Id or Reference Id of the instance.
stepActionobjectNoThe 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:
ParameterTypeRequiredDefaultDescription
IDstringYesThe Workday ID of the resource.
descriptorstringNoThe display name of the instance
idstringNoWorkday Id or Reference Id of the instance.
questionnaireResponseobjectNoQuestionnaire Response
stepActionobjectNoThe status of the step

workday_business_process_post_eventsteps_by_id_sendback

Sends back a business process event step. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe Workday ID of the resource.
descriptorstringNoThe display name of the instance
idstringNoWorkday Id or Reference Id of the instance.
reasonstringYesReturns user’s comment for Event Record.
statusobjectNoThe status of this business process step.
toobjectYesa 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:
ParameterTypeRequiredDefaultDescription
IDstringYesThe Workday ID of the resource.
commentstringNoLast Comment
descriptorstringNoThe display name of the instance
idstringNoWorkday Id or Reference Id of the instance.
stepActionobjectYesThe status of the step