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

generateDefaultDataQuery

Generate a default GraphQL data query for an event topic. Returns a query string with all scalar fields for the resource, or null if the topic has no matching query. The query uses $id as the variable for the resource ID.

Arguments

topicString!

Event topic in resource.verb form (e.g. 'carrier.updated'). Only the resource part is used: it selects the get{Resource}(id:) query the generated document targets. Null is returned when no such query exists.

Returns String

Explore in a view

Administration and IAMAI and MLApp AuthoringDevice FleetERP CostingFulfillmentIntegrationsOrder IntakePrint PrepressProduction FloorReportingReportsScriptingJourneys and WorkspacesWorkflow Authoring
View exact SDL
"""
Generate a default GraphQL data query for an event topic. Returns a query string with all scalar fields for the resource, or null if the topic has no matching query. The query uses $id as the variable for the resource ID.
"""
generateDefaultDataQuery(
  """
  Event topic in `resource.verb` form (e.g. 'carrier.updated'). Only the resource part is used: it selects the `get{Resource}(id:)` query the generated document targets. Null is returned when no such query exists.
  """
  topic: String!
): String @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.