Workspaces
Workspace and lineage discovery.
Operations
Each operation lists its specific responses. See Common error responses for errors shared by every operation on this page.
List workspaces
GET /api/v1/workspaces
Operation ID: listWorkspaces
Effect: read
Confirmation: never
Required privilege: USE_WORKSPACE
Focused reference: JSON · Markdown
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
limit |
query | No | integer | |
pageToken |
query | No | string |
Responses
| Status | Description |
|---|---|
200 |
The request has succeeded. |
Get a workspace
GET /api/v1/workspaces/{workspace}
Operation ID: getWorkspace
Effect: read
Confirmation: never
Required privilege: VIEW_ITEM
Focused reference: JSON · Markdown
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
workspace |
path | Yes | string |
Responses
| Status | Description |
|---|---|
200 |
The request has succeeded. |
Get the active asset graph
GET /api/v1/workspaces/{workspace}/active-asset-graph
Operation ID: getWorkspaceActiveAssetGraph
Effect: read
Confirmation: never
Required privilege: USE_WORKSPACE
Focused reference: JSON · Markdown
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
workspace |
path | Yes | string |
Responses
| Status | Description |
|---|---|
200 |
The request has succeeded. |
List workspace asset edges
GET /api/v1/workspaces/{workspace}/asset-edges
Operation ID: listWorkspaceAssetEdges
Effect: read
Confirmation: never
Required privilege: USE_WORKSPACE
Focused reference: JSON · Markdown
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
workspace |
path | Yes | string | |
limit |
query | No | integer | |
pageToken |
query | No | string |
Responses
| Status | Description |
|---|---|
200 |
The request has succeeded. |
List workspace assets
GET /api/v1/workspaces/{workspace}/assets
Operation ID: listWorkspaceAssets
Effect: read
Confirmation: never
Required privilege: USE_WORKSPACE
Focused reference: JSON · Markdown
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
workspace |
path | Yes | string | |
type |
query | No | string | |
q |
query | No | string | |
limit |
query | No | integer | |
pageToken |
query | No | string |
Responses
| Status | Description |
|---|---|
200 |
The request has succeeded. |
Describe a workspace asset
GET /api/v1/workspaces/{workspace}/assets/{assetId}
Operation ID: getWorkspaceAsset
Effect: read
Confirmation: never
Required privilege: VIEW_ITEM
Focused reference: JSON · Markdown
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
workspace |
path | Yes | string | |
assetId |
path | Yes | string |
Responses
| Status | Description |
|---|---|
200 |
The request has succeeded. |
Get workspace asset lineage
GET /api/v1/workspaces/{workspace}/assets/{assetId}/lineage
Operation ID: getWorkspaceAssetLineage
Effect: read
Confirmation: never
Required privilege: VIEW_ITEM
Focused reference: JSON · Markdown
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
workspace |
path | Yes | string | |
assetId |
path | Yes | string |
Responses
| Status | Description |
|---|---|
200 |
The request has succeeded. |
Common error responses
These error responses apply to every operation on this page.
| Status | Description |
|---|---|
400 |
The server could not understand the request due to invalid syntax. |
401 |
Access is unauthorized. |
403 |
Access is forbidden. |
404 |
The server cannot find the requested resource. |
409 |
The request conflicts with the current state of the server. |
412 |
Precondition failed. |
413 |
Client error |
415 |
Client error |
422 |
Client error |
429 |
Client error |
500 |
Server error |
502 |
Server error |
503 |
Service unavailable. |