OpenAPI 3.0.22026-08-0688147257.1 KB

8dd3d44e1c4f

Schemas

putSchemaCapability

Adds or updates an capability in the schema

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

Path parameters

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

Schema Slug and the Attribute ID

Request body

idstring

ID for the entity capability

namestring required

Unique name for the capability

titlestring

Human readable title of the capability

attributesAttribute[] — unresolved $ref
_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

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
_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