Free cookie consent management tool by TermsFeed Deployment API - Get Deployment Results [Deployment APIs]
Deployment API - Get Deployment Results

Overview

This endpoint retrieves information about a deployment on an Appian environment, given the UUID of the deployment.

  • HTTP Request Method: GET
  • Endpoint: /deployments/<uuid>

Request

When performing a GET request, you do not need a request body. However, you do need to specify the UUID of the deployment that you are querying for. This is done by adding a path parameter to the end of the URL, such as: https://<domain>/suite/deployment-management/v1/deployments/<UUID>

Request example

Request

1

GET /deployments/<uuid>

cURL example

When calling the API from a command line interface, you can use cURL to make a request. The cURL command with the deployment UUID looks like:

1
2
3

curl --location --request
GET 'https://mysite.appiancloud.com/suite/deployment-management/v1/deployments/d243b14c-3ba5-41c3-9f51-76da51beb8f5/' \
--header 'Appian-API-Key: <API key>'

Response

Successful response

Attribute Value
summary Overview of the number of database scripts and objects that were deployed.
summary.databaseScripts The total number of database scripts included in the original deployment request.
summary.plugins Overview of deployment results for the plug-ins included in the original deployment request.

If there are any errors deploying plug-ins, all plug-ins are skipped and/or reverted and the status of the deployment is FAILED. A summary is only present if plug-ins successfully deploy.
summary.plugins.total The total number of plug-ins in the package.
summary.plugins.imported The number of plug-ins in the package that successfully imported.
summary.plugins.skipped The number of plug-ins in the package that were skipped because there were no changes.
summary.objects Overview of deployment results for the objects included in the original deployment request, as part of the package (.zip).
summary.objects.total The total number of objects in the package.
summary.objects.imported The number of objects in the package that successfully imported.
summary.objects.failed The number of objects in the package that failed to import due to problems.
summary.objects.skipped The number of objects in the package that were skipped because there were no changes.
summary.adminConsoleSettings.total The total number of Admin Console settings included.
summary.adminConsoleSettings.imported The number of Admin Console settings that were successfully imported.
summary.adminConsoleSettings.failed The number of Admin Console settings that failed to import due to problems.
summary.adminConsoleSettings.skipped The number of Admin Console settings that were skipped because there were no changes.
summary.deploymentLogUrl The URL to use to retrieve the deployment log of this deployment.

If the status of the deployment is FAILED the deploymentUrl is still accessible as a top-level attribute rather than nested in the "summary".
status Status of the deployment. These correspond to the statuses that appear on the Deploy view in Appian Designer.

Possible statuses: IN_PROGRESS, COMPLETED, COMPLETED_WITH_IMPORT_ERRORS, COMPLETED_WITH_PUBLISH_ERRORS, FAILED, PENDING_REVIEW, or REJECTED.

Response example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

{
    "summary": {
        "databaseScripts": 0,
        "adminConsoleSettings": {
            "total": 7,
            "imported": 6,
            "failed": 0,
            "skipped": 1
        },
        "plugins": {
            "total": 3,
            "imported": 3,
            "skipped": 0
        },
        "objects": {
            "total": 22,
            "imported": 22,
            "failed": 0,
            "skipped": 0
        },
        "deploymentLogUrl": "https://mysite.appiancloud.com/suite/deployment-management/v1/deployments/d243b14c-3ba5-41c3-9f51-76da51beb8f5/log/"
    },
    "status": "COMPLETED"
}
Open in Github Built: Wed, May 15, 2024 (09:12:13 PM)

Deployment API - Get Deployment Results

FEEDBACK