Sign in

v3

latestOpenAPI 3.0.02026-07-31278263961.8 KB
AppDataSchemas

Get app data schema by selector

get/app-data-schemas/{idOrKey}

Path parameters

idOrKeystring required

App data schema ID or key

Query parameters

searchstring

Text search query to filter results

limitinteger

Maximum number of items to return (1-1000)

cursorstring

Pagination cursor from a previous response

includeArchivedboolean
isUniversalboolean
tenantIdstring
userIdstring
appDataSchemaIdstring
instanceKeystring

Response

idstring required

Internal database ID of the element. Assigned by the API; unique per element.

namestring required

Display name. Always present in API responses (filled by API if not set on create).

uuidstring

Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.

keystring

Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.

descriptionstring

Optional human-readable description.

metaobject

Optional key-value metadata.

state'BUILDING' | 'CLIENT_ACTION_REQUIRED' | 'CONFIGURATION_ERROR' | 'SETUP_FAILED' | 'READY' | 'DISCONNECTING'

Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.

revisionstring

Opaque revision token; changes on each update. Used for optimistic concurrency.

createdAtstring

ISO date when the element was created.

updatedAtstring

ISO date when the element was last updated.

archivedAtstring
isDeactivatedboolean

When true, setup is skipped and the element is treated as inactive (e.g. when dependencies are deactivated or the element is archived).

isReadOnlyboolean

When true, the element cannot be modified (e.g. published package elements or elements from another workspace).

instanceKeystring
appDataSchemaIdstring
schemaobject
codestring
userIdstring
tenantIdstring
appDataSchemaRevisionstring
isCustomizedboolean
userobject
appDataSchemaobject