← API reference
Query / jobs · commerce · logistics · costing · productTemplates · files · devices · aiml · apps · workflows · admin · integrations · surfaces · scripting · reporting · reports

iacSchemaDocument

Fetch the JSON Schema document a SCHEMA-kind validator references, for declarative tooling.

Arguments

refString!

Document reference named by @iac_validator(schemaRef:) or @iac_artifact(testContract:), a shared-resource type such as CUSTOM_APP, or 'envelope'.

Returns IaCSchemaDocumentPayload!

Scalar fields at a glance

documentString!
etagString!
↗ View the complete IaCSchemaDocumentPayload type

Explore in a view

Administration and IAMAI and MLApp AuthoringDevice FleetERP CostingFulfillmentIntegrationsOrder IntakePrint PrepressProduction FloorReportingReportsScriptingJourneys and WorkspacesWorkflow Authoring
View exact SDL
"""
Fetch the JSON Schema document a SCHEMA-kind validator references, for declarative tooling.
"""
iacSchemaDocument(
  """
  Document reference named by @iac_validator(schemaRef:) or @iac_artifact(testContract:), a shared-resource type such as CUSTOM_APP, or 'envelope'.
  """
  ref: String!
): IaCSchemaDocumentPayload! @topic(names: [
  "jobs"
  "commerce"
  "logistics"
  "costing"
  "productTemplates"
  "files"
  "devices"
  "aiml"
  "apps"
  "workflows"
  "admin"
  "integrations"
  "surfaces"
  "scripting"
  "reporting"
  "reports"
])

Schema reference describes the API contract. Actual access is checked by the platform for every operation.