v4

latestOpenAPI 3.0.22026-07-3188146256.6 KB

Schemas

getSchemaGroupHeadline

Get a group headline from schema from given headline composite ID

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

Path parameters

composite_idstring required

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

Schema Slug and the Schema Group ID

Response

Success

idstring uuid

namestring required

labelstring required

layoutstring

groupstring required

The group of headline attribute

orderinteger

The order of headline attribute

type'headline' required

enable_dividerboolean

divider'top_divider' | 'bottom_divider'

_purposeClassificationId[]

_manifeststring[] nullable

Manifest ID used to create/update the schema group headline

composite_idstring

schemastring

Schema slug the capability belongs to

Example response

{
  "_purpose": [
    "taxonomy-slug:classification-slug"
  ],
  "_manifest": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "composite_id": "contact:97644baa-083f-4e49-9188-fcff2ecaad7d",
  "schema": "contact"
}