The LOCK_NODE action is used to lock a file or folder so that it cannot be edited.
The input parameters for LOCK_NODE 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. |
| lifetime | String | Required | Lifetime of the lock. Possible values are: EPHEMERAL or PERSISTENT. |
| lockType | String | Required | Lock type. Possible values are FULL, ALLOW_OWNER_CHANGES or ALLOW_ADD_CHILDREN. |
| 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. |
| timeToExpire | Integer | Required | Time (in second) after which the lock is expired. E.g. 1200. |
The output parameters from LOCK_NODE are:
| Parameter | Type | Required | Description |
|---|---|---|---|
| response | Array<json> | Optional | Response for the calls. |