latestOpenAPI 3.0.22026-08-1588147259.4 KB

3020984570dc

Schemas

getSchemaCapability

Get a schema capability from given capability ID

get/v1/entity/schemas/capabilities/{composite_id}

Path parameters

composite_idstring required

Example:contact:97644baa-083f-4e49-9188-fcff2ecaad7d

Schema Slug and the Attribute ID

Response

Success

idstring

ID for the entity capability

namestring required

Unique name for the capability

titlestring

Human readable title of the capability

attributesAttribute[] — unresolved $ref

variant_overridableboolean

Allow conditional variants of the entity to override the values managed by this capability. Only meaningful on schemas that declare conditions and on capabilities that render an attribute group (EntityAttributes:Group ui hook), e.g. pricing tiers. Attributes carried by the capability opt in individually via their own variant_overridable flag.

_purposeClassificationId[]

_manifeststring[] nullable

Manifest ID used to create/update the schema capabilility

app_idstring

ID of the app if the capability is provided by an app

feature_flagstring

This capability should only be active when the feature flag is enabled

composite_idstring

schemastring

Schema slug the capability belongs to