Unlock Workset
Last updated
Last updated
This call is used to remove a lock placed on a workset. In TDO, you can see that the workset ‘api_workset’ has a lock placed by user ‘mbj_test’. Note that locks can be removed under two circumstances: the user who placed the lock can remove their own lock. In addition, an Admin user can remove any lock.
NOTE: there is no API call to place a lock on a workset; this lock is placed when you run the data assembly process (either via the UI or API).
This API is sent as a PATCH call. The call includes the instruction ‘unlock’ and the id of the workset to have the lock removed.
The body is the same as the body for the Get Details API.
{
"context": {
"user": "mbj_test",
"password": "xxxx",
"project": {
"name": "imp_payments_demo",
"version": "1.0"
}
}
}
The return message shows that the lock has been removed (last fields) where the ‘lockedBy’ and ‘lockDateTime’ fields are blank/null and the ‘lockTimeout’ is ‘-1.
Viewing the workset screen in TDO after this API has been run, you can see that there is no longer a lock present on this workset (no value in the ‘locked by’ column).
