Sales & CRM

Product Templates

Explore the data types and operations available in Product Templates.

29 operations

compileSchemaXMLQuery

Compile standalone XML schema syntax into JSON Schema without persisting it; host restrictions apply when embedded.

createProductTemplateMutation

Create a new product template. Requires productTemplate:write permission.

dataChangeEventsSubscription

Subscribe 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).

deleteProductTemplateMutation

Delete a product template. Requires productTemplate:delete permission.

generateDefaultDataQueryQuery

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.

getMagicQueryGraphQLQuery

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.

getMagicQuerySchemaQuery

Returns the input JSON Schema and output introspection for a Magic Query noun, so consumers (especially LLMs) can learn its contract before calling magicQuery.

getProductTemplateQuery

Fetch a product template by ID. Requires productTemplate:read permission.

getProductTemplateVersionQuery

Fetch a specific published version. Requires productTemplate:read permission.

helpChapterQuery

Read a chapter of the current published manual edition.

helpChaptersQuery

List human-facing manual chapters from the running deployment.

iacGuidesQuery

Every 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.

iacSchemaQuery

The infrastructure-only view of this schema, for declarative tooling. Contains only annotated resources and the types they reach.

iacSchemaDocumentQuery

Fetch the JSON Schema document a SCHEMA-kind validator references, for declarative tooling.

iacValidateQuery

Validate an infrastructure artifact. Pure and side-effect free; safe to alias many times in one document.

installCanonicalTemplateMutation

Install a canonical product template (shipped with the app) into the calling tenant as a fresh draft. Requires productTemplate:write permission.

instantiateProductTemplateMutation

Instantiate a published product template into a print job. Requires productTemplate:execute permission.

listDataChangeEventTopicsQuery

List all valid data change event topics, grouped by resource. Requires authentication.

listMagicQueriesQuery

Lists every available Magic Query noun with a short description and its options — the discovery entry point.

listProductTemplatesQuery

List product templates with optional filters, sorted by name. Requires productTemplate:list permission.

listProductTemplateVersionsQuery

List published versions of a template with pagination. Requires productTemplate:read permission.

magicQueryQuery

Executes 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.

pingQuery

Health check endpoint

publishProductTemplateMutation

Publish a product template version. Requires productTemplate:write permission.

renderSchemaXMLQuery

Render JSON Schema as native XML without dropping unsupported keywords or changing a saved document.

schemaAuthoringCatalogQuery

Compiler-owned vocabulary for the standalone XML JSON Schema dialect, including native form annotations.

searchHelpQuery

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

updateProductTemplateMutation

Update a product template. Only provided fields are changed. Requires productTemplate:write permission.

upsertProductTemplateMutation

Create or update a product template. Requires productTemplate:write permission.