Schemas

getSchemaCapability

Changed on

Get a schema capability from given capability ID

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

Request

  • Base URL
    https://entity.sls.epilot.io
  • URL
    https://entity.sls.epilot.io/v1/entity/schemas/capabilities/{composite_id}
  • Auth
    • HTTP bearer
    • or API key in header x-epilot-org-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)
overridable_attributeboolean

Allow conditional variants to override the fields this capability manages. Only meaningful on schemas that declare conditions, and requires managed_fields: the flag covers exactly what that lists, not the capability's name.

managed_fieldsstring[]

Every entity field this capability writes, including one named after the capability itself. With overridable_attribute, this is the definitive list of what a variant may override through the capability, applied as a single patch.

Fields, not attributes: a capability may write entity fields that have no attribute definition, so entries need not resolve to one. Where an entry does resolve to an attribute, hidden and computed do not disqualify it.

_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

Changes

  • b7d4f45d1518Revision changes
    • info

      added to the ///// response property anyOf list for the response status

  • 2eb6a1e5f8ccRevision changes
    • info

      added the optional property //// to the response with the status