# Update Workset

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.

 

<figure><img src="/files/lzLlJKCGhQFDvSGCy9rt" alt=""><figcaption><p>Update workset API call</p></figcaption></figure>

&#x20;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.

&#x20;

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.

&#x20;

```
{
    "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"
            }            
            }                      
        ]
    }
}
```

&#x20;

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’.&#x20;

&#x20;

<figure><img src="/files/EuQfIG1KyTSzefRzUnGw" alt=""><figcaption><p>Update workset return message (successful)</p></figcaption></figure>

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.

&#x20;

<figure><img src="/files/0gXT7aEIl7mPYRHApZCb" alt=""><figcaption><p>Updated workset showing changes in TDO</p></figcaption></figure>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.apica.io/platform-docs/test-data-orchestrator-tdo/user-documentation/api-guide/workset-apis/update-workset.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.