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

searchHelp

Search human-facing manuals using shared semantic and text retrieval.

Arguments

queryString!

Natural-language question or XML identifier; 1–500 characters.

familyString

Restrict to this manual family; omit to search all manuals.

Returns HelpSearchResult!

Scalar fields at a glance

semanticAvailableBoolean!
↗ View the complete HelpSearchResult type

Explore in a view

Administration and IAMAI and MLApp AuthoringDevice FleetERP CostingFulfillmentIntegrationsOrder IntakePrint PrepressProduction FloorReportingReportsScriptingJourneys and WorkspacesWorkflow Authoring
View exact SDL
"""Search human-facing manuals using shared semantic and text retrieval."""
searchHelp(
  """Natural-language question or XML identifier; 1–500 characters."""
  query: String!
  """Restrict to this manual family; omit to search all manuals."""
  family: String
): HelpSearchResult! @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.