{ "schemaVersion": 1, "apiVersion": "1.0.0", "operations": [ { "operationId": "abortManagedDataS3MultipartUpload", "method": "POST", "path": "/api/v1/projects/{project}/connections/{connection}/upload-sessions/{uploadSession}/s3-multipart-uploads/{multipartUpload}/abort", "summary": "Abort an S3 multipart upload", "description": "", "tags": [ "Managed Data" ], "effect": "write", "confirmation": "conditional", "authorization": { "mode": "privilege", "privilege": "INGEST_DATA" }, "parameters": [ { "name": "project", "in": "path", "required": true, "description": "", "schema": { "maxLength": 128, "minLength": 1, "type": "string" } }, { "name": "connection", "in": "path", "required": true, "description": "", "schema": { "maxLength": 128, "minLength": 1, "type": "string" } }, { "name": "uploadSession", "in": "path", "required": true, "description": "", "schema": { "maxLength": 160, "minLength": 1, "type": "string" } }, { "name": "multipartUpload", "in": "path", "required": true, "description": "", "schema": { "maxLength": 160, "minLength": 1, "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "", "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/ManagedDataS3MultipartUploadResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "addGroupMember", "method": "PUT", "path": "/api/v1/workspaces/{workspace}/groups/{group}/members/{principal}", "summary": "Add a group member", "description": "", "tags": [ "Access" ], "effect": "idempotent-write", "confirmation": "conditional", "authorization": { "mode": "privilege", "privilege": "MANAGE_GRANTS" }, "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "group", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "principal", "in": "path", "required": true, "description": "", "schema": { "type": "string" } } ], "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/StatusResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "archiveAgentConversation", "method": "DELETE", "path": "/api/v1/agent/conversations/{conversation}", "summary": "Archive an agent conversation", "description": "", "tags": [ "Agent" ], "effect": "destructive", "confirmation": "required", "authorization": { "mode": "privilege", "privilege": "USE_AGENT" }, "parameters": [ { "name": "conversation", "in": "path", "required": true, "description": "", "schema": { "type": "string" } } ], "responses": [ { "status": "204", "description": "There is no content to send for this request, but the headers may be useful. ", "content": [] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "cancelAgentRun", "method": "POST", "path": "/api/v1/agent/conversations/{conversation}/runs/{run}/cancel", "summary": "Cancel an agent run", "description": "", "tags": [ "Agent" ], "effect": "write", "confirmation": "conditional", "authorization": { "mode": "privilege", "privilege": "USE_AGENT" }, "parameters": [ { "name": "conversation", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "run", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "", "schema": { "maxLength": 200, "minLength": 1, "type": "string" } } ], "responses": [ { "status": "202", "description": "The request has been accepted for processing, but processing has not yet completed.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/AgentRunResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "cancelDeployment", "method": "POST", "path": "/api/v1/projects/{project}/deployments/{deployment}/cancel", "summary": "Cancel a deployment before cutover", "description": "", "tags": [ "Deployments" ], "effect": "write", "confirmation": "conditional", "authorization": { "mode": "privilege", "privilege": "ACTIVATE_DEPLOYMENT" }, "parameters": [ { "name": "project", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "deployment", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "", "schema": { "maxLength": 200, "minLength": 1, "type": "string" } } ], "responses": [ { "status": "202", "description": "The request has been accepted for processing, but processing has not yet completed.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/DeploymentResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "cancelManagedDataUploadSession", "method": "POST", "path": "/api/v1/projects/{project}/connections/{connection}/upload-sessions/{uploadSession}/cancel", "summary": "Cancel a managed-data upload session", "description": "", "tags": [ "Managed Data" ], "effect": "write", "confirmation": "conditional", "authorization": { "mode": "privilege", "privilege": "INGEST_DATA" }, "parameters": [ { "name": "project", "in": "path", "required": true, "description": "", "schema": { "maxLength": 128, "minLength": 1, "type": "string" } }, { "name": "connection", "in": "path", "required": true, "description": "", "schema": { "maxLength": 128, "minLength": 1, "type": "string" } }, { "name": "uploadSession", "in": "path", "required": true, "description": "", "schema": { "maxLength": 160, "minLength": 1, "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "", "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/ManagedDataUploadSessionResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "cancelRefreshRun", "method": "POST", "path": "/api/v1/workspaces/{workspace}/refresh-runs/{run}/cancel", "summary": "Cancel a refresh run", "description": "", "tags": [ "Refresh Runs" ], "effect": "write", "confirmation": "conditional", "authorization": { "mode": "privilege", "privilege": "USE_WORKSPACE" }, "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "run", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "", "schema": { "maxLength": 200, "minLength": 1, "type": "string" } } ], "responses": [ { "status": "202", "description": "The request has been accepted for processing, but processing has not yet completed.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/RefreshRunResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "checkAuthorizationBatch", "method": "POST", "path": "/api/v1/workspaces/{workspace}/authorization-checks", "summary": "Check multiple authorization decisions", "description": "", "tags": [ "Access" ], "effect": "write", "confirmation": "conditional", "authorization": { "mode": "privilege", "privilege": "USE_WORKSPACE" }, "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "", "schema": { "type": "string" } } ], "requestBody": { "required": true, "description": "", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/AuthorizationBatchCheckRequest" } } ] }, "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/AuthorizationBatchCheckResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "completeManagedDataS3MultipartUpload", "method": "POST", "path": "/api/v1/projects/{project}/connections/{connection}/upload-sessions/{uploadSession}/s3-multipart-uploads/{multipartUpload}/complete", "summary": "Complete an S3 multipart upload", "description": "", "tags": [ "Managed Data" ], "effect": "write", "confirmation": "conditional", "authorization": { "mode": "privilege", "privilege": "INGEST_DATA" }, "parameters": [ { "name": "project", "in": "path", "required": true, "description": "", "schema": { "maxLength": 128, "minLength": 1, "type": "string" } }, { "name": "connection", "in": "path", "required": true, "description": "", "schema": { "maxLength": 128, "minLength": 1, "type": "string" } }, { "name": "uploadSession", "in": "path", "required": true, "description": "", "schema": { "maxLength": 160, "minLength": 1, "type": "string" } }, { "name": "multipartUpload", "in": "path", "required": true, "description": "", "schema": { "maxLength": 160, "minLength": 1, "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "", "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "requestBody": { "required": true, "description": "", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/ManagedDataS3MultipartCompleteRequest" } } ] }, "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/ManagedDataS3MultipartUploadResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "createAgentConversation", "method": "POST", "path": "/api/v1/agent/conversations", "summary": "Create an agent conversation", "description": "", "tags": [ "Agent" ], "effect": "write", "confirmation": "conditional", "authorization": { "mode": "privilege", "privilege": "USE_AGENT" }, "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "description": "", "schema": { "maxLength": 200, "minLength": 1, "type": "string" } } ], "requestBody": { "required": true, "description": "", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/AgentConversationCreateRequest" } } ] }, "responses": [ { "status": "201", "description": "The request has succeeded and a new resource has been created as a result.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/AgentConversationResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "createAgentRun", "method": "POST", "path": "/api/v1/agent/conversations/{conversation}/runs", "summary": "Create an asynchronous agent run", "description": "", "tags": [ "Agent" ], "effect": "write", "confirmation": "conditional", "authorization": { "mode": "privilege", "privilege": "USE_AGENT" }, "parameters": [ { "name": "conversation", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "", "schema": { "maxLength": 200, "minLength": 1, "type": "string" } } ], "requestBody": { "required": true, "description": "", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/AgentRunCreateRequest" } } ] }, "responses": [ { "status": "202", "description": "The request has been accepted for processing, but processing has not yet completed.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/AgentRunResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "createCurrentAPIToken", "method": "POST", "path": "/api/v1/me/api-tokens", "summary": "Create current API token", "description": "", "tags": [ "Current User" ], "effect": "write", "confirmation": "conditional", "authorization": { "mode": "privilege", "privilege": "MANAGE_GRANTS" }, "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "description": "", "schema": { "maxLength": 200, "minLength": 1, "type": "string" } } ], "requestBody": { "required": true, "description": "", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/APITokenCreateRequest" } } ] }, "responses": [ { "status": "201", "description": "The request has succeeded and a new resource has been created as a result.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/APITokenCreateResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "createDataPolicy", "method": "POST", "path": "/api/v1/workspaces/{workspace}/data-policies", "summary": "Create a data policy", "description": "", "tags": [ "Access" ], "effect": "write", "confirmation": "conditional", "authorization": { "mode": "privilege", "privilege": "MANAGE_GRANTS" }, "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "", "schema": { "maxLength": 200, "minLength": 1, "type": "string" } } ], "requestBody": { "required": true, "description": "", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/DataPolicyRequest" } } ] }, "responses": [ { "status": "201", "description": "The request has succeeded and a new resource has been created as a result.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/DataPolicyResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "createDeployment", "method": "POST", "path": "/api/v1/projects/{project}/deployments", "summary": "Deploy a ready project release", "description": "", "tags": [ "Deployments" ], "effect": "write", "confirmation": "conditional", "authorization": { "mode": "privilege", "privilege": "ACTIVATE_DEPLOYMENT" }, "parameters": [ { "name": "project", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "", "schema": { "maxLength": 200, "minLength": 1, "type": "string" } } ], "requestBody": { "required": true, "description": "", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/DeploymentCreateRequest" } } ] }, "responses": [ { "status": "202", "description": "The request has been accepted for processing, but processing has not yet completed.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/DeploymentResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "createGrant", "method": "POST", "path": "/api/v1/workspaces/{workspace}/grants", "summary": "Create a grant", "description": "", "tags": [ "Access" ], "effect": "write", "confirmation": "conditional", "authorization": { "mode": "privilege", "privilege": "MANAGE_GRANTS" }, "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "", "schema": { "maxLength": 200, "minLength": 1, "type": "string" } } ], "requestBody": { "required": true, "description": "", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/GrantRequest" } } ] }, "responses": [ { "status": "201", "description": "The request has succeeded and a new resource has been created as a result.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/GrantResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "createGroup", "method": "POST", "path": "/api/v1/workspaces/{workspace}/groups", "summary": "Create a group", "description": "", "tags": [ "Access" ], "effect": "write", "confirmation": "conditional", "authorization": { "mode": "privilege", "privilege": "MANAGE_GRANTS" }, "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "", "schema": { "maxLength": 200, "minLength": 1, "type": "string" } } ], "requestBody": { "required": true, "description": "", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/GroupCreateRequest" } } ] }, "responses": [ { "status": "201", "description": "The request has succeeded and a new resource has been created as a result.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/GroupResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "createManagedDataS3MultipartUpload", "method": "POST", "path": "/api/v1/projects/{project}/connections/{connection}/upload-sessions/{uploadSession}/s3-multipart-uploads", "summary": "Create an S3 multipart upload for a session file", "description": "", "tags": [ "Managed Data" ], "effect": "write", "confirmation": "conditional", "authorization": { "mode": "privilege", "privilege": "INGEST_DATA" }, "parameters": [ { "name": "project", "in": "path", "required": true, "description": "", "schema": { "maxLength": 128, "minLength": 1, "type": "string" } }, { "name": "connection", "in": "path", "required": true, "description": "", "schema": { "maxLength": 128, "minLength": 1, "type": "string" } }, { "name": "uploadSession", "in": "path", "required": true, "description": "", "schema": { "maxLength": 160, "minLength": 1, "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "", "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "requestBody": { "required": true, "description": "", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/ManagedDataS3MultipartCreateRequest" } } ] }, "responses": [ { "status": "201", "description": "The request has succeeded and a new resource has been created as a result.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/ManagedDataS3MultipartUploadResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "createManagedDataUploadSession", "method": "POST", "path": "/api/v1/projects/{project}/connections/{connection}/upload-sessions", "summary": "Create a managed-data upload session from a canonical manifest", "description": "", "tags": [ "Managed Data" ], "effect": "write", "confirmation": "conditional", "authorization": { "mode": "privilege", "privilege": "INGEST_DATA" }, "parameters": [ { "name": "project", "in": "path", "required": true, "description": "", "schema": { "maxLength": 128, "minLength": 1, "type": "string" } }, { "name": "connection", "in": "path", "required": true, "description": "", "schema": { "maxLength": 128, "minLength": 1, "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "", "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "requestBody": { "required": true, "description": "", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/ManagedDataUploadSessionCreateRequest" } } ] }, "responses": [ { "status": "201", "description": "The request has succeeded and a new resource has been created as a result.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/ManagedDataUploadSessionResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "createPrincipal", "method": "POST", "path": "/api/v1/principals", "summary": "Create a local principal", "description": "", "tags": [ "Access" ], "effect": "write", "confirmation": "conditional", "authorization": { "mode": "privilege", "privilege": "MANAGE_GRANTS" }, "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "description": "", "schema": { "maxLength": 200, "minLength": 1, "type": "string" } } ], "requestBody": { "required": true, "description": "", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/PrincipalCreateRequest" } } ] }, "responses": [ { "status": "201", "description": "The request has succeeded and a new resource has been created as a result.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/LocalPasswordResetResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "createRefreshRun", "method": "POST", "path": "/api/v1/workspaces/{workspace}/refresh-runs", "summary": "Create a refresh run", "description": "", "tags": [ "Refresh Runs" ], "effect": "write", "confirmation": "conditional", "authorization": { "mode": "privilege", "privilege": "USE_WORKSPACE" }, "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "", "schema": { "maxLength": 200, "minLength": 1, "type": "string" } } ], "requestBody": { "required": true, "description": "", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/RefreshRunCreateRequest" } } ] }, "responses": [ { "status": "202", "description": "The request has been accepted for processing, but processing has not yet completed.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/RefreshRunResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "createRelease", "method": "POST", "path": "/api/v1/projects/{project}/releases", "summary": "Create a draft project release", "description": "", "tags": [ "Releases" ], "effect": "write", "confirmation": "conditional", "authorization": { "mode": "privilege", "privilege": "DEPLOY" }, "parameters": [ { "name": "project", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "", "schema": { "maxLength": 200, "minLength": 1, "type": "string" } } ], "requestBody": { "required": true, "description": "", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/ReleaseCreateRequest" } } ] }, "responses": [ { "status": "201", "description": "The request has succeeded and a new resource has been created as a result.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/ReleaseResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "createRoleBinding", "method": "POST", "path": "/api/v1/workspaces/{workspace}/role-bindings", "summary": "Create a role binding", "description": "", "tags": [ "Access" ], "effect": "write", "confirmation": "conditional", "authorization": { "mode": "privilege", "privilege": "MANAGE_GRANTS" }, "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "", "schema": { "maxLength": 200, "minLength": 1, "type": "string" } } ], "requestBody": { "required": true, "description": "", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/RoleBindingRequest" } } ] }, "responses": [ { "status": "201", "description": "The request has succeeded and a new resource has been created as a result.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/RoleBindingResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "createServicePrincipal", "method": "POST", "path": "/api/v1/service-principals", "summary": "Create a service principal", "description": "", "tags": [ "Access" ], "effect": "write", "confirmation": "conditional", "authorization": { "mode": "privilege", "privilege": "MANAGE_PLATFORM" }, "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "description": "", "schema": { "maxLength": 200, "minLength": 1, "type": "string" } } ], "requestBody": { "required": true, "description": "", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/ServicePrincipalCreateRequest" } } ] }, "responses": [ { "status": "201", "description": "The request has succeeded and a new resource has been created as a result.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/PrincipalResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "createServicePrincipalSecret", "method": "POST", "path": "/api/v1/service-principals/{servicePrincipal}/secrets", "summary": "Create a service principal secret", "description": "", "tags": [ "Access" ], "effect": "write", "confirmation": "conditional", "authorization": { "mode": "privilege", "privilege": "MANAGE_PLATFORM" }, "parameters": [ { "name": "servicePrincipal", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "", "schema": { "maxLength": 200, "minLength": 1, "type": "string" } } ], "requestBody": { "required": true, "description": "", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/ServicePrincipalSecretCreateRequest" } } ] }, "responses": [ { "status": "201", "description": "The request has succeeded and a new resource has been created as a result.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/ServicePrincipalSecretCreatedResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "deleteDataPolicy", "method": "DELETE", "path": "/api/v1/workspaces/{workspace}/data-policies/{policy}", "summary": "Delete a data policy", "description": "", "tags": [ "Access" ], "effect": "destructive", "confirmation": "required", "authorization": { "mode": "privilege", "privilege": "MANAGE_GRANTS" }, "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "policy", "in": "path", "required": true, "description": "", "schema": { "type": "string" } } ], "responses": [ { "status": "204", "description": "There is no content to send for this request, but the headers may be useful. ", "content": [] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "deleteGrant", "method": "DELETE", "path": "/api/v1/workspaces/{workspace}/grants/{grant}", "summary": "Delete a grant", "description": "", "tags": [ "Access" ], "effect": "destructive", "confirmation": "required", "authorization": { "mode": "privilege", "privilege": "MANAGE_GRANTS" }, "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "grant", "in": "path", "required": true, "description": "", "schema": { "type": "string" } } ], "responses": [ { "status": "204", "description": "There is no content to send for this request, but the headers may be useful. ", "content": [] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "deleteGroup", "method": "DELETE", "path": "/api/v1/workspaces/{workspace}/groups/{group}", "summary": "Delete a group", "description": "", "tags": [ "Access" ], "effect": "destructive", "confirmation": "required", "authorization": { "mode": "privilege", "privilege": "MANAGE_GRANTS" }, "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "group", "in": "path", "required": true, "description": "", "schema": { "type": "string" } } ], "responses": [ { "status": "204", "description": "There is no content to send for this request, but the headers may be useful. ", "content": [] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "deletePrincipal", "method": "DELETE", "path": "/api/v1/principals/{principal}", "summary": "Delete a principal", "description": "", "tags": [ "Access" ], "effect": "destructive", "confirmation": "required", "authorization": { "mode": "privilege", "privilege": "MANAGE_GRANTS" }, "parameters": [ { "name": "principal", "in": "path", "required": true, "description": "", "schema": { "type": "string" } } ], "responses": [ { "status": "204", "description": "There is no content to send for this request, but the headers may be useful. ", "content": [] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "deleteRoleBinding", "method": "DELETE", "path": "/api/v1/workspaces/{workspace}/role-bindings/{binding}", "summary": "Delete a role binding", "description": "", "tags": [ "Access" ], "effect": "destructive", "confirmation": "required", "authorization": { "mode": "privilege", "privilege": "MANAGE_GRANTS" }, "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "binding", "in": "path", "required": true, "description": "", "schema": { "type": "string" } } ], "responses": [ { "status": "204", "description": "There is no content to send for this request, but the headers may be useful. ", "content": [] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "deleteServicePrincipal", "method": "DELETE", "path": "/api/v1/service-principals/{servicePrincipal}", "summary": "Delete a service principal", "description": "", "tags": [ "Access" ], "effect": "destructive", "confirmation": "required", "authorization": { "mode": "privilege", "privilege": "MANAGE_PLATFORM" }, "parameters": [ { "name": "servicePrincipal", "in": "path", "required": true, "description": "", "schema": { "type": "string" } } ], "responses": [ { "status": "204", "description": "There is no content to send for this request, but the headers may be useful. ", "content": [] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "explainSemanticModelQuery", "method": "POST", "path": "/api/v1/workspaces/{workspace}/semantic-models/{model}/query/explain", "summary": "Explain semantic model query", "description": "", "tags": [ "BI" ], "effect": "write", "confirmation": "conditional", "authorization": { "mode": "privilege", "privilege": "QUERY_DATA" }, "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "model", "in": "path", "required": true, "description": "", "schema": { "type": "string" } } ], "requestBody": { "required": false, "description": "", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/SemanticQueryRequest" } } ] }, "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/SemanticExplainResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "explainSemanticPreview", "method": "POST", "path": "/api/v1/workspaces/{workspace}/semantic-models/{model}/datasets/{dataset}/preview/explain", "summary": "Explain semantic model dataset row preview", "description": "", "tags": [ "BI" ], "effect": "write", "confirmation": "conditional", "authorization": { "mode": "privilege", "privilege": "PREVIEW_DATA" }, "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "model", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "dataset", "in": "path", "required": true, "description": "", "schema": { "type": "string" } } ], "requestBody": { "required": false, "description": "", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/SemanticPreviewRequest" } } ] }, "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/SemanticExplainResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "finalizeManagedDataUploadSession", "method": "POST", "path": "/api/v1/projects/{project}/connections/{connection}/upload-sessions/{uploadSession}/finalize", "summary": "Finalize a managed-data upload session", "description": "", "tags": [ "Managed Data" ], "effect": "write", "confirmation": "conditional", "authorization": { "mode": "privilege", "privilege": "INGEST_DATA" }, "parameters": [ { "name": "project", "in": "path", "required": true, "description": "", "schema": { "maxLength": 128, "minLength": 1, "type": "string" } }, { "name": "connection", "in": "path", "required": true, "description": "", "schema": { "maxLength": 128, "minLength": 1, "type": "string" } }, { "name": "uploadSession", "in": "path", "required": true, "description": "", "schema": { "maxLength": 160, "minLength": 1, "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "", "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "responses": [ { "status": "202", "description": "The request has been accepted for processing, but processing has not yet completed.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/ManagedDataUploadSessionResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "finalizeRelease", "method": "POST", "path": "/api/v1/projects/{project}/releases/{release}/finalize", "summary": "Finalize and validate a release", "description": "", "tags": [ "Releases" ], "effect": "write", "confirmation": "conditional", "authorization": { "mode": "privilege", "privilege": "DEPLOY" }, "parameters": [ { "name": "project", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "release", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "", "schema": { "maxLength": 200, "minLength": 1, "type": "string" } } ], "responses": [ { "status": "202", "description": "The request has been accepted for processing, but processing has not yet completed.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/ReleaseResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "getActiveManagedDataRevision", "method": "GET", "path": "/api/v1/projects/{project}/connections/{connection}/active-revision", "summary": "Get the active managed-data revision", "description": "", "tags": [ "Managed Data" ], "effect": "read", "confirmation": "never", "authorization": { "mode": "privilege", "privilege": "VIEW_DATA" }, "parameters": [ { "name": "project", "in": "path", "required": true, "description": "", "schema": { "maxLength": 128, "minLength": 1, "type": "string" } }, { "name": "connection", "in": "path", "required": true, "description": "", "schema": { "maxLength": 128, "minLength": 1, "type": "string" } } ], "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/ManagedDataActiveRevisionResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "getAgentConversation", "method": "GET", "path": "/api/v1/agent/conversations/{conversation}", "summary": "Get an agent conversation", "description": "", "tags": [ "Agent" ], "effect": "read", "confirmation": "never", "authorization": { "mode": "privilege", "privilege": "VIEW_AGENT" }, "parameters": [ { "name": "conversation", "in": "path", "required": true, "description": "", "schema": { "type": "string" } } ], "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/AgentConversationResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "getAgentRun", "method": "GET", "path": "/api/v1/agent/conversations/{conversation}/runs/{run}", "summary": "Get an agent run", "description": "", "tags": [ "Agent" ], "effect": "read", "confirmation": "never", "authorization": { "mode": "privilege", "privilege": "VIEW_AGENT" }, "parameters": [ { "name": "conversation", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "run", "in": "path", "required": true, "description": "", "schema": { "type": "string" } } ], "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/AgentRunResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "getCapabilities", "method": "GET", "path": "/api/v1/capabilities", "summary": "Describe server capabilities", "description": "", "tags": [ "System" ], "effect": "read", "confirmation": "never", "authorization": { "mode": "privilege", "privilege": "USE_WORKSPACE" }, "parameters": [], "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/CapabilitiesResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "getCurrentPrincipal", "method": "GET", "path": "/api/v1/me", "summary": "Get current principal", "description": "", "tags": [ "Current User" ], "effect": "read", "confirmation": "never", "authorization": { "mode": "privilege", "privilege": "USE_WORKSPACE" }, "parameters": [], "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/PrincipalResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "getDashboard", "method": "GET", "path": "/api/v1/workspaces/{workspace}/dashboards/{dashboard}", "summary": "Describe dashboard", "description": "", "tags": [ "BI" ], "effect": "read", "confirmation": "never", "authorization": { "mode": "privilege", "privilege": "VIEW_ITEM" }, "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "dashboard", "in": "path", "required": true, "description": "", "schema": { "type": "string" } } ], "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/DashboardManifestResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "getDashboardFilter", "method": "GET", "path": "/api/v1/workspaces/{workspace}/dashboards/{dashboard}/pages/{page}/filters/{filter}", "summary": "Describe dashboard filter", "description": "", "tags": [ "BI" ], "effect": "read", "confirmation": "never", "authorization": { "mode": "privilege", "privilege": "VIEW_ITEM" }, "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "dashboard", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "filter", "in": "path", "required": true, "description": "", "schema": { "type": "string" } } ], "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/DashboardFilterDescribeResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "getDashboardPage", "method": "GET", "path": "/api/v1/workspaces/{workspace}/dashboards/{dashboard}/pages/{page}", "summary": "Describe dashboard page", "description": "", "tags": [ "BI" ], "effect": "read", "confirmation": "never", "authorization": { "mode": "privilege", "privilege": "VIEW_ITEM" }, "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "dashboard", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "path", "required": true, "description": "", "schema": { "type": "string" } } ], "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/DashboardPageResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "getDashboardPublication", "method": "GET", "path": "/api/v1/workspaces/{workspace}/dashboard-publications/{publication}", "summary": "Get a dashboard publication", "description": "", "tags": [ "Publications" ], "effect": "read", "confirmation": "never", "authorization": { "mode": "privilege", "privilege": "MANAGE_PUBLICATIONS" }, "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "publication", "in": "path", "required": true, "description": "", "schema": { "type": "string" } } ], "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/DashboardPublicationResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "getDashboardVisual", "method": "GET", "path": "/api/v1/workspaces/{workspace}/dashboards/{dashboard}/pages/{page}/visuals/{visual}", "summary": "Describe dashboard visual", "description": "", "tags": [ "BI" ], "effect": "read", "confirmation": "never", "authorization": { "mode": "privilege", "privilege": "VIEW_ITEM" }, "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "dashboard", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "visual", "in": "path", "required": true, "description": "", "schema": { "type": "string" } } ], "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/DashboardVisualDescribeResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "getDataPolicy", "method": "GET", "path": "/api/v1/workspaces/{workspace}/data-policies/{policy}", "summary": "Get a data policy", "description": "", "tags": [ "Access" ], "effect": "read", "confirmation": "never", "authorization": { "mode": "privilege", "privilege": "MANAGE_GRANTS" }, "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "policy", "in": "path", "required": true, "description": "", "schema": { "type": "string" } } ], "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/DataPolicyResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "getDeployment", "method": "GET", "path": "/api/v1/projects/{project}/deployments/{deployment}", "summary": "Get a project deployment", "description": "", "tags": [ "Deployments" ], "effect": "read", "confirmation": "never", "authorization": { "mode": "privilege", "privilege": "VIEW_ITEM" }, "parameters": [ { "name": "project", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "deployment", "in": "path", "required": true, "description": "", "schema": { "type": "string" } } ], "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/DeploymentResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "getGrant", "method": "GET", "path": "/api/v1/workspaces/{workspace}/grants/{grant}", "summary": "Get an object privilege grant", "description": "", "tags": [ "Access" ], "effect": "read", "confirmation": "never", "authorization": { "mode": "privilege", "privilege": "MANAGE_GRANTS" }, "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "grant", "in": "path", "required": true, "description": "", "schema": { "type": "string" } } ], "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/GrantResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "getGroup", "method": "GET", "path": "/api/v1/workspaces/{workspace}/groups/{group}", "summary": "Get a group", "description": "", "tags": [ "Access" ], "effect": "read", "confirmation": "never", "authorization": { "mode": "privilege", "privilege": "MANAGE_GRANTS" }, "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "group", "in": "path", "required": true, "description": "", "schema": { "type": "string" } } ], "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/GroupResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "getInstance", "method": "GET", "path": "/api/v1/instance", "summary": "Get this LeapView instance identity", "description": "", "tags": [ "Instance" ], "effect": "read", "confirmation": "never", "parameters": [], "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/InstanceResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "getManagedConnection", "method": "GET", "path": "/api/v1/projects/{project}/connections/{connection}", "summary": "Describe a project managed connection", "description": "", "tags": [ "Managed Data" ], "effect": "read", "confirmation": "never", "authorization": { "mode": "privilege", "privilege": "VIEW_DATA" }, "parameters": [ { "name": "project", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "connection", "in": "path", "required": true, "description": "", "schema": { "type": "string" } } ], "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/ManagedConnectionResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "getManagedDataRevision", "method": "GET", "path": "/api/v1/projects/{project}/connections/{connection}/revisions/{revision}", "summary": "Get an immutable managed-data revision", "description": "", "tags": [ "Managed Data" ], "effect": "read", "confirmation": "never", "authorization": { "mode": "privilege", "privilege": "VIEW_DATA" }, "parameters": [ { "name": "project", "in": "path", "required": true, "description": "", "schema": { "maxLength": 128, "minLength": 1, "type": "string" } }, { "name": "connection", "in": "path", "required": true, "description": "", "schema": { "maxLength": 128, "minLength": 1, "type": "string" } }, { "name": "revision", "in": "path", "required": true, "description": "", "schema": { "maxLength": 71, "minLength": 71, "type": "string" } } ], "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/ManagedDataRevisionResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "getManagedDataUploadSession", "method": "GET", "path": "/api/v1/projects/{project}/connections/{connection}/upload-sessions/{uploadSession}", "summary": "Get a managed-data upload session", "description": "", "tags": [ "Managed Data" ], "effect": "read", "confirmation": "never", "authorization": { "mode": "privilege", "privilege": "INGEST_DATA" }, "parameters": [ { "name": "project", "in": "path", "required": true, "description": "", "schema": { "maxLength": 128, "minLength": 1, "type": "string" } }, { "name": "connection", "in": "path", "required": true, "description": "", "schema": { "maxLength": 128, "minLength": 1, "type": "string" } }, { "name": "uploadSession", "in": "path", "required": true, "description": "", "schema": { "maxLength": 160, "minLength": 1, "type": "string" } } ], "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/ManagedDataUploadSessionResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "getPrincipal", "method": "GET", "path": "/api/v1/principals/{principal}", "summary": "Get a principal", "description": "", "tags": [ "Access" ], "effect": "read", "confirmation": "never", "authorization": { "mode": "privilege", "privilege": "MANAGE_GRANTS" }, "parameters": [ { "name": "principal", "in": "path", "required": true, "description": "", "schema": { "type": "string" } } ], "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/PrincipalResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "getProject", "method": "GET", "path": "/api/v1/projects/{project}", "summary": "Get a materialized project", "description": "", "tags": [ "Projects" ], "effect": "read", "confirmation": "never", "authorization": { "mode": "privilege", "privilege": "USE_WORKSPACE" }, "parameters": [ { "name": "project", "in": "path", "required": true, "description": "", "schema": { "type": "string" } } ], "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/ProjectResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "getRefreshRun", "method": "GET", "path": "/api/v1/workspaces/{workspace}/refresh-runs/{run}", "summary": "Get a refresh run", "description": "", "tags": [ "Refresh Runs" ], "effect": "read", "confirmation": "never", "authorization": { "mode": "privilege", "privilege": "USE_WORKSPACE" }, "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "run", "in": "path", "required": true, "description": "", "schema": { "type": "string" } } ], "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/RefreshRunResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "getRelease", "method": "GET", "path": "/api/v1/projects/{project}/releases/{release}", "summary": "Get a project release", "description": "", "tags": [ "Releases" ], "effect": "read", "confirmation": "never", "authorization": { "mode": "privilege", "privilege": "DEPLOY" }, "parameters": [ { "name": "project", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "release", "in": "path", "required": true, "description": "", "schema": { "type": "string" } } ], "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/ReleaseResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "getRoleBinding", "method": "GET", "path": "/api/v1/workspaces/{workspace}/role-bindings/{binding}", "summary": "Get a workspace role binding", "description": "", "tags": [ "Access" ], "effect": "read", "confirmation": "never", "authorization": { "mode": "privilege", "privilege": "MANAGE_GRANTS" }, "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "binding", "in": "path", "required": true, "description": "", "schema": { "type": "string" } } ], "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/RoleBindingResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "getSemanticDataset", "method": "GET", "path": "/api/v1/workspaces/{workspace}/semantic-models/{model}/datasets/{dataset}", "summary": "Describe semantic model dataset", "description": "", "tags": [ "BI" ], "effect": "read", "confirmation": "never", "authorization": { "mode": "privilege", "privilege": "VIEW_ITEM" }, "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "model", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "dataset", "in": "path", "required": true, "description": "", "schema": { "type": "string" } } ], "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/SemanticDatasetResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "getSemanticModel", "method": "GET", "path": "/api/v1/workspaces/{workspace}/semantic-models/{model}", "summary": "Describe semantic model", "description": "", "tags": [ "BI" ], "effect": "read", "confirmation": "never", "authorization": { "mode": "privilege", "privilege": "VIEW_ITEM" }, "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "model", "in": "path", "required": true, "description": "", "schema": { "type": "string" } } ], "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/SemanticModelDescriptionResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "getServicePrincipal", "method": "GET", "path": "/api/v1/service-principals/{servicePrincipal}", "summary": "Get a service principal", "description": "", "tags": [ "Access" ], "effect": "read", "confirmation": "never", "authorization": { "mode": "privilege", "privilege": "MANAGE_PLATFORM" }, "parameters": [ { "name": "servicePrincipal", "in": "path", "required": true, "description": "", "schema": { "type": "string" } } ], "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/PrincipalResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "getServicePrincipalSecret", "method": "GET", "path": "/api/v1/service-principals/{servicePrincipal}/secrets/{secret}", "summary": "Get service-principal secret metadata", "description": "", "tags": [ "Access" ], "effect": "read", "confirmation": "never", "authorization": { "mode": "privilege", "privilege": "MANAGE_PLATFORM" }, "parameters": [ { "name": "servicePrincipal", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "secret", "in": "path", "required": true, "description": "", "schema": { "type": "string" } } ], "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/ServicePrincipalSecretResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "getWorkspace", "method": "GET", "path": "/api/v1/workspaces/{workspace}", "summary": "Get a workspace", "description": "", "tags": [ "Workspaces" ], "effect": "read", "confirmation": "never", "authorization": { "mode": "privilege", "privilege": "VIEW_ITEM" }, "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "", "schema": { "type": "string" } } ], "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/WorkspaceResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "getWorkspaceActiveAssetGraph", "method": "GET", "path": "/api/v1/workspaces/{workspace}/active-asset-graph", "summary": "Get the active asset graph", "description": "", "tags": [ "Workspaces" ], "effect": "read", "confirmation": "never", "authorization": { "mode": "privilege", "privilege": "USE_WORKSPACE" }, "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "", "schema": { "type": "string" } } ], "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/WorkspaceAssetGraphResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "getWorkspaceAsset", "method": "GET", "path": "/api/v1/workspaces/{workspace}/assets/{assetId}", "summary": "Describe a workspace asset", "description": "", "tags": [ "Workspaces" ], "effect": "read", "confirmation": "never", "authorization": { "mode": "privilege", "privilege": "VIEW_ITEM" }, "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "assetId", "in": "path", "required": true, "description": "", "schema": { "type": "string" } } ], "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/AssetResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "getWorkspaceAssetLineage", "method": "GET", "path": "/api/v1/workspaces/{workspace}/assets/{assetId}/lineage", "summary": "Get workspace asset lineage", "description": "", "tags": [ "Workspaces" ], "effect": "read", "confirmation": "never", "authorization": { "mode": "privilege", "privilege": "VIEW_ITEM" }, "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "assetId", "in": "path", "required": true, "description": "", "schema": { "type": "string" } } ], "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/AssetLineageResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "listAgentConversations", "method": "GET", "path": "/api/v1/agent/conversations", "summary": "List agent conversations", "description": "", "tags": [ "Agent" ], "effect": "read", "confirmation": "never", "authorization": { "mode": "privilege", "privilege": "VIEW_AGENT" }, "parameters": [ { "name": "limit", "in": "query", "required": false, "description": "", "schema": { "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" } }, { "name": "pageToken", "in": "query", "required": false, "description": "", "schema": { "maxLength": 2048, "minLength": 1, "type": "string" } } ], "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/AgentConversationListResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "listAgentEvents", "method": "GET", "path": "/api/v1/agent/conversations/{conversation}/runs/{run}/events", "summary": "List agent run events", "description": "", "tags": [ "Agent" ], "effect": "read", "confirmation": "never", "authorization": { "mode": "privilege", "privilege": "VIEW_AGENT" }, "parameters": [ { "name": "conversation", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "run", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "accept", "in": "header", "required": false, "description": "", "schema": { "type": "string" } }, { "name": "Last-Event-ID", "in": "header", "required": false, "description": "", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "", "schema": { "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" } }, { "name": "pageToken", "in": "query", "required": false, "description": "", "schema": { "maxLength": 2048, "minLength": 1, "type": "string" } } ], "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/AsyncEventListResponse" } }, { "contentType": "text/event-stream", "schema": { "type": "string" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "listAgentMessages", "method": "GET", "path": "/api/v1/agent/conversations/{conversation}/messages", "summary": "List agent messages", "description": "", "tags": [ "Agent" ], "effect": "read", "confirmation": "never", "authorization": { "mode": "privilege", "privilege": "VIEW_AGENT" }, "parameters": [ { "name": "conversation", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "", "schema": { "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" } }, { "name": "pageToken", "in": "query", "required": false, "description": "", "schema": { "maxLength": 2048, "minLength": 1, "type": "string" } } ], "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/AgentMessageListResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "listAgentRuns", "method": "GET", "path": "/api/v1/agent/conversations/{conversation}/runs", "summary": "List agent runs", "description": "", "tags": [ "Agent" ], "effect": "read", "confirmation": "never", "authorization": { "mode": "privilege", "privilege": "VIEW_AGENT" }, "parameters": [ { "name": "conversation", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "", "schema": { "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" } }, { "name": "pageToken", "in": "query", "required": false, "description": "", "schema": { "maxLength": 2048, "minLength": 1, "type": "string" } } ], "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/AgentRunListResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "listAuditEvents", "method": "GET", "path": "/api/v1/workspaces/{workspace}/audit-events", "summary": "List workspace audit events", "description": "", "tags": [ "Audit" ], "effect": "read", "confirmation": "never", "authorization": { "mode": "privilege", "privilege": "VIEW_AUDIT" }, "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "actor", "in": "query", "required": false, "description": "", "schema": { "type": "string" } }, { "name": "action", "in": "query", "required": false, "description": "", "schema": { "type": "string" } }, { "name": "targetType", "in": "query", "required": false, "description": "", "schema": { "type": "string" } }, { "name": "targetId", "in": "query", "required": false, "description": "", "schema": { "type": "string" } }, { "name": "from", "in": "query", "required": false, "description": "", "schema": { "format": "date-time", "type": "string" } }, { "name": "to", "in": "query", "required": false, "description": "", "schema": { "format": "date-time", "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "", "schema": { "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" } }, { "name": "pageToken", "in": "query", "required": false, "description": "", "schema": { "maxLength": 2048, "minLength": 1, "type": "string" } } ], "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/AuditEventListResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "listCurrentAPITokens", "method": "GET", "path": "/api/v1/me/api-tokens", "summary": "List current API tokens", "description": "", "tags": [ "Current User" ], "effect": "read", "confirmation": "never", "authorization": { "mode": "privilege", "privilege": "MANAGE_GRANTS" }, "parameters": [ { "name": "limit", "in": "query", "required": false, "description": "", "schema": { "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" } }, { "name": "pageToken", "in": "query", "required": false, "description": "", "schema": { "maxLength": 2048, "minLength": 1, "type": "string" } } ], "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/APITokenListResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "listCurrentEffectivePrivileges", "method": "GET", "path": "/api/v1/me/effective-privileges", "summary": "List current effective privileges", "description": "", "tags": [ "Current User" ], "effect": "read", "confirmation": "never", "authorization": { "mode": "privilege", "privilege": "USE_WORKSPACE" }, "parameters": [ { "name": "workspace", "in": "query", "required": false, "description": "", "schema": { "type": "string" } } ], "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/EffectivePrivilegesResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "listCurrentSessions", "method": "GET", "path": "/api/v1/me/sessions", "summary": "List current sessions", "description": "", "tags": [ "Current User" ], "effect": "read", "confirmation": "never", "authorization": { "mode": "privilege", "privilege": "USE_WORKSPACE" }, "parameters": [ { "name": "limit", "in": "query", "required": false, "description": "", "schema": { "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" } }, { "name": "pageToken", "in": "query", "required": false, "description": "", "schema": { "maxLength": 2048, "minLength": 1, "type": "string" } } ], "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/SessionListResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "listDashboardFilterValues", "method": "POST", "path": "/api/v1/workspaces/{workspace}/dashboards/{dashboard}/pages/{page}/filters/{filter}/values", "summary": "List dashboard filter values", "description": "", "tags": [ "BI" ], "effect": "write", "confirmation": "conditional", "authorization": { "mode": "privilege", "privilege": "QUERY_DATA" }, "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "dashboard", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "filter", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "", "schema": { "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" } }, { "name": "pageToken", "in": "query", "required": false, "description": "", "schema": { "maxLength": 2048, "minLength": 1, "type": "string" } } ], "requestBody": { "required": false, "description": "", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/DashboardPageQueryRequest" } } ] }, "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/DashboardFilterOptionListResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "listDashboardPublications", "method": "GET", "path": "/api/v1/workspaces/{workspace}/dashboard-publications", "summary": "List dashboard publications in a workspace", "description": "", "tags": [ "Publications" ], "effect": "read", "confirmation": "never", "authorization": { "mode": "privilege", "privilege": "MANAGE_PUBLICATIONS" }, "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "", "schema": { "type": "string" } } ], "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/DashboardPublicationListResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "listDashboards", "method": "GET", "path": "/api/v1/workspaces/{workspace}/dashboards", "summary": "List dashboards", "description": "", "tags": [ "BI" ], "effect": "read", "confirmation": "never", "authorization": { "mode": "privilege", "privilege": "VIEW_ITEM" }, "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "", "schema": { "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" } }, { "name": "pageToken", "in": "query", "required": false, "description": "", "schema": { "maxLength": 2048, "minLength": 1, "type": "string" } } ], "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/DashboardListResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "listDataPolicies", "method": "GET", "path": "/api/v1/workspaces/{workspace}/data-policies", "summary": "List data policies", "description": "", "tags": [ "Access" ], "effect": "read", "confirmation": "never", "authorization": { "mode": "privilege", "privilege": "MANAGE_GRANTS" }, "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "objectType", "in": "query", "required": false, "description": "", "schema": { "type": "string" } }, { "name": "objectId", "in": "query", "required": false, "description": "", "schema": { "type": "string" } }, { "name": "includeInherited", "in": "query", "required": false, "description": "", "schema": { "type": "boolean" } }, { "name": "limit", "in": "query", "required": false, "description": "", "schema": { "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" } }, { "name": "pageToken", "in": "query", "required": false, "description": "", "schema": { "maxLength": 2048, "minLength": 1, "type": "string" } } ], "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/DataPolicyListResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "listDeploymentEvents", "method": "GET", "path": "/api/v1/projects/{project}/deployments/{deployment}/events", "summary": "List or stream deployment events", "description": "", "tags": [ "Deployments" ], "effect": "read", "confirmation": "never", "authorization": { "mode": "privilege", "privilege": "VIEW_ITEM" }, "parameters": [ { "name": "project", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "deployment", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "accept", "in": "header", "required": false, "description": "", "schema": { "type": "string" } }, { "name": "Last-Event-ID", "in": "header", "required": false, "description": "", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "", "schema": { "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" } }, { "name": "pageToken", "in": "query", "required": false, "description": "", "schema": { "maxLength": 2048, "minLength": 1, "type": "string" } } ], "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/AsyncEventListResponse" } }, { "contentType": "text/event-stream", "schema": { "type": "string" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "listDeployments", "method": "GET", "path": "/api/v1/projects/{project}/deployments", "summary": "List project deployments", "description": "", "tags": [ "Deployments" ], "effect": "read", "confirmation": "never", "authorization": { "mode": "privilege", "privilege": "VIEW_ITEM" }, "parameters": [ { "name": "project", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "", "schema": { "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" } }, { "name": "pageToken", "in": "query", "required": false, "description": "", "schema": { "maxLength": 2048, "minLength": 1, "type": "string" } } ], "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/DeploymentListResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "listEffectivePrivileges", "method": "GET", "path": "/api/v1/workspaces/{workspace}/effective-privileges", "summary": "List effective privileges", "description": "", "tags": [ "Access" ], "effect": "read", "confirmation": "never", "authorization": { "mode": "privilege", "privilege": "USE_WORKSPACE" }, "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "objectType", "in": "query", "required": false, "description": "", "schema": { "type": "string" } }, { "name": "objectId", "in": "query", "required": false, "description": "", "schema": { "type": "string" } } ], "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/EffectivePrivilegeListResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "listGrants", "method": "GET", "path": "/api/v1/workspaces/{workspace}/grants", "summary": "List grants", "description": "", "tags": [ "Access" ], "effect": "read", "confirmation": "never", "authorization": { "mode": "privilege", "privilege": "MANAGE_GRANTS" }, "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "objectType", "in": "query", "required": false, "description": "", "schema": { "type": "string" } }, { "name": "objectId", "in": "query", "required": false, "description": "", "schema": { "type": "string" } }, { "name": "includeInherited", "in": "query", "required": false, "description": "", "schema": { "type": "boolean" } }, { "name": "limit", "in": "query", "required": false, "description": "", "schema": { "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" } }, { "name": "pageToken", "in": "query", "required": false, "description": "", "schema": { "maxLength": 2048, "minLength": 1, "type": "string" } } ], "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/GrantListResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "listGroupMembers", "method": "GET", "path": "/api/v1/workspaces/{workspace}/groups/{group}/members", "summary": "List group members", "description": "", "tags": [ "Access" ], "effect": "read", "confirmation": "never", "authorization": { "mode": "privilege", "privilege": "MANAGE_GRANTS" }, "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "group", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "", "schema": { "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" } }, { "name": "pageToken", "in": "query", "required": false, "description": "", "schema": { "maxLength": 2048, "minLength": 1, "type": "string" } } ], "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/GroupMemberListResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "listGroups", "method": "GET", "path": "/api/v1/workspaces/{workspace}/groups", "summary": "List groups", "description": "", "tags": [ "Access" ], "effect": "read", "confirmation": "never", "authorization": { "mode": "privilege", "privilege": "MANAGE_GRANTS" }, "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "", "schema": { "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" } }, { "name": "pageToken", "in": "query", "required": false, "description": "", "schema": { "maxLength": 2048, "minLength": 1, "type": "string" } } ], "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/GroupListResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "listManagedConnections", "method": "GET", "path": "/api/v1/projects/{project}/connections", "summary": "List project managed connections", "description": "", "tags": [ "Managed Data" ], "effect": "read", "confirmation": "never", "authorization": { "mode": "privilege", "privilege": "VIEW_DATA" }, "parameters": [ { "name": "project", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "", "schema": { "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" } }, { "name": "pageToken", "in": "query", "required": false, "description": "", "schema": { "maxLength": 2048, "minLength": 1, "type": "string" } } ], "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/ManagedConnectionListResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "listManagedDataRevisions", "method": "GET", "path": "/api/v1/projects/{project}/connections/{connection}/revisions", "summary": "List immutable managed-data revisions", "description": "", "tags": [ "Managed Data" ], "effect": "read", "confirmation": "never", "authorization": { "mode": "privilege", "privilege": "VIEW_DATA" }, "parameters": [ { "name": "project", "in": "path", "required": true, "description": "", "schema": { "maxLength": 128, "minLength": 1, "type": "string" } }, { "name": "connection", "in": "path", "required": true, "description": "", "schema": { "maxLength": 128, "minLength": 1, "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "", "schema": { "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" } }, { "name": "pageToken", "in": "query", "required": false, "description": "", "schema": { "maxLength": 2048, "minLength": 1, "type": "string" } } ], "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/ManagedDataRevisionListResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "listManagedDataUploadSessionEvents", "method": "GET", "path": "/api/v1/projects/{project}/connections/{connection}/upload-sessions/{uploadSession}/events", "summary": "List or stream upload-session events", "description": "", "tags": [ "Managed Data" ], "effect": "read", "confirmation": "never", "authorization": { "mode": "privilege", "privilege": "INGEST_DATA" }, "parameters": [ { "name": "project", "in": "path", "required": true, "description": "", "schema": { "maxLength": 128, "minLength": 1, "type": "string" } }, { "name": "connection", "in": "path", "required": true, "description": "", "schema": { "maxLength": 128, "minLength": 1, "type": "string" } }, { "name": "uploadSession", "in": "path", "required": true, "description": "", "schema": { "maxLength": 160, "minLength": 1, "type": "string" } }, { "name": "accept", "in": "header", "required": false, "description": "", "schema": { "type": "string" } }, { "name": "Last-Event-ID", "in": "header", "required": false, "description": "", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "", "schema": { "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" } }, { "name": "pageToken", "in": "query", "required": false, "description": "", "schema": { "maxLength": 2048, "minLength": 1, "type": "string" } } ], "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/AsyncEventListResponse" } }, { "contentType": "text/event-stream", "schema": { "type": "string" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "listManagedDataUploadSessions", "method": "GET", "path": "/api/v1/projects/{project}/connections/{connection}/upload-sessions", "summary": "List managed-data upload sessions", "description": "", "tags": [ "Managed Data" ], "effect": "read", "confirmation": "never", "authorization": { "mode": "privilege", "privilege": "INGEST_DATA" }, "parameters": [ { "name": "project", "in": "path", "required": true, "description": "", "schema": { "maxLength": 128, "minLength": 1, "type": "string" } }, { "name": "connection", "in": "path", "required": true, "description": "", "schema": { "maxLength": 128, "minLength": 1, "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "", "schema": { "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" } }, { "name": "pageToken", "in": "query", "required": false, "description": "", "schema": { "maxLength": 2048, "minLength": 1, "type": "string" } } ], "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/ManagedDataUploadSessionListResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "listPrincipals", "method": "GET", "path": "/api/v1/principals", "summary": "List principals", "description": "", "tags": [ "Access" ], "effect": "read", "confirmation": "never", "authorization": { "mode": "privilege", "privilege": "MANAGE_GRANTS" }, "parameters": [ { "name": "email", "in": "query", "required": false, "description": "", "schema": { "type": "string" } }, { "name": "q", "in": "query", "required": false, "description": "", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "", "schema": { "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" } }, { "name": "pageToken", "in": "query", "required": false, "description": "", "schema": { "maxLength": 2048, "minLength": 1, "type": "string" } } ], "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/PrincipalListResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "listProjectWorkspaces", "method": "GET", "path": "/api/v1/projects/{project}/workspaces", "summary": "List project workspaces", "description": "", "tags": [ "Projects" ], "effect": "read", "confirmation": "never", "authorization": { "mode": "privilege", "privilege": "VIEW_ITEM" }, "parameters": [ { "name": "project", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "", "schema": { "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" } }, { "name": "pageToken", "in": "query", "required": false, "description": "", "schema": { "maxLength": 2048, "minLength": 1, "type": "string" } } ], "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/ProjectWorkspaceListResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "listProjects", "method": "GET", "path": "/api/v1/projects", "summary": "List materialized projects", "description": "", "tags": [ "Projects" ], "effect": "read", "confirmation": "never", "authorization": { "mode": "privilege", "privilege": "USE_WORKSPACE" }, "parameters": [ { "name": "limit", "in": "query", "required": false, "description": "", "schema": { "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" } }, { "name": "pageToken", "in": "query", "required": false, "description": "", "schema": { "maxLength": 2048, "minLength": 1, "type": "string" } } ], "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/ProjectListResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "listQueryEvents", "method": "GET", "path": "/api/v1/workspaces/{workspace}/query-events", "summary": "List workspace query audit events", "description": "", "tags": [ "Audit" ], "effect": "read", "confirmation": "never", "authorization": { "mode": "privilege", "privilege": "VIEW_AUDIT" }, "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "principal", "in": "query", "required": false, "description": "", "schema": { "type": "string" } }, { "name": "surface", "in": "query", "required": false, "description": "", "schema": { "type": "string" } }, { "name": "operation", "in": "query", "required": false, "description": "", "schema": { "type": "string" } }, { "name": "kind", "in": "query", "required": false, "description": "", "schema": { "type": "string" } }, { "name": "modelId", "in": "query", "required": false, "description": "", "schema": { "type": "string" } }, { "name": "target", "in": "query", "required": false, "description": "", "schema": { "type": "string" } }, { "name": "status", "in": "query", "required": false, "description": "", "schema": { "type": "string" } }, { "name": "search", "in": "query", "required": false, "description": "", "schema": { "type": "string" } }, { "name": "from", "in": "query", "required": false, "description": "", "schema": { "format": "date-time", "type": "string" } }, { "name": "to", "in": "query", "required": false, "description": "", "schema": { "format": "date-time", "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "", "schema": { "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" } }, { "name": "pageToken", "in": "query", "required": false, "description": "", "schema": { "maxLength": 2048, "minLength": 1, "type": "string" } } ], "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/QueryEventListResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "listRefreshRunEvents", "method": "GET", "path": "/api/v1/workspaces/{workspace}/refresh-runs/{run}/events", "summary": "List or stream refresh run events", "description": "", "tags": [ "Refresh Runs" ], "effect": "read", "confirmation": "never", "authorization": { "mode": "privilege", "privilege": "USE_WORKSPACE" }, "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "run", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "accept", "in": "header", "required": false, "description": "", "schema": { "type": "string" } }, { "name": "Last-Event-ID", "in": "header", "required": false, "description": "", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "", "schema": { "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" } }, { "name": "pageToken", "in": "query", "required": false, "description": "", "schema": { "maxLength": 2048, "minLength": 1, "type": "string" } } ], "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/AsyncEventListResponse" } }, { "contentType": "text/event-stream", "schema": { "type": "string" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "listRefreshRuns", "method": "GET", "path": "/api/v1/workspaces/{workspace}/refresh-runs", "summary": "List refresh runs", "description": "", "tags": [ "Refresh Runs" ], "effect": "read", "confirmation": "never", "authorization": { "mode": "privilege", "privilege": "USE_WORKSPACE" }, "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "", "schema": { "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" } }, { "name": "pageToken", "in": "query", "required": false, "description": "", "schema": { "maxLength": 2048, "minLength": 1, "type": "string" } } ], "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/RefreshRunListResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "listReleaseEvents", "method": "GET", "path": "/api/v1/projects/{project}/releases/{release}/events", "summary": "List or stream release events", "description": "", "tags": [ "Releases" ], "effect": "read", "confirmation": "never", "authorization": { "mode": "privilege", "privilege": "DEPLOY" }, "parameters": [ { "name": "project", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "release", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "accept", "in": "header", "required": false, "description": "", "schema": { "type": "string" } }, { "name": "Last-Event-ID", "in": "header", "required": false, "description": "", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "", "schema": { "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" } }, { "name": "pageToken", "in": "query", "required": false, "description": "", "schema": { "maxLength": 2048, "minLength": 1, "type": "string" } } ], "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/AsyncEventListResponse" } }, { "contentType": "text/event-stream", "schema": { "type": "string" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "listReleases", "method": "GET", "path": "/api/v1/projects/{project}/releases", "summary": "List project releases", "description": "", "tags": [ "Releases" ], "effect": "read", "confirmation": "never", "authorization": { "mode": "privilege", "privilege": "DEPLOY" }, "parameters": [ { "name": "project", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "", "schema": { "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" } }, { "name": "pageToken", "in": "query", "required": false, "description": "", "schema": { "maxLength": 2048, "minLength": 1, "type": "string" } } ], "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/ReleaseListResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "listRoleBindings", "method": "GET", "path": "/api/v1/workspaces/{workspace}/role-bindings", "summary": "List role bindings", "description": "", "tags": [ "Access" ], "effect": "read", "confirmation": "never", "authorization": { "mode": "privilege", "privilege": "MANAGE_GRANTS" }, "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "subjectType", "in": "query", "required": false, "description": "", "schema": { "type": "string" } }, { "name": "subjectId", "in": "query", "required": false, "description": "", "schema": { "type": "string" } }, { "name": "role", "in": "query", "required": false, "description": "", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "", "schema": { "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" } }, { "name": "pageToken", "in": "query", "required": false, "description": "", "schema": { "maxLength": 2048, "minLength": 1, "type": "string" } } ], "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/RoleBindingListResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "listSemanticDatasets", "method": "GET", "path": "/api/v1/workspaces/{workspace}/semantic-models/{model}/datasets", "summary": "List semantic model datasets", "description": "", "tags": [ "BI" ], "effect": "read", "confirmation": "never", "authorization": { "mode": "privilege", "privilege": "VIEW_ITEM" }, "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "model", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "", "schema": { "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" } }, { "name": "pageToken", "in": "query", "required": false, "description": "", "schema": { "maxLength": 2048, "minLength": 1, "type": "string" } } ], "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/SemanticDatasetListResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "listSemanticFields", "method": "GET", "path": "/api/v1/workspaces/{workspace}/semantic-models/{model}/datasets/{dataset}/fields", "summary": "List semantic model dataset fields", "description": "", "tags": [ "BI" ], "effect": "read", "confirmation": "never", "authorization": { "mode": "privilege", "privilege": "VIEW_ITEM" }, "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "model", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "dataset", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "", "schema": { "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" } }, { "name": "pageToken", "in": "query", "required": false, "description": "", "schema": { "maxLength": 2048, "minLength": 1, "type": "string" } } ], "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/SemanticFieldListResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "listSemanticModelFields", "method": "GET", "path": "/api/v1/workspaces/{workspace}/semantic-models/{model}/fields", "summary": "List semantic model fields", "description": "", "tags": [ "BI" ], "effect": "read", "confirmation": "never", "authorization": { "mode": "privilege", "privilege": "VIEW_ITEM" }, "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "model", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "", "schema": { "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" } }, { "name": "pageToken", "in": "query", "required": false, "description": "", "schema": { "maxLength": 2048, "minLength": 1, "type": "string" } } ], "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/SemanticFieldListResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "listSemanticModels", "method": "GET", "path": "/api/v1/workspaces/{workspace}/semantic-models", "summary": "List semantic models", "description": "", "tags": [ "BI" ], "effect": "read", "confirmation": "never", "authorization": { "mode": "privilege", "privilege": "VIEW_ITEM" }, "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "", "schema": { "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" } }, { "name": "pageToken", "in": "query", "required": false, "description": "", "schema": { "maxLength": 2048, "minLength": 1, "type": "string" } } ], "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/SemanticModelListResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "listSemanticRelationships", "method": "GET", "path": "/api/v1/workspaces/{workspace}/semantic-models/{model}/relationships", "summary": "List semantic model relationships", "description": "", "tags": [ "BI" ], "effect": "read", "confirmation": "never", "authorization": { "mode": "privilege", "privilege": "VIEW_ITEM" }, "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "model", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "", "schema": { "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" } }, { "name": "pageToken", "in": "query", "required": false, "description": "", "schema": { "maxLength": 2048, "minLength": 1, "type": "string" } } ], "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/SemanticRelationshipListResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "listSemanticSources", "method": "GET", "path": "/api/v1/workspaces/{workspace}/semantic-models/{model}/sources", "summary": "List semantic model sources", "description": "", "tags": [ "BI" ], "effect": "read", "confirmation": "never", "authorization": { "mode": "privilege", "privilege": "VIEW_ITEM" }, "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "model", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "", "schema": { "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" } }, { "name": "pageToken", "in": "query", "required": false, "description": "", "schema": { "maxLength": 2048, "minLength": 1, "type": "string" } } ], "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/SemanticSourceListResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "listServicePrincipalSecrets", "method": "GET", "path": "/api/v1/service-principals/{servicePrincipal}/secrets", "summary": "List service-principal secrets", "description": "", "tags": [ "Access" ], "effect": "read", "confirmation": "never", "authorization": { "mode": "privilege", "privilege": "MANAGE_PLATFORM" }, "parameters": [ { "name": "servicePrincipal", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "", "schema": { "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" } }, { "name": "pageToken", "in": "query", "required": false, "description": "", "schema": { "maxLength": 2048, "minLength": 1, "type": "string" } } ], "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/ServicePrincipalSecretListResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "listServicePrincipals", "method": "GET", "path": "/api/v1/service-principals", "summary": "List service principals", "description": "", "tags": [ "Access" ], "effect": "read", "confirmation": "never", "authorization": { "mode": "privilege", "privilege": "MANAGE_PLATFORM" }, "parameters": [ { "name": "limit", "in": "query", "required": false, "description": "", "schema": { "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" } }, { "name": "pageToken", "in": "query", "required": false, "description": "", "schema": { "maxLength": 2048, "minLength": 1, "type": "string" } } ], "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/ServicePrincipalListResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "listWorkspaceAssetEdges", "method": "GET", "path": "/api/v1/workspaces/{workspace}/asset-edges", "summary": "List workspace asset edges", "description": "", "tags": [ "Workspaces" ], "effect": "read", "confirmation": "never", "authorization": { "mode": "privilege", "privilege": "USE_WORKSPACE" }, "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "", "schema": { "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" } }, { "name": "pageToken", "in": "query", "required": false, "description": "", "schema": { "maxLength": 2048, "minLength": 1, "type": "string" } } ], "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/AssetEdgeListResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "listWorkspaceAssets", "method": "GET", "path": "/api/v1/workspaces/{workspace}/assets", "summary": "List workspace assets", "description": "", "tags": [ "Workspaces" ], "effect": "read", "confirmation": "never", "authorization": { "mode": "privilege", "privilege": "USE_WORKSPACE" }, "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "type", "in": "query", "required": false, "description": "", "schema": { "type": "string" } }, { "name": "q", "in": "query", "required": false, "description": "", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "", "schema": { "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" } }, { "name": "pageToken", "in": "query", "required": false, "description": "", "schema": { "maxLength": 2048, "minLength": 1, "type": "string" } } ], "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/AssetListResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "listWorkspaceRoles", "method": "GET", "path": "/api/v1/workspaces/{workspace}/roles", "summary": "List workspace roles", "description": "", "tags": [ "Access" ], "effect": "read", "confirmation": "never", "authorization": { "mode": "privilege", "privilege": "MANAGE_GRANTS" }, "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "", "schema": { "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" } }, { "name": "pageToken", "in": "query", "required": false, "description": "", "schema": { "maxLength": 2048, "minLength": 1, "type": "string" } } ], "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/RoleListResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "listWorkspaces", "method": "GET", "path": "/api/v1/workspaces", "summary": "List workspaces", "description": "", "tags": [ "Workspaces" ], "effect": "read", "confirmation": "never", "authorization": { "mode": "privilege", "privilege": "USE_WORKSPACE" }, "parameters": [ { "name": "limit", "in": "query", "required": false, "description": "", "schema": { "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" } }, { "name": "pageToken", "in": "query", "required": false, "description": "", "schema": { "maxLength": 2048, "minLength": 1, "type": "string" } } ], "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/WorkspaceListResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "previewSemanticDataset", "method": "POST", "path": "/api/v1/workspaces/{workspace}/semantic-models/{model}/datasets/{dataset}/preview", "summary": "Preview semantic model dataset rows", "description": "", "tags": [ "BI" ], "effect": "write", "confirmation": "conditional", "authorization": { "mode": "privilege", "privilege": "PREVIEW_DATA" }, "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "model", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "dataset", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "accept", "in": "header", "required": false, "description": "", "schema": { "type": "string" } } ], "requestBody": { "required": false, "description": "", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/SemanticPreviewRequest" } } ] }, "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/SemanticQueryResponse" } }, { "contentType": "application/vnd.apache.arrow.stream", "schema": { "format": "binary", "type": "string" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "queryDashboardPage", "method": "POST", "path": "/api/v1/workspaces/{workspace}/dashboards/{dashboard}/pages/{page}/query", "summary": "Query dashboard page", "description": "", "tags": [ "BI" ], "effect": "write", "confirmation": "conditional", "authorization": { "mode": "privilege", "privilege": "QUERY_DATA" }, "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "dashboard", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "path", "required": true, "description": "", "schema": { "type": "string" } } ], "requestBody": { "required": false, "description": "", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/DashboardPageQueryRequest" } } ] }, "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/DashboardPageQueryResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "queryDashboardVisualData", "method": "POST", "path": "/api/v1/workspaces/{workspace}/dashboards/{dashboard}/pages/{page}/visuals/{visual}/query", "summary": "Query an existing dashboard visual with governed filters and compact analytical output", "description": "", "tags": [ "BI" ], "effect": "read", "confirmation": "never", "authorization": { "mode": "privilege", "privilege": "QUERY_DATA" }, "tool": { "name": "query_dashboard_visual", "effect": "read", "confirmation": "never" }, "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "", "schema": { "minLength": 1, "type": "string" } }, { "name": "dashboard", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "visual", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "accept", "in": "header", "required": false, "description": "", "schema": { "type": "string" } } ], "requestBody": { "required": false, "description": "", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/DashboardVisualQueryRequest" } } ] }, "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/VisualizationEnvelope" } }, { "contentType": "application/vnd.apache.arrow.stream", "schema": { "format": "binary", "type": "string" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "querySemanticModel", "method": "POST", "path": "/api/v1/workspaces/{workspace}/semantic-models/{model}/query", "summary": "Query governed semantic data with typed columns, filters, pagination, and provenance", "description": "", "tags": [ "BI" ], "effect": "read", "confirmation": "never", "authorization": { "mode": "privilege", "privilege": "QUERY_DATA" }, "tool": { "name": "query_semantic_model", "effect": "read", "confirmation": "never" }, "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "", "schema": { "minLength": 1, "type": "string" } }, { "name": "model", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "accept", "in": "header", "required": false, "description": "", "schema": { "type": "string" } } ], "requestBody": { "required": false, "description": "", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/SemanticQueryRequest" } } ] }, "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/SemanticQueryResponse" } }, { "contentType": "application/vnd.apache.arrow.stream", "schema": { "format": "binary", "type": "string" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "removeGroupMember", "method": "DELETE", "path": "/api/v1/workspaces/{workspace}/groups/{group}/members/{principal}", "summary": "Remove a group member", "description": "", "tags": [ "Access" ], "effect": "destructive", "confirmation": "required", "authorization": { "mode": "privilege", "privilege": "MANAGE_GRANTS" }, "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "group", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "principal", "in": "path", "required": true, "description": "", "schema": { "type": "string" } } ], "responses": [ { "status": "204", "description": "There is no content to send for this request, but the headers may be useful. ", "content": [] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "resetPrincipalPassword", "method": "POST", "path": "/api/v1/principals/{principal}/password-reset", "summary": "Reset a local principal password", "description": "", "tags": [ "Access" ], "effect": "write", "confirmation": "conditional", "authorization": { "mode": "privilege", "privilege": "MANAGE_GRANTS" }, "parameters": [ { "name": "principal", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "", "schema": { "maxLength": 200, "minLength": 1, "type": "string" } } ], "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/LocalPasswordResetResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "resumeDashboardPublication", "method": "POST", "path": "/api/v1/workspaces/{workspace}/dashboard-publications/{publication}/resume", "summary": "Resume a configured dashboard publication", "description": "", "tags": [ "Publications" ], "effect": "write", "confirmation": "conditional", "authorization": { "mode": "privilege", "privilege": "MANAGE_PUBLICATIONS" }, "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "publication", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "", "schema": { "maxLength": 200, "minLength": 1, "type": "string" } } ], "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/DashboardPublicationResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "revokeCurrentAPIToken", "method": "DELETE", "path": "/api/v1/me/api-tokens/{token}", "summary": "Revoke current API token", "description": "", "tags": [ "Current User" ], "effect": "destructive", "confirmation": "required", "authorization": { "mode": "privilege", "privilege": "MANAGE_GRANTS" }, "parameters": [ { "name": "token", "in": "path", "required": true, "description": "", "schema": { "type": "string" } } ], "responses": [ { "status": "204", "description": "There is no content to send for this request, but the headers may be useful. ", "content": [] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "revokeCurrentSession", "method": "DELETE", "path": "/api/v1/me/sessions/{session}", "summary": "Revoke current session", "description": "", "tags": [ "Current User" ], "effect": "destructive", "confirmation": "required", "authorization": { "mode": "privilege", "privilege": "USE_WORKSPACE" }, "parameters": [ { "name": "session", "in": "path", "required": true, "description": "", "schema": { "type": "string" } } ], "responses": [ { "status": "204", "description": "There is no content to send for this request, but the headers may be useful. ", "content": [] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "revokeServicePrincipalSecret", "method": "DELETE", "path": "/api/v1/service-principals/{servicePrincipal}/secrets/{secret}", "summary": "Revoke a service principal secret", "description": "", "tags": [ "Access" ], "effect": "destructive", "confirmation": "required", "authorization": { "mode": "privilege", "privilege": "MANAGE_PLATFORM" }, "parameters": [ { "name": "servicePrincipal", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "secret", "in": "path", "required": true, "description": "", "schema": { "type": "string" } } ], "responses": [ { "status": "204", "description": "There is no content to send for this request, but the headers may be useful. ", "content": [] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "rollbackDeployment", "method": "POST", "path": "/api/v1/projects/{project}/deployments/{deployment}/rollback", "summary": "Roll back by creating a deployment of the prior release", "description": "", "tags": [ "Deployments" ], "effect": "write", "confirmation": "conditional", "authorization": { "mode": "privilege", "privilege": "ACTIVATE_DEPLOYMENT" }, "parameters": [ { "name": "project", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "deployment", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "", "schema": { "maxLength": 200, "minLength": 1, "type": "string" } } ], "responses": [ { "status": "202", "description": "The request has been accepted for processing, but processing has not yet completed.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/DeploymentResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "rotateDashboardPublication", "method": "POST", "path": "/api/v1/workspaces/{workspace}/dashboard-publications/{publication}/rotate", "summary": "Rotate a dashboard publication public ID", "description": "", "tags": [ "Publications" ], "effect": "write", "confirmation": "conditional", "authorization": { "mode": "privilege", "privilege": "MANAGE_PUBLICATIONS" }, "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "publication", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "", "schema": { "maxLength": 200, "minLength": 1, "type": "string" } } ], "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/DashboardPublicationResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "search", "method": "GET", "path": "/api/v1/search", "summary": "Search accessible product objects", "description": "", "tags": [ "Search" ], "effect": "read", "confirmation": "never", "authorization": { "mode": "privilege", "privilege": "VIEW_ITEM" }, "parameters": [ { "name": "q", "in": "query", "required": false, "description": "", "schema": { "type": "string" } }, { "name": "workspace", "in": "query", "required": false, "description": "", "schema": { "items": { "type": "string" }, "type": "array" } }, { "name": "type", "in": "query", "required": false, "description": "", "schema": { "items": { "$ref": "#/components/schemas/SearchResultType" }, "type": "array" } }, { "name": "contextWorkspace", "in": "query", "required": false, "description": "", "schema": { "type": "string" } }, { "name": "contextDashboard", "in": "query", "required": false, "description": "", "schema": { "type": "string" } }, { "name": "contextPage", "in": "query", "required": false, "description": "", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "", "schema": { "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" } }, { "name": "pageToken", "in": "query", "required": false, "description": "", "schema": { "maxLength": 2048, "minLength": 1, "type": "string" } } ], "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/SearchResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "signManagedDataS3MultipartPart", "method": "POST", "path": "/api/v1/projects/{project}/connections/{connection}/upload-sessions/{uploadSession}/s3-multipart-uploads/{multipartUpload}/parts/{partNumber}/sign", "summary": "Sign one S3 multipart upload part", "description": "", "tags": [ "Managed Data" ], "effect": "write", "confirmation": "conditional", "authorization": { "mode": "privilege", "privilege": "INGEST_DATA" }, "parameters": [ { "name": "project", "in": "path", "required": true, "description": "", "schema": { "maxLength": 128, "minLength": 1, "type": "string" } }, { "name": "connection", "in": "path", "required": true, "description": "", "schema": { "maxLength": 128, "minLength": 1, "type": "string" } }, { "name": "uploadSession", "in": "path", "required": true, "description": "", "schema": { "maxLength": 160, "minLength": 1, "type": "string" } }, { "name": "multipartUpload", "in": "path", "required": true, "description": "", "schema": { "maxLength": 160, "minLength": 1, "type": "string" } }, { "name": "partNumber", "in": "path", "required": true, "description": "", "schema": { "format": "int32", "maximum": 10000, "minimum": 1, "type": "integer" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "", "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "requestBody": { "required": true, "description": "", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/ManagedDataS3MultipartSignPartRequest" } } ] }, "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/ManagedDataS3MultipartSignedPartResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "suspendDashboardPublication", "method": "POST", "path": "/api/v1/workspaces/{workspace}/dashboard-publications/{publication}/suspend", "summary": "Suspend a dashboard publication immediately", "description": "", "tags": [ "Publications" ], "effect": "write", "confirmation": "conditional", "authorization": { "mode": "privilege", "privilege": "MANAGE_PUBLICATIONS" }, "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "publication", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "", "schema": { "maxLength": 200, "minLength": 1, "type": "string" } } ], "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/DashboardPublicationResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "transferOwnership", "method": "POST", "path": "/api/v1/workspaces/{workspace}/ownership", "summary": "Transfer object ownership", "description": "", "tags": [ "Access" ], "effect": "write", "confirmation": "conditional", "authorization": { "mode": "privilege", "privilege": "MANAGE_ITEM" }, "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "", "schema": { "maxLength": 200, "minLength": 1, "type": "string" } } ], "requestBody": { "required": true, "description": "", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/OwnershipTransferRequest" } } ] }, "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/SecurableObjectResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "updateAgentConversation", "method": "PATCH", "path": "/api/v1/agent/conversations/{conversation}", "summary": "Update an agent conversation", "description": "", "tags": [ "Agent" ], "effect": "write", "confirmation": "conditional", "authorization": { "mode": "privilege", "privilege": "USE_AGENT" }, "parameters": [ { "name": "conversation", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "required": true, "description": "", "schema": { "type": "string" } } ], "requestBody": { "required": true, "description": "", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/AgentConversationPatchRequest" } } ] }, "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/AgentConversationResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "updateDataPolicy", "method": "PATCH", "path": "/api/v1/workspaces/{workspace}/data-policies/{policy}", "summary": "Update a data policy", "description": "", "tags": [ "Access" ], "effect": "write", "confirmation": "conditional", "authorization": { "mode": "privilege", "privilege": "MANAGE_GRANTS" }, "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "policy", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "required": true, "description": "", "schema": { "type": "string" } } ], "requestBody": { "required": true, "description": "", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/DataPolicyRequest" } } ] }, "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/DataPolicyResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "updateGrant", "method": "PATCH", "path": "/api/v1/workspaces/{workspace}/grants/{grant}", "summary": "Update an object privilege grant", "description": "", "tags": [ "Access" ], "effect": "write", "confirmation": "conditional", "authorization": { "mode": "privilege", "privilege": "MANAGE_GRANTS" }, "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "grant", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "required": true, "description": "", "schema": { "type": "string" } } ], "requestBody": { "required": true, "description": "", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/GrantRequest" } } ] }, "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/GrantResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "updateGroup", "method": "PATCH", "path": "/api/v1/workspaces/{workspace}/groups/{group}", "summary": "Update a group", "description": "", "tags": [ "Access" ], "effect": "write", "confirmation": "conditional", "authorization": { "mode": "privilege", "privilege": "MANAGE_GRANTS" }, "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "group", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "required": true, "description": "", "schema": { "type": "string" } } ], "requestBody": { "required": true, "description": "", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/GroupPatchRequest" } } ] }, "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/GroupResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "updatePrincipal", "method": "PATCH", "path": "/api/v1/principals/{principal}", "summary": "Update a principal", "description": "", "tags": [ "Access" ], "effect": "write", "confirmation": "conditional", "authorization": { "mode": "privilege", "privilege": "MANAGE_GRANTS" }, "parameters": [ { "name": "principal", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "required": true, "description": "", "schema": { "type": "string" } } ], "requestBody": { "required": true, "description": "", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/PrincipalPatchRequest" } } ] }, "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/PrincipalResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "updateRoleBinding", "method": "PATCH", "path": "/api/v1/workspaces/{workspace}/role-bindings/{binding}", "summary": "Update a role binding", "description": "", "tags": [ "Access" ], "effect": "write", "confirmation": "conditional", "authorization": { "mode": "privilege", "privilege": "MANAGE_GRANTS" }, "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "binding", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "required": true, "description": "", "schema": { "type": "string" } } ], "requestBody": { "required": true, "description": "", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/RoleBindingRequest" } } ] }, "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/RoleBindingResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "updateServicePrincipal", "method": "PATCH", "path": "/api/v1/service-principals/{servicePrincipal}", "summary": "Update a service principal", "description": "", "tags": [ "Access" ], "effect": "write", "confirmation": "conditional", "authorization": { "mode": "privilege", "privilege": "MANAGE_PLATFORM" }, "parameters": [ { "name": "servicePrincipal", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "required": true, "description": "", "schema": { "type": "string" } } ], "requestBody": { "required": true, "description": "", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/ServicePrincipalPatchRequest" } } ] }, "responses": [ { "status": "200", "description": "The request has succeeded.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/PrincipalResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] }, { "operationId": "uploadReleaseArtifact", "method": "PUT", "path": "/api/v1/projects/{project}/releases/{release}/workspaces/{workspace}/artifact", "summary": "Upload an immutable workspace artifact", "description": "", "tags": [ "Releases" ], "effect": "idempotent-write", "confirmation": "conditional", "authorization": { "mode": "privilege", "privilege": "DEPLOY" }, "parameters": [ { "name": "project", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "release", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "workspace", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "required": true, "description": "", "schema": { "enum": [ "application/octet-stream" ], "type": "string" } }, { "name": "Content-Digest", "in": "header", "required": true, "description": "", "schema": { "type": "string" } } ], "requestBody": { "required": true, "description": "", "content": [ { "contentType": "application/octet-stream", "schema": { "format": "binary", "type": "string" } } ] }, "responses": [ { "status": "201", "description": "The request has succeeded and a new resource has been created as a result.", "content": [ { "contentType": "application/json", "schema": { "$ref": "#/components/schemas/ReleaseArtifactResponse" } } ] }, { "status": "400", "description": "The server could not understand the request due to invalid syntax.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "401", "description": "Access is unauthorized.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "403", "description": "Access is forbidden.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "404", "description": "The server cannot find the requested resource.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "409", "description": "The request conflicts with the current state of the server.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "412", "description": "Precondition failed.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "413", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "415", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "422", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "429", "description": "Client error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "500", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "502", "description": "Server error", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] }, { "status": "503", "description": "Service unavailable.", "content": [ { "contentType": "application/problem+json", "schema": { "$ref": "#/components/schemas/ProblemDetails" } } ] } ] } ], "schemas": { "APITokenCreateRequest": { "example": { "expiresAt": "2026-01-02T15:04:05Z", "name": "example", "privileges": [ "example" ], "workspaceId": "example" }, "properties": { "expiresAt": { "example": "2026-01-02T15:04:05Z", "format": "date-time", "type": "string" }, "name": { "example": "example", "type": "string" }, "privileges": { "example": [ "example" ], "items": { "type": "string" }, "type": "array" }, "workspaceId": { "example": "example", "type": "string" } }, "required": [ "name" ], "type": "object" }, "APITokenCreateResponse": { "example": { "apiToken": { "createdAt": "2026-01-02T15:04:05Z", "expiresAt": "2026-01-02T15:04:05Z", "id": "example", "lastUsedAt": "2026-01-02T15:04:05Z", "name": "example", "privileges": [ "example" ], "revokedAt": "2026-01-02T15:04:05Z", "workspaceId": "example" }, "token": "example" }, "properties": { "apiToken": { "$ref": "#/components/schemas/APITokenResponse" }, "token": { "example": "example", "type": "string" } }, "required": [ "token", "apiToken" ], "type": "object" }, "APITokenListResponse": { "example": { "items": [ { "createdAt": "2026-01-02T15:04:05Z", "expiresAt": "2026-01-02T15:04:05Z", "id": "example", "lastUsedAt": "2026-01-02T15:04:05Z", "name": "example", "privileges": [ "example" ], "revokedAt": "2026-01-02T15:04:05Z", "workspaceId": "example" } ], "page": { "nextCursor": "example" } }, "properties": { "items": { "example": [ { "createdAt": "2026-01-02T15:04:05Z", "expiresAt": "2026-01-02T15:04:05Z", "id": "example", "lastUsedAt": "2026-01-02T15:04:05Z", "name": "example", "privileges": [ "example" ], "revokedAt": "2026-01-02T15:04:05Z", "workspaceId": "example" } ], "items": { "$ref": "#/components/schemas/APITokenResponse" }, "type": "array" }, "page": { "$ref": "#/components/schemas/PageInfo" } }, "required": [ "items", "page" ], "type": "object" }, "APITokenResponse": { "example": { "createdAt": "2026-01-02T15:04:05Z", "expiresAt": "2026-01-02T15:04:05Z", "id": "example", "lastUsedAt": "2026-01-02T15:04:05Z", "name": "example", "privileges": [ "example" ], "revokedAt": "2026-01-02T15:04:05Z", "workspaceId": "example" }, "properties": { "createdAt": { "example": "2026-01-02T15:04:05Z", "format": "date-time", "type": "string" }, "expiresAt": { "example": "2026-01-02T15:04:05Z", "format": "date-time", "type": "string" }, "id": { "example": "example", "type": "string" }, "lastUsedAt": { "example": "2026-01-02T15:04:05Z", "format": "date-time", "type": "string" }, "name": { "example": "example", "type": "string" }, "privileges": { "example": [ "example" ], "items": { "type": "string" }, "type": "array" }, "revokedAt": { "example": "2026-01-02T15:04:05Z", "format": "date-time", "type": "string" }, "workspaceId": { "example": "example", "type": "string" } }, "required": [ "id", "name", "privileges", "createdAt" ], "type": "object" }, "AgentConversationCreateRequest": { "example": { "title": "example" }, "properties": { "title": { "example": "example", "type": "string" } }, "type": "object" }, "AgentConversationListResponse": { "example": { "items": [ { "archivedAt": "2026-01-02T15:04:05Z", "createdAt": "2026-01-02T15:04:05Z", "id": "example", "lastMessageText": "example", "messageCount": 1, "principalId": "example", "status": "example", "title": "example", "titlePending": true, "updatedAt": "2026-01-02T15:04:05Z" } ], "page": { "nextCursor": "example" } }, "properties": { "items": { "example": [ { "archivedAt": "2026-01-02T15:04:05Z", "createdAt": "2026-01-02T15:04:05Z", "id": "example", "lastMessageText": "example", "messageCount": 1, "principalId": "example", "status": "example", "title": "example", "titlePending": true, "updatedAt": "2026-01-02T15:04:05Z" } ], "items": { "$ref": "#/components/schemas/AgentConversationResponse" }, "type": "array" }, "page": { "$ref": "#/components/schemas/PageInfo" } }, "required": [ "items", "page" ], "type": "object" }, "AgentConversationPatchRequest": { "example": { "title": "example" }, "properties": { "title": { "example": "example", "type": "string" } }, "type": "object" }, "AgentConversationResponse": { "example": { "archivedAt": "2026-01-02T15:04:05Z", "createdAt": "2026-01-02T15:04:05Z", "id": "example", "lastMessageText": "example", "messageCount": 1, "principalId": "example", "status": "example", "title": "example", "titlePending": true, "updatedAt": "2026-01-02T15:04:05Z" }, "properties": { "archivedAt": { "example": "2026-01-02T15:04:05Z", "format": "date-time", "type": "string" }, "createdAt": { "example": "2026-01-02T15:04:05Z", "format": "date-time", "type": "string" }, "id": { "example": "example", "type": "string" }, "lastMessageText": { "example": "example", "type": "string" }, "messageCount": { "example": 1, "format": "int32", "type": "integer" }, "principalId": { "example": "example", "type": "string" }, "status": { "example": "example", "type": "string" }, "title": { "example": "example", "type": "string" }, "titlePending": { "example": true, "type": "boolean" }, "updatedAt": { "example": "2026-01-02T15:04:05Z", "format": "date-time", "type": "string" } }, "required": [ "id", "principalId", "title", "status", "createdAt", "updatedAt" ], "type": "object" }, "AgentMessageListResponse": { "example": { "items": [ { "content": { "key": "example" }, "contentText": "example", "createdAt": "2026-01-02T15:04:05Z", "id": "example", "isError": true, "role": "example", "runId": "example", "seq": 1, "toolCallId": "example", "toolName": "example" } ], "page": { "nextCursor": "example" } }, "properties": { "items": { "example": [ { "content": { "key": "example" }, "contentText": "example", "createdAt": "2026-01-02T15:04:05Z", "id": "example", "isError": true, "role": "example", "runId": "example", "seq": 1, "toolCallId": "example", "toolName": "example" } ], "items": { "$ref": "#/components/schemas/AgentMessageResponse" }, "type": "array" }, "page": { "$ref": "#/components/schemas/PageInfo" } }, "required": [ "items", "page" ], "type": "object" }, "AgentMessageResponse": { "example": { "content": { "key": "example" }, "contentText": "example", "createdAt": "2026-01-02T15:04:05Z", "id": "example", "isError": true, "role": "example", "runId": "example", "seq": 1, "toolCallId": "example", "toolName": "example" }, "properties": { "content": { "additionalProperties": {}, "example": { "key": "example" }, "type": "object" }, "contentText": { "example": "example", "type": "string" }, "createdAt": { "example": "2026-01-02T15:04:05Z", "format": "date-time", "type": "string" }, "id": { "example": "example", "type": "string" }, "isError": { "example": true, "type": "boolean" }, "role": { "example": "example", "type": "string" }, "runId": { "example": "example", "type": "string" }, "seq": { "example": 1, "format": "int64", "type": "integer" }, "toolCallId": { "example": "example", "type": "string" }, "toolName": { "example": "example", "type": "string" } }, "required": [ "id", "seq", "role", "createdAt" ], "type": "object" }, "AgentRunCreateRequest": { "example": { "correlationId": "example", "input": "example" }, "properties": { "correlationId": { "example": "example", "type": "string" }, "input": { "example": "example", "type": "string" } }, "required": [ "input" ], "type": "object" }, "AgentRunListResponse": { "example": { "items": [ { "completedAt": "2026-01-02T15:04:05Z", "conversationId": "example", "createdAt": "2026-01-02T15:04:05Z", "error": "example", "id": "example", "model": "example", "principalId": "example", "startedAt": "2026-01-02T15:04:05Z", "status": "example", "stopReason": "example" } ], "page": { "nextCursor": "example" } }, "properties": { "items": { "example": [ { "completedAt": "2026-01-02T15:04:05Z", "conversationId": "example", "createdAt": "2026-01-02T15:04:05Z", "error": "example", "id": "example", "model": "example", "principalId": "example", "startedAt": "2026-01-02T15:04:05Z", "status": "example", "stopReason": "example" } ], "items": { "$ref": "#/components/schemas/AgentRunResponse" }, "type": "array" }, "page": { "$ref": "#/components/schemas/PageInfo" } }, "required": [ "items", "page" ], "type": "object" }, "AgentRunResponse": { "example": { "completedAt": "2026-01-02T15:04:05Z", "conversationId": "example", "createdAt": "2026-01-02T15:04:05Z", "error": "example", "id": "example", "model": "example", "principalId": "example", "startedAt": "2026-01-02T15:04:05Z", "status": "example", "stopReason": "example" }, "properties": { "completedAt": { "example": "2026-01-02T15:04:05Z", "format": "date-time", "type": "string" }, "conversationId": { "example": "example", "type": "string" }, "createdAt": { "example": "2026-01-02T15:04:05Z", "format": "date-time", "type": "string" }, "error": { "example": "example", "type": "string" }, "id": { "example": "example", "type": "string" }, "model": { "example": "example", "type": "string" }, "principalId": { "example": "example", "type": "string" }, "startedAt": { "example": "2026-01-02T15:04:05Z", "format": "date-time", "type": "string" }, "status": { "example": "example", "type": "string" }, "stopReason": { "example": "example", "type": "string" } }, "required": [ "id", "conversationId", "principalId", "status", "createdAt" ], "type": "object" }, "AssetEdgeListResponse": { "example": { "items": [ { "fromAssetId": "example", "id": "example", "servingStateId": "example", "toAssetId": "example", "type": "example", "workspaceId": "example" } ], "page": { "nextCursor": "example" } }, "properties": { "items": { "example": [ { "fromAssetId": "example", "id": "example", "servingStateId": "example", "toAssetId": "example", "type": "example", "workspaceId": "example" } ], "items": { "$ref": "#/components/schemas/AssetEdgeResponse" }, "type": "array" }, "page": { "$ref": "#/components/schemas/PageInfo" } }, "required": [ "items", "page" ], "type": "object" }, "AssetEdgeResponse": { "example": { "fromAssetId": "example", "id": "example", "servingStateId": "example", "toAssetId": "example", "type": "example", "workspaceId": "example" }, "properties": { "fromAssetId": { "example": "example", "type": "string" }, "id": { "example": "example", "type": "string" }, "servingStateId": { "example": "example", "type": "string" }, "toAssetId": { "example": "example", "type": "string" }, "type": { "example": "example", "type": "string" }, "workspaceId": { "example": "example", "type": "string" } }, "required": [ "id", "workspaceId", "servingStateId", "fromAssetId", "toAssetId", "type" ], "type": "object" }, "AssetGraphAssetResponse": { "example": { "contentHash": "example", "description": "example", "id": "example", "key": "example", "parentId": "example", "payload": { "key": "example" }, "payloadSchema": "example", "servingStateId": "example", "snapshotId": "example", "sourceFile": "example", "title": "example", "type": "example", "workspaceId": "example" }, "properties": { "contentHash": { "example": "example", "type": "string" }, "description": { "example": "example", "type": "string" }, "id": { "example": "example", "type": "string" }, "key": { "example": "example", "type": "string" }, "parentId": { "example": "example", "type": "string" }, "payload": { "additionalProperties": {}, "example": { "key": "example" }, "type": "object" }, "payloadSchema": { "example": "example", "type": "string" }, "servingStateId": { "example": "example", "type": "string" }, "snapshotId": { "example": "example", "type": "string" }, "sourceFile": { "example": "example", "type": "string" }, "title": { "example": "example", "type": "string" }, "type": { "example": "example", "type": "string" }, "workspaceId": { "example": "example", "type": "string" } }, "required": [ "id", "snapshotId", "workspaceId", "servingStateId", "type", "key", "title", "description", "payloadSchema", "payload", "contentHash" ], "type": "object" }, "AssetLineageResponse": { "example": { "assetId": "example", "downstream": [ "example" ], "upstream": [ "example" ] }, "properties": { "assetId": { "example": "example", "type": "string" }, "downstream": { "example": [ "example" ], "items": { "type": "string" }, "type": "array" }, "upstream": { "example": [ "example" ], "items": { "type": "string" }, "type": "array" } }, "required": [ "assetId", "upstream", "downstream" ], "type": "object" }, "AssetListResponse": { "example": { "items": [ { "contentHash": "example", "description": "example", "href": "example", "id": "example", "key": "example", "parentId": "example", "payloadSchema": "example", "servingStateId": "example", "snapshotId": "example", "sourceFile": "example", "title": "example", "type": "example", "workspaceId": "example" } ], "page": { "nextCursor": "example" } }, "properties": { "items": { "example": [ { "contentHash": "example", "description": "example", "href": "example", "id": "example", "key": "example", "parentId": "example", "payloadSchema": "example", "servingStateId": "example", "snapshotId": "example", "sourceFile": "example", "title": "example", "type": "example", "workspaceId": "example" } ], "items": { "$ref": "#/components/schemas/AssetSummaryResponse" }, "type": "array" }, "page": { "$ref": "#/components/schemas/PageInfo" } }, "required": [ "items", "page" ], "type": "object" }, "AssetResponse": { "example": { "description": "example", "href": "example", "id": "example", "key": "example", "parentId": "example", "payload": { "key": "example" }, "payloadSchema": "example", "servingStateId": "example", "snapshotId": "example", "sourceFile": "example", "title": "example", "type": "example", "workspaceId": "example" }, "properties": { "description": { "example": "example", "type": "string" }, "href": { "example": "example", "type": "string" }, "id": { "example": "example", "type": "string" }, "key": { "example": "example", "type": "string" }, "parentId": { "example": "example", "type": "string" }, "payload": { "additionalProperties": {}, "example": { "key": "example" }, "type": "object" }, "payloadSchema": { "example": "example", "type": "string" }, "servingStateId": { "example": "example", "type": "string" }, "snapshotId": { "example": "example", "type": "string" }, "sourceFile": { "example": "example", "type": "string" }, "title": { "example": "example", "type": "string" }, "type": { "example": "example", "type": "string" }, "workspaceId": { "example": "example", "type": "string" } }, "required": [ "id", "snapshotId", "workspaceId", "servingStateId", "type", "key", "title", "description", "payloadSchema", "payload" ], "type": "object" }, "AssetSummaryResponse": { "example": { "contentHash": "example", "description": "example", "href": "example", "id": "example", "key": "example", "parentId": "example", "payloadSchema": "example", "servingStateId": "example", "snapshotId": "example", "sourceFile": "example", "title": "example", "type": "example", "workspaceId": "example" }, "properties": { "contentHash": { "example": "example", "type": "string" }, "description": { "example": "example", "type": "string" }, "href": { "example": "example", "type": "string" }, "id": { "example": "example", "type": "string" }, "key": { "example": "example", "type": "string" }, "parentId": { "example": "example", "type": "string" }, "payloadSchema": { "example": "example", "type": "string" }, "servingStateId": { "example": "example", "type": "string" }, "snapshotId": { "example": "example", "type": "string" }, "sourceFile": { "example": "example", "type": "string" }, "title": { "example": "example", "type": "string" }, "type": { "example": "example", "type": "string" }, "workspaceId": { "example": "example", "type": "string" } }, "required": [ "id", "snapshotId", "workspaceId", "servingStateId", "type", "key", "title", "description", "payloadSchema", "contentHash" ], "type": "object" }, "AsyncEventListResponse": { "example": { "items": [ { "createdAt": "2026-01-02T15:04:05Z", "data": { "key": "example" }, "error": { "code": "example", "detail": "example" }, "event": "example", "id": "example", "progress": { "current": 1, "message": "example", "percent": 1, "total": 1 }, "resourceId": "example", "resourceType": "example" } ], "page": { "nextCursor": "example" } }, "properties": { "items": { "example": [ { "createdAt": "2026-01-02T15:04:05Z", "data": { "key": "example" }, "error": { "code": "example", "detail": "example" }, "event": "example", "id": "example", "progress": { "current": 1, "message": "example", "percent": 1, "total": 1 }, "resourceId": "example", "resourceType": "example" } ], "items": { "$ref": "#/components/schemas/AsyncEventResponse" }, "type": "array" }, "page": { "$ref": "#/components/schemas/PageInfo" } }, "required": [ "items", "page" ], "type": "object" }, "AsyncEventResponse": { "example": { "createdAt": "2026-01-02T15:04:05Z", "data": { "key": "example" }, "error": { "code": "example", "detail": "example" }, "event": "example", "id": "example", "progress": { "current": 1, "message": "example", "percent": 1, "total": 1 }, "resourceId": "example", "resourceType": "example" }, "properties": { "createdAt": { "example": "2026-01-02T15:04:05Z", "format": "date-time", "type": "string" }, "data": { "additionalProperties": {}, "example": { "key": "example" }, "type": "object" }, "error": { "$ref": "#/components/schemas/AsyncStructuredError" }, "event": { "example": "example", "type": "string" }, "id": { "example": "example", "type": "string" }, "progress": { "$ref": "#/components/schemas/AsyncProgress" }, "resourceId": { "example": "example", "type": "string" }, "resourceType": { "example": "example", "type": "string" } }, "required": [ "id", "event", "resourceType", "resourceId", "createdAt", "data" ], "type": "object" }, "AsyncProgress": { "example": { "current": 1, "message": "example", "percent": 1, "total": 1 }, "properties": { "current": { "example": 1, "format": "int64", "type": "integer" }, "message": { "example": "example", "type": "string" }, "percent": { "example": 1, "format": "double", "type": "number" }, "total": { "example": 1, "format": "int64", "type": "integer" } }, "type": "object" }, "AsyncStructuredError": { "example": { "code": "example", "detail": "example" }, "properties": { "code": { "example": "example", "type": "string" }, "detail": { "example": "example", "type": "string" } }, "required": [ "code", "detail" ], "type": "object" }, "AuditEventListResponse": { "example": { "items": [ { "action": "example", "correlationId": "example", "createdAt": "2026-01-02T15:04:05Z", "id": "example", "metadata": { "key": "example" }, "principalId": "example", "privilege": "example", "requestId": "example", "status": "example", "targetId": "example", "targetType": "example", "workspaceId": "example" } ], "page": { "nextCursor": "example" } }, "properties": { "items": { "example": [ { "action": "example", "correlationId": "example", "createdAt": "2026-01-02T15:04:05Z", "id": "example", "metadata": { "key": "example" }, "principalId": "example", "privilege": "example", "requestId": "example", "status": "example", "targetId": "example", "targetType": "example", "workspaceId": "example" } ], "items": { "$ref": "#/components/schemas/AuditEventResponse" }, "type": "array" }, "page": { "$ref": "#/components/schemas/PageInfo" } }, "required": [ "items", "page" ], "type": "object" }, "AuditEventResponse": { "example": { "action": "example", "correlationId": "example", "createdAt": "2026-01-02T15:04:05Z", "id": "example", "metadata": { "key": "example" }, "principalId": "example", "privilege": "example", "requestId": "example", "status": "example", "targetId": "example", "targetType": "example", "workspaceId": "example" }, "properties": { "action": { "example": "example", "type": "string" }, "correlationId": { "example": "example", "type": "string" }, "createdAt": { "example": "2026-01-02T15:04:05Z", "format": "date-time", "type": "string" }, "id": { "example": "example", "type": "string" }, "metadata": { "additionalProperties": {}, "example": { "key": "example" }, "type": "object" }, "principalId": { "example": "example", "type": "string" }, "privilege": { "example": "example", "type": "string" }, "requestId": { "example": "example", "type": "string" }, "status": { "example": "example", "type": "string" }, "targetId": { "example": "example", "type": "string" }, "targetType": { "example": "example", "type": "string" }, "workspaceId": { "example": "example", "type": "string" } }, "required": [ "id", "workspaceId", "action", "targetType", "targetId", "metadata", "createdAt" ], "type": "object" }, "AuthenticationMode": { "enum": [ "bearer" ], "example": "bearer", "type": "string" }, "AuthorizationBatchCheckRequest": { "example": { "checks": [ { "objectId": "example", "objectType": "example", "privilege": "example" } ] }, "properties": { "checks": { "example": [ { "objectId": "example", "objectType": "example", "privilege": "example" } ], "items": { "$ref": "#/components/schemas/AuthorizationCheckRequest" }, "type": "array" } }, "required": [ "checks" ], "type": "object" }, "AuthorizationBatchCheckResponse": { "example": { "decisions": [ { "allowed": true, "grantId": "example", "grantObjectId": "example", "inherited": true, "objectId": "example", "objectType": "example", "owner": true, "platform": true, "privilege": "example", "reason": "example", "subjectId": "example", "subjectType": "example" } ] }, "properties": { "decisions": { "example": [ { "allowed": true, "grantId": "example", "grantObjectId": "example", "inherited": true, "objectId": "example", "objectType": "example", "owner": true, "platform": true, "privilege": "example", "reason": "example", "subjectId": "example", "subjectType": "example" } ], "items": { "$ref": "#/components/schemas/AuthorizationDecisionResponse" }, "type": "array" } }, "required": [ "decisions" ], "type": "object" }, "AuthorizationCheckRequest": { "example": { "objectId": "example", "objectType": "example", "privilege": "example" }, "properties": { "objectId": { "example": "example", "type": "string" }, "objectType": { "example": "example", "type": "string" }, "privilege": { "example": "example", "type": "string" } }, "required": [ "privilege" ], "type": "object" }, "AuthorizationDecisionResponse": { "example": { "allowed": true, "grantId": "example", "grantObjectId": "example", "inherited": true, "objectId": "example", "objectType": "example", "owner": true, "platform": true, "privilege": "example", "reason": "example", "subjectId": "example", "subjectType": "example" }, "properties": { "allowed": { "example": true, "type": "boolean" }, "grantId": { "example": "example", "type": "string" }, "grantObjectId": { "example": "example", "type": "string" }, "inherited": { "example": true, "type": "boolean" }, "objectId": { "example": "example", "type": "string" }, "objectType": { "example": "example", "type": "string" }, "owner": { "example": true, "type": "boolean" }, "platform": { "example": true, "type": "boolean" }, "privilege": { "example": "example", "type": "string" }, "reason": { "example": "example", "type": "string" }, "subjectId": { "example": "example", "type": "string" }, "subjectType": { "example": "example", "type": "string" } }, "required": [ "privilege", "reason", "objectType", "inherited", "owner", "platform" ], "type": "object" }, "CapabilitiesResponse": { "example": { "apiVersion": "example", "authentication": [ "bearer" ], "buildDevelopment": true, "buildDirty": true, "buildRevision": "example", "buildTime": "example", "buildVersion": "example", "environment": "example", "queryFormats": [ "application/json" ], "uploadProtocols": [ "tus" ], "visualization": { "renderers": [ { "id": "echarts", "kinds": [ "cartesian" ], "schemaVersion": 1, "version": "example" } ], "schemaVersion": 1 } }, "properties": { "apiVersion": { "example": "example", "type": "string" }, "authentication": { "example": [ "bearer" ], "items": { "$ref": "#/components/schemas/AuthenticationMode" }, "type": "array" }, "buildDevelopment": { "example": true, "type": "boolean" }, "buildDirty": { "example": true, "type": "boolean" }, "buildRevision": { "example": "example", "type": "string" }, "buildTime": { "example": "example", "type": "string" }, "buildVersion": { "example": "example", "type": "string" }, "environment": { "example": "example", "type": "string" }, "queryFormats": { "example": [ "application/json" ], "items": { "$ref": "#/components/schemas/QueryFormat" }, "type": "array" }, "uploadProtocols": { "example": [ "tus" ], "items": { "$ref": "#/components/schemas/UploadProtocol" }, "type": "array" }, "visualization": { "$ref": "#/components/schemas/VisualizationCapabilities" } }, "required": [ "apiVersion", "buildVersion", "buildRevision", "buildTime", "buildDirty", "buildDevelopment", "environment", "authentication", "queryFormats", "uploadProtocols", "visualization" ], "type": "object" }, "CartesianVisualizationPresentation": { "allOf": [ { "$ref": "#/components/schemas/VisualizationPresentation" } ], "example": { "area": true, "comboSeries": [ { "axis": "primary", "mark": "line", "seriesValue": "example" } ], "dataZoom": true, "histogramBins": 1, "labelPosition": "automatic", "orientation": "horizontal", "showSymbols": true, "smooth": true, "stacked": true, "step": true, "symbolSize": 1 }, "properties": { "area": { "example": true, "type": "boolean" }, "comboSeries": { "example": [ { "axis": "primary", "mark": "line", "seriesValue": "example" } ], "items": { "$ref": "#/components/schemas/VisualizationComboSeries" }, "type": "array" }, "dataZoom": { "example": true, "type": "boolean" }, "histogramBins": { "example": 1, "format": "int32", "type": "integer" }, "labelPosition": { "$ref": "#/components/schemas/VisualizationLabelPosition" }, "orientation": { "$ref": "#/components/schemas/VisualizationOrientation" }, "showSymbols": { "example": true, "type": "boolean" }, "smooth": { "example": true, "type": "boolean" }, "stacked": { "example": true, "type": "boolean" }, "step": { "example": true, "type": "boolean" }, "symbolSize": { "example": 1, "format": "double", "type": "number" } }, "required": [ "smooth", "stacked", "showSymbols", "dataZoom", "area", "step" ], "type": "object" }, "CartesianVisualizationSpec": { "allOf": [ { "$ref": "#/components/schemas/VisualizationSpecBase" } ], "example": { "kind": "example", "mark": "line", "presentation": { "area": true, "comboSeries": [ { "axis": "primary", "mark": "line", "seriesValue": "example" } ], "dataZoom": true, "histogramBins": 1, "labelPosition": "automatic", "orientation": "horizontal", "showSymbols": true, "smooth": true, "stacked": true, "step": true, "symbolSize": 1 }, "series": { "dataset": "example", "field": "example" }, "x": { "dataset": "example", "field": "example" }, "y": [ { "dataset": "example", "field": "example" } ] }, "properties": { "kind": { "enum": [ "cartesian" ], "example": "example", "type": "string" }, "mark": { "$ref": "#/components/schemas/VisualizationCartesianMark" }, "presentation": { "$ref": "#/components/schemas/CartesianVisualizationPresentation" }, "series": { "$ref": "#/components/schemas/VisualizationFieldRef" }, "x": { "$ref": "#/components/schemas/VisualizationFieldRef" }, "y": { "example": [ { "dataset": "example", "field": "example" } ], "items": { "$ref": "#/components/schemas/VisualizationFieldRef" }, "type": "array" } }, "required": [ "kind", "mark", "x", "y", "presentation" ], "type": "object" }, "CompactVisualizationFormat": { "allOf": [ { "$ref": "#/components/schemas/VisualizationFormatBase" } ], "example": { "kind": "example", "maximumFractionDigits": 1 }, "properties": { "kind": { "enum": [ "compact" ], "example": "example", "type": "string" }, "maximumFractionDigits": { "example": 1, "format": "int32", "type": "integer" } }, "required": [ "kind" ], "type": "object" }, "CurrencyVisualizationFormat": { "allOf": [ { "$ref": "#/components/schemas/VisualizationFormatBase" } ], "example": { "currency": "example", "kind": "example", "maximumFractionDigits": 1, "minimumFractionDigits": 1 }, "properties": { "currency": { "example": "example", "type": "string" }, "kind": { "enum": [ "currency" ], "example": "example", "type": "string" }, "maximumFractionDigits": { "example": 1, "format": "int32", "type": "integer" }, "minimumFractionDigits": { "example": 1, "format": "int32", "type": "integer" } }, "required": [ "kind", "currency" ], "type": "object" }, "CustomVisualizationSpec": { "allOf": [ { "$ref": "#/components/schemas/VisualizationSpecBase" } ], "example": { "engine": "vega_lite", "kind": "example", "program": "example", "programDigest": "example" }, "properties": { "engine": { "$ref": "#/components/schemas/VisualizationCustomEngine" }, "kind": { "enum": [ "custom" ], "example": "example", "type": "string" }, "program": { "example": "example", "type": "string" }, "programDigest": { "example": "example", "type": "string" } }, "required": [ "kind", "engine", "program", "programDigest" ], "type": "object" }, "DashboardAppliedFilterInput": { "example": { "controls": { "key": {} }, "version": "example" }, "properties": { "controls": { "additionalProperties": { "$ref": "#/components/schemas/DashboardFilterExpression" }, "example": { "key": {} }, "type": "object" }, "version": { "enum": [ "typed_v1" ], "example": "example", "type": "string" } }, "required": [ "version", "controls" ], "type": "object" }, "DashboardBooleanFilterValue": { "allOf": [ { "$ref": "#/components/schemas/DashboardFilterValueBase" } ], "example": { "kind": "example", "value": true }, "properties": { "kind": { "enum": [ "boolean" ], "example": "example", "type": "string" }, "value": { "example": true, "type": "boolean" } }, "required": [ "kind", "value" ], "type": "object" }, "DashboardComparisonExpression": { "allOf": [ { "$ref": "#/components/schemas/DashboardFilterExpressionBase" } ], "example": { "kind": "example", "operator": "example" }, "properties": { "kind": { "enum": [ "comparison" ], "example": "example", "type": "string" }, "operator": { "enum": [ "equals", "not_equals", "contains", "not_contains", "starts_with", "ends_with", "greater_than", "greater_than_or_equal", "less_than", "less_than_or_equal" ], "example": "example", "type": "string" }, "value": { "$ref": "#/components/schemas/DashboardFilterValue" } }, "required": [ "kind", "operator", "value" ], "type": "object" }, "DashboardCompiledFilterBinding": { "example": { "filter": "example", "id": "example", "key": "example", "maxSelectedValues": 1, "optionDependencies": [ { "id": "example", "scope": "example" } ], "pageID": "example", "paneLabel": "example", "paneOrder": 1, "paneVisible": true, "readerEditable": true, "scope": "example", "selectionMode": "example", "targets": [ "example" ], "urlEncoding": "example", "urlParam": "example" }, "properties": { "default": { "$ref": "#/components/schemas/DashboardFilterExpression" }, "filter": { "example": "example", "type": "string" }, "id": { "example": "example", "type": "string" }, "key": { "example": "example", "type": "string" }, "maxSelectedValues": { "example": 1, "format": "int32", "type": "integer" }, "optionDependencies": { "example": [ { "id": "example", "scope": "example" } ], "items": { "$ref": "#/components/schemas/DashboardFilterBindingRef" }, "type": "array" }, "pageID": { "example": "example", "type": "string" }, "paneLabel": { "example": "example", "type": "string" }, "paneOrder": { "example": 1, "format": "int32", "type": "integer" }, "paneVisible": { "example": true, "type": "boolean" }, "readerEditable": { "example": true, "type": "boolean" }, "scope": { "enum": [ "report", "page" ], "example": "example", "type": "string" }, "selectionMode": { "enum": [ "single", "multiple" ], "example": "example", "type": "string" }, "targets": { "example": [ "example" ], "items": { "type": "string" }, "type": "array" }, "urlEncoding": { "enum": [ "typed_v1" ], "example": "example", "type": "string" }, "urlParam": { "example": "example", "type": "string" } }, "required": [ "key", "id", "filter", "scope", "default", "selectionMode", "maxSelectedValues", "readerEditable", "paneVisible", "paneOrder", "targets", "optionDependencies" ], "type": "object" }, "DashboardCompiledFilterDefinition": { "example": { "calendar": "example", "description": "example", "fact": "example", "field": "example", "formatPattern": "example", "formatUnit": "example", "id": "example", "label": "example", "options": { "kind": "example", "limit": 1, "values": [ { "label": "example" } ] }, "predicates": [ { "kind": "example", "operators": [ "example" ] } ], "timezone": "example", "valueKind": "example", "weekStart": "example" }, "properties": { "calendar": { "example": "example", "type": "string" }, "description": { "example": "example", "type": "string" }, "fact": { "example": "example", "type": "string" }, "field": { "example": "example", "type": "string" }, "formatPattern": { "example": "example", "type": "string" }, "formatUnit": { "example": "example", "type": "string" }, "id": { "example": "example", "type": "string" }, "label": { "example": "example", "type": "string" }, "options": { "$ref": "#/components/schemas/DashboardFilterOptionSource" }, "predicates": { "example": [ { "kind": "example", "operators": [ "example" ] } ], "items": { "$ref": "#/components/schemas/DashboardFilterPredicatePolicy" }, "type": "array" }, "timezone": { "example": "example", "type": "string" }, "valueKind": { "enum": [ "string", "boolean", "integer", "decimal", "date", "timestamp" ], "example": "example", "type": "string" }, "weekStart": { "example": "example", "type": "string" } }, "required": [ "id", "label", "field", "valueKind", "predicates", "options", "timezone", "calendar", "weekStart" ], "type": "object" }, "DashboardComponentPlacement": { "example": { "col": 1, "colSpan": 1, "row": 1, "rowSpan": 1 }, "properties": { "col": { "example": 1, "format": "int32", "type": "integer" }, "colSpan": { "example": 1, "format": "int32", "type": "integer" }, "row": { "example": 1, "format": "int32", "type": "integer" }, "rowSpan": { "example": 1, "format": "int32", "type": "integer" } }, "type": "object" }, "DashboardComponentResponse": { "discriminator": { "mapping": { "filter": "#/components/schemas/DashboardFilterComponentResponse", "header": "#/components/schemas/DashboardHeaderComponentResponse", "visual": "#/components/schemas/DashboardVisualComponentResponse" }, "propertyName": "kind" }, "oneOf": [ { "$ref": "#/components/schemas/DashboardVisualComponentResponse" }, { "$ref": "#/components/schemas/DashboardFilterComponentResponse" }, { "$ref": "#/components/schemas/DashboardHeaderComponentResponse" } ] }, "DashboardComponentResponseBase": { "example": { "description": "example", "height": 1, "id": "example", "kind": "example", "placement": { "col": 1, "colSpan": 1, "row": 1, "rowSpan": 1 }, "ref": "example", "title": "example", "width": 1, "x": 1, "y": 1 }, "properties": { "description": { "example": "example", "type": "string" }, "height": { "example": 1, "format": "double", "type": "number" }, "id": { "example": "example", "type": "string" }, "kind": { "enum": [ "visual", "filter", "header" ], "example": "example", "type": "string" }, "placement": { "$ref": "#/components/schemas/DashboardComponentPlacement" }, "ref": { "example": "example", "type": "string" }, "title": { "example": "example", "type": "string" }, "width": { "example": 1, "format": "double", "type": "number" }, "x": { "example": 1, "format": "double", "type": "number" }, "y": { "example": 1, "format": "double", "type": "number" } }, "required": [ "id", "kind" ], "type": "object" }, "DashboardDateFilterValue": { "allOf": [ { "$ref": "#/components/schemas/DashboardFilterValueBase" } ], "example": { "kind": "example", "value": "example" }, "properties": { "kind": { "enum": [ "date" ], "example": "example", "type": "string" }, "value": { "example": "example", "type": "string" } }, "required": [ "kind", "value" ], "type": "object" }, "DashboardDecimalFilterValue": { "allOf": [ { "$ref": "#/components/schemas/DashboardFilterValueBase" } ], "example": { "kind": "example", "value": "example" }, "properties": { "kind": { "enum": [ "decimal" ], "example": "example", "type": "string" }, "value": { "example": "example", "type": "string" } }, "required": [ "kind", "value" ], "type": "object" }, "DashboardFilterBindingRef": { "example": { "id": "example", "scope": "example" }, "properties": { "id": { "example": "example", "type": "string" }, "scope": { "enum": [ "report", "page" ], "example": "example", "type": "string" } }, "required": [ "scope", "id" ], "type": "object" }, "DashboardFilterBound": { "example": { "inclusive": true }, "properties": { "inclusive": { "example": true, "type": "boolean" }, "value": { "$ref": "#/components/schemas/DashboardFilterValue" } }, "required": [ "value", "inclusive" ], "type": "object" }, "DashboardFilterComponentResponse": { "allOf": [ { "$ref": "#/components/schemas/DashboardComponentResponseBase" } ], "example": { "filterId": "example", "kind": "example" }, "properties": { "filterId": { "example": "example", "type": "string" }, "kind": { "enum": [ "filter" ], "example": "example", "type": "string" } }, "required": [ "kind", "filterId" ], "type": "object" }, "DashboardFilterDescribeResponse": { "example": { "binding": { "filter": "example", "id": "example", "key": "example", "maxSelectedValues": 1, "optionDependencies": [ { "id": "example", "scope": "example" } ], "pageID": "example", "paneLabel": "example", "paneOrder": 1, "paneVisible": true, "readerEditable": true, "scope": "example", "selectionMode": "example", "targets": [ "example" ], "urlEncoding": "example", "urlParam": "example" }, "componentId": "example", "definition": { "calendar": "example", "description": "example", "fact": "example", "field": "example", "formatPattern": "example", "formatUnit": "example", "id": "example", "label": "example", "options": { "kind": "example", "limit": 1, "values": [ { "label": "example" } ] }, "predicates": [ { "kind": "example", "operators": [ "example" ] } ], "timezone": "example", "valueKind": "example", "weekStart": "example" }, "placement": { "col": 1, "colSpan": 1, "row": 1, "rowSpan": 1 }, "presentation": { "ariaLabel": "example", "compact": true, "description": "example", "search": true, "selectAll": true, "showCounts": true, "showSummary": true, "style": "example", "title": "example" } }, "properties": { "binding": { "$ref": "#/components/schemas/DashboardCompiledFilterBinding" }, "componentId": { "example": "example", "type": "string" }, "definition": { "$ref": "#/components/schemas/DashboardCompiledFilterDefinition" }, "placement": { "$ref": "#/components/schemas/DashboardComponentPlacement" }, "presentation": { "$ref": "#/components/schemas/DashboardFilterPresentation" } }, "required": [ "definition", "binding" ], "type": "object" }, "DashboardFilterExpression": { "discriminator": { "mapping": { "comparison": "#/components/schemas/DashboardComparisonExpression", "null_check": "#/components/schemas/DashboardNullCheckExpression", "range": "#/components/schemas/DashboardRangeExpression", "relative_period": "#/components/schemas/DashboardRelativePeriodExpression", "set": "#/components/schemas/DashboardSetExpression", "unfiltered": "#/components/schemas/DashboardUnfilteredExpression" }, "propertyName": "kind" }, "oneOf": [ { "$ref": "#/components/schemas/DashboardUnfilteredExpression" }, { "$ref": "#/components/schemas/DashboardNullCheckExpression" }, { "$ref": "#/components/schemas/DashboardSetExpression" }, { "$ref": "#/components/schemas/DashboardComparisonExpression" }, { "$ref": "#/components/schemas/DashboardRangeExpression" }, { "$ref": "#/components/schemas/DashboardRelativePeriodExpression" } ] }, "DashboardFilterExpressionBase": { "example": { "kind": "example" }, "properties": { "kind": { "example": "example", "type": "string" } }, "required": [ "kind" ], "type": "object" }, "DashboardFilterOptionListResponse": { "example": { "items": [ { "label": "example", "value": "example" } ], "page": { "nextCursor": "example" } }, "properties": { "items": { "example": [ { "label": "example", "value": "example" } ], "items": { "$ref": "#/components/schemas/DashboardFilterOptionResponse" }, "type": "array" }, "page": { "$ref": "#/components/schemas/PageInfo" } }, "required": [ "items", "page" ], "type": "object" }, "DashboardFilterOptionResponse": { "example": { "label": "example", "value": "example" }, "properties": { "label": { "example": "example", "type": "string" }, "value": { "example": "example", "type": "string" } }, "required": [ "value", "label" ], "type": "object" }, "DashboardFilterOptionSource": { "example": { "kind": "example", "limit": 1, "values": [ { "label": "example" } ] }, "properties": { "kind": { "enum": [ "none", "static", "distinct" ], "example": "example", "type": "string" }, "limit": { "example": 1, "format": "int32", "type": "integer" }, "values": { "example": [ { "label": "example" } ], "items": { "$ref": "#/components/schemas/DashboardFilterStaticOption" }, "type": "array" } }, "required": [ "kind", "limit", "values" ], "type": "object" }, "DashboardFilterPredicatePolicy": { "example": { "kind": "example", "operators": [ "example" ] }, "properties": { "kind": { "enum": [ "null_check", "set", "comparison", "range", "relative_period" ], "example": "example", "type": "string" }, "operators": { "example": [ "example" ], "items": { "type": "string" }, "type": "array" } }, "required": [ "kind", "operators" ], "type": "object" }, "DashboardFilterPresentation": { "example": { "ariaLabel": "example", "compact": true, "description": "example", "search": true, "selectAll": true, "showCounts": true, "showSummary": true, "style": "example", "title": "example" }, "properties": { "ariaLabel": { "example": "example", "type": "string" }, "compact": { "example": true, "type": "boolean" }, "description": { "example": "example", "type": "string" }, "search": { "example": true, "type": "boolean" }, "selectAll": { "example": true, "type": "boolean" }, "showCounts": { "example": true, "type": "boolean" }, "showSummary": { "example": true, "type": "boolean" }, "style": { "enum": [ "dropdown", "list", "buttons", "input", "numeric_range", "date_range", "relative_period" ], "example": "example", "type": "string" }, "title": { "example": "example", "type": "string" } }, "required": [ "style", "search", "selectAll", "showCounts", "showSummary", "compact" ], "type": "object" }, "DashboardFilterStaticOption": { "example": { "label": "example" }, "properties": { "label": { "example": "example", "type": "string" }, "value": { "$ref": "#/components/schemas/DashboardFilterValue" } }, "required": [ "value", "label" ], "type": "object" }, "DashboardFilterValue": { "discriminator": { "mapping": { "boolean": "#/components/schemas/DashboardBooleanFilterValue", "date": "#/components/schemas/DashboardDateFilterValue", "decimal": "#/components/schemas/DashboardDecimalFilterValue", "integer": "#/components/schemas/DashboardIntegerFilterValue", "string": "#/components/schemas/DashboardStringFilterValue", "timestamp": "#/components/schemas/DashboardTimestampFilterValue" }, "propertyName": "kind" }, "oneOf": [ { "$ref": "#/components/schemas/DashboardStringFilterValue" }, { "$ref": "#/components/schemas/DashboardBooleanFilterValue" }, { "$ref": "#/components/schemas/DashboardIntegerFilterValue" }, { "$ref": "#/components/schemas/DashboardDecimalFilterValue" }, { "$ref": "#/components/schemas/DashboardDateFilterValue" }, { "$ref": "#/components/schemas/DashboardTimestampFilterValue" } ] }, "DashboardFilterValueBase": { "example": { "kind": "example" }, "properties": { "kind": { "example": "example", "type": "string" } }, "required": [ "kind" ], "type": "object" }, "DashboardHeaderComponentResponse": { "allOf": [ { "$ref": "#/components/schemas/DashboardComponentResponseBase" } ], "example": { "kind": "example" }, "properties": { "kind": { "enum": [ "header" ], "example": "example", "type": "string" } }, "required": [ "kind" ], "type": "object" }, "DashboardIntegerFilterValue": { "allOf": [ { "$ref": "#/components/schemas/DashboardFilterValueBase" } ], "example": { "kind": "example", "value": "example" }, "properties": { "kind": { "enum": [ "integer" ], "example": "example", "type": "string" }, "value": { "example": "example", "type": "string" } }, "required": [ "kind", "value" ], "type": "object" }, "DashboardListResponse": { "example": { "items": [ { "description": "example", "id": "example", "pageCount": 1, "semanticModel": "example", "tags": [ "example" ], "title": "example" } ], "page": { "nextCursor": "example" } }, "properties": { "items": { "example": [ { "description": "example", "id": "example", "pageCount": 1, "semanticModel": "example", "tags": [ "example" ], "title": "example" } ], "items": { "$ref": "#/components/schemas/DashboardSummary" }, "type": "array" }, "page": { "$ref": "#/components/schemas/PageInfo" } }, "required": [ "items", "page" ], "type": "object" }, "DashboardManifestComponent": { "example": { "id": "example", "kind": "example", "ref": "example", "title": "example" }, "properties": { "id": { "example": "example", "type": "string" }, "kind": { "enum": [ "visual", "filter", "header" ], "example": "example", "type": "string" }, "ref": { "example": "example", "type": "string" }, "title": { "example": "example", "type": "string" } }, "required": [ "id", "kind", "ref" ], "type": "object" }, "DashboardManifestCounts": { "example": { "filters": 1, "pages": 1, "visuals": 1 }, "properties": { "filters": { "example": 1, "format": "int32", "type": "integer" }, "pages": { "example": 1, "format": "int32", "type": "integer" }, "visuals": { "example": 1, "format": "int32", "type": "integer" } }, "required": [ "pages", "visuals", "filters" ], "type": "object" }, "DashboardManifestPage": { "example": { "components": [ { "id": "example", "kind": "example", "ref": "example", "title": "example" } ], "description": "example", "id": "example", "title": "example" }, "properties": { "components": { "example": [ { "id": "example", "kind": "example", "ref": "example", "title": "example" } ], "items": { "$ref": "#/components/schemas/DashboardManifestComponent" }, "type": "array" }, "description": { "example": "example", "type": "string" }, "id": { "example": "example", "type": "string" }, "title": { "example": "example", "type": "string" } }, "required": [ "id", "title", "components" ], "type": "object" }, "DashboardManifestResponse": { "example": { "counts": { "filters": 1, "pages": 1, "visuals": 1 }, "description": "example", "detail_tools": { "key": "example" }, "id": "example", "model": { "id": "example", "title": "example" }, "pages": [ { "components": [ { "id": "example", "kind": "example", "ref": "example", "title": "example" } ], "description": "example", "id": "example", "title": "example" } ], "semantic_model": "example", "title": "example" }, "properties": { "counts": { "$ref": "#/components/schemas/DashboardManifestCounts" }, "description": { "example": "example", "type": "string" }, "detail_tools": { "additionalProperties": { "type": "string" }, "example": { "key": "example" }, "type": "object" }, "id": { "example": "example", "type": "string" }, "model": { "$ref": "#/components/schemas/ModelRef" }, "pages": { "example": [ { "components": [ { "id": "example", "kind": "example", "ref": "example", "title": "example" } ], "description": "example", "id": "example", "title": "example" } ], "items": { "$ref": "#/components/schemas/DashboardManifestPage" }, "type": "array" }, "semantic_model": { "example": "example", "type": "string" }, "title": { "example": "example", "type": "string" } }, "required": [ "id", "title", "counts", "pages", "detail_tools" ], "type": "object" }, "DashboardNullCheckExpression": { "allOf": [ { "$ref": "#/components/schemas/DashboardFilterExpressionBase" } ], "example": { "kind": "example", "operator": "example" }, "properties": { "kind": { "enum": [ "null_check" ], "example": "example", "type": "string" }, "operator": { "enum": [ "is_null", "is_not_null" ], "example": "example", "type": "string" } }, "required": [ "kind", "operator" ], "type": "object" }, "DashboardPageQueryRequest": { "example": { "filterState": { "controls": { "key": {} }, "version": "example" }, "interactionSelections": [ { "key": "example" } ], "spatialSelections": [ { "geometry": { "bounds": { "east": 1, "north": 1, "south": 1, "west": 1 }, "center": { "latitude": 1, "longitude": 1 }, "kind": "example", "points": [ { "latitude": 1, "longitude": 1 } ], "radiusMeters": 1 }, "gesture": "box", "interactionID": "example", "order": 1, "visualID": "example" } ] }, "properties": { "filterState": { "$ref": "#/components/schemas/DashboardAppliedFilterInput" }, "interactionSelections": { "example": [ { "key": "example" } ], "items": { "additionalProperties": {}, "type": "object" }, "type": "array" }, "spatialSelections": { "example": [ { "geometry": { "bounds": { "east": 1, "north": 1, "south": 1, "west": 1 }, "center": { "latitude": 1, "longitude": 1 }, "kind": "example", "points": [ { "latitude": 1, "longitude": 1 } ], "radiusMeters": 1 }, "gesture": "box", "interactionID": "example", "order": 1, "visualID": "example" } ], "items": { "$ref": "#/components/schemas/DashboardSpatialInteractionSelection" }, "type": "array" } }, "type": "object" }, "DashboardPageQueryResponse": { "example": { "filterState": { "controls": { "key": {} }, "version": "example" }, "status": { "key": "example" }, "visuals": { "key": { "dataRevision": 1, "diagnostics": [ { "code": "example", "fieldID": "example", "message": "example", "severity": "info" } ], "rendererID": "example", "schemaVersion": 1, "selection": [ { "datum": { "blockID": "example", "dataRevision": 1, "dataset": "example", "identity": { "key": "example" }, "resetVersion": 1 }, "label": "example" } ], "spatialSelection": { "interactionID": "example", "visualID": "example" }, "specRevision": "example", "status": { "kind": "idle", "message": "example" }, "visualID": "example" } } }, "properties": { "filterState": { "$ref": "#/components/schemas/DashboardAppliedFilterInput" }, "status": { "additionalProperties": {}, "example": { "key": "example" }, "type": "object" }, "visuals": { "additionalProperties": { "$ref": "#/components/schemas/VisualizationEnvelope" }, "example": { "key": { "dataRevision": 1, "diagnostics": [ { "code": "example", "fieldID": "example", "message": "example", "severity": "info" } ], "rendererID": "example", "schemaVersion": 1, "selection": [ { "datum": { "blockID": "example", "dataRevision": 1, "dataset": "example", "identity": { "key": "example" }, "resetVersion": 1 }, "label": "example" } ], "spatialSelection": { "interactionID": "example", "visualID": "example" }, "specRevision": "example", "status": { "kind": "idle", "message": "example" }, "visualID": "example" } }, "type": "object" } }, "required": [ "filterState", "visuals" ], "type": "object" }, "DashboardPageResponse": { "example": { "components": [], "description": "example", "id": "example", "title": "example" }, "properties": { "components": { "example": [], "items": { "$ref": "#/components/schemas/DashboardComponentResponse" }, "type": "array" }, "description": { "example": "example", "type": "string" }, "id": { "example": "example", "type": "string" }, "title": { "example": "example", "type": "string" } }, "required": [ "id", "title", "components" ], "type": "object" }, "DashboardPublicationListResponse": { "example": { "items": [ { "activeServingStateId": "example", "allowedOrigins": [ "example" ], "configured": true, "configuredAt": "2026-01-02T15:04:05Z", "createdAt": "2026-01-02T15:04:05Z", "dashboard": "example", "defaultPage": "example", "disabledAt": "2026-01-02T15:04:05Z", "embedUrl": "example", "iframeSnippet": "example", "name": "example", "projectId": "example", "publicUrl": "example", "rotatedAt": "2026-01-02T15:04:05Z", "status": "active", "suspendedAt": "2026-01-02T15:04:05Z", "suspendedBy": "example", "updatedAt": "2026-01-02T15:04:05Z", "workspaceId": "example" } ] }, "properties": { "items": { "example": [ { "activeServingStateId": "example", "allowedOrigins": [ "example" ], "configured": true, "configuredAt": "2026-01-02T15:04:05Z", "createdAt": "2026-01-02T15:04:05Z", "dashboard": "example", "defaultPage": "example", "disabledAt": "2026-01-02T15:04:05Z", "embedUrl": "example", "iframeSnippet": "example", "name": "example", "projectId": "example", "publicUrl": "example", "rotatedAt": "2026-01-02T15:04:05Z", "status": "active", "suspendedAt": "2026-01-02T15:04:05Z", "suspendedBy": "example", "updatedAt": "2026-01-02T15:04:05Z", "workspaceId": "example" } ], "items": { "$ref": "#/components/schemas/DashboardPublicationResponse" }, "type": "array" } }, "required": [ "items" ], "type": "object" }, "DashboardPublicationResponse": { "example": { "activeServingStateId": "example", "allowedOrigins": [ "example" ], "configured": true, "configuredAt": "2026-01-02T15:04:05Z", "createdAt": "2026-01-02T15:04:05Z", "dashboard": "example", "defaultPage": "example", "disabledAt": "2026-01-02T15:04:05Z", "embedUrl": "example", "iframeSnippet": "example", "name": "example", "projectId": "example", "publicUrl": "example", "rotatedAt": "2026-01-02T15:04:05Z", "status": "active", "suspendedAt": "2026-01-02T15:04:05Z", "suspendedBy": "example", "updatedAt": "2026-01-02T15:04:05Z", "workspaceId": "example" }, "properties": { "activeServingStateId": { "example": "example", "type": "string" }, "allowedOrigins": { "example": [ "example" ], "items": { "type": "string" }, "type": "array" }, "configured": { "example": true, "type": "boolean" }, "configuredAt": { "example": "2026-01-02T15:04:05Z", "format": "date-time", "type": "string" }, "createdAt": { "example": "2026-01-02T15:04:05Z", "format": "date-time", "type": "string" }, "dashboard": { "example": "example", "type": "string" }, "defaultPage": { "example": "example", "type": "string" }, "disabledAt": { "example": "2026-01-02T15:04:05Z", "format": "date-time", "type": "string" }, "embedUrl": { "example": "example", "type": "string" }, "iframeSnippet": { "example": "example", "type": "string" }, "name": { "example": "example", "type": "string" }, "projectId": { "example": "example", "type": "string" }, "publicUrl": { "example": "example", "type": "string" }, "rotatedAt": { "example": "2026-01-02T15:04:05Z", "format": "date-time", "type": "string" }, "status": { "$ref": "#/components/schemas/DashboardPublicationStatus" }, "suspendedAt": { "example": "2026-01-02T15:04:05Z", "format": "date-time", "type": "string" }, "suspendedBy": { "example": "example", "type": "string" }, "updatedAt": { "example": "2026-01-02T15:04:05Z", "format": "date-time", "type": "string" }, "workspaceId": { "example": "example", "type": "string" } }, "required": [ "name", "workspaceId", "projectId", "dashboard", "defaultPage", "status", "configured", "allowedOrigins", "publicUrl", "embedUrl", "iframeSnippet", "createdAt", "updatedAt" ], "type": "object" }, "DashboardPublicationStatus": { "enum": [ "active", "suspended", "unconfigured" ], "example": "active", "type": "string" }, "DashboardRangeExpression": { "allOf": [ { "$ref": "#/components/schemas/DashboardFilterExpressionBase" } ], "example": { "kind": "example", "lower": { "inclusive": true }, "upper": { "inclusive": true } }, "properties": { "kind": { "enum": [ "range" ], "example": "example", "type": "string" }, "lower": { "$ref": "#/components/schemas/DashboardFilterBound" }, "upper": { "$ref": "#/components/schemas/DashboardFilterBound" } }, "required": [ "kind" ], "type": "object" }, "DashboardRelativePeriodExpression": { "allOf": [ { "$ref": "#/components/schemas/DashboardFilterExpressionBase" } ], "example": { "anchor": "example", "count": 1, "direction": "example", "includeCurrent": true, "kind": "example", "unit": "example" }, "properties": { "anchor": { "enum": [ "current_time", "first_available", "last_available", "fixed" ], "example": "example", "type": "string" }, "anchorValue": { "$ref": "#/components/schemas/DashboardFilterValue" }, "count": { "example": 1, "format": "int32", "type": "integer" }, "direction": { "enum": [ "previous", "current", "next" ], "example": "example", "type": "string" }, "includeCurrent": { "example": true, "type": "boolean" }, "kind": { "enum": [ "relative_period" ], "example": "example", "type": "string" }, "unit": { "enum": [ "minute", "hour", "day", "week", "month", "quarter", "year" ], "example": "example", "type": "string" } }, "required": [ "kind", "direction", "count", "unit", "includeCurrent", "anchor" ], "type": "object" }, "DashboardSetExpression": { "allOf": [ { "$ref": "#/components/schemas/DashboardFilterExpressionBase" } ], "example": { "kind": "example", "operator": "example", "values": [] }, "properties": { "kind": { "enum": [ "set" ], "example": "example", "type": "string" }, "operator": { "enum": [ "in", "not_in" ], "example": "example", "type": "string" }, "values": { "example": [], "items": { "$ref": "#/components/schemas/DashboardFilterValue" }, "type": "array" } }, "required": [ "kind", "operator", "values" ], "type": "object" }, "DashboardSpatialInteractionSelection": { "example": { "geometry": { "bounds": { "east": 1, "north": 1, "south": 1, "west": 1 }, "center": { "latitude": 1, "longitude": 1 }, "kind": "example", "points": [ { "latitude": 1, "longitude": 1 } ], "radiusMeters": 1 }, "gesture": "box", "interactionID": "example", "order": 1, "visualID": "example" }, "properties": { "geometry": { "$ref": "#/components/schemas/DashboardSpatialSelectionGeometry" }, "gesture": { "$ref": "#/components/schemas/VisualizationSpatialSelectionGesture" }, "interactionID": { "example": "example", "type": "string" }, "order": { "example": 1, "format": "int32", "type": "integer" }, "visualID": { "example": "example", "type": "string" } }, "required": [ "visualID", "interactionID", "gesture", "geometry", "order" ], "type": "object" }, "DashboardSpatialSelectionGeometry": { "example": { "bounds": { "east": 1, "north": 1, "south": 1, "west": 1 }, "center": { "latitude": 1, "longitude": 1 }, "kind": "example", "points": [ { "latitude": 1, "longitude": 1 } ], "radiusMeters": 1 }, "properties": { "bounds": { "$ref": "#/components/schemas/VisualizationSpatialBounds" }, "center": { "$ref": "#/components/schemas/VisualizationSpatialCoordinate" }, "kind": { "enum": [ "box", "lasso", "radius" ], "example": "example", "type": "string" }, "points": { "example": [ { "latitude": 1, "longitude": 1 } ], "items": { "$ref": "#/components/schemas/VisualizationSpatialCoordinate" }, "type": "array" }, "radiusMeters": { "example": 1, "format": "double", "type": "number" } }, "required": [ "kind" ], "type": "object" }, "DashboardStringFilterValue": { "allOf": [ { "$ref": "#/components/schemas/DashboardFilterValueBase" } ], "example": { "kind": "example", "value": "example" }, "properties": { "kind": { "enum": [ "string" ], "example": "example", "type": "string" }, "value": { "example": "example", "type": "string" } }, "required": [ "kind", "value" ], "type": "object" }, "DashboardSummary": { "example": { "description": "example", "id": "example", "pageCount": 1, "semanticModel": "example", "tags": [ "example" ], "title": "example" }, "properties": { "description": { "example": "example", "type": "string" }, "id": { "example": "example", "type": "string" }, "pageCount": { "example": 1, "format": "int32", "type": "integer" }, "semanticModel": { "example": "example", "type": "string" }, "tags": { "example": [ "example" ], "items": { "type": "string" }, "type": "array" }, "title": { "example": "example", "type": "string" } }, "required": [ "id", "title", "description", "semanticModel", "tags", "pageCount" ], "type": "object" }, "DashboardTimestampFilterValue": { "allOf": [ { "$ref": "#/components/schemas/DashboardFilterValueBase" } ], "example": { "kind": "example", "value": "example" }, "properties": { "kind": { "enum": [ "timestamp" ], "example": "example", "type": "string" }, "value": { "example": "example", "type": "string" } }, "required": [ "kind", "value" ], "type": "object" }, "DashboardUnfilteredExpression": { "allOf": [ { "$ref": "#/components/schemas/DashboardFilterExpressionBase" } ], "example": { "kind": "example" }, "properties": { "kind": { "enum": [ "unfiltered" ], "example": "example", "type": "string" } }, "required": [ "kind" ], "type": "object" }, "DashboardVisualComponentResponse": { "allOf": [ { "$ref": "#/components/schemas/DashboardComponentResponseBase" } ], "example": { "kind": "example", "visualId": "example" }, "properties": { "kind": { "enum": [ "visual" ], "example": "example", "type": "string" }, "visualId": { "example": "example", "type": "string" } }, "required": [ "kind", "visualId" ], "type": "object" }, "DashboardVisualDescribeResponse": { "example": { "componentId": "example", "height": 1, "id": "example", "placement": { "col": 1, "colSpan": 1, "row": 1, "rowSpan": 1 }, "rendererID": "example", "specRevision": "example", "width": 1, "x": 1, "y": 1 }, "properties": { "componentId": { "example": "example", "type": "string" }, "height": { "example": 1, "format": "double", "type": "number" }, "id": { "example": "example", "type": "string" }, "placement": { "$ref": "#/components/schemas/DashboardComponentPlacement" }, "rendererID": { "example": "example", "type": "string" }, "spec": { "$ref": "#/components/schemas/VisualizationSpec" }, "specRevision": { "example": "example", "type": "string" }, "width": { "example": 1, "format": "double", "type": "number" }, "x": { "example": 1, "format": "double", "type": "number" }, "y": { "example": 1, "format": "double", "type": "number" } }, "required": [ "id", "rendererID", "specRevision", "spec" ], "type": "object" }, "DashboardVisualQueryRequest": { "example": { "filterState": { "controls": { "key": {} }, "version": "example" }, "interactionSelections": [ { "key": "example" } ], "limit": 1, "pageToken": "example", "spatialSelections": [ { "geometry": { "bounds": { "east": 1, "north": 1, "south": 1, "west": 1 }, "center": { "latitude": 1, "longitude": 1 }, "kind": "example", "points": [ { "latitude": 1, "longitude": 1 } ], "radiusMeters": 1 }, "gesture": "box", "interactionID": "example", "order": 1, "visualID": "example" } ] }, "properties": { "filterState": { "$ref": "#/components/schemas/DashboardAppliedFilterInput" }, "interactionSelections": { "example": [ { "key": "example" } ], "items": { "additionalProperties": {}, "type": "object" }, "type": "array" }, "limit": { "example": 1, "format": "int32", "maximum": 1000, "minimum": 1, "type": "integer" }, "pageToken": { "example": "example", "maxLength": 2048, "minLength": 1, "type": "string" }, "spatialSelections": { "example": [ { "geometry": { "bounds": { "east": 1, "north": 1, "south": 1, "west": 1 }, "center": { "latitude": 1, "longitude": 1 }, "kind": "example", "points": [ { "latitude": 1, "longitude": 1 } ], "radiusMeters": 1 }, "gesture": "box", "interactionID": "example", "order": 1, "visualID": "example" } ], "items": { "$ref": "#/components/schemas/DashboardSpatialInteractionSelection" }, "type": "array" } }, "type": "object" }, "DataPolicyListResponse": { "example": { "items": [ { "createdAt": "2026-01-02T15:04:05Z", "expression": { "key": "example" }, "id": "example", "objectId": "example", "policyType": "example", "subjectId": "example", "subjectType": "example", "updatedAt": "2026-01-02T15:04:05Z", "workspaceId": "example" } ], "page": { "nextCursor": "example" } }, "properties": { "items": { "example": [ { "createdAt": "2026-01-02T15:04:05Z", "expression": { "key": "example" }, "id": "example", "objectId": "example", "policyType": "example", "subjectId": "example", "subjectType": "example", "updatedAt": "2026-01-02T15:04:05Z", "workspaceId": "example" } ], "items": { "$ref": "#/components/schemas/DataPolicyResponse" }, "type": "array" }, "page": { "$ref": "#/components/schemas/PageInfo" } }, "required": [ "items", "page" ], "type": "object" }, "DataPolicyRequest": { "example": { "expression": { "key": "example" }, "objectId": "example", "objectType": "example", "policyType": "example", "subjectId": "example", "subjectType": "example" }, "properties": { "expression": { "additionalProperties": {}, "example": { "key": "example" }, "type": "object" }, "objectId": { "example": "example", "type": "string" }, "objectType": { "example": "example", "type": "string" }, "policyType": { "example": "example", "type": "string" }, "subjectId": { "example": "example", "type": "string" }, "subjectType": { "example": "example", "type": "string" } }, "required": [ "policyType", "expression" ], "type": "object" }, "DataPolicyResponse": { "example": { "createdAt": "2026-01-02T15:04:05Z", "expression": { "key": "example" }, "id": "example", "objectId": "example", "policyType": "example", "subjectId": "example", "subjectType": "example", "updatedAt": "2026-01-02T15:04:05Z", "workspaceId": "example" }, "properties": { "createdAt": { "example": "2026-01-02T15:04:05Z", "format": "date-time", "type": "string" }, "expression": { "additionalProperties": {}, "example": { "key": "example" }, "type": "object" }, "id": { "example": "example", "type": "string" }, "objectId": { "example": "example", "type": "string" }, "policyType": { "example": "example", "type": "string" }, "subjectId": { "example": "example", "type": "string" }, "subjectType": { "example": "example", "type": "string" }, "updatedAt": { "example": "2026-01-02T15:04:05Z", "format": "date-time", "type": "string" }, "workspaceId": { "example": "example", "type": "string" } }, "required": [ "id", "workspaceId", "objectId", "policyType", "expression", "createdAt", "updatedAt" ], "type": "object" }, "DeploymentConnectionResponse": { "example": { "connectionId": "example", "priorRevisionId": "example", "revisionId": "example" }, "properties": { "connectionId": { "example": "example", "type": "string" }, "priorRevisionId": { "example": "example", "type": "string" }, "revisionId": { "example": "example", "type": "string" } }, "required": [ "connectionId", "revisionId" ], "type": "object" }, "DeploymentCreateRequest": { "example": { "releaseId": "example" }, "properties": { "releaseId": { "example": "example", "type": "string" } }, "required": [ "releaseId" ], "type": "object" }, "DeploymentListResponse": { "example": { "items": [ { "connections": [ { "connectionId": "example", "priorRevisionId": "example", "revisionId": "example" } ], "createdAt": "2026-01-02T15:04:05Z", "createdBy": "example", "environment": "example", "error": "example", "finishedAt": "2026-01-02T15:04:05Z", "id": "example", "progress": { "current": 1, "total": 1, "unit": "example" }, "projectId": "example", "releaseId": "example", "startedAt": "2026-01-02T15:04:05Z", "status": "queued", "targets": [ { "error": "example", "priorServingStateId": "example", "servingStateId": "example", "status": "example", "workspaceId": "example" } ] } ], "page": { "nextCursor": "example" } }, "properties": { "items": { "example": [ { "connections": [ { "connectionId": "example", "priorRevisionId": "example", "revisionId": "example" } ], "createdAt": "2026-01-02T15:04:05Z", "createdBy": "example", "environment": "example", "error": "example", "finishedAt": "2026-01-02T15:04:05Z", "id": "example", "progress": { "current": 1, "total": 1, "unit": "example" }, "projectId": "example", "releaseId": "example", "startedAt": "2026-01-02T15:04:05Z", "status": "queued", "targets": [ { "error": "example", "priorServingStateId": "example", "servingStateId": "example", "status": "example", "workspaceId": "example" } ] } ], "items": { "$ref": "#/components/schemas/DeploymentResponse" }, "type": "array" }, "page": { "$ref": "#/components/schemas/PageInfo" } }, "required": [ "items", "page" ], "type": "object" }, "DeploymentProgress": { "example": { "current": 1, "total": 1, "unit": "example" }, "properties": { "current": { "example": 1, "format": "int32", "type": "integer" }, "total": { "example": 1, "format": "int32", "type": "integer" }, "unit": { "example": "example", "type": "string" } }, "required": [ "current", "total", "unit" ], "type": "object" }, "DeploymentResponse": { "example": { "connections": [ { "connectionId": "example", "priorRevisionId": "example", "revisionId": "example" } ], "createdAt": "2026-01-02T15:04:05Z", "createdBy": "example", "environment": "example", "error": "example", "finishedAt": "2026-01-02T15:04:05Z", "id": "example", "progress": { "current": 1, "total": 1, "unit": "example" }, "projectId": "example", "releaseId": "example", "startedAt": "2026-01-02T15:04:05Z", "status": "queued", "targets": [ { "error": "example", "priorServingStateId": "example", "servingStateId": "example", "status": "example", "workspaceId": "example" } ] }, "properties": { "connections": { "example": [ { "connectionId": "example", "priorRevisionId": "example", "revisionId": "example" } ], "items": { "$ref": "#/components/schemas/DeploymentConnectionResponse" }, "type": "array" }, "createdAt": { "example": "2026-01-02T15:04:05Z", "format": "date-time", "type": "string" }, "createdBy": { "example": "example", "type": "string" }, "environment": { "example": "example", "type": "string" }, "error": { "example": "example", "type": "string" }, "finishedAt": { "example": "2026-01-02T15:04:05Z", "format": "date-time", "type": "string" }, "id": { "example": "example", "type": "string" }, "progress": { "$ref": "#/components/schemas/DeploymentProgress" }, "projectId": { "example": "example", "type": "string" }, "releaseId": { "example": "example", "type": "string" }, "startedAt": { "example": "2026-01-02T15:04:05Z", "format": "date-time", "type": "string" }, "status": { "$ref": "#/components/schemas/DeploymentStatus" }, "targets": { "example": [ { "error": "example", "priorServingStateId": "example", "servingStateId": "example", "status": "example", "workspaceId": "example" } ], "items": { "$ref": "#/components/schemas/DeploymentTargetResponse" }, "type": "array" } }, "required": [ "id", "projectId", "releaseId", "environment", "status", "targets", "connections", "createdBy", "createdAt" ], "type": "object" }, "DeploymentStatus": { "enum": [ "queued", "running", "active", "failed", "cancelled", "superseded" ], "example": "queued", "type": "string" }, "DeploymentTargetResponse": { "example": { "error": "example", "priorServingStateId": "example", "servingStateId": "example", "status": "example", "workspaceId": "example" }, "properties": { "error": { "example": "example", "type": "string" }, "priorServingStateId": { "example": "example", "type": "string" }, "servingStateId": { "example": "example", "type": "string" }, "status": { "example": "example", "type": "string" }, "workspaceId": { "example": "example", "type": "string" } }, "required": [ "workspaceId", "status" ], "type": "object" }, "DurationVisualizationFormat": { "allOf": [ { "$ref": "#/components/schemas/VisualizationFormatBase" } ], "example": { "kind": "example", "unit": "example" }, "properties": { "kind": { "enum": [ "duration" ], "example": "example", "type": "string" }, "unit": { "example": "example", "type": "string" } }, "required": [ "kind", "unit" ], "type": "object" }, "EffectivePrivilegeListResponse": { "example": { "effectiveGrants": [ { "allowed": true, "grantId": "example", "grantObjectId": "example", "inherited": true, "objectId": "example", "objectType": "example", "owner": true, "platform": true, "privilege": "example", "reason": "example", "subjectId": "example", "subjectType": "example" } ], "objectId": "example", "objectType": "example", "privileges": [ "example" ], "workspaceId": "example" }, "properties": { "effectiveGrants": { "example": [ { "allowed": true, "grantId": "example", "grantObjectId": "example", "inherited": true, "objectId": "example", "objectType": "example", "owner": true, "platform": true, "privilege": "example", "reason": "example", "subjectId": "example", "subjectType": "example" } ], "items": { "$ref": "#/components/schemas/AuthorizationDecisionResponse" }, "type": "array" }, "objectId": { "example": "example", "type": "string" }, "objectType": { "example": "example", "type": "string" }, "privileges": { "example": [ "example" ], "items": { "type": "string" }, "type": "array" }, "workspaceId": { "example": "example", "type": "string" } }, "required": [ "workspaceId", "objectType", "privileges", "effectiveGrants" ], "type": "object" }, "EffectivePrivilegesResponse": { "example": { "privileges": [ "example" ], "workspaceId": "example" }, "properties": { "privileges": { "example": [ "example" ], "items": { "type": "string" }, "type": "array" }, "workspaceId": { "example": "example", "type": "string" } }, "required": [ "workspaceId", "privileges" ], "type": "object" }, "GeographicVisualizationPresentation": { "allOf": [ { "$ref": "#/components/schemas/VisualizationPresentation" } ], "example": { "basemap": { "archiveDigest": "example", "archiveUrl": "example", "attribution": "example", "bounds": [ 1 ], "glyphsUrl": "example", "id": "example", "labelAnchor": "example", "license": "example", "maximumZoom": 1, "minimumZoom": 1, "source": "example", "spriteUrl": "example", "styleDigest": "example", "styleUrl": "example" }, "camera": { "center": [ 1 ], "maximumZoom": 1, "minimumZoom": 1, "mode": "fit_data", "padding": 1, "zoom": 1 }, "controls": { "compass": true, "reset": true, "zoom": true }, "labelDensity": "hidden", "roam": true, "theme": "auto" }, "properties": { "basemap": { "$ref": "#/components/schemas/VisualizationMapStyleAsset" }, "camera": { "$ref": "#/components/schemas/VisualizationMapCamera" }, "controls": { "$ref": "#/components/schemas/VisualizationMapControls" }, "labelDensity": { "$ref": "#/components/schemas/VisualizationMapLabelDensity" }, "roam": { "example": true, "type": "boolean" }, "theme": { "$ref": "#/components/schemas/VisualizationMapTheme" } }, "required": [ "roam", "theme", "labelDensity", "camera", "controls" ], "type": "object" }, "GeographicVisualizationSpec": { "allOf": [ { "$ref": "#/components/schemas/VisualizationSpecBase" } ], "example": { "kind": "example", "layers": [], "presentation": { "basemap": { "archiveDigest": "example", "archiveUrl": "example", "attribution": "example", "bounds": [ 1 ], "glyphsUrl": "example", "id": "example", "labelAnchor": "example", "license": "example", "maximumZoom": 1, "minimumZoom": 1, "source": "example", "spriteUrl": "example", "styleDigest": "example", "styleUrl": "example" }, "camera": { "center": [ 1 ], "maximumZoom": 1, "minimumZoom": 1, "mode": "fit_data", "padding": 1, "zoom": 1 }, "controls": { "compass": true, "reset": true, "zoom": true }, "labelDensity": "hidden", "roam": true, "theme": "auto" }, "spatialInteractions": [ { "gestures": [ "box" ], "id": "example", "latitude": { "source": { "dataset": "example", "field": "example" }, "targetFactID": "example", "targetFieldID": "example" }, "longitude": { "source": { "dataset": "example", "field": "example" }, "targetFactID": "example", "targetFieldID": "example" }, "targets": [ "example" ] } ] }, "properties": { "kind": { "enum": [ "geographic" ], "example": "example", "type": "string" }, "layers": { "example": [], "items": { "$ref": "#/components/schemas/VisualizationGeographicLayer" }, "type": "array" }, "presentation": { "$ref": "#/components/schemas/GeographicVisualizationPresentation" }, "spatialInteractions": { "example": [ { "gestures": [ "box" ], "id": "example", "latitude": { "source": { "dataset": "example", "field": "example" }, "targetFactID": "example", "targetFieldID": "example" }, "longitude": { "source": { "dataset": "example", "field": "example" }, "targetFactID": "example", "targetFieldID": "example" }, "targets": [ "example" ] } ], "items": { "$ref": "#/components/schemas/VisualizationSpatialSelectionInteraction" }, "type": "array" } }, "required": [ "kind", "layers", "spatialInteractions", "presentation" ], "type": "object" }, "GrantListResponse": { "example": { "items": [ { "createdAt": "2026-01-02T15:04:05Z", "id": "example", "inherited": true, "objectId": "example", "objectType": "example", "parentId": "example", "parentObject": "example", "parentType": "example", "privilege": "example", "subjectId": "example", "subjectType": "example", "workspaceId": "example" } ], "page": { "nextCursor": "example" } }, "properties": { "items": { "example": [ { "createdAt": "2026-01-02T15:04:05Z", "id": "example", "inherited": true, "objectId": "example", "objectType": "example", "parentId": "example", "parentObject": "example", "parentType": "example", "privilege": "example", "subjectId": "example", "subjectType": "example", "workspaceId": "example" } ], "items": { "$ref": "#/components/schemas/GrantResponse" }, "type": "array" }, "page": { "$ref": "#/components/schemas/PageInfo" } }, "required": [ "items", "page" ], "type": "object" }, "GrantRequest": { "example": { "objectId": "example", "objectType": "example", "privilege": "example", "subjectId": "example", "subjectType": "example" }, "properties": { "objectId": { "example": "example", "type": "string" }, "objectType": { "example": "example", "type": "string" }, "privilege": { "example": "example", "type": "string" }, "subjectId": { "example": "example", "type": "string" }, "subjectType": { "example": "example", "type": "string" } }, "required": [ "subjectType", "subjectId", "privilege" ], "type": "object" }, "GrantResponse": { "example": { "createdAt": "2026-01-02T15:04:05Z", "id": "example", "inherited": true, "objectId": "example", "objectType": "example", "parentId": "example", "parentObject": "example", "parentType": "example", "privilege": "example", "subjectId": "example", "subjectType": "example", "workspaceId": "example" }, "properties": { "createdAt": { "example": "2026-01-02T15:04:05Z", "format": "date-time", "type": "string" }, "id": { "example": "example", "type": "string" }, "inherited": { "example": true, "type": "boolean" }, "objectId": { "example": "example", "type": "string" }, "objectType": { "example": "example", "type": "string" }, "parentId": { "example": "example", "type": "string" }, "parentObject": { "example": "example", "type": "string" }, "parentType": { "example": "example", "type": "string" }, "privilege": { "example": "example", "type": "string" }, "subjectId": { "example": "example", "type": "string" }, "subjectType": { "example": "example", "type": "string" }, "workspaceId": { "example": "example", "type": "string" } }, "required": [ "id", "objectId", "objectType", "workspaceId", "subjectType", "subjectId", "privilege", "createdAt" ], "type": "object" }, "GridVisualizationPresentation": { "example": { "rowHeight": 1, "showHeader": true, "striped": true }, "properties": { "rowHeight": { "example": 1, "format": "int64", "type": "integer" }, "showHeader": { "example": true, "type": "boolean" }, "striped": { "example": true, "type": "boolean" } }, "required": [ "rowHeight", "striped", "showHeader" ], "type": "object" }, "GroupCreateRequest": { "example": { "displayName": "example", "name": "example" }, "properties": { "displayName": { "example": "example", "type": "string" }, "name": { "example": "example", "type": "string" } }, "required": [ "name" ], "type": "object" }, "GroupListResponse": { "example": { "items": [ { "createdAt": "2026-01-02T15:04:05Z", "displayName": "example", "id": "example", "name": "example", "updatedAt": "2026-01-02T15:04:05Z" } ], "page": { "nextCursor": "example" } }, "properties": { "items": { "example": [ { "createdAt": "2026-01-02T15:04:05Z", "displayName": "example", "id": "example", "name": "example", "updatedAt": "2026-01-02T15:04:05Z" } ], "items": { "$ref": "#/components/schemas/GroupResponse" }, "type": "array" }, "page": { "$ref": "#/components/schemas/PageInfo" } }, "required": [ "items", "page" ], "type": "object" }, "GroupMemberListResponse": { "example": { "items": [ { "createdAt": "2026-01-02T15:04:05Z", "displayName": "example", "email": "example", "id": "example", "kind": "example", "updatedAt": "2026-01-02T15:04:05Z" } ], "page": { "nextCursor": "example" } }, "properties": { "items": { "example": [ { "createdAt": "2026-01-02T15:04:05Z", "displayName": "example", "email": "example", "id": "example", "kind": "example", "updatedAt": "2026-01-02T15:04:05Z" } ], "items": { "$ref": "#/components/schemas/PrincipalResponse" }, "type": "array" }, "page": { "$ref": "#/components/schemas/PageInfo" } }, "required": [ "items", "page" ], "type": "object" }, "GroupPatchRequest": { "example": { "displayName": "example" }, "properties": { "displayName": { "example": "example", "type": "string" } }, "type": "object" }, "GroupResponse": { "example": { "createdAt": "2026-01-02T15:04:05Z", "displayName": "example", "id": "example", "name": "example", "updatedAt": "2026-01-02T15:04:05Z" }, "properties": { "createdAt": { "example": "2026-01-02T15:04:05Z", "format": "date-time", "type": "string" }, "displayName": { "example": "example", "type": "string" }, "id": { "example": "example", "type": "string" }, "name": { "example": "example", "type": "string" }, "updatedAt": { "example": "2026-01-02T15:04:05Z", "format": "date-time", "type": "string" } }, "required": [ "id", "name", "displayName", "createdAt", "updatedAt" ], "type": "object" }, "HierarchyVisualizationPresentation": { "allOf": [ { "$ref": "#/components/schemas/VisualizationPresentation" } ], "example": { "breadcrumb": true, "curveness": 1, "focus": "none", "initialDepth": 1, "layout": "standard", "nodeGap": 1, "orientation": "horizontal", "roam": true }, "properties": { "breadcrumb": { "example": true, "type": "boolean" }, "curveness": { "example": 1, "format": "double", "type": "number" }, "focus": { "$ref": "#/components/schemas/VisualizationGraphFocus" }, "initialDepth": { "example": 1, "format": "int32", "type": "integer" }, "layout": { "$ref": "#/components/schemas/VisualizationHierarchyLayout" }, "nodeGap": { "example": 1, "format": "double", "type": "number" }, "orientation": { "$ref": "#/components/schemas/VisualizationOrientation" }, "roam": { "example": true, "type": "boolean" } }, "required": [ "orientation", "roam" ], "type": "object" }, "HierarchyVisualizationSpec": { "allOf": [ { "$ref": "#/components/schemas/VisualizationSpecBase" } ], "example": { "kind": "example", "mark": "treemap", "node": { "dataset": "example", "field": "example" }, "parent": { "dataset": "example", "field": "example" }, "presentation": { "breadcrumb": true, "curveness": 1, "focus": "none", "initialDepth": 1, "layout": "standard", "nodeGap": 1, "orientation": "horizontal", "roam": true }, "source": { "dataset": "example", "field": "example" }, "target": { "dataset": "example", "field": "example" }, "value": { "dataset": "example", "field": "example" } }, "properties": { "kind": { "enum": [ "hierarchy" ], "example": "example", "type": "string" }, "mark": { "$ref": "#/components/schemas/VisualizationHierarchyMark" }, "node": { "$ref": "#/components/schemas/VisualizationFieldRef" }, "parent": { "$ref": "#/components/schemas/VisualizationFieldRef" }, "presentation": { "$ref": "#/components/schemas/HierarchyVisualizationPresentation" }, "source": { "$ref": "#/components/schemas/VisualizationFieldRef" }, "target": { "$ref": "#/components/schemas/VisualizationFieldRef" }, "value": { "$ref": "#/components/schemas/VisualizationFieldRef" } }, "required": [ "kind", "mark", "node", "presentation" ], "type": "object" }, "InlineVisualizationDataState": { "allOf": [ { "$ref": "#/components/schemas/VisualizationDataStateBase" } ], "example": { "datasets": [ { "columns": [ "example" ], "completeness": "complete", "dataRevision": 1, "generation": 1, "id": "example", "rows": [ [ "example" ] ], "specRevision": "example" } ], "kind": "example" }, "properties": { "datasets": { "example": [ { "columns": [ "example" ], "completeness": "complete", "dataRevision": 1, "generation": 1, "id": "example", "rows": [ [ "example" ] ], "specRevision": "example" } ], "items": { "$ref": "#/components/schemas/VisualizationInlineDataset" }, "type": "array" }, "kind": { "enum": [ "inline" ], "example": "example", "type": "string" } }, "required": [ "kind", "datasets" ], "type": "object" }, "InstanceResponse": { "example": { "environment": "example" }, "properties": { "environment": { "example": "example", "type": "string" } }, "required": [ "environment" ], "type": "object" }, "KPIVisualizationPresentation": { "example": { "note": "example", "thresholds": [ { "tone": "neutral", "value": 1 } ], "tone": "neutral", "trend": "neutral" }, "properties": { "note": { "example": "example", "type": "string" }, "thresholds": { "example": [ { "tone": "neutral", "value": 1 } ], "items": { "$ref": "#/components/schemas/VisualizationThreshold" }, "type": "array" }, "tone": { "$ref": "#/components/schemas/VisualizationTone" }, "trend": { "$ref": "#/components/schemas/VisualizationKPITrend" } }, "required": [ "trend" ], "type": "object" }, "KPIVisualizationSpec": { "allOf": [ { "$ref": "#/components/schemas/VisualizationSpecBase" } ], "example": { "comparison": { "dataset": "example", "field": "example" }, "kind": "example", "presentation": { "note": "example", "thresholds": [ { "tone": "neutral", "value": 1 } ], "tone": "neutral", "trend": "neutral" }, "trend": { "dataset": "example", "field": "example" }, "value": { "dataset": "example", "field": "example" } }, "properties": { "comparison": { "$ref": "#/components/schemas/VisualizationFieldRef" }, "kind": { "enum": [ "kpi" ], "example": "example", "type": "string" }, "presentation": { "$ref": "#/components/schemas/KPIVisualizationPresentation" }, "trend": { "$ref": "#/components/schemas/VisualizationFieldRef" }, "value": { "$ref": "#/components/schemas/VisualizationFieldRef" } }, "required": [ "kind", "value", "presentation" ], "type": "object" }, "LocalPasswordResetResponse": { "example": { "principal": { "createdAt": "2026-01-02T15:04:05Z", "displayName": "example", "email": "example", "id": "example", "kind": "example", "updatedAt": "2026-01-02T15:04:05Z" }, "temporaryPassword": "example" }, "properties": { "principal": { "$ref": "#/components/schemas/PrincipalResponse" }, "temporaryPassword": { "example": "example", "type": "string" } }, "required": [ "principal", "temporaryPassword" ], "type": "object" }, "ManagedConnectionListResponse": { "example": { "items": [ { "activeRevisionId": "example", "description": "example", "id": "example", "projectId": "example", "title": "example" } ], "page": { "nextCursor": "example" } }, "properties": { "items": { "example": [ { "activeRevisionId": "example", "description": "example", "id": "example", "projectId": "example", "title": "example" } ], "items": { "$ref": "#/components/schemas/ManagedConnectionResponse" }, "type": "array" }, "page": { "$ref": "#/components/schemas/PageInfo" } }, "required": [ "items", "page" ], "type": "object" }, "ManagedConnectionResponse": { "example": { "activeRevisionId": "example", "description": "example", "id": "example", "projectId": "example", "title": "example" }, "properties": { "activeRevisionId": { "example": "example", "type": "string" }, "description": { "example": "example", "type": "string" }, "id": { "example": "example", "type": "string" }, "projectId": { "example": "example", "type": "string" }, "title": { "example": "example", "type": "string" } }, "required": [ "id", "projectId", "title" ], "type": "object" }, "ManagedDataActiveRevisionResponse": { "example": { "activatedAt": "2026-01-02T15:04:05Z", "deploymentId": "example", "revision": { "createdAt": "2026-01-02T15:04:05Z", "fileCount": 1, "id": "example", "size": 1, "status": "available", "uploadSessionId": "example" } }, "properties": { "activatedAt": { "example": "2026-01-02T15:04:05Z", "format": "date-time", "type": "string" }, "deploymentId": { "example": "example", "type": "string" }, "revision": { "$ref": "#/components/schemas/ManagedDataRevisionSummaryResponse" } }, "type": "object" }, "ManagedDataFileMetadata": { "example": { "path": "example", "sha256": "example", "size": 1 }, "properties": { "path": { "example": "example", "maxLength": 1024, "minLength": 1, "type": "string" }, "sha256": { "description": "A lowercase 64-character hexadecimal SHA-256 digest.", "example": "example", "maxLength": 64, "minLength": 64, "type": "string" }, "size": { "example": 1, "format": "int64", "minimum": 0, "type": "integer" } }, "required": [ "path", "size", "sha256" ], "type": "object" }, "ManagedDataFileUploadResponse": { "example": { "error": "example", "file": { "path": "example", "sha256": "example", "size": 1 }, "negotiation": { "protocol": "tus", "s3Multipart": { "createEndpoint": "example", "maximumPartSize": 1, "maximumParts": 1, "minimumPartSize": 1 }, "tus": { "endpoint": "example", "expiresAt": "2026-01-02T15:04:05Z", "offset": 1, "uploadId": "example" } }, "status": "pending" }, "properties": { "error": { "example": "example", "maxLength": 2048, "minLength": 1, "type": "string" }, "file": { "$ref": "#/components/schemas/ManagedDataFileMetadata" }, "negotiation": { "$ref": "#/components/schemas/ManagedDataUploadNegotiation", "description": "Upload instructions, present only while the file can still be uploaded." }, "status": { "$ref": "#/components/schemas/ManagedDataFileUploadStatus" } }, "required": [ "file", "status" ], "type": "object" }, "ManagedDataFileUploadStatus": { "enum": [ "pending", "uploading", "uploaded", "verified", "skipped", "failed" ], "example": "pending", "type": "string" }, "ManagedDataHTTPHeader": { "example": { "name": "example", "value": "example" }, "properties": { "name": { "example": "example", "maxLength": 256, "minLength": 1, "type": "string" }, "value": { "example": "example", "maxLength": 8192, "minLength": 1, "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "ManagedDataManifest": { "example": { "files": [ { "path": "example", "sha256": "example", "size": 1 } ] }, "properties": { "files": { "example": [ { "path": "example", "sha256": "example", "size": 1 } ], "items": { "$ref": "#/components/schemas/ManagedDataFileMetadata" }, "type": "array" } }, "required": [ "files" ], "type": "object" }, "ManagedDataRevisionListResponse": { "example": { "items": [ { "createdAt": "2026-01-02T15:04:05Z", "fileCount": 1, "id": "example", "size": 1, "status": "available", "uploadSessionId": "example" } ], "page": { "nextCursor": "example" } }, "properties": { "items": { "example": [ { "createdAt": "2026-01-02T15:04:05Z", "fileCount": 1, "id": "example", "size": 1, "status": "available", "uploadSessionId": "example" } ], "items": { "$ref": "#/components/schemas/ManagedDataRevisionSummaryResponse" }, "type": "array" }, "page": { "$ref": "#/components/schemas/PageInfo" } }, "required": [ "items", "page" ], "type": "object" }, "ManagedDataRevisionResponse": { "example": { "createdAt": "2026-01-02T15:04:05Z", "fileCount": 1, "id": "example", "manifest": { "files": [ { "path": "example", "sha256": "example", "size": 1 } ] }, "size": 1, "status": "available", "uploadSessionId": "example" }, "properties": { "createdAt": { "example": "2026-01-02T15:04:05Z", "format": "date-time", "type": "string" }, "fileCount": { "example": 1, "format": "int32", "maximum": 10000, "minimum": 1, "type": "integer" }, "id": { "description": "The immutable revision identity, formatted as sha256 followed by a colon and 64 lowercase hexadecimal characters.", "example": "example", "maxLength": 71, "minLength": 71, "type": "string" }, "manifest": { "$ref": "#/components/schemas/ManagedDataManifest" }, "size": { "example": 1, "format": "int64", "minimum": 0, "type": "integer" }, "status": { "$ref": "#/components/schemas/ManagedDataRevisionStatus" }, "uploadSessionId": { "example": "example", "maxLength": 160, "minLength": 1, "type": "string" } }, "required": [ "id", "status", "manifest", "fileCount", "size", "createdAt", "uploadSessionId" ], "type": "object" }, "ManagedDataRevisionStatus": { "enum": [ "available" ], "example": "available", "type": "string" }, "ManagedDataRevisionSummaryResponse": { "example": { "createdAt": "2026-01-02T15:04:05Z", "fileCount": 1, "id": "example", "size": 1, "status": "available", "uploadSessionId": "example" }, "properties": { "createdAt": { "example": "2026-01-02T15:04:05Z", "format": "date-time", "type": "string" }, "fileCount": { "example": 1, "format": "int32", "maximum": 10000, "minimum": 1, "type": "integer" }, "id": { "description": "The immutable revision identity, formatted as sha256 followed by a colon and 64 lowercase hexadecimal characters.", "example": "example", "maxLength": 71, "minLength": 71, "type": "string" }, "size": { "example": 1, "format": "int64", "minimum": 0, "type": "integer" }, "status": { "$ref": "#/components/schemas/ManagedDataRevisionStatus" }, "uploadSessionId": { "example": "example", "maxLength": 160, "minLength": 1, "type": "string" } }, "required": [ "id", "status", "fileCount", "size", "createdAt", "uploadSessionId" ], "type": "object" }, "ManagedDataS3CompletedPart": { "example": { "etag": "example", "partNumber": 1, "sha256": "example" }, "properties": { "etag": { "example": "example", "maxLength": 1024, "minLength": 1, "type": "string" }, "partNumber": { "example": 1, "format": "int32", "maximum": 10000, "minimum": 1, "type": "integer" }, "sha256": { "example": "example", "maxLength": 64, "minLength": 64, "type": "string" } }, "required": [ "partNumber", "etag" ], "type": "object" }, "ManagedDataS3MultipartCompleteRequest": { "example": { "parts": [ { "etag": "example", "partNumber": 1, "sha256": "example" } ] }, "properties": { "parts": { "example": [ { "etag": "example", "partNumber": 1, "sha256": "example" } ], "items": { "$ref": "#/components/schemas/ManagedDataS3CompletedPart" }, "type": "array" } }, "required": [ "parts" ], "type": "object" }, "ManagedDataS3MultipartCreateRequest": { "example": { "path": "example" }, "properties": { "path": { "example": "example", "maxLength": 1024, "minLength": 1, "type": "string" } }, "required": [ "path" ], "type": "object" }, "ManagedDataS3MultipartNegotiation": { "description": "Negotiated S3 multipart transport. Commands below manage transport only; upload-session finalization remains a separate lifecycle operation.", "example": { "createEndpoint": "example", "maximumPartSize": 1, "maximumParts": 1, "minimumPartSize": 1 }, "properties": { "createEndpoint": { "example": "example", "maxLength": 8192, "minLength": 1, "type": "string" }, "maximumPartSize": { "example": 1, "format": "int64", "minimum": 1, "type": "integer" }, "maximumParts": { "example": 1, "format": "int32", "maximum": 10000, "minimum": 1, "type": "integer" }, "minimumPartSize": { "example": 1, "format": "int64", "minimum": 1, "type": "integer" } }, "required": [ "createEndpoint", "minimumPartSize", "maximumPartSize", "maximumParts" ], "type": "object" }, "ManagedDataS3MultipartSignPartRequest": { "example": { "sha256": "example", "size": 1 }, "properties": { "sha256": { "example": "example", "maxLength": 64, "minLength": 64, "type": "string" }, "size": { "example": 1, "format": "int64", "minimum": 1, "type": "integer" } }, "required": [ "size" ], "type": "object" }, "ManagedDataS3MultipartSignedPartResponse": { "example": { "expiresAt": "2026-01-02T15:04:05Z", "headers": [ { "name": "example", "value": "example" } ], "partNumber": 1, "url": "example" }, "properties": { "expiresAt": { "example": "2026-01-02T15:04:05Z", "format": "date-time", "type": "string" }, "headers": { "example": [ { "name": "example", "value": "example" } ], "items": { "$ref": "#/components/schemas/ManagedDataHTTPHeader" }, "type": "array" }, "partNumber": { "example": 1, "format": "int32", "maximum": 10000, "minimum": 1, "type": "integer" }, "url": { "example": "example", "maxLength": 8192, "minLength": 1, "type": "string" } }, "required": [ "partNumber", "url", "headers", "expiresAt" ], "type": "object" }, "ManagedDataS3MultipartStatus": { "enum": [ "open", "completed", "aborted" ], "example": "open", "type": "string" }, "ManagedDataS3MultipartUploadResponse": { "example": { "createdAt": "2026-01-02T15:04:05Z", "existing": true, "expiresAt": "2026-01-02T15:04:05Z", "file": { "path": "example", "sha256": "example", "size": 1 }, "id": "example", "status": "open", "uploadSessionId": "example" }, "properties": { "createdAt": { "example": "2026-01-02T15:04:05Z", "format": "date-time", "type": "string" }, "existing": { "example": true, "type": "boolean" }, "expiresAt": { "example": "2026-01-02T15:04:05Z", "format": "date-time", "type": "string" }, "file": { "$ref": "#/components/schemas/ManagedDataFileMetadata" }, "id": { "example": "example", "maxLength": 160, "minLength": 1, "type": "string" }, "status": { "$ref": "#/components/schemas/ManagedDataS3MultipartStatus" }, "uploadSessionId": { "example": "example", "maxLength": 160, "minLength": 1, "type": "string" } }, "required": [ "id", "uploadSessionId", "file", "status", "existing", "createdAt" ], "type": "object" }, "ManagedDataTusUploadNegotiation": { "description": "Negotiated TUS transport. The endpoint implements the TUS protocol and remains separate from upload-session lifecycle commands.", "example": { "endpoint": "example", "expiresAt": "2026-01-02T15:04:05Z", "offset": 1, "uploadId": "example" }, "properties": { "endpoint": { "example": "example", "maxLength": 8192, "minLength": 1, "type": "string" }, "expiresAt": { "example": "2026-01-02T15:04:05Z", "format": "date-time", "type": "string" }, "offset": { "example": 1, "format": "int64", "minimum": 0, "type": "integer" }, "uploadId": { "example": "example", "maxLength": 160, "minLength": 1, "type": "string" } }, "required": [ "endpoint", "uploadId", "offset", "expiresAt" ], "type": "object" }, "ManagedDataUploadNegotiation": { "description": "Backend-neutral upload instructions. Exactly one protocol-specific object is present for tus or S3 multipart; already-present files have neither.", "example": { "protocol": "tus", "s3Multipart": { "createEndpoint": "example", "maximumPartSize": 1, "maximumParts": 1, "minimumPartSize": 1 }, "tus": { "endpoint": "example", "expiresAt": "2026-01-02T15:04:05Z", "offset": 1, "uploadId": "example" } }, "properties": { "protocol": { "$ref": "#/components/schemas/ManagedDataUploadProtocol" }, "s3Multipart": { "$ref": "#/components/schemas/ManagedDataS3MultipartNegotiation" }, "tus": { "$ref": "#/components/schemas/ManagedDataTusUploadNegotiation" } }, "required": [ "protocol" ], "type": "object" }, "ManagedDataUploadProtocol": { "enum": [ "tus", "s3_multipart", "already_present" ], "example": "tus", "type": "string" }, "ManagedDataUploadSessionCreateRequest": { "example": { "manifest": { "files": [ { "path": "example", "sha256": "example", "size": 1 } ] } }, "properties": { "manifest": { "$ref": "#/components/schemas/ManagedDataManifest" } }, "required": [ "manifest" ], "type": "object" }, "ManagedDataUploadSessionListResponse": { "example": { "items": [ { "completedAt": "2026-01-02T15:04:05Z", "connection": "example", "createdAt": "2026-01-02T15:04:05Z", "error": "example", "expiresAt": "2026-01-02T15:04:05Z", "files": [ { "error": "example", "file": { "path": "example", "sha256": "example", "size": 1 }, "negotiation": { "protocol": "tus", "s3Multipart": { "createEndpoint": "example", "maximumPartSize": 1, "maximumParts": 1, "minimumPartSize": 1 }, "tus": { "endpoint": "example", "expiresAt": "2026-01-02T15:04:05Z", "offset": 1, "uploadId": "example" } }, "status": "pending" } ], "id": "example", "manifest": { "files": [ { "path": "example", "sha256": "example", "size": 1 } ] }, "project": "example", "revisionId": "example", "status": "open" } ], "page": { "nextCursor": "example" } }, "properties": { "items": { "example": [ { "completedAt": "2026-01-02T15:04:05Z", "connection": "example", "createdAt": "2026-01-02T15:04:05Z", "error": "example", "expiresAt": "2026-01-02T15:04:05Z", "files": [ { "error": "example", "file": { "path": "example", "sha256": "example", "size": 1 }, "negotiation": { "protocol": "tus", "s3Multipart": { "createEndpoint": "example", "maximumPartSize": 1, "maximumParts": 1, "minimumPartSize": 1 }, "tus": { "endpoint": "example", "expiresAt": "2026-01-02T15:04:05Z", "offset": 1, "uploadId": "example" } }, "status": "pending" } ], "id": "example", "manifest": { "files": [ { "path": "example", "sha256": "example", "size": 1 } ] }, "project": "example", "revisionId": "example", "status": "open" } ], "items": { "$ref": "#/components/schemas/ManagedDataUploadSessionResponse" }, "type": "array" }, "page": { "$ref": "#/components/schemas/PageInfo" } }, "required": [ "items", "page" ], "type": "object" }, "ManagedDataUploadSessionResponse": { "example": { "completedAt": "2026-01-02T15:04:05Z", "connection": "example", "createdAt": "2026-01-02T15:04:05Z", "error": "example", "expiresAt": "2026-01-02T15:04:05Z", "files": [ { "error": "example", "file": { "path": "example", "sha256": "example", "size": 1 }, "negotiation": { "protocol": "tus", "s3Multipart": { "createEndpoint": "example", "maximumPartSize": 1, "maximumParts": 1, "minimumPartSize": 1 }, "tus": { "endpoint": "example", "expiresAt": "2026-01-02T15:04:05Z", "offset": 1, "uploadId": "example" } }, "status": "pending" } ], "id": "example", "manifest": { "files": [ { "path": "example", "sha256": "example", "size": 1 } ] }, "project": "example", "revisionId": "example", "status": "open" }, "properties": { "completedAt": { "example": "2026-01-02T15:04:05Z", "format": "date-time", "type": "string" }, "connection": { "example": "example", "maxLength": 128, "minLength": 1, "type": "string" }, "createdAt": { "example": "2026-01-02T15:04:05Z", "format": "date-time", "type": "string" }, "error": { "example": "example", "maxLength": 2048, "minLength": 1, "type": "string" }, "expiresAt": { "example": "2026-01-02T15:04:05Z", "format": "date-time", "type": "string" }, "files": { "example": [ { "error": "example", "file": { "path": "example", "sha256": "example", "size": 1 }, "negotiation": { "protocol": "tus", "s3Multipart": { "createEndpoint": "example", "maximumPartSize": 1, "maximumParts": 1, "minimumPartSize": 1 }, "tus": { "endpoint": "example", "expiresAt": "2026-01-02T15:04:05Z", "offset": 1, "uploadId": "example" } }, "status": "pending" } ], "items": { "$ref": "#/components/schemas/ManagedDataFileUploadResponse" }, "type": "array" }, "id": { "example": "example", "maxLength": 160, "minLength": 1, "type": "string" }, "manifest": { "$ref": "#/components/schemas/ManagedDataManifest" }, "project": { "example": "example", "maxLength": 128, "minLength": 1, "type": "string" }, "revisionId": { "example": "example", "maxLength": 71, "minLength": 71, "type": "string" }, "status": { "$ref": "#/components/schemas/ManagedDataUploadSessionStatus" } }, "required": [ "id", "project", "connection", "revisionId", "status", "manifest", "files", "createdAt", "expiresAt" ], "type": "object" }, "ManagedDataUploadSessionStatus": { "enum": [ "open", "finalizing", "completed", "cancelled", "failed", "expired" ], "example": "open", "type": "string" }, "MatrixVisualizationSpec": { "allOf": [ { "$ref": "#/components/schemas/VisualizationSpecBase" } ], "example": { "columns": [ { "dataset": "example", "field": "example" } ], "kind": "example", "measureFormatting": { "key": [] }, "measures": [ { "dataset": "example", "field": "example" } ], "presentation": { "rowHeight": 1, "showHeader": true, "striped": true }, "rows": [ { "dataset": "example", "field": "example" } ] }, "properties": { "columns": { "example": [ { "dataset": "example", "field": "example" } ], "items": { "$ref": "#/components/schemas/VisualizationFieldRef" }, "type": "array" }, "kind": { "enum": [ "matrix" ], "example": "example", "type": "string" }, "measureFormatting": { "additionalProperties": { "items": { "$ref": "#/components/schemas/TableVisualizationFormattingRule" }, "type": "array" }, "example": { "key": [] }, "type": "object" }, "measures": { "example": [ { "dataset": "example", "field": "example" } ], "items": { "$ref": "#/components/schemas/VisualizationFieldRef" }, "type": "array" }, "presentation": { "$ref": "#/components/schemas/GridVisualizationPresentation" }, "rows": { "example": [ { "dataset": "example", "field": "example" } ], "items": { "$ref": "#/components/schemas/VisualizationFieldRef" }, "type": "array" } }, "required": [ "kind", "rows", "columns", "measures", "measureFormatting", "presentation" ], "type": "object" }, "ModelDashboardUsage": { "example": { "id": "example", "pages": 1, "semantic_model": "example", "title": "example" }, "properties": { "id": { "example": "example", "type": "string" }, "pages": { "example": 1, "format": "int32", "type": "integer" }, "semantic_model": { "example": "example", "type": "string" }, "title": { "example": "example", "type": "string" } }, "required": [ "id", "title", "semantic_model", "pages" ], "type": "object" }, "ModelRef": { "example": { "id": "example", "title": "example" }, "properties": { "id": { "example": "example", "type": "string" }, "title": { "example": "example", "type": "string" } }, "required": [ "id", "title" ], "type": "object" }, "NumberVisualizationFormat": { "allOf": [ { "$ref": "#/components/schemas/VisualizationFormatBase" } ], "example": { "kind": "example", "maximumFractionDigits": 1, "minimumFractionDigits": 1 }, "properties": { "kind": { "enum": [ "number" ], "example": "example", "type": "string" }, "maximumFractionDigits": { "example": 1, "format": "int32", "type": "integer" }, "minimumFractionDigits": { "example": 1, "format": "int32", "type": "integer" } }, "required": [ "kind" ], "type": "object" }, "OwnershipTransferRequest": { "example": { "objectId": "example", "objectType": "example", "ownerPrincipalId": "example" }, "properties": { "objectId": { "example": "example", "type": "string" }, "objectType": { "example": "example", "type": "string" }, "ownerPrincipalId": { "example": "example", "type": "string" } }, "required": [ "ownerPrincipalId" ], "type": "object" }, "PageInfo": { "example": { "nextCursor": "example" }, "properties": { "nextCursor": { "example": "example", "type": "string" } }, "type": "object" }, "PercentVisualizationFormat": { "allOf": [ { "$ref": "#/components/schemas/VisualizationFormatBase" } ], "example": { "kind": "example", "maximumFractionDigits": 1, "minimumFractionDigits": 1 }, "properties": { "kind": { "enum": [ "percent" ], "example": "example", "type": "string" }, "maximumFractionDigits": { "example": 1, "format": "int32", "type": "integer" }, "minimumFractionDigits": { "example": 1, "format": "int32", "type": "integer" } }, "required": [ "kind" ], "type": "object" }, "PivotVisualizationSpec": { "allOf": [ { "$ref": "#/components/schemas/VisualizationSpecBase" } ], "example": { "columns": [ { "dataset": "example", "field": "example" } ], "kind": "example", "measureFormatting": { "key": [] }, "measures": [ { "dataset": "example", "field": "example" } ], "presentation": { "rowHeight": 1, "showHeader": true, "striped": true }, "rows": [ { "dataset": "example", "field": "example" } ] }, "properties": { "columns": { "example": [ { "dataset": "example", "field": "example" } ], "items": { "$ref": "#/components/schemas/VisualizationFieldRef" }, "type": "array" }, "kind": { "enum": [ "pivot" ], "example": "example", "type": "string" }, "measureFormatting": { "additionalProperties": { "items": { "$ref": "#/components/schemas/TableVisualizationFormattingRule" }, "type": "array" }, "example": { "key": [] }, "type": "object" }, "measures": { "example": [ { "dataset": "example", "field": "example" } ], "items": { "$ref": "#/components/schemas/VisualizationFieldRef" }, "type": "array" }, "presentation": { "$ref": "#/components/schemas/GridVisualizationPresentation" }, "rows": { "example": [ { "dataset": "example", "field": "example" } ], "items": { "$ref": "#/components/schemas/VisualizationFieldRef" }, "type": "array" } }, "required": [ "kind", "rows", "columns", "measures", "measureFormatting", "presentation" ], "type": "object" }, "PolarVisualizationPresentation": { "allOf": [ { "$ref": "#/components/schemas/VisualizationPresentation" } ], "example": { "area": true, "maximum": 1, "minimum": 1, "progressWidth": 1, "showPointer": true, "target": 1, "thresholds": [ { "tone": "neutral", "value": 1 } ] }, "properties": { "area": { "example": true, "type": "boolean" }, "maximum": { "example": 1, "format": "double", "type": "number" }, "minimum": { "example": 1, "format": "double", "type": "number" }, "progressWidth": { "example": 1, "format": "double", "type": "number" }, "showPointer": { "example": true, "type": "boolean" }, "target": { "example": 1, "format": "double", "type": "number" }, "thresholds": { "example": [ { "tone": "neutral", "value": 1 } ], "items": { "$ref": "#/components/schemas/VisualizationThreshold" }, "type": "array" } }, "required": [ "showPointer" ], "type": "object" }, "PolarVisualizationSpec": { "allOf": [ { "$ref": "#/components/schemas/VisualizationSpecBase" } ], "example": { "category": { "dataset": "example", "field": "example" }, "kind": "example", "mark": "radar", "presentation": { "area": true, "maximum": 1, "minimum": 1, "progressWidth": 1, "showPointer": true, "target": 1, "thresholds": [ { "tone": "neutral", "value": 1 } ] }, "series": { "dataset": "example", "field": "example" }, "value": { "dataset": "example", "field": "example" } }, "properties": { "category": { "$ref": "#/components/schemas/VisualizationFieldRef" }, "kind": { "enum": [ "polar" ], "example": "example", "type": "string" }, "mark": { "$ref": "#/components/schemas/VisualizationPolarMark" }, "presentation": { "$ref": "#/components/schemas/PolarVisualizationPresentation" }, "series": { "$ref": "#/components/schemas/VisualizationFieldRef" }, "value": { "$ref": "#/components/schemas/VisualizationFieldRef" } }, "required": [ "kind", "mark", "value", "presentation" ], "type": "object" }, "PrincipalCreateRequest": { "example": { "displayName": "example", "email": "example" }, "properties": { "displayName": { "example": "example", "type": "string" }, "email": { "example": "example", "type": "string" } }, "required": [ "email" ], "type": "object" }, "PrincipalListResponse": { "example": { "items": [ { "createdAt": "2026-01-02T15:04:05Z", "displayName": "example", "email": "example", "id": "example", "kind": "example", "updatedAt": "2026-01-02T15:04:05Z" } ], "page": { "nextCursor": "example" } }, "properties": { "items": { "example": [ { "createdAt": "2026-01-02T15:04:05Z", "displayName": "example", "email": "example", "id": "example", "kind": "example", "updatedAt": "2026-01-02T15:04:05Z" } ], "items": { "$ref": "#/components/schemas/PrincipalResponse" }, "type": "array" }, "page": { "$ref": "#/components/schemas/PageInfo" } }, "required": [ "items", "page" ], "type": "object" }, "PrincipalPatchRequest": { "example": { "displayName": "example" }, "properties": { "displayName": { "example": "example", "type": "string" } }, "type": "object" }, "PrincipalResponse": { "example": { "createdAt": "2026-01-02T15:04:05Z", "displayName": "example", "email": "example", "id": "example", "kind": "example", "updatedAt": "2026-01-02T15:04:05Z" }, "properties": { "createdAt": { "example": "2026-01-02T15:04:05Z", "format": "date-time", "type": "string" }, "displayName": { "example": "example", "type": "string" }, "email": { "example": "example", "type": "string" }, "id": { "example": "example", "type": "string" }, "kind": { "example": "example", "type": "string" }, "updatedAt": { "example": "2026-01-02T15:04:05Z", "format": "date-time", "type": "string" } }, "required": [ "id", "kind", "email", "displayName", "createdAt", "updatedAt" ], "type": "object" }, "ProblemDetails": { "example": { "code": "example", "detail": "example", "errors": [ { "code": "example", "detail": "example", "field": "example" } ], "instance": "example", "requestId": "example", "status": 1, "title": "example", "type": "example" }, "properties": { "code": { "example": "example", "type": "string" }, "detail": { "example": "example", "type": "string" }, "errors": { "example": [ { "code": "example", "detail": "example", "field": "example" } ], "items": { "$ref": "#/components/schemas/ProblemFieldError" }, "type": "array" }, "instance": { "example": "example", "type": "string" }, "requestId": { "example": "example", "type": "string" }, "status": { "example": 1, "format": "int32", "type": "integer" }, "title": { "example": "example", "type": "string" }, "type": { "example": "example", "type": "string" } }, "required": [ "type", "title", "status", "detail", "instance", "code", "requestId", "errors" ], "type": "object" }, "ProblemFieldError": { "example": { "code": "example", "detail": "example", "field": "example" }, "properties": { "code": { "example": "example", "type": "string" }, "detail": { "example": "example", "type": "string" }, "field": { "example": "example", "type": "string" } }, "required": [ "field", "code", "detail" ], "type": "object" }, "ProjectListResponse": { "example": { "items": [ { "activeDeploymentId": "example", "createdAt": "2026-01-02T15:04:05Z", "description": "example", "id": "example", "latestReleaseId": "example", "title": "example", "updatedAt": "2026-01-02T15:04:05Z" } ], "page": { "nextCursor": "example" } }, "properties": { "items": { "example": [ { "activeDeploymentId": "example", "createdAt": "2026-01-02T15:04:05Z", "description": "example", "id": "example", "latestReleaseId": "example", "title": "example", "updatedAt": "2026-01-02T15:04:05Z" } ], "items": { "$ref": "#/components/schemas/ProjectResponse" }, "type": "array" }, "page": { "$ref": "#/components/schemas/PageInfo" } }, "required": [ "items", "page" ], "type": "object" }, "ProjectResponse": { "example": { "activeDeploymentId": "example", "createdAt": "2026-01-02T15:04:05Z", "description": "example", "id": "example", "latestReleaseId": "example", "title": "example", "updatedAt": "2026-01-02T15:04:05Z" }, "properties": { "activeDeploymentId": { "example": "example", "type": "string" }, "createdAt": { "example": "2026-01-02T15:04:05Z", "format": "date-time", "type": "string" }, "description": { "example": "example", "type": "string" }, "id": { "example": "example", "type": "string" }, "latestReleaseId": { "example": "example", "type": "string" }, "title": { "example": "example", "type": "string" }, "updatedAt": { "example": "2026-01-02T15:04:05Z", "format": "date-time", "type": "string" } }, "required": [ "id", "title", "createdAt", "updatedAt" ], "type": "object" }, "ProjectWorkspaceListResponse": { "example": { "items": [ { "activeServingStateId": "example", "description": "example", "id": "example", "title": "example" } ], "page": { "nextCursor": "example" } }, "properties": { "items": { "example": [ { "activeServingStateId": "example", "description": "example", "id": "example", "title": "example" } ], "items": { "$ref": "#/components/schemas/ProjectWorkspaceResponse" }, "type": "array" }, "page": { "$ref": "#/components/schemas/PageInfo" } }, "required": [ "items", "page" ], "type": "object" }, "ProjectWorkspaceResponse": { "example": { "activeServingStateId": "example", "description": "example", "id": "example", "title": "example" }, "properties": { "activeServingStateId": { "example": "example", "type": "string" }, "description": { "example": "example", "type": "string" }, "id": { "example": "example", "type": "string" }, "title": { "example": "example", "type": "string" } }, "required": [ "id", "title" ], "type": "object" }, "ProportionalVisualizationPresentation": { "allOf": [ { "$ref": "#/components/schemas/VisualizationPresentation" } ], "example": { "align": "example", "centerLabel": "example", "innerRadius": 1, "labelPosition": "automatic", "orientation": "horizontal", "outerRadius": 1, "rose": true, "sort": "ascending" }, "properties": { "align": { "example": "example", "type": "string" }, "centerLabel": { "example": "example", "type": "string" }, "innerRadius": { "example": 1, "format": "double", "type": "number" }, "labelPosition": { "$ref": "#/components/schemas/VisualizationLabelPosition" }, "orientation": { "$ref": "#/components/schemas/VisualizationOrientation" }, "outerRadius": { "example": 1, "format": "double", "type": "number" }, "rose": { "example": true, "type": "boolean" }, "sort": { "$ref": "#/components/schemas/VisualizationSortDirection" } }, "required": [ "orientation", "rose" ], "type": "object" }, "ProportionalVisualizationSpec": { "allOf": [ { "$ref": "#/components/schemas/VisualizationSpecBase" } ], "example": { "category": { "dataset": "example", "field": "example" }, "kind": "example", "mark": "pie", "presentation": { "align": "example", "centerLabel": "example", "innerRadius": 1, "labelPosition": "automatic", "orientation": "horizontal", "outerRadius": 1, "rose": true, "sort": "ascending" }, "series": { "dataset": "example", "field": "example" }, "value": { "dataset": "example", "field": "example" } }, "properties": { "category": { "$ref": "#/components/schemas/VisualizationFieldRef" }, "kind": { "enum": [ "proportional" ], "example": "example", "type": "string" }, "mark": { "$ref": "#/components/schemas/VisualizationProportionalMark" }, "presentation": { "$ref": "#/components/schemas/ProportionalVisualizationPresentation" }, "series": { "$ref": "#/components/schemas/VisualizationFieldRef" }, "value": { "$ref": "#/components/schemas/VisualizationFieldRef" } }, "required": [ "kind", "mark", "category", "value", "presentation" ], "type": "object" }, "QueryColumn": { "example": { "fieldRef": { "id": "example", "type": "example", "workspaceId": "example" }, "format": "example", "kind": "example", "label": "example", "name": "example", "nullable": true, "type": "boolean", "unit": "example" }, "properties": { "fieldRef": { "$ref": "#/components/schemas/QueryFieldRef", "description": "Governed catalog ref for the selected field, measure, or metric." }, "format": { "description": "Formatting contract declared by the semantic measure or metric.", "example": "example", "type": "string" }, "kind": { "description": "Semantic role of the selected member.", "enum": [ "dimension", "measure", "metric" ], "example": "example", "type": "string" }, "label": { "description": "Business-facing semantic label.", "example": "example", "type": "string" }, "name": { "description": "Output column name used to match positional row cells.", "example": "example", "type": "string" }, "nullable": { "description": "Whether the governed semantic definition can produce SQL NULL.", "example": true, "type": "boolean" }, "type": { "$ref": "#/components/schemas/QueryColumnType", "description": "Precision-safe wire data type. Agent tools expose this property as dataType." }, "unit": { "description": "Business unit declared by the semantic measure or metric.", "example": "example", "type": "string" } }, "required": [ "name", "type", "nullable" ], "type": "object" }, "QueryColumnType": { "enum": [ "boolean", "int64", "decimal", "float64", "string", "date", "timestamp", "json" ], "example": "boolean", "type": "string" }, "QueryCompleteness": { "example": { "hasMore": true, "returnedRows": 1 }, "properties": { "hasMore": { "description": "Whether another governed page is available.", "example": true, "type": "boolean" }, "returnedRows": { "description": "Number of rows present in this response page.", "example": 1, "format": "int32", "type": "integer" } }, "required": [ "returnedRows", "hasMore" ], "type": "object" }, "QueryEventListResponse": { "example": { "items": [ { "bytesEstimate": 1, "correlationId": "example", "createdAt": "2026-01-02T15:04:05Z", "durationMs": 1, "error": "example", "id": "example", "modelId": "example", "objectId": "example", "objectType": "example", "operation": "example", "planText": "example", "principalId": "example", "query": { "key": "example" }, "queryKind": "example", "requestId": "example", "rowsReturned": 1, "sql": "example", "status": "example", "surface": "example", "target": "example", "workspaceId": "example" } ], "page": { "nextCursor": "example" } }, "properties": { "items": { "example": [ { "bytesEstimate": 1, "correlationId": "example", "createdAt": "2026-01-02T15:04:05Z", "durationMs": 1, "error": "example", "id": "example", "modelId": "example", "objectId": "example", "objectType": "example", "operation": "example", "planText": "example", "principalId": "example", "query": { "key": "example" }, "queryKind": "example", "requestId": "example", "rowsReturned": 1, "sql": "example", "status": "example", "surface": "example", "target": "example", "workspaceId": "example" } ], "items": { "$ref": "#/components/schemas/QueryEventResponse" }, "type": "array" }, "page": { "$ref": "#/components/schemas/PageInfo" } }, "required": [ "items", "page" ], "type": "object" }, "QueryEventResponse": { "example": { "bytesEstimate": 1, "correlationId": "example", "createdAt": "2026-01-02T15:04:05Z", "durationMs": 1, "error": "example", "id": "example", "modelId": "example", "objectId": "example", "objectType": "example", "operation": "example", "planText": "example", "principalId": "example", "query": { "key": "example" }, "queryKind": "example", "requestId": "example", "rowsReturned": 1, "sql": "example", "status": "example", "surface": "example", "target": "example", "workspaceId": "example" }, "properties": { "bytesEstimate": { "example": 1, "format": "int64", "type": "integer" }, "correlationId": { "example": "example", "type": "string" }, "createdAt": { "example": "2026-01-02T15:04:05Z", "format": "date-time", "type": "string" }, "durationMs": { "example": 1, "format": "int64", "type": "integer" }, "error": { "example": "example", "type": "string" }, "id": { "example": "example", "type": "string" }, "modelId": { "example": "example", "type": "string" }, "objectId": { "example": "example", "type": "string" }, "objectType": { "example": "example", "type": "string" }, "operation": { "example": "example", "type": "string" }, "planText": { "example": "example", "type": "string" }, "principalId": { "example": "example", "type": "string" }, "query": { "additionalProperties": {}, "example": { "key": "example" }, "type": "object" }, "queryKind": { "example": "example", "type": "string" }, "requestId": { "example": "example", "type": "string" }, "rowsReturned": { "example": 1, "format": "int32", "type": "integer" }, "sql": { "example": "example", "type": "string" }, "status": { "example": "example", "type": "string" }, "surface": { "example": "example", "type": "string" }, "target": { "example": "example", "type": "string" }, "workspaceId": { "example": "example", "type": "string" } }, "required": [ "id", "workspaceId", "surface", "operation", "queryKind", "modelId", "target", "objectType", "objectId", "requestId", "correlationId", "status", "durationMs", "rowsReturned", "bytesEstimate", "query", "createdAt" ], "type": "object" }, "QueryFieldRef": { "example": { "id": "example", "type": "example", "workspaceId": "example" }, "properties": { "id": { "description": "Workspace-local catalog ID.", "example": "example", "type": "string" }, "type": { "description": "Catalog type of the semantic member.", "enum": [ "field", "measure" ], "example": "example", "type": "string" }, "workspaceId": { "description": "Workspace containing the semantic member.", "example": "example", "type": "string" } }, "required": [ "workspaceId", "type", "id" ], "type": "object" }, "QueryFormat": { "enum": [ "application/json", "application/vnd.apache.arrow.stream" ], "example": "application/json", "type": "string" }, "QueryFreshness": { "example": { "lastSuccessfulRefreshAt": "2026-01-02T15:04:05Z", "servingStateId": "example", "snapshotId": "example", "source": "example", "status": "example" }, "properties": { "lastSuccessfulRefreshAt": { "description": "Completion time of the last successful publish or refresh. This is not an upstream event-time watermark.", "example": "2026-01-02T15:04:05Z", "format": "date-time", "type": "string" }, "servingStateId": { "description": "Serving state that produced the successful data version.", "example": "example", "type": "string" }, "snapshotId": { "description": "DuckLake snapshot ID recorded for the successful data version.", "example": "example", "type": "string" }, "source": { "description": "Whether the data version came from publish or refresh.", "enum": [ "publish", "refresh" ], "example": "example", "type": "string" }, "status": { "description": "current when the successful data version belongs to the queried serving snapshot; stale otherwise.", "enum": [ "current", "stale" ], "example": "example", "type": "string" } }, "required": [ "lastSuccessfulRefreshAt", "snapshotId", "servingStateId", "source", "status" ], "type": "object" }, "RefreshRunCreateRequest": { "example": { "pipelineId": "example", "retryOf": "example" }, "properties": { "pipelineId": { "example": "example", "type": "string" }, "retryOf": { "example": "example", "type": "string" } }, "required": [ "pipelineId" ], "type": "object" }, "RefreshRunListResponse": { "example": { "items": [ { "createdAt": "2026-01-02T15:04:05Z", "error": "example", "finishedAt": "2026-01-02T15:04:05Z", "id": "example", "pipelineId": "example", "principalDisplayName": "example", "principalId": "example", "retryOf": "example", "semanticModel": "example", "startedAt": "2026-01-02T15:04:05Z", "status": "example", "trigger": "example", "workspaceId": "example" } ], "page": { "nextCursor": "example" } }, "properties": { "items": { "example": [ { "createdAt": "2026-01-02T15:04:05Z", "error": "example", "finishedAt": "2026-01-02T15:04:05Z", "id": "example", "pipelineId": "example", "principalDisplayName": "example", "principalId": "example", "retryOf": "example", "semanticModel": "example", "startedAt": "2026-01-02T15:04:05Z", "status": "example", "trigger": "example", "workspaceId": "example" } ], "items": { "$ref": "#/components/schemas/RefreshRunResponse" }, "type": "array" }, "page": { "$ref": "#/components/schemas/PageInfo" } }, "required": [ "items", "page" ], "type": "object" }, "RefreshRunResponse": { "example": { "createdAt": "2026-01-02T15:04:05Z", "error": "example", "finishedAt": "2026-01-02T15:04:05Z", "id": "example", "pipelineId": "example", "principalDisplayName": "example", "principalId": "example", "retryOf": "example", "semanticModel": "example", "startedAt": "2026-01-02T15:04:05Z", "status": "example", "trigger": "example", "workspaceId": "example" }, "properties": { "createdAt": { "example": "2026-01-02T15:04:05Z", "format": "date-time", "type": "string" }, "error": { "example": "example", "type": "string" }, "finishedAt": { "example": "2026-01-02T15:04:05Z", "format": "date-time", "type": "string" }, "id": { "example": "example", "type": "string" }, "pipelineId": { "example": "example", "type": "string" }, "principalDisplayName": { "example": "example", "type": "string" }, "principalId": { "example": "example", "type": "string" }, "retryOf": { "example": "example", "type": "string" }, "semanticModel": { "example": "example", "type": "string" }, "startedAt": { "example": "2026-01-02T15:04:05Z", "format": "date-time", "type": "string" }, "status": { "example": "example", "type": "string" }, "trigger": { "example": "example", "type": "string" }, "workspaceId": { "example": "example", "type": "string" } }, "required": [ "id", "workspaceId", "pipelineId", "semanticModel", "trigger", "status", "createdAt" ], "type": "object" }, "ReleaseArtifactResponse": { "example": { "digest": "example", "releaseId": "example", "sizeBytes": 1, "workspaceId": "example" }, "properties": { "digest": { "example": "example", "type": "string" }, "releaseId": { "example": "example", "type": "string" }, "sizeBytes": { "example": 1, "format": "int64", "type": "integer" }, "workspaceId": { "example": "example", "type": "string" } }, "required": [ "releaseId", "workspaceId", "digest", "sizeBytes" ], "type": "object" }, "ReleaseConnectionPin": { "example": { "connection": "example", "revisionId": "example" }, "properties": { "connection": { "example": "example", "type": "string" }, "revisionId": { "example": "example", "type": "string" } }, "required": [ "connection", "revisionId" ], "type": "object" }, "ReleaseCreateRequest": { "example": { "connections": [ { "connection": "example", "revisionId": "example" } ], "projectDigest": "example", "workspaces": [ { "artifactDigest": "example", "servingStateId": "example", "workspace": "example" } ] }, "properties": { "connections": { "example": [ { "connection": "example", "revisionId": "example" } ], "items": { "$ref": "#/components/schemas/ReleaseConnectionPin" }, "type": "array" }, "projectDigest": { "example": "example", "type": "string" }, "workspaces": { "example": [ { "artifactDigest": "example", "servingStateId": "example", "workspace": "example" } ], "items": { "$ref": "#/components/schemas/ReleaseWorkspaceManifest" }, "type": "array" } }, "required": [ "projectDigest", "workspaces", "connections" ], "type": "object" }, "ReleaseListResponse": { "example": { "items": [ { "connections": [ { "connection": "example", "revisionId": "example" } ], "createdAt": "2026-01-02T15:04:05Z", "createdBy": "example", "error": "example", "finalizedAt": "2026-01-02T15:04:05Z", "id": "example", "projectDigest": "example", "projectId": "example", "status": "draft", "workspaces": [ { "artifactDigest": "example", "servingStateId": "example", "workspace": "example" } ] } ], "page": { "nextCursor": "example" } }, "properties": { "items": { "example": [ { "connections": [ { "connection": "example", "revisionId": "example" } ], "createdAt": "2026-01-02T15:04:05Z", "createdBy": "example", "error": "example", "finalizedAt": "2026-01-02T15:04:05Z", "id": "example", "projectDigest": "example", "projectId": "example", "status": "draft", "workspaces": [ { "artifactDigest": "example", "servingStateId": "example", "workspace": "example" } ] } ], "items": { "$ref": "#/components/schemas/ReleaseResponse" }, "type": "array" }, "page": { "$ref": "#/components/schemas/PageInfo" } }, "required": [ "items", "page" ], "type": "object" }, "ReleaseResponse": { "example": { "connections": [ { "connection": "example", "revisionId": "example" } ], "createdAt": "2026-01-02T15:04:05Z", "createdBy": "example", "error": "example", "finalizedAt": "2026-01-02T15:04:05Z", "id": "example", "projectDigest": "example", "projectId": "example", "status": "draft", "workspaces": [ { "artifactDigest": "example", "servingStateId": "example", "workspace": "example" } ] }, "properties": { "connections": { "example": [ { "connection": "example", "revisionId": "example" } ], "items": { "$ref": "#/components/schemas/ReleaseConnectionPin" }, "type": "array" }, "createdAt": { "example": "2026-01-02T15:04:05Z", "format": "date-time", "type": "string" }, "createdBy": { "example": "example", "type": "string" }, "error": { "example": "example", "type": "string" }, "finalizedAt": { "example": "2026-01-02T15:04:05Z", "format": "date-time", "type": "string" }, "id": { "example": "example", "type": "string" }, "projectDigest": { "example": "example", "type": "string" }, "projectId": { "example": "example", "type": "string" }, "status": { "$ref": "#/components/schemas/ReleaseStatus" }, "workspaces": { "example": [ { "artifactDigest": "example", "servingStateId": "example", "workspace": "example" } ], "items": { "$ref": "#/components/schemas/ReleaseWorkspaceManifest" }, "type": "array" } }, "required": [ "id", "projectId", "projectDigest", "status", "workspaces", "connections", "createdBy", "createdAt" ], "type": "object" }, "ReleaseStatus": { "enum": [ "draft", "validating", "ready", "failed" ], "example": "draft", "type": "string" }, "ReleaseWorkspaceManifest": { "example": { "artifactDigest": "example", "servingStateId": "example", "workspace": "example" }, "properties": { "artifactDigest": { "example": "example", "type": "string" }, "servingStateId": { "example": "example", "type": "string" }, "workspace": { "example": "example", "type": "string" } }, "required": [ "workspace", "artifactDigest" ], "type": "object" }, "RoleBindingListResponse": { "example": { "items": [ { "createdAt": "2026-01-02T15:04:05Z", "displayName": "example", "email": "example", "id": "example", "role": "example", "subjectId": "example", "subjectType": "example", "workspaceId": "example" } ], "page": { "nextCursor": "example" } }, "properties": { "items": { "example": [ { "createdAt": "2026-01-02T15:04:05Z", "displayName": "example", "email": "example", "id": "example", "role": "example", "subjectId": "example", "subjectType": "example", "workspaceId": "example" } ], "items": { "$ref": "#/components/schemas/RoleBindingResponse" }, "type": "array" }, "page": { "$ref": "#/components/schemas/PageInfo" } }, "required": [ "items", "page" ], "type": "object" }, "RoleBindingRequest": { "example": { "role": "example", "subjectId": "example", "subjectType": "example" }, "properties": { "role": { "example": "example", "type": "string" }, "subjectId": { "example": "example", "type": "string" }, "subjectType": { "example": "example", "type": "string" } }, "required": [ "subjectType", "subjectId", "role" ], "type": "object" }, "RoleBindingResponse": { "example": { "createdAt": "2026-01-02T15:04:05Z", "displayName": "example", "email": "example", "id": "example", "role": "example", "subjectId": "example", "subjectType": "example", "workspaceId": "example" }, "properties": { "createdAt": { "example": "2026-01-02T15:04:05Z", "format": "date-time", "type": "string" }, "displayName": { "example": "example", "type": "string" }, "email": { "example": "example", "type": "string" }, "id": { "example": "example", "type": "string" }, "role": { "example": "example", "type": "string" }, "subjectId": { "example": "example", "type": "string" }, "subjectType": { "example": "example", "type": "string" }, "workspaceId": { "example": "example", "type": "string" } }, "required": [ "id", "workspaceId", "subjectType", "subjectId", "role", "createdAt" ], "type": "object" }, "RoleListResponse": { "example": { "items": [ { "name": "example", "privileges": [ "example" ] } ], "page": { "nextCursor": "example" } }, "properties": { "items": { "example": [ { "name": "example", "privileges": [ "example" ] } ], "items": { "$ref": "#/components/schemas/RoleResponse" }, "type": "array" }, "page": { "$ref": "#/components/schemas/PageInfo" } }, "required": [ "items", "page" ], "type": "object" }, "RoleResponse": { "example": { "name": "example", "privileges": [ "example" ] }, "properties": { "name": { "example": "example", "type": "string" }, "privileges": { "example": [ "example" ], "items": { "type": "string" }, "type": "array" } }, "required": [ "name", "privileges" ], "type": "object" }, "SearchContextTag": { "enum": [ "current_page", "current_dashboard", "current_workspace" ], "example": "current_page", "type": "string" }, "SearchLocation": { "example": { "dashboardId": "example", "dashboardName": "example", "href": "example", "pageId": "example", "pageName": "example" }, "properties": { "dashboardId": { "example": "example", "type": "string" }, "dashboardName": { "example": "example", "type": "string" }, "href": { "example": "example", "type": "string" }, "pageId": { "example": "example", "type": "string" }, "pageName": { "example": "example", "type": "string" } }, "required": [ "href" ], "type": "object" }, "SearchReference": { "example": { "id": "example", "type": "workspace", "workspaceId": "example" }, "properties": { "id": { "example": "example", "type": "string" }, "type": { "$ref": "#/components/schemas/SearchResultType" }, "workspaceId": { "example": "example", "type": "string" } }, "required": [ "workspaceId", "type", "id" ], "type": "object" }, "SearchResponse": { "example": { "items": [ { "context": [ "current_page" ], "description": "example", "href": "example", "locations": [ { "dashboardId": "example", "dashboardName": "example", "href": "example", "pageId": "example", "pageName": "example" } ], "name": "example", "reference": { "id": "example", "type": "workspace", "workspaceId": "example" }, "visualType": "example", "workspace": { "id": "example", "name": "example" } } ], "page": { "nextCursor": "example" } }, "properties": { "items": { "example": [ { "context": [ "current_page" ], "description": "example", "href": "example", "locations": [ { "dashboardId": "example", "dashboardName": "example", "href": "example", "pageId": "example", "pageName": "example" } ], "name": "example", "reference": { "id": "example", "type": "workspace", "workspaceId": "example" }, "visualType": "example", "workspace": { "id": "example", "name": "example" } } ], "items": { "$ref": "#/components/schemas/SearchResult" }, "type": "array" }, "page": { "$ref": "#/components/schemas/PageInfo" } }, "required": [ "items", "page" ], "type": "object" }, "SearchResult": { "example": { "context": [ "current_page" ], "description": "example", "href": "example", "locations": [ { "dashboardId": "example", "dashboardName": "example", "href": "example", "pageId": "example", "pageName": "example" } ], "name": "example", "reference": { "id": "example", "type": "workspace", "workspaceId": "example" }, "visualType": "example", "workspace": { "id": "example", "name": "example" } }, "properties": { "context": { "example": [ "current_page" ], "items": { "$ref": "#/components/schemas/SearchContextTag" }, "type": "array" }, "description": { "example": "example", "type": "string" }, "href": { "example": "example", "type": "string" }, "locations": { "example": [ { "dashboardId": "example", "dashboardName": "example", "href": "example", "pageId": "example", "pageName": "example" } ], "items": { "$ref": "#/components/schemas/SearchLocation" }, "type": "array" }, "name": { "example": "example", "type": "string" }, "reference": { "$ref": "#/components/schemas/SearchReference" }, "visualType": { "example": "example", "type": "string" }, "workspace": { "$ref": "#/components/schemas/SearchWorkspaceSummary" } }, "required": [ "reference", "name", "workspace", "href", "locations", "context" ], "type": "object" }, "SearchResultType": { "enum": [ "workspace", "connection", "source", "model_table", "semantic_model", "semantic_table", "field", "measure", "dashboard", "page", "visual", "filter", "refresh_pipeline" ], "example": "workspace", "type": "string" }, "SearchWorkspaceSummary": { "example": { "id": "example", "name": "example" }, "properties": { "id": { "example": "example", "type": "string" }, "name": { "example": "example", "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "SecurableObjectResponse": { "example": { "createdAt": "2026-01-02T15:04:05Z", "displayName": "example", "id": "example", "ownerPrincipalId": "example", "parentId": "example", "type": "example", "updatedAt": "2026-01-02T15:04:05Z", "workspaceId": "example" }, "properties": { "createdAt": { "example": "2026-01-02T15:04:05Z", "format": "date-time", "type": "string" }, "displayName": { "example": "example", "type": "string" }, "id": { "example": "example", "type": "string" }, "ownerPrincipalId": { "example": "example", "type": "string" }, "parentId": { "example": "example", "type": "string" }, "type": { "example": "example", "type": "string" }, "updatedAt": { "example": "2026-01-02T15:04:05Z", "format": "date-time", "type": "string" }, "workspaceId": { "example": "example", "type": "string" } }, "required": [ "id", "type", "workspaceId", "createdAt", "updatedAt" ], "type": "object" }, "SemanticDatasetListResponse": { "example": { "items": [ { "description": "example", "fieldCount": 1, "id": "example", "kind": "example", "measureCount": 1, "source": "example" } ], "page": { "nextCursor": "example" } }, "properties": { "items": { "example": [ { "description": "example", "fieldCount": 1, "id": "example", "kind": "example", "measureCount": 1, "source": "example" } ], "items": { "$ref": "#/components/schemas/SemanticDatasetSummary" }, "type": "array" }, "page": { "$ref": "#/components/schemas/PageInfo" } }, "required": [ "items", "page" ], "type": "object" }, "SemanticDatasetResponse": { "example": { "description": "example", "fieldCount": 1, "grain": "example", "id": "example", "kind": "example", "measureCount": 1, "primaryKey": "example", "source": "example", "sources": [ "example" ] }, "properties": { "description": { "example": "example", "type": "string" }, "fieldCount": { "example": 1, "format": "int32", "type": "integer" }, "grain": { "example": "example", "type": "string" }, "id": { "example": "example", "type": "string" }, "kind": { "example": "example", "type": "string" }, "measureCount": { "example": 1, "format": "int32", "type": "integer" }, "primaryKey": { "example": "example", "type": "string" }, "source": { "example": "example", "type": "string" }, "sources": { "example": [ "example" ], "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "kind", "source", "sources", "description", "primaryKey", "grain", "fieldCount", "measureCount" ], "type": "object" }, "SemanticDatasetSummary": { "example": { "description": "example", "fieldCount": 1, "id": "example", "kind": "example", "measureCount": 1, "source": "example" }, "properties": { "description": { "example": "example", "type": "string" }, "fieldCount": { "example": 1, "format": "int32", "type": "integer" }, "id": { "example": "example", "type": "string" }, "kind": { "example": "example", "type": "string" }, "measureCount": { "example": 1, "format": "int32", "type": "integer" }, "source": { "example": "example", "type": "string" } }, "required": [ "id", "kind", "source", "description", "fieldCount", "measureCount" ], "type": "object" }, "SemanticExplainResponse": { "example": { "args": [ { "key": "example" } ], "columns": [ "example" ], "facts": [ "example" ], "mode": "example", "physicalDependencies": [ "example" ], "relationshipPaths": [ "example" ], "sql": "example", "stitchDimensions": [ "example" ], "warnings": [ "example" ] }, "properties": { "args": { "example": [ { "key": "example" } ], "items": { "additionalProperties": {}, "type": "object" }, "type": "array" }, "columns": { "example": [ "example" ], "items": { "type": "string" }, "type": "array" }, "facts": { "example": [ "example" ], "items": { "type": "string" }, "type": "array" }, "mode": { "example": "example", "type": "string" }, "physicalDependencies": { "example": [ "example" ], "items": { "type": "string" }, "type": "array" }, "relationshipPaths": { "example": [ "example" ], "items": { "type": "string" }, "type": "array" }, "sql": { "example": "example", "type": "string" }, "stitchDimensions": { "example": [ "example" ], "items": { "type": "string" }, "type": "array" }, "warnings": { "example": [ "example" ], "items": { "type": "string" }, "type": "array" } }, "required": [ "mode", "facts", "stitchDimensions", "physicalDependencies", "relationshipPaths", "sql", "args", "columns", "warnings" ], "type": "object" }, "SemanticFieldKind": { "enum": [ "dimension", "measure", "metric" ], "example": "dimension", "type": "string" }, "SemanticFieldListResponse": { "example": { "items": [ { "description": "example", "format": "example", "grain": "example", "grains": [ "example" ], "id": "example", "kind": "dimension", "label": "example", "name": "example", "table": "example", "time": "example", "type": "example", "unit": "example" } ], "page": { "nextCursor": "example" } }, "properties": { "items": { "example": [ { "description": "example", "format": "example", "grain": "example", "grains": [ "example" ], "id": "example", "kind": "dimension", "label": "example", "name": "example", "table": "example", "time": "example", "type": "example", "unit": "example" } ], "items": { "$ref": "#/components/schemas/SemanticFieldResponse" }, "type": "array" }, "page": { "$ref": "#/components/schemas/PageInfo" } }, "required": [ "items", "page" ], "type": "object" }, "SemanticFieldRef": { "example": { "alias": "example", "field": "example" }, "properties": { "alias": { "description": "Optional output column name.", "example": "example", "type": "string" }, "field": { "description": "Semantic field or measure ID. Use the ID returned by catalog_list or catalog_get.", "example": "example", "type": "string" } }, "required": [ "field" ], "type": "object" }, "SemanticFieldResponse": { "example": { "description": "example", "format": "example", "grain": "example", "grains": [ "example" ], "id": "example", "kind": "dimension", "label": "example", "name": "example", "table": "example", "time": "example", "type": "example", "unit": "example" }, "properties": { "description": { "example": "example", "type": "string" }, "format": { "example": "example", "type": "string" }, "grain": { "example": "example", "type": "string" }, "grains": { "example": [ "example" ], "items": { "type": "string" }, "type": "array" }, "id": { "example": "example", "type": "string" }, "kind": { "$ref": "#/components/schemas/SemanticFieldKind" }, "label": { "example": "example", "type": "string" }, "name": { "example": "example", "type": "string" }, "table": { "example": "example", "type": "string" }, "time": { "example": "example", "type": "string" }, "type": { "example": "example", "type": "string" }, "unit": { "example": "example", "type": "string" } }, "required": [ "id", "kind", "table", "name", "label" ], "type": "object" }, "SemanticFilter": { "example": { "fact": "example", "field": "example", "groups": [ { "filters": [] } ], "operator": "equals", "values": [ "example" ] }, "properties": { "fact": { "description": "Fact table used to resolve a conformed dimension when it is otherwise ambiguous.", "example": "example", "type": "string" }, "field": { "description": "Semantic field ID. Omit only when groups supplies nested filters.", "example": "example", "type": "string" }, "groups": { "description": "Nested filter groups.", "example": [ { "filters": [] } ], "items": { "$ref": "#/components/schemas/SemanticFilterGroup" }, "type": "array" }, "operator": { "$ref": "#/components/schemas/SemanticFilterOperator", "description": "Governed comparison operator. equals is used when omitted." }, "values": { "description": "Comparison values. is_null and is_not_null accept no values.", "example": [ "example" ], "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "SemanticFilterGroup": { "example": { "filters": [] }, "properties": { "filters": { "description": "Filters combined within this nested group.", "example": [ { "fact": "example", "field": "example", "groups": [ { "filters": [] } ], "operator": "equals", "values": [ "example" ] } ], "items": { "$ref": "#/components/schemas/SemanticFilter" }, "type": "array" } }, "required": [ "filters" ], "type": "object" }, "SemanticFilterOperator": { "enum": [ "equals", "in", "contains", "not_contains", "starts_with", "greater_than_or_equal", "less_than", "is_null", "is_not_null" ], "example": "equals", "type": "string" }, "SemanticModelCounts": { "example": { "atomic_measures": 1, "conformed_dimensions": 1, "facts": 1, "fields": 1, "metrics": 1, "model_tables": 1, "relationships": 1, "sources": 1 }, "properties": { "atomic_measures": { "example": 1, "format": "int32", "type": "integer" }, "conformed_dimensions": { "example": 1, "format": "int32", "type": "integer" }, "facts": { "example": 1, "format": "int32", "type": "integer" }, "fields": { "example": 1, "format": "int32", "type": "integer" }, "metrics": { "example": 1, "format": "int32", "type": "integer" }, "model_tables": { "example": 1, "format": "int32", "type": "integer" }, "relationships": { "example": 1, "format": "int32", "type": "integer" }, "sources": { "example": 1, "format": "int32", "type": "integer" } }, "required": [ "sources", "model_tables", "fields", "facts", "conformed_dimensions", "atomic_measures", "metrics", "relationships" ], "type": "object" }, "SemanticModelDescriptionResponse": { "example": { "counts": { "atomic_measures": 1, "conformed_dimensions": 1, "facts": 1, "fields": 1, "metrics": 1, "model_tables": 1, "relationships": 1, "sources": 1 }, "dashboards": [ { "id": "example", "pages": 1, "semantic_model": "example", "title": "example" } ], "description": "example", "id": "example", "tables": [ { "description": "example", "fields": 1, "id": "example", "roles": [ "example" ], "source": "example" } ], "title": "example" }, "properties": { "counts": { "$ref": "#/components/schemas/SemanticModelCounts" }, "dashboards": { "example": [ { "id": "example", "pages": 1, "semantic_model": "example", "title": "example" } ], "items": { "$ref": "#/components/schemas/ModelDashboardUsage" }, "type": "array" }, "description": { "example": "example", "type": "string" }, "id": { "example": "example", "type": "string" }, "tables": { "example": [ { "description": "example", "fields": 1, "id": "example", "roles": [ "example" ], "source": "example" } ], "items": { "$ref": "#/components/schemas/SemanticModelTableSummary" }, "type": "array" }, "title": { "example": "example", "type": "string" } }, "required": [ "id", "title", "description", "dashboards" ], "type": "object" }, "SemanticModelListResponse": { "example": { "items": [ { "description": "example", "id": "example", "title": "example" } ], "page": { "nextCursor": "example" } }, "properties": { "items": { "example": [ { "description": "example", "id": "example", "title": "example" } ], "items": { "$ref": "#/components/schemas/SemanticModelSummary" }, "type": "array" }, "page": { "$ref": "#/components/schemas/PageInfo" } }, "required": [ "items", "page" ], "type": "object" }, "SemanticModelSummary": { "example": { "description": "example", "id": "example", "title": "example" }, "properties": { "description": { "example": "example", "type": "string" }, "id": { "example": "example", "type": "string" }, "title": { "example": "example", "type": "string" } }, "required": [ "id", "title", "description" ], "type": "object" }, "SemanticModelTableSummary": { "example": { "description": "example", "fields": 1, "id": "example", "roles": [ "example" ], "source": "example" }, "properties": { "description": { "example": "example", "type": "string" }, "fields": { "example": 1, "format": "int32", "type": "integer" }, "id": { "example": "example", "type": "string" }, "roles": { "example": [ "example" ], "items": { "type": "string" }, "type": "array" }, "source": { "example": "example", "type": "string" } }, "required": [ "id", "roles", "source", "description", "fields" ], "type": "object" }, "SemanticPreviewRequest": { "example": { "dimensions": [ { "alias": "example", "field": "example" } ], "filters": [ { "fact": "example", "field": "example", "groups": [ { "filters": [] } ], "operator": "equals", "values": [ "example" ] } ], "limit": 1, "measures": [ { "alias": "example", "field": "example" } ], "pageToken": "example", "sort": [ { "direction": "asc", "field": "example" } ] }, "properties": { "dimensions": { "example": [ { "alias": "example", "field": "example" } ], "items": { "$ref": "#/components/schemas/SemanticFieldRef" }, "type": "array" }, "filters": { "example": [ { "fact": "example", "field": "example", "groups": [ { "filters": [] } ], "operator": "equals", "values": [ "example" ] } ], "items": { "$ref": "#/components/schemas/SemanticFilter" }, "type": "array" }, "limit": { "example": 1, "format": "int32", "maximum": 1000, "minimum": 1, "type": "integer" }, "measures": { "example": [ { "alias": "example", "field": "example" } ], "items": { "$ref": "#/components/schemas/SemanticFieldRef" }, "type": "array" }, "pageToken": { "example": "example", "maxLength": 2048, "minLength": 1, "type": "string" }, "sort": { "example": [ { "direction": "asc", "field": "example" } ], "items": { "$ref": "#/components/schemas/SemanticSort" }, "type": "array" } }, "type": "object" }, "SemanticQueryRequest": { "example": { "dimensions": [ { "alias": "example", "field": "example" } ], "filters": [ { "fact": "example", "field": "example", "groups": [ { "filters": [] } ], "operator": "equals", "values": [ "example" ] } ], "limit": 1, "measures": [ { "alias": "example", "field": "example" } ], "pageToken": "example", "sort": [ { "direction": "asc", "field": "example" } ], "time": { "alias": "example", "field": "example", "grain": "day" } }, "properties": { "dimensions": { "example": [ { "alias": "example", "field": "example" } ], "items": { "$ref": "#/components/schemas/SemanticFieldRef" }, "type": "array" }, "filters": { "example": [ { "fact": "example", "field": "example", "groups": [ { "filters": [] } ], "operator": "equals", "values": [ "example" ] } ], "items": { "$ref": "#/components/schemas/SemanticFilter" }, "type": "array" }, "limit": { "example": 1, "format": "int32", "maximum": 1000, "minimum": 1, "type": "integer" }, "measures": { "example": [ { "alias": "example", "field": "example" } ], "items": { "$ref": "#/components/schemas/SemanticFieldRef" }, "type": "array" }, "pageToken": { "example": "example", "maxLength": 2048, "minLength": 1, "type": "string" }, "sort": { "example": [ { "direction": "asc", "field": "example" } ], "items": { "$ref": "#/components/schemas/SemanticSort" }, "type": "array" }, "time": { "$ref": "#/components/schemas/SemanticTimeRef" } }, "type": "object" }, "SemanticQueryResponse": { "example": { "columns": [ { "fieldRef": { "id": "example", "type": "example", "workspaceId": "example" }, "format": "example", "kind": "example", "label": "example", "name": "example", "nullable": true, "type": "boolean", "unit": "example" } ], "completeness": { "hasMore": true, "returnedRows": 1 }, "freshness": { "lastSuccessfulRefreshAt": "2026-01-02T15:04:05Z", "servingStateId": "example", "snapshotId": "example", "source": "example", "status": "example" }, "page": { "nextCursor": "example" }, "queryId": "example", "rows": [ [ "example" ] ], "servingSnapshot": "example" }, "properties": { "columns": { "example": [ { "fieldRef": { "id": "example", "type": "example", "workspaceId": "example" }, "format": "example", "kind": "example", "label": "example", "name": "example", "nullable": true, "type": "boolean", "unit": "example" } ], "items": { "$ref": "#/components/schemas/QueryColumn" }, "type": "array" }, "completeness": { "$ref": "#/components/schemas/QueryCompleteness", "description": "Completeness of the exact row page returned." }, "freshness": { "$ref": "#/components/schemas/QueryFreshness", "description": "Last successful data-version metadata when the model has a recorded publish or refresh." }, "page": { "$ref": "#/components/schemas/PageInfo" }, "queryId": { "description": "Stable identifier for this query execution.", "example": "example", "type": "string" }, "rows": { "example": [ [ "example" ] ], "items": { "items": {}, "type": "array" }, "type": "array" }, "servingSnapshot": { "description": "Immutable serving state used by the query and its continuation cursor.", "example": "example", "type": "string" } }, "required": [ "queryId", "servingSnapshot", "completeness", "columns", "rows", "page" ], "type": "object" }, "SemanticRelationshipListResponse": { "example": { "items": [ { "active": true, "cardinality": "example", "fromDataset": "example", "fromField": "example", "id": "example", "toDataset": "example", "toField": "example" } ], "page": { "nextCursor": "example" } }, "properties": { "items": { "example": [ { "active": true, "cardinality": "example", "fromDataset": "example", "fromField": "example", "id": "example", "toDataset": "example", "toField": "example" } ], "items": { "$ref": "#/components/schemas/SemanticRelationshipResponse" }, "type": "array" }, "page": { "$ref": "#/components/schemas/PageInfo" } }, "required": [ "items", "page" ], "type": "object" }, "SemanticRelationshipResponse": { "example": { "active": true, "cardinality": "example", "fromDataset": "example", "fromField": "example", "id": "example", "toDataset": "example", "toField": "example" }, "properties": { "active": { "example": true, "type": "boolean" }, "cardinality": { "example": "example", "type": "string" }, "fromDataset": { "example": "example", "type": "string" }, "fromField": { "example": "example", "type": "string" }, "id": { "example": "example", "type": "string" }, "toDataset": { "example": "example", "type": "string" }, "toField": { "example": "example", "type": "string" } }, "required": [ "id", "fromDataset", "fromField", "toDataset", "toField", "cardinality", "active" ], "type": "object" }, "SemanticSort": { "example": { "direction": "asc", "field": "example" }, "properties": { "direction": { "$ref": "#/components/schemas/SemanticSortDirection", "description": "Sort direction. Defaults to ascending when omitted." }, "field": { "description": "Selected output field or alias to sort.", "example": "example", "type": "string" } }, "required": [ "field" ], "type": "object" }, "SemanticSortDirection": { "enum": [ "asc", "desc" ], "example": "asc", "type": "string" }, "SemanticSourceListResponse": { "example": { "items": [ { "connection": "example", "description": "example", "id": "example", "kind": "example", "path": "example", "table": "example" } ], "page": { "nextCursor": "example" } }, "properties": { "items": { "example": [ { "connection": "example", "description": "example", "id": "example", "kind": "example", "path": "example", "table": "example" } ], "items": { "$ref": "#/components/schemas/SemanticSourceResponse" }, "type": "array" }, "page": { "$ref": "#/components/schemas/PageInfo" } }, "required": [ "items", "page" ], "type": "object" }, "SemanticSourceResponse": { "example": { "connection": "example", "description": "example", "id": "example", "kind": "example", "path": "example", "table": "example" }, "properties": { "connection": { "example": "example", "type": "string" }, "description": { "example": "example", "type": "string" }, "id": { "example": "example", "type": "string" }, "kind": { "example": "example", "type": "string" }, "path": { "example": "example", "type": "string" }, "table": { "example": "example", "type": "string" } }, "required": [ "id", "kind" ], "type": "object" }, "SemanticTimeGrain": { "enum": [ "day", "week", "month", "quarter", "year" ], "example": "day", "type": "string" }, "SemanticTimeRef": { "example": { "alias": "example", "field": "example", "grain": "day" }, "properties": { "alias": { "description": "Optional output column name.", "example": "example", "type": "string" }, "field": { "description": "Date or timestamp field ID.", "example": "example", "type": "string" }, "grain": { "$ref": "#/components/schemas/SemanticTimeGrain", "description": "Calendar grain used to group the time field." } }, "required": [ "field" ], "type": "object" }, "ServicePrincipalCreateRequest": { "example": { "displayName": "example", "id": "example" }, "properties": { "displayName": { "example": "example", "type": "string" }, "id": { "example": "example", "type": "string" } }, "required": [ "displayName" ], "type": "object" }, "ServicePrincipalListResponse": { "example": { "items": [ { "createdAt": "2026-01-02T15:04:05Z", "displayName": "example", "email": "example", "id": "example", "kind": "example", "updatedAt": "2026-01-02T15:04:05Z" } ], "page": { "nextCursor": "example" } }, "properties": { "items": { "example": [ { "createdAt": "2026-01-02T15:04:05Z", "displayName": "example", "email": "example", "id": "example", "kind": "example", "updatedAt": "2026-01-02T15:04:05Z" } ], "items": { "$ref": "#/components/schemas/PrincipalResponse" }, "type": "array" }, "page": { "$ref": "#/components/schemas/PageInfo" } }, "required": [ "items", "page" ], "type": "object" }, "ServicePrincipalPatchRequest": { "example": { "displayName": "example" }, "properties": { "displayName": { "example": "example", "type": "string" } }, "type": "object" }, "ServicePrincipalSecretCreateRequest": { "example": { "expiresAt": "2026-01-02T15:04:05Z", "name": "example" }, "properties": { "expiresAt": { "example": "2026-01-02T15:04:05Z", "format": "date-time", "type": "string" }, "name": { "example": "example", "type": "string" } }, "required": [ "name" ], "type": "object" }, "ServicePrincipalSecretCreatedResponse": { "example": { "clientSecret": { "createdAt": "2026-01-02T15:04:05Z", "expiresAt": "2026-01-02T15:04:05Z", "id": "example", "name": "example", "revokedAt": "2026-01-02T15:04:05Z", "secret": "example", "servicePrincipalId": "example" }, "secret": "example" }, "properties": { "clientSecret": { "$ref": "#/components/schemas/ServicePrincipalSecretResponse" }, "secret": { "example": "example", "type": "string" } }, "required": [ "secret", "clientSecret" ], "type": "object" }, "ServicePrincipalSecretListResponse": { "example": { "items": [ { "createdAt": "2026-01-02T15:04:05Z", "expiresAt": "2026-01-02T15:04:05Z", "id": "example", "name": "example", "revokedAt": "2026-01-02T15:04:05Z", "secret": "example", "servicePrincipalId": "example" } ], "page": { "nextCursor": "example" } }, "properties": { "items": { "example": [ { "createdAt": "2026-01-02T15:04:05Z", "expiresAt": "2026-01-02T15:04:05Z", "id": "example", "name": "example", "revokedAt": "2026-01-02T15:04:05Z", "secret": "example", "servicePrincipalId": "example" } ], "items": { "$ref": "#/components/schemas/ServicePrincipalSecretResponse" }, "type": "array" }, "page": { "$ref": "#/components/schemas/PageInfo" } }, "required": [ "items", "page" ], "type": "object" }, "ServicePrincipalSecretResponse": { "example": { "createdAt": "2026-01-02T15:04:05Z", "expiresAt": "2026-01-02T15:04:05Z", "id": "example", "name": "example", "revokedAt": "2026-01-02T15:04:05Z", "secret": "example", "servicePrincipalId": "example" }, "properties": { "createdAt": { "example": "2026-01-02T15:04:05Z", "format": "date-time", "type": "string" }, "expiresAt": { "example": "2026-01-02T15:04:05Z", "format": "date-time", "type": "string" }, "id": { "example": "example", "type": "string" }, "name": { "example": "example", "type": "string" }, "revokedAt": { "example": "2026-01-02T15:04:05Z", "format": "date-time", "type": "string" }, "secret": { "example": "example", "type": "string" }, "servicePrincipalId": { "example": "example", "type": "string" } }, "required": [ "id", "servicePrincipalId", "name" ], "type": "object" }, "SessionListResponse": { "example": { "items": [ { "createdAt": "2026-01-02T15:04:05Z", "expiresAt": "2026-01-02T15:04:05Z", "id": "example", "lastSeenAt": "2026-01-02T15:04:05Z" } ], "page": { "nextCursor": "example" } }, "properties": { "items": { "example": [ { "createdAt": "2026-01-02T15:04:05Z", "expiresAt": "2026-01-02T15:04:05Z", "id": "example", "lastSeenAt": "2026-01-02T15:04:05Z" } ], "items": { "$ref": "#/components/schemas/SessionResponse" }, "type": "array" }, "page": { "$ref": "#/components/schemas/PageInfo" } }, "required": [ "items", "page" ], "type": "object" }, "SessionResponse": { "example": { "createdAt": "2026-01-02T15:04:05Z", "expiresAt": "2026-01-02T15:04:05Z", "id": "example", "lastSeenAt": "2026-01-02T15:04:05Z" }, "properties": { "createdAt": { "example": "2026-01-02T15:04:05Z", "format": "date-time", "type": "string" }, "expiresAt": { "example": "2026-01-02T15:04:05Z", "format": "date-time", "type": "string" }, "id": { "example": "example", "type": "string" }, "lastSeenAt": { "example": "2026-01-02T15:04:05Z", "format": "date-time", "type": "string" } }, "required": [ "id", "createdAt", "expiresAt" ], "type": "object" }, "SpatialWindowedVisualizationDataState": { "allOf": [ { "$ref": "#/components/schemas/VisualizationDataStateBase" } ], "example": { "cardinality": { "count": 1, "kind": "unknown" }, "extent": { "east": 1, "north": 1, "south": 1, "west": 1 }, "featureCap": 1, "kind": "example", "resetVersion": 1, "rowCap": 1, "schema": { "fields": [ { "dataType": "string", "geographic": { "geometryAsset": "example", "identifierSystem": "example", "joinField": "example", "unmatchedPolicy": "example" }, "grid": { "columnValue": "example", "formatting": [], "group": "example", "measure": "example" }, "id": "example", "label": "example", "nullable": true, "role": "dimension", "sourceRef": "example", "time": { "calendar": "example", "grain": "example", "meaning": "instant", "timezone": "example", "weekStart": "monday" } } ], "id": "example" }, "window": { "bounds": { "east": 1, "north": 1, "south": 1, "west": 1 }, "height": 1, "id": "example", "precision": "raw", "requestSeq": 1, "resetVersion": 1, "rows": [ [ "example" ] ], "width": 1, "zoom": 1 } }, "properties": { "cardinality": { "$ref": "#/components/schemas/VisualizationCardinality" }, "extent": { "$ref": "#/components/schemas/VisualizationSpatialBounds" }, "featureCap": { "example": 1, "format": "int64", "type": "integer" }, "kind": { "enum": [ "spatial_windowed" ], "example": "example", "type": "string" }, "resetVersion": { "example": 1, "format": "int64", "type": "integer" }, "rowCap": { "example": 1, "format": "int64", "type": "integer" }, "schema": { "$ref": "#/components/schemas/VisualizationDatasetSchema" }, "window": { "$ref": "#/components/schemas/VisualizationSpatialWindowBlock" } }, "required": [ "kind", "schema", "cardinality", "extent", "rowCap", "featureCap", "resetVersion" ], "type": "object" }, "StatusResponse": { "example": { "status": "example" }, "properties": { "status": { "example": "example", "type": "string" } }, "required": [ "status" ], "type": "object" }, "TableBackgroundScaleFormattingRule": { "allOf": [ { "$ref": "#/components/schemas/TableVisualizationFormattingRuleBase" } ], "example": { "highColor": "example", "kind": "example", "lowColor": "example", "maximum": 1, "minimum": 1 }, "properties": { "highColor": { "example": "example", "type": "string" }, "kind": { "enum": [ "background_scale" ], "example": "example", "type": "string" }, "lowColor": { "example": "example", "type": "string" }, "maximum": { "example": 1, "format": "double", "type": "number" }, "minimum": { "example": 1, "format": "double", "type": "number" } }, "required": [ "kind" ], "type": "object" }, "TableBadgeFormattingRule": { "allOf": [ { "$ref": "#/components/schemas/TableVisualizationFormattingRuleBase" } ], "example": { "kind": "example", "values": { "key": "example" } }, "properties": { "kind": { "enum": [ "badge" ], "example": "example", "type": "string" }, "values": { "additionalProperties": { "type": "string" }, "example": { "key": "example" }, "type": "object" } }, "required": [ "kind", "values" ], "type": "object" }, "TableDataBarFormattingRule": { "allOf": [ { "$ref": "#/components/schemas/TableVisualizationFormattingRuleBase" } ], "example": { "background": "example", "color": "example", "kind": "example", "maximum": 1, "minimum": 1 }, "properties": { "background": { "example": "example", "type": "string" }, "color": { "example": "example", "type": "string" }, "kind": { "enum": [ "data_bar" ], "example": "example", "type": "string" }, "maximum": { "example": 1, "format": "double", "type": "number" }, "minimum": { "example": 1, "format": "double", "type": "number" } }, "required": [ "kind", "color" ], "type": "object" }, "TableTextColorFormattingRule": { "allOf": [ { "$ref": "#/components/schemas/TableVisualizationFormattingRuleBase" } ], "example": { "color": "example", "kind": "example", "maximum": 1, "minimum": 1, "values": { "key": "example" } }, "properties": { "color": { "example": "example", "type": "string" }, "kind": { "enum": [ "text_color" ], "example": "example", "type": "string" }, "maximum": { "example": 1, "format": "double", "type": "number" }, "minimum": { "example": 1, "format": "double", "type": "number" }, "values": { "additionalProperties": { "type": "string" }, "example": { "key": "example" }, "type": "object" } }, "required": [ "kind", "color" ], "type": "object" }, "TableVisualizationColumn": { "example": { "columnValue": "example", "field": { "dataset": "example", "field": "example" }, "formatting": [], "group": "example", "label": "example", "measure": "example", "width": 1 }, "properties": { "columnValue": { "example": "example", "type": "string" }, "field": { "$ref": "#/components/schemas/VisualizationFieldRef" }, "formatting": { "example": [], "items": { "$ref": "#/components/schemas/TableVisualizationFormattingRule" }, "type": "array" }, "group": { "example": "example", "type": "string" }, "label": { "example": "example", "type": "string" }, "measure": { "example": "example", "type": "string" }, "width": { "example": 1, "format": "int64", "type": "integer" } }, "required": [ "field", "label", "formatting" ], "type": "object" }, "TableVisualizationFormattingRule": { "discriminator": { "mapping": { "background_scale": "#/components/schemas/TableBackgroundScaleFormattingRule", "badge": "#/components/schemas/TableBadgeFormattingRule", "data_bar": "#/components/schemas/TableDataBarFormattingRule", "text_color": "#/components/schemas/TableTextColorFormattingRule" }, "propertyName": "kind" }, "oneOf": [ { "$ref": "#/components/schemas/TableBadgeFormattingRule" }, { "$ref": "#/components/schemas/TableTextColorFormattingRule" }, { "$ref": "#/components/schemas/TableBackgroundScaleFormattingRule" }, { "$ref": "#/components/schemas/TableDataBarFormattingRule" } ] }, "TableVisualizationFormattingRuleBase": { "example": { "kind": "example" }, "properties": { "kind": { "example": "example", "type": "string" } }, "required": [ "kind" ], "type": "object" }, "TableVisualizationSpec": { "allOf": [ { "$ref": "#/components/schemas/VisualizationSpecBase" } ], "example": { "columns": [ { "columnValue": "example", "field": { "dataset": "example", "field": "example" }, "formatting": [], "group": "example", "label": "example", "measure": "example", "width": 1 } ], "defaultSort": [ { "direction": "ascending", "field": { "dataset": "example", "field": "example" } } ], "kind": "example", "presentation": { "rowHeight": 1, "showHeader": true, "striped": true } }, "properties": { "columns": { "example": [ { "columnValue": "example", "field": { "dataset": "example", "field": "example" }, "formatting": [], "group": "example", "label": "example", "measure": "example", "width": 1 } ], "items": { "$ref": "#/components/schemas/TableVisualizationColumn" }, "type": "array" }, "defaultSort": { "example": [ { "direction": "ascending", "field": { "dataset": "example", "field": "example" } } ], "items": { "$ref": "#/components/schemas/VisualizationSort" }, "type": "array" }, "kind": { "enum": [ "table" ], "example": "example", "type": "string" }, "presentation": { "$ref": "#/components/schemas/GridVisualizationPresentation" } }, "required": [ "kind", "columns", "presentation" ], "type": "object" }, "TemporalVisualizationFormat": { "allOf": [ { "$ref": "#/components/schemas/VisualizationFormatBase" } ], "example": { "dateStyle": "example", "kind": "example", "timeStyle": "example" }, "properties": { "dateStyle": { "example": "example", "type": "string" }, "kind": { "enum": [ "temporal" ], "example": "example", "type": "string" }, "timeStyle": { "example": "example", "type": "string" } }, "required": [ "kind" ], "type": "object" }, "UploadProtocol": { "enum": [ "tus", "s3_multipart" ], "example": "tus", "type": "string" }, "VisualizationAccessibility": { "example": { "announceChanges": true, "description": "example", "summary": "example", "title": "example" }, "properties": { "announceChanges": { "example": true, "type": "boolean" }, "description": { "example": "example", "type": "string" }, "summary": { "example": "example", "type": "string" }, "title": { "example": "example", "type": "string" } }, "required": [ "title", "description" ], "type": "object" }, "VisualizationAxis": { "enum": [ "primary", "secondary" ], "example": "primary", "type": "string" }, "VisualizationCapabilities": { "example": { "renderers": [ { "id": "echarts", "kinds": [ "cartesian" ], "schemaVersion": 1, "version": "example" } ], "schemaVersion": 1 }, "properties": { "renderers": { "example": [ { "id": "echarts", "kinds": [ "cartesian" ], "schemaVersion": 1, "version": "example" } ], "items": { "$ref": "#/components/schemas/VisualizationRendererCapability" }, "type": "array" }, "schemaVersion": { "example": 1, "type": "integer" } }, "required": [ "schemaVersion", "renderers" ], "type": "object" }, "VisualizationCardinality": { "example": { "count": 1, "kind": "unknown" }, "properties": { "count": { "example": 1, "format": "int64", "type": "integer" }, "kind": { "$ref": "#/components/schemas/VisualizationCardinalityKind" } }, "required": [ "kind" ], "type": "object" }, "VisualizationCardinalityKind": { "enum": [ "unknown", "lower_bound", "estimated", "exact" ], "example": "unknown", "type": "string" }, "VisualizationCartesianMark": { "enum": [ "line", "area", "bar", "column", "scatter", "histogram", "combo", "waterfall", "candlestick", "boxplot", "heatmap" ], "example": "line", "type": "string" }, "VisualizationChoroplethLayer": { "allOf": [ { "$ref": "#/components/schemas/VisualizationGeographicLayerBase" } ], "example": { "category": { "dataset": "example", "field": "example" }, "color": { "domainMaximum": 1, "domainMidpoint": 1, "domainMinimum": 1, "kind": "sequential", "nullColor": "example", "palette": "example", "reverse": true }, "geometry": { "attribution": "example", "digest": "example", "id": "example", "identifierSystem": "example", "license": "example", "source": "example", "url": "example" }, "join": { "dataset": "example", "field": "example" }, "kind": "example", "opacity": 1, "stroke": { "color": "example", "opacity": 1, "width": 1 }, "value": { "dataset": "example", "field": "example" } }, "properties": { "category": { "$ref": "#/components/schemas/VisualizationFieldRef" }, "color": { "$ref": "#/components/schemas/VisualizationMapColorScale" }, "geometry": { "$ref": "#/components/schemas/VisualizationGeometryAsset" }, "join": { "$ref": "#/components/schemas/VisualizationFieldRef" }, "kind": { "enum": [ "choropleth" ], "example": "example", "type": "string" }, "opacity": { "example": 1, "format": "double", "type": "number" }, "stroke": { "$ref": "#/components/schemas/VisualizationMapStroke" }, "value": { "$ref": "#/components/schemas/VisualizationFieldRef" } }, "required": [ "kind", "geometry", "join", "color", "stroke", "opacity" ], "type": "object" }, "VisualizationComboSeries": { "example": { "axis": "primary", "mark": "line", "seriesValue": "example" }, "properties": { "axis": { "$ref": "#/components/schemas/VisualizationAxis" }, "mark": { "$ref": "#/components/schemas/VisualizationCartesianMark" }, "seriesValue": { "example": "example", "type": "string" } }, "required": [ "seriesValue", "mark", "axis" ], "type": "object" }, "VisualizationCompleteness": { "enum": [ "complete", "truncated", "partial", "empty" ], "example": "complete", "type": "string" }, "VisualizationCustomEngine": { "enum": [ "vega_lite" ], "example": "vega_lite", "type": "string" }, "VisualizationDataBudget": { "example": { "maxRows": 1, "requiredCompleteness": "complete" }, "properties": { "maxRows": { "example": 1, "format": "int64", "type": "integer" }, "requiredCompleteness": { "$ref": "#/components/schemas/VisualizationCompleteness" } }, "required": [ "maxRows", "requiredCompleteness" ], "type": "object" }, "VisualizationDataState": { "discriminator": { "mapping": { "inline": "#/components/schemas/InlineVisualizationDataState", "spatial_windowed": "#/components/schemas/SpatialWindowedVisualizationDataState", "windowed": "#/components/schemas/WindowedVisualizationDataState" }, "propertyName": "kind" }, "oneOf": [ { "$ref": "#/components/schemas/InlineVisualizationDataState" }, { "$ref": "#/components/schemas/WindowedVisualizationDataState" }, { "$ref": "#/components/schemas/SpatialWindowedVisualizationDataState" } ] }, "VisualizationDataStateBase": { "example": { "dataRevision": 1, "generation": 1, "kind": "example", "specRevision": "example" }, "properties": { "dataRevision": { "example": 1, "format": "int64", "type": "integer" }, "generation": { "example": 1, "format": "int64", "type": "integer" }, "kind": { "example": "example", "type": "string" }, "specRevision": { "example": "example", "type": "string" } }, "required": [ "kind", "specRevision", "dataRevision", "generation" ], "type": "object" }, "VisualizationDataType": { "enum": [ "string", "boolean", "integer", "decimal", "temporal", "date", "geographic" ], "example": "string", "type": "string" }, "VisualizationDatasetSchema": { "example": { "fields": [ { "dataType": "string", "geographic": { "geometryAsset": "example", "identifierSystem": "example", "joinField": "example", "unmatchedPolicy": "example" }, "grid": { "columnValue": "example", "formatting": [], "group": "example", "measure": "example" }, "id": "example", "label": "example", "nullable": true, "role": "dimension", "sourceRef": "example", "time": { "calendar": "example", "grain": "example", "meaning": "instant", "timezone": "example", "weekStart": "monday" } } ], "id": "example" }, "properties": { "fields": { "example": [ { "dataType": "string", "geographic": { "geometryAsset": "example", "identifierSystem": "example", "joinField": "example", "unmatchedPolicy": "example" }, "grid": { "columnValue": "example", "formatting": [], "group": "example", "measure": "example" }, "id": "example", "label": "example", "nullable": true, "role": "dimension", "sourceRef": "example", "time": { "calendar": "example", "grain": "example", "meaning": "instant", "timezone": "example", "weekStart": "monday" } } ], "items": { "$ref": "#/components/schemas/VisualizationField" }, "type": "array" }, "id": { "example": "example", "type": "string" } }, "required": [ "id", "fields" ], "type": "object" }, "VisualizationDatumRef": { "example": { "blockID": "example", "dataRevision": 1, "dataset": "example", "identity": { "key": "example" }, "resetVersion": 1 }, "properties": { "blockID": { "example": "example", "type": "string" }, "dataRevision": { "example": 1, "format": "int64", "type": "integer" }, "dataset": { "example": "example", "type": "string" }, "identity": { "additionalProperties": {}, "example": { "key": "example" }, "type": "object" }, "resetVersion": { "example": 1, "format": "int64", "type": "integer" } }, "required": [ "dataset", "dataRevision", "identity" ], "type": "object" }, "VisualizationDensityLayer": { "allOf": [ { "$ref": "#/components/schemas/VisualizationGeographicLayerBase" } ], "example": { "color": { "domainMaximum": 1, "domainMidpoint": 1, "domainMinimum": 1, "kind": "sequential", "nullColor": "example", "palette": "example", "reverse": true }, "heat": { "intensity": 1, "radius": 1 }, "kind": "example", "latitude": { "dataset": "example", "field": "example" }, "longitude": { "dataset": "example", "field": "example" }, "opacity": 1, "value": { "dataset": "example", "field": "example" } }, "properties": { "color": { "$ref": "#/components/schemas/VisualizationMapColorScale" }, "heat": { "$ref": "#/components/schemas/VisualizationMapHeatStyle" }, "kind": { "enum": [ "density" ], "example": "example", "type": "string" }, "latitude": { "$ref": "#/components/schemas/VisualizationFieldRef" }, "longitude": { "$ref": "#/components/schemas/VisualizationFieldRef" }, "opacity": { "example": 1, "format": "double", "type": "number" }, "value": { "$ref": "#/components/schemas/VisualizationFieldRef" } }, "required": [ "kind", "latitude", "longitude", "color", "heat", "opacity" ], "type": "object" }, "VisualizationDiagnostic": { "example": { "code": "example", "fieldID": "example", "message": "example", "severity": "info" }, "properties": { "code": { "example": "example", "type": "string" }, "fieldID": { "example": "example", "type": "string" }, "message": { "example": "example", "type": "string" }, "severity": { "$ref": "#/components/schemas/VisualizationDiagnosticSeverity" } }, "required": [ "code", "severity", "message" ], "type": "object" }, "VisualizationDiagnosticSeverity": { "enum": [ "info", "warning", "error" ], "example": "info", "type": "string" }, "VisualizationEnvelope": { "example": { "dataRevision": 1, "diagnostics": [ { "code": "example", "fieldID": "example", "message": "example", "severity": "info" } ], "rendererID": "example", "schemaVersion": 1, "selection": [ { "datum": { "blockID": "example", "dataRevision": 1, "dataset": "example", "identity": { "key": "example" }, "resetVersion": 1 }, "label": "example" } ], "spatialSelection": { "interactionID": "example", "visualID": "example" }, "specRevision": "example", "status": { "kind": "idle", "message": "example" }, "visualID": "example" }, "properties": { "dataRevision": { "example": 1, "format": "int64", "type": "integer" }, "dataState": { "$ref": "#/components/schemas/VisualizationDataState" }, "diagnostics": { "example": [ { "code": "example", "fieldID": "example", "message": "example", "severity": "info" } ], "items": { "$ref": "#/components/schemas/VisualizationDiagnostic" }, "type": "array" }, "rendererID": { "example": "example", "type": "string" }, "schemaVersion": { "example": 1, "type": "integer" }, "selection": { "example": [ { "datum": { "blockID": "example", "dataRevision": 1, "dataset": "example", "identity": { "key": "example" }, "resetVersion": 1 }, "label": "example" } ], "items": { "$ref": "#/components/schemas/VisualizationSelectionEntry" }, "type": "array" }, "spatialSelection": { "$ref": "#/components/schemas/VisualizationSpatialSelectionState" }, "spec": { "$ref": "#/components/schemas/VisualizationSpec" }, "specRevision": { "example": "example", "type": "string" }, "status": { "$ref": "#/components/schemas/VisualizationStatus" }, "visualID": { "example": "example", "type": "string" } }, "required": [ "schemaVersion", "visualID", "rendererID", "specRevision", "spec", "dataRevision", "dataState", "selection", "status", "diagnostics" ], "type": "object" }, "VisualizationField": { "example": { "dataType": "string", "geographic": { "geometryAsset": "example", "identifierSystem": "example", "joinField": "example", "unmatchedPolicy": "example" }, "grid": { "columnValue": "example", "formatting": [], "group": "example", "measure": "example" }, "id": "example", "label": "example", "nullable": true, "role": "dimension", "sourceRef": "example", "time": { "calendar": "example", "grain": "example", "meaning": "instant", "timezone": "example", "weekStart": "monday" } }, "properties": { "dataType": { "$ref": "#/components/schemas/VisualizationDataType" }, "format": { "$ref": "#/components/schemas/VisualizationFormat" }, "geographic": { "$ref": "#/components/schemas/VisualizationGeographicMetadata" }, "grid": { "$ref": "#/components/schemas/VisualizationGridFieldMetadata" }, "id": { "example": "example", "type": "string" }, "label": { "example": "example", "type": "string" }, "nullable": { "example": true, "type": "boolean" }, "role": { "$ref": "#/components/schemas/VisualizationFieldRole" }, "sourceRef": { "example": "example", "type": "string" }, "time": { "$ref": "#/components/schemas/VisualizationTemporalMetadata" } }, "required": [ "id", "role", "dataType", "nullable", "label" ], "type": "object" }, "VisualizationFieldRef": { "example": { "dataset": "example", "field": "example" }, "properties": { "dataset": { "example": "example", "type": "string" }, "field": { "example": "example", "type": "string" } }, "required": [ "dataset", "field" ], "type": "object" }, "VisualizationFieldRole": { "enum": [ "dimension", "measure", "metadata", "identity" ], "example": "dimension", "type": "string" }, "VisualizationFormat": { "discriminator": { "mapping": { "compact": "#/components/schemas/CompactVisualizationFormat", "currency": "#/components/schemas/CurrencyVisualizationFormat", "duration": "#/components/schemas/DurationVisualizationFormat", "number": "#/components/schemas/NumberVisualizationFormat", "percent": "#/components/schemas/PercentVisualizationFormat", "temporal": "#/components/schemas/TemporalVisualizationFormat" }, "propertyName": "kind" }, "oneOf": [ { "$ref": "#/components/schemas/NumberVisualizationFormat" }, { "$ref": "#/components/schemas/CurrencyVisualizationFormat" }, { "$ref": "#/components/schemas/PercentVisualizationFormat" }, { "$ref": "#/components/schemas/CompactVisualizationFormat" }, { "$ref": "#/components/schemas/DurationVisualizationFormat" }, { "$ref": "#/components/schemas/TemporalVisualizationFormat" } ] }, "VisualizationFormatBase": { "example": { "kind": "example" }, "properties": { "kind": { "example": "example", "type": "string" } }, "required": [ "kind" ], "type": "object" }, "VisualizationGeographicLayer": { "discriminator": { "mapping": { "choropleth": "#/components/schemas/VisualizationChoroplethLayer", "density": "#/components/schemas/VisualizationDensityLayer", "heat": "#/components/schemas/VisualizationHeatLayer", "path": "#/components/schemas/VisualizationPathLayer", "point": "#/components/schemas/VisualizationPointLayer", "reference": "#/components/schemas/VisualizationReferenceLayer" }, "propertyName": "kind" }, "oneOf": [ { "$ref": "#/components/schemas/VisualizationPointLayer" }, { "$ref": "#/components/schemas/VisualizationChoroplethLayer" }, { "$ref": "#/components/schemas/VisualizationHeatLayer" }, { "$ref": "#/components/schemas/VisualizationDensityLayer" }, { "$ref": "#/components/schemas/VisualizationReferenceLayer" }, { "$ref": "#/components/schemas/VisualizationPathLayer" } ] }, "VisualizationGeographicLayerBase": { "example": { "id": "example", "kind": "example", "label": { "dataset": "example", "field": "example" }, "position": "below_labels", "tooltip": [ { "dataset": "example", "field": "example" } ], "visibility": { "maximumZoom": 1, "minimumZoom": 1 } }, "properties": { "id": { "example": "example", "type": "string" }, "kind": { "example": "example", "type": "string" }, "label": { "$ref": "#/components/schemas/VisualizationFieldRef" }, "position": { "$ref": "#/components/schemas/VisualizationMapLayerPosition" }, "tooltip": { "example": [ { "dataset": "example", "field": "example" } ], "items": { "$ref": "#/components/schemas/VisualizationFieldRef" }, "type": "array" }, "visibility": { "$ref": "#/components/schemas/VisualizationMapVisibility" } }, "required": [ "id", "kind", "tooltip", "position", "visibility" ], "type": "object" }, "VisualizationGeographicMetadata": { "example": { "geometryAsset": "example", "identifierSystem": "example", "joinField": "example", "unmatchedPolicy": "example" }, "properties": { "geometryAsset": { "example": "example", "type": "string" }, "identifierSystem": { "example": "example", "type": "string" }, "joinField": { "example": "example", "type": "string" }, "unmatchedPolicy": { "example": "example", "type": "string" } }, "required": [ "identifierSystem", "geometryAsset", "joinField", "unmatchedPolicy" ], "type": "object" }, "VisualizationGeometryAsset": { "example": { "attribution": "example", "digest": "example", "id": "example", "identifierSystem": "example", "license": "example", "source": "example", "url": "example" }, "properties": { "attribution": { "example": "example", "type": "string" }, "digest": { "example": "example", "type": "string" }, "id": { "example": "example", "type": "string" }, "identifierSystem": { "example": "example", "type": "string" }, "license": { "example": "example", "type": "string" }, "source": { "example": "example", "type": "string" }, "url": { "example": "example", "type": "string" } }, "required": [ "id", "digest", "source", "license", "attribution", "identifierSystem", "url" ], "type": "object" }, "VisualizationGraphFocus": { "enum": [ "none", "adjacency" ], "example": "none", "type": "string" }, "VisualizationGridFieldMetadata": { "example": { "columnValue": "example", "formatting": [], "group": "example", "measure": "example" }, "properties": { "columnValue": { "example": "example", "type": "string" }, "formatting": { "example": [], "items": { "$ref": "#/components/schemas/TableVisualizationFormattingRule" }, "type": "array" }, "group": { "example": "example", "type": "string" }, "measure": { "example": "example", "type": "string" } }, "required": [ "formatting" ], "type": "object" }, "VisualizationHeatLayer": { "allOf": [ { "$ref": "#/components/schemas/VisualizationGeographicLayerBase" } ], "example": { "color": { "domainMaximum": 1, "domainMidpoint": 1, "domainMinimum": 1, "kind": "sequential", "nullColor": "example", "palette": "example", "reverse": true }, "heat": { "intensity": 1, "radius": 1 }, "kind": "example", "latitude": { "dataset": "example", "field": "example" }, "longitude": { "dataset": "example", "field": "example" }, "opacity": 1, "value": { "dataset": "example", "field": "example" } }, "properties": { "color": { "$ref": "#/components/schemas/VisualizationMapColorScale" }, "heat": { "$ref": "#/components/schemas/VisualizationMapHeatStyle" }, "kind": { "enum": [ "heat" ], "example": "example", "type": "string" }, "latitude": { "$ref": "#/components/schemas/VisualizationFieldRef" }, "longitude": { "$ref": "#/components/schemas/VisualizationFieldRef" }, "opacity": { "example": 1, "format": "double", "type": "number" }, "value": { "$ref": "#/components/schemas/VisualizationFieldRef" } }, "required": [ "kind", "latitude", "longitude", "color", "heat", "opacity" ], "type": "object" }, "VisualizationHierarchyLayout": { "enum": [ "standard", "circular" ], "example": "standard", "type": "string" }, "VisualizationHierarchyMark": { "enum": [ "treemap", "sunburst", "tree", "sankey", "graph" ], "example": "treemap", "type": "string" }, "VisualizationInlineDataset": { "example": { "columns": [ "example" ], "completeness": "complete", "dataRevision": 1, "generation": 1, "id": "example", "rows": [ [ "example" ] ], "specRevision": "example" }, "properties": { "columns": { "example": [ "example" ], "items": { "type": "string" }, "type": "array" }, "completeness": { "$ref": "#/components/schemas/VisualizationCompleteness" }, "dataRevision": { "example": 1, "format": "int64", "type": "integer" }, "generation": { "example": 1, "format": "int64", "type": "integer" }, "id": { "example": "example", "type": "string" }, "rows": { "example": [ [ "example" ] ], "items": { "items": {}, "type": "array" }, "type": "array" }, "specRevision": { "example": "example", "type": "string" } }, "required": [ "id", "specRevision", "dataRevision", "generation", "columns", "rows", "completeness" ], "type": "object" }, "VisualizationInteraction": { "example": { "id": "example", "kind": "select", "mappings": [ { "grain": "example", "label": { "dataset": "example", "field": "example" }, "source": { "dataset": "example", "field": "example" }, "targetFactID": "example", "targetFieldID": "example" } ], "mode": "single", "requiresStableIdentity": true, "targets": [ "example" ] }, "properties": { "id": { "example": "example", "type": "string" }, "kind": { "$ref": "#/components/schemas/VisualizationInteractionKind" }, "mappings": { "example": [ { "grain": "example", "label": { "dataset": "example", "field": "example" }, "source": { "dataset": "example", "field": "example" }, "targetFactID": "example", "targetFieldID": "example" } ], "items": { "$ref": "#/components/schemas/VisualizationInteractionMapping" }, "type": "array" }, "mode": { "$ref": "#/components/schemas/VisualizationSelectionMode" }, "requiresStableIdentity": { "example": true, "type": "boolean" }, "targets": { "example": [ "example" ], "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "kind", "mappings", "targets", "mode", "requiresStableIdentity" ], "type": "object" }, "VisualizationInteractionKind": { "enum": [ "select", "filter", "drill", "navigate" ], "example": "select", "type": "string" }, "VisualizationInteractionMapping": { "example": { "grain": "example", "label": { "dataset": "example", "field": "example" }, "source": { "dataset": "example", "field": "example" }, "targetFactID": "example", "targetFieldID": "example" }, "properties": { "grain": { "example": "example", "type": "string" }, "label": { "$ref": "#/components/schemas/VisualizationFieldRef" }, "source": { "$ref": "#/components/schemas/VisualizationFieldRef" }, "targetFactID": { "example": "example", "type": "string" }, "targetFieldID": { "example": "example", "type": "string" } }, "required": [ "source", "targetFieldID" ], "type": "object" }, "VisualizationKPITrend": { "enum": [ "neutral", "positive", "negative" ], "example": "neutral", "type": "string" }, "VisualizationLabelPosition": { "enum": [ "automatic", "inside", "outside", "top" ], "example": "automatic", "type": "string" }, "VisualizationLegendPosition": { "enum": [ "hidden", "top", "right", "bottom", "left" ], "example": "hidden", "type": "string" }, "VisualizationMapCamera": { "example": { "center": [ 1 ], "maximumZoom": 1, "minimumZoom": 1, "mode": "fit_data", "padding": 1, "zoom": 1 }, "properties": { "center": { "example": [ 1 ], "items": { "format": "double", "type": "number" }, "type": "array" }, "maximumZoom": { "example": 1, "format": "double", "type": "number" }, "minimumZoom": { "example": 1, "format": "double", "type": "number" }, "mode": { "$ref": "#/components/schemas/VisualizationMapCameraMode" }, "padding": { "example": 1, "format": "int32", "type": "integer" }, "zoom": { "example": 1, "format": "double", "type": "number" } }, "required": [ "mode", "padding", "minimumZoom", "maximumZoom" ], "type": "object" }, "VisualizationMapCameraMode": { "enum": [ "fit_data", "fixed", "preserve" ], "example": "fit_data", "type": "string" }, "VisualizationMapCluster": { "example": { "enabled": true, "maximumZoom": 1, "minimumPoints": 1, "radius": 1, "showCount": true }, "properties": { "enabled": { "example": true, "type": "boolean" }, "maximumZoom": { "example": 1, "format": "int32", "type": "integer" }, "minimumPoints": { "example": 1, "format": "int32", "type": "integer" }, "radius": { "example": 1, "format": "int32", "type": "integer" }, "showCount": { "example": true, "type": "boolean" } }, "required": [ "enabled", "radius", "maximumZoom", "minimumPoints", "showCount" ], "type": "object" }, "VisualizationMapColorScale": { "example": { "domainMaximum": 1, "domainMidpoint": 1, "domainMinimum": 1, "kind": "sequential", "nullColor": "example", "palette": "example", "reverse": true }, "properties": { "domainMaximum": { "example": 1, "format": "double", "type": "number" }, "domainMidpoint": { "example": 1, "format": "double", "type": "number" }, "domainMinimum": { "example": 1, "format": "double", "type": "number" }, "kind": { "$ref": "#/components/schemas/VisualizationMapColorScaleKind" }, "nullColor": { "example": "example", "type": "string" }, "palette": { "example": "example", "type": "string" }, "reverse": { "example": true, "type": "boolean" } }, "required": [ "kind", "palette", "reverse", "nullColor" ], "type": "object" }, "VisualizationMapColorScaleKind": { "enum": [ "sequential", "diverging", "categorical" ], "example": "sequential", "type": "string" }, "VisualizationMapControls": { "example": { "compass": true, "reset": true, "zoom": true }, "properties": { "compass": { "example": true, "type": "boolean" }, "reset": { "example": true, "type": "boolean" }, "zoom": { "example": true, "type": "boolean" } }, "required": [ "zoom", "reset", "compass" ], "type": "object" }, "VisualizationMapHeatStyle": { "example": { "intensity": 1, "radius": 1 }, "properties": { "intensity": { "example": 1, "format": "double", "type": "number" }, "radius": { "example": 1, "format": "double", "type": "number" } }, "required": [ "radius", "intensity" ], "type": "object" }, "VisualizationMapLabelDensity": { "enum": [ "hidden", "normal", "dense" ], "example": "hidden", "type": "string" }, "VisualizationMapLayerPosition": { "enum": [ "below_labels", "above_labels" ], "example": "below_labels", "type": "string" }, "VisualizationMapLineStyle": { "example": { "curvature": 1, "width": 1 }, "properties": { "curvature": { "example": 1, "format": "double", "type": "number" }, "width": { "example": 1, "format": "double", "type": "number" } }, "required": [ "width", "curvature" ], "type": "object" }, "VisualizationMapSizeScale": { "example": { "domainMaximum": 1, "domainMinimum": 1, "maximumRadius": 1, "minimumRadius": 1 }, "properties": { "domainMaximum": { "example": 1, "format": "double", "type": "number" }, "domainMinimum": { "example": 1, "format": "double", "type": "number" }, "maximumRadius": { "example": 1, "format": "double", "type": "number" }, "minimumRadius": { "example": 1, "format": "double", "type": "number" } }, "required": [ "minimumRadius", "maximumRadius" ], "type": "object" }, "VisualizationMapStroke": { "example": { "color": "example", "opacity": 1, "width": 1 }, "properties": { "color": { "example": "example", "type": "string" }, "opacity": { "example": 1, "format": "double", "type": "number" }, "width": { "example": 1, "format": "double", "type": "number" } }, "required": [ "color", "width", "opacity" ], "type": "object" }, "VisualizationMapStyleAsset": { "example": { "archiveDigest": "example", "archiveUrl": "example", "attribution": "example", "bounds": [ 1 ], "glyphsUrl": "example", "id": "example", "labelAnchor": "example", "license": "example", "maximumZoom": 1, "minimumZoom": 1, "source": "example", "spriteUrl": "example", "styleDigest": "example", "styleUrl": "example" }, "properties": { "archiveDigest": { "example": "example", "type": "string" }, "archiveUrl": { "example": "example", "type": "string" }, "attribution": { "example": "example", "type": "string" }, "bounds": { "example": [ 1 ], "items": { "format": "double", "type": "number" }, "type": "array" }, "glyphsUrl": { "example": "example", "type": "string" }, "id": { "example": "example", "type": "string" }, "labelAnchor": { "example": "example", "type": "string" }, "license": { "example": "example", "type": "string" }, "maximumZoom": { "example": 1, "format": "double", "type": "number" }, "minimumZoom": { "example": 1, "format": "double", "type": "number" }, "source": { "example": "example", "type": "string" }, "spriteUrl": { "example": "example", "type": "string" }, "styleDigest": { "example": "example", "type": "string" }, "styleUrl": { "example": "example", "type": "string" } }, "required": [ "id", "styleUrl", "styleDigest", "archiveUrl", "archiveDigest", "glyphsUrl", "spriteUrl", "source", "license", "attribution", "minimumZoom", "maximumZoom", "bounds", "labelAnchor" ], "type": "object" }, "VisualizationMapTheme": { "enum": [ "auto", "light", "dark" ], "example": "auto", "type": "string" }, "VisualizationMapVisibility": { "example": { "maximumZoom": 1, "minimumZoom": 1 }, "properties": { "maximumZoom": { "example": 1, "format": "double", "type": "number" }, "minimumZoom": { "example": 1, "format": "double", "type": "number" } }, "required": [ "minimumZoom", "maximumZoom" ], "type": "object" }, "VisualizationOrientation": { "enum": [ "horizontal", "vertical" ], "example": "horizontal", "type": "string" }, "VisualizationPathLayer": { "allOf": [ { "$ref": "#/components/schemas/VisualizationGeographicLayerBase" } ], "example": { "category": { "dataset": "example", "field": "example" }, "color": { "domainMaximum": 1, "domainMidpoint": 1, "domainMinimum": 1, "kind": "sequential", "nullColor": "example", "palette": "example", "reverse": true }, "kind": "example", "latitude": { "dataset": "example", "field": "example" }, "line": { "curvature": 1, "width": 1 }, "longitude": { "dataset": "example", "field": "example" }, "opacity": 1, "order": { "dataset": "example", "field": "example" }, "path": { "dataset": "example", "field": "example" }, "stroke": { "color": "example", "opacity": 1, "width": 1 }, "value": { "dataset": "example", "field": "example" } }, "properties": { "category": { "$ref": "#/components/schemas/VisualizationFieldRef" }, "color": { "$ref": "#/components/schemas/VisualizationMapColorScale" }, "kind": { "enum": [ "path" ], "example": "example", "type": "string" }, "latitude": { "$ref": "#/components/schemas/VisualizationFieldRef" }, "line": { "$ref": "#/components/schemas/VisualizationMapLineStyle" }, "longitude": { "$ref": "#/components/schemas/VisualizationFieldRef" }, "opacity": { "example": 1, "format": "double", "type": "number" }, "order": { "$ref": "#/components/schemas/VisualizationFieldRef" }, "path": { "$ref": "#/components/schemas/VisualizationFieldRef" }, "stroke": { "$ref": "#/components/schemas/VisualizationMapStroke" }, "value": { "$ref": "#/components/schemas/VisualizationFieldRef" } }, "required": [ "kind", "latitude", "longitude", "path", "order", "color", "stroke", "line", "opacity" ], "type": "object" }, "VisualizationPointLayer": { "allOf": [ { "$ref": "#/components/schemas/VisualizationGeographicLayerBase" } ], "example": { "category": { "dataset": "example", "field": "example" }, "cluster": { "enabled": true, "maximumZoom": 1, "minimumPoints": 1, "radius": 1, "showCount": true }, "color": { "domainMaximum": 1, "domainMidpoint": 1, "domainMinimum": 1, "kind": "sequential", "nullColor": "example", "palette": "example", "reverse": true }, "kind": "example", "latitude": { "dataset": "example", "field": "example" }, "longitude": { "dataset": "example", "field": "example" }, "opacity": 1, "size": { "domainMaximum": 1, "domainMinimum": 1, "maximumRadius": 1, "minimumRadius": 1 }, "stroke": { "color": "example", "opacity": 1, "width": 1 }, "value": { "dataset": "example", "field": "example" } }, "properties": { "category": { "$ref": "#/components/schemas/VisualizationFieldRef" }, "cluster": { "$ref": "#/components/schemas/VisualizationMapCluster" }, "color": { "$ref": "#/components/schemas/VisualizationMapColorScale" }, "kind": { "enum": [ "point" ], "example": "example", "type": "string" }, "latitude": { "$ref": "#/components/schemas/VisualizationFieldRef" }, "longitude": { "$ref": "#/components/schemas/VisualizationFieldRef" }, "opacity": { "example": 1, "format": "double", "type": "number" }, "size": { "$ref": "#/components/schemas/VisualizationMapSizeScale" }, "stroke": { "$ref": "#/components/schemas/VisualizationMapStroke" }, "value": { "$ref": "#/components/schemas/VisualizationFieldRef" } }, "required": [ "kind", "latitude", "longitude", "size", "color", "stroke", "cluster", "opacity" ], "type": "object" }, "VisualizationPolarMark": { "enum": [ "radar", "gauge" ], "example": "radar", "type": "string" }, "VisualizationPresentation": { "example": { "legend": "hidden", "showLabels": true }, "properties": { "legend": { "$ref": "#/components/schemas/VisualizationLegendPosition" }, "showLabels": { "example": true, "type": "boolean" } }, "required": [ "legend", "showLabels" ], "type": "object" }, "VisualizationProportionalMark": { "enum": [ "pie", "donut", "funnel" ], "example": "pie", "type": "string" }, "VisualizationReferenceLayer": { "allOf": [ { "$ref": "#/components/schemas/VisualizationGeographicLayerBase" } ], "example": { "color": { "domainMaximum": 1, "domainMidpoint": 1, "domainMinimum": 1, "kind": "sequential", "nullColor": "example", "palette": "example", "reverse": true }, "geometry": { "attribution": "example", "digest": "example", "id": "example", "identifierSystem": "example", "license": "example", "source": "example", "url": "example" }, "kind": "example", "opacity": 1, "stroke": { "color": "example", "opacity": 1, "width": 1 } }, "properties": { "color": { "$ref": "#/components/schemas/VisualizationMapColorScale" }, "geometry": { "$ref": "#/components/schemas/VisualizationGeometryAsset" }, "kind": { "enum": [ "reference" ], "example": "example", "type": "string" }, "opacity": { "example": 1, "format": "double", "type": "number" }, "stroke": { "$ref": "#/components/schemas/VisualizationMapStroke" } }, "required": [ "kind", "geometry", "color", "stroke", "opacity" ], "type": "object" }, "VisualizationRendererCapability": { "example": { "id": "echarts", "kinds": [ "cartesian" ], "schemaVersion": 1, "version": "example" }, "properties": { "id": { "$ref": "#/components/schemas/VisualizationRendererID" }, "kinds": { "example": [ "cartesian" ], "items": { "$ref": "#/components/schemas/VisualizationSpecKind" }, "type": "array" }, "schemaVersion": { "example": 1, "type": "integer" }, "version": { "example": "example", "type": "string" } }, "required": [ "id", "version", "schemaVersion", "kinds" ], "type": "object" }, "VisualizationRendererID": { "enum": [ "echarts", "tanstack", "html", "maplibre", "vega-lite-sandbox" ], "example": "echarts", "type": "string" }, "VisualizationSelectionEntry": { "example": { "datum": { "blockID": "example", "dataRevision": 1, "dataset": "example", "identity": { "key": "example" }, "resetVersion": 1 }, "label": "example" }, "properties": { "datum": { "$ref": "#/components/schemas/VisualizationDatumRef" }, "label": { "example": "example", "type": "string" } }, "required": [ "datum" ], "type": "object" }, "VisualizationSelectionMode": { "enum": [ "single", "multiple" ], "example": "single", "type": "string" }, "VisualizationSort": { "example": { "direction": "ascending", "field": { "dataset": "example", "field": "example" } }, "properties": { "direction": { "$ref": "#/components/schemas/VisualizationSortDirection" }, "field": { "$ref": "#/components/schemas/VisualizationFieldRef" } }, "required": [ "field", "direction" ], "type": "object" }, "VisualizationSortDirection": { "enum": [ "ascending", "descending" ], "example": "ascending", "type": "string" }, "VisualizationSpatialBounds": { "example": { "east": 1, "north": 1, "south": 1, "west": 1 }, "properties": { "east": { "example": 1, "format": "double", "type": "number" }, "north": { "example": 1, "format": "double", "type": "number" }, "south": { "example": 1, "format": "double", "type": "number" }, "west": { "example": 1, "format": "double", "type": "number" } }, "required": [ "west", "south", "east", "north" ], "type": "object" }, "VisualizationSpatialBoxSelection": { "allOf": [ { "$ref": "#/components/schemas/VisualizationSpatialSelectionGeometryBase" } ], "example": { "bounds": { "east": 1, "north": 1, "south": 1, "west": 1 }, "kind": "example" }, "properties": { "bounds": { "$ref": "#/components/schemas/VisualizationSpatialBounds" }, "kind": { "enum": [ "box" ], "example": "example", "type": "string" } }, "required": [ "kind", "bounds" ], "type": "object" }, "VisualizationSpatialCoordinate": { "example": { "latitude": 1, "longitude": 1 }, "properties": { "latitude": { "example": 1, "format": "double", "type": "number" }, "longitude": { "example": 1, "format": "double", "type": "number" } }, "required": [ "longitude", "latitude" ], "type": "object" }, "VisualizationSpatialFieldMapping": { "example": { "source": { "dataset": "example", "field": "example" }, "targetFactID": "example", "targetFieldID": "example" }, "properties": { "source": { "$ref": "#/components/schemas/VisualizationFieldRef" }, "targetFactID": { "example": "example", "type": "string" }, "targetFieldID": { "example": "example", "type": "string" } }, "required": [ "source", "targetFieldID" ], "type": "object" }, "VisualizationSpatialLassoSelection": { "allOf": [ { "$ref": "#/components/schemas/VisualizationSpatialSelectionGeometryBase" } ], "example": { "kind": "example", "points": [ { "latitude": 1, "longitude": 1 } ] }, "properties": { "kind": { "enum": [ "lasso" ], "example": "example", "type": "string" }, "points": { "example": [ { "latitude": 1, "longitude": 1 } ], "items": { "$ref": "#/components/schemas/VisualizationSpatialCoordinate" }, "type": "array" } }, "required": [ "kind", "points" ], "type": "object" }, "VisualizationSpatialPrecision": { "enum": [ "raw", "aggregated" ], "example": "raw", "type": "string" }, "VisualizationSpatialRadiusSelection": { "allOf": [ { "$ref": "#/components/schemas/VisualizationSpatialSelectionGeometryBase" } ], "example": { "center": { "latitude": 1, "longitude": 1 }, "kind": "example", "radiusMeters": 1 }, "properties": { "center": { "$ref": "#/components/schemas/VisualizationSpatialCoordinate" }, "kind": { "enum": [ "radius" ], "example": "example", "type": "string" }, "radiusMeters": { "example": 1, "format": "double", "type": "number" } }, "required": [ "kind", "center", "radiusMeters" ], "type": "object" }, "VisualizationSpatialSelectionGeometry": { "discriminator": { "mapping": { "box": "#/components/schemas/VisualizationSpatialBoxSelection", "lasso": "#/components/schemas/VisualizationSpatialLassoSelection", "radius": "#/components/schemas/VisualizationSpatialRadiusSelection" }, "propertyName": "kind" }, "oneOf": [ { "$ref": "#/components/schemas/VisualizationSpatialBoxSelection" }, { "$ref": "#/components/schemas/VisualizationSpatialLassoSelection" }, { "$ref": "#/components/schemas/VisualizationSpatialRadiusSelection" } ] }, "VisualizationSpatialSelectionGeometryBase": { "example": { "kind": "example" }, "properties": { "kind": { "example": "example", "type": "string" } }, "required": [ "kind" ], "type": "object" }, "VisualizationSpatialSelectionGesture": { "enum": [ "box", "lasso", "radius" ], "example": "box", "type": "string" }, "VisualizationSpatialSelectionInteraction": { "example": { "gestures": [ "box" ], "id": "example", "latitude": { "source": { "dataset": "example", "field": "example" }, "targetFactID": "example", "targetFieldID": "example" }, "longitude": { "source": { "dataset": "example", "field": "example" }, "targetFactID": "example", "targetFieldID": "example" }, "targets": [ "example" ] }, "properties": { "gestures": { "example": [ "box" ], "items": { "$ref": "#/components/schemas/VisualizationSpatialSelectionGesture" }, "type": "array" }, "id": { "example": "example", "type": "string" }, "latitude": { "$ref": "#/components/schemas/VisualizationSpatialFieldMapping" }, "longitude": { "$ref": "#/components/schemas/VisualizationSpatialFieldMapping" }, "targets": { "example": [ "example" ], "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "gestures", "latitude", "longitude", "targets" ], "type": "object" }, "VisualizationSpatialSelectionState": { "example": { "interactionID": "example", "visualID": "example" }, "properties": { "geometry": { "$ref": "#/components/schemas/VisualizationSpatialSelectionGeometry" }, "interactionID": { "example": "example", "type": "string" }, "visualID": { "example": "example", "type": "string" } }, "required": [ "visualID", "interactionID", "geometry" ], "type": "object" }, "VisualizationSpatialWindowBlock": { "example": { "bounds": { "east": 1, "north": 1, "south": 1, "west": 1 }, "height": 1, "id": "example", "precision": "raw", "requestSeq": 1, "resetVersion": 1, "rows": [ [ "example" ] ], "width": 1, "zoom": 1 }, "properties": { "bounds": { "$ref": "#/components/schemas/VisualizationSpatialBounds" }, "height": { "example": 1, "format": "int32", "type": "integer" }, "id": { "example": "example", "type": "string" }, "precision": { "$ref": "#/components/schemas/VisualizationSpatialPrecision" }, "requestSeq": { "example": 1, "format": "int64", "type": "integer" }, "resetVersion": { "example": 1, "format": "int64", "type": "integer" }, "rows": { "example": [ [ "example" ] ], "items": { "items": {}, "type": "array" }, "type": "array" }, "width": { "example": 1, "format": "int32", "type": "integer" }, "zoom": { "example": 1, "format": "double", "type": "number" } }, "required": [ "id", "bounds", "zoom", "width", "height", "precision", "rows", "requestSeq", "resetVersion" ], "type": "object" }, "VisualizationSpec": { "discriminator": { "mapping": { "cartesian": "#/components/schemas/CartesianVisualizationSpec", "custom": "#/components/schemas/CustomVisualizationSpec", "geographic": "#/components/schemas/GeographicVisualizationSpec", "hierarchy": "#/components/schemas/HierarchyVisualizationSpec", "kpi": "#/components/schemas/KPIVisualizationSpec", "matrix": "#/components/schemas/MatrixVisualizationSpec", "pivot": "#/components/schemas/PivotVisualizationSpec", "polar": "#/components/schemas/PolarVisualizationSpec", "proportional": "#/components/schemas/ProportionalVisualizationSpec", "table": "#/components/schemas/TableVisualizationSpec" }, "propertyName": "kind" }, "oneOf": [ { "$ref": "#/components/schemas/CartesianVisualizationSpec" }, { "$ref": "#/components/schemas/ProportionalVisualizationSpec" }, { "$ref": "#/components/schemas/HierarchyVisualizationSpec" }, { "$ref": "#/components/schemas/PolarVisualizationSpec" }, { "$ref": "#/components/schemas/TableVisualizationSpec" }, { "$ref": "#/components/schemas/MatrixVisualizationSpec" }, { "$ref": "#/components/schemas/PivotVisualizationSpec" }, { "$ref": "#/components/schemas/KPIVisualizationSpec" }, { "$ref": "#/components/schemas/GeographicVisualizationSpec" }, { "$ref": "#/components/schemas/CustomVisualizationSpec" } ] }, "VisualizationSpecBase": { "example": { "accessibility": { "announceChanges": true, "description": "example", "summary": "example", "title": "example" }, "dataBudget": { "maxRows": 1, "requiredCompleteness": "complete" }, "datasets": [ { "fields": [ { "dataType": "string", "geographic": { "geometryAsset": "example", "identifierSystem": "example", "joinField": "example", "unmatchedPolicy": "example" }, "grid": { "columnValue": "example", "formatting": [], "group": "example", "measure": "example" }, "id": "example", "label": "example", "nullable": true, "role": "dimension", "sourceRef": "example", "time": { "calendar": "example", "grain": "example", "meaning": "instant", "timezone": "example", "weekStart": "monday" } } ], "id": "example" } ], "interactions": [ { "id": "example", "kind": "select", "mappings": [ { "grain": "example", "label": { "dataset": "example", "field": "example" }, "source": { "dataset": "example", "field": "example" }, "targetFactID": "example", "targetFieldID": "example" } ], "mode": "single", "requiresStableIdentity": true, "targets": [ "example" ] } ], "kind": "example", "title": "example" }, "properties": { "accessibility": { "$ref": "#/components/schemas/VisualizationAccessibility" }, "dataBudget": { "$ref": "#/components/schemas/VisualizationDataBudget" }, "datasets": { "example": [ { "fields": [ { "dataType": "string", "geographic": { "geometryAsset": "example", "identifierSystem": "example", "joinField": "example", "unmatchedPolicy": "example" }, "grid": { "columnValue": "example", "formatting": [], "group": "example", "measure": "example" }, "id": "example", "label": "example", "nullable": true, "role": "dimension", "sourceRef": "example", "time": { "calendar": "example", "grain": "example", "meaning": "instant", "timezone": "example", "weekStart": "monday" } } ], "id": "example" } ], "items": { "$ref": "#/components/schemas/VisualizationDatasetSchema" }, "type": "array" }, "interactions": { "example": [ { "id": "example", "kind": "select", "mappings": [ { "grain": "example", "label": { "dataset": "example", "field": "example" }, "source": { "dataset": "example", "field": "example" }, "targetFactID": "example", "targetFieldID": "example" } ], "mode": "single", "requiresStableIdentity": true, "targets": [ "example" ] } ], "items": { "$ref": "#/components/schemas/VisualizationInteraction" }, "type": "array" }, "kind": { "example": "example", "type": "string" }, "title": { "example": "example", "type": "string" } }, "required": [ "kind", "title", "datasets", "dataBudget", "accessibility", "interactions" ], "type": "object" }, "VisualizationSpecKind": { "enum": [ "cartesian", "proportional", "hierarchy", "polar", "table", "matrix", "pivot", "kpi", "geographic", "custom" ], "example": "cartesian", "type": "string" }, "VisualizationStatus": { "example": { "kind": "idle", "message": "example" }, "properties": { "kind": { "$ref": "#/components/schemas/VisualizationStatusKind" }, "message": { "example": "example", "type": "string" } }, "required": [ "kind" ], "type": "object" }, "VisualizationStatusKind": { "enum": [ "idle", "loading", "ready", "no_data", "partial", "error" ], "example": "idle", "type": "string" }, "VisualizationTemporalMeaning": { "enum": [ "instant", "bucket" ], "example": "instant", "type": "string" }, "VisualizationTemporalMetadata": { "example": { "calendar": "example", "grain": "example", "meaning": "instant", "timezone": "example", "weekStart": "monday" }, "properties": { "calendar": { "example": "example", "type": "string" }, "grain": { "example": "example", "type": "string" }, "meaning": { "$ref": "#/components/schemas/VisualizationTemporalMeaning" }, "timezone": { "example": "example", "type": "string" }, "weekStart": { "$ref": "#/components/schemas/VisualizationWeekStart" } }, "required": [ "grain", "timezone", "calendar", "weekStart", "meaning" ], "type": "object" }, "VisualizationThreshold": { "example": { "tone": "neutral", "value": 1 }, "properties": { "tone": { "$ref": "#/components/schemas/VisualizationTone" }, "value": { "example": 1, "format": "double", "type": "number" } }, "required": [ "value", "tone" ], "type": "object" }, "VisualizationTone": { "enum": [ "neutral", "ink", "success", "warning", "danger" ], "example": "neutral", "type": "string" }, "VisualizationWeekStart": { "enum": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ], "example": "monday", "type": "string" }, "VisualizationWindowBlock": { "example": { "id": "example", "requestSeq": 1, "resetVersion": 1, "rows": [ [ "example" ] ], "sort": [ { "direction": "ascending", "field": { "dataset": "example", "field": "example" } } ], "start": 1 }, "properties": { "id": { "example": "example", "type": "string" }, "requestSeq": { "example": 1, "format": "int64", "type": "integer" }, "resetVersion": { "example": 1, "format": "int64", "type": "integer" }, "rows": { "example": [ [ "example" ] ], "items": { "items": {}, "type": "array" }, "type": "array" }, "sort": { "example": [ { "direction": "ascending", "field": { "dataset": "example", "field": "example" } } ], "items": { "$ref": "#/components/schemas/VisualizationSort" }, "type": "array" }, "start": { "example": 1, "format": "int64", "type": "integer" } }, "required": [ "id", "start", "rows", "requestSeq", "resetVersion", "sort" ], "type": "object" }, "WindowedVisualizationDataState": { "allOf": [ { "$ref": "#/components/schemas/VisualizationDataStateBase" } ], "example": { "availableRows": 1, "blocks": { "key": { "id": "example", "requestSeq": 1, "resetVersion": 1, "rows": [ [ "example" ] ], "sort": [ { "direction": "ascending", "field": { "dataset": "example", "field": "example" } } ], "start": 1 } }, "cardinality": { "count": 1, "kind": "unknown" }, "chunkSize": 1, "kind": "example", "resetVersion": 1, "rowCap": 1, "schema": { "fields": [ { "dataType": "string", "geographic": { "geometryAsset": "example", "identifierSystem": "example", "joinField": "example", "unmatchedPolicy": "example" }, "grid": { "columnValue": "example", "formatting": [], "group": "example", "measure": "example" }, "id": "example", "label": "example", "nullable": true, "role": "dimension", "sourceRef": "example", "time": { "calendar": "example", "grain": "example", "meaning": "instant", "timezone": "example", "weekStart": "monday" } } ], "id": "example" }, "sort": [ { "direction": "ascending", "field": { "dataset": "example", "field": "example" } } ] }, "properties": { "availableRows": { "example": 1, "format": "int64", "type": "integer" }, "blocks": { "additionalProperties": { "$ref": "#/components/schemas/VisualizationWindowBlock" }, "example": { "key": { "id": "example", "requestSeq": 1, "resetVersion": 1, "rows": [ [ "example" ] ], "sort": [ { "direction": "ascending", "field": { "dataset": "example", "field": "example" } } ], "start": 1 } }, "type": "object" }, "cardinality": { "$ref": "#/components/schemas/VisualizationCardinality" }, "chunkSize": { "example": 1, "format": "int64", "type": "integer" }, "kind": { "enum": [ "windowed" ], "example": "example", "type": "string" }, "resetVersion": { "example": 1, "format": "int64", "type": "integer" }, "rowCap": { "example": 1, "format": "int64", "type": "integer" }, "schema": { "$ref": "#/components/schemas/VisualizationDatasetSchema" }, "sort": { "example": [ { "direction": "ascending", "field": { "dataset": "example", "field": "example" } } ], "items": { "$ref": "#/components/schemas/VisualizationSort" }, "type": "array" } }, "required": [ "kind", "schema", "cardinality", "availableRows", "rowCap", "chunkSize", "resetVersion", "sort", "blocks" ], "type": "object" }, "WorkspaceAssetGraphResponse": { "example": { "assets": [ { "contentHash": "example", "description": "example", "id": "example", "key": "example", "parentId": "example", "payload": { "key": "example" }, "payloadSchema": "example", "servingStateId": "example", "snapshotId": "example", "sourceFile": "example", "title": "example", "type": "example", "workspaceId": "example" } ], "edges": [ { "fromAssetId": "example", "id": "example", "servingStateId": "example", "toAssetId": "example", "type": "example", "workspaceId": "example" } ] }, "properties": { "assets": { "example": [ { "contentHash": "example", "description": "example", "id": "example", "key": "example", "parentId": "example", "payload": { "key": "example" }, "payloadSchema": "example", "servingStateId": "example", "snapshotId": "example", "sourceFile": "example", "title": "example", "type": "example", "workspaceId": "example" } ], "items": { "$ref": "#/components/schemas/AssetGraphAssetResponse" }, "type": "array" }, "edges": { "example": [ { "fromAssetId": "example", "id": "example", "servingStateId": "example", "toAssetId": "example", "type": "example", "workspaceId": "example" } ], "items": { "$ref": "#/components/schemas/AssetEdgeResponse" }, "type": "array" } }, "required": [ "assets", "edges" ], "type": "object" }, "WorkspaceListResponse": { "example": { "items": [ { "activeServingStateId": "example", "createdAt": "2026-01-02T15:04:05Z", "description": "example", "id": "example", "title": "example", "updatedAt": "2026-01-02T15:04:05Z" } ], "page": { "nextCursor": "example" } }, "properties": { "items": { "example": [ { "activeServingStateId": "example", "createdAt": "2026-01-02T15:04:05Z", "description": "example", "id": "example", "title": "example", "updatedAt": "2026-01-02T15:04:05Z" } ], "items": { "$ref": "#/components/schemas/WorkspaceResponse" }, "type": "array" }, "page": { "$ref": "#/components/schemas/PageInfo" } }, "required": [ "items", "page" ], "type": "object" }, "WorkspaceResponse": { "example": { "activeServingStateId": "example", "createdAt": "2026-01-02T15:04:05Z", "description": "example", "id": "example", "title": "example", "updatedAt": "2026-01-02T15:04:05Z" }, "properties": { "activeServingStateId": { "example": "example", "type": "string" }, "createdAt": { "example": "2026-01-02T15:04:05Z", "format": "date-time", "type": "string" }, "description": { "example": "example", "type": "string" }, "id": { "example": "example", "type": "string" }, "title": { "example": "example", "type": "string" }, "updatedAt": { "example": "2026-01-02T15:04:05Z", "format": "date-time", "type": "string" } }, "required": [ "id", "title", "description", "createdAt", "updatedAt" ], "type": "object" } } }