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.
Creates a new Virtual Table from an upstream table. The VirtualTable will be created in the specified parent folder and can be queried through Foundry's data access APIs.
Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:connectivity-virtual-table-write.
stringThe Resource Identifier (RID) of a Connection (also known as a source).
objectlist<MarkingId>stringThe unique resource identifier (RID) of a Folder.
stringThe name of a VirtualTable.
unionobjectThe created VirtualTable
stringThe Resource Identifier (RID) of a registered VirtualTable.
stringThe name of a VirtualTable.
stringThe unique resource identifier (RID) of a Folder.
unionlist<MarkingId>1
2
3
4
5
curl -X POST \
\t-H "Content-type: application/json" \
\t-H "Authorization: Bearer $TOKEN" \
"https://$HOSTNAME/api/v2/connectivity/connections/ri.magritte..source.c078b71b-92f9-41b6-b0df-3760f411120b/virtualTables?preview=true" \
-d '{"markings":["18212f9a-0e63-4b79-96a0-aae04df23336"],"parentRid":"ri.compass.main.folder.c410f510-2937-420e-8ea3-8c9bcb3c1791","name":"my_table"}'1
2
3
4
5
6
7
8
{
"markings": [
"18212f9a-0e63-4b79-96a0-aae04df23336"
],
"parentRid": "ri.compass.main.folder.c410f510-2937-420e-8ea3-8c9bcb3c1791",
"name": "my_table",
"rid": "ri.foundry.main.table.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da"
}| Error Name | ||
|---|---|---|
Invalid | Error Code | INVALID_ARGUMENT |
| Status Code | 400 | |
| Description | The specified connection is invalid or inaccessible. | |
| Parameters | connection, reason | |
Virtual | Error Code | CONFLICT |
| Status Code | 409 | |
| Description | A VirtualTable with the same name already exists in the parent folder. | |
| Parameters | parentRid, name | |
Virtual | Error Code | PERMISSION_DENIED |
| Status Code | 403 | |
| Description | User lacks permission to use the specified connection for virtual table registration. | |
| Parameters | | |
Create | Error Code | PERMISSION_DENIED |
| Status Code | 403 | |
| Description | Could not create the VirtualTable. | |
| Parameters | connectionRid | |
Connection | Error Code | NOT_FOUND |
| Status Code | 404 | |
| Description | The given Connection could not be found. | |
| Parameters | connectionRid | |
See Errors for a general overview of errors in the platform.