Document metadata [VC 21.3 GEN]

GET /document Retrieves the list of metadata documents. Query Parameters: first (integer) – Return documents from that number in the document list. Default is 1. number (integer) – Return at most that number of documents. Default is 100. Produces: application/xml, application/json – DocumentListDocument Role: _document_read

GET /document/(name) Retrieves the document with the specified name. This resource shares the same query parameters as the item metadata resource. Query Parameters: interval (string) – Comma-separated list time-span - Filter out metadata, return only metadata for specified time span. generic - Return all non-timed metadata. all (default) - Return all metadata, same as interval=generic,-INF-+INF result - Can be used when retrieving metadata from a search result. Will return time spans that overlap with the search result. (New in 5.5.) field (string) – Comma-separated list. field-name - Return specified field. field-name “:” new-name - Return specified field, renamed to a new name in return value. ”-” field-name - Exclude specified field. (default) - Return all fields. group (string) – Comma-separated list. group-name - Return specified group. group-name + - Return specified group and subgroups. group-name : new-name - Return specified group, renamed to a new name in return value. - group-name - Exclude specified group. (default) - Return all groups. track (string) – Comma-separated list. track-type track-number - Return metadata for specified track. Example of track is A2. track-type t1 - t2 - Return metadata for specified track interval, e.g. A2-4. track-type * - Return metadata for all tracks of specified type, e.g. A*. generic - Return all non-tracked metadata. all (default) - All metadata, with or without track specification, are returned. language (string) – Comma-separated list. language-tag - Return metadata for specific language, e.g. en_US. Wildcards may be used, e.g. *_CA for both Canadian French and Canadian English. none - Return all metadata without language specification. all (default) - Return all metadata, with or without language specification. samplerate (string) – Convert all outgoing time instants to specified rate. NB! Time codes which cannot be expressed in an integer number of samples will be returned as a decimal number, with risk of losing precision. conflict (string) – yes (default) - Include all metadata conflicts, unresolved. no - Return conflicts resolved according to field rules. include (string) – A list of keys. Includes additional field specific data. Additionally, if set to type the type definition of the field will be retrieved. defaultValue (boolean) – true - For unset fields, return default values. false (default) - Do not return default values. Produces: application/xml, application/json – MetadataDocument Role: _document_read

PUT /document/(name) Creates a new or modifies the existing document with the specified name. Query Parameters: revision (string) – The known revision. If not specified, the change set will attempt to override existing change sets. skipForbidden (boolean) – Skip fields or groups that the user doesn’t have write access to. Default is false. Accepts: application/xml, application/json – MetadataDocument Produces: application/xml, application/json – MetadataDocument Role: _document_write

PUT /document Searches for documents matching a provided ItemSearchDocument. Note that document indexing is disabled by default. Make sure to enable document indexing using indexDocumentMetadata and trigger a reindex so that any existing documents are added to the index. New in version 5.0. Query Parameters: first (integer) – Start returning results from this index. Default is 1. number (integer) – Return at most this number of documents. Default is 100. count (boolean) – true (default) - Return hits in result. false - Do not return hits in result, in order to produce results faster. Accepts: application/xml, application/json – ItemSearchDocument Produces: application/xml, application/json – SearchResultDocument

GET /document/(name)/changes Retrieves all change sets that have been applied to the document. Query Parameters: change (string) – Retrieve a single change set. first (integer) – Return change sets from that number in the list of sorted change sets. Default is 1. number (integer) – Return at most that number of change sets. Default is all change sets. Response Headers: Link – Contains URLs to the previous, next, first and last pages. Produces: application/xml, application/json – MetadataChangeSetDocument Role: _document_read

DELETE /document/(name) Removes the metadata document with the specified name. Role: _document_write