{ "openapi": "3.0.1", "info": { "title": "Skyvia public API", "version": "v1" }, "paths": { "/v1/account/users": { "get": { "tags": [ "Account" ], "summary": "Get account users", "parameters": [ { "name": "searchMask", "in": "query", "description": "search by user name", "schema": { "type": "string" } }, { "name": "take", "in": "query", "description": "Items to take [1..200]", "schema": { "type": "integer", "format": "int32", "default": 20 } }, { "name": "skip", "in": "query", "description": "Items to skip [0...]", "schema": { "type": "integer", "format": "int32", "default": 0 } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AccountUserDtoHasMorePagingDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AccountUserDtoHasMorePagingDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AccountUserDtoHasMorePagingDto" } } } } } }, "delete": { "tags": [ "Account" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/RemoveAccountUserRequestDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RemoveAccountUserRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RemoveAccountUserRequestDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RemoveAccountUserRequestDto" } } } }, "responses": { "200": { "description": "OK" } } } }, "/v1/account/invitations": { "get": { "tags": [ "Account" ], "summary": "Get account invitations", "parameters": [ { "name": "take", "in": "query", "description": "Items to take [1..200]", "schema": { "type": "integer", "format": "int32", "default": 20 } }, { "name": "skip", "in": "query", "description": "Items to skip [0...]", "schema": { "type": "integer", "format": "int32", "default": 0 } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AccountInvitedUserDtoHasMorePagingDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AccountInvitedUserDtoHasMorePagingDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AccountInvitedUserDtoHasMorePagingDto" } } } } } }, "post": { "tags": [ "Account" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/InviteUserRequestDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/InviteUserRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InviteUserRequestDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/InviteUserRequestDto" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/InvitedUserStatusDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/InvitedUserStatusDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InvitedUserStatusDto" } } } } } } }, "/v1/account/invitations/{invitationId}/resend": { "post": { "tags": [ "Account" ], "parameters": [ { "name": "invitationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/InvitedUserStatusDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/InvitedUserStatusDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InvitedUserStatusDto" } } } } } } }, "/v1/account/invitations/{invitationId}": { "delete": { "tags": [ "Account" ], "parameters": [ { "name": "invitationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/v1/workspaces/{workspaceId}/agents": { "get": { "tags": [ "Agents" ], "summary": "Get agents", "parameters": [ { "name": "workspaceId", "in": "path", "description": "", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Items to skip [0...]", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "take", "in": "query", "description": "Items to take [1..200]", "schema": { "type": "integer", "format": "int32", "default": 20 } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AgentDtoHasMorePagingDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AgentDtoHasMorePagingDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AgentDtoHasMorePagingDto" } } } } } } }, "/v1/workspaces/{workspaceId}/agents/{agentId}": { "get": { "tags": [ "Agents" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "agentId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AgentDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AgentDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AgentDto" } } } } } } }, "/v1/workspaces/{workspaceId}/agents/{agentId}/test": { "post": { "tags": [ "Agents" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "agentId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiResult" } } } } } } }, "/v1/workspaces/{workspaceId}/automations": { "get": { "tags": [ "Automations" ], "summary": "Get automations", "parameters": [ { "name": "workspaceId", "in": "path", "description": "Workspace Id", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Items to skip [0...]", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "take", "in": "query", "description": "Items to take [1..200]", "schema": { "type": "integer", "format": "int32", "default": 20 } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AutomationDtoHasMorePagingDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AutomationDtoHasMorePagingDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AutomationDtoHasMorePagingDto" } } } } } } }, "/v1/workspaces/{workspaceId}/automations/{automationId}": { "get": { "tags": [ "Automations" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "automationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AutomationDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AutomationDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AutomationDto" } } } } } } }, "/v1/workspaces/{workspaceId}/automations/{automationId}/executions": { "get": { "tags": [ "Automations" ], "summary": "Get finished executions", "parameters": [ { "name": "workspaceId", "in": "path", "description": "", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "automationId", "in": "path", "description": "", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "startDate", "in": "query", "description": "", "schema": { "type": "string", "format": "date-time" } }, { "name": "endDate", "in": "query", "description": "", "schema": { "type": "string", "format": "date-time" } }, { "name": "failed", "in": "query", "description": "", "schema": { "type": "boolean" } }, { "name": "skip", "in": "query", "description": "Items to skip [0...]", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "take", "in": "query", "description": "Items to take [1..200]", "schema": { "type": "integer", "format": "int32", "default": 20 } }, { "name": "sortOrder", "in": "query", "description": "To sort the available list of records in either ascending or descending order. Possible values: asc - ascending order, desc - descending order.The default value is 'asc'.", "schema": { "type": "string", "default": "asc" } }, { "name": "sortBy", "in": "query", "description": "To sort the records based on the fields: date, executionId. The default value is 'date'", "schema": { "type": "string", "default": "date" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AutomationLogItemDtoHasMorePagingDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AutomationLogItemDtoHasMorePagingDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AutomationLogItemDtoHasMorePagingDto" } } } } } } }, "/v1/workspaces/{workspaceId}/automations/{automationId}/executions/{executionId}": { "get": { "tags": [ "Automations" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "automationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "executionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AutomationLogItemDetailsDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AutomationLogItemDetailsDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AutomationLogItemDetailsDto" } } } } } } }, "/v1/workspaces/{workspaceId}/automations/{automationId}/state": { "get": { "tags": [ "Automations" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "automationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AutomationStateDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AutomationStateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AutomationStateDto" } } } } } } }, "/v1/workspaces/{workspaceId}/automations/{automationId}/active": { "get": { "tags": [ "Automations" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "automationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AutomationExecutionStateDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AutomationExecutionStateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AutomationExecutionStateDto" } } } } } } }, "/v1/workspaces/{workspaceId}/automations/{automationId}/enable": { "post": { "tags": [ "Automations" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "automationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/v1/workspaces/{workspaceId}/automations/{automationId}/disable": { "post": { "tags": [ "Automations" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "automationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/v1/workspaces/{workspaceId}/backups": { "get": { "tags": [ "Backups" ], "summary": "Get backups", "parameters": [ { "name": "workspaceId", "in": "path", "description": "Workspace Id", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Items to skip [0...]", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "take", "in": "query", "description": "Items to take [1..200]", "schema": { "type": "integer", "format": "int32", "default": 20 } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BackupDtoHasMorePagingDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BackupDtoHasMorePagingDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackupDtoHasMorePagingDto" } } } } } } }, "/v1/workspaces/{workspaceId}/backups/{backupId}": { "get": { "tags": [ "Backups" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "backupId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BackupDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BackupDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackupDto" } } } } } } }, "/v1/workspaces/{workspaceId}/backups/{backupId}/snapshots": { "get": { "tags": [ "Backups" ], "summary": "Get finished snapshots", "parameters": [ { "name": "workspaceId", "in": "path", "description": "", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "backupId", "in": "path", "description": "", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "startDate", "in": "query", "description": "", "schema": { "type": "string", "format": "date-time" } }, { "name": "endDate", "in": "query", "description": "", "schema": { "type": "string", "format": "date-time" } }, { "name": "failed", "in": "query", "description": "", "schema": { "type": "boolean" } }, { "name": "skip", "in": "query", "description": "Items to skip [0...]", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "take", "in": "query", "description": "Items to take [1..200]", "schema": { "type": "integer", "format": "int32", "default": 20 } }, { "name": "sortOrder", "in": "query", "description": "To sort the available list of records in either ascending or descending order. Possible values: asc - ascending order, desc - descending order.The default value is 'asc'.", "schema": { "type": "string", "default": "asc" } }, { "name": "sortBy", "in": "query", "description": "To sort the records based on the fields: startTime, snapshotId. The default value is 'startTime'", "schema": { "type": "string", "default": "startTime" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BackupSnapshotLogDtoHasMorePagingDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BackupSnapshotLogDtoHasMorePagingDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackupSnapshotLogDtoHasMorePagingDto" } } } } } }, "post": { "tags": [ "Backups" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "backupId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BackupActiveRunDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BackupActiveRunDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackupActiveRunDto" } } } } } } }, "/v1/workspaces/{workspaceId}/backups/{backupId}/snapshots/{snapshotId}": { "get": { "tags": [ "Backups" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "backupId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "snapshotId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BackupSnapshotLogDetailsDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BackupSnapshotLogDetailsDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackupSnapshotLogDetailsDto" } } } } } } }, "/v1/workspaces/{workspaceId}/backups/{backupId}/snapshots/active": { "get": { "tags": [ "Backups" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "backupId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BackupActiveRunDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BackupActiveRunDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackupActiveRunDto" } } } } } } }, "/v1/workspaces/{workspaceId}/backups/{backupId}/schedule": { "get": { "tags": [ "Backups" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "backupId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BackupScheduleDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BackupScheduleDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackupScheduleDto" } } } } } } }, "/v1/workspaces/{workspaceId}/backups/{backupId}/schedule/enable": { "post": { "tags": [ "Backups" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "backupId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BackupScheduleDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BackupScheduleDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackupScheduleDto" } } } } } } }, "/v1/workspaces/{workspaceId}/backups/{backupId}/schedule/disable": { "post": { "tags": [ "Backups" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "backupId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BackupScheduleDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BackupScheduleDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackupScheduleDto" } } } } } } }, "/v1/workspaces/{workspaceId}/connections": { "get": { "tags": [ "Connections" ], "summary": "Get connections", "parameters": [ { "name": "workspaceId", "in": "path", "description": "", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Items to skip [0...]", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "take", "in": "query", "description": "Items to take [1..200]", "schema": { "type": "integer", "format": "int32", "default": 20 } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ConnectionDtoHasMorePagingDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ConnectionDtoHasMorePagingDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ConnectionDtoHasMorePagingDto" } } } } } } }, "/v1/workspaces/{workspaceId}/connections/{connectionId}": { "get": { "tags": [ "Connections" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "connectionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ConnectionDetailsDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ConnectionDetailsDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ConnectionDetailsDto" } } } } } } }, "/v1/workspaces/{workspaceId}/connections/{connectionId}/test": { "post": { "tags": [ "Connections" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "connectionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiResult" } } } } } } }, "/v1/endpoints/types": { "get": { "tags": [ "Endpoints" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "object", "properties": { "OData": { "type": "integer", "format": "int32" }, "Sql": { "type": "integer", "format": "int32" } }, "additionalProperties": false } }, "application/json": { "schema": { "type": "object", "properties": { "OData": { "type": "integer", "format": "int32" }, "Sql": { "type": "integer", "format": "int32" } }, "additionalProperties": false } }, "text/json": { "schema": { "type": "object", "properties": { "OData": { "type": "integer", "format": "int32" }, "Sql": { "type": "integer", "format": "int32" } }, "additionalProperties": false } } } } } } }, "/v1/workspaces/{workspaceId}/endpoints": { "get": { "tags": [ "Endpoints" ], "summary": "Get endpoints", "parameters": [ { "name": "workspaceId", "in": "path", "description": "", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Items to skip [0...]", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "take", "in": "query", "description": "Items to take [1..200]", "schema": { "type": "integer", "format": "int32", "default": 20 } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/EndpointDtoHasMorePagingDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EndpointDtoHasMorePagingDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EndpointDtoHasMorePagingDto" } } } } } } }, "/v1/workspaces/{workspaceId}/endpoints/{endpointId}": { "get": { "tags": [ "Endpoints" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "endpointId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/EndpointDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EndpointDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EndpointDto" } } } } } } }, "/v1/workspaces/{workspaceId}/endpoints/{endpointId}/enable": { "post": { "tags": [ "Endpoints" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "endpointId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/v1/workspaces/{workspaceId}/endpoints/{endpointId}/disable": { "post": { "tags": [ "Endpoints" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "endpointId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/v1/workspaces/{workspaceId}/endpoints/{endpointId}/executions": { "get": { "tags": [ "Endpoints" ], "summary": "Get requests log", "parameters": [ { "name": "workspaceId", "in": "path", "description": "", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "endpointId", "in": "path", "description": "", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "startDate", "in": "query", "description": "", "schema": { "type": "string", "format": "date-time" } }, { "name": "endDate", "in": "query", "description": "", "schema": { "type": "string", "format": "date-time" } }, { "name": "failed", "in": "query", "description": "", "schema": { "type": "boolean" } }, { "name": "skip", "in": "query", "description": "Items to skip [0...]", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "take", "in": "query", "description": "Items to take [1..200]", "schema": { "type": "integer", "format": "int32", "default": 20 } }, { "name": "sortOrder", "in": "query", "description": "To sort the available list of records in either ascending or descending order. Possible values: asc - ascending order, desc - descending order.The default value is 'asc'.", "schema": { "type": "string", "default": "asc" } }, { "name": "sortBy", "in": "query", "description": "To sort the records based on the fields: date, executionId. The default value is 'date'", "schema": { "type": "string", "default": "date" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/EndpointRequestLogDtoHasMorePagingDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EndpointRequestLogDtoHasMorePagingDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EndpointRequestLogDtoHasMorePagingDto" } } } } } } }, "/v1/workspaces/{workspaceId}/endpoints/{endpointId}/executions/{recordId}": { "get": { "tags": [ "Endpoints" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "endpointId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/EndpointRequestLogDetailedDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EndpointRequestLogDetailedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EndpointRequestLogDetailedDto" } } } } } } }, "/v1/workspaces/{workspaceId}/integrations": { "get": { "tags": [ "Integrations" ], "summary": "Get integrations", "parameters": [ { "name": "workspaceId", "in": "path", "description": "Workspace Id", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Items to skip [0...]", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "take", "in": "query", "description": "Items to take [1..200]", "schema": { "type": "integer", "format": "int32", "default": 20 } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/IntegrationDtoHasMorePagingDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationDtoHasMorePagingDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IntegrationDtoHasMorePagingDto" } } } } } } }, "/v1/workspaces/{workspaceId}/integrations/{integrationId}": { "get": { "tags": [ "Integrations" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "integrationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/IntegrationDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IntegrationDto" } } } } } } }, "/v1/workspaces/{workspaceId}/integrations/{integrationId}/executions": { "get": { "tags": [ "Integrations" ], "summary": "Get finished executions", "parameters": [ { "name": "workspaceId", "in": "path", "description": "", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "integrationId", "in": "path", "description": "", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "startDate", "in": "query", "description": "", "schema": { "type": "string", "format": "date-time" } }, { "name": "endDate", "in": "query", "description": "", "schema": { "type": "string", "format": "date-time" } }, { "name": "failed", "in": "query", "description": "", "schema": { "type": "boolean" } }, { "name": "skip", "in": "query", "description": "Items to skip [0...]", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "take", "in": "query", "description": "Items to take [1..200]", "schema": { "type": "integer", "format": "int32", "default": 20 } }, { "name": "sortOrder", "in": "query", "description": "To sort the available list of records in either ascending or descending order. Possible values: asc - ascending order, desc - descending order.The default value is 'asc'.", "schema": { "type": "string", "default": "asc" } }, { "name": "sortBy", "in": "query", "description": "To sort the records based on the fields: startDate, runId. The default value is 'startDate'", "schema": { "type": "string", "default": "startDate" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/IntegrationExecutionLogDtoHasMorePagingDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationExecutionLogDtoHasMorePagingDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IntegrationExecutionLogDtoHasMorePagingDto" } } } } } }, "post": { "tags": [ "Integrations" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "integrationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/IntegrationExecutionLogDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationExecutionLogDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IntegrationExecutionLogDto" } } } } } } }, "/v1/workspaces/{workspaceId}/integrations/{integrationId}/executions/{executionId}": { "get": { "tags": [ "Integrations" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "integrationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "executionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/IntegrationExecutionResultDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationExecutionResultDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IntegrationExecutionResultDto" } } } } } } }, "/v1/workspaces/{workspaceId}/integrations/{integrationId}/executions/active": { "get": { "tags": [ "Integrations" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "integrationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/IntegrationExecutionLogDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationExecutionLogDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IntegrationExecutionLogDto" } } } } } } }, "/v1/workspaces/{workspaceId}/integrations/{integrationId}/executions/cancel": { "post": { "tags": [ "Integrations" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "integrationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/v1/workspaces/{workspaceId}/integrations/{integrationId}/executions/kill": { "post": { "tags": [ "Integrations" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "integrationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/v1/workspaces/{workspaceId}/integrations/{integrationId}/schedule": { "get": { "tags": [ "Integrations" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "integrationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/IntegrationScheduleDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationScheduleDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IntegrationScheduleDto" } } } } } } }, "/v1/workspaces/{workspaceId}/integrations/{integrationId}/schedule/enable": { "post": { "tags": [ "Integrations" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "integrationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/IntegrationScheduleDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationScheduleDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IntegrationScheduleDto" } } } } } } }, "/v1/workspaces/{workspaceId}/integrations/{integrationId}/schedule/disable": { "post": { "tags": [ "Integrations" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "integrationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/IntegrationScheduleDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationScheduleDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IntegrationScheduleDto" } } } } } } }, "/v1/workspaces": { "get": { "tags": [ "Workspaces" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkspaceDto" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkspaceDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkspaceDto" } } } } } } } }, "/v1/workspaces/{workspaceId}": { "get": { "tags": [ "Workspaces" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/WorkspaceDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WorkspaceDto" } } } } } } }, "/v1/workspaces/{workspaceId}/users": { "get": { "tags": [ "Workspaces" ], "summary": "Get workspace users", "parameters": [ { "name": "workspaceId", "in": "path", "description": "The workspace ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "searchMask", "in": "query", "description": "Search by part of user name", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkspaceUserDto" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkspaceUserDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkspaceUserDto" } } } } } } }, "post": { "tags": [ "Workspaces" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/AddWorkspaceUserRequestDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AddWorkspaceUserRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AddWorkspaceUserRequestDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AddWorkspaceUserRequestDto" } } } }, "responses": { "200": { "description": "OK" } } } }, "/v1/workspaces/{workspaceId}/users/{userId}": { "delete": { "tags": [ "Workspaces" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "userId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "AccountInvitedUserDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "email": { "type": "string", "nullable": true }, "type": { "enum": [ "Administrator", "Member" ], "type": "string" }, "workspaces": { "type": "array", "items": { "$ref": "#/components/schemas/AccountWorkspaceUserDto" }, "nullable": true }, "invitationDate": { "type": "string", "format": "date-time" }, "userId": { "type": "integer", "format": "int32", "nullable": true }, "fullName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AccountInvitedUserDtoHasMorePagingDto": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AccountInvitedUserDto" }, "nullable": true }, "hasMore": { "type": "boolean" } }, "additionalProperties": false }, "AccountUserDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "email": { "type": "string", "nullable": true }, "fullName": { "type": "string", "nullable": true }, "type": { "enum": [ "Administrator", "Member" ], "type": "string" }, "workspaces": { "type": "array", "items": { "$ref": "#/components/schemas/AccountWorkspaceUserDto" }, "nullable": true } }, "additionalProperties": false }, "AccountUserDtoHasMorePagingDto": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AccountUserDto" }, "nullable": true }, "hasMore": { "type": "boolean" } }, "additionalProperties": false }, "AccountWorkspaceUserDto": { "type": "object", "properties": { "workspaceId": { "type": "integer", "format": "int32" }, "roleName": { "type": "string", "nullable": true }, "roleId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "AddWorkspaceUserRequestDto": { "type": "object", "properties": { "userId": { "type": "integer", "format": "int32" }, "roleId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "AgentDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "key": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AgentDtoHasMorePagingDto": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AgentDto" }, "nullable": true }, "hasMore": { "type": "boolean" } }, "additionalProperties": false }, "ApiResult": { "type": "object", "properties": { "message": { "type": "string", "nullable": true }, "refresh": { "type": "boolean" } }, "additionalProperties": false }, "AutomationDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "triggerType": { "enum": [ "Manual", "Schedule", "Connection", "Webhook" ], "type": "string" }, "created": { "type": "string", "format": "date-time" }, "modified": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "AutomationDtoHasMorePagingDto": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AutomationDto" }, "nullable": true }, "hasMore": { "type": "boolean" } }, "additionalProperties": false }, "AutomationExecutionStateDto": { "type": "object", "properties": { "executionId": { "type": "integer", "format": "int64" }, "date": { "type": "string", "format": "date-time" }, "state": { "type": "string", "nullable": true }, "testMode": { "type": "boolean" } }, "additionalProperties": false }, "AutomationLogItemDetailsDto": { "type": "object", "properties": { "executionId": { "type": "integer", "format": "int64" }, "state": { "enum": [ "Executing", "Succeeded", "Failed", "Canceling", "Canceled", "Killing" ], "type": "string" }, "version": { "type": "integer", "format": "int32" }, "testMode": { "type": "boolean" }, "comment": { "type": "string", "nullable": true }, "started": { "type": "string", "format": "date-time" }, "executed": { "type": "string", "format": "date-time", "nullable": true }, "billedTasks": { "type": "integer", "format": "int32", "nullable": true }, "error": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AutomationLogItemDto": { "type": "object", "properties": { "executionId": { "type": "integer", "format": "int64" }, "state": { "enum": [ "Executing", "Succeeded", "Failed", "Canceling", "Canceled", "Killing" ], "type": "string" }, "date": { "type": "string", "format": "date-time" }, "billedTasks": { "type": "integer", "format": "int64" }, "testMode": { "type": "boolean" } }, "additionalProperties": false }, "AutomationLogItemDtoHasMorePagingDto": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AutomationLogItemDto" }, "nullable": true }, "hasMore": { "type": "boolean" } }, "additionalProperties": false }, "AutomationQueueStateDto": { "type": "object", "properties": { "queuedCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "AutomationStateDto": { "type": "object", "properties": { "trigger": { "$ref": "#/components/schemas/AutomationTriggerStateDto" }, "queue": { "$ref": "#/components/schemas/AutomationQueueStateDto" }, "executing": { "$ref": "#/components/schemas/AutomationExecutionStateDto" }, "testMode": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "AutomationTriggerStateDto": { "type": "object", "properties": { "enabled": { "type": "boolean" } }, "additionalProperties": false }, "BackupActiveRunDto": { "type": "object", "properties": { "runId": { "type": "integer", "format": "int32" }, "date": { "type": "string", "format": "date-time" }, "duration": { "type": "integer", "format": "int32" }, "state": { "enum": [ "New", "Queued", "Running", "Succeeded", "Failed", "Canceling", "Canceled" ], "type": "string" } }, "additionalProperties": false }, "BackupDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "created": { "type": "string", "format": "date-time" }, "modified": { "type": "string", "format": "date-time" }, "scheduled": { "type": "boolean" } }, "additionalProperties": false }, "BackupDtoHasMorePagingDto": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/BackupDto" }, "nullable": true }, "hasMore": { "type": "boolean" } }, "additionalProperties": false }, "BackupScheduleDto": { "type": "object", "properties": { "active": { "type": "boolean" } }, "additionalProperties": false }, "BackupSnapshotLogDetailsDto": { "type": "object", "properties": { "snapshotId": { "type": "integer", "format": "int32" }, "queueTime": { "type": "string", "format": "date-time", "nullable": true }, "startTime": { "type": "string", "format": "date-time", "nullable": true }, "endTime": { "type": "string", "format": "date-time", "nullable": true }, "state": { "enum": [ "New", "Queued", "Running", "Succeeded", "Failed", "Canceling", "Canceled" ], "type": "string" }, "runBySchedule": { "type": "boolean" }, "result": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BackupSnapshotLogDto": { "type": "object", "properties": { "snapshotId": { "type": "integer", "format": "int32" }, "queueTime": { "type": "string", "format": "date-time", "nullable": true }, "startTime": { "type": "string", "format": "date-time", "nullable": true }, "endTime": { "type": "string", "format": "date-time", "nullable": true }, "state": { "enum": [ "New", "Queued", "Running", "Succeeded", "Failed", "Canceling", "Canceled" ], "type": "string" }, "runBySchedule": { "type": "boolean" } }, "additionalProperties": false }, "BackupSnapshotLogDtoHasMorePagingDto": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/BackupSnapshotLogDto" }, "nullable": true }, "hasMore": { "type": "boolean" } }, "additionalProperties": false }, "ConnectionDetailsDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "connector": { "type": "string", "nullable": true }, "type": { "enum": [ "Direct", "Agent" ], "type": "string" } }, "additionalProperties": false }, "ConnectionDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "connector": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ConnectionDtoHasMorePagingDto": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ConnectionDto" }, "nullable": true }, "hasMore": { "type": "boolean" } }, "additionalProperties": false }, "EndpointDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "token": { "type": "string", "nullable": true }, "active": { "type": "boolean" }, "type": { "enum": [ "OData", "Sql" ], "type": "string" }, "created": { "type": "string", "format": "date-time" }, "modified": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "EndpointDtoHasMorePagingDto": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/EndpointDto" }, "nullable": true }, "hasMore": { "type": "boolean" } }, "additionalProperties": false }, "EndpointRequestLogDetailedDto": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time" }, "url": { "type": "string", "nullable": true }, "method": { "type": "string", "nullable": true }, "remoteIP": { "type": "string", "nullable": true }, "userAgent": { "type": "string", "nullable": true }, "user": { "type": "string", "nullable": true }, "error": { "type": "string", "nullable": true }, "log": { "type": "array", "items": { "type": "string" }, "nullable": true }, "bytes": { "type": "integer", "format": "int32" }, "rows": { "type": "integer", "format": "int32" }, "pageToken": { "type": "string", "nullable": true }, "external": { "type": "boolean" } }, "additionalProperties": false }, "EndpointRequestLogDto": { "type": "object", "properties": { "executionId": { "type": "string", "nullable": true }, "date": { "type": "string", "format": "date-time" }, "method": { "enum": [ "GET", "POST", "PUT", "DELETE", "PATCH", "HEAD", "OPTIONS", "TRACE" ], "type": "string" }, "failed": { "type": "boolean" }, "bytes": { "type": "integer", "format": "int32" }, "remoteIP": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true } }, "additionalProperties": false }, "EndpointRequestLogDtoHasMorePagingDto": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/EndpointRequestLogDto" }, "nullable": true }, "hasMore": { "type": "boolean" } }, "additionalProperties": false }, "IntegrationDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "type": { "type": "string", "description": "Possible values: dataflow, export, controlflow, replication, import, sync, custom", "nullable": true }, "created": { "type": "string", "format": "date-time" }, "modified": { "type": "string", "format": "date-time" }, "scheduled": { "type": "boolean" } }, "additionalProperties": false }, "IntegrationDtoHasMorePagingDto": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/IntegrationDto" }, "nullable": true }, "hasMore": { "type": "boolean" } }, "additionalProperties": false }, "IntegrationExecutionLogDto": { "type": "object", "properties": { "runId": { "type": "integer", "format": "int32" }, "date": { "type": "string", "format": "date-time" }, "duration": { "type": "integer", "format": "int32" }, "state": { "enum": [ "New", "Queued", "Running", "Succeeded", "Failed", "Canceling", "Canceled" ], "type": "string" }, "successRows": { "type": "integer", "format": "int32" }, "errorRows": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "IntegrationExecutionLogDtoHasMorePagingDto": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/IntegrationExecutionLogDto" }, "nullable": true }, "hasMore": { "type": "boolean" } }, "additionalProperties": false }, "IntegrationExecutionResultDto": { "type": "object", "properties": { "runId": { "type": "integer", "format": "int32" }, "queueTime": { "type": "string", "format": "date-time" }, "startTime": { "type": "string", "format": "date-time", "nullable": true }, "endTime": { "type": "string", "format": "date-time", "nullable": true }, "state": { "enum": [ "New", "Queued", "Running", "Succeeded", "Failed", "Canceling", "Canceled" ], "type": "string" }, "result": { "type": "string", "nullable": true } }, "additionalProperties": false }, "IntegrationScheduleDto": { "type": "object", "properties": { "active": { "type": "boolean" } }, "additionalProperties": false }, "InviteToWorkspaceDto": { "required": [ "roleId", "workspaceId" ], "type": "object", "properties": { "workspaceId": { "type": "integer", "format": "int32", "example": 123 }, "roleId": { "type": "integer", "format": "int32", "example": 3 } }, "additionalProperties": false }, "InviteUserRequestDto": { "required": [ "email", "userType" ], "type": "object", "properties": { "email": { "minLength": 1, "type": "string", "example": "johnDou@email.org" }, "userType": { "enum": [ "Administrator", "Member" ], "type": "string", "example": "Member" }, "workspaces": { "type": "array", "items": { "$ref": "#/components/schemas/InviteToWorkspaceDto" }, "nullable": true } }, "additionalProperties": false }, "InvitedUserStatusDto": { "type": "object", "properties": { "email": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "invitationId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "RemoveAccountUserRequestDto": { "type": "object", "properties": { "email": { "type": "string", "nullable": true } }, "additionalProperties": false }, "WorkspaceDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "isPersonal": { "type": "boolean" } }, "additionalProperties": false }, "WorkspaceUserDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "email": { "type": "string", "nullable": true }, "fullName": { "type": "string", "nullable": true }, "roleId": { "type": "integer", "format": "int32" }, "roleName": { "type": "string", "nullable": true } }, "additionalProperties": false } }, "securitySchemes": { "Access Token": { "type": "apiKey", "description": "Authorization header with the Skyvia access token.", "name": "Authorization", "in": "header" } } }, "security": [ { "Access Token": [ ] } ] }