Every API here is available over the APIs.io API and to AI agents over MCP.
openapi: 3.2.0
info:
title: Changelog for businessProcess 06/15/2024 API
description: The public APIs to access event actions and details
version: v1
servers:
- url: https://<tenantHostname>/businessProcess/v1
tags:
- name: 06/15/2024
description: Changes for v2024.24
paths:
2024.24/types:
get:
tags:
- 06/15/2024
summary: Modified this existing endpoint
description: '## Description changed
|
Updated Value
|
Previous Value
|
| :--- | :--- |
|
Retrieves a collection of business process types.
Secured by: Public Business Processes
Scope: Tenant Non-Configurable
|
Retrieves a collection of business process types.
|
## Security changed
|
Updated Value
|
| :--- |
|
|
|
Added Domains
|
Removed Domains
|
| :--- | :--- |
|
None
|
Public Business Processes
|
## Scope changed
|
Updated Value
|
| :--- |
|
|
|
Added Domains
|
Removed Domains
|
| :--- | :--- |
|
None
|
Tenant Non-Configurable
|
View this Endpoint: GET /types'
operationId: get202424Types
x-operation-id-source: derived
2024.24/types/{ID}:
get:
tags:
- 06/15/2024
summary: Modified this existing endpoint
description: '## Description changed
|
Updated Value
|
Previous Value
|
| :--- | :--- |
|
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.
|
## Security changed
|
Updated Value
|
| :--- |
|
|
|
Added Domains
|
Removed Domains
|
| :--- | :--- |
|
None
|
Public Business Processes
|
## Scope changed
|
Updated Value
|
| :--- |
|
|
|
Added Domains
|
Removed Domains
|
| :--- | :--- |
|
None
|
Tenant Non-Configurable
|
View this Endpoint: GET /types/{ID}'
operationId: get202424TypesByID
x-operation-id-source: derived
2024.24/types/{ID}/attachmentCategories:
get:
tags:
- 06/15/2024
summary: Modified this existing endpoint
description: '## Description changed
|
Updated Value
|
Previous Value
|
| :--- | :--- |
|
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.
|
## Security changed
|
Updated Value
|
| :--- |
|
|
|
Added Domains
|
Removed Domains
|
| :--- | :--- |
|
None
|
Core Navigation
|
|
|
Public Business Processes
|
## Scope changed
|
Updated Value
|
| :--- |
|
|
|
Added Domains
|
Removed Domains
|
| :--- | :--- |
|
None
|
Adaptive Planning For Financial Plans
|
|
|
Adaptive Planning For The Workforce
|
|
|
Tenant Non-Configurable
|
View this Endpoint: GET /types/{ID}/attachmentCategories'
operationId: get202424TypesByIDAttachmentCategories
x-operation-id-source: derived
2024.24/eventSteps/{ID}/toDo:
post:
tags:
- 06/15/2024
summary: Modified this existing endpoint
description: '## Description changed
|
Updated Value
|
Previous Value
|
| :--- | :--- |
|
Post an action for a To Do step in a business process.
Specify these required fields in the request body: {stepAction}.
You can add an optional comment, if enabled at tenant or business process level.
Valid values for stepAction are:
{ "id": "133d5c88baa64136aab041c1d2e9ed53" } for Submit,
{ "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.
Specify these required fields in the request body: {stepAction}.
You can add an optional comment, if enabled at tenant or business process level.
Valid values for stepAction are:
{ "id": "133d5c88baa64136aab041c1d2e9ed53" } for Submit,
{ "id": "d9e41d34446c11de98360015c5e6daf6" } for Save for Later.
|
## Security changed
|
Updated Value
|
| :--- |
|
|
|
Added Domains
|
Removed Domains
|
| :--- | :--- |
|
None
|
Core Navigation
|
|
|
Public Business Processes
|
## Scope changed
|
Updated Value
|
| :--- |
|
|
|
Added Domains
|
Removed Domains
|
| :--- | :--- |
|
None
|
Adaptive Planning For Financial Plans
|
|
|
Adaptive Planning For The Workforce
|
|
|
Tenant Non-Configurable
|
View this Endpoint: POST /eventSteps/{ID}/toDo'
operationId: post202424EventStepsByIDToDo
x-operation-id-source: derived
2024.24/events:
get:
tags:
- 06/15/2024
summary: Modified this existing endpoint
description: '## Description changed
|
Updated Value
|
Previous Value
|
| :--- | :--- |
|
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.
|
## Security changed
|
Updated Value
|
| :--- |
|
|
|
Added Domains
|
Removed Domains
|
| :--- | :--- |
|
None
|
Core Navigation
|
|
|
Public Business Processes
|
## Scope changed
|
Updated Value
|
| :--- |
|
|
|
Added Domains
|
Removed Domains
|
| :--- | :--- |
|
None
|
Adaptive Planning For Financial Plans
|
|
|
Adaptive Planning For The Workforce
|
|
|
Tenant Non-Configurable
|
View this Endpoint: GET /events'
operationId: get202424Events
x-operation-id-source: derived
2024.24/events/{ID}/attachments:
get:
tags:
- 06/15/2024
summary: Modified this existing endpoint
description: '## Description changed
|
Updated Value
|
Previous Value
|
| :--- | :--- |
|
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.
|
## Security changed
|
Updated Value
|
| :--- |
|
|
|
Added Domains
|
Removed Domains
|
| :--- | :--- |
|
None
|
Core Navigation
|
|
|
Public Business Processes
|
## Scope changed
|
Updated Value
|
| :--- |
|
|
|
Added Domains
|
Removed Domains
|
| :--- | :--- |
|
None
|
Adaptive Planning For Financial Plans
|
|
|
Adaptive Planning For The Workforce
|
|
|
Tenant Non-Configurable
|
View this Endpoint: GET /events/{ID}/attachments'
operationId: get202424EventsByIDAttachments
x-operation-id-source: derived
2024.24/events/{ID}/comments:
get:
tags:
- 06/15/2024
summary: Modified this existing endpoint
description: '## Description changed
|
Updated Value
|
Previous Value
|
| :--- | :--- |
|
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.
|
## Security changed
|
Updated Value
|
| :--- |
|
|
|
Added Domains
|
Removed Domains
|
| :--- | :--- |
|
None
|
Core Navigation
|
|
|
Public Business Processes
|
## Scope changed
|
Updated Value
|
| :--- |
|
|
|
Added Domains
|
Removed Domains
|
| :--- | :--- |
|
None
|
Adaptive Planning For Financial Plans
|
|
|
Adaptive Planning For The Workforce
|
|
|
Tenant Non-Configurable
|
View this Endpoint: GET /events/{ID}/comments'
operationId: get202424EventsByIDComments
x-operation-id-source: derived
2024.24/events/{ID}/inProgressSteps:
get:
tags:
- 06/15/2024
summary: Modified this existing endpoint
description: '## Description changed
|
Updated Value
|
Previous Value
|
| :--- | :--- |
|
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.
|
## Security changed
|
Updated Value
|
| :--- |
|
|
|
Added Domains
|
Removed Domains
|
| :--- | :--- |
|
None
|
Core Navigation
|
|
|
Public Business Processes
|
## Scope changed
|
Updated Value
|
| :--- |
|
|
|
Added Domains
|
Removed Domains
|
| :--- | :--- |
|
None
|
Adaptive Planning For Financial Plans
|
|
|
Adaptive Planning For The Workforce
|
|
|
Tenant Non-Configurable
|
View this Endpoint: GET /events/{ID}/inProgressSteps'
operationId: get202424EventsByIDInProgressSteps
x-operation-id-source: derived
2024.24/eventSteps/{ID}/deny:
post:
tags:
- 06/15/2024
summary: Modified this existing endpoint
description: '## Description changed
|
Updated Value
|
Previous Value
|
| :--- | :--- |
|
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.
|
## Security changed
|
Updated Value
|
| :--- |
|
|
|
Added Domains
|
Removed Domains
|
| :--- | :--- |
|
None
|
Core Navigation
|
|
|
Public Business Processes
|
## Scope changed
|
Updated Value
|
| :--- |
|
|
|
Added Domains
|
Removed Domains
|
| :--- | :--- |
|
None
|
Adaptive Planning For Financial Plans
|
|
|
Adaptive Planning For The Workforce
|
|
|
Tenant Non-Configurable
|
View this Endpoint: POST /eventSteps/{ID}/deny'
operationId: post202424EventStepsByIDDeny
x-operation-id-source: derived
2024.24/events/{ID}/remainingSteps:
get:
tags:
- 06/15/2024
summary: Modified this existing endpoint
description: '## Description changed
|
Updated Value
|
Previous Value
|
| :--- | :--- |
|
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.
|
## Security changed
|
Updated Value
|
| :--- |
|
|
|
Added Domains
|
Removed Domains
|
| :--- | :--- |
|
None
|
Core Navigation
|
|
|
Public Business Processes
|
## Scope changed
|
Updated Value
|
| :--- |
|
|
|
Added Domains
|
Removed Domains
|
| :--- | :--- |
|
None
|
Adaptive Planning For Financial Plans
|
|
|
Adaptive Planning For The Workforce
|
|
|
Tenant Non-Configurable
|
View this Endpoint: GET /events/{ID}/remainingSteps'
operationId: get202424EventsByIDRemainingSteps
x-operation-id-source: derived
2024.24/events/{ID}:
get:
tags:
- 06/15/2024
summary: Modified this existing endpoint
description: '## Description changed
|
Updated Value
|
Previous Value
|
| :--- | :--- |
|
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.
|
## Security changed
|
Updated Value
|
| :--- |
|
|
|
Added Domains
|
Removed Domains
|
| :--- | :--- |
|
None
|
Core Navigation
|
|
|
Public Business Processes
|
## Scope changed
|
Updated Value
|
| :--- |
|
|
|
Added Domains
|
Removed Domains
|
| :--- | :--- |
|
None
|
Adaptive Planning For Financial Plans
|
|
|
Adaptive Planning For The Workforce
|
|
|
Tenant Non-Configurable
|
View this Endpoint: GET /events/{ID}'
operationId: get202424EventsByID
x-operation-id-source: derived
2024.24/eventSteps/{ID}/approve:
post:
tags:
- 06/15/2024
summary: Modified this existing endpoint
description: '## Description changed
|
Updated Value
|
Previous Value
|
| :--- | :--- |
|
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.
|
## Security changed
|
Updated Value
|
| :--- |
|
|
|
Added Domains
|
Removed Domains
|
| :--- | :--- |
|
None
|
Core Navigation
|
|
|
Public Business Processes
|
## Scope changed
|
Updated Value
|
| :--- |
|
|
|
Added Domains
|
Removed Domains
|
| :--- | :--- |
|
None
|
Adaptive Planning For Financial Plans
|
|
|
Adaptive Planning For The Workforce
|
|
|
Tenant Non-Configurable
|
View this Endpoint: POST /eventSteps/{ID}/approve'
operationId: post202424EventStepsByIDApprove
x-operation-id-source: derived
2024.24/eventSteps/{ID}/sendBack:
post:
tags:
- 06/15/2024
summary: Modified this existing endpoint
description: '## Description changed
|
Updated Value
|
Previous Value
|
| :--- | :--- |
|
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.
|
## Security changed
|
Updated Value
|
| :--- |
|
|
|
Added Domains
|
Removed Domains
|
| :--- | :--- |
|
None
|
Core Navigation
|
|
|
Public Business Processes
|
## Scope changed
|
Updated Value
|
| :--- |
|
|
|
Added Domains
|
Removed Domains
|
| :--- | :--- |
|
None
|
Adaptive Planning For Financial Plans
|
|
|
Adaptive Planning For The Workforce
|
|
|
Tenant Non-Configurable
|
View this Endpoint: POST /eventSteps/{ID}/sendBack'
operationId: post202424EventStepsByIDSendBack
x-operation-id-source: derived
2024.24/eventSteps:
get:
tags:
- 06/15/2024
summary: Modified this existing endpoint
description: '## Description changed
|
Updated Value
|
Previous Value
|
| :--- | :--- |
|
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.
|
## Security changed
|
Updated Value
|
| :--- |
|
|
|
Added Domains
|
Removed Domains
|
| :--- | :--- |
|
None
|
Core Navigation
|
|
|
Public Business Processes
|
## Scope changed
|
Updated Value
|
| :--- |
|
|
|
Added Domains
|
Removed Domains
|
| :--- | :--- |
|
None
|
Adaptive Planning For Financial Plans
|
|
|
Adaptive Planning For The Workforce
|
|
|
Tenant Non-Configurable
|
View this Endpoint: GET /eventSteps'
operationId: get202424EventSteps
x-operation-id-source: derived
2024.24/events/{ID}/completedSteps:
get:
tags:
- 06/15/2024
summary: Modified this existing endpoint
description: '## Description changed
|
Updated Value
|
Previous Value
|
| :--- | :--- |
|
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.
|
## Security changed
|
Updated Value
|
| :--- |
|
|
|
Added Domains
|
Removed Domains
|
| :--- | :--- |
|
None
|
Core Navigation
|
|
|
Public Business Processes
|
## Scope changed
|
Updated Value
|
| :--- |
|
|
|
Added Domains
|
Removed Domains
|
| :--- | :--- |
|
None
|
Adaptive Planning For Financial Plans
|
|
|
Adaptive Planning For The Workforce
|
|
|
Tenant Non-Configurable
|
View this Endpoint: GET /events/{ID}/completedSteps'
operationId: get202424EventsByIDCompletedSteps
x-operation-id-source: derived
2024.24/eventSteps/{ID}:
get:
tags:
- 06/15/2024
summary: Modified this existing endpoint
description: '## Description changed
|
Updated Value
|
Previous Value
|
| :--- | :--- |
|
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.
|
## Security changed
|
Updated Value
|
| :--- |
|
|
|
Added Domains
|
Removed Domains
|
| :--- | :--- |
|
None
|
Core Navigation
|
|
|
Public Business Processes
|
## Scope changed
|
Updated Value
|
| :--- |
|
|
|
Added Domains
|
Removed Domains
|
| :--- | :--- |
|
None
|
Adaptive Planning For Financial Plans
|
|
|
Adaptive Planning For The Workforce
|
|
|
Tenant Non-Configurable
|
View this Endpoint: GET /eventSteps/{ID}'
operationId: get202424EventStepsByID
x-operation-id-source: derived
2024.24/eventSteps/{ID}/questionnaire:
post:
tags:
- 06/15/2024
summary: Modified this existing endpoint
description: '## Description changed
|
Updated Value
|
Previous Value
|
| :--- | :--- |
|
Post an action for a Complete Questionnaire step in a business process.
Specify these required fields in the request body if the intended action is Submit or Save for Later: {stepAction, questionnaireResponse}.
You can send Save for Later multiple times, but {questionnaireResponse} values will replace the existing questionnaire answers.
If the intended action is Skip, exclude {questionnaireResponse} from the request body.
Valid values for stepAction are:
{ "id": "133d5c88baa64136aab041c1d2e9ed53" } for Submit,
{ "id": "d9e41a8c446c11de98360015c5e6daf6" } for Save for Later,
{ "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.
Specify these required fields in the request body if the intended action is Submit or Save for Later: {stepAction, questionnaireResponse}.
You can send Save for Later multiple times, but {questionnaireResponse} values will replace the existing questionnaire answers.
If the intended action is Skip, exclude {questionnaireResponse} from the request body.
Valid values for stepAction are:
{ "id": "133d5c88baa64136aab041c1d2e9ed53" } for Submit,
{ "id": "d9e41a8c446c11de98360015c5e6daf6" } for Save for Later,
{ "id": "d9e4231a446c11de98360015c5e6daf6" } for Skip.
|
## Security changed
|
Updated Value
|
| :--- |
|
|
|
Added Domains
|
Removed Domains
|
| :--- | :--- |
|
None
|
Core Navigation
|
|
|
Public Business Processes
|
## Scope changed
|
Updated Value
|
| :--- |
|
|
|
Added Domains
|
Removed Domains
|
| :--- | :--- |
|
None
|
Adaptive Planning For Financial Plans
|
|
|
Adaptive Planning For The Workforce
|
|
|
Tenant Non-Configurable
|
View this Endpoint: POST /eventSteps/{ID}/questionnaire'
operationId: post202424EventStepsByIDQuestionnaire
x-operation-id-source: derived
components:
securitySchemes:
OAuth2:
type: OAUTH2
flows:
implicit:
authorizationUrl: https://<tenantAuthorizationHostname>
scopes: {}