Operations Manager API Changes

Breaking Change [2023.2.0]

This breaking change notice applies to the 2023.2 Itential Platform (IP) release.

Changes to Operations Manager APIs

To support performance improvement in the Itential Platform, a small number of changes were made to the Operations (Ops) Manager APIs:

• When calling getJob or getJobs with ?dereference=tasks Itential Platform will no longer provide variable data for the dereferenced tasks, and when using ?dereference=parent Itential Platform will no longer provide job variable data for the dereferenced parent job.
  
  
• When calling getTask or getTasks with ?dereference=tasks Itential Platform will no longer provide job variable data from the dereferenced job.
  
  
• When calling getJobs or getTasks, the job or task variables will no longer be included in the API response.

What should I do?

Please test and confirm all custom applications and adapters are unaffected by these changes. If you encounter any issues, please contact the Product Support Team for assistance.

Changes to Trigger APIs

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

A new, optional, property called legacyWrapper has been added to the createTrigger API which allows full control of this behavior:

• "legacyWrapper": true - This trigger property will send its form input wrapped in a formData object.
   
• "legacyWrapper": false - This trigger property will send its form input directly into the workflow.

If the key is not provided, the value is assumed to be false.

Additionally, Itential will be updating the 2023.1 createTrigger API schema to allow this new property as optional. This will have no impact on 23.1 execution; however it allows for proactive migration of workflows that use this API to generate automations and triggers.

What should I do?

Please review any existing triggers that utilize the createTrigger API and check if the legacyWrapper is set to the appropriate true/false value for how the trigger property should send its form input. If you need additional information or encounter any issues, please contact the Product Support Team for assistance.