This endpoint is in preview and may be modified or removed at any time.
To use this endpoint, add preview=true to the request query parameters.
Removes specified backing datasets from a View. Removing a dataset triggers a SNAPSHOT transaction on the next update. If a specified dataset does not exist, no error is thrown.
Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:datasets-write.
objectstringThe name of a Branch.
list<ViewBackingDataset>objectstringstringThe rid of the View.
stringThe unique resource identifier (RID) of a Folder.
stringThe branch name of the View. If not specified, defaults to master for most enrollments.
list<ViewBackingDataset>objectThe primary key of the dataset. Primary keys are treated as guarantees provided by the creator of the dataset.
1
2
3
4
5
curl -X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer $TOKEN" \
"https://$HOSTNAME/api/v2/datasets/views/ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da/removeBackingDatasets?preview=true" \
-d '{"backingDatasets":[{"datasetRid":"ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da","branch":"master"}],"branch":"master"}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
{
"datasetRid": "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da",
"parentFolderRid": "ri.compass.main.folder.c410f510-2937-420e-8ea3-8c9bcb3c1791",
"viewName": "My Dataset",
"backingDatasets": [
{
"datasetRid": "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da",
"branch": "master"
}
],
"branch": "master",
"primaryKey": {
"columns": [
"order_id"
]
}
}| Error Name | ||
|---|---|---|
Invalid | Error Code | INVALID_ARGUMENT |
| Status Code | 400 | |
| Description | Either you do not have access to one or more of the backing datasets or it does not exist. | |
| Parameters | | |
View | Error Code | NOT_FOUND |
| Status Code | 404 | |
| Description | The requested View could not be found. Either the view does not exist, the branch is not valid or the client token does not have access to it. | |
| Parameters | viewDatasetRid, branch | |
Input | Error Code | INVALID_ARGUMENT |
| Status Code | 400 | |
| Description | One or more backing datasets do not live in the same project as the view. Either move the input datasets to the same project as the view or add them as project references. | |
| Parameters | | |
Remove | Error Code | PERMISSION_DENIED |
| Status Code | 403 | |
| Description | Could not removeBackingDatasets the View. | |
| Parameters | viewDatasetRid | |
See Errors for a general overview of errors in the platform.