CoCoCoCoCoCo / docs
← API reference
SCHEMA VIEW

App Authoring

Custom apps, dashboards, data schemas, records and clips.

Open workbench ↗Download SDL ↓AI context →

109 operations · complete schema 152 KB

Query

magicQuery

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.

→Query

getMagicQuerySchema

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

→Query

listMagicQueries

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

→Query

getMagicQueryGraphQL

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.

→Query

listDataChangeEventTopics

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

→Query

generateDefaultDataQuery

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.

→Query

ping

Health check endpoint

→Query

getDashboardCard

Fetch a single dashboard card. Visibility follows the parent dashboard. Requires dashboard:read permission.

→Query

getDashboard

Fetch a dashboard by ID with its cards. Requires dashboard:read permission.

→Query

listDashboards

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

→Query

getCustomApp

Fetch a custom app by ID. Requires customapp:read permission.

→Query

getCustomAppByHandle

Fetch a custom app by handle. Requires customapp:read permission.

→Query

listCustomApps

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

→Query

listCustomAppUsers

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

→Query

listCustomAppTeams

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

→Query

getCustomAppVersion

Fetch a custom app version by ID. Requires customapp:read permission.

→Query

listCustomAppVersions

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

→Query

getCustomDataContainer

Fetch a custom data container by ID. Requires customapp:read permission.

→Query

listCustomDataContainersByApp

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

→Query

listCustomDataContainersByTaggable

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

→Query

getDataSchema

Fetch a data schema by ID. Requires dataschema:read permission.

→Query

getDataSchemaByName

Fetch a data schema by name. Requires dataschema:read permission.

→Query

dataSchemas

List all data schemas for the current tenant with pagination. Requires dataschema:read permission.

→Query

listDataSchemas

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

→Query

getDataRecord

Fetch a data record by ID. Requires datarecord:read permission.

→Query

dataRecordsBySchema

List data records for a schema with pagination. Requires datarecord:read permission.

→Query

listDataRecords

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

→Query

dataRecordsByTaggable

List data records tagged to a specific entity with pagination. Requires datarecord:read permission.

→Query

getProtobufSchema

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

→Query

getProtobufSchemaByName

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

→Query

listProtobufSchemas

List protobuf schemas with pagination. Requires protobufSchema:list permission.

→Query

iacSchema

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

→Query

iacValidate

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

→Query

iacGuides

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.

→Query

helpChapters

List human-facing manual chapters from the running deployment.

→Query

helpChapter

Read a chapter of the current published manual edition.

→Query

searchHelp

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

→Query

schemaAuthoringCatalog

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

→Query

compileSchemaXML

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

→Query

renderSchemaXML

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

→Query

iacSchemaDocument

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

→Query

sharedResources

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

→Query

getSharedResource

Fetch a single catalog template's metadata by id. Returns null when no such template exists in the catalog. Requires sharedResource:read permission.

→Query

sharedResourceInstallations

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

→Query

getDataClip

Get a data clip by ID

→Query

listDataClips

List data clips for the current tenant

→Query

previewDataClip

Preview a MicroSQL query without saving (returns tabular results)

→Query

getExternalSchema

Fetch an external schema by ID. Requires externalSchema:read permission.

→Query

listExternalSchemas

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

→Query

listAPIClientDefinitions

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

→Query

getAPIClientDefinition

Read a tenant API definition and its current compilation status.

→Query

listExternalSchemaEntries

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

→Query

searchSchemaTypes

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

→Query

searchSchemaFields

Semantic search over GraphQL fields on types

→Query

searchSchemaQueries

Semantic search over GraphQL query operations

→Query

searchSchemaMutations

Semantic search over GraphQL mutation operations

→Mutation

upsertDashboard

Create or update a dashboard. Requires dashboard:write permission.

→Mutation

createDashboard

Create a new dashboard. Requires dashboard:write permission.

→Mutation

updateDashboard

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

→Mutation

deleteDashboard

Delete a dashboard and all its cards. Requires dashboard:delete permission.

→Mutation

createDashboardCard

Create a card on a dashboard. Only the dashboard owner may. Requires dashboard:write permission.

→Mutation

updateDashboardCard

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

