Update metadata descriptor

PUT /data/metadata-descriptors/{instance_id}
Jwt authorization

Update a metadata descriptor with data provided in the request body. JSON format is expected. Validates data_type.

Path parameters

  • instance_id string(uuid) Required
application/json

Body Required

  • name string
  • data_type string

Responses

  • 200 application/json

    Metadata descriptor updated successfully

    Hide response attributes Show response attributes object
    • id string(uuid)
    • name string
    • field_name string
    • data_type string
    • project_id string(uuid)
    • created_at string(date-time)
    • updated_at string(date-time)
  • 400

    Invalid data format or invalid data_type

PUT /data/metadata-descriptors/{instance_id} 
curl \
 --request PUT 'http://api.example.com/data/metadata-descriptors/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"name":"Updated Custom Field","data_type":"number"}'
Request examples 
{
  "name": "Updated Custom Field",
  "data_type": "number"
}
Response examples (200) 
{
  "id": "a24a6ea4-ce75-4665-a070-57453082c25",
  "name": "Updated Custom Field",
  "field_name": "custom_field",
  "data_type": "number",
  "project_id": "b24a6ea4-ce75-4665-a070-57453082c25",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T11:00:00Z"
}