Custom metadata fields

>>>

GET /api/v1/custom_metadata_fields
Display a list of custom metadata fields.

>>>

GET /api/v1/custom_metadata_fields/:id
Display a custom metadata field.

Params

Param name Description
id
required

ID of the custom metadata field to be displayed.

Validations:

  • Must be a String
>>>

POST /api/v1/custom_metadata_fields
Create a new custom metadata field.

Params

Param name Description
custom_metadata_field
optional , nil allowed

Validations:

  • Must be a Hash
custom_metadata_field[name]
required

The name of the metadatum field.

Validations:

  • Must be a String
custom_metadata_field[type]
required
select | text | pattern | expiry | mapping | generator

The type of the metadatum field.

Validations:

  • Must be a String
custom_metadata_field[mandatory]
optional , nil allowed
true | false

Indicates whether a metadatum field is required or optional. Default: false.

Validations:

  • Must be a String
custom_metadata_field[maxlen]
optional , nil allowed

Maximum length for text fields. Disabled when set to 0.

Validations:

  • Must be a String
>>>

PUT /api/v1/custom_metadata_fields/:id
Update a custom metadata field.

Params

Param name Description
id
required

ID of the custom metadata field to be updated.

Validations:

  • Must be a String
custom_metadata_field
optional , nil allowed

Validations:

  • Must be a Hash
custom_metadata_field[name]
optional

The name of the metadatum field.

Validations:

  • Must be a String
custom_metadata_field[type]
optional
select | text | pattern | expiry | mapping | generator

The type of the metadatum field.

Validations:

  • Must be a String
custom_metadata_field[mandatory]
optional , nil allowed
true | false

Indicates whether a metadatum field is required or optional. Default: false.

Validations:

  • Must be a String
custom_metadata_field[maxlen]
optional , nil allowed

Maximum length for text fields. Disabled when set to 0.

Validations:

  • Must be a String
>>>

DELETE /api/v1/custom_metadata_fields/:id
Delete a custom metadata field.

Params

Param name Description
id
required

ID of the custom metadata field to be deleted.

Validations:

  • Must be a String
>>>

PUT /api/v1/custom_metadata_fields/:id/copy
Copy the custom metadata field to an other metadata set

Params

Param name Description
id
required

ID of the custom metadata field to be copied.

Validations:

  • Must be a String
target_set_id
required

ID of the target custom metadata set

Validations:

  • Must be a String
>>>

GET /api/v1/custom_metadata_fields/:id/in_use
Checks if the metadata field is used by any asset or project