Get metadata descriptor

GET /data/metadata-descriptors/{instance_id}

Jwt authorization

Retrieve a metadata descriptor by its ID and return it as a JSON object. Supports including relations.

Path parameters

instance_id string(uuid) Required

Query parameters

relations boolean

Whether to include relations

Responses

200 application/json

Metadata descriptor retrieved successfully
Hide response attributes Show response attributes object
- id string(uuid)
- name string
- field_name string
- data_type string
- project_id string(uuid)
- entity_type string
- created_at string(date-time)
- updated_at string(date-time)
400

Invalid ID format or query error

GET /data/metadata-descriptors/{instance_id}

curl \
 --request GET 'http://api.example.com/data/metadata-descriptors/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Response examples (200)

{
  "id": "a24a6ea4-ce75-4665-a070-57453082c25",
  "name": "Custom Field",
  "field_name": "custom_field",
  "data_type": "text",
  "project_id": "b24a6ea4-ce75-4665-a070-57453082c25",
  "entity_type": "Asset",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}