Resource
integration_definition
An integration definition (immutable, versioned)
Configuration
sourceXMLintegration_documentRequiredIntegration document, including its actors and API clients.
integration_document fields
XML v1 definition of Integration behavior and required configuration.
actorOptionalapiClientsOptionalconfigurationSchemaOptionalcustomAppsOptionaldataContainerSchemasOptionaldescriptionOptionaledgeAppsOptionalintegrationIdRequired^[a-z0-9][a-z0-9-](.[a-z0-9][a-z0-9-])+$
- Pattern
"^[a-z0-9][a-z0-9-]*(\\.[a-z0-9][a-z0-9-]*)+$"- Minimum length
1
policyOptionalprotobufOptionalresourcesOptionalsdkVersionRequired^[0-9]+.[0-9]+$
- Pattern
"^[0-9]+\\.[0-9]+$"- Minimum length
1
timeoutMsOptionalInteger 1...60000; runtime default 5000
- Minimum
1- Maximum
60000
versionRequired^[0-9]+.[0-9]+.[0-9]+(-[a-zA-Z0-9.]+)?$
- Pattern
"^[0-9]+\\.[0-9]+\\.[0-9]+(-[a-zA-Z0-9.]+)?$"- Minimum length
1
workflowsOptionalOnly the fields listed here are accepted.
Read-only values
Show values
idIntegrationDefinitionID!Read onlyUnique identifier
computed by the platform
tenantIdTenantID!Read onlyTenant ID
computed by the platform
parentIdIntegrationID!Read onlyTypeID of the integration this is a version of (prefix igr). Fixed at creation.
References integration
computed by the platform
integrationIdString!Read onlyIntegration identifier (e.g., com.acme.erp-connector)
computed by the platform
versionString!Read onlySemantic version (e.g., 1.2.4)
computed by the platform
nativeProjectionJSONRead onlyServer-derived native runtime projection compiled from authoritative Integration XML; not an authoring input.
computed by the platform
exportedActions[IntegrationExportedActionDescription!]!Read onlyActions 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.
computed by the platform
configSchemaStringRead onlyJSON Schema document an instance's config must satisfy, compiled from sourceXML (or read from a legacy bundle); null when the definition declares no configuration.
computed by the platform
revisionInt!Read onlyMonotonic native draft revision used to reject stale source edits and publication attempts.
computed by the platform
bundleIntegrationBundleRead onlyIntegration bundle containing manifest and files
computed by the platform
statusIntegrationDefinitionStatus!Read onlyStatus (DRAFT, ACTIVE or DEPRECATED)
Allowed values
DRAFT — Draft, still being built in the integration builder
ACTIVE — Active and available for installation
DEPRECATED — Deprecated, no new installations allowed
computed by the platform
engineVersionInt!Read onlyRuntime version: 3 for native XML definitions; 1 and 2 identify legacy bundles.
computed by the platform
createdAtISO8601!Read onlyCreation timestamp (ISO8601)
computed by the platform
exportDocumentStringRead onlyLegacy bundle export; native definitions are authored and read back through sourceXML.
computed by the platform
Lifecycle
The CLI can create this resource. The platform assigns its id.
When replacement is needed, the existing resource is removed before its replacement is created.