PrepressQu Query

generateDefaultDataQuery

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

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.

Returns

String

Arguments

topic

String!Required

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.

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

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