ProductionQu Query

getMagicQuerySchema

Topics: Admin Aiml Apps Commerce Costing Devices Files IAM Integrations Jobs Logistics Product Templates Reporting Reports Scripting Surfaces Workflows

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

Returns

MagicQuerySchema!

Arguments

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

Exact field 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"
  "iam"
])

Declared on Query. Access is checked by the platform for each operation.