Application Package Details REST API

Supported Versions

Below are the versions of the API that support this endpoint.

Overview

This endpoint uses the UUID of an application to retrieve data about any in-flight packages for the application.

• HTTP Request Method: GET
• Endpoint: /applications/<UUID>/packages

You can use this data to:

• Link packages to change management systems.
• Get identifiers for packages to use for a deployment.
• Identify which release a package is associated with.

This endpoint only returns the packages for the single application you specify. Because a release can contain packages from multiple applications, use the release details endpoint when you need all of the packages associated with a release.

Endpoint

While this API is not strictly a deployment API, it is most useful when used with the deployment APIs.

https://<domain>/suite/deployment-management/<v#>/applications/<UUID>/packages

Replace <domain> with your Appian site domain, <v#> with the version of the API compatible with your environment, and replace <UUID> with the UUID of the application.

You can find the application UUID in the application properties.

To use this endpoint to retrieve information from Appian, use a GET request.

Authentication

All requests are authenticated with an API key, which is linked to a service account. This is the same mechanism that Appian uses to secure Web API objects. The service account and API key can be created in the Admin Console.

Once configured, there are multiple ways to use the API key to authenticate your request. For example, you can add it to the HTTP header with the key name:

curl https://<domain>/suite/deployment-management/v3/applications/<UUID>/packages -H "appian-api-key: <API key>"

When the application package endpoint is used to perform an external deployment, any API keys for the Authenticate As service account will automatically grant access to package details for any application on the environment without the service account being added to the rolemap.

If you are not using the Authenticate As service account, the service account specified must have access to the application on the application's rolemap in order to return the package information.

Request parameters

By default, this endpoint returns all of the in-progress packages in the application. You can limit the response to the packages associated with a single release by adding the releaseUuid query parameter to the request URL.

https://<domain>/suite/deployment-management/v3/applications/<UUID>/packages?releaseUuid=<releaseUUID>

You can retrieve release UUIDs using the release details endpoint, or from the releaseUuid attribute of an unfiltered response.

Because this endpoint is specific to a single application, you can only return the packages in that application that are associated with the specific release. To retrieve every package associated with a release across all applications, use the release details endpoint.

Request example

1
GET /applications/d243b14c-3ba5-41c3-9f51-76da51beb8f5/packages

To limit the response to the packages associated with a single release:

1
GET /applications/d243b14c-3ba5-41c3-9f51-76da51beb8f5/packages?releaseUuid=f9c81c58-9e62-414e-9bd2-dfe3f923f362

cURL example

If you’re calling the API from a command line interface, you can use cURL to make a request. For package exports, the cURL command with the above JSON object and its corresponding files looks like:

1
2
3
curl --location --request \
GET https://mysite.appiancloud.com/suite/deployment-management/v3/applications/d243b14c-3ba5-41c3-9f51-76da51beb8f5/packages \
--header 'Authorization: Bearer <access_token>'

To limit the response to the packages associated with a single release, append the releaseUuid query parameter:

1
2
3
curl --location --request \
GET 'https://mysite.appiancloud.com/suite/deployment-management/v3/applications/d243b14c-3ba5-41c3-9f51-76da51beb8f5/packages?releaseUuid=f9c81c58-9e62-414e-9bd2-dfe3f923f362' \
--header 'Authorization: Bearer <access_token>'

Response

Successful response

When a package has no release associated with it, releaseName and releaseUuid are returned as null.

Example response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
{
  "totalPackageCount": 1,
  "packages": [
  {
    "datasourceUuid": "",
    "objectCount": 8,
    "databaseScriptCount": 0,
    "createdTimestamp": "2023-03-13T16: 54: 39.051Z",
    "name": "[VM-18533] Allows Users to Request Multiple Orders",
    "description": "- Update Order Record, - Update related action for Request to accept multiple requests even if one already exists for the record.",
    "pluginCount": 0,
    "hasCustomizationFile": false,
    "uuid": "f9c81c58-9e62-414e-9bd2-ceb2e812e251",
    "ticketLink": "https://issues.acmevehicles.com/browser/VM-18533",
    "lastModifiedTimestamp": "2023-03-13T16: 54: 39.136Z",
    "releaseName": "CRM Release 1.0",
    "releaseUuid": "f9c81c58-9e62-414e-9bd2-dfe3f923f362"
    }
  ]
}

Feedback