Appian · Schema

DeploymentRequest

Request body for creating a deployment operation. For exports, provide the JSON configuration with export type and UUIDs. For imports, provide package files along with the JSON configuration.

AutomationBPMBusiness Process ManagementEnterprise SoftwareLow-CodeProcess AutomationRPAWorkflow

Properties

Name	Type	Description
json	string	JSON string containing the deployment configuration. For exports, includes exportType and uuids. For imports, includes name, description, and file name references.
packageFileName	string	The deployment package ZIP file to import. Required for import operations.
adminConsoleSettingsFileName	string	Admin Console settings ZIP file to import alongside the package.
customizationFileName	string	Import customization properties file that maps source environment values to target environment values.
pluginsFileName	string	Plug-ins ZIP file containing plug-ins to deploy.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/DeploymentRequest",
  "title": "DeploymentRequest",
  "type": "object",
  "description": "Request body for creating a deployment operation. For exports, provide the JSON configuration with export type and UUIDs. For imports, provide package files along with the JSON configuration.",
  "properties": {
    "json": {
      "type": "string",
      "description": "JSON string containing the deployment configuration. For exports, includes exportType and uuids. For imports, includes name, description, and file name references."
    },
    "packageFileName": {
      "type": "string",
      "format": "binary",
      "description": "The deployment package ZIP file to import. Required for import operations."
    },
    "adminConsoleSettingsFileName": {
      "type": "string",
      "format": "binary",
      "description": "Admin Console settings ZIP file to import alongside the package."
    },
    "customizationFileName": {
      "type": "string",
      "format": "binary",
      "description": "Import customization properties file that maps source environment values to target environment values."
    },
    "pluginsFileName": {
      "type": "string",
      "format": "binary",
      "description": "Plug-ins ZIP file containing plug-ins to deploy."
    }
  }
}