The UPDATE_METADATA action is used to update the metadata of a file or a folder.
The input parameters for UPDATE_METADATA are:
Parameter | Type | Required | Description |
---|---|---|---|
file | Array<json>, JSON | Optional | ACS file to be updated. If the received value contains multiple files, only the first of them will be processed. |
folder | Array<json>, JSON | Optional | ACS folder to be updated. If the received value contains multiple references to folders, only the first of them will be used.. |
metadata | JSON | Required | AMetadata to be set to the node in ACS. Metadata is a JSON object that contains key-value pairs, each of them holding a property name (e.g. 'cm:title') and a property value (e.g: 'Introduction to AWS'). |
nodeId | String | Optional | Node ID of the file or folder in ACS. Example: a6a977a6-c728-4038-8dbc-d914c4d8cfb3. |
path | String | Optional | Node ID of the file or folder in ACS. For example, a6a977a6-c728-4038-8dbc-d914c4d8cfb3. |
underscoreMetadata | Boolean | Optional | If underscoreMetadata is true, the received prefixed properties names contain underscore (_) instead of colon (:) for separating the namespace prefix from the property name. E.g. 'cm_title' instead of 'cm:title'. |
The output parameters from UPDATE_METADATA are:
Parameter | Type | Required | Description |
---|---|---|---|
response | Array<json> | Optional | Response for the calls. |