Apps & Surfaces

Apps

Explore the data types and operations available in Apps.

114 operations

getProtobufSchemaQuery

Fetch a protobuf schema by ID. Requires protobufSchema:read permission.

getProtobufSchemaByNameQuery

Fetch a protobuf schema by name. Requires protobufSchema:read permission.

getSharedResourceQuery

Fetch a single catalog template's metadata by id. Returns null when no such template exists in the catalog. Requires sharedResource: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.

importDashboardMutation

Import a dashboard from YAML or JSON, creating a new dashboard. Requires dashboard:write permission.

installSharedResourceMutation

Install a catalog template into the calling tenant, creating or updating the corresponding domain resource and recording the installation with ControlApp. Idempotent: re-installing an unchanged template returns the existing resource. Authorization is dynamic — the caller needs write permission on the resource kind the template installs (e.g. script:write for a SCRIPT template, workflow:write for a WORKFLOW one), so it is checked in the resolver once the template has been fetched. Failures are reported in the payload, not as GraphQL errors.

listAPIClientDefinitionsQuery

List tenant API definitions, optionally restricted to one uploaded schema.

listCustomAppsQuery

List custom apps with pagination and filtering. Requires customapp:list permission.

listCustomAppTeamsQuery

List custom app team bindings. Requires customappteam:read permission.

listCustomAppUsersQuery

List custom app user bindings. Requires customappuser:read permission.

listCustomAppVersionsQuery

List versions for a custom app. Requires customapp:read permission.

listCustomDataContainersByAppQuery

List containers for a custom app with pagination. Requires customapp:read permission.

listCustomDataContainersByTaggableQuery

List containers tagged to a specific entity with pagination. Requires customapp:read permission.

listDashboardsQuery

List dashboards visible to the current user. Returns personal dashboards owned by the user and shared dashboards. Requires dashboard:list permission.

listDataChangeEventTopicsQuery

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

listDataClipsQuery

List data clips for the current tenant

listDataRecordsQuery

List data records with pagination. Requires datarecord:list permission.

listDataSchemasQuery

List data schemas with pagination. Requires dataschema:list permission.

listExternalSchemaEntriesQuery

List entries for an external schema. Requires externalSchema:read permission.

listExternalSchemasQuery

List external schemas with pagination and filtering. Requires externalSchema:list permission.

listMagicQueriesQuery

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

listProtobufSchemasQuery

List protobuf schemas with pagination. Requires protobufSchema:list 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.

openCustomAppPreviewMutation

Open an in-memory preview of a custom app's draft server API for the caller. Nothing is saved; the preview ends after a period without calls. Source with problems still opens a preview, which holds no server API until fixed. Requires customapp:write.

pingQuery

Health check endpoint

previewDataClipQuery

Preview a MicroSQL query without saving (returns tabular results)

publishCustomAppMutation

Publish a specific version of a custom app, making it visible to end users. Requires customapp:write permission.

renderSchemaXMLQuery

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

rollDataClipShareTokenMutation

Roll/regenerate the share token for a data clip, invalidating old links

saveAPIClientDefinitionMutation

Create or replace an API definition and compile its types without I/O. Updates require the current revision. Compilation failures are saved with diagnostics.

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.

searchSchemaFieldsQuery

Semantic search over GraphQL fields on types

searchSchemaMutationsQuery

Semantic search over GraphQL mutation operations

searchSchemaQueriesQuery

Semantic search over GraphQL query operations

searchSchemaTypesQuery

Semantic search over GraphQL types (objects, inputs, enums)

setCustomAppEngineVersionMutation

Upgrade a custom app's engine to v2 after a script-shape lint. Requires customapp:write permission.

sharedResourceInstallationsQuery

Every catalog template this tenant has installed, with the version installed — the basis for detecting available upgrades. Requires sharedResource:list permission.

sharedResourcesQuery

Browse the shared-resource catalog served by ControlApp, with optional type, text and category filters. Requires sharedResource:list permission.

updateCustomAppMutation

Update a custom app. Only provided fields are changed. Requires customapp:write permission.

updateCustomAppPreviewMutation

Push a draft's current server API to its preview. Source with problems is not taken: the last working source keeps running and the problems are returned. Only the person who opened the preview may update it. Requires customapp:write.

updateCustomDataContainerMutation

Update a custom data container. Only provided fields are changed. Requires customapp:write permission.

updateDashboardMutation

Update a dashboard. Only provided fields are changed. Requires dashboard:write permission.

updateDashboardCardMutation

Update a dashboard card in place. Only the dashboard owner may. Requires dashboard:write permission.

updateDashboardLayoutMutation

Bulk update card positions after drag/resize operations. Requires dashboard:write permission.