{ "openapi": "3.0.1", "info": { "title": "Grapes Api", "version": "v1" }, "paths": { "/api/{version}/organizations/{orgId}/agent-pools": { "get": { "tags": [ "AgentPools" ], "operationId": "GetAgentPools", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AgentPoolDtoListItemResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AgentPoolDtoListItemResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AgentPoolDtoListItemResponse" } } } } } }, "post": { "tags": [ "AgentPools" ], "operationId": "CreateAgentPool", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAgentPoolRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateAgentPoolRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateAgentPoolRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AgentPoolDtoItemResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AgentPoolDtoItemResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AgentPoolDtoItemResponse" } } } }, "400": { "description": "Validation failed" } } } }, "/api/{version}/organizations/{orgId}/agent-pools/{agentPoolId}/agents": { "get": { "tags": [ "AgentPools" ], "operationId": "GetAgents", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "agentPoolId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AgentDtoListItemResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AgentDtoListItemResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AgentDtoListItemResponse" } } } } } }, "post": { "tags": [ "AgentPools" ], "operationId": "CreateAgent", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "agentPoolId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAgentRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateAgentRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateAgentRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AgentDtoItemResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AgentDtoItemResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AgentDtoItemResponse" } } } }, "400": { "description": "Validation failed" } } } }, "/api/{version}/organizations/{orgId}/agent-pools/{agentPoolId}/agents/{agentId}": { "get": { "tags": [ "AgentPools" ], "operationId": "GetAgentById", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "agentPoolId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "agentId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AgentDtoItemResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AgentDtoItemResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AgentDtoItemResponse" } } } } } }, "patch": { "tags": [ "AgentPools" ], "operationId": "UpdateAgent", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "agentPoolId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "agentId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAgentRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateAgentRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateAgentRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AgentDtoItemResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AgentDtoItemResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AgentDtoItemResponse" } } } }, "400": { "description": "Validation failed" } } } }, "/api/{version}/organizations/{orgId}/agent-pools/{agentPoolId}/agents/{agentId}/upgrade": { "post": { "tags": [ "AgentPools" ], "operationId": "UpgradeAgent", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "agentPoolId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "agentId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/IActionResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/IActionResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IActionResult" } } } }, "400": { "description": "Validation failed" } } } }, "/api/{version}/organizations/{orgId}/agent-pools/{agentPoolId}/authorize": { "post": { "tags": [ "AgentPools" ], "operationId": "AuthorizeAgent", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "agentPoolId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ActionResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ActionResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ActionResult" } } } }, "400": { "description": "Validation failed" } } } }, "/communication-hub/negotiate": { "post": { "tags": [ "CommunicationHub" ], "operationId": "negociate", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/NegotiationResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/NegotiationResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NegotiationResponse" } } } } } } }, "/api/{version}/organizations/{orgId}/projects/{projId}/databases": { "get": { "tags": [ "Databases" ], "operationId": "GetDatabases", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "projId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "searchQuery", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Take", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DatabaseDtoListItemResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DatabaseDtoListItemResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DatabaseDtoListItemResponse" } } } } } }, "post": { "tags": [ "Databases" ], "operationId": "CreateDatabase", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "projId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDatabaseRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateDatabaseRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateDatabaseRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DatabaseDtoItemResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DatabaseDtoItemResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DatabaseDtoItemResponse" } } } }, "400": { "description": "Validation failed" } } } }, "/api/{version}/organizations/{orgId}/projects/{projId}/databases/{id}": { "get": { "tags": [ "Databases" ], "operationId": "GetDatabaseById", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "projId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DatabaseDtoItemResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DatabaseDtoItemResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DatabaseDtoItemResponse" } } } }, "404": { "description": "Database not found" } } }, "put": { "tags": [ "Databases" ], "operationId": "UpdateDatabase", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "projId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateDatabaseRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateDatabaseRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateDatabaseRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DatabaseDtoItemResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DatabaseDtoItemResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DatabaseDtoItemResponse" } } } }, "400": { "description": "Validation failed" }, "404": { "description": "Database not found" } } }, "delete": { "tags": [ "Databases" ], "operationId": "DeleteDatabase", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "projId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Validation failed" }, "404": { "description": "Database not found" } } } }, "/api/{version}/organizations/{orgId}/projects/{projId}/databases/{id}/schema/extract": { "post": { "tags": [ "Databases" ], "operationId": "ExtractDatabaseSchema", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "projId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExtractSchemaRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ExtractSchemaRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ExtractSchemaRequest" } } } }, "responses": { "202": { "description": "Accepted", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/IActionResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/IActionResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IActionResult" } } } }, "400": { "description": "Validation failed" }, "404": { "description": "Database not found" } } } }, "/api/{version}/organizations/{orgId}/projects/{projId}/databases/{id}/schema": { "get": { "tags": [ "Databases" ], "operationId": "GetDatabaseSchema", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "projId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "202": { "description": "Accepted", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SchemaDtoItemResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SchemaDtoItemResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SchemaDtoItemResponse" } } } }, "400": { "description": "Validation failed" }, "404": { "description": "Schema not found" } } }, "post": { "tags": [ "Databases" ], "operationId": "CreateDatabaseSchema", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "projId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSchemaRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateSchemaRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateSchemaRequest" } } } }, "responses": { "202": { "description": "Accepted", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SchemaDtoItemResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SchemaDtoItemResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SchemaDtoItemResponse" } } } }, "400": { "description": "Validation failed" } } } }, "/api/{version}/organizations/{orgId}/projects/{projId}/grapes/{grapeId}/datasets": { "get": { "tags": [ "Datasets" ], "operationId": "GetDatasets", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "projId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "grapeId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DatasetDtoListItemResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DatasetDtoListItemResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DatasetDtoListItemResponse" } } } } } }, "post": { "tags": [ "Datasets" ], "operationId": "CreateDataset", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "projId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "grapeId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDatasetRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateDatasetRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateDatasetRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DatasetDtoItemResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DatasetDtoItemResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DatasetDtoItemResponse" } } } }, "400": { "description": "Validation failed" } } } }, "/api/{version}/organizations/{orgId}/projects/{projId}/grapes/{grapeId}/datasets/{id}": { "get": { "tags": [ "Datasets" ], "operationId": "GetDatasetById", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "projId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "grapeId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DatasetDtoItemResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DatasetDtoItemResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DatasetDtoItemResponse" } } } }, "404": { "description": "Dataset not found" } } }, "put": { "tags": [ "Datasets" ], "operationId": "UpdateDataset", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "projId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "grapeId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateDatasetRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateDatasetRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateDatasetRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DatasetDtoItemResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DatasetDtoItemResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DatasetDtoItemResponse" } } } }, "400": { "description": "Validation failed" }, "404": { "description": "Dataset not found" } } }, "delete": { "tags": [ "Datasets" ], "operationId": "DeleteDataset", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "projId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "grapeId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Validation failed" }, "404": { "description": "Dataset not found" } } } }, "/api/{version}/organizations/{orgId}/projects/{projId}/grapes/{grapeId}/datasets/{id}/extract-data": { "post": { "tags": [ "Datasets" ], "operationId": "ExtractDataset", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "projId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "grapeId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExtractDataRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ExtractDataRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ExtractDataRequest" } } } }, "responses": { "202": { "description": "Accepted", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/IActionResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/IActionResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IActionResult" } } } }, "400": { "description": "Validation failed" }, "404": { "description": "Dataset not found" } } } }, "/api/{version}/organizations/{orgId}/projects/{projId}/grapes/{grapeId}/datasets/{id}/import-data": { "post": { "tags": [ "Datasets" ], "operationId": "ImportDataset", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "projId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "grapeId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportDatasetRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ImportDatasetRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ImportDatasetRequest" } } } }, "responses": { "202": { "description": "Accepted", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/IActionResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/IActionResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IActionResult" } } } }, "400": { "description": "Validation failed" }, "404": { "description": "Dataset not found" } } } }, "/api/{version}/organizations/{orgId}/projects/{projId}/grapes/{grapeId}/datasets/{id}/upload": { "post": { "tags": [ "Datasets" ], "operationId": "UploadDataset", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "projId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "grapeId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "202": { "description": "Accepted", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/IActionResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/IActionResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IActionResult" } } } }, "400": { "description": "Validation failed" }, "404": { "description": "Dataset not found" }, "415": { "description": "Content-Type not supported" } } } }, "/api/{version}/organizations/{orgId}/projects/{projId}/grapes/{grapeId}/datasets/{id}/download": { "get": { "tags": [ "Datasets" ], "operationId": "DownloadDataset", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "projId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "grapeId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Dataset not found" } } } }, "/api/{version}/organizations/{orgId}/projects/{projId}/environments": { "get": { "tags": [ "Environments" ], "operationId": "GetEnvironments", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "projId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/EnvironmentDtoListItemResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EnvironmentDtoListItemResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EnvironmentDtoListItemResponse" } } } } } }, "post": { "tags": [ "Environments" ], "operationId": "CreateEnvironment", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "projId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateEnvironmentRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateEnvironmentRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateEnvironmentRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/EnvironmentDtoItemResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EnvironmentDtoItemResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EnvironmentDtoItemResponse" } } } }, "400": { "description": "Validation failed" } } } }, "/api/{version}/organizations/{orgId}/projects/{projId}/environments/{id}": { "get": { "tags": [ "Environments" ], "operationId": "GetEnvironmentById", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "projId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/EnvironmentDtoItemResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EnvironmentDtoItemResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EnvironmentDtoItemResponse" } } } }, "404": { "description": "Environment not found" } } }, "put": { "tags": [ "Environments" ], "operationId": "UpdateEnvironment", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "projId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateEnvironmentRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateEnvironmentRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateEnvironmentRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/EnvironmentDtoItemResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EnvironmentDtoItemResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EnvironmentDtoItemResponse" } } } }, "400": { "description": "Validation failed" }, "404": { "description": "Environment not found" } } } }, "/api/{version}/organizations/{orgId}/projects/{projId}/grapes": { "get": { "tags": [ "Grapes" ], "operationId": "GetGrapes", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "projId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GrapeDtoListItemResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GrapeDtoListItemResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GrapeDtoListItemResponse" } } } } } }, "post": { "tags": [ "Grapes" ], "operationId": "CreateGrape", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "projId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateGrapeRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateGrapeRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateGrapeRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GrapeDtoItemResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GrapeDtoItemResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GrapeDtoItemResponse" } } } }, "400": { "description": "Validation failed" } } } }, "/api/{version}/organizations/{orgId}/projects/{projId}/grapes/{id}": { "get": { "tags": [ "Grapes" ], "operationId": "GetGrapesById", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "projId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "includeDatabases", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GrapeDtoItemResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GrapeDtoItemResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GrapeDtoItemResponse" } } } } } }, "put": { "tags": [ "Grapes" ], "operationId": "UpdateGrape", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "projId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateGrapeRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateGrapeRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateGrapeRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GrapeDtoItemResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GrapeDtoItemResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GrapeDtoItemResponse" } } } }, "400": { "description": "Validation failed" }, "404": { "description": "Grape not found" } } }, "delete": { "tags": [ "Grapes" ], "operationId": "DeleteGrape", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "projId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Validation failed" }, "404": { "description": "Grape not found" } } } }, "/api/{version}/organizations/{orgId}/infrastructures": { "get": { "tags": [ "Infrastructures" ], "operationId": "GetInfrastructures", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "searchQuery", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Take", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/InfrastructureDtoListItemResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/InfrastructureDtoListItemResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InfrastructureDtoListItemResponse" } } } } } }, "post": { "tags": [ "Infrastructures" ], "operationId": "CreateInfrastructure", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateInfrastructureRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateInfrastructureRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateInfrastructureRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/InfrastructureDtoItemResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/InfrastructureDtoItemResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InfrastructureDtoItemResponse" } } } }, "400": { "description": "Validation failed" } } } }, "/api/{version}/organizations/{orgId}/infrastructures/{id}": { "get": { "tags": [ "Infrastructures" ], "operationId": "GetInfrastructureById", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "includeConnectionString", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/InfrastructureDtoItemResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/InfrastructureDtoItemResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InfrastructureDtoItemResponse" } } } }, "404": { "description": "Infrastructure not found" } } }, "put": { "tags": [ "Infrastructures" ], "operationId": "UpdateInfrastructure", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateInfrastructureRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateInfrastructureRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateInfrastructureRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/InfrastructureDtoItemResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/InfrastructureDtoItemResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InfrastructureDtoItemResponse" } } } }, "400": { "description": "Validation failed" }, "404": { "description": "Infrastructure not found" } } }, "delete": { "tags": [ "Infrastructures" ], "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Validation failed" }, "404": { "description": "Infrastructure not found" } } } }, "/api/{version}/organizations/{orgId}/notifications": { "get": { "tags": [ "Notifications" ], "operationId": "GetNotifications", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Channel", "in": "query", "schema": { "$ref": "#/components/schemas/NotificationChannel" } }, { "name": "Status", "in": "query", "schema": { "$ref": "#/components/schemas/NotificationStatus" } }, { "name": "skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "take", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/NotificationDtoListItemResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/NotificationDtoListItemResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NotificationDtoListItemResponse" } } } } } } }, "/api/{version}/organizations/{orgId}/notifications/dismiss": { "post": { "tags": [ "Notifications" ], "operationId": "DismissNotification", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/IActionResultTask" } }, "application/json": { "schema": { "$ref": "#/components/schemas/IActionResultTask" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IActionResultTask" } } } } } } }, "/api/{version}/organizations": { "get": { "tags": [ "Organizations" ], "operationId": "GetOrganizations", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OrganizationDtoListItemResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationDtoListItemResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OrganizationDtoListItemResponse" } } } } } }, "post": { "tags": [ "Organizations" ], "operationId": "CreateOrganization", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOrganizationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateOrganizationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateOrganizationRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OrganizationDtoItemResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationDtoItemResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OrganizationDtoItemResponse" } } } }, "400": { "description": "Validation failed" } } } }, "/api/{version}/organizations/{orgId}": { "get": { "tags": [ "Organizations" ], "operationId": "GetOrganizationById", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OrganizationDtoItemResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationDtoItemResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OrganizationDtoItemResponse" } } } }, "404": { "description": "Organization not found" } } }, "put": { "tags": [ "Organizations" ], "operationId": "UpdateOrganization", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateOrganizationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateOrganizationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateOrganizationRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OrganizationDtoItemResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationDtoItemResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OrganizationDtoItemResponse" } } } }, "400": { "description": "Validation failed" }, "404": { "description": "Organization not found" } } } }, "/api/{version}/organizations/{orgId}/join": { "post": { "tags": [ "Organizations" ], "operationId": "JoinOrganization", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JoinOrganizationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/JoinOrganizationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/JoinOrganizationRequest" } } } }, "responses": { "202": { "description": "Accepted", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ActionResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ActionResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ActionResult" } } } }, "400": { "description": "Validation failed" }, "404": { "description": "Organization not found" } } } }, "/api/{version}/personal-access-tokens": { "post": { "tags": [ "PersonalAccessTokens" ], "operationId": "CreatePersonalAccessToken", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePersonalAccessTokenRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreatePersonalAccessTokenRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreatePersonalAccessTokenRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PersonalAccessTokenDtoItemResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PersonalAccessTokenDtoItemResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PersonalAccessTokenDtoItemResponse" } } } }, "400": { "description": "Validation failed" } } }, "get": { "tags": [ "PersonalAccessTokens" ], "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PersonalAccessTokenInfoDtoListItemResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PersonalAccessTokenInfoDtoListItemResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PersonalAccessTokenInfoDtoListItemResponse" } } } } } } }, "/api/{version}/personal-access-tokens/{id}": { "delete": { "tags": [ "PersonalAccessTokens" ], "operationId": "DeletePersonalAccessToken", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Personal access token deleted successfully" }, "400": { "description": "Validation failed" } } } }, "/api/{version}/organizations/{orgId}/projects": { "get": { "tags": [ "Projects" ], "operationId": "GetProjects", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "searchQuery", "in": "query", "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProjectDtoListItemResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProjectDtoListItemResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProjectDtoListItemResponse" } } } } } }, "post": { "tags": [ "Projects" ], "operationId": "CreateProject", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateProjectRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateProjectRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateProjectRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProjectDtoItemResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProjectDtoItemResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProjectDtoItemResponse" } } } }, "400": { "description": "Validation failed" } } } }, "/api/{version}/organizations/{orgId}/projects/{id}": { "get": { "tags": [ "Projects" ], "operationId": "GetProjectById", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProjectDtoItemResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProjectDtoItemResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProjectDtoItemResponse" } } } }, "404": { "description": "Project not found" } } }, "put": { "tags": [ "Projects" ], "operationId": "UpdateProject", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateProjectRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateProjectRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateProjectRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProjectDtoItemResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProjectDtoItemResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProjectDtoItemResponse" } } } }, "400": { "description": "Validation failed" }, "404": { "description": "Project not found" } } }, "delete": { "tags": [ "Projects" ], "operationId": "DeleteProject", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Project deleted successfully" }, "404": { "description": "Project not found" } } } }, "/api/{version}/organizations/{orgId}/projects/{id}/stats": { "get": { "tags": [ "Projects" ], "operationId": "GetProjectStatsById", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProjectStatsDtoItemResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProjectStatsDtoItemResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProjectStatsDtoItemResponse" } } } }, "404": { "description": "Project not found" } } } }, "/api/{version}/organizations/{orgId}/resources": { "post": { "tags": [ "Resource" ], "operationId": "CreateResource", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateResourceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateResourceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateResourceRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ResourceDtoItemResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ResourceDtoItemResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ResourceDtoItemResponse" } } } }, "400": { "description": "Validation failed" } } }, "get": { "tags": [ "Resource" ], "operationId": "GetResources", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "includeData", "in": "query", "schema": { "type": "boolean" } }, { "name": "projectId", "in": "query", "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ResourceDtoListItemResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ResourceDtoListItemResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ResourceDtoListItemResponse" } } } } } } }, "/api/{version}/organizations/{orgId}/resources/{id}": { "put": { "tags": [ "Resource" ], "operationId": "UpdateResource", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResourceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateResourceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateResourceRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ResourceDtoItemResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ResourceDtoItemResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ResourceDtoItemResponse" } } } }, "400": { "description": "Validation failed" } } }, "get": { "tags": [ "Resource" ], "operationId": "GetResourceById", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ResourceDtoItemResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ResourceDtoItemResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ResourceDtoItemResponse" } } } }, "404": { "description": "Resource not found" } } } }, "/api/{version}": { "get": { "tags": [ "Root" ], "operationId": "GetRoot", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/RootResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RootResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RootResponse" } } } } } } }, "/api/{version}/organizations/{orgId}/projects/{projId}/databases/{dbId}/sensitive-fields": { "post": { "tags": [ "SensitiveFields" ], "operationId": "CreateSensitiveField", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "projId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "dbId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSensitiveFieldRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateSensitiveFieldRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateSensitiveFieldRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SensitiveFieldDtoItemResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SensitiveFieldDtoItemResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SensitiveFieldDtoItemResponse" } } } }, "400": { "description": "Validation failed" } } }, "get": { "tags": [ "SensitiveFields" ], "operationId": "GetSensitiveFields", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "projId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "dbId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Take", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SensitiveFieldDtoListItemResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SensitiveFieldDtoListItemResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SensitiveFieldDtoListItemResponse" } } } } } } }, "/api/{version}/organizations/{orgId}/projects/{projId}/databases/{dbId}/sensitive-fields/{sensitiveFieldId}": { "patch": { "tags": [ "SensitiveFields" ], "operationId": "UpdateSensitiveField", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "projId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "dbId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "sensitiveFieldId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSensitiveFieldRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateSensitiveFieldRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateSensitiveFieldRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SensitiveFieldDtoListItemResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SensitiveFieldDtoListItemResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SensitiveFieldDtoListItemResponse" } } } } } } }, "/api/{version}/organizations/{orgId}/projects/{projId}/databases/{dbId}/sensitive-fields/{sensitiveFieldId}/workflow-status": { "post": { "tags": [ "SensitiveFields" ], "operationId": "UpdateSensitiveFieldWokflowStatus", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "projId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "dbId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "sensitiveFieldId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSensitiveFieldStatusRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateSensitiveFieldStatusRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateSensitiveFieldStatusRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SensitiveFieldDtoListItemResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SensitiveFieldDtoListItemResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SensitiveFieldDtoListItemResponse" } } } } } } }, "/api/{version}/organizations/{orgId}/projects/{projId}/databases/{dbId}/sensitive-fields/recognize": { "post": { "tags": [ "SensitiveFields" ], "operationId": "RecognizeSensitiveFields", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "projId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "dbId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecognizeSensitiveFieldsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RecognizeSensitiveFieldsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RecognizeSensitiveFieldsRequest" } } } }, "responses": { "202": { "description": "Accepted", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/IActionResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/IActionResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IActionResult" } } } }, "400": { "description": "Validation failed" } } } }, "/api/{version}/organizations/{orgId}/tasks": { "get": { "tags": [ "Tasks" ], "operationId": "GetTasks", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "projectId", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Take", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TaskDtoListItemResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TaskDtoListItemResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TaskDtoListItemResponse" } } } } } } }, "/api/{version}/organizations/{orgId}/tasks/{id}": { "patch": { "tags": [ "Tasks" ], "operationId": "UpdateTask", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateTaskRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateTaskRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateTaskRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TaskDtoItemResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TaskDtoItemResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TaskDtoItemResponse" } } } }, "400": { "description": "Validation failed" } } }, "get": { "tags": [ "Tasks" ], "operationId": "GetTaskById", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/IActionResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/IActionResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IActionResult" } } } } } } }, "/api/{version}/organizations/{orgId}/tasks/{id}/events": { "get": { "tags": [ "Tasks" ], "operationId": "GetTaskEvents", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TaskEventDtoListItemResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TaskEventDtoListItemResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TaskEventDtoListItemResponse" } } } } } }, "post": { "tags": [ "Tasks" ], "operationId": "CreateTaskEvents", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTaskEventsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateTaskEventsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateTaskEventsRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/IActionResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/IActionResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IActionResult" } } } }, "400": { "description": "Validation failed" } } } }, "/api/{version}/organizations/{orgId}/users": { "get": { "tags": [ "UsersControllers" ], "operationId": "GetUsers", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "searchQuery", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Take", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/UserDtoListItemResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UserDtoListItemResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserDtoListItemResponse" } } } } } } }, "/api/{version}/organizations/{orgId}/users/{id}": { "get": { "tags": [ "UsersControllers" ], "operationId": "GetUserById", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/UserDtoItemResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UserDtoItemResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserDtoItemResponse" } } } }, "404": { "description": "User not found" } } }, "put": { "tags": [ "UsersControllers" ], "operationId": "UpdateUser", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateUserRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateUserRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateUserRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/UserDtoItemResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UserDtoItemResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserDtoItemResponse" } } } }, "400": { "description": "Validation failed" }, "404": { "description": "User not found" } } } }, "/api/{version}/organizations/{orgId}/users/{id}/privileges": { "get": { "tags": [ "UsersControllers" ], "operationId": "GetUserPrivileges", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/UserPrivilegesDtoItemResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UserPrivilegesDtoItemResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserPrivilegesDtoItemResponse" } } } }, "404": { "description": "User not found" } } }, "post": { "tags": [ "UsersControllers" ], "operationId": "UpdateUserPrevileges", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateUserPrivilegesRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateUserPrivilegesRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateUserPrivilegesRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/IActionResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/IActionResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IActionResult" } } } }, "400": { "description": "Validation failed" }, "404": { "description": "User not found" } } } } }, "components": { "schemas": { "ActionResult": { "type": "object", "additionalProperties": false }, "AgentDto": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "status": { "$ref": "#/components/schemas/AgentStatusTypes" }, "lastSeenDate": { "type": "string", "format": "date-time", "nullable": true }, "identity": { "type": "string", "nullable": true }, "version": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AgentDtoItemResponse": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/AgentDto" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/HateoasLink" }, "nullable": true } }, "additionalProperties": false }, "AgentDtoListItemResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/AgentDtoItemResponse" }, "nullable": true }, "totalCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "AgentPoolDto": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "type": { "$ref": "#/components/schemas/AgentPoolTypes" } }, "additionalProperties": false }, "AgentPoolDtoItemResponse": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/AgentPoolDto" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/HateoasLink" }, "nullable": true } }, "additionalProperties": false }, "AgentPoolDtoListItemResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/AgentPoolDtoItemResponse" }, "nullable": true }, "totalCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "AgentPoolTypes": { "enum": [ "GrapesAgent", "SelfHosted" ], "type": "string" }, "AgentStatusTypes": { "enum": [ "Unknown", "Up", "Down", "Stopped", "Running" ], "type": "string" }, "AggregateException": { "type": "object", "properties": { "targetSite": { "$ref": "#/components/schemas/MethodBase" }, "data": { "type": "object", "additionalProperties": { }, "nullable": true, "readOnly": true }, "innerException": { "$ref": "#/components/schemas/Exception" }, "helpLink": { "type": "string", "nullable": true }, "source": { "type": "string", "nullable": true }, "hResult": { "type": "integer", "format": "int32" }, "stackTrace": { "type": "string", "nullable": true, "readOnly": true }, "innerExceptions": { "type": "array", "items": { "$ref": "#/components/schemas/Exception" }, "nullable": true, "readOnly": true }, "message": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Assembly": { "type": "object", "properties": { "definedTypes": { "type": "array", "items": { "$ref": "#/components/schemas/TypeInfo" }, "nullable": true, "readOnly": true }, "exportedTypes": { "type": "array", "items": { "$ref": "#/components/schemas/Type" }, "nullable": true, "readOnly": true }, "codeBase": { "type": "string", "nullable": true, "readOnly": true, "deprecated": true }, "entryPoint": { "$ref": "#/components/schemas/MethodInfo" }, "fullName": { "type": "string", "nullable": true, "readOnly": true }, "imageRuntimeVersion": { "type": "string", "nullable": true, "readOnly": true }, "isDynamic": { "type": "boolean", "readOnly": true }, "location": { "type": "string", "nullable": true, "readOnly": true }, "reflectionOnly": { "type": "boolean", "readOnly": true }, "isCollectible": { "type": "boolean", "readOnly": true }, "isFullyTrusted": { "type": "boolean", "readOnly": true }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttributeData" }, "nullable": true, "readOnly": true }, "escapedCodeBase": { "type": "string", "nullable": true, "readOnly": true, "deprecated": true }, "manifestModule": { "$ref": "#/components/schemas/Module" }, "modules": { "type": "array", "items": { "$ref": "#/components/schemas/Module" }, "nullable": true, "readOnly": true }, "globalAssemblyCache": { "type": "boolean", "readOnly": true, "deprecated": true }, "hostContext": { "type": "integer", "format": "int64", "readOnly": true }, "securityRuleSet": { "$ref": "#/components/schemas/SecurityRuleSet" } }, "additionalProperties": false }, "AvailableTransport": { "type": "object", "properties": { "transport": { "type": "string", "nullable": true }, "transferFormats": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "CallingConventions": { "enum": [ "Standard", "VarArgs", "Any", "HasThis", "ExplicitThis" ], "type": "string" }, "CompositeRelationDto": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "fromTable": { "type": "string", "nullable": true }, "toTable": { "type": "string", "nullable": true }, "columnMappings": { "type": "array", "items": { "$ref": "#/components/schemas/RelationColumnMappingDto" }, "nullable": true }, "fromDatabase": { "type": "string", "nullable": true }, "toDatabase": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ConstructorInfo": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "readOnly": true }, "declaringType": { "$ref": "#/components/schemas/Type" }, "reflectedType": { "$ref": "#/components/schemas/Type" }, "module": { "$ref": "#/components/schemas/Module" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttributeData" }, "nullable": true, "readOnly": true }, "isCollectible": { "type": "boolean", "readOnly": true }, "metadataToken": { "type": "integer", "format": "int32", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/MethodAttributes" }, "methodImplementationFlags": { "$ref": "#/components/schemas/MethodImplAttributes" }, "callingConvention": { "$ref": "#/components/schemas/CallingConventions" }, "isAbstract": { "type": "boolean", "readOnly": true }, "isConstructor": { "type": "boolean", "readOnly": true }, "isFinal": { "type": "boolean", "readOnly": true }, "isHideBySig": { "type": "boolean", "readOnly": true }, "isSpecialName": { "type": "boolean", "readOnly": true }, "isStatic": { "type": "boolean", "readOnly": true }, "isVirtual": { "type": "boolean", "readOnly": true }, "isAssembly": { "type": "boolean", "readOnly": true }, "isFamily": { "type": "boolean", "readOnly": true }, "isFamilyAndAssembly": { "type": "boolean", "readOnly": true }, "isFamilyOrAssembly": { "type": "boolean", "readOnly": true }, "isPrivate": { "type": "boolean", "readOnly": true }, "isPublic": { "type": "boolean", "readOnly": true }, "isConstructedGenericMethod": { "type": "boolean", "readOnly": true }, "isGenericMethod": { "type": "boolean", "readOnly": true }, "isGenericMethodDefinition": { "type": "boolean", "readOnly": true }, "containsGenericParameters": { "type": "boolean", "readOnly": true }, "methodHandle": { "$ref": "#/components/schemas/RuntimeMethodHandle" }, "isSecurityCritical": { "type": "boolean", "readOnly": true }, "isSecuritySafeCritical": { "type": "boolean", "readOnly": true }, "isSecurityTransparent": { "type": "boolean", "readOnly": true }, "memberType": { "$ref": "#/components/schemas/MemberTypes" } }, "additionalProperties": false }, "CreateAgentPoolRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreateAgentRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreateDatabaseRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "type": { "$ref": "#/components/schemas/DataBaseTypes" }, "environments": { "type": "array", "items": { "$ref": "#/components/schemas/DatabaseEnvironmentRequest" }, "nullable": true } }, "additionalProperties": false }, "CreateDatasetRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "parameters": { "type": "array", "items": { "$ref": "#/components/schemas/DatasetParameterValueDto" }, "nullable": true } }, "additionalProperties": false }, "CreateEnvironmentRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "tag": { "type": "string", "nullable": true }, "defaultAgentPool": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreateGrapeDetailTableRef": { "type": "object", "properties": { "tableName": { "type": "string", "nullable": true }, "databaseId": { "type": "string", "nullable": true }, "filter": { "$ref": "#/components/schemas/FilterRuleset" }, "sampling": { "$ref": "#/components/schemas/SamplingModel" }, "tableStyle": { "$ref": "#/components/schemas/TableStyle" }, "mergeOptions": { "$ref": "#/components/schemas/GrapeMergeOptionsModel" } }, "additionalProperties": false }, "CreateGrapeRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "details": { "type": "array", "items": { "$ref": "#/components/schemas/CreateGrapeDetailTableRef" }, "nullable": true }, "compositeRelations": { "type": "array", "items": { "$ref": "#/components/schemas/CompositeRelationDto" }, "nullable": true }, "parameters": { "type": "array", "items": { "$ref": "#/components/schemas/GrapeParameterDto" }, "nullable": true } }, "additionalProperties": false }, "CreateInfrastructureRequest": { "type": "object", "properties": { "connectionString": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "databaseType": { "$ref": "#/components/schemas/DataBaseTypes" }, "readOnly": { "type": "boolean" } }, "additionalProperties": false }, "CreateOrganizationRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "createDefaultResource": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "CreatePersonalAccessTokenRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "organizationId": { "type": "string", "nullable": true }, "customPrivileges": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "CreateProjectRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "sensitiveFieldsWorkflow": { "$ref": "#/components/schemas/SensitiveFieldsWorkflows" } }, "additionalProperties": false }, "CreateResourceRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "data": { "$ref": "#/components/schemas/IResourceItem" }, "scopeLevel": { "$ref": "#/components/schemas/ResourceScopeTypes" }, "projectsScope": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "CreateSensitiveFieldRequest": { "type": "object", "properties": { "tableName": { "type": "string", "nullable": true }, "fieldName": { "type": "string", "nullable": true }, "type": { "$ref": "#/components/schemas/SensitiveFieldTypes" }, "status": { "$ref": "#/components/schemas/SensitiveFieldStatusTypes" }, "origin": { "$ref": "#/components/schemas/SensitiveFieldOrigins" }, "piiScore": { "type": "number", "format": "double", "nullable": true }, "workflowStatus": { "$ref": "#/components/schemas/SensitiveFieldWorkflowStatusTypes" }, "rejectedReason": { "type": "string", "nullable": true }, "anonymizationRule": { "$ref": "#/components/schemas/IAnonymizationRule" } }, "additionalProperties": false }, "CreateTaskEventsRequest": { "type": "object", "properties": { "events": { "type": "array", "items": { "$ref": "#/components/schemas/TaskEventDto" }, "nullable": true } }, "additionalProperties": false }, "CustomAttributeData": { "type": "object", "properties": { "attributeType": { "$ref": "#/components/schemas/Type" }, "constructor": { "$ref": "#/components/schemas/ConstructorInfo" }, "constructorArguments": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttributeTypedArgument" }, "nullable": true, "readOnly": true }, "namedArguments": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttributeNamedArgument" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "CustomAttributeNamedArgument": { "type": "object", "properties": { "memberInfo": { "$ref": "#/components/schemas/MemberInfo" }, "typedValue": { "$ref": "#/components/schemas/CustomAttributeTypedArgument" }, "memberName": { "type": "string", "nullable": true, "readOnly": true }, "isField": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "CustomAttributeTypedArgument": { "type": "object", "properties": { "argumentType": { "$ref": "#/components/schemas/Type" }, "value": { "nullable": true } }, "additionalProperties": false }, "DataBaseTypes": { "enum": [ "SqlServer", "MySql" ], "type": "string" }, "DataTypeGroup": { "enum": [ "String", "Number", "Boolean", "Date", "Binary", "Unknown" ], "type": "string" }, "DatabaseDto": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "type": { "$ref": "#/components/schemas/DataBaseTypes" }, "environments": { "type": "array", "items": { "$ref": "#/components/schemas/DatabaseEnvironmentDto" }, "nullable": true } }, "additionalProperties": false }, "DatabaseDtoItemResponse": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/DatabaseDto" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/HateoasLink" }, "nullable": true } }, "additionalProperties": false }, "DatabaseDtoListItemResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/DatabaseDtoItemResponse" }, "nullable": true }, "totalCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "DatabaseEnvironmentDto": { "type": "object", "properties": { "environmentId": { "type": "string", "nullable": true }, "infrastructureId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DatabaseEnvironmentRequest": { "type": "object", "properties": { "environmentId": { "type": "string", "nullable": true }, "infrastructureId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DatabaseSchemaDto": { "type": "object", "properties": { "database": { "$ref": "#/components/schemas/DatabaseDto" }, "schema": { "$ref": "#/components/schemas/SchemaDto" } }, "additionalProperties": false }, "DatasetDto": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "status": { "$ref": "#/components/schemas/DatasetStatusTypes" }, "latestExecutionDate": { "type": "string", "format": "date-time", "nullable": true }, "size": { "type": "integer", "format": "int64", "nullable": true }, "parameters": { "type": "array", "items": { "$ref": "#/components/schemas/DatasetParameterValueDto" }, "nullable": true } }, "additionalProperties": false }, "DatasetDtoItemResponse": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/DatasetDto" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/HateoasLink" }, "nullable": true } }, "additionalProperties": false }, "DatasetDtoListItemResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/DatasetDtoItemResponse" }, "nullable": true }, "totalCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "DatasetParameterValueDto": { "type": "object", "properties": { "parmeterId": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DatasetStatusTypes": { "enum": [ "Empty", "InProgress", "Ready", "Error" ], "type": "string" }, "EnvironmentDto": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "tag": { "type": "string", "nullable": true }, "defaultAgentPool": { "type": "string", "nullable": true } }, "additionalProperties": false }, "EnvironmentDtoItemResponse": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/EnvironmentDto" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/HateoasLink" }, "nullable": true } }, "additionalProperties": false }, "EnvironmentDtoListItemResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/EnvironmentDtoItemResponse" }, "nullable": true }, "totalCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "EventAttributes": { "enum": [ "None", "SpecialName", "RTSpecialName" ], "type": "string" }, "EventInfo": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "readOnly": true }, "declaringType": { "$ref": "#/components/schemas/Type" }, "reflectedType": { "$ref": "#/components/schemas/Type" }, "module": { "$ref": "#/components/schemas/Module" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttributeData" }, "nullable": true, "readOnly": true }, "isCollectible": { "type": "boolean", "readOnly": true }, "metadataToken": { "type": "integer", "format": "int32", "readOnly": true }, "memberType": { "$ref": "#/components/schemas/MemberTypes" }, "attributes": { "$ref": "#/components/schemas/EventAttributes" }, "isSpecialName": { "type": "boolean", "readOnly": true }, "addMethod": { "$ref": "#/components/schemas/MethodInfo" }, "removeMethod": { "$ref": "#/components/schemas/MethodInfo" }, "raiseMethod": { "$ref": "#/components/schemas/MethodInfo" }, "isMulticast": { "type": "boolean", "readOnly": true }, "eventHandlerType": { "$ref": "#/components/schemas/Type" } }, "additionalProperties": false }, "Exception": { "type": "object", "properties": { "targetSite": { "$ref": "#/components/schemas/MethodBase" }, "message": { "type": "string", "nullable": true, "readOnly": true }, "data": { "type": "object", "additionalProperties": { }, "nullable": true, "readOnly": true }, "innerException": { "$ref": "#/components/schemas/Exception" }, "helpLink": { "type": "string", "nullable": true }, "source": { "type": "string", "nullable": true }, "hResult": { "type": "integer", "format": "int32" }, "stackTrace": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "ExtractDataRequest": { "type": "object", "properties": { "environmentId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ExtractSchemaRequest": { "type": "object", "properties": { "databaseEnvironmentId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "FieldAttributes": { "enum": [ "PrivateScope", "Private", "FamANDAssem", "Assembly", "Family", "FamORAssem", "Public", "FieldAccessMask", "Static", "InitOnly", "Literal", "NotSerialized", "HasFieldRVA", "SpecialName", "RTSpecialName", "HasFieldMarshal", "PinvokeImpl", "HasDefault", "ReservedMask" ], "type": "string" }, "FieldDto": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "dataType": { "type": "string", "nullable": true }, "innerDataType": { "type": "string", "nullable": true }, "dataTypeGroup": { "$ref": "#/components/schemas/DataTypeGroup" }, "nullable": { "type": "boolean" }, "isAutoGenerated": { "type": "boolean" }, "isComputed": { "type": "boolean" }, "isPrimaryKey": { "type": "boolean" } }, "additionalProperties": false }, "FieldInfo": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "readOnly": true }, "declaringType": { "$ref": "#/components/schemas/Type" }, "reflectedType": { "$ref": "#/components/schemas/Type" }, "module": { "$ref": "#/components/schemas/Module" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttributeData" }, "nullable": true, "readOnly": true }, "isCollectible": { "type": "boolean", "readOnly": true }, "metadataToken": { "type": "integer", "format": "int32", "readOnly": true }, "memberType": { "$ref": "#/components/schemas/MemberTypes" }, "attributes": { "$ref": "#/components/schemas/FieldAttributes" }, "fieldType": { "$ref": "#/components/schemas/Type" }, "isInitOnly": { "type": "boolean", "readOnly": true }, "isLiteral": { "type": "boolean", "readOnly": true }, "isNotSerialized": { "type": "boolean", "readOnly": true, "deprecated": true }, "isPinvokeImpl": { "type": "boolean", "readOnly": true }, "isSpecialName": { "type": "boolean", "readOnly": true }, "isStatic": { "type": "boolean", "readOnly": true }, "isAssembly": { "type": "boolean", "readOnly": true }, "isFamily": { "type": "boolean", "readOnly": true }, "isFamilyAndAssembly": { "type": "boolean", "readOnly": true }, "isFamilyOrAssembly": { "type": "boolean", "readOnly": true }, "isPrivate": { "type": "boolean", "readOnly": true }, "isPublic": { "type": "boolean", "readOnly": true }, "isSecurityCritical": { "type": "boolean", "readOnly": true }, "isSecuritySafeCritical": { "type": "boolean", "readOnly": true }, "isSecurityTransparent": { "type": "boolean", "readOnly": true }, "fieldHandle": { "$ref": "#/components/schemas/RuntimeFieldHandle" } }, "additionalProperties": false }, "FilterLogicOperators": { "enum": [ "AND", "OR" ], "type": "string" }, "FilterRuleset": { "type": "object", "properties": { "filterType": { "type": "string", "nullable": true, "readOnly": true }, "condition": { "$ref": "#/components/schemas/FilterLogicOperators" }, "rules": { "type": "array", "items": { "$ref": "#/components/schemas/IFilterComponent" }, "nullable": true } }, "additionalProperties": false }, "GenericParameterAttributes": { "enum": [ "None", "Covariant", "Contravariant", "VarianceMask", "ReferenceTypeConstraint", "NotNullableValueTypeConstraint", "DefaultConstructorConstraint", "SpecialConstraintMask" ], "type": "string" }, "GrapeDetailDto": { "type": "object", "properties": { "tableName": { "type": "string", "nullable": true }, "databaseId": { "type": "string", "nullable": true }, "filter": { "$ref": "#/components/schemas/FilterRuleset" }, "anonymisers": { "type": "array", "items": { "$ref": "#/components/schemas/IAnonymiserComponent" }, "nullable": true }, "sampling": { "$ref": "#/components/schemas/SamplingModel" }, "tableStyle": { "$ref": "#/components/schemas/TableStyle" }, "mergeOptions": { "$ref": "#/components/schemas/GrapeMergeOptionsDto" } }, "additionalProperties": false }, "GrapeDto": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "details": { "type": "array", "items": { "$ref": "#/components/schemas/GrapeDetailDto" }, "nullable": true }, "databases": { "type": "array", "items": { "$ref": "#/components/schemas/DatabaseSchemaDto" }, "nullable": true }, "compositeRelations": { "type": "array", "items": { "$ref": "#/components/schemas/CompositeRelationDto" }, "nullable": true }, "parameters": { "type": "array", "items": { "$ref": "#/components/schemas/GrapeParameterDto" }, "nullable": true }, "latestModifiedDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "GrapeDtoItemResponse": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/GrapeDto" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/HateoasLink" }, "nullable": true } }, "additionalProperties": false }, "GrapeDtoListItemResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/GrapeDtoItemResponse" }, "nullable": true }, "totalCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "GrapeMergeOptionsDto": { "type": "object", "properties": { "mergeMode": { "$ref": "#/components/schemas/TableMergeModes" }, "basedOnFields": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "GrapeMergeOptionsModel": { "type": "object", "properties": { "mergeMode": { "$ref": "#/components/schemas/TableMergeModes" }, "basedOnFields": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "GrapeParameterDto": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "dataType": { "$ref": "#/components/schemas/DataTypeGroup" }, "defaultValue": { "type": "string", "nullable": true } }, "additionalProperties": false }, "HateoasLink": { "type": "object", "properties": { "relation": { "type": "string", "nullable": true }, "uri": { "type": "string", "nullable": true }, "method": { "type": "string", "nullable": true } }, "additionalProperties": false }, "IActionResult": { "type": "object", "additionalProperties": false }, "IActionResultTask": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "exception": { "$ref": "#/components/schemas/AggregateException" }, "status": { "$ref": "#/components/schemas/TaskStatus" }, "isCanceled": { "type": "boolean", "readOnly": true }, "isCompleted": { "type": "boolean", "readOnly": true }, "isCompletedSuccessfully": { "type": "boolean", "readOnly": true }, "creationOptions": { "$ref": "#/components/schemas/TaskCreationOptions" }, "asyncState": { "nullable": true, "readOnly": true }, "isFaulted": { "type": "boolean", "readOnly": true }, "result": { "$ref": "#/components/schemas/IActionResult" } }, "additionalProperties": false }, "IAnonymiserComponent": { "type": "object", "properties": { "type": { "type": "string", "nullable": true, "readOnly": true }, "field": { "type": "string", "nullable": true } }, "additionalProperties": false }, "IAnonymizationRule": { "type": "object", "properties": { "type": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "ICustomAttributeProvider": { "type": "object", "additionalProperties": false }, "IFilterComponent": { "type": "object", "properties": { "filterType": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "IResourceItem": { "type": "object", "properties": { "resourceType": { "$ref": "#/components/schemas/ResourceTypes" } }, "additionalProperties": false }, "ImportDatasetRequest": { "type": "object", "properties": { "targetEnvironmentId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "InfrastructureDto": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "connectionString": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "databaseType": { "$ref": "#/components/schemas/DataBaseTypes" }, "readOnly": { "type": "boolean" } }, "additionalProperties": false }, "InfrastructureDtoItemResponse": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/InfrastructureDto" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/HateoasLink" }, "nullable": true } }, "additionalProperties": false }, "InfrastructureDtoListItemResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/InfrastructureDtoItemResponse" }, "nullable": true }, "totalCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "IntPtr": { "type": "object", "additionalProperties": false }, "JoinOrganizationRequest": { "type": "object", "properties": { "email": { "type": "string", "nullable": true }, "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "defaultRole": { "type": "string", "nullable": true } }, "additionalProperties": false }, "LayoutKind": { "enum": [ "Sequential", "Explicit", "Auto" ], "type": "string" }, "MemberInfo": { "type": "object", "properties": { "memberType": { "$ref": "#/components/schemas/MemberTypes" }, "name": { "type": "string", "nullable": true, "readOnly": true }, "declaringType": { "$ref": "#/components/schemas/Type" }, "reflectedType": { "$ref": "#/components/schemas/Type" }, "module": { "$ref": "#/components/schemas/Module" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttributeData" }, "nullable": true, "readOnly": true }, "isCollectible": { "type": "boolean", "readOnly": true }, "metadataToken": { "type": "integer", "format": "int32", "readOnly": true } }, "additionalProperties": false }, "MemberTypes": { "enum": [ "Constructor", "Event", "Field", "Method", "Property", "TypeInfo", "Custom", "NestedType", "All" ], "type": "string" }, "MethodAttributes": { "enum": [ "PrivateScope", "Private", "FamANDAssem", "Assembly", "Family", "FamORAssem", "Public", "MemberAccessMask", "UnmanagedExport", "Static", "Final", "Virtual", "HideBySig", "NewSlot", "CheckAccessOnOverride", "Abstract", "SpecialName", "RTSpecialName", "PinvokeImpl", "HasSecurity", "RequireSecObject", "ReservedMask" ], "type": "string" }, "MethodBase": { "type": "object", "properties": { "memberType": { "$ref": "#/components/schemas/MemberTypes" }, "name": { "type": "string", "nullable": true, "readOnly": true }, "declaringType": { "$ref": "#/components/schemas/Type" }, "reflectedType": { "$ref": "#/components/schemas/Type" }, "module": { "$ref": "#/components/schemas/Module" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttributeData" }, "nullable": true, "readOnly": true }, "isCollectible": { "type": "boolean", "readOnly": true }, "metadataToken": { "type": "integer", "format": "int32", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/MethodAttributes" }, "methodImplementationFlags": { "$ref": "#/components/schemas/MethodImplAttributes" }, "callingConvention": { "$ref": "#/components/schemas/CallingConventions" }, "isAbstract": { "type": "boolean", "readOnly": true }, "isConstructor": { "type": "boolean", "readOnly": true }, "isFinal": { "type": "boolean", "readOnly": true }, "isHideBySig": { "type": "boolean", "readOnly": true }, "isSpecialName": { "type": "boolean", "readOnly": true }, "isStatic": { "type": "boolean", "readOnly": true }, "isVirtual": { "type": "boolean", "readOnly": true }, "isAssembly": { "type": "boolean", "readOnly": true }, "isFamily": { "type": "boolean", "readOnly": true }, "isFamilyAndAssembly": { "type": "boolean", "readOnly": true }, "isFamilyOrAssembly": { "type": "boolean", "readOnly": true }, "isPrivate": { "type": "boolean", "readOnly": true }, "isPublic": { "type": "boolean", "readOnly": true }, "isConstructedGenericMethod": { "type": "boolean", "readOnly": true }, "isGenericMethod": { "type": "boolean", "readOnly": true }, "isGenericMethodDefinition": { "type": "boolean", "readOnly": true }, "containsGenericParameters": { "type": "boolean", "readOnly": true }, "methodHandle": { "$ref": "#/components/schemas/RuntimeMethodHandle" }, "isSecurityCritical": { "type": "boolean", "readOnly": true }, "isSecuritySafeCritical": { "type": "boolean", "readOnly": true }, "isSecurityTransparent": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "MethodImplAttributes": { "enum": [ "IL", "Native", "OPTIL", "CodeTypeMask", "ManagedMask", "NoInlining", "ForwardRef", "Synchronized", "NoOptimization", "PreserveSig", "AggressiveInlining", "AggressiveOptimization", "InternalCall", "MaxMethodImplVal" ], "type": "string" }, "MethodInfo": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "readOnly": true }, "declaringType": { "$ref": "#/components/schemas/Type" }, "reflectedType": { "$ref": "#/components/schemas/Type" }, "module": { "$ref": "#/components/schemas/Module" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttributeData" }, "nullable": true, "readOnly": true }, "isCollectible": { "type": "boolean", "readOnly": true }, "metadataToken": { "type": "integer", "format": "int32", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/MethodAttributes" }, "methodImplementationFlags": { "$ref": "#/components/schemas/MethodImplAttributes" }, "callingConvention": { "$ref": "#/components/schemas/CallingConventions" }, "isAbstract": { "type": "boolean", "readOnly": true }, "isConstructor": { "type": "boolean", "readOnly": true }, "isFinal": { "type": "boolean", "readOnly": true }, "isHideBySig": { "type": "boolean", "readOnly": true }, "isSpecialName": { "type": "boolean", "readOnly": true }, "isStatic": { "type": "boolean", "readOnly": true }, "isVirtual": { "type": "boolean", "readOnly": true }, "isAssembly": { "type": "boolean", "readOnly": true }, "isFamily": { "type": "boolean", "readOnly": true }, "isFamilyAndAssembly": { "type": "boolean", "readOnly": true }, "isFamilyOrAssembly": { "type": "boolean", "readOnly": true }, "isPrivate": { "type": "boolean", "readOnly": true }, "isPublic": { "type": "boolean", "readOnly": true }, "isConstructedGenericMethod": { "type": "boolean", "readOnly": true }, "isGenericMethod": { "type": "boolean", "readOnly": true }, "isGenericMethodDefinition": { "type": "boolean", "readOnly": true }, "containsGenericParameters": { "type": "boolean", "readOnly": true }, "methodHandle": { "$ref": "#/components/schemas/RuntimeMethodHandle" }, "isSecurityCritical": { "type": "boolean", "readOnly": true }, "isSecuritySafeCritical": { "type": "boolean", "readOnly": true }, "isSecurityTransparent": { "type": "boolean", "readOnly": true }, "memberType": { "$ref": "#/components/schemas/MemberTypes" }, "returnParameter": { "$ref": "#/components/schemas/ParameterInfo" }, "returnType": { "$ref": "#/components/schemas/Type" }, "returnTypeCustomAttributes": { "$ref": "#/components/schemas/ICustomAttributeProvider" } }, "additionalProperties": false }, "Module": { "type": "object", "properties": { "assembly": { "$ref": "#/components/schemas/Assembly" }, "fullyQualifiedName": { "type": "string", "nullable": true, "readOnly": true }, "name": { "type": "string", "nullable": true, "readOnly": true }, "mdStreamVersion": { "type": "integer", "format": "int32", "readOnly": true }, "moduleVersionId": { "type": "string", "format": "uuid", "readOnly": true }, "scopeName": { "type": "string", "nullable": true, "readOnly": true }, "moduleHandle": { "$ref": "#/components/schemas/ModuleHandle" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttributeData" }, "nullable": true, "readOnly": true }, "metadataToken": { "type": "integer", "format": "int32", "readOnly": true } }, "additionalProperties": false }, "ModuleHandle": { "type": "object", "properties": { "mdStreamVersion": { "type": "integer", "format": "int32", "readOnly": true } }, "additionalProperties": false }, "NegotiationResponse": { "type": "object", "properties": { "url": { "type": "string", "nullable": true }, "accessToken": { "type": "string", "nullable": true }, "connectionId": { "type": "string", "nullable": true }, "connectionToken": { "type": "string", "nullable": true }, "version": { "type": "integer", "format": "int32" }, "availableTransports": { "type": "array", "items": { "$ref": "#/components/schemas/AvailableTransport" }, "nullable": true }, "error": { "type": "string", "nullable": true }, "useStatefulReconnect": { "type": "boolean" } }, "additionalProperties": false }, "NotificationChannel": { "enum": [ "InApp", "InMail" ], "type": "string" }, "NotificationDto": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "date": { "type": "string", "format": "date-time" }, "targetUser": { "type": "string", "nullable": true }, "targetTask": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "channel": { "$ref": "#/components/schemas/NotificationChannel" }, "status": { "$ref": "#/components/schemas/NotificationStatus" }, "organizationId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "NotificationDtoItemResponse": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/NotificationDto" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/HateoasLink" }, "nullable": true } }, "additionalProperties": false }, "NotificationDtoListItemResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationDtoItemResponse" }, "nullable": true }, "totalCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "NotificationStatus": { "enum": [ "Created", "Archived" ], "type": "string" }, "OrganizationDto": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OrganizationDtoItemResponse": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/OrganizationDto" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/HateoasLink" }, "nullable": true } }, "additionalProperties": false }, "OrganizationDtoListItemResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/OrganizationDtoItemResponse" }, "nullable": true }, "totalCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ParameterAttributes": { "enum": [ "None", "In", "Out", "Lcid", "Retval", "Optional", "HasDefault", "HasFieldMarshal", "Reserved3", "Reserved4", "ReservedMask" ], "type": "string" }, "ParameterInfo": { "type": "object", "properties": { "attributes": { "$ref": "#/components/schemas/ParameterAttributes" }, "member": { "$ref": "#/components/schemas/MemberInfo" }, "name": { "type": "string", "nullable": true, "readOnly": true }, "parameterType": { "$ref": "#/components/schemas/Type" }, "position": { "type": "integer", "format": "int32", "readOnly": true }, "isIn": { "type": "boolean", "readOnly": true }, "isLcid": { "type": "boolean", "readOnly": true }, "isOptional": { "type": "boolean", "readOnly": true }, "isOut": { "type": "boolean", "readOnly": true }, "isRetval": { "type": "boolean", "readOnly": true }, "defaultValue": { "nullable": true, "readOnly": true }, "rawDefaultValue": { "nullable": true, "readOnly": true }, "hasDefaultValue": { "type": "boolean", "readOnly": true }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttributeData" }, "nullable": true, "readOnly": true }, "metadataToken": { "type": "integer", "format": "int32", "readOnly": true } }, "additionalProperties": false }, "PermissionTypes": { "enum": [ "Role", "Right" ], "type": "string" }, "PersonalAccessTokenDto": { "type": "object", "properties": { "plainTextToken": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PersonalAccessTokenDtoItemResponse": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/PersonalAccessTokenDto" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/HateoasLink" }, "nullable": true } }, "additionalProperties": false }, "PersonalAccessTokenInfoDto": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "organizationId": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time" }, "status": { "$ref": "#/components/schemas/PersonalAccessTokenStatusTypes" } }, "additionalProperties": false }, "PersonalAccessTokenInfoDtoItemResponse": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/PersonalAccessTokenInfoDto" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/HateoasLink" }, "nullable": true } }, "additionalProperties": false }, "PersonalAccessTokenInfoDtoListItemResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PersonalAccessTokenInfoDtoItemResponse" }, "nullable": true }, "totalCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "PersonalAccessTokenStatusTypes": { "enum": [ "Active", "Revoked" ], "type": "string" }, "Point": { "type": "object", "properties": { "isEmpty": { "type": "boolean", "readOnly": true }, "x": { "type": "integer", "format": "int32" }, "y": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "PrivilegeDto": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "type": { "$ref": "#/components/schemas/PermissionTypes" } }, "additionalProperties": false }, "ProjectDto": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "sensitiveFieldsWorkflow": { "$ref": "#/components/schemas/SensitiveFieldsWorkflows" } }, "additionalProperties": false }, "ProjectDtoItemResponse": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/ProjectDto" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/HateoasLink" }, "nullable": true } }, "additionalProperties": false }, "ProjectDtoListItemResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectDtoItemResponse" }, "nullable": true }, "totalCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ProjectStatsDto": { "type": "object", "properties": { "databasesCount": { "type": "integer", "format": "int32" }, "grapesCount": { "type": "integer", "format": "int32" }, "datasetsCount": { "type": "integer", "format": "int32" }, "datasetsSize": { "type": "integer", "format": "int64", "nullable": true }, "tasksSuccessRate": { "type": "number", "format": "double" }, "sensitiveFieldsCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ProjectStatsDtoItemResponse": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/ProjectStatsDto" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/HateoasLink" }, "nullable": true } }, "additionalProperties": false }, "PropertyAttributes": { "enum": [ "None", "SpecialName", "RTSpecialName", "HasDefault", "Reserved2", "Reserved3", "Reserved4", "ReservedMask" ], "type": "string" }, "PropertyInfo": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "readOnly": true }, "declaringType": { "$ref": "#/components/schemas/Type" }, "reflectedType": { "$ref": "#/components/schemas/Type" }, "module": { "$ref": "#/components/schemas/Module" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttributeData" }, "nullable": true, "readOnly": true }, "isCollectible": { "type": "boolean", "readOnly": true }, "metadataToken": { "type": "integer", "format": "int32", "readOnly": true }, "memberType": { "$ref": "#/components/schemas/MemberTypes" }, "propertyType": { "$ref": "#/components/schemas/Type" }, "attributes": { "$ref": "#/components/schemas/PropertyAttributes" }, "isSpecialName": { "type": "boolean", "readOnly": true }, "canRead": { "type": "boolean", "readOnly": true }, "canWrite": { "type": "boolean", "readOnly": true }, "getMethod": { "$ref": "#/components/schemas/MethodInfo" }, "setMethod": { "$ref": "#/components/schemas/MethodInfo" } }, "additionalProperties": false }, "RecognizeSensitiveFieldsRequest": { "type": "object", "properties": { "databaseEnvironmentId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RelationColumnMappingDto": { "type": "object", "properties": { "fromColumn": { "type": "string", "nullable": true }, "toColumn": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RelationDto": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "fromTable": { "type": "string", "nullable": true }, "toTable": { "type": "string", "nullable": true }, "columnMappings": { "type": "array", "items": { "$ref": "#/components/schemas/RelationColumnMappingDto" }, "nullable": true } }, "additionalProperties": false }, "ResourceDto": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "data": { "$ref": "#/components/schemas/IResourceItem" }, "scope": { "$ref": "#/components/schemas/ResourceScopeDto" } }, "additionalProperties": false }, "ResourceDtoItemResponse": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/ResourceDto" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/HateoasLink" }, "nullable": true } }, "additionalProperties": false }, "ResourceDtoListItemResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceDtoItemResponse" }, "nullable": true }, "totalCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ResourceScopeDto": { "type": "object", "properties": { "level": { "$ref": "#/components/schemas/ResourceScopeTypes" }, "projectsScope": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "ResourceScopeTypes": { "enum": [ "Global", "Organization", "Project" ], "type": "string" }, "ResourceTypes": { "enum": [ "VALUE", "KEY_VALUE" ], "type": "string" }, "RootResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/HateoasLink" }, "nullable": true } }, "additionalProperties": false }, "RuntimeFieldHandle": { "type": "object", "properties": { "value": { "$ref": "#/components/schemas/IntPtr" } }, "additionalProperties": false }, "RuntimeMethodHandle": { "type": "object", "properties": { "value": { "$ref": "#/components/schemas/IntPtr" } }, "additionalProperties": false }, "RuntimeTypeHandle": { "type": "object", "properties": { "value": { "$ref": "#/components/schemas/IntPtr" } }, "additionalProperties": false }, "SamplingModel": { "type": "object", "properties": { "take": { "type": "string", "nullable": true }, "sort": { "type": "array", "items": { "$ref": "#/components/schemas/SortDetailModel" }, "nullable": true } }, "additionalProperties": false }, "SchemaDto": { "type": "object", "properties": { "tables": { "type": "array", "items": { "$ref": "#/components/schemas/TableDto" }, "nullable": true }, "relations": { "type": "array", "items": { "$ref": "#/components/schemas/RelationDto" }, "nullable": true }, "uniqueIndexes": { "type": "array", "items": { "$ref": "#/components/schemas/UniqueIndexDto" }, "nullable": true } }, "additionalProperties": false }, "SchemaDtoItemResponse": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/SchemaDto" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/HateoasLink" }, "nullable": true } }, "additionalProperties": false }, "SecurityRuleSet": { "enum": [ "None", "Level1", "Level2" ], "type": "string" }, "SensitiveFieldDto": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "tableName": { "type": "string", "nullable": true }, "fieldName": { "type": "string", "nullable": true }, "type": { "$ref": "#/components/schemas/SensitiveFieldTypes" }, "status": { "$ref": "#/components/schemas/SensitiveFieldStatusTypes" }, "origin": { "$ref": "#/components/schemas/SensitiveFieldOrigins" }, "piiScore": { "type": "number", "format": "double", "nullable": true }, "workflowStatus": { "$ref": "#/components/schemas/SensitiveFieldWorkflowStatusTypes" }, "rejectedReason": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time" }, "anonymizationRule": { "$ref": "#/components/schemas/IAnonymizationRule" } }, "additionalProperties": false }, "SensitiveFieldDtoItemResponse": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/SensitiveFieldDto" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/HateoasLink" }, "nullable": true } }, "additionalProperties": false }, "SensitiveFieldDtoListItemResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/SensitiveFieldDtoItemResponse" }, "nullable": true }, "totalCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "SensitiveFieldOrigins": { "enum": [ "Auto", "Manuel" ], "type": "string" }, "SensitiveFieldStatusTypes": { "enum": [ "New", "Validated", "FalsePositive" ], "type": "string" }, "SensitiveFieldTypes": { "enum": [ "EmailAddress", "IPAddress", "MacAddress", "PhoneNumber", "FirstName", "LastName", "SensitiveDate", "CreditCard", "Iban", "Address", "PostalCode", "Unknown" ], "type": "string" }, "SensitiveFieldWorkflowStatusTypes": { "enum": [ "ReadyForReview", "Approved", "Rejected" ], "type": "string" }, "SensitiveFieldsWorkflows": { "enum": [ "Straightforward", "Review" ], "type": "string" }, "SortDetailModel": { "type": "object", "properties": { "order": { "type": "integer", "format": "int32" }, "field": { "type": "string", "nullable": true }, "direction": { "type": "string", "nullable": true } }, "additionalProperties": false }, "StructLayoutAttribute": { "type": "object", "properties": { "typeId": { "nullable": true, "readOnly": true }, "value": { "$ref": "#/components/schemas/LayoutKind" } }, "additionalProperties": false }, "TableDto": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "fields": { "type": "array", "items": { "$ref": "#/components/schemas/FieldDto" }, "nullable": true } }, "additionalProperties": false }, "TableMergeModes": { "enum": [ "Insert", "Merge" ], "type": "string" }, "TableStyle": { "type": "object", "properties": { "position": { "$ref": "#/components/schemas/Point" }, "color": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TaskCreationOptions": { "enum": [ "None", "PreferFairness", "LongRunning", "AttachedToParent", "DenyChildAttach", "HideScheduler", "RunContinuationsAsynchronously" ], "type": "string" }, "TaskDto": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "projectId": { "type": "string", "nullable": true }, "type": { "$ref": "#/components/schemas/TasksTypes" }, "ownerId": { "type": "string", "nullable": true }, "taskTarget": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "createdDate": { "type": "string", "format": "date-time" }, "lastUpdatedDate": { "type": "string", "format": "date-time" }, "processingStartDate": { "type": "string", "format": "date-time", "nullable": true }, "status": { "$ref": "#/components/schemas/TasksStatus" }, "errorMessage": { "type": "string", "nullable": true }, "duration": { "type": "integer", "format": "int64", "nullable": true } }, "additionalProperties": false }, "TaskDtoItemResponse": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/TaskDto" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/HateoasLink" }, "nullable": true } }, "additionalProperties": false }, "TaskDtoListItemResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/TaskDtoItemResponse" }, "nullable": true }, "totalCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "TaskEventDto": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true }, "eventDate": { "type": "string", "format": "date-time" }, "status": { "$ref": "#/components/schemas/TaskEventStatusTypes" }, "duration": { "type": "integer", "format": "int64" }, "errorMessage": { "type": "string", "nullable": true }, "errorDetails": { "type": "string", "nullable": true }, "group": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "TaskEventDtoItemResponse": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/TaskEventDto" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/HateoasLink" }, "nullable": true } }, "additionalProperties": false }, "TaskEventDtoListItemResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/TaskEventDtoItemResponse" }, "nullable": true }, "totalCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "TaskEventStatusTypes": { "enum": [ "Success", "Error" ], "type": "string" }, "TaskStatus": { "enum": [ "Created", "WaitingForActivation", "WaitingToRun", "Running", "WaitingForChildrenToComplete", "RanToCompletion", "Canceled", "Faulted" ], "type": "string" }, "TasksStatus": { "enum": [ "Created", "InProgress", "Canceled", "Error", "Completed" ], "type": "string" }, "TasksTypes": { "enum": [ "DatabaseReadSchema", "ExtratData", "ImportData", "RecognizeSensitiveFields", "UpgradeAgent" ], "type": "string" }, "Type": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "readOnly": true }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttributeData" }, "nullable": true, "readOnly": true }, "isCollectible": { "type": "boolean", "readOnly": true }, "metadataToken": { "type": "integer", "format": "int32", "readOnly": true }, "isInterface": { "type": "boolean", "readOnly": true }, "memberType": { "$ref": "#/components/schemas/MemberTypes" }, "namespace": { "type": "string", "nullable": true, "readOnly": true }, "assemblyQualifiedName": { "type": "string", "nullable": true, "readOnly": true }, "fullName": { "type": "string", "nullable": true, "readOnly": true }, "assembly": { "$ref": "#/components/schemas/Assembly" }, "module": { "$ref": "#/components/schemas/Module" }, "isNested": { "type": "boolean", "readOnly": true }, "declaringType": { "$ref": "#/components/schemas/Type" }, "declaringMethod": { "$ref": "#/components/schemas/MethodBase" }, "reflectedType": { "$ref": "#/components/schemas/Type" }, "underlyingSystemType": { "$ref": "#/components/schemas/Type" }, "isTypeDefinition": { "type": "boolean", "readOnly": true }, "isArray": { "type": "boolean", "readOnly": true }, "isByRef": { "type": "boolean", "readOnly": true }, "isPointer": { "type": "boolean", "readOnly": true }, "isConstructedGenericType": { "type": "boolean", "readOnly": true }, "isGenericParameter": { "type": "boolean", "readOnly": true }, "isGenericTypeParameter": { "type": "boolean", "readOnly": true }, "isGenericMethodParameter": { "type": "boolean", "readOnly": true }, "isGenericType": { "type": "boolean", "readOnly": true }, "isGenericTypeDefinition": { "type": "boolean", "readOnly": true }, "isSZArray": { "type": "boolean", "readOnly": true }, "isVariableBoundArray": { "type": "boolean", "readOnly": true }, "isByRefLike": { "type": "boolean", "readOnly": true }, "isFunctionPointer": { "type": "boolean", "readOnly": true }, "isUnmanagedFunctionPointer": { "type": "boolean", "readOnly": true }, "hasElementType": { "type": "boolean", "readOnly": true }, "genericTypeArguments": { "type": "array", "items": { "$ref": "#/components/schemas/Type" }, "nullable": true, "readOnly": true }, "genericParameterPosition": { "type": "integer", "format": "int32", "readOnly": true }, "genericParameterAttributes": { "$ref": "#/components/schemas/GenericParameterAttributes" }, "attributes": { "$ref": "#/components/schemas/TypeAttributes" }, "isAbstract": { "type": "boolean", "readOnly": true }, "isImport": { "type": "boolean", "readOnly": true }, "isSealed": { "type": "boolean", "readOnly": true }, "isSpecialName": { "type": "boolean", "readOnly": true }, "isClass": { "type": "boolean", "readOnly": true }, "isNestedAssembly": { "type": "boolean", "readOnly": true }, "isNestedFamANDAssem": { "type": "boolean", "readOnly": true }, "isNestedFamily": { "type": "boolean", "readOnly": true }, "isNestedFamORAssem": { "type": "boolean", "readOnly": true }, "isNestedPrivate": { "type": "boolean", "readOnly": true }, "isNestedPublic": { "type": "boolean", "readOnly": true }, "isNotPublic": { "type": "boolean", "readOnly": true }, "isPublic": { "type": "boolean", "readOnly": true }, "isAutoLayout": { "type": "boolean", "readOnly": true }, "isExplicitLayout": { "type": "boolean", "readOnly": true }, "isLayoutSequential": { "type": "boolean", "readOnly": true }, "isAnsiClass": { "type": "boolean", "readOnly": true }, "isAutoClass": { "type": "boolean", "readOnly": true }, "isUnicodeClass": { "type": "boolean", "readOnly": true }, "isCOMObject": { "type": "boolean", "readOnly": true }, "isContextful": { "type": "boolean", "readOnly": true }, "isEnum": { "type": "boolean", "readOnly": true }, "isMarshalByRef": { "type": "boolean", "readOnly": true }, "isPrimitive": { "type": "boolean", "readOnly": true }, "isValueType": { "type": "boolean", "readOnly": true }, "isSignatureType": { "type": "boolean", "readOnly": true }, "isSecurityCritical": { "type": "boolean", "readOnly": true }, "isSecuritySafeCritical": { "type": "boolean", "readOnly": true }, "isSecurityTransparent": { "type": "boolean", "readOnly": true }, "structLayoutAttribute": { "$ref": "#/components/schemas/StructLayoutAttribute" }, "typeInitializer": { "$ref": "#/components/schemas/ConstructorInfo" }, "typeHandle": { "$ref": "#/components/schemas/RuntimeTypeHandle" }, "guid": { "type": "string", "format": "uuid", "readOnly": true }, "baseType": { "$ref": "#/components/schemas/Type" }, "isSerializable": { "type": "boolean", "readOnly": true, "deprecated": true }, "containsGenericParameters": { "type": "boolean", "readOnly": true }, "isVisible": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "TypeAttributes": { "enum": [ "NotPublic", "Public", "NestedPublic", "NestedPrivate", "NestedFamily", "NestedAssembly", "NestedFamANDAssem", "VisibilityMask", "SequentialLayout", "ExplicitLayout", "LayoutMask", "Interface", "Abstract", "Sealed", "SpecialName", "RTSpecialName", "Import", "Serializable", "WindowsRuntime", "UnicodeClass", "AutoClass", "StringFormatMask", "HasSecurity", "ReservedMask", "BeforeFieldInit", "CustomFormatMask" ], "type": "string" }, "TypeInfo": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "readOnly": true }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttributeData" }, "nullable": true, "readOnly": true }, "isCollectible": { "type": "boolean", "readOnly": true }, "metadataToken": { "type": "integer", "format": "int32", "readOnly": true }, "isInterface": { "type": "boolean", "readOnly": true }, "memberType": { "$ref": "#/components/schemas/MemberTypes" }, "namespace": { "type": "string", "nullable": true, "readOnly": true }, "assemblyQualifiedName": { "type": "string", "nullable": true, "readOnly": true }, "fullName": { "type": "string", "nullable": true, "readOnly": true }, "assembly": { "$ref": "#/components/schemas/Assembly" }, "module": { "$ref": "#/components/schemas/Module" }, "isNested": { "type": "boolean", "readOnly": true }, "declaringType": { "$ref": "#/components/schemas/Type" }, "declaringMethod": { "$ref": "#/components/schemas/MethodBase" }, "reflectedType": { "$ref": "#/components/schemas/Type" }, "underlyingSystemType": { "$ref": "#/components/schemas/Type" }, "isTypeDefinition": { "type": "boolean", "readOnly": true }, "isArray": { "type": "boolean", "readOnly": true }, "isByRef": { "type": "boolean", "readOnly": true }, "isPointer": { "type": "boolean", "readOnly": true }, "isConstructedGenericType": { "type": "boolean", "readOnly": true }, "isGenericParameter": { "type": "boolean", "readOnly": true }, "isGenericTypeParameter": { "type": "boolean", "readOnly": true }, "isGenericMethodParameter": { "type": "boolean", "readOnly": true }, "isGenericType": { "type": "boolean", "readOnly": true }, "isGenericTypeDefinition": { "type": "boolean", "readOnly": true }, "isSZArray": { "type": "boolean", "readOnly": true }, "isVariableBoundArray": { "type": "boolean", "readOnly": true }, "isByRefLike": { "type": "boolean", "readOnly": true }, "isFunctionPointer": { "type": "boolean", "readOnly": true }, "isUnmanagedFunctionPointer": { "type": "boolean", "readOnly": true }, "hasElementType": { "type": "boolean", "readOnly": true }, "genericTypeArguments": { "type": "array", "items": { "$ref": "#/components/schemas/Type" }, "nullable": true, "readOnly": true }, "genericParameterPosition": { "type": "integer", "format": "int32", "readOnly": true }, "genericParameterAttributes": { "$ref": "#/components/schemas/GenericParameterAttributes" }, "attributes": { "$ref": "#/components/schemas/TypeAttributes" }, "isAbstract": { "type": "boolean", "readOnly": true }, "isImport": { "type": "boolean", "readOnly": true }, "isSealed": { "type": "boolean", "readOnly": true }, "isSpecialName": { "type": "boolean", "readOnly": true }, "isClass": { "type": "boolean", "readOnly": true }, "isNestedAssembly": { "type": "boolean", "readOnly": true }, "isNestedFamANDAssem": { "type": "boolean", "readOnly": true }, "isNestedFamily": { "type": "boolean", "readOnly": true }, "isNestedFamORAssem": { "type": "boolean", "readOnly": true }, "isNestedPrivate": { "type": "boolean", "readOnly": true }, "isNestedPublic": { "type": "boolean", "readOnly": true }, "isNotPublic": { "type": "boolean", "readOnly": true }, "isPublic": { "type": "boolean", "readOnly": true }, "isAutoLayout": { "type": "boolean", "readOnly": true }, "isExplicitLayout": { "type": "boolean", "readOnly": true }, "isLayoutSequential": { "type": "boolean", "readOnly": true }, "isAnsiClass": { "type": "boolean", "readOnly": true }, "isAutoClass": { "type": "boolean", "readOnly": true }, "isUnicodeClass": { "type": "boolean", "readOnly": true }, "isCOMObject": { "type": "boolean", "readOnly": true }, "isContextful": { "type": "boolean", "readOnly": true }, "isEnum": { "type": "boolean", "readOnly": true }, "isMarshalByRef": { "type": "boolean", "readOnly": true }, "isPrimitive": { "type": "boolean", "readOnly": true }, "isValueType": { "type": "boolean", "readOnly": true }, "isSignatureType": { "type": "boolean", "readOnly": true }, "isSecurityCritical": { "type": "boolean", "readOnly": true }, "isSecuritySafeCritical": { "type": "boolean", "readOnly": true }, "isSecurityTransparent": { "type": "boolean", "readOnly": true }, "structLayoutAttribute": { "$ref": "#/components/schemas/StructLayoutAttribute" }, "typeInitializer": { "$ref": "#/components/schemas/ConstructorInfo" }, "typeHandle": { "$ref": "#/components/schemas/RuntimeTypeHandle" }, "guid": { "type": "string", "format": "uuid", "readOnly": true }, "baseType": { "$ref": "#/components/schemas/Type" }, "isSerializable": { "type": "boolean", "readOnly": true, "deprecated": true }, "containsGenericParameters": { "type": "boolean", "readOnly": true }, "isVisible": { "type": "boolean", "readOnly": true }, "genericTypeParameters": { "type": "array", "items": { "$ref": "#/components/schemas/Type" }, "nullable": true, "readOnly": true }, "declaredConstructors": { "type": "array", "items": { "$ref": "#/components/schemas/ConstructorInfo" }, "nullable": true, "readOnly": true }, "declaredEvents": { "type": "array", "items": { "$ref": "#/components/schemas/EventInfo" }, "nullable": true, "readOnly": true }, "declaredFields": { "type": "array", "items": { "$ref": "#/components/schemas/FieldInfo" }, "nullable": true, "readOnly": true }, "declaredMembers": { "type": "array", "items": { "$ref": "#/components/schemas/MemberInfo" }, "nullable": true, "readOnly": true }, "declaredMethods": { "type": "array", "items": { "$ref": "#/components/schemas/MethodInfo" }, "nullable": true, "readOnly": true }, "declaredNestedTypes": { "type": "array", "items": { "$ref": "#/components/schemas/TypeInfo" }, "nullable": true, "readOnly": true }, "declaredProperties": { "type": "array", "items": { "$ref": "#/components/schemas/PropertyInfo" }, "nullable": true, "readOnly": true }, "implementedInterfaces": { "type": "array", "items": { "$ref": "#/components/schemas/Type" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "UniqueIndexColumnDto": { "type": "object", "properties": { "ordinal": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UniqueIndexDto": { "type": "object", "properties": { "table": { "type": "string", "nullable": true }, "indexName": { "type": "string", "nullable": true }, "columns": { "type": "array", "items": { "$ref": "#/components/schemas/UniqueIndexColumnDto" }, "nullable": true } }, "additionalProperties": false }, "UpdateAgentRequest": { "type": "object", "properties": { "status": { "$ref": "#/components/schemas/AgentStatusTypes" }, "version": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UpdateDatabaseRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "type": { "$ref": "#/components/schemas/DataBaseTypes" }, "environments": { "type": "array", "items": { "$ref": "#/components/schemas/DatabaseEnvironmentRequest" }, "nullable": true } }, "additionalProperties": false }, "UpdateDatasetRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "status": { "$ref": "#/components/schemas/DatasetStatusTypes" }, "latestExecutionDate": { "type": "string", "format": "date-time", "nullable": true }, "size": { "type": "integer", "format": "int64", "nullable": true }, "parameters": { "type": "array", "items": { "$ref": "#/components/schemas/DatasetParameterValueDto" }, "nullable": true } }, "additionalProperties": false }, "UpdateEnvironmentRequest": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "tag": { "type": "string", "nullable": true }, "defaultAgentPool": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UpdateGrapeDetailTableRef": { "type": "object", "properties": { "tableName": { "type": "string", "nullable": true }, "databaseId": { "type": "string", "nullable": true }, "filter": { "$ref": "#/components/schemas/FilterRuleset" }, "sampling": { "$ref": "#/components/schemas/SamplingModel" }, "tableStyle": { "$ref": "#/components/schemas/TableStyle" }, "mergeOptions": { "$ref": "#/components/schemas/GrapeMergeOptionsModel" } }, "additionalProperties": false }, "UpdateGrapeRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "details": { "type": "array", "items": { "$ref": "#/components/schemas/UpdateGrapeDetailTableRef" }, "nullable": true }, "compositeRelations": { "type": "array", "items": { "$ref": "#/components/schemas/CompositeRelationDto" }, "nullable": true }, "parameters": { "type": "array", "items": { "$ref": "#/components/schemas/GrapeParameterDto" }, "nullable": true } }, "additionalProperties": false }, "UpdateInfrastructureRequest": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "connectionString": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "databaseType": { "$ref": "#/components/schemas/DataBaseTypes" }, "readOnly": { "type": "boolean" } }, "additionalProperties": false }, "UpdateOrganizationRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UpdateProjectRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "sensitiveFieldsWorkflow": { "$ref": "#/components/schemas/SensitiveFieldsWorkflows" } }, "additionalProperties": false }, "UpdateResourceRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "type": { "$ref": "#/components/schemas/ResourceTypes" }, "data": { "$ref": "#/components/schemas/IResourceItem" }, "scopeLevel": { "$ref": "#/components/schemas/ResourceScopeTypes" }, "projectsScope": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "UpdateSchemaRequest": { "type": "object", "properties": { "tables": { "type": "array", "items": { "$ref": "#/components/schemas/TableDto" }, "nullable": true }, "relations": { "type": "array", "items": { "$ref": "#/components/schemas/RelationDto" }, "nullable": true }, "uniqueIndexes": { "type": "array", "items": { "$ref": "#/components/schemas/UniqueIndexDto" }, "nullable": true } }, "additionalProperties": false }, "UpdateSensitiveFieldRequest": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/SensitiveFieldTypes" }, "piiScore": { "type": "number", "format": "double", "nullable": true }, "status": { "$ref": "#/components/schemas/SensitiveFieldStatusTypes" }, "anonymizationRule": { "$ref": "#/components/schemas/IAnonymizationRule" } }, "additionalProperties": false }, "UpdateSensitiveFieldStatusRequest": { "type": "object", "properties": { "status": { "$ref": "#/components/schemas/SensitiveFieldWorkflowStatusTypes" }, "rejectedReason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UpdateTaskRequest": { "type": "object", "properties": { "status": { "$ref": "#/components/schemas/TasksStatus" }, "errorMessage": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UpdateUserPrivilegesRequest": { "type": "object", "properties": { "defaultPrivileges": { "type": "array", "items": { "$ref": "#/components/schemas/PrivilegeDto" }, "nullable": true } }, "additionalProperties": false }, "UpdateUserRequest": { "type": "object", "properties": { "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "favoriteLanguage": { "type": "string", "nullable": true }, "defaultOrganizationId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UserDto": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "login": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "favoriteLanguage": { "type": "string", "nullable": true }, "defaultOrganizationId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UserDtoItemResponse": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/UserDto" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/HateoasLink" }, "nullable": true } }, "additionalProperties": false }, "UserDtoListItemResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/UserDtoItemResponse" }, "nullable": true }, "totalCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "UserPrivilegesDto": { "type": "object", "properties": { "defaultPrivileges": { "type": "array", "items": { "$ref": "#/components/schemas/PrivilegeDto" }, "nullable": true } }, "additionalProperties": false }, "UserPrivilegesDtoItemResponse": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/UserPrivilegesDto" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/HateoasLink" }, "nullable": true } }, "additionalProperties": false } }, "securitySchemes": { "Bearer": { "type": "oauth2", "description": "JWT Authorization header using the Bearer scheme. \r\n\r\n Enter 'Bearer' [space] and then your token in the text input below.\r\n\r\nExample: \"Bearer 1safsfsdfdfd\"" } } }, "security": [ { "Bearer": [ ] } ] }