Appian · JSON Structure

Deployment Rest Deployment Response Structure

Response returned when a deployment operation is successfully initiated. Contains the UUID for tracking the deployment and its current status.

Type: object Properties: 3 Required: 3
AutomationBPMBusiness Process ManagementEnterprise SoftwareLow-CodeProcess AutomationRPAWorkflow

DeploymentResponse is a JSON Structure definition published by Appian, describing 3 properties, of which 3 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

uuid url status

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/appian/refs/heads/main/json-structure/deployment-rest-deployment-response-structure.json",
  "name": "DeploymentResponse",
  "description": "Response returned when a deployment operation is successfully initiated. Contains the UUID for tracking the deployment and its current status.",
  "type": "object",
  "properties": {
    "uuid": {
      "description": "Unique identifier for the deployment operation. Use this UUID to retrieve deployment results and logs.",
      "example": "d243b14c-3ba5-41c3-9f51-76da51beb8f5",
      "type": "string"
    },
    "url": {
      "description": "URL endpoint for retrieving the deployment details and results.",
      "example": "https://mysite.appiancloud.com/suite/deployment-management/v2/deployments/d243b14c-3ba5-41c3-9f51-76da51beb8f5/",
      "type": "uri"
    },
    "status": {
      "$ref": "#/components/schemas/DeploymentStatus",
      "type": null
    }
  },
  "required": [
    "uuid",
    "url",
    "status"
  ]
}