{"components":{"schemas":{"BulkMetadataCopySchema":{"properties":{"object_ids_mapping":{"items":{"$ref":"#/components/schemas/SegmentsCopyMapping"},"type":"array"}},"required":["object_ids_mapping"],"type":"object"},"BulkMetadataDeleteSchema":{"properties":{"object_ids":{"items":{"format":"uuid","type":"string"},"maxItems":500,"minItems":1,"type":"array"}},"required":["object_ids"],"type":"object"},"CollectionMetadataValuesBatchSchema":{"properties":{"date_created":{"format":"date-time","type":"string"},"date_modified":{"format":"date-time","type":"string"},"include_assets":{"type":"boolean"},"include_collections":{"type":"boolean"},"metadata_values":{"additionalProperties":{"$ref":"#/components/schemas/MetadataFieldValueSchema"},"type":"object"},"object_ids":{"items":{"format":"uuid","type":"string"},"type":"array"},"object_type":{"type":"string"}},"required":["include_assets","include_collections","metadata_values","object_ids"],"type":"object"},"CopySourceQueryParamsSchema":{"properties":{"source_object_id":{"format":"uuid","type":"string"},"source_object_type":{"type":"string"},"source_version_id":{"format":"uuid","type":"string"}},"type":"object"},"CreateMetadataValuesBatchSchema":{"properties":{"asset_id":{"format":"uuid","type":"string"},"date_created":{"format":"date-time","type":"string"},"date_modified":{"format":"date-time","type":"string"},"metadata_values_object_id_mapping":{"items":{"$ref":"#/components/schemas/MetadataValuesObjectId"},"type":"array"},"object_ids":{"items":{"format":"uuid","type":"string"},"type":"array"},"object_type":{"type":"string"}},"required":["metadata_values_object_id_mapping","object_ids"],"type":"object"},"ExternalSourceFieldOptionsSchema":{"properties":{"label":{"type":"string"},"value":{"type":"string"}},"type":"object"},"FacetFieldNamesSchema":{"properties":{"objects":{"items":{"type":"string"},"type":"array"}},"type":"object"},"FieldOptionsSchema":{"properties":{"label":{"type":"string"},"value":{"type":"string"}},"type":"object"},"ListObjectsSchema":{"properties":{"first_url":{"readOnly":true,"type":"string"},"last_url":{"readOnly":true,"type":"string"},"next_url":{"readOnly":true,"type":"string"},"page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"pages":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"per_page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"prev_url":{"readOnly":true,"type":"string"},"total":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"readOnly":true,"type":"integer"}},"type":"object"},"MetadataCategoriesSchema":{"properties":{"objects":{"items":{"$ref":"#/components/schemas/MetadataCategory"},"readOnly":true,"type":"array"}},"type":"object"},"MetadataCategory":{"properties":{"date_created":{"format":"date-time","type":"string"},"date_modified":{"format":"date-time","type":"string"},"label":{"type":"string"},"name":{"type":"string"},"object_type":{"readOnly":true,"type":"string"},"view_ids":{"items":{"type":"string"},"type":"array"},"views":{"items":{"$ref":"#/components/schemas/MetadataView"},"readOnly":true,"type":"array"}},"required":["label","name"],"type":"object"},"MetadataCategorySchema":{"properties":{"date_created":{"format":"date-time","type":"string"},"date_modified":{"format":"date-time","type":"string"},"label":{"type":"string"},"name":{"type":"string"},"object_type":{"readOnly":true,"type":"string"},"view_ids":{"items":{"type":"string"},"type":"array"},"views":{"items":{"$ref":"#/components/schemas/MetadataView"},"readOnly":true,"type":"array"}},"required":["label","name"],"type":"object"},"MetadataField":{"properties":{"auto_set":{"nullable":true,"type":"boolean"},"date_created":{"format":"date-time","type":"string"},"date_modified":{"format":"date-time","type":"string"},"description":{"type":"string"},"external_id":{"type":"string"},"field_type":{"type":"string"},"hide_if_not_set":{"nullable":true,"type":"boolean"},"is_block_field":{"type":"boolean"},"is_warning_field":{"type":"boolean"},"label":{"type":"string"},"mapped_field_name":{"readOnly":true,"type":"string"},"max_value":{"type":"number"},"min_value":{"type":"number"},"multi":{"type":"boolean"},"name":{"readOnly":true,"type":"string"},"options":{"items":{"$ref":"#/components/schemas/FieldOptionsSchema"},"type":"array"},"read_only":{"nullable":true,"type":"boolean"},"representative":{"type":"boolean"},"required":{"nullable":true,"type":"boolean"},"sortable":{"type":"boolean"},"source_url":{"description":"Will be used to upload MetadataField's `options`. Cannot be set or used as long as `options` are set.  **Example**: The value is `https://external-url.com/foo/`. In that case `GET` request will be sent to `https://external-url.com/foo/?user_id=uuid1&view_id=uuid1&field_name=bar&view_name=user_view&system_domain_id=uuid1`. Please note that some query parameters were added by *iconik* to get values that were predefined in your system for each user [user_id] and view [view_id]. Metadata field name [field_name], view's name [view_name] and system domain identifier [system_domain_id] will be also passed in each request. *iconik* will successfully parse the response from that URL if it will be sent in JSON formatted string: `{\"bar\": [{\"value\": \"1\", \"label\": \"1st\"}, {\"value\": \"2\", \"label\": \"2nd\"}]}`","format":"url","nullable":true,"type":"string"},"use_as_facet":{"type":"boolean"}},"required":["field_type","label","name"],"type":"object"},"MetadataFieldBaseSchema":{"properties":{"auto_set":{"nullable":true,"type":"boolean"},"date_created":{"format":"date-time","type":"string"},"date_modified":{"format":"date-time","type":"string"},"description":{"type":"string"},"external_id":{"type":"string"},"field_type":{"type":"string"},"hide_if_not_set":{"nullable":true,"type":"boolean"},"is_block_field":{"type":"boolean"},"is_warning_field":{"type":"boolean"},"mapped_field_name":{"readOnly":true,"type":"string"},"max_value":{"type":"number"},"min_value":{"type":"number"},"multi":{"type":"boolean"},"options":{"items":{"$ref":"#/components/schemas/FieldOptionsSchema"},"type":"array"},"read_only":{"nullable":true,"type":"boolean"},"representative":{"type":"boolean"},"required":{"nullable":true,"type":"boolean"},"sortable":{"type":"boolean"},"source_url":{"description":"Will be used to upload MetadataField's `options`. Cannot be set or used as long as `options` are set.  **Example**: The value is `https://external-url.com/foo/`. In that case `GET` request will be sent to `https://external-url.com/foo/?user_id=uuid1&view_id=uuid1&field_name=bar&view_name=user_view&system_domain_id=uuid1`. Please note that some query parameters were added by *iconik* to get values that were predefined in your system for each user [user_id] and view [view_id]. Metadata field name [field_name], view's name [view_name] and system domain identifier [system_domain_id] will be also passed in each request. *iconik* will successfully parse the response from that URL if it will be sent in JSON formatted string: `{\"bar\": [{\"value\": \"1\", \"label\": \"1st\"}, {\"value\": \"2\", \"label\": \"2nd\"}]}`","format":"url","nullable":true,"type":"string"},"use_as_facet":{"type":"boolean"}},"required":["field_type"],"type":"object"},"MetadataFieldCreateSchema":{"properties":{"auto_set":{"nullable":true,"type":"boolean"},"date_created":{"format":"date-time","type":"string"},"date_modified":{"format":"date-time","type":"string"},"description":{"type":"string"},"external_id":{"type":"string"},"field_type":{"type":"string"},"hide_if_not_set":{"nullable":true,"type":"boolean"},"is_block_field":{"type":"boolean"},"is_warning_field":{"type":"boolean"},"label":{"type":"string"},"mapped_field_name":{"readOnly":true,"type":"string"},"max_value":{"type":"number"},"min_value":{"type":"number"},"multi":{"type":"boolean"},"name":{"type":"string"},"options":{"items":{"$ref":"#/components/schemas/FieldOptionsSchema"},"type":"array"},"read_only":{"nullable":true,"type":"boolean"},"representative":{"type":"boolean"},"required":{"nullable":true,"type":"boolean"},"sortable":{"type":"boolean"},"source_url":{"description":"Will be used to upload MetadataField's `options`. Cannot be set or used as long as `options` are set.  **Example**: The value is `https://external-url.com/foo/`. In that case `GET` request will be sent to `https://external-url.com/foo/?user_id=uuid1&view_id=uuid1&field_name=bar&view_name=user_view&system_domain_id=uuid1`. Please note that some query parameters were added by *iconik* to get values that were predefined in your system for each user [user_id] and view [view_id]. Metadata field name [field_name], view's name [view_name] and system domain identifier [system_domain_id] will be also passed in each request. *iconik* will successfully parse the response from that URL if it will be sent in JSON formatted string: `{\"bar\": [{\"value\": \"1\", \"label\": \"1st\"}, {\"value\": \"2\", \"label\": \"2nd\"}]}`","format":"url","nullable":true,"type":"string"},"use_as_facet":{"type":"boolean"}},"required":["field_type","label","name"],"type":"object"},"MetadataFieldMappingOptionSchema":{"properties":{"name":{"minLength":1,"type":"string"}},"required":["name"],"type":"object"},"MetadataFieldMappingOptionsSchema":{"properties":{"objects":{"items":{"$ref":"#/components/schemas/MetadataFieldMappingOptionSchema"},"type":"array"}},"required":["objects"],"type":"object"},"MetadataFieldMappingSchema":{"properties":{"field_type":{"readOnly":true,"type":"string"},"mapped_field_name":{"minLength":1,"type":"string"},"name":{"minLength":1,"type":"string"}},"required":["mapped_field_name","name"],"type":"object"},"MetadataFieldMappingUpdateSchema":{"properties":{"field_type":{"readOnly":true,"type":"string"},"mapped_field_name":{"minLength":1,"type":"string"},"name":{"readOnly":true,"type":"string"}},"required":["mapped_field_name"],"type":"object"},"MetadataFieldMappingsSchema":{"properties":{"objects":{"items":{"$ref":"#/components/schemas/MetadataFieldMappingSchema"},"type":"array"}},"type":"object"},"MetadataFieldSchema":{"properties":{"auto_set":{"nullable":true,"type":"boolean"},"date_created":{"format":"date-time","type":"string"},"date_modified":{"format":"date-time","type":"string"},"description":{"type":"string"},"external_id":{"type":"string"},"field_type":{"type":"string"},"hide_if_not_set":{"nullable":true,"type":"boolean"},"is_block_field":{"type":"boolean"},"is_warning_field":{"type":"boolean"},"label":{"type":"string"},"mapped_field_name":{"readOnly":true,"type":"string"},"max_value":{"type":"number"},"min_value":{"type":"number"},"multi":{"type":"boolean"},"name":{"readOnly":true,"type":"string"},"options":{"items":{"$ref":"#/components/schemas/FieldOptionsSchema"},"type":"array"},"read_only":{"nullable":true,"type":"boolean"},"representative":{"type":"boolean"},"required":{"nullable":true,"type":"boolean"},"sortable":{"type":"boolean"},"source_url":{"description":"Will be used to upload MetadataField's `options`. Cannot be set or used as long as `options` are set.  **Example**: The value is `https://external-url.com/foo/`. In that case `GET` request will be sent to `https://external-url.com/foo/?user_id=uuid1&view_id=uuid1&field_name=bar&view_name=user_view&system_domain_id=uuid1`. Please note that some query parameters were added by *iconik* to get values that were predefined in your system for each user [user_id] and view [view_id]. Metadata field name [field_name], view's name [view_name] and system domain identifier [system_domain_id] will be also passed in each request. *iconik* will successfully parse the response from that URL if it will be sent in JSON formatted string: `{\"bar\": [{\"value\": \"1\", \"label\": \"1st\"}, {\"value\": \"2\", \"label\": \"2nd\"}]}`","format":"url","nullable":true,"type":"string"},"use_as_facet":{"type":"boolean"}},"required":["field_type","label","name"],"type":"object"},"MetadataFieldValueSchema":{"properties":{"date_created":{"format":"date-time","nullable":true,"type":"string"},"field_values":{"items":{"type":"object"},"type":"array"},"mode":{"default":"overwrite","enum":["append","delete","overwrite"],"type":"string","writeOnly":true}},"type":"object"},"MetadataFieldsSchema":{"properties":{"first_url":{"readOnly":true,"type":"string"},"last_url":{"readOnly":true,"type":"string"},"next_url":{"readOnly":true,"type":"string"},"objects":{"items":{"$ref":"#/components/schemas/MetadataFieldSchema"},"readOnly":true,"type":"array"},"page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"pages":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"per_page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"prev_url":{"readOnly":true,"type":"string"},"total":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"readOnly":true,"type":"integer"}},"type":"object"},"MetadataValuesBatchSchema":{"properties":{"date_created":{"format":"date-time","type":"string"},"date_modified":{"format":"date-time","type":"string"},"metadata_values":{"additionalProperties":{"$ref":"#/components/schemas/MetadataFieldValueSchema"},"type":"object"},"object_ids":{"items":{"format":"uuid","type":"string"},"type":"array"},"object_type":{"type":"string"}},"required":["metadata_values","object_ids"],"type":"object"},"MetadataValuesObjectId":{"properties":{"id":{"format":"uuid","type":"string"},"metadata_values":{"additionalProperties":{"$ref":"#/components/schemas/MetadataFieldValueSchema"},"type":"object"}},"required":["id","metadata_values"],"type":"object"},"MetadataValuesObjectIdSchema":{"properties":{"id":{"format":"uuid","type":"string"},"metadata_values":{"additionalProperties":{"$ref":"#/components/schemas/MetadataFieldValueSchema"},"type":"object"}},"required":["id","metadata_values"],"type":"object"},"MetadataValuesSchema":{"properties":{"date_created":{"format":"date-time","nullable":true,"type":"string"},"date_modified":{"format":"date-time","nullable":true,"type":"string"},"job_id":{"format":"uuid","type":"string"},"metadata_values":{"additionalProperties":{"$ref":"#/components/schemas/MetadataFieldValueSchema"},"type":"object"},"object_id":{"format":"uuid","type":"string"},"object_type":{"type":"string"},"version_id":{"format":"uuid","type":"string"}},"required":["metadata_values"],"type":"object"},"MetadataView":{"properties":{"date_created":{"format":"date-time","type":"string"},"date_modified":{"format":"date-time","type":"string"},"description":{"nullable":true,"type":"string"},"id":{"format":"uuid","readOnly":true,"type":"string"},"name":{"type":"string"},"view_fields":{"items":{"$ref":"#/components/schemas/MetadataField"},"type":"array"}},"required":["name","view_fields"],"type":"object"},"MetadataViewCreateSchema":{"properties":{"description":{"nullable":true,"type":"string"},"id":{"format":"uuid","readOnly":true,"type":"string"},"name":{"type":"string"},"view_fields":{"items":{"$ref":"#/components/schemas/MetadataViewField"},"type":"array"},"write_access_for_everyone":{"type":"boolean"}},"required":["name","view_fields"],"type":"object"},"MetadataViewField":{"properties":{"auto_set":{"nullable":true,"type":"boolean"},"hide_if_not_set":{"nullable":true,"type":"boolean"},"label":{"nullable":true,"type":"string"},"mapped_field_name":{"readOnly":true,"type":"string"},"name":{"type":"string"},"options":{"items":{"$ref":"#/components/schemas/FieldOptionsSchema"},"nullable":true,"type":"array"},"read_only":{"nullable":true,"type":"boolean"},"required":{"nullable":true,"type":"boolean"},"source_url":{"description":"Will be used to upload MetadataField's `options`. Cannot be set or used as long as `options` are set.  **Example**: The value is `https://external-url.com/foo/`. In that case `GET` request will be sent to `https://external-url.com/foo/?user_id=uuid1&view_id=uuid1&field_name=bar&view_name=user_view&system_domain_id=uuid1`. Please note that some query parameters were added by *iconik* to get values that were predefined in your system for each user [user_id] and view [view_id]. Metadata field name [field_name], view's name [view_name] and system domain identifier [system_domain_id] will be also passed in each request. *iconik* will successfully parse the response from that URL if it will be sent in JSON formatted string: `{\"bar\": [{\"value\": \"1\", \"label\": \"1st\"}, {\"value\": \"2\", \"label\": \"2nd\"}]}`","format":"url","nullable":true,"type":"string"}},"required":["name"],"type":"object"},"MetadataViewFieldSchema":{"properties":{"auto_set":{"nullable":true,"type":"boolean"},"hide_if_not_set":{"nullable":true,"type":"boolean"},"label":{"nullable":true,"type":"string"},"mapped_field_name":{"readOnly":true,"type":"string"},"name":{"type":"string"},"options":{"items":{"$ref":"#/components/schemas/FieldOptionsSchema"},"nullable":true,"type":"array"},"read_only":{"nullable":true,"type":"boolean"},"required":{"nullable":true,"type":"boolean"},"source_url":{"description":"Will be used to upload MetadataField's `options`. Cannot be set or used as long as `options` are set.  **Example**: The value is `https://external-url.com/foo/`. In that case `GET` request will be sent to `https://external-url.com/foo/?user_id=uuid1&view_id=uuid1&field_name=bar&view_name=user_view&system_domain_id=uuid1`. Please note that some query parameters were added by *iconik* to get values that were predefined in your system for each user [user_id] and view [view_id]. Metadata field name [field_name], view's name [view_name] and system domain identifier [system_domain_id] will be also passed in each request. *iconik* will successfully parse the response from that URL if it will be sent in JSON formatted string: `{\"bar\": [{\"value\": \"1\", \"label\": \"1st\"}, {\"value\": \"2\", \"label\": \"2nd\"}]}`","format":"url","nullable":true,"type":"string"}},"required":["name"],"type":"object"},"MetadataViewForListSchema":{"properties":{"date_created":{"format":"date-time","type":"string"},"date_modified":{"format":"date-time","type":"string"},"description":{"nullable":true,"type":"string"},"id":{"format":"uuid","readOnly":true,"type":"string"},"name":{"type":"string"},"view_fields":{"items":{"$ref":"#/components/schemas/MetadataViewFieldSchema"},"type":"array"}},"required":["name","view_fields"],"type":"object"},"MetadataViewInputSchema":{"properties":{"description":{"nullable":true,"type":"string"},"id":{"format":"uuid","readOnly":true,"type":"string"},"name":{"type":"string"},"view_fields":{"items":{"$ref":"#/components/schemas/MetadataViewFieldSchema"},"type":"array"}},"required":["name","view_fields"],"type":"object"},"MetadataViewSchema":{"properties":{"date_created":{"format":"date-time","type":"string"},"date_modified":{"format":"date-time","type":"string"},"description":{"nullable":true,"type":"string"},"id":{"format":"uuid","readOnly":true,"type":"string"},"name":{"type":"string"},"view_fields":{"items":{"$ref":"#/components/schemas/MetadataFieldSchema"},"type":"array"}},"required":["name","view_fields"],"type":"object"},"MetadataViewsSchema":{"properties":{"objects":{"items":{"$ref":"#/components/schemas/MetadataViewForListSchema"},"readOnly":true,"type":"array"}},"type":"object"},"SegmentsCopyMapping":{"properties":{"destination_object_id":{"format":"uuid","type":"string"},"destination_version_id":{"format":"uuid","type":"string"},"source_object_id":{"format":"uuid","type":"string"},"source_version_id":{"format":"uuid","type":"string"}},"required":["destination_object_id","destination_version_id","source_object_id","source_version_id"],"type":"object"},"SegmentsCopyMappingSchema":{"properties":{"destination_object_id":{"format":"uuid","type":"string"},"destination_version_id":{"format":"uuid","type":"string"},"source_object_id":{"format":"uuid","type":"string"},"source_version_id":{"format":"uuid","type":"string"}},"required":["destination_object_id","destination_version_id","source_object_id","source_version_id"],"type":"object"}}},"info":{"title":"Iconik Metadata","version":"2.0.0"},"openapi":"3.0.3","paths":{"/":{},"/ip/":{},"/livez/":{},"/readyz/":{},"/spec/":{},"/static/{filename}":{},"/v1/assets/{asset_id}/versions/{version_id}/views/{view_id}/":{"get":{"description":"\nRequired roles:\n - can_read_metadata_values\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"version_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"view_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"query","name":"reencode_values_to_string","required":false,"schema":{"default":false,"type":"boolean"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetadataValuesSchema"}}},"description":"Returns a metadata values for object and view if it exists"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Metadata values for this object and view doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get object metadata by object type, object ID, version ID and view ID"}},"/v1/assets/{asset_id}/{object_type}/{object_id}/versions/{version_id}/views/{view_id}/":{"get":{"deprecated":true,"description":"\nRequired roles:\n - can_read_metadata_values\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"object_type","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"object_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"version_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"view_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetadataValuesSchema"}}},"description":"Returns a metadata values for object and view if it exists"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Metadata values for this object and view doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get asset metadata by object type, object ID, version ID and view ID"}},"/v1/assets/{asset_id}/{object_type}/{object_id}/views/{view_id}/":{"get":{"description":"\nRequired roles:\n - can_read_metadata_values\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"object_type","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"object_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"view_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"query","name":"reencode_values_to_string","required":false,"schema":{"default":false,"type":"boolean"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetadataValuesSchema"}}},"description":"Returns a metadata values for object and view if it exists"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Metadata values for this object and view doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get asset metadata by object type, object ID and view ID"},"put":{"description":"\nRequired roles:\n - can_write_metadata_values\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"object_type","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"object_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"view_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"query","name":"ignore_unchanged","required":false,"schema":{"type":"boolean"},"style":"form"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetadataValuesSchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetadataValuesSchema"}}},"description":"Returns a created metadata values for object and view"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Metadata view doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Edit view metadata values for sub-objects of an asset (Such as segments)"}},"/v1/copy/":{},"/v1/fields/":{"get":{"description":"\nRequired roles:\n - can_read_metadata_fields\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"The number of items for each page (Default 500)","in":"query","name":"per_page","schema":{"format":"int32","type":"integer"},"style":"form"},{"description":"If your request returns per_page entries, send the last value of \"name\" to fetch next page","in":"query","name":"last_field_name","schema":{"type":"string"},"style":"form"},{"description":"A comma separated list of fieldnames For example - first_name,last_name,salary","in":"query","name":"filter","schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetadataFieldsSchema"}}},"description":"Returns a list of metadata entities"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"List the fields defined in the system"},"post":{"description":"\nRequired roles:\n - can_write_metadata_fields\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetadataFieldCreateSchema"}}},"description":"body","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetadataFieldSchema"}}},"description":"Returns a created field"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Create a new field"}},"/v1/fields/{field_name}/":{"delete":{"description":"\nRequired roles:\n - can_delete_metadata_fields\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"field_name","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"204":{"description":"Without body"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Metadata field doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Delete a particular field by name"},"get":{"description":"\nRequired roles:\n - can_read_metadata_fields\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"field_name","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetadataFieldSchema"}}},"description":"Returns a field"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Metadata field doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Returns a particular field by name"},"patch":{"description":"\nRequired roles:\n - can_write_metadata_fields\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"field_name","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetadataFieldSchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetadataFieldSchema"}}},"description":"Returns an updated field"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Metadata field doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Update field by name"},"put":{"description":"\nRequired roles:\n - can_write_metadata_fields\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"field_name","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetadataFieldSchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetadataFieldSchema"}}},"description":"Returns an updated field"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Metadata field doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Update field by name"}},"/v1/mapping/fields/":{"post":{"description":"\nRequired roles:\n - can_read_metadata_fields\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetadataFieldMappingSchema"}}},"description":"body","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetadataFieldMappingSchema"}}},"description":"Returns a created field mapping"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Create a new metadata field mapping"}},"/v1/mapping/fields/{field_name}/":{"get":{"description":"\nRequired roles:\n - can_read_metadata_fields\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"field_name","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetadataFieldMappingSchema"}}},"description":"Returns the metadata field mapping"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get the metadata field mapping"}},"/v1/mapping/options/":{"get":{"description":"\nRequired roles:\n - can_read_metadata_fields\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetadataFieldMappingOptionsSchema"}}},"description":"Returns a list of metadata field mapping options"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"List the metadata field mapping options"}},"/v1/shares/custom_actions/{context}/{action_id}/views/":{"get":{"description":"","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Share-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Share-User-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"context","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"action_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetadataViewSchema"}}},"description":"Returns a view"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"403":{"description":"Custom actions not enabled for this share"},"404":{"description":"Metadata view doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Returns a particular view for a shared custom action context"}},"/v1/user/fields/":{"get":{"description":"\nRequired roles:\n - can_read_metadata_fields\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetadataFieldsSchema"}}},"description":"Returns a list of metadata fields"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"List the fields that can be accessed by a user"}},"/v1/views/":{"get":{"description":"\nRequired roles:\n - can_read_metadata_views\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetadataViewsSchema"}}},"description":"Returns a list of metadata views"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"List the views defined in the system"},"post":{"description":"\nRequired roles:\n - can_write_metadata_views\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetadataViewCreateSchema"}}},"description":"body","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetadataViewSchema"}}},"description":"Returns a created view"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Create a new view"}},"/v1/views/{view_id}/":{"delete":{"description":"\nRequired roles:\n - can_delete_metadata_views\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"view_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"204":{"description":"Without body"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Metadata view doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Delete a particular view by id"},"get":{"description":"\nRequired roles:\n - can_read_metadata_views\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"view_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"query","name":"merge_fields","required":false,"schema":{"default":true,"type":"boolean"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetadataViewSchema"}}},"description":"Returns a view"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Metadata view doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Returns a particular view by id"},"patch":{"description":"\nRequired roles:\n - can_write_metadata_views\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"view_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetadataViewInputSchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetadataViewSchema"}}},"description":"Returns an updated view"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Metadata view doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Update view"},"put":{"description":"\nRequired roles:\n - can_write_metadata_views\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"view_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetadataViewInputSchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetadataViewSchema"}}},"description":"Returns an updated view"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Metadata view doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Update view"}},"/v1/{object_type}/categories/":{"get":{"description":"\nRequired roles:\n - can_read_metadata_categories\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"object_type","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetadataCategoriesSchema"}}},"description":"Returns metadata categories for an object"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get metadata categories"},"post":{"description":"\nRequired roles:\n - can_write_metadata_categories\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"object_type","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetadataCategorySchema"}}},"description":"body","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetadataCategorySchema"}}},"description":"Returns a metadata category"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"409":{"description":"A category with the same name and object_type already exists"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Add a metadata category for an object type"}},"/v1/{object_type}/categories/{name}/":{"delete":{"description":"\nRequired roles:\n - can_delete_metadata_categories\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"object_type","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"name","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"204":{"description":"Without body"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Metadata category by object type and category name doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Delete metadata category by object type and category name"},"get":{"description":"\nRequired roles:\n - can_read_metadata_categories\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"object_type","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"name","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetadataCategorySchema"}}},"description":"Returns metadata category by object type and category name"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Metadata category by object type and category name doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get metadata category by object type and category name"},"put":{"description":"\nRequired roles:\n - can_write_metadata_categories\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"object_type","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"name","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetadataCategorySchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetadataCategorySchema"}}},"description":"Returns a metadata category"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Metadata category for this object type doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Edit metadata category for an object type"}},"/v1/{object_type}/categories/{name}/views/":{"get":{"description":"\nRequired roles:\n - can_read_metadata_categories\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"object_type","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"name","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"query","name":"ext_options","required":false,"schema":{"type":"boolean"},"style":"form"},{"in":"query","name":"writable_only","required":false,"schema":{"type":"boolean"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetadataCategorySchema"}}},"description":"Returns metadata views with field for object type and category"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Metadata views with field for object type and category doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get metadata views with field for object type and category"}},"/v1/{object_type}/content/views/{view_id}/":{"put":{"description":"\nRequired roles:\n - can_write_metadata_values\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"object_type","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"view_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionMetadataValuesBatchSchema"}}},"description":"body","required":true},"responses":{"202":{"description":"No body"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Metadata view doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Edit view metadata values for collection or saved search content."}},"/v1/{object_type}/views/{view_id}/":{"post":{"description":"\nRequired roles:\n - can_write_metadata_values\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"object_type","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"view_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateMetadataValuesBatchSchema"}}},"description":"body","required":true},"responses":{"202":{"description":"Batch metadata update was successfully scheduled"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Metadata view doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Add view metadata values for multiple objects (Assets, Collections or Segments)"},"put":{"description":"\nRequired roles:\n - can_write_metadata_values\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"object_type","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"view_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetadataValuesBatchSchema"}}},"description":"body","required":true},"responses":{"202":{"description":"Batch metadata update was successfully scheduled"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Metadata view doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Edit view metadata values for multiple objects (Assets, Collections or Segments)"}},"/v1/{object_type}/{object_id}/":{"get":{"description":"This endpoint is available only for admins","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"object_type","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"object_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"query","name":"check_if_subclip","required":false,"schema":{"type":"boolean"},"style":"form"},{"description":"Filter out metadata field values, for deleted fields","in":"query","name":"include_values_for_deleted_fields","schema":{"default":false,"type":"boolean"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":{"properties":{"name":{"type":"string"},"type":{"type":"string"},"values":{"items":{"properties":{"value":{"type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"example":{"ReleaseDate":{"name":"ReleaseDate","type":"date","values":[{"value":"2025-12-26"}]}},"type":"object"}}},"description":"Returns a metadata values for object and view if it exists"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Metadata values for this object don't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get object metadata by object type and object ID"},"put":{"description":"","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"object_type","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"object_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"query","name":"check_if_subclip","required":false,"schema":{"type":"boolean"},"style":"form"},{"in":"query","name":"ignore_unchanged","required":false,"schema":{"type":"boolean"},"style":"form"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetadataValuesSchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetadataValuesSchema"}}},"description":"Returns a created metadata values for object and view"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Metadata view doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Edit metadata values directly without a view. Admin access required."}},"/v1/{object_type}/{object_id}/views/{view_id}/":{"get":{"description":"\nRequired roles:\n - can_read_metadata_values\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"object_type","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"object_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"query","name":"check_if_subclip","required":false,"schema":{"type":"boolean"},"style":"form"},{"in":"path","name":"view_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"query","name":"reencode_values_to_string","required":false,"schema":{"default":false,"type":"boolean"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetadataValuesSchema"}}},"description":"Returns a metadata values for object and view if it exists"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Metadata values for this object and view doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get object metadata by object type, object ID and view ID"},"put":{"description":"\nRequired roles:\n - can_write_metadata_values\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"object_type","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"object_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"view_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"query","name":"check_if_subclip","required":false,"schema":{"type":"boolean"},"style":"form"},{"in":"query","name":"ignore_unchanged","required":false,"schema":{"type":"boolean"},"style":"form"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetadataValuesSchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetadataValuesSchema"}}},"description":"Returns a created metadata values for object and view"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Metadata view doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Edit view metadata values for a single object"}}},"servers":[{"url":"/API/metadata/"}]}