{ "openapi": "3.0.1", "info": { "title": "Changelog for businessProcess", "description": "The public APIs to access event actions and details", "version": "v1" }, "servers": [ { "url": "https:///businessProcess/v1" } ], "tags": [ { "name": "08/17/2026", "description": "Changes for v2026.33" }, { "name": "06/30/2026", "description": "Changes for v2026.26" }, { "name": "06/15/2026", "description": "Changes for v2026.24" }, { "name": "06/08/2026", "description": "Changes for v2026.23" }, { "name": "03/18/2026", "description": "Changes for v2026.11" }, { "name": "12/15/2025", "description": "Changes for v2025.50" }, { "name": "12/06/2025", "description": "Changes for v2025.49" }, { "name": "05/17/2025", "description": "Changes for v2025.20" }, { "name": "09/28/2024", "description": "Changes for v2024.39" }, { "name": "06/15/2024", "description": "Changes for v2024.24" }, { "name": "07/15/2023", "description": "Changes for v2023.28" }, { "name": "04/24/2023", "description": "Changes for v2023.16" }, { "name": "04/01/2023", "description": "Changes for v2023.13" }, { "name": "03/11/2023", "description": "Changes for v2023.10" }, { "name": "09/19/2022", "description": "Changes for v2022.38" }, { "name": "08/06/2022", "description": "Changes for v2022.32" }, { "name": "04/02/2022", "description": "Changes for v2022.14" }, { "name": "09/09/2021", "description": "Changes for v2021.38" }, { "name": "09/01/2021", "description": "Changes for v2021.37" }, { "name": "03/15/2021", "description": "Changes for v2021.13" } ], "paths": { "2021.13/events": { "get": { "tags": [ "03/15/2021" ], "summary": "Modified this existing endpoint", "description": "
\n\n
\n View this Endpoint: GET /events\n
\n
", "parameters": [ { "name": "initiatedOnOrAfter", "in": "query", "description": "Parameter Description changed \n| Updated Value | \n| :--- | \n| The date and time this business process was initiated. | \n\n| Previous Value | \n| :--- | \n| The date and time the business process was initiated. | \n\n", "required": false, "explode": true, "schema": { "type": "string", "format": "date", "exampleSetFlag": false, "types": [ "string" ] } }, { "name": "initiatedOnOrBefore", "in": "query", "description": "Parameter Description changed \n| Updated Value | \n| :--- | \n| The date and time this business process was initiated. | \n\n| Previous Value | \n| :--- | \n| The date and time the business process was initiated. | \n\n", "required": false, "explode": true, "schema": { "type": "string", "format": "date", "exampleSetFlag": false, "types": [ "string" ] } } ] } }, "2021.37/events/{ID}/comments": { "get": { "tags": [ "09/01/2021" ], "summary": "Added new operation", "description": "Retrieves comments on the specified business process event.\n\nSecured by: Core Navigation\n\nScope: Adaptive Planning for the Workforce, Adaptive Planning for Financial Plans
\n\n
\n View this Endpoint: GET /events/{ID}/comments\n
\n
", "parameters": [ { "name": "ID", "in": "path", "description": "The Workday ID of the resource.", "required": true, "explode": false, "schema": { "type": "string", "exampleSetFlag": false, "types": [ "string" ] } }, { "name": "limit", "in": "query", "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100.", "required": false, "explode": true, "schema": { "type": "integer", "format": "int64", "exampleSetFlag": false, "types": [ "integer" ] } }, { "name": "offset", "in": "query", "description": "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.", "required": false, "explode": true, "schema": { "type": "integer", "format": "int64", "exampleSetFlag": false, "types": [ "integer" ] } } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "exampleSetFlag": false, "items": { "$ref": "#/components/schemas/comments_a7a41b4d029c10000b1da9c45b7b18f4", "exampleSetFlag": false }, "types": [ "array" ] }, "total": { "type": "integer", "format": "int64", "exampleSetFlag": false, "types": [ "integer" ] } }, "description": "collection something or other", "exampleSetFlag": false, "types": [ "object" ] }, "exampleSetFlag": false } } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "401": { "description": "Invalid resource or operation. (https://community.workday.com/rest/error-messages)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "default": { "description": "An error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE", "exampleSetFlag": false }, "exampleSetFlag": false } } } } } }, "2021.37/types": { "get": { "tags": [ "09/01/2021" ], "summary": "Modified this existing endpoint", "description": "## Summary changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Retrieves all business process types.
|
None
| \n\n## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Retrieves a collection of business process types.
|
None
| \n\n
\n\n
\n View this Endpoint: GET /types\n
\n
" } }, "2021.37/types/{ID}": { "get": { "tags": [ "09/01/2021" ], "summary": "Modified this existing endpoint", "description": "## Summary changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Retrieves a business process type.
|
None
| \n\n## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Retrieves the business process type specified by the ID.
|
None
| \n\n
\n\n
\n View this Endpoint: GET /types/{ID}\n
\n
" } }, "2021.37/types/{ID}/attachmentCategories": { "get": { "tags": [ "09/01/2021" ], "summary": "Modified this existing endpoint", "description": "## Summary changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Retrieves attachment categories for a business process type.
|
None
| \n\n## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Retrieves all attachment categories for the specified business process type that the processing user can select for the specified event. You can filter by event target.
|
None
| \n\n
\n\n
\n View this Endpoint: GET /types/{ID}/attachmentCategories\n
\n
", "parameters": [ { "name": "eventTarget", "in": "query", "description": "Parameter Description changed \n| Updated Value | \n| :--- | \n| 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. | \n\n| Previous Value | \n| :--- | \n| a set containing no instances | \n\n", "required": false, "explode": true, "schema": { "type": "string", "exampleSetFlag": false, "types": [ "string" ] } } ] } }, "2021.37/events": { "get": { "tags": [ "09/01/2021" ], "summary": "Modified this existing endpoint", "description": "## Summary changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Retrieves business process events.
|
None
| \n\n## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Retrieves a collection of business process events based on the specified parameters. You must specify exactly one worker parameter. If a worker parameter is not specified, returns a blank response.
|
Returns a business process event. Secured by the Business Process Security Policy for each event.
| \n\n## Scope changed \n|
Updated Value
| \n| :--- | \n|
Adaptive Planning For Financial Plans, Adaptive Planning For The Workforce
| \n\n|
Added Domains
|
Removed Domains
| \n| :--- | :--- | \n|
Adaptive Planning For The Workforce
|
Adaptive Planning For Headcount Plans
| \n\n
\n\n
\n View this Endpoint: GET /events\n
\n
" } }, "2021.37/events/{ID}/attachments": { "get": { "tags": [ "09/01/2021" ], "summary": "Modified this existing endpoint", "description": "## Summary changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Retrieves attachments for a business process event.
|
None
| \n\n## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Retrieves attachments on the specified business process event that the processing user has permission to view.
|
None
| \n\n
\n\n
\n View this Endpoint: GET /events/{ID}/attachments\n
\n
" } }, "2021.37/events/{ID}/inProgressSteps": { "get": { "tags": [ "09/01/2021" ], "summary": "Modified this existing endpoint", "description": "## Summary changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Retrieves in progress steps for a business process event.
|
None
| \n\n## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Retrieves all business process steps that are currently in progress for the specified business process event.
|
None
| \n\n## Scope changed \n|
Updated Value
| \n| :--- | \n|
Adaptive Planning For Financial Plans, Adaptive Planning For The Workforce
| \n\n|
Added Domains
|
Removed Domains
| \n| :--- | :--- | \n|
Adaptive Planning For The Workforce
|
Adaptive Planning For Headcount Plans
| \n\n
\n\n
\n View this Endpoint: GET /events/{ID}/inProgressSteps\n
\n
" } }, "2021.37/eventSteps/{ID}/deny": { "post": { "tags": [ "09/01/2021" ], "summary": "Modified this existing endpoint", "description": "## Summary changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Denies a business process event step.
|
None
| \n\n## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Denies the business process event step specified by the ID of the originating event step. The processing person must have view access to the event. In the request body, specify these required fields: id (the event step you are denying), stepAction{id} (if there are multiple event steps), comment.
|
None
| \n\n## Scope changed \n|
Updated Value
| \n| :--- | \n|
Adaptive Planning For Financial Plans, Adaptive Planning For The Workforce
| \n\n|
Added Domains
|
Removed Domains
| \n| :--- | :--- | \n|
Adaptive Planning For The Workforce
|
Adaptive Planning For Headcount Plans
| \n\n
\n\n
\n View this Endpoint: POST /eventSteps/{ID}/deny\n
\n
" } }, "2021.37/values/sendBack/to/": { "get": { "tags": [ "09/01/2021" ], "summary": "Description has been changed", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Retrieves instances that can be used as values for other endpoint parameters in this service.
|
This endpoint returns instances valid for other endpoint parameters in this API, as referenced in their respective x-prompt-values properties.
| \n\n
\n\n
\n View this Endpoint: GET /values/sendBack/to/\n
\n
" } }, "2021.37/events/{ID}/remainingSteps": { "get": { "tags": [ "09/01/2021" ], "summary": "Modified this existing endpoint", "description": "## Summary changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Retrieves remaining steps for a business process event.
|
None
| \n\n## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Retrieves all remaining business process steps for the specified business process event.
|
None
| \n\n## Scope changed \n|
Updated Value
| \n| :--- | \n|
Adaptive Planning For Financial Plans, Adaptive Planning For The Workforce
| \n\n|
Added Domains
|
Removed Domains
| \n| :--- | :--- | \n|
Adaptive Planning For The Workforce
|
Adaptive Planning For Headcount Plans
| \n\n
\n\n
\n View this Endpoint: GET /events/{ID}/remainingSteps\n
\n
" } }, "2021.37/events/{ID}": { "get": { "tags": [ "09/01/2021" ], "summary": "Modified this existing endpoint", "description": "## Summary changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Retrieves a business process event.
|
None
| \n\n## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Retrieves the business process event with the specified ID.
|
Returns a business process event. Secured by the Business Process Security Policy for each event.
| \n\n## Scope changed \n|
Updated Value
| \n| :--- | \n|
Adaptive Planning For Financial Plans, Adaptive Planning For The Workforce
| \n\n|
Added Domains
|
Removed Domains
| \n| :--- | :--- | \n|
Adaptive Planning For The Workforce
|
Adaptive Planning For Headcount Plans
| \n\n
\n\n
\n View this Endpoint: GET /events/{ID}\n
\n
" } }, "2021.37/eventSteps/{ID}/approve": { "post": { "tags": [ "09/01/2021" ], "summary": "Modified this existing endpoint", "description": "## Summary changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Approves a business process event step.
|
None
| \n\n## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Approves the business process event step specified by the ID of the originating event step. In the request body, specify these required fields: id (the event step you are approving), comment.
|
None
| \n\n## Scope changed \n|
Updated Value
| \n| :--- | \n|
Adaptive Planning For Financial Plans, Adaptive Planning For The Workforce
| \n\n|
Added Domains
|
Removed Domains
| \n| :--- | :--- | \n|
Adaptive Planning For The Workforce
|
Adaptive Planning For Headcount Plans
| \n\n
\n\n
\n View this Endpoint: POST /eventSteps/{ID}/approve\n
\n
" } }, "2021.37/eventSteps/{ID}/sendBack": { "post": { "tags": [ "09/01/2021" ], "summary": "Modified this existing endpoint", "description": "## Summary changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Sends back a business process event step.
|
None
| \n\n## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Sends back the business process event step specified by the ID of the originating event step. In the request body, specify these required fields: id (the event step you are sending back), reason.
|
None
| \n\n
\n\n
\n View this Endpoint: POST /eventSteps/{ID}/sendBack\n
\n
" } }, "2021.37/eventSteps": { "get": { "tags": [ "09/01/2021" ], "summary": "Modified this existing endpoint", "description": "## Summary changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Retrieves business process event steps.
|
None
| \n\n## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Retrieves a collection of business process event steps. You can filter the event steps by business process, creation date, due date, and step type.
|
Returns a business process event step. Returned results are secured based on processing person's view access to the event to which the step belongs. If the processing person does not have view access to the event, when this API is called, they will not be able to retrieve the event step and receive a 404 error.
| \n\n## Scope changed \n|
Updated Value
| \n| :--- | \n|
Adaptive Planning For Financial Plans, Adaptive Planning For The Workforce
| \n\n|
Added Domains
|
Removed Domains
| \n| :--- | :--- | \n|
Adaptive Planning For The Workforce
|
Adaptive Planning For Headcount Plans
| \n\n
\n\n
\n View this Endpoint: GET /eventSteps\n
\n
" } }, "2021.37/events/{ID}/completedSteps": { "get": { "tags": [ "09/01/2021" ], "summary": "Modified this existing endpoint", "description": "## Summary changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Retrieves completed steps for a business process event.
|
None
| \n\n## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Retrieves all business process steps that are completed for the specified buinesss process event.
|
None
| \n\n## Scope changed \n|
Updated Value
| \n| :--- | \n|
Adaptive Planning For Financial Plans, Adaptive Planning For The Workforce
| \n\n|
Added Domains
|
Removed Domains
| \n| :--- | :--- | \n|
Adaptive Planning For The Workforce
|
Adaptive Planning For Headcount Plans
| \n\n
\n\n
\n View this Endpoint: GET /events/{ID}/completedSteps\n
\n
" } }, "2021.37/eventSteps/{ID}": { "get": { "tags": [ "09/01/2021" ], "summary": "Modified this existing endpoint", "description": "## Summary changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Retrieves a business process event step.
|
None
| \n\n## Scope changed \n|
Updated Value
| \n| :--- | \n|
Adaptive Planning For Financial Plans, Adaptive Planning For The Workforce
| \n\n|
Added Domains
|
Removed Domains
| \n| :--- | :--- | \n|
Adaptive Planning For The Workforce
|
Adaptive Planning For Headcount Plans
| \n\n
\n\n
\n View this Endpoint: GET /eventSteps/{ID}\n
\n
" } }, "2021.38/eventSteps": { "get": { "tags": [ "09/09/2021" ], "summary": "Parameters have been modified.", "description": "
\n\n
\n View this Endpoint: GET /eventSteps\n
\n
", "parameters": [ { "name": "stepType", "in": "query", "description": "Parameter Description changed \n| Updated Value | \n| :--- | \n| Retired. We retire this report field because when there are multiple steps on the business process definition that are associated with this event step, this report field doesn't return the step type for each associated step. We recommend that you use the Step Type report field instead. | \n\n| Previous Value | \n| :--- | \n| Returns the type of step being performed by the event record. | \n\n", "required": false, "style": "FORM", "explode": true, "schema": { "type": "array", "exampleSetFlag": false, "items": { "type": "string", "exampleSetFlag": false, "types": [ "string" ] }, "types": [ "array" ] } } ] } }, "2022.14/eventSteps/{ID}/submit": { "post": { "tags": [ "04/02/2022" ], "summary": "Added new operation", "description": "Submits the business process event step specified by the ID of the originating event step. In the request body, specify these required fields: id (the event step you are submitting), stepAction {id} (if there are multiple event steps), comment.\n\nSecured by: Core Navigation\n\nScope: Adaptive Planning for the Workforce, Adaptive Planning for Financial Plans
\n\n
\n View this Endpoint: POST /eventSteps/{ID}/submit\n
\n
", "parameters": [ { "name": "ID", "in": "path", "description": "The Workday ID of the resource.", "required": true, "explode": false, "schema": { "type": "string", "exampleSetFlag": false, "types": [ "string" ] } } ], "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/businessProcessEventStepSubmit_9df63b314485100006ff40401d3e00f0", "exampleSetFlag": false }, "exampleSetFlag": false } }, "required": true }, "responses": { "201": { "description": "Resource created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/businessProcessEventStepSubmit_9df63b314485100006ff40401d3e00f0", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\nError Code | Validation Message\n--- | ---\nA226 | Event must be an application business process event\nA212 | This event step isn't awaiting your action\nA169 | This step isn't valid for submission", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "401": { "description": "Invalid resource or operation. (https://community.workday.com/rest/error-messages)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "default": { "description": "An error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE", "exampleSetFlag": false }, "exampleSetFlag": false } } } }, "extensions": { "x-codegen-request-body-name": "businessProcessEventStepSubmit" } } }, "2022.32/types": { "get": { "tags": [ "08/06/2022" ], "summary": "Scope has been changed", "description": "## Scope changed \n|
Updated Value
| \n| :--- | \n|
Tenant Non-Configurable
| \n\n|
Added Domains
|
Removed Domains
| \n| :--- | :--- | \n|
Tenant Non-Configurable
|
None
| \n\n
\n\n
\n View this Endpoint: GET /types\n
\n
" } }, "2022.32/types/{ID}": { "get": { "tags": [ "08/06/2022" ], "summary": "Scope has been changed", "description": "## Scope changed \n|
Updated Value
| \n| :--- | \n|
Tenant Non-Configurable
| \n\n|
Added Domains
|
Removed Domains
| \n| :--- | :--- | \n|
Tenant Non-Configurable
|
None
| \n\n
\n\n
\n View this Endpoint: GET /types/{ID}\n
\n
" } }, "2022.32/types/{ID}/attachmentCategories": { "get": { "tags": [ "08/06/2022" ], "summary": "Scope has been changed", "description": "## Scope changed \n|
Updated Value
| \n| :--- | \n|
Tenant Non-Configurable
| \n\n|
Added Domains
|
Removed Domains
| \n| :--- | :--- | \n|
Tenant Non-Configurable
|
None
| \n\n
\n\n
\n View this Endpoint: GET /types/{ID}/attachmentCategories\n
\n
" } }, "2022.32/events": { "get": { "tags": [ "08/06/2022" ], "summary": "Scope has been changed", "description": "## Scope changed \n|
Updated Value
| \n| :--- | \n|
Adaptive Planning For Financial Plans, Adaptive Planning For The Workforce, Tenant Non-Configurable
| \n\n|
Added Domains
|
Removed Domains
| \n| :--- | :--- | \n|
Tenant Non-Configurable
|
None
| \n\n
\n\n
\n View this Endpoint: GET /events\n
\n
" } }, "2022.32/events/{ID}/attachments": { "get": { "tags": [ "08/06/2022" ], "summary": "Scope has been changed", "description": "## Scope changed \n|
Updated Value
| \n| :--- | \n|
Tenant Non-Configurable
| \n\n|
Added Domains
|
Removed Domains
| \n| :--- | :--- | \n|
Tenant Non-Configurable
|
None
| \n\n
\n\n
\n View this Endpoint: GET /events/{ID}/attachments\n
\n
" } }, "2022.32/events/{ID}/comments": { "get": { "tags": [ "08/06/2022" ], "summary": "Scope has been changed", "description": "## Scope changed \n|
Updated Value
| \n| :--- | \n|
Adaptive Planning For Financial Plans, Adaptive Planning For The Workforce, Tenant Non-Configurable
| \n\n|
Added Domains
|
Removed Domains
| \n| :--- | :--- | \n|
Tenant Non-Configurable
|
None
| \n\n
\n\n
\n View this Endpoint: GET /events/{ID}/comments\n
\n
" } }, "2022.32/events/{ID}/inProgressSteps": { "get": { "tags": [ "08/06/2022" ], "summary": "Scope has been changed", "description": "## Scope changed \n|
Updated Value
| \n| :--- | \n|
Adaptive Planning For Financial Plans, Adaptive Planning For The Workforce, Tenant Non-Configurable
| \n\n|
Added Domains
|
Removed Domains
| \n| :--- | :--- | \n|
Tenant Non-Configurable
|
None
| \n\n
\n\n
\n View this Endpoint: GET /events/{ID}/inProgressSteps\n
\n
" } }, "2022.32/eventSteps/{ID}/deny": { "post": { "tags": [ "08/06/2022" ], "summary": "Scope has been changed", "description": "## Scope changed \n|
Updated Value
| \n| :--- | \n|
Adaptive Planning For Financial Plans, Adaptive Planning For The Workforce, Tenant Non-Configurable
| \n\n|
Added Domains
|
Removed Domains
| \n| :--- | :--- | \n|
Tenant Non-Configurable
|
None
| \n\n
\n\n
\n View this Endpoint: POST /eventSteps/{ID}/deny\n
\n
" } }, "2022.32/events/{ID}/remainingSteps": { "get": { "tags": [ "08/06/2022" ], "summary": "Scope has been changed", "description": "## Scope changed \n|
Updated Value
| \n| :--- | \n|
Adaptive Planning For Financial Plans, Adaptive Planning For The Workforce, Tenant Non-Configurable
| \n\n|
Added Domains
|
Removed Domains
| \n| :--- | :--- | \n|
Tenant Non-Configurable
|
None
| \n\n
\n\n
\n View this Endpoint: GET /events/{ID}/remainingSteps\n
\n
" } }, "2022.32/events/{ID}": { "get": { "tags": [ "08/06/2022" ], "summary": "Scope has been changed", "description": "## Scope changed \n|
Updated Value
| \n| :--- | \n|
Adaptive Planning For Financial Plans, Adaptive Planning For The Workforce, Tenant Non-Configurable
| \n\n|
Added Domains
|
Removed Domains
| \n| :--- | :--- | \n|
Tenant Non-Configurable
|
None
| \n\n
\n\n
\n View this Endpoint: GET /events/{ID}\n
\n
" } }, "2022.32/eventSteps/{ID}/approve": { "post": { "tags": [ "08/06/2022" ], "summary": "Scope has been changed", "description": "## Scope changed \n|
Updated Value
| \n| :--- | \n|
Adaptive Planning For Financial Plans, Adaptive Planning For The Workforce, Tenant Non-Configurable
| \n\n|
Added Domains
|
Removed Domains
| \n| :--- | :--- | \n|
Tenant Non-Configurable
|
None
| \n\n
\n\n
\n View this Endpoint: POST /eventSteps/{ID}/approve\n
\n
" } }, "2022.32/eventSteps/{ID}/sendBack": { "post": { "tags": [ "08/06/2022" ], "summary": "Scope has been changed", "description": "## Scope changed \n|
Updated Value
| \n| :--- | \n|
Tenant Non-Configurable
| \n\n|
Added Domains
|
Removed Domains
| \n| :--- | :--- | \n|
Tenant Non-Configurable
|
None
| \n\n
\n\n
\n View this Endpoint: POST /eventSteps/{ID}/sendBack\n
\n
" } }, "2022.32/eventSteps": { "get": { "tags": [ "08/06/2022" ], "summary": "Scope has been changed", "description": "## Scope changed \n|
Updated Value
| \n| :--- | \n|
Adaptive Planning For Financial Plans, Adaptive Planning For The Workforce, Tenant Non-Configurable
| \n\n|
Added Domains
|
Removed Domains
| \n| :--- | :--- | \n|
Tenant Non-Configurable
|
None
| \n\n
\n\n
\n View this Endpoint: GET /eventSteps\n
\n
" } }, "2022.32/events/{ID}/completedSteps": { "get": { "tags": [ "08/06/2022" ], "summary": "Scope has been changed", "description": "## Scope changed \n|
Updated Value
| \n| :--- | \n|
Adaptive Planning For Financial Plans, Adaptive Planning For The Workforce, Tenant Non-Configurable
| \n\n|
Added Domains
|
Removed Domains
| \n| :--- | :--- | \n|
Tenant Non-Configurable
|
None
| \n\n
\n\n
\n View this Endpoint: GET /events/{ID}/completedSteps\n
\n
" } }, "2022.32/eventSteps/{ID}": { "get": { "tags": [ "08/06/2022" ], "summary": "Scope has been changed", "description": "## Scope changed \n|
Updated Value
| \n| :--- | \n|
Adaptive Planning For Financial Plans, Adaptive Planning For The Workforce, Tenant Non-Configurable
| \n\n|
Added Domains
|
Removed Domains
| \n| :--- | :--- | \n|
Tenant Non-Configurable
|
None
| \n\n
\n\n
\n View this Endpoint: GET /eventSteps/{ID}\n
\n
" } }, "2022.38/events": { "get": { "tags": [ "09/19/2022" ], "summary": "Modified this existing endpoint", "description": "
\n\n
\n View this Endpoint: GET /events\n
\n
", "parameters": [ { "name": "businessProcess", "in": "query", "description": "Parameter Description changed \n| Updated Value | \n| :--- | \n| None | \n\n| Previous Value | \n| :--- | \n| The business process type associated with the business process. Returns filterable search results. Use with the Business Process Type data source. | \n\n", "required": false, "style": "FORM", "explode": true, "schema": { "type": "array", "exampleSetFlag": false, "items": { "type": "string", "exampleSetFlag": false, "types": [ "string" ] }, "types": [ "array" ] } }, { "name": "completedOnOrAfter", "in": "query", "description": "Parameter Description changed \n| Updated Value | \n| :--- | \n| None | \n\n| Previous Value | \n| :--- | \n| The date and time the business process was completed. | \n\n", "required": false, "explode": true, "schema": { "type": "string", "format": "date", "exampleSetFlag": false, "types": [ "string" ] } }, { "name": "completedOnOrBefore", "in": "query", "description": "Parameter Description changed \n| Updated Value | \n| :--- | \n| None | \n\n| Previous Value | \n| :--- | \n| The date and time the business process was completed. | \n\n", "required": false, "explode": true, "schema": { "type": "string", "format": "date", "exampleSetFlag": false, "types": [ "string" ] } }, { "name": "initiatedOnOrAfter", "in": "query", "description": "Parameter Description changed \n| Updated Value | \n| :--- | \n| None | \n\n| Previous Value | \n| :--- | \n| The date and time this business process was initiated. | \n\n", "required": false, "explode": true, "schema": { "type": "string", "format": "date", "exampleSetFlag": false, "types": [ "string" ] } }, { "name": "initiatedOnOrBefore", "in": "query", "description": "Parameter Description changed \n| Updated Value | \n| :--- | \n| None | \n\n| Previous Value | \n| :--- | \n| The date and time this business process was initiated. | \n\n", "required": false, "explode": true, "schema": { "type": "string", "format": "date", "exampleSetFlag": false, "types": [ "string" ] } }, { "name": "initiator", "in": "query", "description": "Parameter Description changed \n| Updated Value | \n| :--- | \n| None | \n\n| Previous Value | \n| :--- | \n| The \\~worker\\~ that initiated the business process. Please do not use this field in a condition rule for the initiation step of a process, as it will not return results. This is because there is no initiating \\~worker\\~ designated until the process has started. The Initiating \\~Worker\\~ field only gets a value after the event is initiated (after the process is submitted). | \n\n", "required": false, "style": "FORM", "explode": true, "schema": { "type": "array", "exampleSetFlag": false, "items": { "type": "string", "exampleSetFlag": false, "types": [ "string" ] }, "types": [ "array" ] } }, { "name": "status", "in": "query", "description": "Parameter Description changed \n| Updated Value | \n| :--- | \n| None | \n\n| Previous Value | \n| :--- | \n| Transaction Status for Facet Search | \n\n", "required": false, "style": "FORM", "explode": true, "schema": { "type": "array", "exampleSetFlag": false, "items": { "type": "string", "exampleSetFlag": false, "types": [ "string" ] }, "types": [ "array" ] } }, { "name": "worker", "in": "query", "description": "Parameter Description changed \n| Updated Value | \n| :--- | \n| None | \n\n| Previous Value | \n| :--- | \n| Event about \\~Worker\\~ for Facet Search | \n\n", "required": false, "explode": true, "schema": { "type": "string", "exampleSetFlag": false, "types": [ "string" ] } } ] } }, "2022.38/eventSteps": { "get": { "tags": [ "09/19/2022" ], "summary": "Modified this existing endpoint", "description": "
\n\n
\n View this Endpoint: GET /eventSteps\n
\n
", "parameters": [ { "name": "businessProcess", "in": "query", "description": "Parameter Description changed \n| Updated Value | \n| :--- | \n| None | \n\n| Previous Value | \n| :--- | \n| The business process type of the event that the step is associated with. | \n\n", "required": false, "style": "FORM", "explode": true, "schema": { "type": "array", "exampleSetFlag": false, "items": { "type": "string", "exampleSetFlag": false, "types": [ "string" ] }, "types": [ "array" ] } }, { "name": "createdOnOrAfter", "in": "query", "description": "Parameter Description changed \n| Updated Value | \n| :--- | \n| None | \n\n| Previous Value | \n| :--- | \n| The last moment the step was updated. | \n\n", "required": false, "explode": true, "schema": { "type": "string", "format": "date", "exampleSetFlag": false, "types": [ "string" ] } }, { "name": "createdOnOrBefore", "in": "query", "description": "Parameter Description changed \n| Updated Value | \n| :--- | \n| None | \n\n| Previous Value | \n| :--- | \n| The last moment the step was updated. | \n\n", "required": false, "explode": true, "schema": { "type": "string", "format": "date", "exampleSetFlag": false, "types": [ "string" ] } }, { "name": "dueDateOnOrAfter", "in": "query", "description": "Parameter Description changed \n| Updated Value | \n| :--- | \n| None | \n\n| Previous Value | \n| :--- | \n| Returns the due date for this step. | \n\n", "required": false, "explode": true, "schema": { "type": "string", "format": "date", "exampleSetFlag": false, "types": [ "string" ] } }, { "name": "dueDateOnOrBefore", "in": "query", "description": "Parameter Description changed \n| Updated Value | \n| :--- | \n| None | \n\n| Previous Value | \n| :--- | \n| Returns the due date for this step. | \n\n", "required": false, "explode": true, "schema": { "type": "string", "format": "date", "exampleSetFlag": false, "types": [ "string" ] } }, { "name": "stepType", "in": "query", "description": "Parameter Description changed \n| Updated Value | \n| :--- | \n| None | \n\n| Previous Value | \n| :--- | \n| Retired. We retire this report field because when there are multiple steps on the business process definition that are associated with this event step, this report field doesn't return the step type for each associated step. We recommend that you use the Step Type report field instead. | \n\n", "required": false, "style": "FORM", "explode": true, "schema": { "type": "array", "exampleSetFlag": false, "items": { "type": "string", "exampleSetFlag": false, "types": [ "string" ] }, "types": [ "array" ] } } ] } }, "2023.10/eventSteps/{ID}/toDo": { "post": { "tags": [ "03/11/2023" ], "summary": "Added new operation", "description": "Posts a To Do event step with the specified ID. Specify whether to submit the To Do item or save it for later.In the request body, specify at least these required fields: {stepAction}.\n\nSecured by: Core Navigation, Public Business Processes\n\nScope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Tenant Non-Configurable
\n\n
\n View this Endpoint: POST /eventSteps/{ID}/toDo\n
\n
", "parameters": [ { "name": "ID", "in": "path", "description": "The Workday ID of the resource.", "required": true, "explode": false, "schema": { "type": "string", "exampleSetFlag": false, "types": [ "string" ] } } ], "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/businessProcessEventStepTodo_33ae690d779b10001c98021b2aa90000", "exampleSetFlag": false }, "exampleSetFlag": false } }, "required": true }, "responses": { "201": { "description": "Resource created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/businessProcessEventStepTodo_33ae690d779b10001c98021b2aa90000", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\nError Code | Validation Message\n--- | ---\nA212 | This event step isn't awaiting your action\nA1572 | Specify a To Do step.\nA1573 | You can't comment on this business process type.\nA1574 | Specify Submit or Save for Later. This step type doesn't support other actions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "401": { "description": "Invalid resource or operation. (https://community.workday.com/rest/error-messages)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "default": { "description": "An error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE", "exampleSetFlag": false }, "exampleSetFlag": false } } } }, "extensions": { "x-codegen-request-body-name": "businessProcessEventStepTodo" } } }, "2023.13/eventSteps/{ID}/toDo": { "post": { "tags": [ "04/01/2023" ], "summary": "Modified this existing endpoint", "description": "## Summary changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Post an action for a To Do step in a business process.
|
Posts a To Do event step with the specified ID. Specify whether to submit the To Do item or save it for later.In the request body, specify at least these required fields: {stepAction}.
| \n\n## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Post an action for a To Do step in a business process.\nSpecify these required fields in the request body: {stepAction}.\nYou can add an optional comment, if enabled at tenant or business process level.
Valid values for stepAction are:\n{ \"id\": \"133d5c88baa64136aab041c1d2e9ed53\" } for Submit, \n{ \"id\": \"d9e41d34446c11de98360015c5e6daf6\" } for Save for Later.
|
Posts a To Do event step with the specified ID. Specify whether to submit the To Do item or save it for later.In the request body, specify at least these required fields: {stepAction}.
| \n\n
\n\n
\n View this Endpoint: POST /eventSteps/{ID}/toDo\n
\n
" } }, "2023.16/eventSteps/{ID}/questionnaire": { "post": { "tags": [ "04/24/2023" ], "summary": "Added new operation", "description": "Post an action for a Complete Questionnaire step in a business process.\nSpecify these required fields in the request body if the intended action is Submit or Save for Later: {stepAction, questionnaireResponse}.\nYou can send Save for Later multiple times, but {questionnaireResponse} values will replace the existing questionnaire answers. \nIf the intended action is Skip, exclude {questionnaireResponse} from the request body.\n\nValid values for stepAction are:\n{ \"id\": \"133d5c88baa64136aab041c1d2e9ed53\" } for Submit, \n{ \"id\": \"d9e41a8c446c11de98360015c5e6daf6\" } for Save for Later,\n{ \"id\": \"d9e4231a446c11de98360015c5e6daf6\" } for Skip.\n\nSecured by: Core Navigation, Public Business Processes\n\nScope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Tenant Non-Configurable
\n\n
\n View this Endpoint: POST /eventSteps/{ID}/questionnaire\n
\n
", "parameters": [ { "name": "ID", "in": "path", "description": "The Workday ID of the resource.", "required": true, "explode": false, "schema": { "type": "string", "exampleSetFlag": false, "types": [ "string" ] } } ], "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/completeQuestionnaireEventStep_3544fcea2784100018ee4286aeca0000", "exampleSetFlag": false }, "exampleSetFlag": false } }, "required": true }, "responses": { "201": { "description": "Resource created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/completeQuestionnaireEventStep_3544fcea2784100018ee4286aeca0000", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\nError Code | Validation Message\n--- | ---\nA212 | This event step isn't awaiting your action\nA1584 | Specify a questionnaire response.\nA1585 | Specify a complete questionnaire.\nA1649 | You can’t skip this step if you provide a questionnaire response.\nA1650 | Specify Submit, Save for Later or Skip. This step type doesn't support other actions.\nA1651 | This step is required.\n- | All answered questions must be questions from the associated questionnaire.\n- | All answers you submit must match the expected format for that question type.\n- | This questionnaire has already been skipped. You can’t submit it again.\n- | This questionnaire is now closed. You can no longer submit new responses or change your existing responses.\n- | This questionnaire was submitted already. You can’t submit it again.\n- | This questionnaire was submitted already. You can’t submit it again.\n- | You cannot submit answers to branching questions without answers for parent questions.\n- | You have selected an invalid answer choice.\n- | You have submitted more multiple choice answers than is allowed for a question.\n- | You have submitted more than one answer for a single select multiple choice question.\n- | You must answer all required questions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "401": { "description": "Invalid resource or operation. (https://community.workday.com/rest/error-messages)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "default": { "description": "An error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE", "exampleSetFlag": false }, "exampleSetFlag": false } } } }, "extensions": { "x-workday-try-enabled": "false", "x-codegen-request-body-name": "completeQuestionnaireEventStep" } } }, "2023.28/types/{ID}/attachmentCategories": { "get": { "tags": [ "07/15/2023" ], "summary": "Modified this existing endpoint", "description": "## Security changed \n|
Updated Value
| \n| :--- | \n|
Core Navigation, Public Business Processes
| \n\n|
Added Domains
|
Removed Domains
| \n| :--- | :--- | \n|
Core Navigation
|
None
| \n\n## Scope changed \n|
Updated Value
| \n| :--- | \n|
Adaptive Planning For Financial Plans, Adaptive Planning For The Workforce, Tenant Non-Configurable
| \n\n|
Added Domains
|
Removed Domains
| \n| :--- | :--- | \n|
Adaptive Planning For Financial Plans
|
None
| \n|
Adaptive Planning For The Workforce
|
| \n\n
\n\n
\n View this Endpoint: GET /types/{ID}/attachmentCategories\n
\n
" } }, "2023.28/events/{ID}/attachments": { "get": { "tags": [ "07/15/2023" ], "summary": "Modified this existing endpoint", "description": "## Security changed \n|
Updated Value
| \n| :--- | \n|
Core Navigation, Public Business Processes
| \n\n|
Added Domains
|
Removed Domains
| \n| :--- | :--- | \n|
Core Navigation
|
None
| \n\n## Scope changed \n|
Updated Value
| \n| :--- | \n|
Adaptive Planning For Financial Plans, Adaptive Planning For The Workforce, Tenant Non-Configurable
| \n\n|
Added Domains
|
Removed Domains
| \n| :--- | :--- | \n|
Adaptive Planning For Financial Plans
|
None
| \n|
Adaptive Planning For The Workforce
|
| \n\n
\n\n
\n View this Endpoint: GET /events/{ID}/attachments\n
\n
" } }, "2023.28/events/{ID}/comments": { "get": { "tags": [ "07/15/2023" ], "summary": "Security has been changed", "description": "## Security changed \n|
Updated Value
| \n| :--- | \n|
Core Navigation, Public Business Processes
| \n\n|
Added Domains
|
Removed Domains
| \n| :--- | :--- | \n|
Public Business Processes
|
None
| \n\n
\n\n
\n View this Endpoint: GET /events/{ID}/comments\n
\n
" } }, "2023.28/eventSteps/{ID}/sendBack": { "post": { "tags": [ "07/15/2023" ], "summary": "Modified this existing endpoint", "description": "## Security changed \n|
Updated Value
| \n| :--- | \n|
Core Navigation, Public Business Processes
| \n\n|
Added Domains
|
Removed Domains
| \n| :--- | :--- | \n|
Core Navigation
|
None
| \n\n## Scope changed \n|
Updated Value
| \n| :--- | \n|
Adaptive Planning For Financial Plans, Adaptive Planning For The Workforce, Tenant Non-Configurable
| \n\n|
Added Domains
|
Removed Domains
| \n| :--- | :--- | \n|
Adaptive Planning For Financial Plans
|
None
| \n|
Adaptive Planning For The Workforce
|
| \n\n
\n\n
\n View this Endpoint: POST /eventSteps/{ID}/sendBack\n
\n
" } }, "2024.24/types": { "get": { "tags": [ "06/15/2024" ], "summary": "Modified this existing endpoint", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Retrieves a collection of business process types.
Secured by: Public Business Processes
Scope: Tenant Non-Configurable
|
Retrieves a collection of business process types.
| \n\n## Security changed \n|
Updated Value
| \n| :--- | \n|
| \n\n|
Added Domains
|
Removed Domains
| \n| :--- | :--- | \n|
None
|
Public Business Processes
| \n\n## Scope changed \n|
Updated Value
| \n| :--- | \n|
| \n\n|
Added Domains
|
Removed Domains
| \n| :--- | :--- | \n|
None
|
Tenant Non-Configurable
| \n\n
\n\n
\n View this Endpoint: GET /types\n
\n
" } }, "2024.24/types/{ID}": { "get": { "tags": [ "06/15/2024" ], "summary": "Modified this existing endpoint", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Retrieves the business process type specified by the ID.
Secured by: Public Business Processes
Scope: Tenant Non-Configurable
|
Retrieves the business process type specified by the ID.
| \n\n## Security changed \n|
Updated Value
| \n| :--- | \n|
| \n\n|
Added Domains
|
Removed Domains
| \n| :--- | :--- | \n|
None
|
Public Business Processes
| \n\n## Scope changed \n|
Updated Value
| \n| :--- | \n|
| \n\n|
Added Domains
|
Removed Domains
| \n| :--- | :--- | \n|
None
|
Tenant Non-Configurable
| \n\n
\n\n
\n View this Endpoint: GET /types/{ID}\n
\n
" } }, "2024.24/types/{ID}/attachmentCategories": { "get": { "tags": [ "06/15/2024" ], "summary": "Modified this existing endpoint", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Retrieves all attachment categories for the specified business process type that the processing user can select for the specified event. You can filter by event target.
Secured by: Core Navigation, Public Business Processes
Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Tenant Non-Configurable
|
Retrieves all attachment categories for the specified business process type that the processing user can select for the specified event. You can filter by event target.
| \n\n## Security changed \n|
Updated Value
| \n| :--- | \n|
| \n\n|
Added Domains
|
Removed Domains
| \n| :--- | :--- | \n|
None
|
Core Navigation
| \n|
|
Public Business Processes
| \n\n## Scope changed \n|
Updated Value
| \n| :--- | \n|
| \n\n|
Added Domains
|
Removed Domains
| \n| :--- | :--- | \n|
None
|
Adaptive Planning For Financial Plans
| \n|
|
Adaptive Planning For The Workforce
| \n|
|
Tenant Non-Configurable
| \n\n
\n\n
\n View this Endpoint: GET /types/{ID}/attachmentCategories\n
\n
" } }, "2024.24/eventSteps/{ID}/toDo": { "post": { "tags": [ "06/15/2024" ], "summary": "Modified this existing endpoint", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Post an action for a To Do step in a business process.\nSpecify these required fields in the request body: {stepAction}.\nYou can add an optional comment, if enabled at tenant or business process level.
Valid values for stepAction are:\n{ \"id\": \"133d5c88baa64136aab041c1d2e9ed53\" } for Submit, \n{ \"id\": \"d9e41d34446c11de98360015c5e6daf6\" } for Save for Later.
Secured by: Core Navigation, Public Business Processes
Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Tenant Non-Configurable
|
Post an action for a To Do step in a business process.\nSpecify these required fields in the request body: {stepAction}.\nYou can add an optional comment, if enabled at tenant or business process level.
Valid values for stepAction are:\n{ \"id\": \"133d5c88baa64136aab041c1d2e9ed53\" } for Submit, \n{ \"id\": \"d9e41d34446c11de98360015c5e6daf6\" } for Save for Later.
| \n\n## Security changed \n|
Updated Value
| \n| :--- | \n|
| \n\n|
Added Domains
|
Removed Domains
| \n| :--- | :--- | \n|
None
|
Core Navigation
| \n|
|
Public Business Processes
| \n\n## Scope changed \n|
Updated Value
| \n| :--- | \n|
| \n\n|
Added Domains
|
Removed Domains
| \n| :--- | :--- | \n|
None
|
Adaptive Planning For Financial Plans
| \n|
|
Adaptive Planning For The Workforce
| \n|
|
Tenant Non-Configurable
| \n\n
\n\n
\n View this Endpoint: POST /eventSteps/{ID}/toDo\n
\n
" } }, "2024.24/events": { "get": { "tags": [ "06/15/2024" ], "summary": "Modified this existing endpoint", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Retrieves a collection of business process events based on the specified parameters. You must specify exactly one worker parameter. If a worker parameter is not specified, returns a blank response.
Secured by: Core Navigation, Public Business Processes
Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Tenant Non-Configurable
|
Retrieves a collection of business process events based on the specified parameters. You must specify exactly one worker parameter. If a worker parameter is not specified, returns a blank response.
| \n\n## Security changed \n|
Updated Value
| \n| :--- | \n|
| \n\n|
Added Domains
|
Removed Domains
| \n| :--- | :--- | \n|
None
|
Core Navigation
| \n|
|
Public Business Processes
| \n\n## Scope changed \n|
Updated Value
| \n| :--- | \n|
| \n\n|
Added Domains
|
Removed Domains
| \n| :--- | :--- | \n|
None
|
Adaptive Planning For Financial Plans
| \n|
|
Adaptive Planning For The Workforce
| \n|
|
Tenant Non-Configurable
| \n\n
\n\n
\n View this Endpoint: GET /events\n
\n
" } }, "2024.24/events/{ID}/attachments": { "get": { "tags": [ "06/15/2024" ], "summary": "Modified this existing endpoint", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Retrieves attachments on the specified business process event that the processing user has permission to view.
Secured by: Core Navigation, Public Business Processes
Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Tenant Non-Configurable
|
Retrieves attachments on the specified business process event that the processing user has permission to view.
| \n\n## Security changed \n|
Updated Value
| \n| :--- | \n|
| \n\n|
Added Domains
|
Removed Domains
| \n| :--- | :--- | \n|
None
|
Core Navigation
| \n|
|
Public Business Processes
| \n\n## Scope changed \n|
Updated Value
| \n| :--- | \n|
| \n\n|
Added Domains
|
Removed Domains
| \n| :--- | :--- | \n|
None
|
Adaptive Planning For Financial Plans
| \n|
|
Adaptive Planning For The Workforce
| \n|
|
Tenant Non-Configurable
| \n\n
\n\n
\n View this Endpoint: GET /events/{ID}/attachments\n
\n
" } }, "2024.24/events/{ID}/comments": { "get": { "tags": [ "06/15/2024" ], "summary": "Modified this existing endpoint", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Retrieves comments on the specified business process event.
Secured by: Core Navigation, Public Business Processes
Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Tenant Non-Configurable
|
Retrieves comments on the specified business process event.
| \n\n## Security changed \n|
Updated Value
| \n| :--- | \n|
| \n\n|
Added Domains
|
Removed Domains
| \n| :--- | :--- | \n|
None
|
Core Navigation
| \n|
|
Public Business Processes
| \n\n## Scope changed \n|
Updated Value
| \n| :--- | \n|
| \n\n|
Added Domains
|
Removed Domains
| \n| :--- | :--- | \n|
None
|
Adaptive Planning For Financial Plans
| \n|
|
Adaptive Planning For The Workforce
| \n|
|
Tenant Non-Configurable
| \n\n
\n\n
\n View this Endpoint: GET /events/{ID}/comments\n
\n
" } }, "2024.24/events/{ID}/inProgressSteps": { "get": { "tags": [ "06/15/2024" ], "summary": "Modified this existing endpoint", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Retrieves all business process steps that are currently in progress for the specified business process event.
Secured by: Core Navigation, Public Business Processes
Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Tenant Non-Configurable
|
Retrieves all business process steps that are currently in progress for the specified business process event.
| \n\n## Security changed \n|
Updated Value
| \n| :--- | \n|
| \n\n|
Added Domains
|
Removed Domains
| \n| :--- | :--- | \n|
None
|
Core Navigation
| \n|
|
Public Business Processes
| \n\n## Scope changed \n|
Updated Value
| \n| :--- | \n|
| \n\n|
Added Domains
|
Removed Domains
| \n| :--- | :--- | \n|
None
|
Adaptive Planning For Financial Plans
| \n|
|
Adaptive Planning For The Workforce
| \n|
|
Tenant Non-Configurable
| \n\n
\n\n
\n View this Endpoint: GET /events/{ID}/inProgressSteps\n
\n
" } }, "2024.24/eventSteps/{ID}/deny": { "post": { "tags": [ "06/15/2024" ], "summary": "Modified this existing endpoint", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Denies the business process event step specified by the ID of the originating event step. The processing person must have view access to the event. In the request body, specify these required fields: id (the event step you are denying), stepAction{id} (if there are multiple event steps), comment.
Secured by: Core Navigation, Public Business Processes
Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Tenant Non-Configurable
|
Denies the business process event step specified by the ID of the originating event step. The processing person must have view access to the event. In the request body, specify these required fields: id (the event step you are denying), stepAction{id} (if there are multiple event steps), comment.
| \n\n## Security changed \n|
Updated Value
| \n| :--- | \n|
| \n\n|
Added Domains
|
Removed Domains
| \n| :--- | :--- | \n|
None
|
Core Navigation
| \n|
|
Public Business Processes
| \n\n## Scope changed \n|
Updated Value
| \n| :--- | \n|
| \n\n|
Added Domains
|
Removed Domains
| \n| :--- | :--- | \n|
None
|
Adaptive Planning For Financial Plans
| \n|
|
Adaptive Planning For The Workforce
| \n|
|
Tenant Non-Configurable
| \n\n
\n\n
\n View this Endpoint: POST /eventSteps/{ID}/deny\n
\n
" } }, "2024.24/events/{ID}/remainingSteps": { "get": { "tags": [ "06/15/2024" ], "summary": "Modified this existing endpoint", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Retrieves all remaining business process steps for the specified business process event.
Secured by: Core Navigation, Public Business Processes
Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Tenant Non-Configurable
|
Retrieves all remaining business process steps for the specified business process event.
| \n\n## Security changed \n|
Updated Value
| \n| :--- | \n|
| \n\n|
Added Domains
|
Removed Domains
| \n| :--- | :--- | \n|
None
|
Core Navigation
| \n|
|
Public Business Processes
| \n\n## Scope changed \n|
Updated Value
| \n| :--- | \n|
| \n\n|
Added Domains
|
Removed Domains
| \n| :--- | :--- | \n|
None
|
Adaptive Planning For Financial Plans
| \n|
|
Adaptive Planning For The Workforce
| \n|
|
Tenant Non-Configurable
| \n\n
\n\n
\n View this Endpoint: GET /events/{ID}/remainingSteps\n
\n
" } }, "2024.24/events/{ID}": { "get": { "tags": [ "06/15/2024" ], "summary": "Modified this existing endpoint", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Retrieves the business process event with the specified ID.
Secured by: Core Navigation, Public Business Processes
Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Tenant Non-Configurable
|
Retrieves the business process event with the specified ID.
| \n\n## Security changed \n|
Updated Value
| \n| :--- | \n|
| \n\n|
Added Domains
|
Removed Domains
| \n| :--- | :--- | \n|
None
|
Core Navigation
| \n|
|
Public Business Processes
| \n\n## Scope changed \n|
Updated Value
| \n| :--- | \n|
| \n\n|
Added Domains
|
Removed Domains
| \n| :--- | :--- | \n|
None
|
Adaptive Planning For Financial Plans
| \n|
|
Adaptive Planning For The Workforce
| \n|
|
Tenant Non-Configurable
| \n\n
\n\n
\n View this Endpoint: GET /events/{ID}\n
\n
" } }, "2024.24/eventSteps/{ID}/approve": { "post": { "tags": [ "06/15/2024" ], "summary": "Modified this existing endpoint", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Approves the business process event step specified by the ID of the originating event step. In the request body, specify these required fields: id (the event step you are approving), comment.
Secured by: Core Navigation, Public Business Processes
Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Tenant Non-Configurable
|
Approves the business process event step specified by the ID of the originating event step. In the request body, specify these required fields: id (the event step you are approving), comment.
| \n\n## Security changed \n|
Updated Value
| \n| :--- | \n|
| \n\n|
Added Domains
|
Removed Domains
| \n| :--- | :--- | \n|
None
|
Core Navigation
| \n|
|
Public Business Processes
| \n\n## Scope changed \n|
Updated Value
| \n| :--- | \n|
| \n\n|
Added Domains
|
Removed Domains
| \n| :--- | :--- | \n|
None
|
Adaptive Planning For Financial Plans
| \n|
|
Adaptive Planning For The Workforce
| \n|
|
Tenant Non-Configurable
| \n\n
\n\n
\n View this Endpoint: POST /eventSteps/{ID}/approve\n
\n
" } }, "2024.24/eventSteps/{ID}/sendBack": { "post": { "tags": [ "06/15/2024" ], "summary": "Modified this existing endpoint", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Sends back the business process event step specified by the ID of the originating event step. In the request body, specify these required fields: id (the event step you are sending back), reason.
Secured by: Core Navigation, Public Business Processes
Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Tenant Non-Configurable
|
Sends back the business process event step specified by the ID of the originating event step. In the request body, specify these required fields: id (the event step you are sending back), reason.
| \n\n## Security changed \n|
Updated Value
| \n| :--- | \n|
| \n\n|
Added Domains
|
Removed Domains
| \n| :--- | :--- | \n|
None
|
Core Navigation
| \n|
|
Public Business Processes
| \n\n## Scope changed \n|
Updated Value
| \n| :--- | \n|
| \n\n|
Added Domains
|
Removed Domains
| \n| :--- | :--- | \n|
None
|
Adaptive Planning For Financial Plans
| \n|
|
Adaptive Planning For The Workforce
| \n|
|
Tenant Non-Configurable
| \n\n
\n\n
\n View this Endpoint: POST /eventSteps/{ID}/sendBack\n
\n
" } }, "2024.24/eventSteps": { "get": { "tags": [ "06/15/2024" ], "summary": "Modified this existing endpoint", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Retrieves a collection of business process event steps. You can filter the event steps by business process, creation date, due date, and step type.
Secured by: Core Navigation, Public Business Processes
Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Tenant Non-Configurable
|
Retrieves a collection of business process event steps. You can filter the event steps by business process, creation date, due date, and step type.
| \n\n## Security changed \n|
Updated Value
| \n| :--- | \n|
| \n\n|
Added Domains
|
Removed Domains
| \n| :--- | :--- | \n|
None
|
Core Navigation
| \n|
|
Public Business Processes
| \n\n## Scope changed \n|
Updated Value
| \n| :--- | \n|
| \n\n|
Added Domains
|
Removed Domains
| \n| :--- | :--- | \n|
None
|
Adaptive Planning For Financial Plans
| \n|
|
Adaptive Planning For The Workforce
| \n|
|
Tenant Non-Configurable
| \n\n
\n\n
\n View this Endpoint: GET /eventSteps\n
\n
" } }, "2024.24/events/{ID}/completedSteps": { "get": { "tags": [ "06/15/2024" ], "summary": "Modified this existing endpoint", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Retrieves all business process steps that are completed for the specified buinesss process event.
Secured by: Core Navigation, Public Business Processes
Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Tenant Non-Configurable
|
Retrieves all business process steps that are completed for the specified buinesss process event.
| \n\n## Security changed \n|
Updated Value
| \n| :--- | \n|
| \n\n|
Added Domains
|
Removed Domains
| \n| :--- | :--- | \n|
None
|
Core Navigation
| \n|
|
Public Business Processes
| \n\n## Scope changed \n|
Updated Value
| \n| :--- | \n|
| \n\n|
Added Domains
|
Removed Domains
| \n| :--- | :--- | \n|
None
|
Adaptive Planning For Financial Plans
| \n|
|
Adaptive Planning For The Workforce
| \n|
|
Tenant Non-Configurable
| \n\n
\n\n
\n View this Endpoint: GET /events/{ID}/completedSteps\n
\n
" } }, "2024.24/eventSteps/{ID}": { "get": { "tags": [ "06/15/2024" ], "summary": "Modified this existing endpoint", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Returns a business process event step. Returned results are secured based on processing person's view access to the event to which the step belongs. If the processing person does not have view access to the event, when this API is called, they will not be able to retrieve the event step and receive a 404 error.
Secured by: Core Navigation, Public Business Processes
Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Tenant Non-Configurable
|
Returns a business process event step. Returned results are secured based on processing person's view access to the event to which the step belongs. If the processing person does not have view access to the event, when this API is called, they will not be able to retrieve the event step and receive a 404 error.
| \n\n## Security changed \n|
Updated Value
| \n| :--- | \n|
| \n\n|
Added Domains
|
Removed Domains
| \n| :--- | :--- | \n|
None
|
Core Navigation
| \n|
|
Public Business Processes
| \n\n## Scope changed \n|
Updated Value
| \n| :--- | \n|
| \n\n|
Added Domains
|
Removed Domains
| \n| :--- | :--- | \n|
None
|
Adaptive Planning For Financial Plans
| \n|
|
Adaptive Planning For The Workforce
| \n|
|
Tenant Non-Configurable
| \n\n
\n\n
\n View this Endpoint: GET /eventSteps/{ID}\n
\n
" } }, "2024.24/eventSteps/{ID}/questionnaire": { "post": { "tags": [ "06/15/2024" ], "summary": "Modified this existing endpoint", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Post an action for a Complete Questionnaire step in a business process.\nSpecify these required fields in the request body if the intended action is Submit or Save for Later: {stepAction, questionnaireResponse}.\nYou can send Save for Later multiple times, but {questionnaireResponse} values will replace the existing questionnaire answers. \nIf the intended action is Skip, exclude {questionnaireResponse} from the request body.
Valid values for stepAction are:\n{ \"id\": \"133d5c88baa64136aab041c1d2e9ed53\" } for Submit, \n{ \"id\": \"d9e41a8c446c11de98360015c5e6daf6\" } for Save for Later,\n{ \"id\": \"d9e4231a446c11de98360015c5e6daf6\" } for Skip.
Secured by: Core Navigation, Public Business Processes
Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Tenant Non-Configurable
|
Post an action for a Complete Questionnaire step in a business process.\nSpecify these required fields in the request body if the intended action is Submit or Save for Later: {stepAction, questionnaireResponse}.\nYou can send Save for Later multiple times, but {questionnaireResponse} values will replace the existing questionnaire answers. \nIf the intended action is Skip, exclude {questionnaireResponse} from the request body.
Valid values for stepAction are:\n{ \"id\": \"133d5c88baa64136aab041c1d2e9ed53\" } for Submit, \n{ \"id\": \"d9e41a8c446c11de98360015c5e6daf6\" } for Save for Later,\n{ \"id\": \"d9e4231a446c11de98360015c5e6daf6\" } for Skip.
| \n\n## Security changed \n|
Updated Value
| \n| :--- | \n|
| \n\n|
Added Domains
|
Removed Domains
| \n| :--- | :--- | \n|
None
|
Core Navigation
| \n|
|
Public Business Processes
| \n\n## Scope changed \n|
Updated Value
| \n| :--- | \n|
| \n\n|
Added Domains
|
Removed Domains
| \n| :--- | :--- | \n|
None
|
Adaptive Planning For Financial Plans
| \n|
|
Adaptive Planning For The Workforce
| \n|
|
Tenant Non-Configurable
| \n\n
\n\n
\n View this Endpoint: POST /eventSteps/{ID}/questionnaire\n
\n
" } }, "2024.39/events/{ID}/cancel": { "post": { "tags": [ "09/28/2024" ], "summary": "Added new operation", "description": "Cancels the business process event specified by the ID. In the request body, specify these required fields: comment.\n\nSecured by: Core Navigation, Public Business Processes\n\nScope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Tenant Non-Configurable
\n\n
\n View this Endpoint: POST /events/{ID}/cancel\n
\n
", "parameters": [ { "name": "ID", "in": "path", "description": "The Workday ID of the resource.", "required": true, "explode": false, "schema": { "type": "string", "exampleSetFlag": false, "types": [ "string" ] } } ], "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/businessProcessEventAction_46302b0ce6a810001fcbad0bc1e30000", "exampleSetFlag": false }, "exampleSetFlag": false } }, "required": true }, "responses": { "201": { "description": "Resource created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/businessProcessEventAction_46302b0ce6a810001fcbad0bc1e30000", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\nError Code | Validation Message\n--- | ---\nA181 | You need to specify a comment.\nA219 | You can't cancel this business process because the event isn't in progress or in error.\nA2198 | You can't cancel this event because this action isn't supported on the subprocess.\nA2199 | You can't cancel this event because this action isn't supported on the business process.\nA2200 | You can't cancel this event because this action isn't currently supported on the business process.\nA2201 | You currently don't have security access to cancel this event.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "401": { "description": "Invalid resource or operation. (https://community.workday.com/rest/error-messages)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "default": { "description": "An error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE", "exampleSetFlag": false }, "exampleSetFlag": false } } } }, "extensions": { "x-workday-confidence-level": "Production", "x-workday-internal-try-enabled": "false", "x-codegen-request-body-name": "businessProcessEventAction" } } }, "2025.20/events/{ID}/rescind": { "post": { "tags": [ "05/17/2025" ], "summary": "Added new operation", "description": "Rescinds the business process event specified by the ID. In the request body, specify these required fields: comment.\n\nSecured by: Core Navigation, Public Business Processes\n\nScope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Tenant Non-Configurable
\n\n
\n View this Endpoint: POST /events/{ID}/rescind\n
\n
", "parameters": [ { "name": "ID", "in": "path", "description": "The Workday ID of the resource.", "required": true, "explode": false, "schema": { "type": "string", "exampleSetFlag": false, "types": [ "string" ] } } ], "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/businessProcessEventAction_46302b0ce6a810001fcbad0bc1e30000", "exampleSetFlag": false }, "exampleSetFlag": false } }, "required": true }, "responses": { "201": { "description": "Resource created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/businessProcessEventAction_46302b0ce6a810001fcbad0bc1e30000", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\nError Code | Validation Message\n--- | ---\nA181 | You need to specify a comment.\nA219 | You can't rescind this event because the status isn't Successfully Completed.\nA2443 | You currently don't have security access to rescind this event.\nA2444 | You can't rescind this event because this action isn't supported on the business process.\nA2444 | You can't rescind this event because this action isn't supported on this business process: [businessprocesstype]\nA2445 | You can't rescind this event because this action isn't supported on the subprocess.\nA2453 | You can't rescind this event because this event is delegated to someone.\nA2454 | You can't rescind this event because there are subevents still in progress.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "401": { "description": "Invalid resource or operation. (https://community.workday.com/rest/error-messages)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "default": { "description": "An error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE", "exampleSetFlag": false }, "exampleSetFlag": false } } } }, "extensions": { "x-workday-confidence-level": "Production", "x-workday-internal-try-enabled": "false", "x-codegen-request-body-name": "businessProcessEventAction" } } }, "2025.49/values/sendBack/to/": { "get": { "tags": [ "12/06/2025" ], "summary": "Description has been changed", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Retrieves instances that can be used as values for other endpoint parameters in this service.
Secured by: Public Business Processes
Scope: Tenant Non-Configurable
|
Retrieves instances that can be used as values for other endpoint parameters in this service.
| \n\n
\n\n
\n View this Endpoint: GET /values/sendBack/to/\n
\n
" } }, "2025.50/types": { "get": { "tags": [ "12/15/2025" ], "summary": "Parameters have been modified.", "description": "
\n\n
\n View this Endpoint: GET /types\n
\n
", "parameters": [ { "name": "limit", "in": "query", "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100.", "required": false, "style": "FORM", "explode": true, "schema": { "type": "integer", "format": "int64", "exampleSetFlag": false, "types": [ "integer" ] } }, { "name": "offset", "in": "query", "description": "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.", "required": false, "style": "FORM", "explode": true, "schema": { "type": "integer", "format": "int64", "exampleSetFlag": false, "types": [ "integer" ] } } ] } }, "2025.50/events/{ID}/rescind": { "post": { "tags": [ "12/15/2025" ], "summary": "Parameters have been modified.", "description": "
\n\n
\n View this Endpoint: POST /events/{ID}/rescind\n
\n
", "parameters": [ { "name": "ID", "in": "path", "description": "The Workday ID of the resource.", "required": true, "style": "SIMPLE", "explode": false, "schema": { "type": "string", "exampleSetFlag": false, "types": [ "string" ] } } ] } }, "2025.50/types/{ID}": { "get": { "tags": [ "12/15/2025" ], "summary": "Parameters have been modified.", "description": "
\n\n
\n View this Endpoint: GET /types/{ID}\n
\n
", "parameters": [ { "name": "ID", "in": "path", "description": "The Workday ID of the resource.", "required": true, "style": "SIMPLE", "explode": false, "schema": { "type": "string", "exampleSetFlag": false, "types": [ "string" ] } } ] } }, "2025.50/events/{ID}/cancel": { "post": { "tags": [ "12/15/2025" ], "summary": "Parameters have been modified.", "description": "
\n\n
\n View this Endpoint: POST /events/{ID}/cancel\n
\n
", "parameters": [ { "name": "ID", "in": "path", "description": "The Workday ID of the resource.", "required": true, "style": "SIMPLE", "explode": false, "schema": { "type": "string", "exampleSetFlag": false, "types": [ "string" ] } } ] } }, "2025.50/types/{ID}/attachmentCategories": { "get": { "tags": [ "12/15/2025" ], "summary": "Parameters have been modified.", "description": "
\n\n
\n View this Endpoint: GET /types/{ID}/attachmentCategories\n
\n
", "parameters": [ { "name": "ID", "in": "path", "description": "The Workday ID of the resource.", "required": true, "style": "SIMPLE", "explode": false, "schema": { "type": "string", "exampleSetFlag": false, "types": [ "string" ] } }, { "name": "eventTarget", "in": "query", "description": "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.", "required": false, "style": "FORM", "explode": true, "schema": { "type": "string", "exampleSetFlag": false, "types": [ "string" ] } }, { "name": "limit", "in": "query", "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100.", "required": false, "style": "FORM", "explode": true, "schema": { "type": "integer", "format": "int64", "exampleSetFlag": false, "types": [ "integer" ] } }, { "name": "offset", "in": "query", "description": "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.", "required": false, "style": "FORM", "explode": true, "schema": { "type": "integer", "format": "int64", "exampleSetFlag": false, "types": [ "integer" ] } } ] } }, "2025.50/eventSteps/{ID}/toDo": { "post": { "tags": [ "12/15/2025" ], "summary": "Parameters have been modified.", "description": "
\n\n
\n View this Endpoint: POST /eventSteps/{ID}/toDo\n
\n
", "parameters": [ { "name": "ID", "in": "path", "description": "The Workday ID of the resource.", "required": true, "style": "SIMPLE", "explode": false, "schema": { "type": "string", "exampleSetFlag": false, "types": [ "string" ] } } ] } }, "2025.50/events": { "get": { "tags": [ "12/15/2025" ], "summary": "Parameters have been modified.", "description": "
\n\n
\n View this Endpoint: GET /events\n
\n
", "parameters": [ { "name": "completedOnOrAfter", "in": "query", "required": false, "style": "FORM", "explode": true, "schema": { "type": "string", "format": "date", "exampleSetFlag": false, "types": [ "string" ] } }, { "name": "completedOnOrBefore", "in": "query", "required": false, "style": "FORM", "explode": true, "schema": { "type": "string", "format": "date", "exampleSetFlag": false, "types": [ "string" ] } }, { "name": "initiatedOnOrAfter", "in": "query", "required": false, "style": "FORM", "explode": true, "schema": { "type": "string", "format": "date", "exampleSetFlag": false, "types": [ "string" ] } }, { "name": "initiatedOnOrBefore", "in": "query", "required": false, "style": "FORM", "explode": true, "schema": { "type": "string", "format": "date", "exampleSetFlag": false, "types": [ "string" ] } }, { "name": "limit", "in": "query", "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100.", "required": false, "style": "FORM", "explode": true, "schema": { "type": "integer", "format": "int64", "exampleSetFlag": false, "types": [ "integer" ] } }, { "name": "offset", "in": "query", "description": "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.", "required": false, "style": "FORM", "explode": true, "schema": { "type": "integer", "format": "int64", "exampleSetFlag": false, "types": [ "integer" ] } }, { "name": "worker", "in": "query", "required": false, "style": "FORM", "explode": true, "schema": { "type": "string", "exampleSetFlag": false, "types": [ "string" ] } } ] } }, "2025.50/events/{ID}/attachments": { "get": { "tags": [ "12/15/2025" ], "summary": "Parameters have been modified.", "description": "
\n\n
\n View this Endpoint: GET /events/{ID}/attachments\n
\n
", "parameters": [ { "name": "ID", "in": "path", "description": "The Workday ID of the resource.", "required": true, "style": "SIMPLE", "explode": false, "schema": { "type": "string", "exampleSetFlag": false, "types": [ "string" ] } }, { "name": "limit", "in": "query", "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100.", "required": false, "style": "FORM", "explode": true, "schema": { "type": "integer", "format": "int64", "exampleSetFlag": false, "types": [ "integer" ] } }, { "name": "offset", "in": "query", "description": "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.", "required": false, "style": "FORM", "explode": true, "schema": { "type": "integer", "format": "int64", "exampleSetFlag": false, "types": [ "integer" ] } } ] } }, "2025.50/events/{ID}/comments": { "get": { "tags": [ "12/15/2025" ], "summary": "Parameters have been modified.", "description": "
\n\n
\n View this Endpoint: GET /events/{ID}/comments\n
\n
", "parameters": [ { "name": "ID", "in": "path", "description": "The Workday ID of the resource.", "required": true, "style": "SIMPLE", "explode": false, "schema": { "type": "string", "exampleSetFlag": false, "types": [ "string" ] } }, { "name": "limit", "in": "query", "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100.", "required": false, "style": "FORM", "explode": true, "schema": { "type": "integer", "format": "int64", "exampleSetFlag": false, "types": [ "integer" ] } }, { "name": "offset", "in": "query", "description": "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.", "required": false, "style": "FORM", "explode": true, "schema": { "type": "integer", "format": "int64", "exampleSetFlag": false, "types": [ "integer" ] } } ] } }, "2025.50/events/{ID}/inProgressSteps": { "get": { "tags": [ "12/15/2025" ], "summary": "Parameters have been modified.", "description": "
\n\n
\n View this Endpoint: GET /events/{ID}/inProgressSteps\n
\n
", "parameters": [ { "name": "ID", "in": "path", "description": "The Workday ID of the resource.", "required": true, "style": "SIMPLE", "explode": false, "schema": { "type": "string", "exampleSetFlag": false, "types": [ "string" ] } }, { "name": "limit", "in": "query", "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100.", "required": false, "style": "FORM", "explode": true, "schema": { "type": "integer", "format": "int64", "exampleSetFlag": false, "types": [ "integer" ] } }, { "name": "offset", "in": "query", "description": "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.", "required": false, "style": "FORM", "explode": true, "schema": { "type": "integer", "format": "int64", "exampleSetFlag": false, "types": [ "integer" ] } } ] } }, "2025.50/eventSteps/{ID}/deny": { "post": { "tags": [ "12/15/2025" ], "summary": "Parameters have been modified.", "description": "
\n\n
\n View this Endpoint: POST /eventSteps/{ID}/deny\n
\n
", "parameters": [ { "name": "ID", "in": "path", "description": "The Workday ID of the resource.", "required": true, "style": "SIMPLE", "explode": false, "schema": { "type": "string", "exampleSetFlag": false, "types": [ "string" ] } } ] } }, "2025.50/events/{ID}/remainingSteps": { "get": { "tags": [ "12/15/2025" ], "summary": "Parameters have been modified.", "description": "
\n\n
\n View this Endpoint: GET /events/{ID}/remainingSteps\n
\n
", "parameters": [ { "name": "ID", "in": "path", "description": "The Workday ID of the resource.", "required": true, "style": "SIMPLE", "explode": false, "schema": { "type": "string", "exampleSetFlag": false, "types": [ "string" ] } }, { "name": "limit", "in": "query", "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100.", "required": false, "style": "FORM", "explode": true, "schema": { "type": "integer", "format": "int64", "exampleSetFlag": false, "types": [ "integer" ] } }, { "name": "offset", "in": "query", "description": "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.", "required": false, "style": "FORM", "explode": true, "schema": { "type": "integer", "format": "int64", "exampleSetFlag": false, "types": [ "integer" ] } } ] } }, "2025.50/events/{ID}": { "get": { "tags": [ "12/15/2025" ], "summary": "Parameters have been modified.", "description": "
\n\n
\n View this Endpoint: GET /events/{ID}\n
\n
", "parameters": [ { "name": "ID", "in": "path", "description": "The Workday ID of the resource.", "required": true, "style": "SIMPLE", "explode": false, "schema": { "type": "string", "exampleSetFlag": false, "types": [ "string" ] } } ] } }, "2025.50/eventSteps/{ID}/approve": { "post": { "tags": [ "12/15/2025" ], "summary": "Parameters have been modified.", "description": "
\n\n
\n View this Endpoint: POST /eventSteps/{ID}/approve\n
\n
", "parameters": [ { "name": "ID", "in": "path", "description": "The Workday ID of the resource.", "required": true, "style": "SIMPLE", "explode": false, "schema": { "type": "string", "exampleSetFlag": false, "types": [ "string" ] } } ] } }, "2025.50/eventSteps/{ID}/sendBack": { "post": { "tags": [ "12/15/2025" ], "summary": "Parameters have been modified.", "description": "
\n\n
\n View this Endpoint: POST /eventSteps/{ID}/sendBack\n
\n
", "parameters": [ { "name": "ID", "in": "path", "description": "The Workday ID of the resource.", "required": true, "style": "SIMPLE", "explode": false, "schema": { "type": "string", "exampleSetFlag": false, "types": [ "string" ] } } ] } }, "2025.50/eventSteps": { "get": { "tags": [ "12/15/2025" ], "summary": "Parameters have been modified.", "description": "
\n\n
\n View this Endpoint: GET /eventSteps\n
\n
", "parameters": [ { "name": "createdOnOrAfter", "in": "query", "required": false, "style": "FORM", "explode": true, "schema": { "type": "string", "format": "date", "exampleSetFlag": false, "types": [ "string" ] } }, { "name": "createdOnOrBefore", "in": "query", "required": false, "style": "FORM", "explode": true, "schema": { "type": "string", "format": "date", "exampleSetFlag": false, "types": [ "string" ] } }, { "name": "dueDateOnOrAfter", "in": "query", "required": false, "style": "FORM", "explode": true, "schema": { "type": "string", "format": "date", "exampleSetFlag": false, "types": [ "string" ] } }, { "name": "dueDateOnOrBefore", "in": "query", "required": false, "style": "FORM", "explode": true, "schema": { "type": "string", "format": "date", "exampleSetFlag": false, "types": [ "string" ] } }, { "name": "limit", "in": "query", "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100.", "required": false, "style": "FORM", "explode": true, "schema": { "type": "integer", "format": "int64", "exampleSetFlag": false, "types": [ "integer" ] } }, { "name": "offset", "in": "query", "description": "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.", "required": false, "style": "FORM", "explode": true, "schema": { "type": "integer", "format": "int64", "exampleSetFlag": false, "types": [ "integer" ] } } ] } }, "2025.50/events/{ID}/completedSteps": { "get": { "tags": [ "12/15/2025" ], "summary": "Parameters have been modified.", "description": "
\n\n
\n View this Endpoint: GET /events/{ID}/completedSteps\n
\n
", "parameters": [ { "name": "ID", "in": "path", "description": "The Workday ID of the resource.", "required": true, "style": "SIMPLE", "explode": false, "schema": { "type": "string", "exampleSetFlag": false, "types": [ "string" ] } }, { "name": "limit", "in": "query", "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100.", "required": false, "style": "FORM", "explode": true, "schema": { "type": "integer", "format": "int64", "exampleSetFlag": false, "types": [ "integer" ] } }, { "name": "offset", "in": "query", "description": "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.", "required": false, "style": "FORM", "explode": true, "schema": { "type": "integer", "format": "int64", "exampleSetFlag": false, "types": [ "integer" ] } } ] } }, "2025.50/eventSteps/{ID}": { "get": { "tags": [ "12/15/2025" ], "summary": "Parameters have been modified.", "description": "
\n\n
\n View this Endpoint: GET /eventSteps/{ID}\n
\n
", "parameters": [ { "name": "ID", "in": "path", "description": "The Workday ID of the resource.", "required": true, "style": "SIMPLE", "explode": false, "schema": { "type": "string", "exampleSetFlag": false, "types": [ "string" ] } } ] } }, "2025.50/eventSteps/{ID}/questionnaire": { "post": { "tags": [ "12/15/2025" ], "summary": "Parameters have been modified.", "description": "
\n\n
\n View this Endpoint: POST /eventSteps/{ID}/questionnaire\n
\n
", "parameters": [ { "name": "ID", "in": "path", "description": "The Workday ID of the resource.", "required": true, "style": "SIMPLE", "explode": false, "schema": { "type": "string", "exampleSetFlag": false, "types": [ "string" ] } } ] } }, "2026.11/eventSteps/{ID}/reassign": { "post": { "tags": [ "03/18/2026" ], "summary": "Added new operation", "description": "Reassigns the business process event step specified by the reference ID of the originating event step.\n\nSecured by: Core Navigation, Public Business Processes\n\nScope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Benefits, Tenant Non-Configurable
\n\n
\n View this Endpoint: POST /eventSteps/{ID}/reassign\n
\n
", "parameters": [ { "name": "ID", "in": "path", "description": "The Workday ID of the resource.", "required": true, "style": "SIMPLE", "explode": false, "schema": { "type": "string", "exampleSetFlag": false, "types": [ "string" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/businessProcessStepsReassign_bd578ca9ac8010001895bda38db00000", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "responses": { "201": { "description": "Resource created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/businessProcessStepsReassign_bd578ca9ac8010001895bda38db00000", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\nError Code | Validation Message\n--- | ---\nA2822 | Specify a comment.\nA3055 | You can't remove and add the same person to the business process step. Specify a different person for the reassignment.\nA3056 | Specify at least 1 person to remove or 1 person to add to the business process step.\nA3057 | Specify a valid person to remove from the business process step. You can't remove a person that's not a current awaiting person for the step.\nA3058 | There must be at least 1 awaiting person.\nA3059 | Specify a valid person. You can't reassign the business process step to the current awaiting person.\nA3152 | You don't have security permissions to perform this reassignment.\nA3153 | You can't reassign the event because the event record has a Completed status.\nA3154 | You can't reassign the event.\nA3173 | The role you're attempting to reassign to is blocked by routing restrictions.\nA3174 | You can't assign the business process step to a person that doesn't have an active Workday account.\nA3175 | Specify a valid role to reassign the business process step to. The person's role isn't configured or isn't part of a security group on the business process security policy to perform the action.\nA3185 | Specify a valid step type. Reassignment doesn't support this step type.\nA3186 | You can't reassign this business process step.\nA3187 | You can’t reassign the event because eSignature isn’t supported in reassignment.", "content": {} }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "default": { "description": "An error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE", "exampleSetFlag": false }, "exampleSetFlag": false } } } }, "extensions": { "x-workday-confidence-level": "Production", "x-workday-internal-try-enabled": "false" } } }, "2026.11/types/{ID}/attachmentCategories": { "get": { "tags": [ "03/18/2026" ], "summary": "Description has been changed", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Retrieves all attachment categories for the specified business process type that the processing user can select for the specified event. You can filter by event target.
Secured by: Core Navigation, Public Business Processes
Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Benefits, Tenant Non-Configurable
|
Retrieves all attachment categories for the specified business process type that the processing user can select for the specified event. You can filter by event target.
Secured by: Core Navigation, Public Business Processes
Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Tenant Non-Configurable
| \n\n
\n\n
\n View this Endpoint: GET /types/{ID}/attachmentCategories\n
\n
" } }, "2026.11/events/{ID}/rescind": { "post": { "tags": [ "03/18/2026" ], "summary": "Description has been changed", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Rescinds the business process event specified by the ID. In the request body, specify these required fields: comment.
Secured by: Core Navigation, Public Business Processes
Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Benefits, Tenant Non-Configurable
|
Rescinds the business process event specified by the ID. In the request body, specify these required fields: comment.
Secured by: Core Navigation, Public Business Processes
Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Tenant Non-Configurable
| \n\n
\n\n
\n View this Endpoint: POST /events/{ID}/rescind\n
\n
" } }, "2026.11/events/{ID}/cancel": { "post": { "tags": [ "03/18/2026" ], "summary": "Description has been changed", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Cancels the business process event specified by the ID. In the request body, specify these required fields: comment.
Secured by: Core Navigation, Public Business Processes
Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Benefits, Tenant Non-Configurable
|
Cancels the business process event specified by the ID. In the request body, specify these required fields: comment.
Secured by: Core Navigation, Public Business Processes
Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Tenant Non-Configurable
| \n\n
\n\n
\n View this Endpoint: POST /events/{ID}/cancel\n
\n
" } }, "2026.11/eventSteps/{ID}/deny": { "post": { "tags": [ "03/18/2026" ], "summary": "Description has been changed", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Denies the business process event step specified by the ID of the originating event step. The processing person must have view access to the event. In the request body, specify these required fields: id (the event step you are denying), stepAction{id} (if there are multiple event steps), comment.
Secured by: Core Navigation, Public Business Processes
Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Benefits, Tenant Non-Configurable
|
Denies the business process event step specified by the ID of the originating event step. The processing person must have view access to the event. In the request body, specify these required fields: id (the event step you are denying), stepAction{id} (if there are multiple event steps), comment.
Secured by: Core Navigation, Public Business Processes
Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Tenant Non-Configurable
| \n\n
\n\n
\n View this Endpoint: POST /eventSteps/{ID}/deny\n
\n
" } }, "2026.11/eventSteps/{ID}/toDo": { "post": { "tags": [ "03/18/2026" ], "summary": "Description has been changed", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Post an action for a To Do step in a business process.\nSpecify these required fields in the request body: {stepAction}.\nYou can add an optional comment, if enabled at tenant or business process level.
Valid values for stepAction are:\n{ \"id\": \"133d5c88baa64136aab041c1d2e9ed53\" } for Submit, \n{ \"id\": \"d9e41d34446c11de98360015c5e6daf6\" } for Save for Later.
Secured by: Core Navigation, Public Business Processes
Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Benefits, Tenant Non-Configurable
|
Post an action for a To Do step in a business process.\nSpecify these required fields in the request body: {stepAction}.\nYou can add an optional comment, if enabled at tenant or business process level.
Valid values for stepAction are:\n{ \"id\": \"133d5c88baa64136aab041c1d2e9ed53\" } for Submit, \n{ \"id\": \"d9e41d34446c11de98360015c5e6daf6\" } for Save for Later.
Secured by: Core Navigation, Public Business Processes
Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Tenant Non-Configurable
| \n\n
\n\n
\n View this Endpoint: POST /eventSteps/{ID}/toDo\n
\n
" } }, "2026.11/eventSteps/{ID}/sendBack": { "post": { "tags": [ "03/18/2026" ], "summary": "Description has been changed", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Sends back the business process event step specified by the ID of the originating event step. In the request body, specify these required fields: id (the event step you are sending back), reason.
Secured by: Core Navigation, Public Business Processes
Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Benefits, Tenant Non-Configurable
|
Sends back the business process event step specified by the ID of the originating event step. In the request body, specify these required fields: id (the event step you are sending back), reason.
Secured by: Core Navigation, Public Business Processes
Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Tenant Non-Configurable
| \n\n
\n\n
\n View this Endpoint: POST /eventSteps/{ID}/sendBack\n
\n
" } }, "2026.11/eventSteps/{ID}/approve": { "post": { "tags": [ "03/18/2026" ], "summary": "Description has been changed", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Approves the business process event step specified by the ID of the originating event step. In the request body, specify these required fields: id (the event step you are approving), comment.
Secured by: Core Navigation, Public Business Processes
Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Benefits, Tenant Non-Configurable
|
Approves the business process event step specified by the ID of the originating event step. In the request body, specify these required fields: id (the event step you are approving), comment.
Secured by: Core Navigation, Public Business Processes
Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Tenant Non-Configurable
| \n\n
\n\n
\n View this Endpoint: POST /eventSteps/{ID}/approve\n
\n
" } }, "2026.11/events": { "get": { "tags": [ "03/18/2026" ], "summary": "Description has been changed", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Retrieves a collection of business process events based on the specified parameters. You must specify exactly one worker parameter. If a worker parameter is not specified, returns a blank response.
Secured by: Core Navigation, Public Business Processes
Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Benefits, Tenant Non-Configurable
|
Retrieves a collection of business process events based on the specified parameters. You must specify exactly one worker parameter. If a worker parameter is not specified, returns a blank response.
Secured by: Core Navigation, Public Business Processes
Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Tenant Non-Configurable
| \n\n
\n\n
\n View this Endpoint: GET /events\n
\n
" } }, "2026.11/events/{ID}/remainingSteps": { "get": { "tags": [ "03/18/2026" ], "summary": "Description has been changed", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Retrieves all remaining business process steps for the specified business process event.
Secured by: Core Navigation, Public Business Processes
Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Benefits, Tenant Non-Configurable
|
Retrieves all remaining business process steps for the specified business process event.
Secured by: Core Navigation, Public Business Processes
Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Tenant Non-Configurable
| \n\n
\n\n
\n View this Endpoint: GET /events/{ID}/remainingSteps\n
\n
" } }, "2026.11/events/{ID}/comments": { "get": { "tags": [ "03/18/2026" ], "summary": "Description has been changed", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Retrieves comments on the specified business process event.
Secured by: Core Navigation, Public Business Processes
Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Benefits, Tenant Non-Configurable
|
Retrieves comments on the specified business process event.
Secured by: Core Navigation, Public Business Processes
Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Tenant Non-Configurable
| \n\n
\n\n
\n View this Endpoint: GET /events/{ID}/comments\n
\n
" } }, "2026.11/events/{ID}": { "get": { "tags": [ "03/18/2026" ], "summary": "Description has been changed", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Retrieves the business process event with the specified ID.
Secured by: Core Navigation, Public Business Processes
Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Benefits, Tenant Non-Configurable
|
Retrieves the business process event with the specified ID.
Secured by: Core Navigation, Public Business Processes
Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Tenant Non-Configurable
| \n\n
\n\n
\n View this Endpoint: GET /events/{ID}\n
\n
" } }, "2026.11/events/{ID}/inProgressSteps": { "get": { "tags": [ "03/18/2026" ], "summary": "Description has been changed", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Retrieves all business process steps that are currently in progress for the specified business process event.
Secured by: Core Navigation, Public Business Processes
Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Benefits, Tenant Non-Configurable
|
Retrieves all business process steps that are currently in progress for the specified business process event.
Secured by: Core Navigation, Public Business Processes
Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Tenant Non-Configurable
| \n\n
\n\n
\n View this Endpoint: GET /events/{ID}/inProgressSteps\n
\n
" } }, "2026.11/events/{ID}/attachments": { "get": { "tags": [ "03/18/2026" ], "summary": "Description has been changed", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Retrieves attachments on the specified business process event that the processing user has permission to view.
Secured by: Core Navigation, Public Business Processes
Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Benefits, Tenant Non-Configurable
|
Retrieves attachments on the specified business process event that the processing user has permission to view.
Secured by: Core Navigation, Public Business Processes
Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Tenant Non-Configurable
| \n\n
\n\n
\n View this Endpoint: GET /events/{ID}/attachments\n
\n
" } }, "2026.11/eventSteps": { "get": { "tags": [ "03/18/2026" ], "summary": "Description has been changed", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Retrieves a collection of business process event steps. You can filter the event steps by business process, creation date, due date, and step type.
Secured by: Core Navigation, Public Business Processes
Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Benefits, Tenant Non-Configurable
|
Retrieves a collection of business process event steps. You can filter the event steps by business process, creation date, due date, and step type.
Secured by: Core Navigation, Public Business Processes
Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Tenant Non-Configurable
| \n\n
\n\n
\n View this Endpoint: GET /eventSteps\n
\n
" } }, "2026.11/eventSteps/{ID}": { "get": { "tags": [ "03/18/2026" ], "summary": "Description has been changed", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Returns a business process event step. Returned results are secured based on processing person's view access to the event to which the step belongs. If the processing person does not have view access to the event, when this API is called, they will not be able to retrieve the event step and receive a 404 error.
Secured by: Core Navigation, Public Business Processes
Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Benefits, Tenant Non-Configurable
|
Returns a business process event step. Returned results are secured based on processing person's view access to the event to which the step belongs. If the processing person does not have view access to the event, when this API is called, they will not be able to retrieve the event step and receive a 404 error.
Secured by: Core Navigation, Public Business Processes
Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Tenant Non-Configurable
| \n\n
\n\n
\n View this Endpoint: GET /eventSteps/{ID}\n
\n
" } }, "2026.11/events/{ID}/completedSteps": { "get": { "tags": [ "03/18/2026" ], "summary": "Description has been changed", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Retrieves all business process steps that are completed for the specified buinesss process event.
Secured by: Core Navigation, Public Business Processes
Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Benefits, Tenant Non-Configurable
|
Retrieves all business process steps that are completed for the specified buinesss process event.
Secured by: Core Navigation, Public Business Processes
Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Tenant Non-Configurable
| \n\n
\n\n
\n View this Endpoint: GET /events/{ID}/completedSteps\n
\n
" } }, "2026.11/eventSteps/{ID}/questionnaire": { "post": { "tags": [ "03/18/2026" ], "summary": "Description has been changed", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Post an action for a Complete Questionnaire step in a business process.\nSpecify these required fields in the request body if the intended action is Submit or Save for Later: {stepAction, questionnaireResponse}.\nYou can send Save for Later multiple times, but {questionnaireResponse} values will replace the existing questionnaire answers. \nIf the intended action is Skip, exclude {questionnaireResponse} from the request body.
Valid values for stepAction are:\n{ \"id\": \"133d5c88baa64136aab041c1d2e9ed53\" } for Submit, \n{ \"id\": \"d9e41a8c446c11de98360015c5e6daf6\" } for Save for Later,\n{ \"id\": \"d9e4231a446c11de98360015c5e6daf6\" } for Skip.
Secured by: Core Navigation, Public Business Processes
Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Benefits, Tenant Non-Configurable
|
Post an action for a Complete Questionnaire step in a business process.\nSpecify these required fields in the request body if the intended action is Submit or Save for Later: {stepAction, questionnaireResponse}.\nYou can send Save for Later multiple times, but {questionnaireResponse} values will replace the existing questionnaire answers. \nIf the intended action is Skip, exclude {questionnaireResponse} from the request body.
Valid values for stepAction are:\n{ \"id\": \"133d5c88baa64136aab041c1d2e9ed53\" } for Submit, \n{ \"id\": \"d9e41a8c446c11de98360015c5e6daf6\" } for Save for Later,\n{ \"id\": \"d9e4231a446c11de98360015c5e6daf6\" } for Skip.
Secured by: Core Navigation, Public Business Processes
Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Tenant Non-Configurable
| \n\n
\n\n
\n View this Endpoint: POST /eventSteps/{ID}/questionnaire\n
\n
" } }, "2026.23/eventSteps/{ID}/approve": { "post": { "tags": [ "06/08/2026" ], "summary": "Description has been changed", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Approves the business process event step specified by the ID of the originating event step. In the request body, specify this required field: comment.
Secured by: Core Navigation, Public Business Processes
Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Benefits, Tenant Non-Configurable
|
Approves the business process event step specified by the ID of the originating event step. In the request body, specify these required fields: id (the event step you are approving), comment.
Secured by: Core Navigation, Public Business Processes
Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Benefits, Tenant Non-Configurable
| \n\n
\n\n
\n View this Endpoint: POST /eventSteps/{ID}/approve\n
\n
" } }, "2026.23/eventSteps": { "get": { "tags": [ "06/08/2026" ], "summary": "Description has been changed", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Retrieves a collection of business process event steps. You can filter the event steps by business process, creation date, due date, and step type. Returned results are secured based on processing person's view access to the events to which the steps belong. Only event steps from events the processing person has view access to will be included in the collection.
Secured by: Core Navigation, Public Business Processes
Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Benefits, Tenant Non-Configurable
|
Retrieves a collection of business process event steps. You can filter the event steps by business process, creation date, due date, and step type.
Secured by: Core Navigation, Public Business Processes
Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Benefits, Tenant Non-Configurable
| \n\n
\n\n
\n View this Endpoint: GET /eventSteps\n
\n
" } }, "2026.24/events/{ID}/rescind": { "post": { "tags": [ "06/15/2026" ], "summary": "Description has been changed", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Rescinds the business process event specified by the ID. In the request body, specify these required fields: comment.
|
Rescinds the business process event specified by the ID. In the request body, specify these required fields: comment.
Secured by: Core Navigation, Public Business Processes
Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Benefits, Tenant Non-Configurable
| \n\n
\n\n
\n View this Endpoint: POST /events/{ID}/rescind\n
\n
" } }, "2026.24/events/{ID}/cancel": { "post": { "tags": [ "06/15/2026" ], "summary": "Description has been changed", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Cancels the business process event specified by the ID. In the request body, specify these required fields: comment.
|
Cancels the business process event specified by the ID. In the request body, specify these required fields: comment.
Secured by: Core Navigation, Public Business Processes
Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Benefits, Tenant Non-Configurable
| \n\n
\n\n
\n View this Endpoint: POST /events/{ID}/cancel\n
\n
" } }, "2026.24/types": { "get": { "tags": [ "06/15/2026" ], "summary": "Description has been changed", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Retrieves a collection of business process types.
|
Retrieves a collection of business process types.
Secured by: Public Business Processes
Scope: Tenant Non-Configurable
| \n\n
\n\n
\n View this Endpoint: GET /types\n
\n
" } }, "2026.24/types/{ID}": { "get": { "tags": [ "06/15/2026" ], "summary": "Description has been changed", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Retrieves the business process type specified by the ID.
|
Retrieves the business process type specified by the ID.
Secured by: Public Business Processes
Scope: Tenant Non-Configurable
| \n\n
\n\n
\n View this Endpoint: GET /types/{ID}\n
\n
" } }, "2026.24/types/{ID}/attachmentCategories": { "get": { "tags": [ "06/15/2026" ], "summary": "Description has been changed", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Retrieves all attachment categories for the specified business process type that the processing user can select for the specified event. You can filter by event target.
|
Retrieves all attachment categories for the specified business process type that the processing user can select for the specified event. You can filter by event target.
Secured by: Core Navigation, Public Business Processes
Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Benefits, Tenant Non-Configurable
| \n\n
\n\n
\n View this Endpoint: GET /types/{ID}/attachmentCategories\n
\n
" } }, "2026.24/eventSteps/{ID}/reassign": { "post": { "tags": [ "06/15/2026" ], "summary": "Description has been changed", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Reassigns the business process event step specified by the reference ID of the originating event step.
|
Reassigns the business process event step specified by the reference ID of the originating event step.
Secured by: Core Navigation, Public Business Processes
Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Benefits, Tenant Non-Configurable
| \n\n
\n\n
\n View this Endpoint: POST /eventSteps/{ID}/reassign\n
\n
" } }, "2026.24/eventSteps/{ID}/deny": { "post": { "tags": [ "06/15/2026" ], "summary": "Description has been changed", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Denies the business process event step specified by the ID of the originating event step. The processing person must have view access to the event. In the request body, specify these required fields: id (the event step you are denying), stepAction{id} (if there are multiple event steps), comment.
|
Denies the business process event step specified by the ID of the originating event step. The processing person must have view access to the event. In the request body, specify these required fields: id (the event step you are denying), stepAction{id} (if there are multiple event steps), comment.
Secured by: Core Navigation, Public Business Processes
Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Benefits, Tenant Non-Configurable
| \n\n
\n\n
\n View this Endpoint: POST /eventSteps/{ID}/deny\n
\n
" } }, "2026.24/eventSteps/{ID}/approve": { "post": { "tags": [ "06/15/2026" ], "summary": "Description has been changed", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Approves the business process event step specified by the ID of the originating event step. In the request body, specify this required field: comment.
|
Approves the business process event step specified by the ID of the originating event step. In the request body, specify this required field: comment.
Secured by: Core Navigation, Public Business Processes
Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Benefits, Tenant Non-Configurable
| \n\n
\n\n
\n View this Endpoint: POST /eventSteps/{ID}/approve\n
\n
" } }, "2026.24/eventSteps/{ID}/sendBack": { "post": { "tags": [ "06/15/2026" ], "summary": "Description has been changed", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Sends back the business process event step specified by the ID of the originating event step. In the request body, specify these required fields: id (the event step you are sending back), reason.
|
Sends back the business process event step specified by the ID of the originating event step. In the request body, specify these required fields: id (the event step you are sending back), reason.
Secured by: Core Navigation, Public Business Processes
Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Benefits, Tenant Non-Configurable
| \n\n
\n\n
\n View this Endpoint: POST /eventSteps/{ID}/sendBack\n
\n
" } }, "2026.24/eventSteps/{ID}/toDo": { "post": { "tags": [ "06/15/2026" ], "summary": "Description has been changed", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Post an action for a To Do step in a business process.\nSpecify these required fields in the request body: {stepAction}.\nYou can add an optional comment, if enabled at tenant or business process level.
Valid values for stepAction are:\n{ \"id\": \"133d5c88baa64136aab041c1d2e9ed53\" } for Submit, \n{ \"id\": \"d9e41d34446c11de98360015c5e6daf6\" } for Save for Later.
|
Post an action for a To Do step in a business process.\nSpecify these required fields in the request body: {stepAction}.\nYou can add an optional comment, if enabled at tenant or business process level.
Valid values for stepAction are:\n{ \"id\": \"133d5c88baa64136aab041c1d2e9ed53\" } for Submit, \n{ \"id\": \"d9e41d34446c11de98360015c5e6daf6\" } for Save for Later.
Secured by: Core Navigation, Public Business Processes
Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Benefits, Tenant Non-Configurable
| \n\n
\n\n
\n View this Endpoint: POST /eventSteps/{ID}/toDo\n
\n
" } }, "2026.24/events": { "get": { "tags": [ "06/15/2026" ], "summary": "Description has been changed", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Retrieves a collection of business process events based on the specified parameters. You must specify exactly one worker parameter. If a worker parameter is not specified, returns a blank response.
|
Retrieves a collection of business process events based on the specified parameters. You must specify exactly one worker parameter. If a worker parameter is not specified, returns a blank response.
Secured by: Core Navigation, Public Business Processes
Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Benefits, Tenant Non-Configurable
| \n\n
\n\n
\n View this Endpoint: GET /events\n
\n
" } }, "2026.24/events/{ID}/remainingSteps": { "get": { "tags": [ "06/15/2026" ], "summary": "Description has been changed", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Retrieves all remaining business process steps for the specified business process event.
|
Retrieves all remaining business process steps for the specified business process event.
Secured by: Core Navigation, Public Business Processes
Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Benefits, Tenant Non-Configurable
| \n\n
\n\n
\n View this Endpoint: GET /events/{ID}/remainingSteps\n
\n
" } }, "2026.24/events/{ID}/comments": { "get": { "tags": [ "06/15/2026" ], "summary": "Description has been changed", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Retrieves comments on the specified business process event.
|
Retrieves comments on the specified business process event.
Secured by: Core Navigation, Public Business Processes
Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Benefits, Tenant Non-Configurable
| \n\n
\n\n
\n View this Endpoint: GET /events/{ID}/comments\n
\n
" } }, "2026.24/events/{ID}": { "get": { "tags": [ "06/15/2026" ], "summary": "Description has been changed", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Retrieves the business process event with the specified ID.
|
Retrieves the business process event with the specified ID.
Secured by: Core Navigation, Public Business Processes
Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Benefits, Tenant Non-Configurable
| \n\n
\n\n
\n View this Endpoint: GET /events/{ID}\n
\n
" } }, "2026.24/events/{ID}/inProgressSteps": { "get": { "tags": [ "06/15/2026" ], "summary": "Description has been changed", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Retrieves all business process steps that are currently in progress for the specified business process event.
|
Retrieves all business process steps that are currently in progress for the specified business process event.
Secured by: Core Navigation, Public Business Processes
Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Benefits, Tenant Non-Configurable
| \n\n
\n\n
\n View this Endpoint: GET /events/{ID}/inProgressSteps\n
\n
" } }, "2026.24/events/{ID}/attachments": { "get": { "tags": [ "06/15/2026" ], "summary": "Description has been changed", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Retrieves attachments on the specified business process event that the processing user has permission to view.
|
Retrieves attachments on the specified business process event that the processing user has permission to view.
Secured by: Core Navigation, Public Business Processes
Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Benefits, Tenant Non-Configurable
| \n\n
\n\n
\n View this Endpoint: GET /events/{ID}/attachments\n
\n
" } }, "2026.24/values/sendBack/to/": { "get": { "tags": [ "06/15/2026" ], "summary": "Description has been changed", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Retrieves instances that can be used as values for other endpoint parameters in this service.
|
Retrieves instances that can be used as values for other endpoint parameters in this service.
Secured by: Public Business Processes
Scope: Tenant Non-Configurable
| \n\n
\n\n
\n View this Endpoint: GET /values/sendBack/to/\n
\n
" } }, "2026.24/eventSteps": { "get": { "tags": [ "06/15/2026" ], "summary": "Description has been changed", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Retrieves a collection of business process event steps. You can filter the event steps by business process, creation date, due date, and step type. Returned results are secured based on processing person's view access to the events to which the steps belong. Only event steps from events the processing person has view access to will be included in the collection.
|
Retrieves a collection of business process event steps. You can filter the event steps by business process, creation date, due date, and step type. Returned results are secured based on processing person's view access to the events to which the steps belong. Only event steps from events the processing person has view access to will be included in the collection.
Secured by: Core Navigation, Public Business Processes
Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Benefits, Tenant Non-Configurable
| \n\n
\n\n
\n View this Endpoint: GET /eventSteps\n
\n
" } }, "2026.24/eventSteps/{ID}": { "get": { "tags": [ "06/15/2026" ], "summary": "Description has been changed", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Returns a business process event step. Returned results are secured based on processing person's view access to the event to which the step belongs. If the processing person does not have view access to the event, when this API is called, they will not be able to retrieve the event step and receive a 404 error.
|
Returns a business process event step. Returned results are secured based on processing person's view access to the event to which the step belongs. If the processing person does not have view access to the event, when this API is called, they will not be able to retrieve the event step and receive a 404 error.
Secured by: Core Navigation, Public Business Processes
Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Benefits, Tenant Non-Configurable
| \n\n
\n\n
\n View this Endpoint: GET /eventSteps/{ID}\n
\n
" } }, "2026.24/events/{ID}/completedSteps": { "get": { "tags": [ "06/15/2026" ], "summary": "Description has been changed", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Retrieves all business process steps that are completed for the specified buinesss process event.
|
Retrieves all business process steps that are completed for the specified buinesss process event.
Secured by: Core Navigation, Public Business Processes
Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Benefits, Tenant Non-Configurable
| \n\n
\n\n
\n View this Endpoint: GET /events/{ID}/completedSteps\n
\n
" } }, "2026.24/eventSteps/{ID}/questionnaire": { "post": { "tags": [ "06/15/2026" ], "summary": "Description has been changed", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Post an action for a Complete Questionnaire step in a business process.\nSpecify these required fields in the request body if the intended action is Submit or Save for Later: {stepAction, questionnaireResponse}.\nYou can send Save for Later multiple times, but {questionnaireResponse} values will replace the existing questionnaire answers. \nIf the intended action is Skip, exclude {questionnaireResponse} from the request body.
Valid values for stepAction are:\n{ \"id\": \"133d5c88baa64136aab041c1d2e9ed53\" } for Submit, \n{ \"id\": \"d9e41a8c446c11de98360015c5e6daf6\" } for Save for Later,\n{ \"id\": \"d9e4231a446c11de98360015c5e6daf6\" } for Skip.
|
Post an action for a Complete Questionnaire step in a business process.\nSpecify these required fields in the request body if the intended action is Submit or Save for Later: {stepAction, questionnaireResponse}.\nYou can send Save for Later multiple times, but {questionnaireResponse} values will replace the existing questionnaire answers. \nIf the intended action is Skip, exclude {questionnaireResponse} from the request body.
Valid values for stepAction are:\n{ \"id\": \"133d5c88baa64136aab041c1d2e9ed53\" } for Submit, \n{ \"id\": \"d9e41a8c446c11de98360015c5e6daf6\" } for Save for Later,\n{ \"id\": \"d9e4231a446c11de98360015c5e6daf6\" } for Skip.
Secured by: Core Navigation, Public Business Processes
Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Benefits, Tenant Non-Configurable
| \n\n
\n\n
\n View this Endpoint: POST /eventSteps/{ID}/questionnaire\n
\n
" } }, "2026.26/types": { "get": { "tags": [ "06/30/2026" ], "summary": "Description has been changed", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Retrieves a collection of business process types.
Secured By Domain: Public Business Processes
Scope: Tenant Non-Configurable
|
Retrieves a collection of business process types.
| \n\n
\n\n
\n View this Endpoint: GET /types\n
\n
" } }, "2026.26/types/{ID}": { "get": { "tags": [ "06/30/2026" ], "summary": "Description has been changed", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Retrieves the business process type specified by the ID.
Secured By Domain: Public Business Processes
Scope: Tenant Non-Configurable
|
Retrieves the business process type specified by the ID.
| \n\n
\n\n
\n View this Endpoint: GET /types/{ID}\n
\n
" } }, "2026.26/types/{ID}/attachmentCategories": { "get": { "tags": [ "06/30/2026" ], "summary": "Description has been changed", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Retrieves all attachment categories for the specified business process type that the processing user can select for the specified event. You can filter by event target.
Secured By Domain: Core Navigation, Public Business Processes
Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Benefits, Tenant Non-Configurable
|
Retrieves all attachment categories for the specified business process type that the processing user can select for the specified event. You can filter by event target.
| \n\n
\n\n
\n View this Endpoint: GET /types/{ID}/attachmentCategories\n
\n
" } }, "2026.26/events/{ID}/rescind": { "post": { "tags": [ "06/30/2026" ], "summary": "Description has been changed", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Rescinds the business process event specified by the ID. In the request body, specify these required fields: comment.
Secured By Domain: Core Navigation, Public Business Processes
Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Benefits, Tenant Non-Configurable
|
Rescinds the business process event specified by the ID. In the request body, specify these required fields: comment.
| \n\n
\n\n
\n View this Endpoint: POST /events/{ID}/rescind\n
\n
" } }, "2026.26/events/{ID}/cancel": { "post": { "tags": [ "06/30/2026" ], "summary": "Description has been changed", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Cancels the business process event specified by the ID. In the request body, specify these required fields: comment.
Secured By Domain: Core Navigation, Public Business Processes
Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Benefits, Tenant Non-Configurable
|
Cancels the business process event specified by the ID. In the request body, specify these required fields: comment.
| \n\n
\n\n
\n View this Endpoint: POST /events/{ID}/cancel\n
\n
" } }, "2026.26/eventSteps/{ID}/reassign": { "post": { "tags": [ "06/30/2026" ], "summary": "Description has been changed", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Reassigns the business process event step specified by the reference ID of the originating event step.
Secured By Domain: Core Navigation, Public Business Processes
Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Benefits, Tenant Non-Configurable
|
Reassigns the business process event step specified by the reference ID of the originating event step.
| \n\n
\n\n
\n View this Endpoint: POST /eventSteps/{ID}/reassign\n
\n
" } }, "2026.26/eventSteps/{ID}/deny": { "post": { "tags": [ "06/30/2026" ], "summary": "Description has been changed", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Denies the business process event step specified by the ID of the originating event step. The processing person must have view access to the event. In the request body, specify these required fields: id (the event step you are denying), stepAction{id} (if there are multiple event steps), comment.
Secured By Domain: Core Navigation, Public Business Processes
Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Benefits, Tenant Non-Configurable
|
Denies the business process event step specified by the ID of the originating event step. The processing person must have view access to the event. In the request body, specify these required fields: id (the event step you are denying), stepAction{id} (if there are multiple event steps), comment.
| \n\n
\n\n
\n View this Endpoint: POST /eventSteps/{ID}/deny\n
\n
" } }, "2026.26/eventSteps/{ID}/approve": { "post": { "tags": [ "06/30/2026" ], "summary": "Description has been changed", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Approves the business process event step specified by the ID of the originating event step. In the request body, specify this required field: comment.
Secured By Domain: Core Navigation, Public Business Processes
Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Benefits, Tenant Non-Configurable
|
Approves the business process event step specified by the ID of the originating event step. In the request body, specify this required field: comment.
| \n\n
\n\n
\n View this Endpoint: POST /eventSteps/{ID}/approve\n
\n
" } }, "2026.26/eventSteps/{ID}/toDo": { "post": { "tags": [ "06/30/2026" ], "summary": "Description has been changed", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Post an action for a To Do step in a business process.\nSpecify these required fields in the request body: {stepAction}.\nYou can add an optional comment, if enabled at tenant or business process level.
Valid values for stepAction are:\n{ \"id\": \"133d5c88baa64136aab041c1d2e9ed53\" } for Submit, \n{ \"id\": \"d9e41d34446c11de98360015c5e6daf6\" } for Save for Later.
Secured By Domain: Core Navigation, Public Business Processes
Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Benefits, Tenant Non-Configurable
|
Post an action for a To Do step in a business process.\nSpecify these required fields in the request body: {stepAction}.\nYou can add an optional comment, if enabled at tenant or business process level.
Valid values for stepAction are:\n{ \"id\": \"133d5c88baa64136aab041c1d2e9ed53\" } for Submit, \n{ \"id\": \"d9e41d34446c11de98360015c5e6daf6\" } for Save for Later.
| \n\n
\n\n
\n View this Endpoint: POST /eventSteps/{ID}/toDo\n
\n
" } }, "2026.26/eventSteps/{ID}/sendBack": { "post": { "tags": [ "06/30/2026" ], "summary": "Description has been changed", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Sends back the business process event step specified by the ID of the originating event step. In the request body, specify these required fields: id (the event step you are sending back), reason.
Secured By Domain: Core Navigation, Public Business Processes
Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Benefits, Tenant Non-Configurable
|
Sends back the business process event step specified by the ID of the originating event step. In the request body, specify these required fields: id (the event step you are sending back), reason.
| \n\n
\n\n
\n View this Endpoint: POST /eventSteps/{ID}/sendBack\n
\n
" } }, "2026.26/events": { "get": { "tags": [ "06/30/2026" ], "summary": "Description has been changed", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Retrieves a collection of business process events based on the specified parameters. You must specify exactly one worker parameter. If a worker parameter is not specified, returns a blank response.
Secured By Domain: Core Navigation, Public Business Processes
Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Benefits, Tenant Non-Configurable
|
Retrieves a collection of business process events based on the specified parameters. You must specify exactly one worker parameter. If a worker parameter is not specified, returns a blank response.
| \n\n
\n\n
\n View this Endpoint: GET /events\n
\n
" } }, "2026.26/events/{ID}/remainingSteps": { "get": { "tags": [ "06/30/2026" ], "summary": "Description has been changed", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Retrieves all remaining business process steps for the specified business process event.
Secured By Domain: Core Navigation, Public Business Processes
Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Benefits, Tenant Non-Configurable
|
Retrieves all remaining business process steps for the specified business process event.
| \n\n
\n\n
\n View this Endpoint: GET /events/{ID}/remainingSteps\n
\n
" } }, "2026.26/events/{ID}/comments": { "get": { "tags": [ "06/30/2026" ], "summary": "Description has been changed", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Retrieves comments on the specified business process event.
Secured By Domain: Core Navigation, Public Business Processes
Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Benefits, Tenant Non-Configurable
|
Retrieves comments on the specified business process event.
| \n\n
\n\n
\n View this Endpoint: GET /events/{ID}/comments\n
\n
" } }, "2026.26/events/{ID}": { "get": { "tags": [ "06/30/2026" ], "summary": "Description has been changed", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Retrieves the business process event with the specified ID.
Secured By Domain: Core Navigation, Public Business Processes
Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Benefits, Tenant Non-Configurable
|
Retrieves the business process event with the specified ID.
| \n\n
\n\n
\n View this Endpoint: GET /events/{ID}\n
\n
" } }, "2026.26/events/{ID}/inProgressSteps": { "get": { "tags": [ "06/30/2026" ], "summary": "Description has been changed", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Retrieves all business process steps that are currently in progress for the specified business process event.
Secured By Domain: Core Navigation, Public Business Processes
Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Benefits, Tenant Non-Configurable
|
Retrieves all business process steps that are currently in progress for the specified business process event.
| \n\n
\n\n
\n View this Endpoint: GET /events/{ID}/inProgressSteps\n
\n
" } }, "2026.26/events/{ID}/attachments": { "get": { "tags": [ "06/30/2026" ], "summary": "Description has been changed", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Retrieves attachments on the specified business process event that the processing user has permission to view.
Secured By Domain: Core Navigation, Public Business Processes
Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Benefits, Tenant Non-Configurable
|
Retrieves attachments on the specified business process event that the processing user has permission to view.
| \n\n
\n\n
\n View this Endpoint: GET /events/{ID}/attachments\n
\n
" } }, "2026.26/eventSteps": { "get": { "tags": [ "06/30/2026" ], "summary": "Description has been changed", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Retrieves a collection of business process event steps. You can filter the event steps by business process, creation date, due date, and step type. Returned results are secured based on processing person's view access to the events to which the steps belong. Only event steps from events the processing person has view access to will be included in the collection.
Secured By Domain: Core Navigation, Public Business Processes
Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Benefits, Tenant Non-Configurable
|
Retrieves a collection of business process event steps. You can filter the event steps by business process, creation date, due date, and step type. Returned results are secured based on processing person's view access to the events to which the steps belong. Only event steps from events the processing person has view access to will be included in the collection.
| \n\n
\n\n
\n View this Endpoint: GET /eventSteps\n
\n
" } }, "2026.26/eventSteps/{ID}": { "get": { "tags": [ "06/30/2026" ], "summary": "Description has been changed", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Returns a business process event step. Returned results are secured based on processing person's view access to the event to which the step belongs. If the processing person does not have view access to the event, when this API is called, they will not be able to retrieve the event step and receive a 404 error.
Secured By Domain: Core Navigation, Public Business Processes
Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Benefits, Tenant Non-Configurable
|
Returns a business process event step. Returned results are secured based on processing person's view access to the event to which the step belongs. If the processing person does not have view access to the event, when this API is called, they will not be able to retrieve the event step and receive a 404 error.
| \n\n
\n\n
\n View this Endpoint: GET /eventSteps/{ID}\n
\n
" } }, "2026.26/events/{ID}/completedSteps": { "get": { "tags": [ "06/30/2026" ], "summary": "Description has been changed", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Retrieves all business process steps that are completed for the specified buinesss process event.
Secured By Domain: Core Navigation, Public Business Processes
Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Benefits, Tenant Non-Configurable
|
Retrieves all business process steps that are completed for the specified buinesss process event.
| \n\n
\n\n
\n View this Endpoint: GET /events/{ID}/completedSteps\n
\n
" } }, "2026.26/eventSteps/{ID}/questionnaire": { "post": { "tags": [ "06/30/2026" ], "summary": "Description has been changed", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Post an action for a Complete Questionnaire step in a business process.\nSpecify these required fields in the request body if the intended action is Submit or Save for Later: {stepAction, questionnaireResponse}.\nYou can send Save for Later multiple times, but {questionnaireResponse} values will replace the existing questionnaire answers. \nIf the intended action is Skip, exclude {questionnaireResponse} from the request body.
Valid values for stepAction are:\n{ \"id\": \"133d5c88baa64136aab041c1d2e9ed53\" } for Submit, \n{ \"id\": \"d9e41a8c446c11de98360015c5e6daf6\" } for Save for Later,\n{ \"id\": \"d9e4231a446c11de98360015c5e6daf6\" } for Skip.
Secured By Domain: Core Navigation, Public Business Processes
Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Benefits, Tenant Non-Configurable
|
Post an action for a Complete Questionnaire step in a business process.\nSpecify these required fields in the request body if the intended action is Submit or Save for Later: {stepAction, questionnaireResponse}.\nYou can send Save for Later multiple times, but {questionnaireResponse} values will replace the existing questionnaire answers. \nIf the intended action is Skip, exclude {questionnaireResponse} from the request body.
Valid values for stepAction are:\n{ \"id\": \"133d5c88baa64136aab041c1d2e9ed53\" } for Submit, \n{ \"id\": \"d9e41a8c446c11de98360015c5e6daf6\" } for Save for Later,\n{ \"id\": \"d9e4231a446c11de98360015c5e6daf6\" } for Skip.
| \n\n
\n\n
\n View this Endpoint: POST /eventSteps/{ID}/questionnaire\n
\n
" } }, "2026.33/types/{ID}": { "get": { "tags": [ "08/17/2026" ], "summary": "Modified this existing endpoint", "description": "
\n\n
\n View this Endpoint: GET /types/{ID}\n
\n
", "parameters": [ { "name": "ID", "in": "path", "description": "Parameter Schema Type changed \n| Updated Value | \n| :--- | \n| None | \n\n| Previous Value | \n| :--- | \n| None | \n\n", "required": true, "style": "SIMPLE", "explode": false, "schema": { "$ref": "#/components/schemas/ResourceIdPathValue_types", "exampleSetFlag": false }, "examples": { "wid": { "summary": "Specific resource WID", "value": "a3f5b554007d20e98360015c5e6daf6", "valueSetFlag": true }, "referenceId": { "summary": "Reference ID", "value": "Business_Process_Type=21002", "valueSetFlag": true } } } ] } }, "2026.33/types/{ID}/attachmentCategories": { "get": { "tags": [ "08/17/2026" ], "summary": "Modified this existing endpoint", "description": "
\n\n
\n View this Endpoint: GET /types/{ID}/attachmentCategories\n
\n
", "parameters": [ { "name": "ID", "in": "path", "description": "Parameter Schema Type changed \n| Updated Value | \n| :--- | \n| None | \n\n| Previous Value | \n| :--- | \n| None | \n\n", "required": true, "style": "SIMPLE", "explode": false, "schema": { "$ref": "#/components/schemas/ResourceIdPathValue_types", "exampleSetFlag": false }, "examples": { "wid": { "summary": "Specific resource WID", "value": "a3f5b554007d20e98360015c5e6daf6", "valueSetFlag": true }, "referenceId": { "summary": "Reference ID", "value": "Business_Process_Type=21002", "valueSetFlag": true } } } ] } }, "2026.33/events/{ID}/rescind": { "post": { "tags": [ "08/17/2026" ], "summary": "Modified this existing endpoint", "description": "
\n\n
\n View this Endpoint: POST /events/{ID}/rescind\n
\n
", "parameters": [ { "name": "ID", "in": "path", "description": "Parameter Schema Type changed \n| Updated Value | \n| :--- | \n| None | \n\n| Previous Value | \n| :--- | \n| None | \n\n", "required": true, "style": "SIMPLE", "explode": false, "schema": { "$ref": "#/components/schemas/ResourceIdPathValue_events", "exampleSetFlag": false }, "examples": { "wid": { "summary": "Specific resource WID", "value": "a3f5b554007d20e98360015c5e6daf6", "valueSetFlag": true }, "referenceId": { "summary": "Reference ID", "value": "Worker_Time_Card_ID=21002", "valueSetFlag": true } } } ] } }, "2026.33/events/{ID}/cancel": { "post": { "tags": [ "08/17/2026" ], "summary": "Modified this existing endpoint", "description": "
\n\n
\n View this Endpoint: POST /events/{ID}/cancel\n
\n
", "parameters": [ { "name": "ID", "in": "path", "description": "Parameter Schema Type changed \n| Updated Value | \n| :--- | \n| None | \n\n| Previous Value | \n| :--- | \n| None | \n\n", "required": true, "style": "SIMPLE", "explode": false, "schema": { "$ref": "#/components/schemas/ResourceIdPathValue_events", "exampleSetFlag": false }, "examples": { "wid": { "summary": "Specific resource WID", "value": "a3f5b554007d20e98360015c5e6daf6", "valueSetFlag": true }, "referenceId": { "summary": "Reference ID", "value": "Worker_Time_Card_ID=21002", "valueSetFlag": true } } } ] } }, "2026.33/events/{ID}/remainingSteps": { "get": { "tags": [ "08/17/2026" ], "summary": "Modified this existing endpoint", "description": "
\n\n
\n View this Endpoint: GET /events/{ID}/remainingSteps\n
\n
", "parameters": [ { "name": "ID", "in": "path", "description": "Parameter Schema Type changed \n| Updated Value | \n| :--- | \n| None | \n\n| Previous Value | \n| :--- | \n| None | \n\n", "required": true, "style": "SIMPLE", "explode": false, "schema": { "$ref": "#/components/schemas/ResourceIdPathValue_events", "exampleSetFlag": false }, "examples": { "wid": { "summary": "Specific resource WID", "value": "a3f5b554007d20e98360015c5e6daf6", "valueSetFlag": true }, "referenceId": { "summary": "Reference ID", "value": "Worker_Time_Card_ID=21002", "valueSetFlag": true } } } ] } }, "2026.33/events/{ID}/comments": { "get": { "tags": [ "08/17/2026" ], "summary": "Modified this existing endpoint", "description": "
\n\n
\n View this Endpoint: GET /events/{ID}/comments\n
\n
", "parameters": [ { "name": "ID", "in": "path", "description": "Parameter Schema Type changed \n| Updated Value | \n| :--- | \n| None | \n\n| Previous Value | \n| :--- | \n| None | \n\n", "required": true, "style": "SIMPLE", "explode": false, "schema": { "$ref": "#/components/schemas/ResourceIdPathValue_events", "exampleSetFlag": false }, "examples": { "wid": { "summary": "Specific resource WID", "value": "a3f5b554007d20e98360015c5e6daf6", "valueSetFlag": true }, "referenceId": { "summary": "Reference ID", "value": "Worker_Time_Card_ID=21002", "valueSetFlag": true } } } ] } }, "2026.33/events/{ID}": { "get": { "tags": [ "08/17/2026" ], "summary": "Modified this existing endpoint", "description": "
\n\n
\n View this Endpoint: GET /events/{ID}\n
\n
", "parameters": [ { "name": "ID", "in": "path", "description": "Parameter Schema Type changed \n| Updated Value | \n| :--- | \n| None | \n\n| Previous Value | \n| :--- | \n| None | \n\n", "required": true, "style": "SIMPLE", "explode": false, "schema": { "$ref": "#/components/schemas/ResourceIdPathValue_events", "exampleSetFlag": false }, "examples": { "wid": { "summary": "Specific resource WID", "value": "a3f5b554007d20e98360015c5e6daf6", "valueSetFlag": true }, "referenceId": { "summary": "Reference ID", "value": "Worker_Time_Card_ID=21002", "valueSetFlag": true } } } ] } }, "2026.33/events/{ID}/inProgressSteps": { "get": { "tags": [ "08/17/2026" ], "summary": "Modified this existing endpoint", "description": "
\n\n
\n View this Endpoint: GET /events/{ID}/inProgressSteps\n
\n
", "parameters": [ { "name": "ID", "in": "path", "description": "Parameter Schema Type changed \n| Updated Value | \n| :--- | \n| None | \n\n| Previous Value | \n| :--- | \n| None | \n\n", "required": true, "style": "SIMPLE", "explode": false, "schema": { "$ref": "#/components/schemas/ResourceIdPathValue_events", "exampleSetFlag": false }, "examples": { "wid": { "summary": "Specific resource WID", "value": "a3f5b554007d20e98360015c5e6daf6", "valueSetFlag": true }, "referenceId": { "summary": "Reference ID", "value": "Worker_Time_Card_ID=21002", "valueSetFlag": true } } } ] } }, "2026.33/events/{ID}/attachments": { "get": { "tags": [ "08/17/2026" ], "summary": "Modified this existing endpoint", "description": "
\n\n
\n View this Endpoint: GET /events/{ID}/attachments\n
\n
", "parameters": [ { "name": "ID", "in": "path", "description": "Parameter Schema Type changed \n| Updated Value | \n| :--- | \n| None | \n\n| Previous Value | \n| :--- | \n| None | \n\n", "required": true, "style": "SIMPLE", "explode": false, "schema": { "$ref": "#/components/schemas/ResourceIdPathValue_events", "exampleSetFlag": false }, "examples": { "wid": { "summary": "Specific resource WID", "value": "a3f5b554007d20e98360015c5e6daf6", "valueSetFlag": true }, "referenceId": { "summary": "Reference ID", "value": "Worker_Time_Card_ID=21002", "valueSetFlag": true } } } ] } }, "2026.33/eventSteps/{ID}/reassign": { "post": { "tags": [ "08/17/2026" ], "summary": "Modified this existing endpoint", "description": "
\n\n
\n View this Endpoint: POST /eventSteps/{ID}/reassign\n
\n
", "parameters": [ { "name": "ID", "in": "path", "description": "Parameter Schema Type changed \n| Updated Value | \n| :--- | \n| None | \n\n| Previous Value | \n| :--- | \n| None | \n\n", "required": true, "style": "SIMPLE", "explode": false, "schema": { "$ref": "#/components/schemas/ResourceIdPathValue_eventSteps", "exampleSetFlag": false }, "examples": { "wid": { "summary": "Specific resource WID", "value": "a3f5b554007d20e98360015c5e6daf6", "valueSetFlag": true } } } ] } }, "2026.33/eventSteps/{ID}/deny": { "post": { "tags": [ "08/17/2026" ], "summary": "Modified this existing endpoint", "description": "
\n\n
\n View this Endpoint: POST /eventSteps/{ID}/deny\n
\n
", "parameters": [ { "name": "ID", "in": "path", "description": "Parameter Schema Type changed \n| Updated Value | \n| :--- | \n| None | \n\n| Previous Value | \n| :--- | \n| None | \n\n", "required": true, "style": "SIMPLE", "explode": false, "schema": { "$ref": "#/components/schemas/ResourceIdPathValue_eventSteps", "exampleSetFlag": false }, "examples": { "wid": { "summary": "Specific resource WID", "value": "a3f5b554007d20e98360015c5e6daf6", "valueSetFlag": true } } } ] } }, "2026.33/eventSteps/{ID}/toDo": { "post": { "tags": [ "08/17/2026" ], "summary": "Modified this existing endpoint", "description": "
\n\n
\n View this Endpoint: POST /eventSteps/{ID}/toDo\n
\n
", "parameters": [ { "name": "ID", "in": "path", "description": "Parameter Schema Type changed \n| Updated Value | \n| :--- | \n| None | \n\n| Previous Value | \n| :--- | \n| None | \n\n", "required": true, "style": "SIMPLE", "explode": false, "schema": { "$ref": "#/components/schemas/ResourceIdPathValue_eventSteps", "exampleSetFlag": false }, "examples": { "wid": { "summary": "Specific resource WID", "value": "a3f5b554007d20e98360015c5e6daf6", "valueSetFlag": true } } } ] } }, "2026.33/eventSteps/{ID}/sendBack": { "post": { "tags": [ "08/17/2026" ], "summary": "Modified this existing endpoint", "description": "
\n\n
\n View this Endpoint: POST /eventSteps/{ID}/sendBack\n
\n
", "parameters": [ { "name": "ID", "in": "path", "description": "Parameter Schema Type changed \n| Updated Value | \n| :--- | \n| None | \n\n| Previous Value | \n| :--- | \n| None | \n\n", "required": true, "style": "SIMPLE", "explode": false, "schema": { "$ref": "#/components/schemas/ResourceIdPathValue_eventSteps", "exampleSetFlag": false }, "examples": { "wid": { "summary": "Specific resource WID", "value": "a3f5b554007d20e98360015c5e6daf6", "valueSetFlag": true } } } ] } }, "2026.33/eventSteps/{ID}/approve": { "post": { "tags": [ "08/17/2026" ], "summary": "Modified this existing endpoint", "description": "
\n\n
\n View this Endpoint: POST /eventSteps/{ID}/approve\n
\n
", "parameters": [ { "name": "ID", "in": "path", "description": "Parameter Schema Type changed \n| Updated Value | \n| :--- | \n| None | \n\n| Previous Value | \n| :--- | \n| None | \n\n", "required": true, "style": "SIMPLE", "explode": false, "schema": { "$ref": "#/components/schemas/ResourceIdPathValue_eventSteps", "exampleSetFlag": false }, "examples": { "wid": { "summary": "Specific resource WID", "value": "a3f5b554007d20e98360015c5e6daf6", "valueSetFlag": true } } } ] } }, "2026.33/events/{ID}/completedSteps": { "get": { "tags": [ "08/17/2026" ], "summary": "Modified this existing endpoint", "description": "
\n\n
\n View this Endpoint: GET /events/{ID}/completedSteps\n
\n
", "parameters": [ { "name": "ID", "in": "path", "description": "Parameter Schema Type changed \n| Updated Value | \n| :--- | \n| None | \n\n| Previous Value | \n| :--- | \n| None | \n\n", "required": true, "style": "SIMPLE", "explode": false, "schema": { "$ref": "#/components/schemas/ResourceIdPathValue_events", "exampleSetFlag": false }, "examples": { "wid": { "summary": "Specific resource WID", "value": "a3f5b554007d20e98360015c5e6daf6", "valueSetFlag": true }, "referenceId": { "summary": "Reference ID", "value": "Worker_Time_Card_ID=21002", "valueSetFlag": true } } } ] } }, "2026.33/eventSteps/{ID}": { "get": { "tags": [ "08/17/2026" ], "summary": "Modified this existing endpoint", "description": "
\n\n
\n View this Endpoint: GET /eventSteps/{ID}\n
\n
", "parameters": [ { "name": "ID", "in": "path", "description": "Parameter Schema Type changed \n| Updated Value | \n| :--- | \n| None | \n\n| Previous Value | \n| :--- | \n| None | \n\n", "required": true, "style": "SIMPLE", "explode": false, "schema": { "$ref": "#/components/schemas/ResourceIdPathValue_eventSteps", "exampleSetFlag": false }, "examples": { "wid": { "summary": "Specific resource WID", "value": "a3f5b554007d20e98360015c5e6daf6", "valueSetFlag": true } } } ] } }, "2026.33/eventSteps/{ID}/questionnaire": { "post": { "tags": [ "08/17/2026" ], "summary": "Modified this existing endpoint", "description": "
\n\n
\n View this Endpoint: POST /eventSteps/{ID}/questionnaire\n
\n
", "parameters": [ { "name": "ID", "in": "path", "description": "Parameter Schema Type changed \n| Updated Value | \n| :--- | \n| None | \n\n| Previous Value | \n| :--- | \n| None | \n\n", "required": true, "style": "SIMPLE", "explode": false, "schema": { "$ref": "#/components/schemas/ResourceIdPathValue_eventSteps", "exampleSetFlag": false }, "examples": { "wid": { "summary": "Specific resource WID", "value": "a3f5b554007d20e98360015c5e6daf6", "valueSetFlag": true } } } ] } } }, "components": { "schemas": { "INSTANCE_MODEL_REFERENCE": { "required": [ "id" ], "type": "object", "properties": { "id": { "pattern": "^(([0-9a-f]{32})|(\\S+=\\S+))$", "type": "string", "description": "Workday Id or Reference Id of the instance.", "exampleSetFlag": false, "types": [ "string" ] }, "descriptor": { "type": "string", "description": "The display name of the instance", "readOnly": true, "exampleSetFlag": false, "types": [ "string" ] }, "href": { "type": "string", "description": "A link to the instance", "readOnly": true, "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] }, "ERROR_MODEL_REFERENCE": { "required": [ "error" ], "type": "object", "properties": { "error": { "type": "string", "description": "A description of the error", "exampleSetFlag": false, "types": [ "string" ] }, "code": { "type": "string", "description": "The code that corresponds to the error message. Use the error code to drive programmatic error-handling behavior. Don't use error message strings for this purpose because they are subject to change", "exampleSetFlag": false, "types": [ "string" ] }, "field": { "type": "string", "description": "The field related to the error", "exampleSetFlag": false, "types": [ "string" ] }, "path": { "type": "string", "description": "The path of the field related to the error", "exampleSetFlag": false, "types": [ "string" ] }, "severity": { "type": "string", "description": "Severity of the validation (e.g. Critical, Warning).", "exampleSetFlag": false, "types": [ "string" ] }, "internalMessage": { "type": "string", "description": "Internal message providing additional context for the validation (e.g. representation content validation details).", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] }, "VALIDATION_ERROR_MODEL_REFERENCE": { "exampleSetFlag": false, "allOf": [ { "required": [ "error" ], "type": "object", "properties": { "error": { "type": "string", "description": "A description of the error", "exampleSetFlag": false, "types": [ "string" ] }, "errors": { "type": "array", "description": "An array of validation errors", "exampleSetFlag": false, "items": { "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE", "exampleSetFlag": false }, "types": [ "array" ] } }, "exampleSetFlag": false, "types": [ "object" ] } ] }, "FACETS_MODEL_REFERENCE": { "type": "array", "exampleSetFlag": false, "items": { "type": "object", "properties": { "descriptor": { "type": "string", "description": "A description of the facet", "exampleSetFlag": false, "types": [ "string" ] }, "facetParameter": { "type": "string", "description": "The alias used to select the facet", "exampleSetFlag": false, "types": [ "string" ] }, "values": { "type": "array", "description": "the facet values", "exampleSetFlag": false, "items": { "required": [ "id" ], "type": "object", "properties": { "count": { "type": "integer", "description": "The number of instances returned by this facet", "format": "int32", "exampleSetFlag": false, "types": [ "integer" ] }, "id": { "pattern": "^(([0-9a-f]{32})|(\\S+=\\S+))$", "type": "string", "description": "Workday Id or Reference Id of the instance.", "exampleSetFlag": false, "types": [ "string" ] }, "descriptor": { "type": "string", "description": "A description of the facet", "exampleSetFlag": false, "types": [ "string" ] }, "href": { "type": "string", "description": "A link to the instance", "readOnly": true, "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] }, "types": [ "array" ] } }, "description": "This object represents the possible facets for this resource", "readOnly": true, "exampleSetFlag": false, "types": [ "object" ] }, "types": [ "array" ] }, "MULTIPLE_INSTANCE_MODEL_REFERENCE": { "type": "object", "properties": { "total": { "type": "integer", "format": "int32", "exampleSetFlag": false, "types": [ "integer" ] }, "data": { "type": "array", "exampleSetFlag": false, "items": { "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE", "exampleSetFlag": false }, "types": [ "array" ] } }, "exampleSetFlag": false, "types": [ "object" ] }, "WorkdayId": { "pattern": "^[0-9a-f]{32}$", "type": "string", "description": "Workday ID (32-character lowercase hexadecimal string).", "example": "a3f5b554007d20e98360015c5e6daf6", "exampleSetFlag": true, "types": [ "string" ] }, "WorkdayReferenceId_types": { "pattern": "^(Business_Process_Type)=\\S+$", "type": "string", "description": "Workday reference ID (Type=Value). Valid types: Business_Process_Type", "example": "Business_Process_Type=21002", "exampleSetFlag": true, "types": [ "string" ] }, "ResourceIdPathValue_types": { "exampleSetFlag": false, "oneOf": [ { "$ref": "#/components/schemas/WorkdayId", "exampleSetFlag": false }, { "$ref": "#/components/schemas/WorkdayReferenceId_types", "exampleSetFlag": false } ] }, "businessProcessTypeDetails_e73cbf40479a100012b92d7f999d0144": { "exampleSetFlag": false, "allOf": [ { "type": "object", "properties": { "helpText": { "type": "string", "description": "The help text for the initiation step of a business process.", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "extensions": { "x-workday-type": "Rich Text" }, "exampleSetFlag": true, "types": [ "string" ] }, "descriptor": { "type": "string", "description": "The display name of the instance", "example": "Lorem ipsum dolor sit ame", "exampleSetFlag": true, "types": [ "string" ] }, "id": { "type": "string", "description": "Workday Id or Reference Id of the instance.", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] } ] }, "businessProcessTypeView_a06e49cf714e100008435914d7d90105": { "exampleSetFlag": false, "allOf": [ { "type": "object", "properties": { "descriptor": { "type": "string", "description": "The display name of the instance", "example": "Lorem ipsum dolor sit ame", "exampleSetFlag": true, "types": [ "string" ] }, "id": { "type": "string", "description": "Workday Id or Reference Id of the instance.", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] } ] }, "attachmentCategoryView_01bedd7c1f9e10001e09ac8bd50600e8": { "exampleSetFlag": false, "allOf": [ { "type": "object", "properties": { "referenceID": { "type": "string", "description": "The Reference ID to use for lookups within our Workday Web Services. For \\~supervisory organizations\\~, this is also the 'Organization ID'", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "extensions": { "x-workday-type": "Text" }, "exampleSetFlag": true, "types": [ "string" ] }, "descriptor": { "type": "string", "description": "The display name of the instance", "example": "Lorem ipsum dolor sit ame", "exampleSetFlag": true, "types": [ "string" ] }, "id": { "type": "string", "description": "Workday Id or Reference Id of the instance.", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] } ] }, "WorkdayReferenceId_events": { "pattern": "^(Worker_Time_Card_ID|Payroll_Reporting_Code_Event_ID|Eligibility_Override_Event_ID|Update_Student_Hold_Event_ID|Employee_Severance_Worksheet_Event_ID|Journal_Insights_Feedback_Event_Reference_ID|Proposed_Payroll_Input_Event|Quick_Issue_Reference_ID|Requirement_Effective_Date_Override_Event_ID|Inventory_Par_Location_Change_Event_ID|Request_Leave_of_Absence_ID|External_ID|Proposed_New_Project_Resource_Plan_Detail_Reference_ID|Recall_Reaction_ID|Recall_Response_ID|Spend_Authorization_Mass_Close_ID|Student_Dismissal_Event_ID|Budget_Amendment_ID|Compensation_Review_Event_ID|Change_Order_Reference_ID|Flexible_Payment_And_Deduction_Event_ID|Event_ID|Procurement_Mass_ReOpen_ID|Purchase_Item_Request_Event_ID|Purchase_Item_Maintenance_Event_Id|Requisition_Sourcing_Event_ID|Mass_Change_Requisition_Requester_ID|Invite_Committee_Candidate_Event_ID|Spend_Authorization_ID|Position_Budget_Group_ID|Employee_Review_ID|Recall_ID|Assign_Pay_Group_Event_ID|Customer_Request_ID|Workday_Project_ID|Request_Leave_of_Absence_Case_Number|Backorder_Event_ID|IRL_RPN_Submission_Event_Reference|Medicare_Information_Event_ID|Par_Removal_ID|Procurement_Roll_Forward_ID|Procurement_Document_Mass_Action_ID|Receipt_Adjustment_Number|Student_Hold_Assignment_Override_Event_ID|Absence_Case_ID|Change_Spend_Category_Reference_ID|Purchase_Item_Event_Id|Student_Institutional_Withdrawal_Event_ID|IRS_1099_MISC_Adjustment_ID|Supplier_Invoice_Contract_ID|Background_Process_Instance_ID|Background_Check_ID|Student_Leave_of_Absence_Event_ID|Student_Employment_Eligibility_Event_ID|Receipt_Number|Goods_Delivery_Run_ID|Customer_Request_Reference_ID|Benefits_Billing_Reference_ID|Goods_Delivery_Group_ID|Request_Payroll_Input_Event|Student_Onboarding_Event_Abstract_ID|Assignable_Payroll_ID|Complete_Action_Item_Event_ID|Change_Base_Reference_ID)=\\S+$", "type": "string", "description": "Workday reference ID (Type=Value). Valid types: Worker_Time_Card_ID, Payroll_Reporting_Code_Event_ID, Eligibility_Override_Event_ID, Update_Student_Hold_Event_ID, Employee_Severance_Worksheet_Event_ID, Journal_Insights_Feedback_Event_Reference_ID, Proposed_Payroll_Input_Event, Quick_Issue_Reference_ID, Requirement_Effective_Date_Override_Event_ID, Inventory_Par_Location_Change_Event_ID, Request_Leave_of_Absence_ID, External_ID, Proposed_New_Project_Resource_Plan_Detail_Reference_ID, Recall_Reaction_ID, Recall_Response_ID, Spend_Authorization_Mass_Close_ID, Student_Dismissal_Event_ID, Budget_Amendment_ID, Compensation_Review_Event_ID, Change_Order_Reference_ID, Flexible_Payment_And_Deduction_Event_ID, Event_ID, Procurement_Mass_ReOpen_ID, Purchase_Item_Request_Event_ID, Purchase_Item_Maintenance_Event_Id, Requisition_Sourcing_Event_ID, Mass_Change_Requisition_Requester_ID, Invite_Committee_Candidate_Event_ID, Spend_Authorization_ID, Position_Budget_Group_ID, Employee_Review_ID, Recall_ID, Assign_Pay_Group_Event_ID, Customer_Request_ID, Workday_Project_ID, Request_Leave_of_Absence_Case_Number, Backorder_Event_ID, IRL_RPN_Submission_Event_Reference, Medicare_Information_Event_ID, Par_Removal_ID, Procurement_Roll_Forward_ID, Procurement_Document_Mass_Action_ID, Receipt_Adjustment_Number, Student_Hold_Assignment_Override_Event_ID, Absence_Case_ID, Change_Spend_Category_Reference_ID, Purchase_Item_Event_Id, Student_Institutional_Withdrawal_Event_ID, IRS_1099_MISC_Adjustment_ID, Supplier_Invoice_Contract_ID, Background_Process_Instance_ID, Background_Check_ID, Student_Leave_of_Absence_Event_ID, Student_Employment_Eligibility_Event_ID, Receipt_Number, Goods_Delivery_Run_ID, Customer_Request_Reference_ID, Benefits_Billing_Reference_ID, Goods_Delivery_Group_ID, Request_Payroll_Input_Event, Student_Onboarding_Event_Abstract_ID, Assignable_Payroll_ID, Complete_Action_Item_Event_ID, Change_Base_Reference_ID", "example": "Worker_Time_Card_ID=21002", "exampleSetFlag": true, "types": [ "string" ] }, "ResourceIdPathValue_events": { "exampleSetFlag": false, "oneOf": [ { "$ref": "#/components/schemas/WorkdayId", "exampleSetFlag": false }, { "$ref": "#/components/schemas/WorkdayReferenceId_events", "exampleSetFlag": false } ] }, "status_ce00e3198c5b100009273f74aaf20011": { "description": "Transaction status or workflow state for an event. Example: Successfully Completed, Denied, Terminated", "exampleSetFlag": false, "allOf": [ { "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE", "exampleSetFlag": false }, { "type": "object", "exampleSetFlag": false, "types": [ "object" ] } ] }, "initiator_5fd69af0d37810001afef9a3d7684d0a": { "description": "The \\~worker\\~ that initiated the business process. Please do not use this field in a condition rule for the initiation step of a process, as it will not return results. This is because there is no initiating \\~worker\\~ designated until the process has started. The Initiating \\~Worker\\~ field only gets a value after the event is initiated (after the process is submitted).", "exampleSetFlag": false, "allOf": [ { "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE", "exampleSetFlag": false }, { "type": "object", "exampleSetFlag": false, "types": [ "object" ] } ] }, "overallBusinessProcess_ce00e3198c5b1000095ceb31e13f0015": { "description": "Returns the Top Level (overall) Business Process that this Event is part of or returns the same instance if this Event is not a sub-process.", "exampleSetFlag": false, "allOf": [ { "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE", "exampleSetFlag": false }, { "type": "object", "exampleSetFlag": false, "types": [ "object" ] } ] }, "for_ce00e3198c5b1000095ceb1fc8290014": { "description": "The thing which this business process is about. It could be another business process if this is a sub-process", "exampleSetFlag": false, "allOf": [ { "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE", "exampleSetFlag": false }, { "type": "object", "exampleSetFlag": false, "types": [ "object" ] } ] }, "eventDetails_ce00e3198c5b100007db119d8cef0007": { "exampleSetFlag": false, "allOf": [ { "type": "object", "properties": { "creationDate": { "type": "string", "description": "Date the business process was initiated.", "format": "date", "extensions": { "x-workday-type": "Date" }, "exampleSetFlag": false, "types": [ "string" ] }, "completedDate": { "type": "string", "description": "The date and time the business process was completed.", "format": "date", "extensions": { "x-workday-type": "Date" }, "exampleSetFlag": false, "types": [ "string" ] }, "status": { "$ref": "#/components/schemas/status_ce00e3198c5b100009273f74aaf20011", "exampleSetFlag": false }, "effectiveDate": { "type": "string", "description": "The date this business process takes effect.", "format": "date", "extensions": { "x-workday-type": "Date" }, "exampleSetFlag": false, "types": [ "string" ] }, "dueDate": { "type": "string", "description": "The date the business process needs to be completed.", "format": "date", "extensions": { "x-workday-type": "Date" }, "exampleSetFlag": false, "types": [ "string" ] }, "initiator": { "$ref": "#/components/schemas/initiator_5fd69af0d37810001afef9a3d7684d0a", "exampleSetFlag": false }, "subBusinessProcesses": { "type": "array", "description": "Returns other Business Processes (sub-processes) part of this process, including processes multiple levels down.", "extensions": { "x-workday-type": "Multi-instance" }, "exampleSetFlag": false, "items": { "$ref": "#/components/schemas/subBusinessProcesses_ce00e3198c5b1000095ceb025b770013", "exampleSetFlag": false }, "types": [ "array" ] }, "overallBusinessProcess": { "$ref": "#/components/schemas/overallBusinessProcess_ce00e3198c5b1000095ceb31e13f0015", "exampleSetFlag": false }, "for": { "$ref": "#/components/schemas/for_ce00e3198c5b1000095ceb1fc8290014", "exampleSetFlag": false }, "descriptor": { "type": "string", "description": "The display name of the instance", "example": "Lorem ipsum dolor sit ame", "exampleSetFlag": true, "types": [ "string" ] }, "id": { "type": "string", "description": "The id for Action Event", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] } ] }, "event_0108ca756f1b1000191379c74408007b": { "description": "Identifies the business process and allows you to drill into the details and access related actions.", "exampleSetFlag": false, "allOf": [ { "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE", "exampleSetFlag": false }, { "type": "object", "exampleSetFlag": false, "types": [ "object" ] } ] }, "completedByPerson_0108ca756f1b1000191379b06bbf0079": { "description": "The person that completed the step as Assignee", "exampleSetFlag": false, "allOf": [ { "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE", "exampleSetFlag": false }, { "type": "object", "exampleSetFlag": false, "types": [ "object" ] } ] }, "status_0108ca756f1b100019137981a39f0075": { "description": "The status of this business process step.", "exampleSetFlag": false, "allOf": [ { "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE", "exampleSetFlag": false }, { "type": "object", "exampleSetFlag": false, "types": [ "object" ] } ] }, "completedStepsView_0108ca756f1b10001913796229930074": { "exampleSetFlag": false, "allOf": [ { "type": "object", "properties": { "order": { "type": "string", "description": "The order of this step within the business process definition it is part of.", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "extensions": { "x-workday-type": "Text" }, "exampleSetFlag": true, "types": [ "string" ] }, "parallelStepInboxOrder": { "type": "string", "description": "The order of parallel steps in My Tasks. This field returns the order only if this business process type allows the Parallel Step Order in My Tasks configuration. If there are multiple steps from the business process definition that are associated to this event step, this field returns no value.", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "extensions": { "x-workday-type": "Text" }, "exampleSetFlag": true, "types": [ "string" ] }, "dueDate": { "type": "string", "description": "Returns the due date for this step.", "format": "date", "extensions": { "x-workday-type": "Date" }, "exampleSetFlag": false, "types": [ "string" ] }, "comments": { "type": "array", "description": "Returns the comments for the business process event step", "extensions": { "x-workday-type": "Multi-instance" }, "exampleSetFlag": false, "items": { "$ref": "#/components/schemas/comments_a7a41b4d029c10000b1da9c45b7b18f4", "exampleSetFlag": false }, "types": [ "array" ] }, "event": { "$ref": "#/components/schemas/event_0108ca756f1b1000191379c74408007b", "exampleSetFlag": false }, "awaitingPersons": { "type": "array", "description": "The people this event is currently awaiting for action.", "extensions": { "x-workday-type": "Multi-instance" }, "exampleSetFlag": false, "items": { "$ref": "#/components/schemas/awaitingPersons_0108ca756f1b1000191379d0c8b3007c", "exampleSetFlag": false }, "types": [ "array" ] }, "creationDate": { "type": "string", "description": "The date when the event record was created.", "format": "date", "extensions": { "x-workday-type": "Date" }, "exampleSetFlag": false, "types": [ "string" ] }, "completedDate": { "type": "string", "description": "The date when this step was completed", "format": "date", "extensions": { "x-workday-type": "Date" }, "exampleSetFlag": false, "types": [ "string" ] }, "completedByPerson": { "$ref": "#/components/schemas/completedByPerson_0108ca756f1b1000191379b06bbf0079", "exampleSetFlag": false }, "status": { "$ref": "#/components/schemas/status_0108ca756f1b100019137981a39f0075", "exampleSetFlag": false }, "descriptor": { "type": "string", "description": "The display name of the instance", "example": "Lorem ipsum dolor sit ame", "exampleSetFlag": true, "types": [ "string" ] }, "id": { "type": "string", "description": "The id for Event Record", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] } ] }, "stepType_d8ee62587cf610001a018fce99fb0117": { "description": "Returns the type of the step.", "exampleSetFlag": false, "allOf": [ { "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE", "exampleSetFlag": false }, { "type": "object", "exampleSetFlag": false, "types": [ "object" ] } ] }, "dueDate_d8ee62587cf610001af42c229a9f0144": { "description": "Returns the due date for the Process Definition Step.", "exampleSetFlag": false, "allOf": [ { "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE", "exampleSetFlag": false }, { "type": "object", "exampleSetFlag": false, "types": [ "object" ] } ] }, "remainingStepView_33c0a45dcb6a10000c26c7c9b9640020": { "exampleSetFlag": false, "allOf": [ { "type": "object", "properties": { "stepType": { "$ref": "#/components/schemas/stepType_d8ee62587cf610001a018fce99fb0117", "exampleSetFlag": false }, "completionStep": { "type": "boolean", "description": "Returns true if this step completes the business process.", "example": true, "extensions": { "x-workday-type": "Boolean" }, "exampleSetFlag": true, "types": [ "boolean" ] }, "step": { "type": "string", "description": "Returns the alternate name of the workflow step for the business process definition.", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "extensions": { "x-workday-type": "Text" }, "exampleSetFlag": true, "types": [ "string" ] }, "groups": { "type": "array", "description": "Returns the security groups that can perform the workflow step.", "extensions": { "x-workday-type": "Multi-instance" }, "exampleSetFlag": false, "items": { "$ref": "#/components/schemas/groups_d8ee62587cf610001a551e47fbc30124", "exampleSetFlag": false }, "types": [ "array" ] }, "parallelStepInboxOrder": { "type": "string", "description": "The order of parallel steps in My Tasks. This field returns the order only if this business process type allows the Parallel Step Order in My Tasks configuration.", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "extensions": { "x-workday-type": "Text" }, "exampleSetFlag": true, "types": [ "string" ] }, "dueDate": { "$ref": "#/components/schemas/dueDate_d8ee62587cf610001af42c229a9f0144", "exampleSetFlag": false }, "order": { "type": "string", "description": "Returns the order of this step within the business process definition it is part of.", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "extensions": { "x-workday-type": "Text" }, "exampleSetFlag": true, "types": [ "string" ] }, "descriptor": { "type": "string", "description": "The display name of the instance", "example": "Lorem ipsum dolor sit ame", "exampleSetFlag": true, "types": [ "string" ] }, "id": { "type": "string", "description": "The id for Workflow Step", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] } ] }, "person_a7a41b4d029c10000b46e7abcec61901": { "description": "Comment made by Person", "exampleSetFlag": false, "allOf": [ { "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE", "exampleSetFlag": false }, { "type": "object", "exampleSetFlag": false, "types": [ "object" ] } ] }, "comments_a7a41b4d029c10000b1da9c45b7b18f4": { "exampleSetFlag": false, "allOf": [ { "type": "object", "properties": { "commentDate": { "type": "string", "description": "Gives the moment at which the instance was originally created.", "format": "date", "extensions": { "x-workday-type": "Date" }, "exampleSetFlag": false, "types": [ "string" ] }, "person": { "$ref": "#/components/schemas/person_a7a41b4d029c10000b46e7abcec61901", "exampleSetFlag": false }, "comment": { "type": "string", "description": "Comment", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "extensions": { "x-workday-type": "Text" }, "exampleSetFlag": true, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] } ] }, "businessProcessEventAction_46302b0ce6a810001fcbad0bc1e30000": { "exampleSetFlag": false, "allOf": [ { "type": "object", "properties": { "comment": { "type": "string", "description": "comment", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "extensions": { "x-workday-type": "Text" }, "exampleSetFlag": true, "types": [ "string" ] }, "status": { "type": "string", "description": "status", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "extensions": { "x-workday-type": "Text" }, "exampleSetFlag": true, "types": [ "string" ] }, "descriptor": { "type": "string", "description": "The display name of the instance", "example": "Lorem ipsum dolor sit ame", "exampleSetFlag": true, "types": [ "string" ] }, "id": { "type": "string", "description": "Workday Id or Reference Id of the instance.", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] } ] }, "status_be45cf559398100006ba2d93420c0014": { "description": "The status of this business process step.", "exampleSetFlag": false, "allOf": [ { "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE", "exampleSetFlag": false }, { "type": "object", "exampleSetFlag": false, "types": [ "object" ] } ] }, "businessProcessStep_119846d6d88210000efec4095f07022f": { "description": "Returns the step being performed by the event record.", "exampleSetFlag": false, "allOf": [ { "$ref": "#/components/schemas/businessProcessStep_c7f1caa70f141000115398ce8d0800fd", "exampleSetFlag": false }, { "type": "object", "exampleSetFlag": false, "types": [ "object" ] } ] }, "stepsInProgressView_be45cf559398100006ba2d34b00d0010": { "exampleSetFlag": false, "allOf": [ { "type": "object", "properties": { "awaitingPersons": { "type": "array", "description": "The people this event is currently awaiting for action.", "extensions": { "x-workday-type": "Multi-instance" }, "exampleSetFlag": false, "items": { "$ref": "#/components/schemas/awaitingPersons_be45cf559398100006ba2d50d6700011", "exampleSetFlag": false }, "types": [ "array" ] }, "parallelStepInboxOrder": { "type": "string", "description": "The order of parallel steps in My Tasks. This field returns the order only if this business process type allows the Parallel Step Order in My Tasks configuration. If there are multiple steps from the business process definition that are associated to this event step, this field returns no value.", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "extensions": { "x-workday-type": "Text" }, "exampleSetFlag": true, "types": [ "string" ] }, "status": { "$ref": "#/components/schemas/status_be45cf559398100006ba2d93420c0014", "exampleSetFlag": false }, "creationDate": { "type": "string", "description": "The date when the event record was created.", "format": "date", "extensions": { "x-workday-type": "Date" }, "exampleSetFlag": false, "types": [ "string" ] }, "delayedDate": { "type": "string", "description": "The date the delayed step will trigger.", "format": "date", "extensions": { "x-workday-type": "Date" }, "exampleSetFlag": false, "types": [ "string" ] }, "dueDate": { "type": "string", "description": "Returns the due date for this step.", "format": "date", "extensions": { "x-workday-type": "Date" }, "exampleSetFlag": false, "types": [ "string" ] }, "anonymous": { "type": "boolean", "description": "Returns if the event step has been anonymously assigned.", "example": true, "extensions": { "x-workday-type": "Boolean" }, "exampleSetFlag": true, "types": [ "boolean" ] }, "order": { "type": "string", "description": "The order of this step within the business process definition it is part of.", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "extensions": { "x-workday-type": "Text" }, "exampleSetFlag": true, "types": [ "string" ] }, "businessProcessStep": { "$ref": "#/components/schemas/businessProcessStep_119846d6d88210000efec4095f07022f", "exampleSetFlag": false }, "descriptor": { "type": "string", "description": "The display name of the instance", "example": "Lorem ipsum dolor sit ame", "exampleSetFlag": true, "types": [ "string" ] }, "id": { "type": "string", "description": "The id for Event Record", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] } ] }, "ResourceIdPathValue_eventSteps": { "exampleSetFlag": false, "oneOf": [ { "$ref": "#/components/schemas/WorkdayId", "exampleSetFlag": false } ] }, "stepEvent_429268efcffb10000a1c13ce7e2200b3": { "description": "Returns Event for event record.", "exampleSetFlag": false, "allOf": [ { "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE", "exampleSetFlag": false }, { "type": "object", "exampleSetFlag": false, "types": [ "object" ] } ] }, "businessProcessStep_126610e8eaaa10001a6221fd7bb500b2": { "description": "Returns the step being performed by the event record.", "exampleSetFlag": false, "allOf": [ { "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE", "exampleSetFlag": false }, { "type": "object", "exampleSetFlag": false, "types": [ "object" ] } ] }, "status_a7a41b4d029c10000b1f9341d97718fb": { "description": "The status of this business process step.", "exampleSetFlag": false, "allOf": [ { "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE", "exampleSetFlag": false }, { "type": "object", "exampleSetFlag": false, "types": [ "object" ] } ] }, "stepType_003fc135ee7610000781c691372100fa": { "description": "Returns the type of step being performed by the event record.", "exampleSetFlag": false, "allOf": [ { "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE", "exampleSetFlag": false }, { "type": "object", "exampleSetFlag": false, "types": [ "object" ] } ] }, "businessProcess_abe94cbf692f10001401fef6197a023b": { "description": "The business process type of the event that the step is associated with.", "exampleSetFlag": false, "allOf": [ { "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE", "exampleSetFlag": false }, { "type": "object", "exampleSetFlag": false, "types": [ "object" ] } ] }, "task_1c5422aa354510000b063cf1297f00fb": { "description": "This CRF returns the instance of the task that is configured for the Event Record. The included instance information includes a descriptor and the WID.", "exampleSetFlag": false, "allOf": [ { "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE", "exampleSetFlag": false }, { "type": "object", "exampleSetFlag": false, "types": [ "object" ] } ] }, "overallProcess_cb97eee93655100009c59d031a5e013b": { "description": "Returns the overall process for this event record. The overall process is the outermost process in a business process.", "exampleSetFlag": false, "allOf": [ { "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE", "exampleSetFlag": false }, { "type": "object", "exampleSetFlag": false, "types": [ "object" ] } ] }, "event_a7a41b4d029c10000b1f9334c61218fa": { "description": "Identifies the business process and allows you to drill into the details and access related actions.", "exampleSetFlag": false, "allOf": [ { "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE", "exampleSetFlag": false }, { "type": "object", "exampleSetFlag": false, "types": [ "object" ] } ] }, "completedByPerson_a7a41b4d029c10000b1f9327976918f9": { "description": "The person that completed the step as Assignee", "exampleSetFlag": false, "allOf": [ { "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE", "exampleSetFlag": false }, { "type": "object", "exampleSetFlag": false, "types": [ "object" ] } ] }, "questionnaire_29444fc74ae610001adc2a36b8c300b3": { "description": "This CRF returns the instance of Questionnaire that is configured for the Complete Questionnaire Event included in the Event Record. The included instance information includes a descriptor and the WID.", "exampleSetFlag": false, "allOf": [ { "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE", "exampleSetFlag": false }, { "type": "object", "exampleSetFlag": false, "types": [ "object" ] } ] }, "eventStepsView_a7a41b4d029c10000b1f92d3188e18f6": { "exampleSetFlag": false, "allOf": [ { "type": "object", "properties": { "delayedDate": { "type": "string", "description": "The date the delayed step will trigger.", "format": "date", "extensions": { "x-workday-type": "Date" }, "exampleSetFlag": false, "types": [ "string" ] }, "stepEvent": { "$ref": "#/components/schemas/stepEvent_429268efcffb10000a1c13ce7e2200b3", "exampleSetFlag": false }, "businessProcessStep": { "$ref": "#/components/schemas/businessProcessStep_126610e8eaaa10001a6221fd7bb500b2", "exampleSetFlag": false }, "status": { "$ref": "#/components/schemas/status_a7a41b4d029c10000b1f9341d97718fb", "exampleSetFlag": false }, "parallelStepInboxOrder": { "type": "string", "description": "The order of parallel steps in My Tasks. This field returns the order only if this business process type allows the Parallel Step Order in My Tasks configuration. If there are multiple steps from the business process definition that are associated to this event step, this field returns no value.", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "extensions": { "x-workday-type": "Text" }, "exampleSetFlag": true, "types": [ "string" ] }, "dueDate": { "type": "string", "description": "Returns the due date for this step.", "format": "date", "extensions": { "x-workday-type": "Date" }, "exampleSetFlag": false, "types": [ "string" ] }, "stepType": { "$ref": "#/components/schemas/stepType_003fc135ee7610000781c691372100fa", "exampleSetFlag": false }, "order": { "type": "string", "description": "The order of this step within the business process definition it is part of.", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "extensions": { "x-workday-type": "Text" }, "exampleSetFlag": true, "types": [ "string" ] }, "stepHelpText": { "type": "string", "description": "This CRF returns the step help text that is configured for the Workflow Step of the Event Record.", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "extensions": { "x-workday-type": "Rich Text" }, "exampleSetFlag": true, "types": [ "string" ] }, "businessProcess": { "$ref": "#/components/schemas/businessProcess_abe94cbf692f10001401fef6197a023b", "exampleSetFlag": false }, "task": { "$ref": "#/components/schemas/task_1c5422aa354510000b063cf1297f00fb", "exampleSetFlag": false }, "completedDate": { "type": "string", "description": "The date when this step was completed", "format": "date", "extensions": { "x-workday-type": "Date" }, "exampleSetFlag": false, "types": [ "string" ] }, "awaitingPersons": { "type": "array", "description": "The people this event is currently awaiting for action.", "extensions": { "x-workday-type": "Multi-instance" }, "exampleSetFlag": false, "items": { "$ref": "#/components/schemas/awaitingPersons_a7a41b4d029c10000b1f9316fd2018f8", "exampleSetFlag": false }, "types": [ "array" ] }, "overallProcess": { "$ref": "#/components/schemas/overallProcess_cb97eee93655100009c59d031a5e013b", "exampleSetFlag": false }, "comments": { "type": "array", "description": "Returns the comments for the business process event step", "extensions": { "x-workday-type": "Multi-instance" }, "exampleSetFlag": false, "items": { "$ref": "#/components/schemas/comments_a7a41b4d029c10000b1da9c45b7b18f4", "exampleSetFlag": false }, "types": [ "array" ] }, "event": { "$ref": "#/components/schemas/event_a7a41b4d029c10000b1f9334c61218fa", "exampleSetFlag": false }, "completedByPerson": { "$ref": "#/components/schemas/completedByPerson_a7a41b4d029c10000b1f9327976918f9", "exampleSetFlag": false }, "questionnaire": { "$ref": "#/components/schemas/questionnaire_29444fc74ae610001adc2a36b8c300b3", "exampleSetFlag": false }, "creationDate": { "type": "string", "description": "The date when the event record was created.", "format": "date", "extensions": { "x-workday-type": "Date" }, "exampleSetFlag": false, "types": [ "string" ] }, "descriptor": { "type": "string", "description": "The display name of the instance", "example": "Lorem ipsum dolor sit ame", "exampleSetFlag": true, "types": [ "string" ] }, "id": { "type": "string", "description": "Workday Id or Reference Id of the instance.", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] } ] }, "stepEvent_0e248a2147271000163da105718300b7": { "description": "Returns Event for event record.", "exampleSetFlag": false, "allOf": [ { "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE", "exampleSetFlag": false }, { "type": "object", "exampleSetFlag": false, "types": [ "object" ] } ] }, "overallProcess_da856647269810000f8afbe3503c0191": { "description": "Returns the overall process for this event record. The overall process is the outermost process in a business process.", "exampleSetFlag": false, "allOf": [ { "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE", "exampleSetFlag": false }, { "type": "object", "exampleSetFlag": false, "types": [ "object" ] } ] }, "task_da856647269810000f8afbdb394e018e": { "description": "This CRF returns the instance of the task that is configured for the Event Record. The included instance information includes a descriptor and the WID.", "exampleSetFlag": false, "allOf": [ { "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE", "exampleSetFlag": false }, { "type": "object", "exampleSetFlag": false, "types": [ "object" ] } ] }, "businessProcessStep_da856647269810000f8afbbdc74c0186": { "description": "Returns the step being performed by the event record.", "exampleSetFlag": false, "allOf": [ { "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE", "exampleSetFlag": false }, { "type": "object", "exampleSetFlag": false, "types": [ "object" ] } ] }, "stepType_da856647269810000f8afbcf5b17018a": { "description": "Returns the type of step being performed by the event record.", "exampleSetFlag": false, "allOf": [ { "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE", "exampleSetFlag": false }, { "type": "object", "exampleSetFlag": false, "types": [ "object" ] } ] }, "businessProcess_da856647269810000f8afbd85bf8018d": { "description": "The business process type of the event that the step is associated with.", "exampleSetFlag": false, "allOf": [ { "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE", "exampleSetFlag": false }, { "type": "object", "exampleSetFlag": false, "types": [ "object" ] } ] }, "completedByPerson_da856647269810000f8afbed6fd00194": { "description": "The person that completed the step as Assignee", "exampleSetFlag": false, "allOf": [ { "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE", "exampleSetFlag": false }, { "type": "object", "exampleSetFlag": false, "types": [ "object" ] } ] }, "status_da856647269810000f8afbc077fb0187": { "description": "The status of this business process step.", "exampleSetFlag": false, "allOf": [ { "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE", "exampleSetFlag": false }, { "type": "object", "exampleSetFlag": false, "types": [ "object" ] } ] }, "event_da856647269810000f8afbeac5a00193": { "description": "Identifies the business process and allows you to drill into the details and access related actions.", "exampleSetFlag": false, "allOf": [ { "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE", "exampleSetFlag": false }, { "type": "object", "exampleSetFlag": false, "types": [ "object" ] } ] }, "eventStepsSummary_da856647269810000f8afbac30ba0183": { "exampleSetFlag": false, "allOf": [ { "type": "object", "properties": { "stepEvent": { "$ref": "#/components/schemas/stepEvent_0e248a2147271000163da105718300b7", "exampleSetFlag": false }, "creationDate": { "type": "string", "description": "The date when the event record was created.", "format": "date", "extensions": { "x-workday-type": "Date" }, "exampleSetFlag": false, "types": [ "string" ] }, "stepHelpText": { "type": "string", "description": "This CRF returns the step help text that is configured for the Workflow Step of the Event Record.", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "extensions": { "x-workday-type": "Rich Text" }, "exampleSetFlag": true, "types": [ "string" ] }, "overallProcess": { "$ref": "#/components/schemas/overallProcess_da856647269810000f8afbe3503c0191", "exampleSetFlag": false }, "delayedDate": { "type": "string", "description": "The date the delayed step will trigger.", "format": "date", "extensions": { "x-workday-type": "Date" }, "exampleSetFlag": false, "types": [ "string" ] }, "completedDate": { "type": "string", "description": "The date when this step was completed", "format": "date", "extensions": { "x-workday-type": "Date" }, "exampleSetFlag": false, "types": [ "string" ] }, "task": { "$ref": "#/components/schemas/task_da856647269810000f8afbdb394e018e", "exampleSetFlag": false }, "awaitingPersons": { "type": "array", "description": "The people this event is currently awaiting for action.", "extensions": { "x-workday-type": "Multi-instance" }, "exampleSetFlag": false, "items": { "$ref": "#/components/schemas/awaitingPersons_da856647269810000f8afbe0b1160190", "exampleSetFlag": false }, "types": [ "array" ] }, "businessProcessStep": { "$ref": "#/components/schemas/businessProcessStep_da856647269810000f8afbbdc74c0186", "exampleSetFlag": false }, "stepType": { "$ref": "#/components/schemas/stepType_da856647269810000f8afbcf5b17018a", "exampleSetFlag": false }, "businessProcess": { "$ref": "#/components/schemas/businessProcess_da856647269810000f8afbd85bf8018d", "exampleSetFlag": false }, "parallelStepInboxOrder": { "type": "string", "description": "The order of parallel steps in My Tasks. This field returns the order only if this business process type allows the Parallel Step Order in My Tasks configuration. If there are multiple steps from the business process definition that are associated to this event step, this field returns no value.", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "extensions": { "x-workday-type": "Text" }, "exampleSetFlag": true, "types": [ "string" ] }, "completedByPerson": { "$ref": "#/components/schemas/completedByPerson_da856647269810000f8afbed6fd00194", "exampleSetFlag": false }, "comments": { "type": "array", "description": "Returns the comments for the business process event step", "extensions": { "x-workday-type": "Multi-instance" }, "exampleSetFlag": false, "items": { "$ref": "#/components/schemas/comments_a7a41b4d029c10000b1da9c45b7b18f4", "exampleSetFlag": false }, "types": [ "array" ] }, "status": { "$ref": "#/components/schemas/status_da856647269810000f8afbc077fb0187", "exampleSetFlag": false }, "order": { "type": "string", "description": "The order of this step within the business process definition it is part of.", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "extensions": { "x-workday-type": "Text" }, "exampleSetFlag": true, "types": [ "string" ] }, "dueDate": { "type": "string", "description": "Returns the due date for this step.", "format": "date", "extensions": { "x-workday-type": "Date" }, "exampleSetFlag": false, "types": [ "string" ] }, "event": { "$ref": "#/components/schemas/event_da856647269810000f8afbeac5a00193", "exampleSetFlag": false }, "descriptor": { "type": "string", "description": "The display name of the instance", "example": "Lorem ipsum dolor sit ame", "exampleSetFlag": true, "types": [ "string" ] }, "id": { "type": "string", "description": "The id for Event Record", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] } ] }, "businessProcessStepsReassign_bd578ca9ac8010001895bda38db00000": { "exampleSetFlag": false, "allOf": [ { "type": "object", "properties": { "awaitingRoles": { "type": "array", "description": "The roles that the business event step is awaiting.", "extensions": { "x-workday-type": "Multi-instance", "x-readOnly": true }, "exampleSetFlag": false, "items": { "$ref": "#/components/schemas/awaitingRoles_d6a10186b85d100015f2f7094b410000", "exampleSetFlag": false }, "types": [ "array" ] }, "addAssignees": { "type": "array", "description": "Assignees added to the business process step because of reassignment.", "extensions": { "x-workday-type": "Multi-instance" }, "exampleSetFlag": false, "items": { "$ref": "#/components/schemas/addAssignees_d6a10186b85d10001820dee2dce40000", "exampleSetFlag": false }, "types": [ "array" ] }, "removeAssignees": { "type": "array", "description": "Assignees removed from the business process step because of reassignment.", "extensions": { "x-workday-type": "Multi-instance" }, "exampleSetFlag": false, "items": { "$ref": "#/components/schemas/removeAssignees_d6a10186b85d10001786ad45b71c0000", "exampleSetFlag": false }, "types": [ "array" ] }, "comment": { "type": "string", "description": "Comments provided on the business process step because of reassignment.", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "extensions": { "x-workday-type": "Text" }, "exampleSetFlag": true, "types": [ "string" ] }, "descriptor": { "type": "string", "description": "The display name of the instance", "example": "Lorem ipsum dolor sit ame", "exampleSetFlag": true, "types": [ "string" ] }, "id": { "type": "string", "description": "The id for Event Record", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] } ] }, "eventStatus_0277c526ae0f1000142f25a5ad5e12cd": { "description": "Returns the Workflow State of the current Action Event", "exampleSetFlag": false, "allOf": [ { "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE", "exampleSetFlag": false }, { "type": "object", "exampleSetFlag": false, "types": [ "object" ] } ] }, "stepAction_0277c526ae0f100006ec0d3a4fd7128d": { "description": "The status of this business process step.", "exampleSetFlag": false, "allOf": [ { "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE", "exampleSetFlag": false }, { "type": "object", "exampleSetFlag": false, "types": [ "object" ] } ] }, "businessProcessStepsDeny_0277c526ae0f100006ec0c0cc48a128b": { "exampleSetFlag": false, "allOf": [ { "type": "object", "properties": { "comment": { "type": "string", "description": "Returns user's comment for Event Record.", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "extensions": { "x-workday-type": "Text" }, "exampleSetFlag": true, "types": [ "string" ] }, "eventStatus": { "$ref": "#/components/schemas/eventStatus_0277c526ae0f1000142f25a5ad5e12cd", "exampleSetFlag": false }, "stepAction": { "$ref": "#/components/schemas/stepAction_0277c526ae0f100006ec0d3a4fd7128d", "exampleSetFlag": false }, "descriptor": { "type": "string", "description": "The display name of the instance", "example": "Lorem ipsum dolor sit ame", "exampleSetFlag": true, "types": [ "string" ] }, "id": { "type": "string", "description": "The id for Event Record", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] } ] }, "status_7493dc548656100016691f82f04a0448": { "description": "The status of this business process step.", "extensions": { "x-readOnly": true }, "exampleSetFlag": false, "allOf": [ { "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE", "exampleSetFlag": false }, { "type": "object", "exampleSetFlag": false, "types": [ "object" ] } ] }, "to_7493dc54865610001e4448dfd4cc0826": { "description": "a set containing no instances", "extensions": { "x-workday-populated-by": { "path": "/values/sendBack/to", "field": "id" } }, "exampleSetFlag": false, "allOf": [ { "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE", "exampleSetFlag": false }, { "type": "object", "exampleSetFlag": false, "types": [ "object" ] } ] }, "businessProcessStepSendBack_7493dc548656100016691f68af730447": { "exampleSetFlag": false, "allOf": [ { "required": [ "reason", "to" ], "type": "object", "properties": { "reason": { "type": "string", "description": "Returns user's comment for Event Record.", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "extensions": { "x-workday-type": "Text" }, "exampleSetFlag": true, "types": [ "string" ] }, "status": { "$ref": "#/components/schemas/status_7493dc548656100016691f82f04a0448", "exampleSetFlag": false }, "to": { "$ref": "#/components/schemas/to_7493dc54865610001e4448dfd4cc0826", "exampleSetFlag": false }, "descriptor": { "type": "string", "description": "The display name of the instance", "example": "Lorem ipsum dolor sit ame", "exampleSetFlag": true, "types": [ "string" ] }, "id": { "type": "string", "description": "The id for Event Record", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] } ] }, "stepAction_122be871d36110000539df507b410000": { "description": "The status of the step", "exampleSetFlag": false, "allOf": [ { "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE", "exampleSetFlag": false }, { "type": "object", "exampleSetFlag": false, "types": [ "object" ] } ] }, "businessProcessEventStepTodo_33ae690d779b10001c98021b2aa90000": { "exampleSetFlag": false, "allOf": [ { "required": [ "stepAction" ], "type": "object", "properties": { "stepAction": { "$ref": "#/components/schemas/stepAction_122be871d36110000539df507b410000", "exampleSetFlag": false }, "comment": { "type": "string", "description": "Last Comment", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "extensions": { "x-workday-type": "Text" }, "exampleSetFlag": true, "types": [ "string" ] }, "descriptor": { "type": "string", "description": "The display name of the instance", "example": "Lorem ipsum dolor sit ame", "exampleSetFlag": true, "types": [ "string" ] }, "id": { "type": "string", "description": "The id for Event Record", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] } ] }, "eventStatus_d3a64cee269d100010eef79987c40042": { "description": "Returns the Workflow State of the current Action Event", "exampleSetFlag": false, "allOf": [ { "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE", "exampleSetFlag": false }, { "type": "object", "exampleSetFlag": false, "types": [ "object" ] } ] }, "businessProcessStepsApprove_d3a64cee269d100010ccdf1f3a7a003c": { "exampleSetFlag": false, "allOf": [ { "type": "object", "properties": { "comment": { "type": "string", "description": "Returns user's comment for Event Record.", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "extensions": { "x-workday-type": "Text" }, "exampleSetFlag": true, "types": [ "string" ] }, "eventStatus": { "$ref": "#/components/schemas/eventStatus_d3a64cee269d100010eef79987c40042", "exampleSetFlag": false }, "descriptor": { "type": "string", "description": "The display name of the instance", "example": "Lorem ipsum dolor sit ame", "exampleSetFlag": true, "types": [ "string" ] }, "id": { "type": "string", "description": "The id for Event Record", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] } ] }, "subBusinessProcess_e72a50878598100007c686af2536000e": { "exampleSetFlag": false, "allOf": [ { "type": "object", "properties": { "descriptor": { "type": "string", "description": "The display name of the instance", "example": "Lorem ipsum dolor sit ame", "exampleSetFlag": true, "types": [ "string" ] }, "id": { "type": "string", "description": "The id for Action Event", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] } ] }, "subBusinessProcesses_ce00e3198c5b1000095ceb025b770013": { "exampleSetFlag": false, "allOf": [ { "$ref": "#/components/schemas/subBusinessProcess_e72a50878598100007c686af2536000e", "exampleSetFlag": false }, { "type": "object", "properties": { "id": { "type": "string", "description": "The id for Action Event", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] } ] }, "awaitingPerson_be45cf559398100006b982ad8c6d000e": { "exampleSetFlag": false, "allOf": [ { "type": "object", "properties": { "descriptor": { "type": "string", "description": "The display name of the instance", "example": "Lorem ipsum dolor sit ame", "exampleSetFlag": true, "types": [ "string" ] }, "id": { "type": "string", "description": "The id for Person", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] } ] }, "awaitingPersons_0108ca756f1b1000191379d0c8b3007c": { "exampleSetFlag": false, "allOf": [ { "$ref": "#/components/schemas/awaitingPerson_be45cf559398100006b982ad8c6d000e", "exampleSetFlag": false }, { "type": "object", "properties": { "id": { "type": "string", "description": "The id for Person", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] } ] }, "uploadedBy_b32ff437243510000c2e443f3c8b0155": { "description": "Returns the primary Role of the person who uploaded the Attachment.", "exampleSetFlag": false, "allOf": [ { "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE", "exampleSetFlag": false }, { "type": "object", "exampleSetFlag": false, "types": [ "object" ] } ] }, "contentType_f1092a8e519710000a41ca17e2da02a3": { "description": "Content type of the attachment", "exampleSetFlag": false, "allOf": [ { "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE", "exampleSetFlag": false }, { "type": "object", "exampleSetFlag": false, "types": [ "object" ] } ] }, "category_f1092a8e519710000a41ca421a3602a5": { "description": "Returns the category of a Business Process Attachment.", "exampleSetFlag": false, "allOf": [ { "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE", "exampleSetFlag": false }, { "type": "object", "exampleSetFlag": false, "types": [ "object" ] } ] }, "eventAttachmentsView_f1092a8e5197100009621afa37b9029b": { "exampleSetFlag": false, "allOf": [ { "type": "object", "properties": { "fileName": { "maxLength": 255, "type": "string", "description": "File name of the attachment", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "extensions": { "x-workday-type": "Text" }, "exampleSetFlag": true, "types": [ "string" ] }, "file": { "type": "string", "description": "For RaaS Only (Reports used as Web Services). Returns the raw Base64 data for an attachment or image.", "format": "binary", "extensions": { "x-workday-type": "File" }, "exampleSetFlag": false, "types": [ "string" ] }, "uploadDate": { "type": "string", "description": "Returns Date the Business Process Attachment was updated.", "format": "date", "extensions": { "x-workday-type": "Date" }, "exampleSetFlag": false, "types": [ "string" ] }, "uploadedBy": { "$ref": "#/components/schemas/uploadedBy_b32ff437243510000c2e443f3c8b0155", "exampleSetFlag": false }, "description": { "type": "string", "description": "Event attachment description", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "extensions": { "x-workday-type": "Text" }, "exampleSetFlag": true, "types": [ "string" ] }, "contentType": { "$ref": "#/components/schemas/contentType_f1092a8e519710000a41ca17e2da02a3", "exampleSetFlag": false }, "category": { "$ref": "#/components/schemas/category_f1092a8e519710000a41ca421a3602a5", "exampleSetFlag": false }, "fileLength": { "type": "integer", "description": "File length of the attachment", "format": "int32", "example": 99999999999, "extensions": { "x-workday-type": "Numeric" }, "exampleSetFlag": true, "types": [ "integer" ] }, "id": { "type": "string", "description": "The id for Event Attachment", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] } ] }, "securityGroupView_5abdf20568241000191b2a1b8cf502ea": { "exampleSetFlag": false, "allOf": [ { "type": "object", "properties": { "descriptor": { "type": "string", "description": "The display name of the instance", "example": "Lorem ipsum dolor sit ame", "exampleSetFlag": true, "types": [ "string" ] }, "id": { "type": "string", "description": "The id for Security Group", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] } ] }, "groups_d8ee62587cf610001a551e47fbc30124": { "exampleSetFlag": false, "allOf": [ { "$ref": "#/components/schemas/securityGroupView_5abdf20568241000191b2a1b8cf502ea", "exampleSetFlag": false }, { "type": "object", "properties": { "id": { "type": "string", "description": "The id for Security Group", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] } ] }, "businessProcessStep_c7f1caa70f141000115398ce8d0800fd": { "exampleSetFlag": false, "allOf": [ { "type": "object", "properties": { "descriptor": { "type": "string", "description": "The display name of the instance", "example": "Lorem ipsum dolor sit ame", "exampleSetFlag": true, "types": [ "string" ] }, "id": { "type": "string", "description": "The id for Workflow Step", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] } ] }, "awaitingPersons_be45cf559398100006ba2d50d6700011": { "exampleSetFlag": false, "allOf": [ { "$ref": "#/components/schemas/awaitingPerson_be45cf559398100006b982ad8c6d000e", "exampleSetFlag": false }, { "type": "object", "properties": { "id": { "type": "string", "description": "The id for Person", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] } ] }, "awaitingPersons_a7a41b4d029c10000b1f9316fd2018f8": { "exampleSetFlag": false, "allOf": [ { "$ref": "#/components/schemas/awaitingPerson_be45cf559398100006b982ad8c6d000e", "exampleSetFlag": false }, { "type": "object", "properties": { "id": { "type": "string", "description": "The id for Person", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] } ] }, "awaitingPersons_da856647269810000f8afbe0b1160190": { "exampleSetFlag": false, "allOf": [ { "$ref": "#/components/schemas/awaitingPerson_be45cf559398100006b982ad8c6d000e", "exampleSetFlag": false }, { "type": "object", "properties": { "id": { "type": "string", "description": "The id for Person", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] } ] }, "roles_d6a10186b85d1000177ee6105ff50000": { "exampleSetFlag": false, "allOf": [ { "type": "object", "properties": { "descriptor": { "type": "string", "description": "The display name of the instance", "example": "Lorem ipsum dolor sit ame", "exampleSetFlag": true, "types": [ "string" ] }, "id": { "type": "string", "description": "The id for Role Representation", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] } ] }, "awaitingRoles_d6a10186b85d100015f2f7094b410000": { "exampleSetFlag": false, "allOf": [ { "$ref": "#/components/schemas/roles_d6a10186b85d1000177ee6105ff50000", "exampleSetFlag": false }, { "type": "object", "properties": { "id": { "type": "string", "description": "The id for Role", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] } ] }, "addAssignees_d6a10186b85d10001820dee2dce40000": { "exampleSetFlag": false, "allOf": [ { "$ref": "#/components/schemas/roles_d6a10186b85d1000177ee6105ff50000", "exampleSetFlag": false }, { "type": "object", "properties": { "id": { "type": "string", "description": "The id for Role Representation", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] } ] }, "removeAssignees_d6a10186b85d10001786ad45b71c0000": { "exampleSetFlag": false, "allOf": [ { "$ref": "#/components/schemas/roles_d6a10186b85d1000177ee6105ff50000", "exampleSetFlag": false }, { "type": "object", "properties": { "id": { "type": "string", "description": "The id for Role Representation", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] } ] }, "contentType_cfb1e71e5435100008e52b8894ef0709": { "description": "Content type of the attachment", "exampleSetFlag": false, "allOf": [ { "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE", "exampleSetFlag": false }, { "type": "object", "exampleSetFlag": false, "types": [ "object" ] } ] }, "questionnaireAttachment_cfb1e71e5435100008e52b3f011f0708": { "exampleSetFlag": false, "allOf": [ { "type": "object", "properties": { "fileLength": { "type": "integer", "description": "File length of the attachment", "format": "int32", "example": 99999999999, "extensions": { "x-workday-type": "Numeric" }, "exampleSetFlag": true, "types": [ "integer" ] }, "file": { "type": "string", "description": "For RaaS Only (Reports used as Web Services). Returns the raw Base64 data for an attachment or image.", "format": "binary", "extensions": { "x-workday-type": "File" }, "exampleSetFlag": false, "types": [ "string" ] }, "fileName": { "maxLength": 255, "type": "string", "description": "File name of the attachment", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "extensions": { "x-workday-type": "Text" }, "exampleSetFlag": true, "types": [ "string" ] }, "contentType": { "$ref": "#/components/schemas/contentType_cfb1e71e5435100008e52b8894ef0709", "exampleSetFlag": false }, "descriptor": { "type": "string", "description": "The display name of the instance", "example": "Lorem ipsum dolor sit ame", "exampleSetFlag": true, "types": [ "string" ] }, "id": { "type": "string", "description": "The id for Questionnaire Attachment Representation", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] } ] }, "questionMultipleChoiceAnswerEmptyView_670e7e9e117b100027c36c757fb807d5": { "exampleSetFlag": false, "allOf": [ { "type": "object", "properties": { "descriptor": { "type": "string", "description": "The display name of the instance", "example": "Lorem ipsum dolor sit ame", "exampleSetFlag": true, "types": [ "string" ] }, "id": { "type": "string", "description": "The id for Question Multiple Choice Answer Representation", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] } ] }, "questionItem_670e7e9e117b10002790f46f3d9c07d1": { "description": "Question Item for Questionnaire Answer. Question item represents the question in a questionnaire.", "exampleSetFlag": false, "allOf": [ { "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE", "exampleSetFlag": false }, { "type": "object", "exampleSetFlag": false, "types": [ "object" ] } ] }, "questionnaireAttachments_69164aa4df9610001e17f32134be5429": { "exampleSetFlag": false, "allOf": [ { "$ref": "#/components/schemas/questionnaireAttachment_cfb1e71e5435100008e52b3f011f0708", "exampleSetFlag": false }, { "type": "object", "properties": { "id": { "type": "string", "description": "The id for Questionnaire Attachment Representation", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] } ] }, "answerMultipleChoices_670e7e9e117b10002790f474903a07d2": { "exampleSetFlag": false, "allOf": [ { "$ref": "#/components/schemas/questionMultipleChoiceAnswerEmptyView_670e7e9e117b100027c36c757fb807d5", "exampleSetFlag": false }, { "type": "object", "properties": { "id": { "type": "string", "description": "The id for Question Multiple Choice Answer Representation", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] } ] }, "questionnaireAnswerCreate_670e7e9e117b1000276a34afc7b207cb": { "exampleSetFlag": false, "allOf": [ { "type": "object", "properties": { "questionItem": { "$ref": "#/components/schemas/questionItem_670e7e9e117b10002790f46f3d9c07d1", "exampleSetFlag": false }, "questionnaireAttachments": { "type": "array", "description": "Questionnaire Attachments for Questionnaire Response.", "extensions": { "x-workday-type": "Multi-instance" }, "exampleSetFlag": false, "items": { "$ref": "#/components/schemas/questionnaireAttachments_69164aa4df9610001e17f32134be5429", "exampleSetFlag": false }, "types": [ "array" ] }, "answerNumeric": { "type": "integer", "description": "The answer in a numeric format.", "format": "int32", "example": 99999999999, "extensions": { "x-workday-type": "Numeric" }, "exampleSetFlag": true, "types": [ "integer" ] }, "answerMultipleChoices": { "type": "array", "description": "Question Multiple Choice Answers for question answer", "extensions": { "x-workday-type": "Multi-instance" }, "exampleSetFlag": false, "items": { "$ref": "#/components/schemas/answerMultipleChoices_670e7e9e117b10002790f474903a07d2", "exampleSetFlag": false }, "types": [ "array" ] }, "answerDate": { "type": "string", "description": "The answer in a date format.", "format": "date", "extensions": { "x-workday-type": "Date" }, "exampleSetFlag": false, "types": [ "string" ] }, "answerText": { "type": "string", "description": "The text answer for a questionnaire.", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "extensions": { "x-workday-type": "Text" }, "exampleSetFlag": true, "types": [ "string" ] }, "descriptor": { "type": "string", "description": "The display name of the instance", "example": "Lorem ipsum dolor sit ame", "exampleSetFlag": true, "types": [ "string" ] }, "id": { "type": "string", "description": "The id for Questionnaire Answer Representation", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] } ] }, "questionnaireAnswers_670e7e9e117b10002734f5a0c9fd07c7": { "exampleSetFlag": false, "allOf": [ { "$ref": "#/components/schemas/questionnaireAnswerCreate_670e7e9e117b1000276a34afc7b207cb", "exampleSetFlag": false }, { "type": "object", "properties": { "id": { "type": "string", "description": "The id for Questionnaire Answer Representation", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] } ] }, "questionnaireTargetContext_b73d92d470c7100012164155beb48425": { "description": "The applicable questionnaire or application for a student. Example: Student Application for Spring 2023. This is a new attribute as of 2021R2, and is currently only supported for Student.", "exampleSetFlag": false, "allOf": [ { "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE", "exampleSetFlag": false }, { "type": "object", "exampleSetFlag": false, "types": [ "object" ] } ] }, "questionnaireTarget_b73d92d470c7100012164171eac28426": { "description": "The questionnaire subject. Example: The candidate for admission to a school. This is a new attribute as of 2021R2, and is currently only supported for Student.", "exampleSetFlag": false, "allOf": [ { "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE", "exampleSetFlag": false }, { "type": "object", "exampleSetFlag": false, "types": [ "object" ] } ] }, "questionnaireResponseSubmit_177812e3e8b51000163a63c22b7a0000": { "exampleSetFlag": false, "allOf": [ { "type": "object", "properties": { "questionnaireAnswers": { "type": "array", "description": "The set of answers for a questionnaire.", "extensions": { "x-workday-type": "Multi-instance" }, "exampleSetFlag": false, "items": { "$ref": "#/components/schemas/questionnaireAnswers_670e7e9e117b10002734f5a0c9fd07c7", "exampleSetFlag": false }, "types": [ "array" ] }, "questionnaireTargetContext": { "$ref": "#/components/schemas/questionnaireTargetContext_b73d92d470c7100012164155beb48425", "exampleSetFlag": false }, "questionnaireTarget": { "$ref": "#/components/schemas/questionnaireTarget_b73d92d470c7100012164171eac28426", "exampleSetFlag": false }, "descriptor": { "type": "string", "description": "The display name of the instance", "example": "Lorem ipsum dolor sit ame", "exampleSetFlag": true, "types": [ "string" ] }, "id": { "type": "string", "description": "The id for Questionnaire Response Representation", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] } ] }, "stepAction_0fe15a3bc2e510000a1ff95a59a30000": { "description": "The status of the step", "exampleSetFlag": false, "allOf": [ { "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE", "exampleSetFlag": false }, { "type": "object", "exampleSetFlag": false, "types": [ "object" ] } ] }, "questionnaireResponse_3544fcea2784100018ee4320719e0000": { "description": "Questionnaire Response", "exampleSetFlag": false, "allOf": [ { "$ref": "#/components/schemas/questionnaireResponseSubmit_177812e3e8b51000163a63c22b7a0000", "exampleSetFlag": false }, { "type": "object", "exampleSetFlag": false, "types": [ "object" ] } ] }, "completeQuestionnaireEventStep_3544fcea2784100018ee4286aeca0000": { "exampleSetFlag": false, "allOf": [ { "type": "object", "properties": { "stepAction": { "$ref": "#/components/schemas/stepAction_0fe15a3bc2e510000a1ff95a59a30000", "exampleSetFlag": false }, "questionnaireResponse": { "$ref": "#/components/schemas/questionnaireResponse_3544fcea2784100018ee4320719e0000", "exampleSetFlag": false }, "descriptor": { "type": "string", "description": "The display name of the instance", "example": "Lorem ipsum dolor sit ame", "exampleSetFlag": true, "types": [ "string" ] }, "id": { "type": "string", "description": "The id for Event Record", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] } ] } }, "securitySchemes": { "OAuth2": { "type": "OAUTH2", "flows": { "implicit": { "authorizationUrl": "https://", "scopes": {} } } } }, "extensions": {} } }