Apps & Surfaces
Apps
Explore the data types and operations available in Apps.
163 types · Used in operation arguments and return values.
Result of validating one artifact
IDScalarThe `ID` scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as `"4"`) or integer (such as `4`) input value will be accepted as an ID.
ImportDashboardInputInputInput for importing a dashboard from YAML/JSON
ImportDashboardPayloadObjectResult of importing a dashboard from YAML/JSON
InstallSharedResourcePayloadObjectResult of installing a catalog template into the calling tenant. Failures are returned in this payload rather than raised as GraphQL errors.
IntScalarThe `Int` scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
JSONScalarArbitrary JSON value (object, array, number, boolean, string, or null). Not introspectable — when the shape is known, prefer a typed `Type` registration. Numbers stored as numbers come back as numbers, not stringified.
MagicQueryInfoObjectA discoverable Magic Query noun and its accepted options.
MagicQueryOperationObjectThe real GraphQL operation + variables a Magic Query resolves to.
MagicQuerySchemaObjectInput (JSON Schema) and output (introspection) contract for a Magic Query noun.
OpenCustomAppPreviewPayloadObjectResult of opening a custom app preview.
PreviewDataClipInputInputInput for `previewDataClip`: run a candidate query and inspect its rows before committing it to a clip.
ProtobufSchemaByIdInputInputInput for fetching a protobuf schema by ID
ProtobufSchemaByNameInputInputInput for fetching a protobuf schema by name
ProtobufSchemaConnectionObjectPaginated list of protobuf schemas
ProtobufSchemaFilterInputInputFilter criteria for protobuf schemas
ProtobufSchemaIDScalarUnique identifier for a protobuf schema
ProtobufSchemaSortInputInputSort order for protobuf schemas
ProtobufSchemaStateObjectA tenant-scoped protobuf schema used by scripts to decode binary payloads
QueryScalarScalarA URI-style string defining an entity, optional ID, and filter parameters. Format: <noun>[#<id>][?<key>=<value>,...]. Examples: 'jobs?limit=100,status=approved', 'job#01H...'.
ReportQueryPayloadObjectResult of a MicroSQL reporting query
RollShareTokenInputInputInput for `rollDataClipShareToken`.
RollShareTokenPayloadObjectResult of rolling a data clip's share token. On success the clip carries the new token and every previously shared link is dead.
SaveAPIClientDefinitionPayloadObjectResult of saving an API client definition.
SchemaDocSearchResultObjectOne semantic-search hit against the introspected GraphQL schema: the matched schema element, its documentation text, and how closely it matched the query.
SetCustomAppEngineVersionInputInputInput for upgrading an app's engine version after a script-shape lint
SharedResourceConnectionObjectA page of shared-resource catalog templates matching the requested filters.
SharedResourceEnvelopeObjectA template published in the shared-resource catalog: the metadata a tenant browses before installing it. Served by ControlApp, not by this tenant's database; the template's payload itself is not exposed here.
SharedResourceInstallationStateObjectA record, held by ControlApp, that this tenant installed a given catalog template at a given version. Describes the installation, not the installed resource.
SharedResourceTemplateIDScalarUnique identifier for a shared resource template
SharedResourceTypeEnumType of shared resource in the catalog
StringScalarThe `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
UpdateCustomAppInputInputInput for updating a custom app. Only provided fields are changed.
UpdateCustomAppPreviewPayloadObjectResult of pushing new source to a custom app preview.
UpdateCustomDataContainerInputInputInput for updating a custom data container. Only provided fields are changed.
UpdateDashboardCardInputInputFields for updating a dashboard card — only provided fields are changed
UpdateDashboardInputInputInput for updating a dashboard. Only provided fields are changed.
UpdateDashboardLayoutInputInputInput for bulk-updating card positions after drag/resize
UpdateDashboardLayoutPayloadObjectResult of updating dashboard card layout positions
UpdateDataClipInputInputInput for `updateDataClip`. Every field is optional — omitted fields are left as-is.
UpdateDataRecordInputInputInput for updating a data record. Only provided fields are changed.
UpdateDataSchemaInputInputInput for updating a data schema. Only provided fields are changed.
UpdateExternalSchemaInputInputInput for updating an external schema. Only provided fields are changed.
UpdateProtobufSchemaInputInputInput for updating a protobuf schema. Only provided fields are changed.
UpsertCustomAppInputInputInput for creating or updating a custom app
UpsertCustomAppPayloadObjectResult of creating or updating a custom app
UpsertCustomDataContainerInputInputInput for creating or updating a custom data container
UpsertCustomDataContainerPayloadObjectResult of creating or updating a custom data container
UpsertDashboardCardInputInputInput for creating or updating a dashboard card
UpsertDashboardCardPayloadObjectResult of creating or updating a dashboard card