Create a new metadata descriptor

POST /data/projects/{project_id}/metadata-descriptors

It serves to describe extra fields listed in the data attribute of entities.

Path parameters

  • project_id string(uuid) Required
application/x-www-form-urlencoded

Body Required

  • entity_type string

    Values are Asset, Shot, Edit, Episode, or Sequence. Default value is Asset.

  • name string Required

    Name of the metadata descriptor

  • data_type string Required

    Type of data (string, number, boolean, etc.)

  • for_client string

    Default value is False.

  • choices array[string]
  • departments array[string]

Responses

  • 201 application/json

    Metadata descriptor created

    Hide response attributes Show response attributes object
    • id string(uuid)
    • name string
    • data_type string
  • 400

    Invalid parameters

  • 404

    Project not found

POST /data/projects/{project_id}/metadata-descriptors
curl \
 --request POST 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/metadata-descriptors' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/x-www-form-urlencoded" \
 --data 'entity_type=Asset&name=string&data_type=string&for_client=True&choices=option1&choices=option2&departments=department1&departments=department2'
Response examples (201)
{
  "id": "string",
  "name": "string",
  "data_type": "string"
}