Appian · JSON Structure

Deployment Rest Export Configuration Structure

Configuration for an export deployment operation specifying what to export and how.

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

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

Properties

exportType uuids name description

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-export-configuration-structure.json",
  "name": "ExportConfiguration",
  "description": "Configuration for an export deployment operation specifying what to export and how.",
  "type": "object",
  "properties": {
    "exportType": {
      "description": "Specifies the kind of export being performed. Use package for a single package or application for one or more applications.",
      "enum": [
        "package",
        "application"
      ],
      "type": "string"
    },
    "uuids": {
      "description": "Array of UUIDs to export. For packages, provide a single UUID. For applications, provide one or more application UUIDs.",
      "items": {
        "type": "string",
        "format": "uuid"
      },
      "minItems": 1,
      "type": "array"
    },
    "name": {
      "description": "Custom name for the deployment. If omitted, a name is auto-generated.",
      "example": "CR-176543 Add reports dashboard",
      "type": "string"
    },
    "description": {
      "description": "Description of the deployment, displayed in Appian Designer.",
      "example": "Updates the executive summary view.",
      "type": "string"
    }
  },
  "required": [
    "exportType",
    "uuids"
  ]
}