Breaking Change Notice
The following is a breaking change in Workflow Engine (WFE) for the 2023.2 release.
Itential policy is to notify customers of deprecations two (2) release cycles in advance (at a minimum) before the API is removed.
APIs Removed Due to Scheduled Deprecation
Below is a list of WFE APIs removed from Itential Platform in the 2023.2 release.
| API | Description | Deprecation Release | Removal Release | Replacement Method Name | Route |
|---|---|---|---|---|---|
| checkWorkflowForJobVariables | Get job variables from a workflow by workflow name. | 2022.1 | 2023.2 | getWorkflowDetailedByName | Use inputSchema from GET /automation-studio/workflows/detailed/:name |
| getTaskDetails | Get a detailed information model for a task. | 2022.1 | 2023.2 | getTaskDetails | GET /automation-studio/locations/:location/packages/:pckg/tasks/:method |
| getWorkflowDetailedByName | Get the details of a workflow by workflow name. | 2022.1 | 2023.2 | getWorkflowDetailedByName | GET /automation-studio/workflows/detailed/:name |
| runValidation | Validate a workflow and return errors and warnings. | 2022.1 | 2023.2 | validateWorkflow | POST /automation-studio/workflows/validate |
| searchWorkflows | Search workflows. | 2022.1 | 2023.2 | getWorkflows | GET /automation-studio/workflows |
What should I do?
Review any custom apps and adapters that might reference any APIs on the list and change them to the replacement call (or remove them if no replacement call is provided).