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.
Create a new View.
Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:datasets-write.
objectstringThe unique resource identifier (RID) of a Folder.
stringlist<ViewBackingDataset>stringThe branch name of the View. If not specified, defaults to master for most enrollments.
objectThe primary key of the dataset. Primary keys are treated as guarantees provided by the creator of the dataset.
objectThe created View
stringstringThe 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?preview=true" \
-d '{"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"]}}'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 | ||
|---|---|---|
Create | Error Code | PERMISSION_DENIED |
| Status Code | 403 | |
| Description | The provided token does not have permission to create a dataset in this folder. | |
| Parameters | parentFolderRid, name | |
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 | |
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 | INVALID_ARGUMENT |
| Status Code | 400 | |
| Description | No columns were provided as part of the primary key | |
| Parameters | | |
View | Error Code | INVALID_ARGUMENT |
| Status Code | 400 | |
| Description | Cannot add a primary key to a View that does not have any backing datasets. | |
| Parameters | | |
View | Error Code | INTERNAL |
| Status Code | 500 | |
| Description | Failed to delete dataset following View creation failure. | |
| Parameters | viewDatasetRid | |
Resource | Error Code | CONFLICT |
| Status Code | 409 | |
| Description | The provided resource name is already in use by another resource in the same folder. | |
| Parameters | parentFolderRid, displayName | |
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 | | |
Create | Error Code | PERMISSION_DENIED |
| Status Code | 403 | |
| Description | Could not create the View. | |
| Parameters | | |
Folder | Error Code | NOT_FOUND |
| Status Code | 404 | |
| Description | The given Folder could not be found. | |
| Parameters | folderRid | |
See Errors for a general overview of errors in the platform.