generated: '2026-10-03'
method: derived
generator: derive-data-model.py
source:
- openapi/appian-export-api-openapi.yml
- openapi/appian-import-api-openapi.yml
- openapi/appian-inspection-api-openapi.yml
- openapi/appian-packages-api-openapi.yml
- openapi/appian-results-api-openapi.yml
notation: has_one = property $ref; has_many = array of $ref; belongs_to = <entity>_id field
summary:
  entities: 14
  entities_in_spec: 14
  relationships: 4
entities:
- name: DatabaseScript
  fields: 3
  description: Represents a database script included in an export or import deployment.
- name: DeploymentRequest
  fields: 5
  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.
- name: DeploymentResponse
  fields: 3
  description: Response returned when a deployment operation is successfully initiated. Contains the UUID for tracking
    the deployment and its current status.
- name: ExportDeploymentResult
  fields: 8
  description: Result of an export deployment operation, including URLs to download the exported artifacts such
    as packages, plug-ins, customization files, and database scripts.
- name: ImportDeploymentResult
  fields: 2
  description: Result of an import deployment operation, including a summary of imported, failed, and skipped objects,
    Admin Console settings, plug-ins, and database scripts.
- name: ImportSummaryCount
  fields: 4
  description: Summary count of items in an import deployment, showing total, imported, failed, and skipped counts.
- name: InspectionError
  fields: 3
  description: An error identified during package inspection that would prevent successful deployment.
- name: InspectionProblems
  fields: 4
  description: Collection of errors and warnings identified during a package inspection.
- name: InspectionRequest
  fields: 4
  description: Request body for creating a package inspection operation. Requires the deployment package and Admin
    Console settings files, with an optional import customization file.
- name: InspectionResponse
  fields: 2
  description: Response returned when an inspection operation is successfully initiated. Contains the UUID for tracking
    the inspection.
- name: InspectionResult
  fields: 2
  description: Result of a package inspection operation, including expected object counts and any problems identified.
- name: InspectionWarning
  fields: 3
  description: A warning identified during package inspection that may affect deployment but would not prevent it.
- name: Package
  fields: 11
  description: Represents an in-flight deployment package associated with an Appian application. Contains metadata
    about the package contents and status.
- name: PackageListResponse
  fields: 2
  description: Response containing the total count of packages and an array of package detail objects for the specified
    application.
relationships:
- from: InspectionProblems
  to: InspectionError
  type: has_many
  via: errors
- from: InspectionProblems
  to: InspectionWarning
  type: has_many
  via: warnings
- from: PackageListResponse
  to: Package
  type: has_many
  via: packages
- from: ExportDeploymentResult
  to: DatabaseScript
  type: has_many
  via: databaseScripts