Sales & CRM
Product Templates
Explore the data types and operations available in Product Templates.
29 operations
Compile standalone XML schema syntax into JSON Schema without persisting it; host restrictions apply when embedded.
createProductTemplateMutationCreate a new product template. Requires productTemplate:write permission.
dataChangeEventsSubscriptionSubscribe to real-time data change events. Requires read permission on each requested resource. Task topics are the exception: a signed-in user without task:read receives the events of their own tasks only (assigned to them, claimed by them, unclaimed on their teams).
deleteProductTemplateMutationDelete a product template. Requires productTemplate:delete permission.
generateDefaultDataQueryQueryGenerate 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.
getMagicQueryGraphQLQueryResolves 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.
getMagicQuerySchemaQueryReturns the input JSON Schema and output introspection for a Magic Query noun, so consumers (especially LLMs) can learn its contract before calling magicQuery.
getProductTemplateQueryFetch a product template by ID. Requires productTemplate:read permission.
getProductTemplateVersionQueryFetch a specific published version. Requires productTemplate:read permission.
helpChapterQueryRead a chapter of the current published manual edition.
helpChaptersQueryList human-facing manual chapters from the running deployment.
iacGuidesQueryEvery authoring guide, for a tool that syncs them to a folder. Intended for `schema pull` to call once and write to disk, not for an agent to call while authoring — a file can be grepped and re-read in part, where a response arrives whole.
iacSchemaQueryThe infrastructure-only view of this schema, for declarative tooling. Contains only annotated resources and the types they reach.
iacSchemaDocumentQueryFetch the JSON Schema document a SCHEMA-kind validator references, for declarative tooling.
iacValidateQueryValidate an infrastructure artifact. Pure and side-effect free; safe to alias many times in one document.
installCanonicalTemplateMutationInstall a canonical product template (shipped with the app) into the calling tenant as a fresh draft. Requires productTemplate:write permission.
instantiateProductTemplateMutationInstantiate a published product template into a print job. Requires productTemplate:execute permission.
listDataChangeEventTopicsQueryList all valid data change event topics, grouped by resource. Requires authentication.
listMagicQueriesQueryLists every available Magic Query noun with a short description and its options — the discovery entry point.
listProductTemplatesQueryList product templates with optional filters, sorted by name. Requires productTemplate:list permission.
listProductTemplateVersionsQueryList published versions of a template with pagination. Requires productTemplate:read permission.
magicQueryQueryExecutes a Magic Query string and returns the predefined query's JSON result. On a bad noun or parameter, returns a structured error whose 'extensions' carry 'code', 'actionable_message', and 'suggestions' for self-correction.
pingQueryHealth check endpoint
publishProductTemplateMutationPublish a product template version. Requires productTemplate:write permission.
renderSchemaXMLQueryRender JSON Schema as native XML without dropping unsupported keywords or changing a saved document.
schemaAuthoringCatalogQueryCompiler-owned vocabulary for the standalone XML JSON Schema dialect, including native form annotations.
searchHelpQuerySearch human-facing manuals using shared semantic and text retrieval.
updateProductTemplateMutationUpdate a product template. Only provided fields are changed. Requires productTemplate:write permission.
upsertProductTemplateMutationCreate or update a product template. Requires productTemplate:write permission.