Apps & Surfaces
Apps
Explore the data types and operations available in Apps.
114 operations
Fetch a protobuf schema by ID. Requires protobufSchema:read permission.
getProtobufSchemaByNameQueryFetch a protobuf schema by name. Requires protobufSchema:read permission.
getSharedResourceQueryFetch a single catalog template's metadata by id. Returns null when no such template exists in the catalog. Requires sharedResource: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.
importDashboardMutationImport a dashboard from YAML or JSON, creating a new dashboard. Requires dashboard:write permission.
installSharedResourceMutationInstall 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.
listAPIClientDefinitionsQueryList tenant API definitions, optionally restricted to one uploaded schema.
listCustomAppsQueryList custom apps with pagination and filtering. Requires customapp:list permission.
listCustomAppTeamsQueryList custom app team bindings. Requires customappteam:read permission.
listCustomAppUsersQueryList custom app user bindings. Requires customappuser:read permission.
listCustomAppVersionsQueryList versions for a custom app. Requires customapp:read permission.
listCustomDataContainersByAppQueryList containers for a custom app with pagination. Requires customapp:read permission.
listCustomDataContainersByTaggableQueryList containers tagged to a specific entity with pagination. Requires customapp:read permission.
listDashboardsQueryList dashboards visible to the current user. Returns personal dashboards owned by the user and shared dashboards. Requires dashboard:list permission.
listDataChangeEventTopicsQueryList all valid data change event topics, grouped by resource. Requires authentication.
listDataClipsQueryList data clips for the current tenant
listDataRecordsQueryList data records with pagination. Requires datarecord:list permission.
listDataSchemasQueryList data schemas with pagination. Requires dataschema:list permission.
listExternalSchemaEntriesQueryList entries for an external schema. Requires externalSchema:read permission.
listExternalSchemasQueryList external schemas with pagination and filtering. Requires externalSchema:list permission.
listMagicQueriesQueryLists every available Magic Query noun with a short description and its options — the discovery entry point.
listProtobufSchemasQueryList protobuf schemas with pagination. Requires protobufSchema:list 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.
openCustomAppPreviewMutationOpen 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.
pingQueryHealth check endpoint
previewDataClipQueryPreview a MicroSQL query without saving (returns tabular results)
publishCustomAppMutationPublish a specific version of a custom app, making it visible to end users. Requires customapp:write permission.
renderSchemaXMLQueryRender JSON Schema as native XML without dropping unsupported keywords or changing a saved document.
rollDataClipShareTokenMutationRoll/regenerate the share token for a data clip, invalidating old links
saveAPIClientDefinitionMutationCreate or replace an API definition and compile its types without I/O. Updates require the current revision. Compilation failures are saved with diagnostics.
schemaAuthoringCatalogQueryCompiler-owned vocabulary for the standalone XML JSON Schema dialect, including native form annotations.
searchHelpQuerySearch human-facing manuals using shared semantic and text retrieval.
searchSchemaFieldsQuerySemantic search over GraphQL fields on types
searchSchemaMutationsQuerySemantic search over GraphQL mutation operations
searchSchemaQueriesQuerySemantic search over GraphQL query operations
searchSchemaTypesQuerySemantic search over GraphQL types (objects, inputs, enums)
setCustomAppEngineVersionMutationUpgrade a custom app's engine to v2 after a script-shape lint. Requires customapp:write permission.
sharedResourceInstallationsQueryEvery catalog template this tenant has installed, with the version installed — the basis for detecting available upgrades. Requires sharedResource:list permission.
sharedResourcesQueryBrowse the shared-resource catalog served by ControlApp, with optional type, text and category filters. Requires sharedResource:list permission.
updateCustomAppMutationUpdate a custom app. Only provided fields are changed. Requires customapp:write permission.
updateCustomAppPreviewMutationPush 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.
updateCustomDataContainerMutationUpdate a custom data container. Only provided fields are changed. Requires customapp:write permission.
updateDashboardMutationUpdate a dashboard. Only provided fields are changed. Requires dashboard:write permission.
updateDashboardCardMutationUpdate a dashboard card in place. Only the dashboard owner may. Requires dashboard:write permission.
updateDashboardLayoutMutationBulk update card positions after drag/resize operations. Requires dashboard:write permission.