IntegrationDefinitionState
An integration definition (immutable, versioned)
Fields
Unique identifier
Tenant ID
TypeID of the integration this is a version of (prefix igr). Fixed at creation.
Integration identifier (e.g., com.acme.erp-connector)
Semantic version (e.g., 1.2.4)
Authoritative Integration XML v1, including owned API schema/client pairs; null for legacy definitions. The integration-source validator checks the entire document.
Server-derived native runtime projection compiled from authoritative Integration XML; not an authoring input.
Actions this definition's API clients export (<export>), named client.operation, with JSON Schemas generated from each operation's compiled contract. The schemas describe the Actions for discovery; the contract itself checks every call. Empty for legacy definitions.
JSON Schema document an instance's config must satisfy, compiled from sourceXML (or read from a legacy bundle); null when the definition declares no configuration.
Monotonic native draft revision used to reject stale source edits and publication attempts.
Integration bundle containing manifest and files
Status (DRAFT, ACTIVE or DEPRECATED)
Possible values (3)
DRAFTDraft, still being built in the integration builder
ACTIVEActive and available for installation
DEPRECATEDDeprecated, no new installations allowed
Runtime version: 3 for native XML definitions; 1 and 2 identify legacy bundles.
Creation timestamp (ISO8601)
Legacy bundle export; native definitions are authored and read back through sourceXML.
Referenced by (5)
Exact type SDL
"""An integration definition (immutable, versioned)"""
type IntegrationDefinitionState @iac_resource(name: "integration_definition") @iac_history(parentResource: "integration", parentField: "parentId", currentField: "publishedVersionId", statusField: "status", publishedValues: ["ACTIVE", "DEPRECATED"]) @iac_immutable(read: "getIntegrationDefinitionObservation", statusField: "status", frozenValues: ["ACTIVE", "DEPRECATED"], fields: ["sourceXML"], version: "1", tokenField: "revision", changes: "integrationDefinitionChanges") @iac_guide(ref: "integration-guide") @iac_precondition(field: "revision", input: "expectedRevision") @iac_ops(create: "createIntegrationDefinitionSource", update: "updateIntegrationDefinitionSource", read: "getIntegrationDefinition", delete: "deleteIntegrationDefinition") {
"""Unique identifier"""
id: IntegrationDefinitionID! @iac_identity(assignedBy: SERVER) @iac_computed
"""Tenant ID"""
tenantId: TenantID! @iac_computed
"""
TypeID of the integration this is a version of (prefix `igr`). Fixed at creation.
"""
parentId: IntegrationID! @iac_ref(resource: "integration") @iac_computed
"""Integration identifier (e.g., com.acme.erp-connector)"""
integrationId: String! @iac_computed
"""Semantic version (e.g., 1.2.4)"""
version: String! @iac_computed
"""
Authoritative Integration XML v1, including owned API schema/client pairs; null for legacy definitions. The integration-source validator checks the entire document.
"""
sourceXML: String @iac_artifact(language: XML, validators: ["integration-source"], models: ["integration_document"], description: "Integration document, including its actors and API clients.")
"""
Server-derived native runtime projection compiled from authoritative Integration XML; not an authoring input.
"""
nativeProjection: JSON @iac_computed
"""
Actions this definition's API clients export (`<export>`), named `client.operation`, with JSON Schemas generated from each operation's compiled contract. The schemas describe the Actions for discovery; the contract itself checks every call. Empty for legacy definitions.
"""
exportedActions: [IntegrationExportedActionDescription!]! @iac_computed
"""
JSON Schema document an instance's config must satisfy, compiled from sourceXML (or read from a legacy bundle); null when the definition declares no configuration.
"""
configSchema: String @iac_computed
"""
Monotonic native draft revision used to reject stale source edits and publication attempts.
"""
revision: Int! @iac_computed
"""Integration bundle containing manifest and files"""
bundle: IntegrationBundle @iac_computed
"""Status (DRAFT, ACTIVE or DEPRECATED)"""
status: IntegrationDefinitionStatus! @iac_computed
"""
Runtime version: 3 for native XML definitions; 1 and 2 identify legacy bundles.
"""
engineVersion: Int! @iac_computed
"""Creation timestamp (ISO8601)"""
createdAt: ISO8601! @iac_computed
"""
Legacy bundle export; native definitions are authored and read back through sourceXML.
"""
exportDocument: String @iac_computed
}