The ADD_ASPECT action is used to add an aspect to a file or folder.
The input parameters for ADD_ASPECT are:
| Parameter | Type | Required | Description |
|---|---|---|---|
| aspect | String | Optional | Aspect to be assigned to the node, for example rv:reviewable. |
| 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. |
| nodeId | String | Optional | Node ID of the file or folder in ACS. Example: a6a977a6-c728-4038-8dbc-d914c4d8cfb3. |
| noteMetadata | JSON | Optional | Metadata 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 (for example, cm:title) and a property value (for example, Introduction to AWS). |
| 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 ADD_ASPECT are:
| Parameter | Type | Required | Description |
|---|---|---|---|
| response | Array<json> | Optional | Response for the calls. |