Appian · JSON Structure

Deployment Rest Import Configuration Structure

Configuration for an import deployment operation specifying the files and settings to deploy.

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

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

Properties

name description packageFileName adminConsoleSettingsFileName customizationFileName pluginsFileName dataSource databaseScripts

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-import-configuration-structure.json",
  "name": "ImportConfiguration",
  "description": "Configuration for an import deployment operation specifying the files and settings to deploy.",
  "type": "object",
  "properties": {
    "name": {
      "description": "Name of the deployment, displayed in Appian Designer's Deploy view.",
      "example": "Q4 Release Package",
      "type": "string"
    },
    "description": {
      "description": "Description of the deployment.",
      "type": "string"
    },
    "packageFileName": {
      "description": "File name of the deployment package ZIP file attached in the form data.",
      "type": "string"
    },
    "adminConsoleSettingsFileName": {
      "description": "File name of the Admin Console settings ZIP file attached in the form data.",
      "type": "string"
    },
    "customizationFileName": {
      "description": "File name of the import customization properties file attached in the form data.",
      "type": "string"
    },
    "pluginsFileName": {
      "description": "File name of the plug-ins ZIP file attached in the form data.",
      "type": "string"
    },
    "dataSource": {
      "description": "The data source name or UUID for database script execution.",
      "type": "string"
    },
    "databaseScripts": {
      "description": "Array of database script configurations specifying file names and execution order.",
      "items": {
        "type": "object",
        "properties": {
          "fileName": {
            "type": "string",
            "description": "The file name of the database script."
          },
          "orderId": {
            "type": "string",
            "description": "The execution order for the script, starting at 1."
          }
        }
      },
      "type": "array"
    }
  },
  "required": [
    "name"
  ]
}