process metadata
/members/{member}/groups/{group}/metadata/{extension}/process [POST]
API Support | Available since | Last updated | Output |
---|---|---|---|
5.9500 | 6.2000 | xml |
Description
Process the files with the specified extension
to load their default metadata and set it on the corresponding URI. This service starts an Asynchronous process.
Default metadata is loaded using the corresponding PSML document template for the psml
extension or media template for other files.
The overwrite parameter can be used to preserve existing document metadata properties:
- if
false
, only new properties are added to the existing metadata. - if
true
, all existing metadata properties are overwritten and for a nonpsml
extension the document properties (title, docid, description, labels) are also overwritten.
Parameters
Name | Description | Required | Type | Default |
---|---|---|---|---|
document-type | The document type to process (required and only for the psml extension) | Maybe | string | |
overwrite | A flag to allow overwriting of existing metadata properties | no | boolean | false |
Permission
This service requires manager or higher in the group.
Response
XML output:
<metadata-process> <thread ... > ... </thread> </metadata-process>
Error Handling
No specific errors expected for this service.