Release notesBreaking changes

Operations Manager API changes

Breaking change (2023.2.0)

Changes to Operations Manager APIs

To support performance improvements in Itential Platform, the following changes have been made to the Operations Manager APIs:

  • Calling getJob or getJobs with ?dereference=tasks no longer returns variable data for the dereferenced tasks. Calling with ?dereference=parent no longer returns job variable data for the dereferenced parent job.
  • Calling getTask or getTasks with ?dereference=tasks no longer returns job variable data from the dereferenced job.
  • Calling getJobs or getTasks no longer includes job or task variables in the API response.

What should I do?

Test and confirm all custom applications and adapters are unaffected by these changes. If you encounter any issues, contact the Product Support Team.

Changes to Trigger APIs

The following information is only relevant for customers who create automations and triggers via workflows. Customers who have created automations and trigger documents via Operations Manager are migrated correctly on startup.

As of 2023.2, Automation Triggers and their respective workflows no longer require workflow input to be wrapped in a formData object. When creating a trigger using the createTrigger API, the formData wrapper is no longer used by default.

A new optional property, legacyWrapper, has been added to the createTrigger API:

  • "legacyWrapper": true — The trigger sends its form input wrapped in a formData object.
  • "legacyWrapper": false — The trigger sends its form input directly into the workflow.

If the key is not provided, the value defaults to false.

The 2023.1 createTrigger API schema will also be updated to allow this new property as optional. This has no impact on 2023.1 execution, but allows for proactive migration of workflows that use this API to generate automations and triggers.

What should I do?

Review any existing triggers that use the createTrigger API and verify whether legacyWrapper is set to the appropriate value for how that trigger should send its form input. Contact the Product Support Team if you need additional information or encounter any issues.