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

getMagicQuerySchema

Returns the input JSON Schema and output introspection for a Magic Query noun, so consumers (especially LLMs) can learn its contract before calling magicQuery.

Arguments

queryQueryScalar!

A Magic Query string; only the noun is required, e.g. 'jobs'.

Returns MagicQuerySchema!

Scalar fields at a glance

nounString!
kindMagicQueryKind!
returnTypeString!
inputSchemaJSON!
outputSchemaIntrospectionResultJSON!
↗ View the complete MagicQuerySchema type

Explore in a view

Administration and IAMAI and MLApp AuthoringDevice FleetERP CostingFulfillmentIntegrationsOrder IntakePrint PrepressProduction FloorReportingReportsScriptingJourneys and WorkspacesWorkflow Authoring
View exact SDL
"""
Returns the input JSON Schema and output introspection for a Magic Query noun, so consumers (especially LLMs) can learn its contract before calling magicQuery.
"""
getMagicQuerySchema(
  """A Magic Query string; only the noun is required, e.g. 'jobs'."""
  query: QueryScalar!
): MagicQuerySchema! @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.