Appian · Schema

Package

Represents an in-flight deployment package associated with an Appian application. Contains metadata about the package contents and status.

AutomationBPMBusiness Process ManagementEnterprise SoftwareLow-CodeProcess AutomationRPAWorkflow

Properties

Name	Type	Description
name	string	The name of the deployment package.
description	string	A description of the deployment package.
uuid	string	The unique identifier for the package. This UUID can be used with the Deployment REST API for exports and deployments.
objectCount	integer	The number of design objects included in the package.
databaseScriptCount	integer	The number of database scripts included in the package.
pluginCount	integer	The number of plug-ins included in the package.
datasourceUuid	string	The UUID of the data source associated with the package, if applicable.
hasCustomizationFile	boolean	Indicates whether the package includes an import customization file.
createdTimestamp	string	The timestamp when the package was created.
lastModifiedTimestamp	string	The timestamp when the package was last modified. Packages are sorted by this field in descending order.
ticketLink	string	A link to an external ticket or change request associated with this package.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/appian/refs/heads/main/json-schema/application-package-details-package-schema.json",
  "title": "Package",
  "description": "Represents an in-flight deployment package associated with an Appian application. Contains metadata about the package contents and status.",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the deployment package.",
      "example": "CR-176543 Add reports dashboard"
    },
    "description": {
      "type": "string",
      "description": "A description of the deployment package.",
      "example": "Updates the executive summary view with new reports."
    },
    "uuid": {
      "type": "string",
      "format": "uuid",
      "description": "The unique identifier for the package. This UUID can be used with the Deployment REST API for exports and deployments.",
      "example": "d243b14c-3ba5-41c3-9f51-76da51beb8f5"
    },
    "objectCount": {
      "type": "integer",
      "description": "The number of design objects included in the package.",
      "minimum": 0,
      "example": 12
    },
    "databaseScriptCount": {
      "type": "integer",
      "description": "The number of database scripts included in the package.",
      "minimum": 0,
      "example": 2
    },
    "pluginCount": {
      "type": "integer",
      "description": "The number of plug-ins included in the package.",
      "minimum": 0,
      "example": 1
    },
    "datasourceUuid": {
      "type": "string",
      "format": "uuid",
      "description": "The UUID of the data source associated with the package, if applicable."
    },
    "hasCustomizationFile": {
      "type": "boolean",
      "description": "Indicates whether the package includes an import customization file.",
      "example": true
    },
    "createdTimestamp": {
      "type": "string",
      "format": "date-time",
      "description": "The timestamp when the package was created."
    },
    "lastModifiedTimestamp": {
      "type": "string",
      "format": "date-time",
      "description": "The timestamp when the package was last modified. Packages are sorted by this field in descending order."
    },
    "ticketLink": {
      "type": "string",
      "description": "A link to an external ticket or change request associated with this package.",
      "example": "https://jira.example.com/browse/CR-176543"
    }
  },
  "required": [
    "name",
    "uuid"
  ]
}