Update Workset
Last updated
Last updated
This API is used to update worksets, either by changing the datablock underlying the data view or by adding a new data view. It is sent as a PATCH call.
There is one difference between the body of the ‘create’ and ‘update’ calls. The first is that the initial part of the ‘entity’ section [defines the workset name, the primary data view, and underlying coverage set] is replaced by a single line, ‘id’, that contains the TDO id for the workset being upated. This id can be found in the return message of the create, get all, and get details APIs.
Also, to perform the update, you need to be making a change. Here, we have changed the name of the data block underlying the customer data view from ‘imp_customers 1.0.0’ to ‘customers 1.0.0’. We have also added a new data view, ‘clh_view’ to the workset.
{
"context": {
"user": "mbj_test",
"password": "xxxx",
"project": {
"name": "imp_payments_demo",
"version": "1.0"
}
},
"entity": {
"id": "6761ae6d98cd8a04d7f4e959",
"dataViews": [
{
"view": {
"name": "cust_data_view",
"version": "1.0"
},
"dataSet": {
"name": "customers",
"version": "1.0.0"
}
},
{
"view": {
"name": "acts_view",
"version": "1.0"
},
"dataSet": {
"name": "imp_accounts",
"version": "1.0.0"
}
},
{
"view": {
"name": "clh_view",
"version": "1.0"
},
"dataSet": {
"name": "clh_view",
"version": "1.0.0"
}
}
]
}
}
The return message contains the information on what was sent to TDO, including the updated views. The workset id (in the response message) has remained the same, but the workset version is now returned as ‘1.1’.
Looking at the workset in TDO, we can see the changes that were made to the workset. The version has incremented to 1.1, the file for ‘cust_data_view’ has changed, and the ‘clh_view’ has been added to the workset.
