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

getMagicQueryGraphQL

Resolves a Magic Query string to the real GraphQL operation and variables it runs, so consumers can graduate from the façade to raw GraphQL. Does not execute.

Arguments

A Magic Query string to resolve, e.g. 'jobs?limit=10'.

Returns MagicQueryOperation!

Scalar fields at a glance

queryString!
variablesJSON!
↗ View the complete MagicQueryOperation type

Explore in a view

Administration and IAMAI and MLApp AuthoringDevice FleetERP CostingFulfillmentIntegrationsOrder IntakePrint PrepressProduction FloorReportingReportsScriptingJourneys and WorkspacesWorkflow Authoring
View exact SDL
"""
Resolves a Magic Query string to the real GraphQL operation and variables it runs, so consumers can graduate from the façade to raw GraphQL. Does not execute.
"""
getMagicQueryGraphQL(
  """A Magic Query string to resolve, e.g. 'jobs?limit=10'."""
  query: QueryScalar!
): MagicQueryOperation! @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.