Delete Workset

This API deletes an existing workset. As the workset ID is passed in the URL, you can only delete one workset at a time. It is run as a DELETE call. This API can only be run by a user with Admin privileges; all other users will get a return message that they do not have proper authorization to perform this function.

Delete workset API

The body is the same body as the other simple calls (other than ‘create’ and ‘update’).

 {
    "context": {
        "user": "mbj_test",
        "password": "xxxx",
        "project": {
            "name": "imp_payments_demo",
            "version": "1.0"
        }
    }
}

Here is the workset listing prior to running this call. The ID in the call URL is for the ‘cloned_workset’.

Workset list from TDO

When run, the response contains the result (‘0’ for false and ‘1’ for true). A response of ‘1’ indicates that the workset has been deleted.

Results message for delete workset API

When viewing the workset listing in TDO, the workset ‘cloned_workset’ is no longer present.

TDO workset list showing successful deletion