Management

Start a Planned Lifecycle Operation

Changed on

Starts the pending plan named by planId, whatever its operation (install, upgrade or uninstall). Get the plan from POST /installation/plan. The plan is made again from the current state before it starts, and the attempt records how it differs from the reviewed plan in review.

post/installation

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /installation
  • Auth: OAuth 2 (client credentials, token URL https://ims-na1.adobelogin.com/ims/token/v3, scopes: AdobeID, openid)

Headers

x-gw-ims-org-idstring required

Adobe IMS organization ID that identifies the organization for the request.

x-aio-commerce-installation-invocation-source'post-app-deploy'

Identifies the source of the request. The generated post-deploy hook sends post-app-deploy; when that source is present and the app is not installed, reconciliation returns 409 not-installed instead of starting a first-time installation.

Request body

ioEventsUrlstring required
ioEventsEnvstring required
operation'uninstall'

Set to uninstall to plan an uninstallation. Without it, POST /installation/plan plans the install or upgrade the installed state calls for.

planIdstring

The id of the pending plan to start. Required by POST /installation.

Response

The plan started. Poll GET /installation for its status.

idstring required
previousAttemptIdstring nullable required

The attempt this one replaced as the latest, or null for the first attempt.

planIdstring required

The plan the attempt executed.

previousPlanIdstring nullable required

The pending plan the executed plan replaced, or null when none was pending.

operation'install' | 'upgrade' | 'uninstall' required
status'pending' | 'in-progress' | 'succeeded' | 'failed' required
startedAtstring date-time required
completedAtstring date-time

Present once the attempt succeeded or failed.

dataobject nullable required
reviewobject

How the started plan differs from the reviewed one. Present when the attempt started from a reviewed plan.

messagestring required
activationIdstring required

The activation id of the background execution.

Changes

  • 759439d755adRevision changes
    • info

      added the optional property //// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

  • 670d2ef21b7dRevision changes
    • breaking

      removed the success response with the status

    • warning

      removed the request property

    • warning

      removed the request property

    • info

      api operation id reconcileInstallation removed and replaced with startLifecyclePlan

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added subschema #2 to the response body allOf list for the response status

    • info

      removed subschema #1 subschema #2 from the response body oneOf list for the response status

    • info

      added the optional property to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      removed the already-current enum value from the response property for the response status

    • info

      removed the not-associated enum value from the response property for the response status

    • info

      removed the not-installed enum value from the response property for the response status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status