Admin Essentials
  • Dark
    Light
  • PDF

Admin Essentials

  • Dark
    Light
  • PDF

BREAKING CHANGE for 2021.2

The following are breaking changes for the 2021.2 release.

API Changes for Pre-built Automations

Overall, multiple changes have been made to the Pre-built Automation APIs in an effort to give users the ability to overwrite Pre-built Automations when the Pre-builts are installed or imported into an Itential Automation Platform (IAP) environment. In order to accomplish this functionality change, some breaking changes have been introduced to several of these Pre-built APIs which has been explained further below.

POST /prebuilts/import

The main breaking change for the importPrebuilt API is the introduction of the optional parameter overwrite. Now when making a request to POST /prebuilts/import the request body should be as follows:

{
  "prebuilt": { ... },
  "options": {
    "overwrite": true or false
  }
}

This functionality now allows a user to specify if they would like to "overwrite" any existing Pre-built component documents already on the system.

For example, let's say there is a Pre-built Automation that contains a workflow document (Workflow A) and this workflow document already exists in the current IAP environment. If the user chooses to import the Pre-built with overwrite = false, then the import process will fail saying a workflow document (Workflow A) already exists in your IAP environment. If the user chooses to import the Pre-built with overwrite = true the import process will continue and the incoming workflow document will be processed and used to replace the existing workflow document that is in the IAP environment.

Additional breaking changes to the importPrebuilt API are the improvement to the error handling. The error responses of the API are much more verbose and compartmentalized. This means that the import process will capture errors from each component and handle it separately as if it was an independent process. This allows the user to better understand which aspects of the Pre-built contributed to a failed import.

DELETE /prebuilts/:id

The only change to the deletePrebuilt API is the process will only remove the Pre-built document from the IAP environment. Any referenced component within the Pre-built (i.e. workflows, json-forms, transformations, etc.) will not be removed and remain on the system.

What should I do?

Review any custom apps and adapters that might reference any APIs mentioned above and change them accordingly; otherwise, please use this newly revamped system as we believe the experience is better than the previous one.

BREAKING CHANGE for 2021.1 → 2021.2

The following are breaking changes for the 2021.2 release.

API removal due to scheduled deprecations

The table below shows a list of APIs that have been removed from IAP. Our policy is to provide a deprecation notice two (2) release cycles in advance (at a minimum) before the API is removed. This list represents all deprecations announced at the latest in the 2020.2 release.

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).

Removed APIs

Item Description Deprecation Release Actual Removal Release Replacement
GET /admin/artifacts/available Get available artifacts/prebuilts from the Itential git repository. 2020.2 2021.2 GET /prebuilts-repository
GET /admin/artifacts/export/:id Exports an artifact/prebuilt. 2020.2 2021.2 GET /prebuilts/:id/export
GET /admin/artifacts/:id Gets an artifact/prebuilt. 2020.2 2021.2 GET /prebuilts/:id
GET /admin/artifacts Gets all artifacts/prebuilts installed. 2020.2 2021.2 GET /prebuilts
POST /admin/artifacts/import Imports an artifact/prebuilt. 2020.2 2021.2 POST /prebuilts/import
POST /admin/artifacts Installs an artifact. 2020.2 2021.2 Method removed; no longer necessary with new methods such as POST /prebuilts/import.
DELETE /admin/artifacts/:id Removes an artifact/prebuilt from the IAP system. 2020.2 2021.2 DELETE /prebuilts/:id
PUT /admin/artifacts/:id Updates an artifact/prebuilt. 2020.2 2021.2 PUT /prebuilts/:id