→Mutation

upsertDashboardCard

Create or update a card within a dashboard. Requires dashboard:write permission.

→Mutation

deleteDashboardCard

Delete a card from a dashboard. Requires dashboard:write permission.

→Mutation

updateDashboardLayout

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

→Mutation

exportDashboard

Export a dashboard and its cards to YAML or JSON. Requires dashboard:read permission.

→Mutation

importDashboard

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

→Mutation

upsertCustomApp

Create or update a custom app. Requires customapp:write permission.

→Mutation

createCustomApp

Create a new custom app. Requires customapp:write permission.

→Mutation

updateCustomApp

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

→Mutation

deleteCustomApp

Delete a custom app. Requires customapp:delete permission.

→Mutation

createCustomAppSession

Create a session token for a custom app. The token should be passed in the X-App-Session header for RPC calls. Requires customapp:read permission.

→Mutation

publishCustomApp

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

→Mutation

setCustomAppEngineVersion

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

→Mutation

attachCustomAppUser

Attach a user to a custom app. Requires customappuser:write permission.

→Mutation

detachCustomAppUser

Detach a user from a custom app. Requires customappuser:write permission.

→Mutation

attachCustomAppTeam

Attach a team to a custom app. Requires customappteam:write permission.

→Mutation

detachCustomAppTeam

Detach a team from a custom app. Requires customappteam:write permission.

→Mutation

createCustomAppVersion

Create a new version snapshot of a custom app. Requires customapp:write permission.

→Mutation

deleteCustomAppVersion

Delete a custom app version. Requires customapp:delete permission.

→Mutation

upsertCustomDataContainer

Create or update a custom data container. Requires customapp:write permission.

→Mutation

createCustomDataContainer

Create a custom data container. Requires customapp:write permission.

→Mutation

updateCustomDataContainer

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

→Mutation

deleteCustomDataContainer

Delete a custom data container. Requires customapp:delete permission.

→Mutation

upsertDataSchema

Create or update a data schema. Requires dataschema:write permission.

→Mutation

createDataSchema

Create a new data schema. Requires dataschema:write permission.

→Mutation

updateDataSchema

Update a data schema. Only provided fields are changed. Requires dataschema:write permission.

→Mutation

deleteDataSchema

Delete a data schema. Requires dataschema:delete permission.

→Mutation

upsertDataRecord

Create or update a data record. Requires datarecord:write permission.

→Mutation

createDataRecord

Create a new data record. Requires datarecord:write permission.

→Mutation

updateDataRecord

Update a data record. Only provided fields are changed. Requires datarecord:write permission.

→Mutation

deleteDataRecord

Delete a data record. Requires datarecord:delete permission.

→Mutation

upsertProtobufSchema

Create or update a protobuf schema. Requires protobufSchema:write permission.

→Mutation

createProtobufSchema

Create a new protobuf schema. Requires protobufSchema:write permission.

→Mutation

updateProtobufSchema

Update a protobuf schema. Only provided fields are changed. Requires protobufSchema:write permission.

→Mutation

deleteProtobufSchema

Delete a protobuf schema. Requires protobufSchema:delete permission.

→Mutation

installSharedResource

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.

→Mutation

upsertDataClip

Create or update a data clip

→Mutation

createDataClip

Create a new data clip

→Mutation

updateDataClip

Update a data clip

→Mutation

deleteDataClip

Delete a data clip

→Mutation

rollDataClipShareToken

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

→Mutation

upsertExternalSchema

Create or update an external schema. Triggers background processing. Requires externalSchema:write permission.

→Mutation

createExternalSchema

Create a new external schema. Triggers background processing. Requires externalSchema:write permission.

→Mutation

updateExternalSchema

Update an external schema. Only provided fields are changed. Triggers background processing if sourceText is changed. Requires externalSchema:write permission.

→Mutation

deleteExternalSchema

Delete an external schema and all its entries. Requires externalSchema:delete permission.

→Mutation

saveAPIClientDefinition

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

→Mutation

deleteAPIClientDefinition

Delete an API definition only when its current revision matches.

→Subscription

dataChangeEvents

Subscribe to real-time data change events. Requires read permission on each requested resource.

→