{ "openapi": "3.0.0", "paths": { "/v2/application/build": { "get": { "operationId": "AppController_getBuild_v2", "parameters": [], "responses": { "200": { "description": "The API and application version, production flag, the maximum number of active pipelines and the GPU can be used for inference", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationVersionDto" } } } } }, "summary": "Get the API build information", "tags": [ "General operations" ] } }, "/v3/application/build": { "get": { "operationId": "AppController_getBuild_v3", "parameters": [], "responses": { "200": { "description": "The API and application version, production flag, the maximum number of active pipelines and the GPU can be used for inference", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationVersionDto" } } } } }, "summary": "Get the API build information", "tags": [ "General operations" ] } }, "/v2/application/configuration": { "get": { "operationId": "AppController_getApplicationConfiguration_v2", "parameters": [], "responses": { "200": { "description": "The application configuration", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationConfiguration" } } } }, "500": { "description": "Failed to fetch the application configuration (E00001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Get the application configuration", "tags": [ "General operations" ] }, "patch": { "description": "Operator", "operationId": "AppController_setApplicationConfiguration_v2", "parameters": [], "requestBody": { "required": true, "description": "The new configuration", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationConfigurationDto" } } } }, "responses": { "200": { "description": "The updated application configuration", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationConfiguration" } } } }, "400": { "description": "Invalid logFileSize (E20060)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Failed to update the application configuration (E00001) or failed to set maximum log file size (E70004)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Update the application configuration", "tags": [ "General operations" ] } }, "/v3/application/configuration": { "get": { "operationId": "AppController_getApplicationConfiguration_v3", "parameters": [], "responses": { "200": { "description": "The application configuration", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationConfiguration" } } } }, "500": { "description": "Failed to fetch the application configuration (E00001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Get the application configuration", "tags": [ "General operations" ] }, "patch": { "description": "Operator", "operationId": "AppController_setApplicationConfiguration_v3", "parameters": [], "requestBody": { "required": true, "description": "The new configuration", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationConfigurationDto" } } } }, "responses": { "200": { "description": "The updated application configuration", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationConfiguration" } } } }, "400": { "description": "Invalid logFileSize (E20060)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "User permission is insufficient to perform this action (E00006)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Failed to update the application configuration (E00001) or failed to set maximum log file size (E70004)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Update the application configuration", "tags": [ "General operations" ] } }, "/v2/application/log": { "get": { "operationId": "AppController_getLogMessages_v2", "parameters": [ { "name": "limit", "required": false, "in": "query", "description": "The limit of the number of returned log messages", "schema": { "default": 15, "example": "15", "type": "integer" } }, { "name": "applications", "required": false, "in": "query", "description": "The name of the applications in a comma separated list. Empty by default, which means all of the applications", "schema": { "default": "", "example": "API,Orchestrator,Runtime Manager", "type": "string" } }, { "name": "logLevels", "required": false, "in": "query", "description": "The log levels for the applications, given in comma separated numbers as string (1: Debug, 2: Info, 3: Warn, 4: Error, 5: Fatal). Empty by default, which means all of the log levels", "schema": { "default": "", "example": "1,4,5", "type": "string" } }, { "name": "pipelineId", "required": false, "in": "query", "description": "Unique identifier of the corresponding pipeline", "schema": { "default": "", "example": "f5d82b95-523d-438c-1002-bca5dc7748e7", "type": "string" } } ], "responses": { "200": { "description": "The list of the logs", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LogMessageDto" } } } } }, "400": { "description": "Invalid log levels (E20025) parameter", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Get the stored log messages", "tags": [ "General operations" ] }, "post": { "description": "Admin", "operationId": "AppController_setLogMessage_v2", "parameters": [], "requestBody": { "required": true, "description": "The new log message object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LogMessageDto" } } } }, "responses": { "201": { "description": "The created log", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LogMessageDto" } } } }, "400": { "description": "Invalid log level (E20025)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Create new log message for a requested application on a specified level", "tags": [ "General operations" ] }, "delete": { "description": "AppAdmin", "operationId": "AppController_deleteLogMessage_v2", "parameters": [], "responses": { "200": { "description": "Log deletion successful" }, "500": { "description": "Failed to delete log messages (E70003)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Deletes log messages from each internal component", "tags": [ "General operations" ] } }, "/v3/application/log": { "get": { "operationId": "AppController_getLogMessages_v3", "parameters": [ { "name": "limit", "required": false, "in": "query", "description": "The limit of the number of returned log messages", "schema": { "default": 15, "example": "15", "type": "integer" } }, { "name": "applications", "required": false, "in": "query", "description": "The name of the applications in a comma separated list. Empty by default, which means all of the applications", "schema": { "default": "", "example": "API,Orchestrator,Runtime Manager", "type": "string" } }, { "name": "logLevels", "required": false, "in": "query", "description": "The log levels for the applications, given in comma separated numbers as string (1: Debug, 2: Info, 3: Warn, 4: Error, 5: Fatal). Empty by default, which means all of the log levels", "schema": { "default": "", "example": "1,4,5", "type": "string" } }, { "name": "pipelineId", "required": false, "in": "query", "description": "Unique identifier of the corresponding pipeline", "schema": { "default": "", "example": "f5d82b95-523d-438c-1002-bca5dc7748e7", "type": "string" } } ], "responses": { "200": { "description": "The list of the logs", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LogMessageDto" } } } } }, "400": { "description": "Invalid log levels (E20025) parameter", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Get the stored log messages", "tags": [ "General operations" ] }, "post": { "description": "Admin", "operationId": "AppController_setLogMessage_v3", "parameters": [], "requestBody": { "required": true, "description": "The new log message object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LogMessageDto" } } } }, "responses": { "201": { "description": "The created log", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LogMessageDto" } } } }, "400": { "description": "Invalid log level (E20025)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "User permission is insufficient to perform this action (E00006)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Create new log message for a requested application on a specified level", "tags": [ "General operations" ] }, "delete": { "description": "AppAdmin", "operationId": "AppController_deleteLogMessage_v3", "parameters": [], "responses": { "200": { "description": "Log deletion successful" }, "403": { "description": "User permission is insufficient to perform this action (E00006)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Failed to delete log messages (E70003)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Deletes log messages from each internal component", "tags": [ "General operations" ] } }, "/v2/application/log/level/api": { "get": { "operationId": "AppController_getMainLogLevel_v2", "parameters": [], "responses": { "200": { "description": "Returns true if the debug log level is enabled for API, otherwise false" } }, "summary": "Checking whether the log level of API is debug", "tags": [ "General operations" ] }, "patch": { "description": "Operator", "operationId": "AppController_setMainLogLevel_v2", "parameters": [], "requestBody": { "required": true, "description": "The debug log level is enabled or not for API", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LogLevelDto" } } } }, "responses": { "200": { "description": "Returns true if the debug log level is enabled for API, otherwise false" }, "500": { "description": "Failed to set log level (E70001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Enable or disable debug mode for API", "tags": [ "General operations" ] } }, "/v3/application/log/level/api": { "get": { "operationId": "AppController_getMainLogLevel_v3", "parameters": [], "responses": { "200": { "description": "Returns true if the debug log level is enabled for API, otherwise false" } }, "summary": "Checking whether the log level of API is debug", "tags": [ "General operations" ] }, "patch": { "description": "Operator", "operationId": "AppController_setMainLogLevel_v3", "parameters": [], "requestBody": { "required": true, "description": "The debug log level is enabled or not for API", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LogLevelDto" } } } }, "responses": { "200": { "description": "Returns true if the debug log level is enabled for API, otherwise false" }, "403": { "description": "User permission is insufficient to perform this action (E00006)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Failed to set log level (E70001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Enable or disable debug mode for API", "tags": [ "General operations" ] } }, "/v2/application/log/level/runtime": { "get": { "operationId": "AppController_getRuntimeLogLevel_v2", "parameters": [], "responses": { "200": { "description": "Returns true if the debug log level is enabled for Runtimes, otherwise false" } }, "summary": "Checking whether the log level of Runtimes is debug", "tags": [ "General operations" ] }, "patch": { "description": "Operator", "operationId": "AppController_setRuntimeLogLevel_v2", "parameters": [], "requestBody": { "required": true, "description": "The debug log level is enabled or not for Runtimes", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LogLevelDto" } } } }, "responses": { "200": { "description": "Returns true if the debug log level is enabled for Runtimes, otherwise false" }, "500": { "description": "Failed to set log level (E70001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Enable or disable debug mode for Runtimes", "tags": [ "General operations" ] } }, "/v3/application/log/level/runtime": { "get": { "operationId": "AppController_getRuntimeLogLevel_v3", "parameters": [], "responses": { "200": { "description": "Returns true if the debug log level is enabled for Runtimes, otherwise false" } }, "summary": "Checking whether the log level of Runtimes is debug", "tags": [ "General operations" ] }, "patch": { "description": "Operator", "operationId": "AppController_setRuntimeLogLevel_v3", "parameters": [], "requestBody": { "required": true, "description": "The debug log level is enabled or not for Runtimes", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LogLevelDto" } } } }, "responses": { "200": { "description": "Returns true if the debug log level is enabled for Runtimes, otherwise false" }, "403": { "description": "User permission is insufficient to perform this action (E00006)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Failed to set log level (E70001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Enable or disable debug mode for Runtimes", "tags": [ "General operations" ] } }, "/v2/application/log/level/gpuRuntime": { "get": { "operationId": "AppController_getGPURuntimeLogLevel_v2", "parameters": [], "responses": { "200": { "description": "Returns true if the debug log level is enabled for GPU Runtimes, otherwise false" }, "501": { "description": "The installed AI Inference Server does not support GPU (E20053)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Checking whether the log level of GPU Runtimes is debug", "tags": [ "General operations" ] }, "patch": { "description": "Operator", "operationId": "AppController_setGPURuntimeLogLevel_v2", "parameters": [], "requestBody": { "required": true, "description": "The debug log level is enabled or not for GPU Runtimes", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LogLevelDto" } } } }, "responses": { "200": { "description": "Returns true if the debug log level is enabled for GPU Runtimes, otherwise false" }, "500": { "description": "Failed to set log level (E70001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "501": { "description": "The installed AI Inference Server does not support GPU (E20053)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Enable or disable debug mode for GPU Runtimes", "tags": [ "General operations" ] } }, "/v3/application/log/level/gpuRuntime": { "get": { "operationId": "AppController_getGPURuntimeLogLevel_v3", "parameters": [], "responses": { "200": { "description": "Returns true if the debug log level is enabled for GPU Runtimes, otherwise false" }, "501": { "description": "The installed AI Inference Server does not support GPU (E20053)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Checking whether the log level of GPU Runtimes is debug", "tags": [ "General operations" ] }, "patch": { "description": "Operator", "operationId": "AppController_setGPURuntimeLogLevel_v3", "parameters": [], "requestBody": { "required": true, "description": "The debug log level is enabled or not for GPU Runtimes", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LogLevelDto" } } } }, "responses": { "200": { "description": "Returns true if the debug log level is enabled for GPU Runtimes, otherwise false" }, "403": { "description": "User permission is insufficient to perform this action (E00006)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Failed to set log level (E70001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "501": { "description": "The installed AI Inference Server does not support GPU (E20053)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Enable or disable debug mode for GPU Runtimes", "tags": [ "General operations" ] } }, "/v2/application/log/download": { "get": { "description": "AppAdmin", "operationId": "AppController_downloadSpecifiedLogs_v2", "parameters": [], "responses": { "200": { "description": "The requested logs in a single zip file" }, "500": { "description": "Error during creating archive due to file system error (E70002)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Return the logs in compressed file", "tags": [ "General operations" ] } }, "/v3/application/log/download": { "get": { "description": "AppAdmin", "operationId": "AppController_downloadSpecifiedLogs_v3", "parameters": [], "responses": { "200": { "description": "The requested logs in a single zip file" }, "403": { "description": "User permission is insufficient to perform this action (E00006)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Error during creating archive due to file system error (E70002)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Return the logs in compressed file", "tags": [ "General operations" ] } }, "/v2/application/memoryUsage": { "get": { "deprecated": true, "operationId": "AppController_getMemoryUsage_v2", "parameters": [], "responses": { "200": { "description": "List of the memory usage of different components", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemoryUsageDetailsDto" } } } } }, "summary": "Get memory usage of internal components", "tags": [ "General operations" ] } }, "/v3/application/memoryUsage": { "get": { "deprecated": true, "operationId": "AppController_getMemoryUsage_v3", "parameters": [], "responses": { "200": { "description": "List of the memory usage of different components", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemoryUsageDetailsDto" } } } } }, "summary": "Get memory usage of internal components", "tags": [ "General operations" ] } }, "/v2/application/globalStatus": { "get": { "operationId": "AppController_getGlobalStatus_v2", "parameters": [], "responses": { "200": { "description": "Global status of the application, including memory and processor usage", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlobalStatusDto" } } } } }, "summary": "Get global status of the application, including memory and processor usage", "tags": [ "General operations" ] } }, "/v3/application/globalStatus": { "get": { "operationId": "AppController_getGlobalStatus_v3", "parameters": [], "responses": { "200": { "description": "Global status of the application, including memory and processor usage", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlobalStatusDto" } } } } }, "summary": "Get global status of the application, including memory and processor usage", "tags": [ "General operations" ] } }, "/v2/user/{id}": { "get": { "operationId": "UserController_getUserPreferences_v2", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Unique identifier of the entity in UUID v4 format", "schema": { "example": "f5d82b95-523d-438c-1002-bca5dc7748e7", "type": "string" } } ], "responses": { "200": { "description": "The requested user preferences", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserPreferences" } } } }, "400": { "description": "Invalid edge user ID (E20062)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Failed to fetch user preferences (E00001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Get the user preferences using edge user ID", "tags": [ "General user-related operations" ] }, "patch": { "operationId": "UserController_saveUserPreferences_v2", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Unique identifier of the entity in UUID v4 format", "schema": { "example": "f5d82b95-523d-438c-1002-bca5dc7748e7", "type": "string" } } ], "requestBody": { "required": true, "description": "The new user preferences", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateUserPreferencesDto" } } } }, "responses": { "200": { "description": "The updated user preferences", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserPreferences" } } } }, "400": { "description": "Invalid edge user ID (E20062)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Failed to update user preferences (E00001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Update the user preferences using edge user ID", "tags": [ "General user-related operations" ] } }, "/v3/user/{id}": { "get": { "operationId": "UserController_getUserPreferences_v3", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Unique identifier of the entity in UUID v4 format", "schema": { "example": "f5d82b95-523d-438c-1002-bca5dc7748e7", "type": "string" } } ], "responses": { "200": { "description": "The requested user preferences", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserPreferences" } } } }, "400": { "description": "Invalid edge user ID (E20062)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Failed to fetch user preferences (E00001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Get the user preferences using edge user ID", "tags": [ "General user-related operations" ] }, "patch": { "operationId": "UserController_saveUserPreferences_v3", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Unique identifier of the entity in UUID v4 format", "schema": { "example": "f5d82b95-523d-438c-1002-bca5dc7748e7", "type": "string" } } ], "requestBody": { "required": true, "description": "The new user preferences", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateUserPreferencesDto" } } } }, "responses": { "200": { "description": "The updated user preferences", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserPreferences" } } } }, "400": { "description": "Invalid edge user ID (E20062)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Failed to update user preferences (E00001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Update the user preferences using edge user ID", "tags": [ "General user-related operations" ] } }, "/v2/user/reset": { "delete": { "operationId": "UserController_resetUserPreferences_v2", "parameters": [], "responses": { "200": { "description": "Reset operation has been performed successfully" }, "500": { "description": "Failed to reset the user preferences (E00001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Reset user preferences to default", "tags": [ "General user-related operations" ] } }, "/v3/user/reset": { "delete": { "operationId": "UserController_resetUserPreferences_v3", "parameters": [], "responses": { "200": { "description": "Reset operation has been performed successfully" }, "500": { "description": "Failed to reset the user preferences (E00001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Reset user preferences to default", "tags": [ "General user-related operations" ] } }, "/v2/pipeline": { "get": { "operationId": "PipelineController_getPipelines_v2", "parameters": [ { "name": "name", "required": false, "in": "query", "description": "The name of the pipeline", "schema": { "example": "State Identifier", "type": "string" } }, { "name": "version", "required": false, "in": "query", "description": "The version of the pipeline", "schema": { "example": "1.0.0", "type": "string" } }, { "name": "packageId", "required": false, "in": "query", "description": "Unique identifier of the pipeline's package", "schema": { "example": "f5d82b95-523d-438c-2002-bca5dc7748e7", "type": "string" } } ], "responses": { "200": { "description": "The pipeline list", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Pipeline" } } } } }, "500": { "description": "Failed to fetch pipelines (E00001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Get the list of the pipelines and its components. The list based on the (optional) query", "tags": [ "General operations with a single pipeline" ] }, "post": { "description": "AppAdmin", "operationId": "PipelineController_import_v2", "parameters": [], "requestBody": { "required": true, "description": "The configuration package to be uploaded", "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/FileUploadDto" } } } }, "responses": { "201": { "description": "The created pipeline", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Pipeline" } } } }, "400": { "description": "Invalid pipeline ID (E20001) or invalid pipeline name, version (E20022) or invalid path (E20021) or invalid origin ID (E20001) or invalid package ID (E20013) or duplicated pipeline (E20030, E20028) or import is in-progress (E20037) or Model Distributor error (E80000)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Failed to upload the file (E00003) or failed to call Model Distributor (E80000) or failed to create pipeline (E10002)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Creating new pipeline using configuration package. It is not allowed to import in parallel", "tags": [ "General operations with a single pipeline" ] } }, "/v3/pipeline": { "get": { "operationId": "PipelineController_getPipelines_v3", "parameters": [ { "name": "name", "required": false, "in": "query", "description": "The name of the pipeline", "schema": { "example": "State Identifier", "type": "string" } }, { "name": "version", "required": false, "in": "query", "description": "The version of the pipeline", "schema": { "example": "1.0.0", "type": "string" } }, { "name": "packageId", "required": false, "in": "query", "description": "Unique identifier of the pipeline's package", "schema": { "example": "f5d82b95-523d-438c-2002-bca5dc7748e7", "type": "string" } } ], "responses": { "200": { "description": "The pipeline list", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Pipeline" } } } } }, "500": { "description": "Failed to fetch pipelines (E00001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Get the list of the pipelines and its components. The list based on the (optional) query", "tags": [ "General operations with a single pipeline" ] }, "post": { "description": "AppAdmin", "operationId": "PipelineController_import_v3", "parameters": [], "requestBody": { "required": true, "description": "The configuration package to be uploaded", "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/FileUploadDto" } } } }, "responses": { "201": { "description": "The created pipeline", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Pipeline" } } } }, "400": { "description": "Invalid pipeline ID (E20001) or invalid pipeline name, version (E20022) or invalid path (E20021) or invalid origin ID (E20001) or invalid package ID (E20013) or duplicated pipeline (E20030, E20028) or import is in-progress (E20037) or Model Distributor error (E80000)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "User permission is insufficient to perform this action (E00006)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Failed to upload the file (E00003) or failed to call Model Distributor (E80000) or failed to create pipeline (E10002)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Creating new pipeline using configuration package. It is not allowed to import in parallel", "tags": [ "General operations with a single pipeline" ] } }, "/v1/pipeline/{id}": { "get": { "deprecated": true, "operationId": "PipelineController_getPipelineV1_v1", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Unique identifier of the entity in UUID v4 format", "schema": { "example": "f5d82b95-523d-438c-1002-bca5dc7748e7", "type": "string" } } ], "responses": { "200": { "description": "The requested pipeline", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Pipeline" } } } }, "400": { "description": "Invalid pipeline ID (E20001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Pipeline does not exist (E10001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Failed to fetch pipeline (E00001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Get the details about the pipeline using ID (use '0' to get the most recently updated active pipeline)", "tags": [ "General operations with a single pipeline" ] } }, "/v2/pipeline/{id}": { "get": { "operationId": "PipelineController_getPipeline_v2", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Unique identifier of the entity in UUID v4 format", "schema": { "example": "f5d82b95-523d-438c-1002-bca5dc7748e7", "type": "string" } } ], "responses": { "200": { "description": "The requested pipeline", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Pipeline" } } } }, "400": { "description": "Invalid pipeline ID (E20001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Pipeline does not exist (E10001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Failed to fetch pipeline (E00001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Get the details about the pipeline using ID (use '0' to get the most recently updated active pipeline)", "tags": [ "General operations with a single pipeline" ] }, "delete": { "description": "AppAdmin", "operationId": "PipelineController_remove_v2", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Unique identifier of the entity in UUID v4 format", "schema": { "example": "f5d82b95-523d-438c-1002-bca5dc7748e7", "type": "string" } } ], "responses": { "200": { "description": "True if the deletion was successful" }, "400": { "description": "Invalid pipeline ID (E20001) or pipeline is active (E20033) or pipeline status is incorrect to delete (E20034)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Pipeline does not exist (E10001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Failed to get or remove pipeline (E00001) or failed to delete configuration package or log files when removing pipeline (E00005)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Delete the specific inactive pipeline using ID", "tags": [ "General operations with a single pipeline" ] } }, "/v3/pipeline/{id}": { "get": { "operationId": "PipelineController_getPipeline_v3", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Unique identifier of the entity in UUID v4 format", "schema": { "example": "f5d82b95-523d-438c-1002-bca5dc7748e7", "type": "string" } } ], "responses": { "200": { "description": "The requested pipeline", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Pipeline" } } } }, "400": { "description": "Invalid pipeline ID (E20001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Pipeline does not exist (E10001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Failed to fetch pipeline (E00001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Get the details about the pipeline using ID (use '0' to get the most recently updated active pipeline)", "tags": [ "General operations with a single pipeline" ] }, "delete": { "description": "AppAdmin", "operationId": "PipelineController_remove_v3", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Unique identifier of the entity in UUID v4 format", "schema": { "example": "f5d82b95-523d-438c-1002-bca5dc7748e7", "type": "string" } } ], "responses": { "200": { "description": "True if the deletion was successful" }, "400": { "description": "Invalid pipeline ID (E20001) or pipeline is active (E20033) or pipeline status is incorrect to delete (E20034)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "User permission is insufficient to perform this action (E00006)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Pipeline does not exist (E10001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Failed to get or remove pipeline (E00001) or failed to delete configuration package or log files when removing pipeline (E00005)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Delete the specific inactive pipeline using ID", "tags": [ "General operations with a single pipeline" ] } }, "/v2/pipeline/{id}/settings": { "patch": { "description": "Operator", "operationId": "PipelineController_updateSettings_v2", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Unique identifier of the entity in UUID v4 format", "schema": { "example": "f5d82b95-523d-438c-1002-bca5dc7748e7", "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PipelineSettingsDto" } } } }, "responses": { "200": { "description": "The updated pipeline", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Pipeline" } } } }, "400": { "description": "Invalid pipeline ID (E20001) or pipeline is inactive (E20032) or pipeline is not editable (E20034) or pipeline setting is incorrect (E20066)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Pipeline does not exist (E10001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Failed to get pipeline or failed to update pipeline (E00001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Update pipeline settings", "tags": [ "General operations with a single pipeline" ] } }, "/v3/pipeline/{id}/settings": { "patch": { "description": "Operator", "operationId": "PipelineController_updateSettings_v3", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Unique identifier of the entity in UUID v4 format", "schema": { "example": "f5d82b95-523d-438c-1002-bca5dc7748e7", "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PipelineSettingsDto" } } } }, "responses": { "200": { "description": "The updated pipeline", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Pipeline" } } } }, "400": { "description": "Invalid pipeline ID (E20001) or pipeline is inactive (E20032) or pipeline is not editable (E20034) or pipeline setting is incorrect (E20066)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "User permission is insufficient to perform this action (E00006)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Pipeline does not exist (E10001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Failed to get pipeline or failed to update pipeline (E00001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Update pipeline settings", "tags": [ "General operations with a single pipeline" ] } }, "/v2/pipeline/{id}/connector": { "patch": { "description": "Operator", "operationId": "PipelineController_setConnector_v2", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Unique identifier of the entity in UUID v4 format", "schema": { "example": "f5d82b95-523d-438c-1002-bca5dc7748e7", "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdDto" } } } }, "responses": { "200": { "description": "The updated pipeline", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Pipeline" } } } }, "400": { "description": "Invalid pipeline ID (E20001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Pipeline does not exist (E10001) or connector does not exist (E10005)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Failed to get pipeline or connector or failed to update pipeline (E00001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Set connector for the pipeline", "tags": [ "General operations with a single pipeline" ] } }, "/v3/pipeline/{id}/connector": { "patch": { "description": "Operator", "operationId": "PipelineController_setConnector_v3", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Unique identifier of the entity in UUID v4 format", "schema": { "example": "f5d82b95-523d-438c-1002-bca5dc7748e7", "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdDto" } } } }, "responses": { "200": { "description": "The updated pipeline", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Pipeline" } } } }, "400": { "description": "Invalid pipeline ID (E20001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "User permission is insufficient to perform this action (E00006)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Pipeline does not exist (E10001) or connector does not exist (E10005)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Failed to get pipeline or connector or failed to update pipeline (E00001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Set connector for the pipeline", "tags": [ "General operations with a single pipeline" ] } }, "/v2/pipeline/{id}/variables": { "get": { "operationId": "PipelineController_getVariables_v2", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Unique identifier of the entity in UUID v4 format", "schema": { "example": "f5d82b95-523d-438c-1002-bca5dc7748e7", "type": "string" } } ], "responses": { "200": { "description": "The list of mappable variables", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PipelineVariableDto" } } } } }, "400": { "description": "Invalid pipeline ID (E20001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Pipeline does not exist (E10001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Failed to get pipeline or variables (E00001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Get mappable variables of the pipeline", "tags": [ "General operations with a single pipeline" ] }, "patch": { "description": "Operator", "operationId": "PipelineController_updateVariableMapping_v2", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Unique identifier of the entity in UUID v4 format", "schema": { "example": "f5d82b95-523d-438c-1002-bca5dc7748e7", "type": "string" } } ], "requestBody": { "required": true, "description": "The list of variables intended for modification", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePipelineVariablesDto" } } } }, "responses": { "200": { "description": "The updated pipeline", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Pipeline" } } } }, "400": { "description": "Invalid pipeline ID (E20001) or pipeline is not editable (E20034) or input and output variable mapping is identical (E20031) or missing variable list (E20014) or invalid variable ID (E20011) or invalid variable topic (E20012) or variable topic is not found in the metadata (E20058) or variable type and metadata type do not match based on topic (E20061) or connector does not exist for a variable (E20040) or data type and connector payload type do not match (E20044) or data persistency should be set for Databus connector (E20054) or invalid topic with wildcard (E20051) or invalid topic for S7 connector (E20050)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Pipeline does not exist (E10001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Failed to get or update pipeline (E00001, E10003)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Update mappable variables of the active pipeline, which is not running", "tags": [ "General operations with a single pipeline" ] } }, "/v3/pipeline/{id}/variables": { "get": { "operationId": "PipelineController_getVariables_v3", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Unique identifier of the entity in UUID v4 format", "schema": { "example": "f5d82b95-523d-438c-1002-bca5dc7748e7", "type": "string" } } ], "responses": { "200": { "description": "The list of mappable variables", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PipelineVariableDto" } } } } }, "400": { "description": "Invalid pipeline ID (E20001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Pipeline does not exist (E10001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Failed to get pipeline or variables (E00001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Get mappable variables of the pipeline", "tags": [ "General operations with a single pipeline" ] }, "patch": { "description": "Operator", "operationId": "PipelineController_updateVariableMapping_v3", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Unique identifier of the entity in UUID v4 format", "schema": { "example": "f5d82b95-523d-438c-1002-bca5dc7748e7", "type": "string" } } ], "requestBody": { "required": true, "description": "The list of variables intended for modification", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePipelineVariablesDto" } } } }, "responses": { "200": { "description": "The updated pipeline", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Pipeline" } } } }, "400": { "description": "Invalid pipeline ID (E20001) or pipeline is not editable (E20034) or input and output variable mapping is identical (E20031) or missing variable list (E20014) or invalid variable ID (E20011) or invalid variable topic (E20012) or variable topic is not found in the metadata (E20058) or variable type and metadata type do not match based on topic (E20061) or connector does not exist for a variable (E20040) or data type and connector payload type do not match (E20044) or data persistency should be set for Databus connector (E20054) or invalid topic with wildcard (E20051) or invalid topic for S7 connector (E20050)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "User permission is insufficient to perform this action (E00006)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Pipeline does not exist (E10001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Failed to get or update pipeline (E00001, E10003)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Update mappable variables of the active pipeline, which is not running", "tags": [ "General operations with a single pipeline" ] } }, "/v2/pipeline/{id}/reset": { "patch": { "description": "Operator", "operationId": "PipelineController_resetMapping_v2", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Unique identifier of the entity in UUID v4 format", "schema": { "example": "f5d82b95-523d-438c-1002-bca5dc7748e7", "type": "string" } } ], "responses": { "200": { "description": "The updated pipeline", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Pipeline" } } } }, "400": { "description": "Invalid pipeline ID (E20001) or pipeline is not editable (E20034)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Pipeline does not exist (E10001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Failed to get or update pipeline (E00001, E10003)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Reset variable mapping of the active pipeline, which is not running", "tags": [ "General operations with a single pipeline" ] } }, "/v3/pipeline/{id}/reset": { "patch": { "description": "Operator", "operationId": "PipelineController_resetMapping_v3", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Unique identifier of the entity in UUID v4 format", "schema": { "example": "f5d82b95-523d-438c-1002-bca5dc7748e7", "type": "string" } } ], "responses": { "200": { "description": "The updated pipeline", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Pipeline" } } } }, "400": { "description": "Invalid pipeline ID (E20001) or pipeline is not editable (E20034)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "User permission is insufficient to perform this action (E00006)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Pipeline does not exist (E10001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Failed to get or update pipeline (E00001, E10003)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Reset variable mapping of the active pipeline, which is not running", "tags": [ "General operations with a single pipeline" ] } }, "/v2/pipeline/{id}/parameters": { "get": { "operationId": "PipelineController_getParameters_v2", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Unique identifier of the entity in UUID v4 format", "schema": { "example": "f5d82b95-523d-438c-1002-bca5dc7748e7", "type": "string" } } ], "responses": { "200": { "description": "The list of parameters", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PipelineParameterDto" } } } } }, "400": { "description": "Invalid pipeline ID (E20001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Pipeline does not exist (E10001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Failed to get pipeline or parameters (E00001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Get parameters of the pipeline", "tags": [ "General operations with a single pipeline" ] }, "patch": { "description": "Operator", "operationId": "PipelineController_updateParameters_v2", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Unique identifier of the entity in UUID v4 format", "schema": { "example": "f5d82b95-523d-438c-1002-bca5dc7748e7", "type": "string" } } ], "requestBody": { "required": true, "description": "The list of parameters intended for modification", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePipelineParametersDto" } } } }, "responses": { "200": { "description": "The updated pipeline", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Pipeline" } } } }, "400": { "description": "Invalid pipeline ID (E20001) or pipeline is not editable (E20034) or invalid parameter ID or topic (E20027) or parameter topic is not found in the metadata (E20058) or parameter type and metadata type do not match based on topic (E20061) or connector does not exist for a parameter (E20040) or data type and connector payload type do not match (E20044) or parameter does not exist for the pipeline (E20046) or invalid topic for S7 connector (E20052)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Pipeline does not exist (E10001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Failed to get or update pipeline (E00001, E10003)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Update parameters of the active pipeline, which is not running", "tags": [ "General operations with a single pipeline" ] } }, "/v3/pipeline/{id}/parameters": { "get": { "operationId": "PipelineController_getParameters_v3", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Unique identifier of the entity in UUID v4 format", "schema": { "example": "f5d82b95-523d-438c-1002-bca5dc7748e7", "type": "string" } } ], "responses": { "200": { "description": "The list of parameters", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PipelineParameterDto" } } } } }, "400": { "description": "Invalid pipeline ID (E20001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Pipeline does not exist (E10001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Failed to get pipeline or parameters (E00001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Get parameters of the pipeline", "tags": [ "General operations with a single pipeline" ] }, "patch": { "description": "Operator", "operationId": "PipelineController_updateParameters_v3", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Unique identifier of the entity in UUID v4 format", "schema": { "example": "f5d82b95-523d-438c-1002-bca5dc7748e7", "type": "string" } } ], "requestBody": { "required": true, "description": "The list of parameters intended for modification", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePipelineParametersDto" } } } }, "responses": { "200": { "description": "The updated pipeline", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Pipeline" } } } }, "400": { "description": "Invalid pipeline ID (E20001) or pipeline is not editable (E20034) or invalid parameter ID or topic (E20027) or parameter topic is not found in the metadata (E20058) or parameter type and metadata type do not match based on topic (E20061) or connector does not exist for a parameter (E20040) or data type and connector payload type do not match (E20044) or parameter does not exist for the pipeline (E20046) or invalid topic for S7 connector (E20052)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "User permission is insufficient to perform this action (E00006)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Pipeline does not exist (E10001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Failed to get or update pipeline (E00001, E10003)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Update parameters of the active pipeline, which is not running", "tags": [ "General operations with a single pipeline" ] } }, "/v2/pipeline/{id}/parameters/reset": { "patch": { "description": "Operator", "operationId": "PipelineController_resetParameters_v2", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Unique identifier of the entity in UUID v4 format", "schema": { "example": "f5d82b95-523d-438c-1002-bca5dc7748e7", "type": "string" } } ], "responses": { "200": { "description": "The updated pipeline", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Pipeline" } } } }, "400": { "description": "Invalid pipeline ID (E20001) or pipeline is not editable (E20034)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Pipeline does not exist (E10001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Failed to get or update pipeline (E00001, E10003)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Reset parameters of the active pipeline, which is not running", "tags": [ "General operations with a single pipeline" ] } }, "/v3/pipeline/{id}/parameters/reset": { "patch": { "description": "Operator", "operationId": "PipelineController_resetParameters_v3", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Unique identifier of the entity in UUID v4 format", "schema": { "example": "f5d82b95-523d-438c-1002-bca5dc7748e7", "type": "string" } } ], "responses": { "200": { "description": "The updated pipeline", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Pipeline" } } } }, "400": { "description": "Invalid pipeline ID (E20001) or pipeline is not editable (E20034)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "User permission is insufficient to perform this action (E00006)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Pipeline does not exist (E10001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Failed to get or update pipeline (E00001, E10003)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Reset parameters of the active pipeline, which is not running", "tags": [ "General operations with a single pipeline" ] } }, "/v2/pipeline/{id}/tags": { "get": { "deprecated": true, "operationId": "PipelineController_getSelectedTags_v2", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Unique identifier of the entity in UUID v4 format", "schema": { "example": "f5d82b95-523d-438c-1002-bca5dc7748e7", "type": "string" } } ], "responses": { "200": { "description": "The list of the selected tags", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SelectedTag" } } } } }, "400": { "description": "Invalid pipeline ID (E20001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Pipeline does not exist (E10001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Failed to get pipeline or selected tags (E00001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Get selected tags of the pipeline", "tags": [ "General operations with a single pipeline" ] }, "patch": { "deprecated": true, "description": "Operator", "operationId": "PipelineController_updateSelectedTags_v2", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Unique identifier of the entity in UUID v4 format", "schema": { "example": "f5d82b95-523d-438c-1002-bca5dc7748e7", "type": "string" } } ], "requestBody": { "required": true, "description": "The list of selected tags intended for modification", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePipelineTagsDto" } } } }, "responses": { "200": { "description": "The updated pipeline", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Pipeline" } } } }, "400": { "description": "Invalid pipeline ID (E20001) or pipeline is inactive (E20032) or invalid topic/subtopicName/subtopicId/dataType/arrayDimensions/connectorId (E20007, E20008, E20009, E20010, E20055, E20017)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Pipeline does not exist (E10001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Failed to get or update pipeline (E00001, E10003)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Update selected tags of the pipeline", "tags": [ "General operations with a single pipeline" ] } }, "/v3/pipeline/{id}/tags": { "get": { "deprecated": true, "operationId": "PipelineController_getSelectedTags_v3", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Unique identifier of the entity in UUID v4 format", "schema": { "example": "f5d82b95-523d-438c-1002-bca5dc7748e7", "type": "string" } } ], "responses": { "200": { "description": "The list of the selected tags", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SelectedTag" } } } } }, "400": { "description": "Invalid pipeline ID (E20001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Pipeline does not exist (E10001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Failed to get pipeline or selected tags (E00001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Get selected tags of the pipeline", "tags": [ "General operations with a single pipeline" ] }, "patch": { "deprecated": true, "description": "Operator", "operationId": "PipelineController_updateSelectedTags_v3", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Unique identifier of the entity in UUID v4 format", "schema": { "example": "f5d82b95-523d-438c-1002-bca5dc7748e7", "type": "string" } } ], "requestBody": { "required": true, "description": "The list of selected tags intended for modification", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePipelineTagsDto" } } } }, "responses": { "200": { "description": "The updated pipeline", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Pipeline" } } } }, "400": { "description": "Invalid pipeline ID (E20001) or pipeline is inactive (E20032) or invalid topic/subtopicName/subtopicId/dataType/arrayDimensions/connectorId (E20007, E20008, E20009, E20010, E20055, E20017)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "User permission is insufficient to perform this action (E00006)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Pipeline does not exist (E10001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Failed to get or update pipeline (E00001, E10003)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Update selected tags of the pipeline", "tags": [ "General operations with a single pipeline" ] } }, "/v2/pipeline/{id}/replicas": { "get": { "operationId": "PipelineController_getComponentReplicas_v2", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Unique identifier of the entity in UUID v4 format", "schema": { "example": "f5d82b95-523d-438c-1002-bca5dc7748e7", "type": "string" } } ], "responses": { "200": { "description": "The list of the component replicas", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ComponentReplicasDto" } } } } }, "400": { "description": "Invalid pipeline ID (E20001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Pipeline does not exist (E10001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Failed to get pipeline (E00001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Get number of component replicas of the pipeline", "tags": [ "General operations with a single pipeline" ] }, "patch": { "description": "Operator", "operationId": "PipelineController_updateReplicas_v2", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Unique identifier of the entity in UUID v4 format", "schema": { "example": "f5d82b95-523d-438c-1002-bca5dc7748e7", "type": "string" } } ], "requestBody": { "required": true, "description": "The list of number of replicas of components intended for modification", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ComponentReplicasListDto" } } } }, "responses": { "200": { "description": "The updated pipeline", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Pipeline" } } } }, "400": { "description": "Invalid pipeline ID (E20001) or pipeline is not editable (E20034) or missing component replicas list (E20036) or replicas should be integer at least 1, maximum 8 (E20036) or invalid component ID (E20035) or pipeline parallel step execution is disabled (E20039)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Pipeline does not exist (E10001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Failed to get or update pipeline (E00001, E10003)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Update number of replicas of the active, but not-running pipeline's components", "tags": [ "General operations with a single pipeline" ] } }, "/v3/pipeline/{id}/replicas": { "get": { "operationId": "PipelineController_getComponentReplicas_v3", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Unique identifier of the entity in UUID v4 format", "schema": { "example": "f5d82b95-523d-438c-1002-bca5dc7748e7", "type": "string" } } ], "responses": { "200": { "description": "The list of the component replicas", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ComponentReplicasDto" } } } } }, "400": { "description": "Invalid pipeline ID (E20001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Pipeline does not exist (E10001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Failed to get pipeline (E00001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Get number of component replicas of the pipeline", "tags": [ "General operations with a single pipeline" ] }, "patch": { "description": "Operator", "operationId": "PipelineController_updateReplicas_v3", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Unique identifier of the entity in UUID v4 format", "schema": { "example": "f5d82b95-523d-438c-1002-bca5dc7748e7", "type": "string" } } ], "requestBody": { "required": true, "description": "The list of number of replicas of components intended for modification", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ComponentReplicasListDto" } } } }, "responses": { "200": { "description": "The updated pipeline", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Pipeline" } } } }, "400": { "description": "Invalid pipeline ID (E20001) or pipeline is not editable (E20034) or missing component replicas list (E20036) or replicas should be integer at least 1, maximum 8 (E20036) or invalid component ID (E20035) or pipeline parallel step execution is disabled (E20039)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "User permission is insufficient to perform this action (E00006)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Pipeline does not exist (E10001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Failed to get or update pipeline (E00001, E10003)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Update number of replicas of the active, but not-running pipeline's components", "tags": [ "General operations with a single pipeline" ] } }, "/v2/pipeline/{id}/activate": { "post": { "description": "Operator", "operationId": "PipelineController_activate_v2", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Unique identifier of the entity in UUID v4 format", "schema": { "example": "f5d82b95-523d-438c-1002-bca5dc7748e7", "type": "string" } } ], "responses": { "201": { "description": "The pipeline ID along with warnings", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PipelineMessageDto" } } } }, "400": { "description": "Invalid pipeline ID (E20001) or there are too many activated pipelines (E20029) or pipeline is active (E20033) or pipeline parameter names should be unique (E20056) or pipeline variable names should be unique (E20057)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Pipeline does not exist (E10001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Failed to get pipeline (E00001) or failed to activate pipeline (E10008) or failed to load configuration file (E40001) or failed to parse configuration file (E40002) or failed to save pipeline configuration (E10009)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Activate pipeline using pipeline ID", "tags": [ "General operations with a single pipeline" ] }, "delete": { "description": "Operator", "operationId": "PipelineController_deactivate_v2", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Unique identifier of the entity in UUID v4 format", "schema": { "example": "f5d82b95-523d-438c-1002-bca5dc7748e7", "type": "string" } } ], "responses": { "200": { "description": "The ID of the deactivated pipeline", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdDto" } } } }, "400": { "description": "Invalid pipeline ID (E20001) or pipeline is inactive (E20032)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Pipeline does not exist (E10001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Failed to get pipeline (E00001) or failed to deactivate pipeline (E10008)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Deactivate the not-running pipeline using pipeline ID", "tags": [ "General operations with a single pipeline" ] } }, "/v3/pipeline/{id}/activate": { "post": { "description": "Operator", "operationId": "PipelineController_activate_v3", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Unique identifier of the entity in UUID v4 format", "schema": { "example": "f5d82b95-523d-438c-1002-bca5dc7748e7", "type": "string" } } ], "responses": { "201": { "description": "The pipeline ID along with warnings", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PipelineMessageDto" } } } }, "400": { "description": "Invalid pipeline ID (E20001) or there are too many activated pipelines (E20029) or pipeline is active (E20033) or pipeline parameter names should be unique (E20056) or pipeline variable names should be unique (E20057)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "User permission is insufficient to perform this action (E00006)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Pipeline does not exist (E10001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Failed to get pipeline (E00001) or failed to activate pipeline (E10008) or failed to load configuration file (E40001) or failed to parse configuration file (E40002) or failed to save pipeline configuration (E10009)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Activate pipeline using pipeline ID", "tags": [ "General operations with a single pipeline" ] }, "delete": { "description": "Operator", "operationId": "PipelineController_deactivate_v3", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Unique identifier of the entity in UUID v4 format", "schema": { "example": "f5d82b95-523d-438c-1002-bca5dc7748e7", "type": "string" } } ], "responses": { "200": { "description": "The ID of the deactivated pipeline", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdDto" } } } }, "400": { "description": "Invalid pipeline ID (E20001) or pipeline is inactive (E20032)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "User permission is insufficient to perform this action (E00006)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Pipeline does not exist (E10001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Failed to get pipeline (E00001) or failed to deactivate pipeline (E10008)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Deactivate the not-running pipeline using pipeline ID", "tags": [ "General operations with a single pipeline" ] } }, "/v2/pipeline/{id}/readme": { "get": { "operationId": "PipelineController_getReadme_v2", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Unique identifier of the entity in UUID v4 format", "schema": { "example": "f5d82b95-523d-438c-1002-bca5dc7748e7", "type": "string" } } ], "responses": { "200": { "description": "The readme file", "content": { "application/json": { "schema": { "type": "string" } } } }, "400": { "description": "Invalid pipeline ID (E20001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "No readme html found (E40003) or Pipeline does not exist (E10001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Failed to load the file (E00004) or Failed to get pipeline (E00001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Get the readme file", "tags": [ "General operations with a single pipeline" ] } }, "/v3/pipeline/{id}/readme": { "get": { "operationId": "PipelineController_getReadme_v3", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Unique identifier of the entity in UUID v4 format", "schema": { "example": "f5d82b95-523d-438c-1002-bca5dc7748e7", "type": "string" } } ], "responses": { "200": { "description": "The readme file", "content": { "application/json": { "schema": { "type": "string" } } } }, "400": { "description": "Invalid pipeline ID (E20001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "No readme html found (E40003) or Pipeline does not exist (E10001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Failed to load the file (E00004) or Failed to get pipeline (E00001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Get the readme file", "tags": [ "General operations with a single pipeline" ] } }, "/v2/pipelines": { "delete": { "description": "AppAdmin", "operationId": "MultiplePipelineController_remove_v2", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdListDto" } } } }, "responses": { "200": { "description": "The list of the deleted pipeline IDs along with errors if occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiplePipelineOperationDto" } } } }, "500": { "description": "At least one of the pipeline operations failed (due to various reasons)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiplePipelineOperationDto" } } } } }, "summary": "Delete multiple inactive pipelines", "tags": [ "Multiple pipeline operations" ] } }, "/v3/pipelines": { "delete": { "description": "AppAdmin", "operationId": "MultiplePipelineController_remove_v3", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdListDto" } } } }, "responses": { "200": { "description": "The list of the deleted pipeline IDs along with errors if occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiplePipelineOperationDto" } } } }, "403": { "description": "User permission is insufficient to perform this action (E00006)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "At least one of the pipeline operations failed (due to various reasons)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiplePipelineOperationDto" } } } } }, "summary": "Delete multiple inactive pipelines", "tags": [ "Multiple pipeline operations" ] } }, "/v2/pipelines/activate": { "post": { "description": "Operator", "operationId": "MultiplePipelineController_activate_v2", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdListDto" } } } }, "responses": { "201": { "description": "The list of the activated pipeline IDs along with warning messages and errors if occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiplePipelineOperationDto" } } } }, "400": { "description": "There are too many activated pipelines (E20029)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Failed to get pipeline list (E00001) or at least one of the pipeline operations failed (due to various reasons)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Activate multiple pipelines using pipeline IDs", "tags": [ "Multiple pipeline operations" ] }, "delete": { "description": "Operator", "operationId": "MultiplePipelineController_deactivate_v2", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdListDto" } } } }, "responses": { "200": { "description": "The list of the deleted pipeline IDs along with errors if occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiplePipelineOperationDto" } } } }, "500": { "description": "At least one of the pipeline operations failed (due to various reasons)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiplePipelineOperationDto" } } } } }, "summary": "Deactivate multiple not-running pipelines using pipeline IDs", "tags": [ "Multiple pipeline operations" ] } }, "/v3/pipelines/activate": { "post": { "description": "Operator", "operationId": "MultiplePipelineController_activate_v3", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdListDto" } } } }, "responses": { "201": { "description": "The list of the activated pipeline IDs along with warning messages and errors if occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiplePipelineOperationDto" } } } }, "400": { "description": "There are too many activated pipelines (E20029)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "User permission is insufficient to perform this action (E00006)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Failed to get pipeline list (E00001) or at least one of the pipeline operations failed (due to various reasons)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Activate multiple pipelines using pipeline IDs", "tags": [ "Multiple pipeline operations" ] }, "delete": { "description": "Operator", "operationId": "MultiplePipelineController_deactivate_v3", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdListDto" } } } }, "responses": { "200": { "description": "The list of the deleted pipeline IDs along with errors if occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiplePipelineOperationDto" } } } }, "403": { "description": "User permission is insufficient to perform this action (E00006)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "At least one of the pipeline operations failed (due to various reasons)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiplePipelineOperationDto" } } } } }, "summary": "Deactivate multiple not-running pipelines using pipeline IDs", "tags": [ "Multiple pipeline operations" ] } }, "/v2/pipeline/{id}/execution": { "post": { "description": "Operator", "operationId": "PipelineExecutionController_startExecution_v2", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Unique identifier of the entity in UUID v4 format", "schema": { "example": "f5d82b95-523d-438c-1002-bca5dc7748e7", "type": "string" } } ], "responses": { "201": { "description": "The updated pipeline", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Pipeline" } } } }, "400": { "description": "Missing credentials for connector (E20006) or execution operation is in-progress (E20038) or invalid pipeline ID (E20001) or pipeline is not active (E20032) or pipeline status is incorrect to start/resume (E20002) or pipeline internal status is incorrect (E20049) or pipeline variable type and metadata type do not match (E20061) or topic validation problem for pipeline variables and parameters (E20058) or the topic of an Integer output variable is not found in the metadata for the data bus with SIMATIC v1 payload format (E20058) or the used Python version is unsupported (E20064)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Pipeline does not exist (E10001) or connector does not exist (E10005)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Failed to get pipeline (E00001) or failed to get connectors (E00001) or general Orchestrator error (E50000)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Start/resume the execution of the active, not-running pipeline", "tags": [ "Handling the execution of a single pipeline" ] }, "delete": { "description": "Operator", "operationId": "PipelineExecutionController_stopExecution_v2", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Unique identifier of the entity in UUID v4 format", "schema": { "example": "f5d82b95-523d-438c-1002-bca5dc7748e7", "type": "string" } } ], "responses": { "200": { "description": "The updated pipeline", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Pipeline" } } } }, "400": { "description": "Invalid pipeline ID (E20001) or pipeline is not active (E20032) or pipeline status is incorrect to stop (E20003) or execution operation is in-progress (E20038) or pipeline status is incorrect to stop on Orchestrator (E20016)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Pipeline does not exist (E10001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Failed to get pipeline (E00001) or general Orchestrator error (E50000)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Stop the execution of the running pipeline", "tags": [ "Handling the execution of a single pipeline" ] }, "patch": { "description": "Operator", "operationId": "PipelineExecutionController_pauseExecution_v2", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Unique identifier of the entity in UUID v4 format", "schema": { "example": "f5d82b95-523d-438c-1002-bca5dc7748e7", "type": "string" } } ], "responses": { "200": { "description": "The updated pipeline", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Pipeline" } } } }, "400": { "description": "Invalid pipeline ID (E20001) or execution operation is in-progress (E20038) or pipeline is not active (E20032) or pipeline status is incorrect to pause (E20003) or pipeline status is incorrect to pause on Orchestrator (E20015)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Pipeline does not exist (E10001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Failed to get pipeline (E00001) or general Orchestrator error (E50000)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Pause the execution of the running pipeline", "tags": [ "Handling the execution of a single pipeline" ] }, "get": { "operationId": "PipelineExecutionController_getExecutionStatus_v2", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Unique identifier of the entity in UUID v4 format", "schema": { "example": "f5d82b95-523d-438c-1002-bca5dc7748e7", "type": "string" } } ], "responses": { "200": { "description": "The execution status of the pipeline provided by Orchestrator", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PipelineStatusDto" } } } }, "400": { "description": "Invalid pipeline ID (E20001) or pipeline is not active (E20032)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Pipeline does not exist (E10001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Failed to get pipeline (E00001) or general Orchestrator error (E50000)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Get status of active pipeline execution without debug information", "tags": [ "Handling the execution of a single pipeline" ] } }, "/v3/pipeline/{id}/execution": { "post": { "description": "Operator", "operationId": "PipelineExecutionController_startExecution_v3", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Unique identifier of the entity in UUID v4 format", "schema": { "example": "f5d82b95-523d-438c-1002-bca5dc7748e7", "type": "string" } } ], "responses": { "201": { "description": "The updated pipeline", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Pipeline" } } } }, "400": { "description": "Missing credentials for connector (E20006) or execution operation is in-progress (E20038) or invalid pipeline ID (E20001) or pipeline is not active (E20032) or pipeline status is incorrect to start/resume (E20002) or pipeline internal status is incorrect (E20049) or pipeline variable type and metadata type do not match (E20061) or topic validation problem for pipeline variables and parameters (E20058) or the topic of an Integer output variable is not found in the metadata for the data bus with SIMATIC v1 payload format (E20058) or the used Python version is unsupported (E20064)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "User permission is insufficient to perform this action (E00006)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Pipeline does not exist (E10001) or connector does not exist (E10005)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Failed to get pipeline (E00001) or failed to get connectors (E00001) or general Orchestrator error (E50000)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Start/resume the execution of the active, not-running pipeline", "tags": [ "Handling the execution of a single pipeline" ] }, "delete": { "description": "Operator", "operationId": "PipelineExecutionController_stopExecution_v3", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Unique identifier of the entity in UUID v4 format", "schema": { "example": "f5d82b95-523d-438c-1002-bca5dc7748e7", "type": "string" } } ], "responses": { "200": { "description": "The updated pipeline", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Pipeline" } } } }, "400": { "description": "Invalid pipeline ID (E20001) or pipeline is not active (E20032) or pipeline status is incorrect to stop (E20003) or execution operation is in-progress (E20038) or pipeline status is incorrect to stop on Orchestrator (E20016)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "User permission is insufficient to perform this action (E00006)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Pipeline does not exist (E10001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Failed to get pipeline (E00001) or general Orchestrator error (E50000)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Stop the execution of the running pipeline", "tags": [ "Handling the execution of a single pipeline" ] }, "patch": { "description": "Operator", "operationId": "PipelineExecutionController_pauseExecution_v3", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Unique identifier of the entity in UUID v4 format", "schema": { "example": "f5d82b95-523d-438c-1002-bca5dc7748e7", "type": "string" } } ], "responses": { "200": { "description": "The updated pipeline", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Pipeline" } } } }, "400": { "description": "Invalid pipeline ID (E20001) or execution operation is in-progress (E20038) or pipeline is not active (E20032) or pipeline status is incorrect to pause (E20003) or pipeline status is incorrect to pause on Orchestrator (E20015)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "User permission is insufficient to perform this action (E00006)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Pipeline does not exist (E10001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Failed to get pipeline (E00001) or general Orchestrator error (E50000)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Pause the execution of the running pipeline", "tags": [ "Handling the execution of a single pipeline" ] }, "get": { "operationId": "PipelineExecutionController_getExecutionStatus_v3", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Unique identifier of the entity in UUID v4 format", "schema": { "example": "f5d82b95-523d-438c-1002-bca5dc7748e7", "type": "string" } } ], "responses": { "200": { "description": "The execution status of the pipeline provided by Orchestrator", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PipelineStatusDto" } } } }, "400": { "description": "Invalid pipeline ID (E20001) or pipeline is not active (E20032)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Pipeline does not exist (E10001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Failed to get pipeline (E00001) or general Orchestrator error (E50000)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Get status of active pipeline execution without debug information", "tags": [ "Handling the execution of a single pipeline" ] } }, "/v2/pipeline/{id}/execution/statistics": { "delete": { "description": "Operator", "operationId": "PipelineExecutionController_clearExecutionStatistics_v2", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Unique identifier of the entity in UUID v4 format", "schema": { "example": "f5d82b95-523d-438c-1002-bca5dc7748e7", "type": "string" } } ], "responses": { "200": { "description": "Clearing operation has been performed successfully" }, "400": { "description": "Invalid pipeline ID (E20001) or pipeline is not active (E20032) or pipeline is not running (E20059)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Pipeline does not exist (E10001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Failed to get pipeline (E00001) or general Orchestrator error (E50000)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Clear the execution statistics of the pipeline", "tags": [ "Handling the execution of a single pipeline" ] } }, "/v3/pipeline/{id}/execution/statistics": { "delete": { "description": "Operator", "operationId": "PipelineExecutionController_clearExecutionStatistics_v3", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Unique identifier of the entity in UUID v4 format", "schema": { "example": "f5d82b95-523d-438c-1002-bca5dc7748e7", "type": "string" } } ], "responses": { "200": { "description": "Clearing operation has been performed successfully" }, "400": { "description": "Invalid pipeline ID (E20001) or pipeline is not active (E20032) or pipeline is not running (E20059)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "User permission is insufficient to perform this action (E00006)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Pipeline does not exist (E10001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Failed to get pipeline (E00001) or general Orchestrator error (E50000)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Clear the execution statistics of the pipeline", "tags": [ "Handling the execution of a single pipeline" ] } }, "/v1/pipeline/{id}/{version}/events": { "get": { "deprecated": true, "operationId": "PipelineExecutionController_getDetailedExecutionStatusV1_v1", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Unique identifier of pipeline", "schema": { "example": "f5d82b95-523d-438c-1002-bca5dc7748e7", "type": "string" } }, { "name": "version", "required": true, "in": "path", "description": "Version of the pipeline", "schema": { "example": "1.0.0", "type": "string" } } ], "responses": { "200": { "description": "The execution status of the pipeline provided by Orchestrator along with the debug settings", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PipelineStatusDto" } } } }, "400": { "description": "Invalid pipeline ID (E20001) or pipeline is not found (E10001) or pipeline is not active (E20032)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Get status of active pipeline execution with debug information", "tags": [ "Handling the execution of a single pipeline" ] } }, "/v2/pipeline/{id}/{version}/events": { "get": { "operationId": "PipelineExecutionController_getDetailedExecutionStatus_v2", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Unique identifier of pipeline", "schema": { "example": "f5d82b95-523d-438c-1002-bca5dc7748e7", "type": "string" } }, { "name": "version", "required": true, "in": "path", "description": "Version of the pipeline", "schema": { "example": "1.0.0", "type": "string" } } ], "responses": { "200": { "description": "The execution status of the pipeline provided by Orchestrator along with the debug settings", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PipelineStatusDto" } } } }, "400": { "description": "Invalid pipeline ID (E20001) or pipeline is not found (E10001) or pipeline is not active (E20032)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Get status of active pipeline execution with debug information", "tags": [ "Handling the execution of a single pipeline" ] } }, "/v3/pipeline/{id}/{version}/events": { "get": { "operationId": "PipelineExecutionController_getDetailedExecutionStatus_v3", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Unique identifier of pipeline", "schema": { "example": "f5d82b95-523d-438c-1002-bca5dc7748e7", "type": "string" } }, { "name": "version", "required": true, "in": "path", "description": "Version of the pipeline", "schema": { "example": "1.0.0", "type": "string" } } ], "responses": { "200": { "description": "The execution status of the pipeline provided by Orchestrator along with the debug settings", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PipelineStatusDto" } } } }, "400": { "description": "Invalid pipeline ID (E20001) or pipeline is not found (E10001) or pipeline is not active (E20032)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Get status of active pipeline execution with debug information", "tags": [ "Handling the execution of a single pipeline" ] } }, "/v2/pipelines/execution": { "get": { "operationId": "MultiplePipelineExecutionController_getMetricsForActivePipelines_v2", "parameters": [], "responses": { "200": { "description": "The execution statuses of the active pipelines and the memory usage of the internal components provided by Orchestrator", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricsDto" } } } }, "404": { "description": "Metrics cannot be found (E00001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Failed to get pipeline (E00001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Get metrics of pipeline execution for active pipelines", "tags": [ "Multiple pipeline operations" ] }, "post": { "description": "Operator", "operationId": "MultiplePipelineExecutionController_startMultipleExecution_v2", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdListDto" } } } }, "responses": { "201": { "description": "The pipeline ID list and errors", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiplePipelineOperationDto" } } } }, "404": { "description": "Connector does not exist (E10005)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "At least one of the pipeline operations failed (due to various reasons)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiplePipelineOperationDto" } } } } }, "summary": "Start/resume multiple pipeline execution", "tags": [ "Multiple pipeline operations" ] }, "delete": { "description": "Operator", "operationId": "MultiplePipelineExecutionController_stopMultipleExecution_v2", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdListDto" } } } }, "responses": { "201": { "description": "The pipeline ID list and errors", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiplePipelineOperationDto" } } } }, "500": { "description": "At least one of the pipeline operations failed (due to various reasons)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiplePipelineOperationDto" } } } } }, "summary": "Stop multiple pipeline execution", "tags": [ "Multiple pipeline operations" ] }, "patch": { "description": "Operator", "operationId": "MultiplePipelineExecutionController_pauseMultipleExecution_v2", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdListDto" } } } }, "responses": { "201": { "description": "The pipeline ID list and errors", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiplePipelineOperationDto" } } } }, "500": { "description": "At least one of the pipeline operations failed (due to various reasons)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiplePipelineOperationDto" } } } } }, "summary": "Pause multiple pipeline execution", "tags": [ "Multiple pipeline operations" ] } }, "/v3/pipelines/execution": { "get": { "operationId": "MultiplePipelineExecutionController_getMetricsForActivePipelines_v3", "parameters": [], "responses": { "200": { "description": "The execution statuses of the active pipelines and the memory usage of the internal components provided by Orchestrator", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricsDto" } } } }, "404": { "description": "Metrics cannot be found (E00001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Failed to get pipeline (E00001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Get metrics of pipeline execution for active pipelines", "tags": [ "Multiple pipeline operations" ] }, "post": { "description": "Operator", "operationId": "MultiplePipelineExecutionController_startMultipleExecution_v3", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdListDto" } } } }, "responses": { "201": { "description": "The pipeline ID list and errors", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiplePipelineOperationDto" } } } }, "403": { "description": "User permission is insufficient to perform this action (E00006)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Connector does not exist (E10005)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "At least one of the pipeline operations failed (due to various reasons)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiplePipelineOperationDto" } } } } }, "summary": "Start/resume multiple pipeline execution", "tags": [ "Multiple pipeline operations" ] }, "delete": { "description": "Operator", "operationId": "MultiplePipelineExecutionController_stopMultipleExecution_v3", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdListDto" } } } }, "responses": { "201": { "description": "The pipeline ID list and errors", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiplePipelineOperationDto" } } } }, "403": { "description": "User permission is insufficient to perform this action (E00006)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "At least one of the pipeline operations failed (due to various reasons)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiplePipelineOperationDto" } } } } }, "summary": "Stop multiple pipeline execution", "tags": [ "Multiple pipeline operations" ] }, "patch": { "description": "Operator", "operationId": "MultiplePipelineExecutionController_pauseMultipleExecution_v3", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdListDto" } } } }, "responses": { "201": { "description": "The pipeline ID list and errors", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiplePipelineOperationDto" } } } }, "403": { "description": "User permission is insufficient to perform this action (E00006)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "At least one of the pipeline operations failed (due to various reasons)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiplePipelineOperationDto" } } } } }, "summary": "Pause multiple pipeline execution", "tags": [ "Multiple pipeline operations" ] } }, "/v2/connector": { "get": { "operationId": "ConnectorController_getConnectors_v2", "parameters": [], "responses": { "200": { "description": "The connector list", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Connector" } } } } }, "500": { "description": "Error occurred during fetching the connectors (E00001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Get the connector list", "tags": [ "Handling data connections" ] }, "post": { "description": "Operator", "operationId": "ConnectorController_createConnector_v2", "parameters": [], "requestBody": { "required": true, "description": "The new connector data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorDto" } } } }, "responses": { "201": { "description": "The created connector", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Connector" } } } }, "400": { "description": "Duplicated connector name (E10006) or validation error (E20018) or connector type validation error (E20019) or password validation error (E20005) or username validation error (E20004) or authorization error (E60002)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Failed to create the connector (E00001) or connector error (E60000)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Create a new connector", "tags": [ "Handling data connections" ] } }, "/v3/connector": { "get": { "operationId": "ConnectorController_getConnectors_v3", "parameters": [], "responses": { "200": { "description": "The connector list", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Connector" } } } } }, "500": { "description": "Error occurred during fetching the connectors (E00001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Get the connector list", "tags": [ "Handling data connections" ] }, "post": { "description": "Operator", "operationId": "ConnectorController_createConnector_v3", "parameters": [], "requestBody": { "required": true, "description": "The new connector data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorDto" } } } }, "responses": { "201": { "description": "The created connector", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Connector" } } } }, "400": { "description": "Duplicated connector name (E10006) or validation error (E20018) or connector type validation error (E20019) or password validation error (E20005) or username validation error (E20004) or authorization error (E60002)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "User permission is insufficient to perform this action (E00006)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Failed to create the connector (E00001) or connector error (E60000)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Create a new connector", "tags": [ "Handling data connections" ] } }, "/v2/connector/configuration": { "get": { "operationId": "ConnectorController_getConnectorConfigurations_v2", "parameters": [], "responses": { "200": { "description": "The connector configuration list", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ConnectorConfigurationDto" } } } } } }, "summary": "Get the connector configuration", "tags": [ "Handling data connections" ] } }, "/v3/connector/configuration": { "get": { "operationId": "ConnectorController_getConnectorConfigurations_v3", "parameters": [], "responses": { "200": { "description": "The connector configuration list", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ConnectorConfigurationDto" } } } } } }, "summary": "Get the connector configuration", "tags": [ "Handling data connections" ] } }, "/v2/connector/{id}": { "get": { "operationId": "ConnectorController_getConnector_v2", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Unique identifier of the entity in UUID v4 format", "schema": { "example": "f5d82b95-523d-438c-1002-bca5dc7748e7", "type": "string" } } ], "responses": { "200": { "description": "The connector", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Connector" } } } }, "400": { "description": "Invalid connector ID (E20017)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Connector not found (E10005)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Error occurred during fetching the connector (E00001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Get the specific connector using ID", "tags": [ "Handling data connections" ] }, "patch": { "description": "Operator", "operationId": "ConnectorController_updateConnector_v2", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Unique identifier of the entity in UUID v4 format", "schema": { "example": "f5d82b95-523d-438c-1002-bca5dc7748e7", "type": "string" } } ], "requestBody": { "required": true, "description": "The updated data of the connector", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorDto" } } } }, "responses": { "200": { "description": "The updated connector", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Connector" } } } }, "400": { "description": "Duplicated connector (E10006) or validation error (E20018) or connector type validation error (E20019) or password validation error (E20005) or username validation error (E20004) or authorization error (E60002) or there is a running pipeline (E20023)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Connector not found E10005", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Error occurred during fetching the connector or failed to update the connector (E00001) or connector error (E60000)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Update the specific connector using ID. It is allowed if there is no running pipeline", "tags": [ "Handling data connections" ] }, "delete": { "description": "AppAdmin", "operationId": "ConnectorController_deleteConnector_v2", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Unique identifier of the entity in UUID v4 format", "schema": { "example": "f5d82b95-523d-438c-1002-bca5dc7748e7", "type": "string" } } ], "responses": { "200": { "description": "Returns true if the connector have been removed otherwise false" }, "400": { "description": "Invalid connector ID (E20017) or there is a running pipeline (E20023)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Connector not found (E10005)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Error occurred during fetching the connector or failed to remove the connector (E00001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Delete the specific connector using ID. It is allowed if there is no running pipeline", "tags": [ "Handling data connections" ] } }, "/v3/connector/{id}": { "get": { "operationId": "ConnectorController_getConnector_v3", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Unique identifier of the entity in UUID v4 format", "schema": { "example": "f5d82b95-523d-438c-1002-bca5dc7748e7", "type": "string" } } ], "responses": { "200": { "description": "The connector", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Connector" } } } }, "400": { "description": "Invalid connector ID (E20017)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Connector not found (E10005)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Error occurred during fetching the connector (E00001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Get the specific connector using ID", "tags": [ "Handling data connections" ] }, "patch": { "description": "Operator", "operationId": "ConnectorController_updateConnector_v3", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Unique identifier of the entity in UUID v4 format", "schema": { "example": "f5d82b95-523d-438c-1002-bca5dc7748e7", "type": "string" } } ], "requestBody": { "required": true, "description": "The updated data of the connector", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorDto" } } } }, "responses": { "200": { "description": "The updated connector", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Connector" } } } }, "400": { "description": "Duplicated connector (E10006) or validation error (E20018) or connector type validation error (E20019) or password validation error (E20005) or username validation error (E20004) or authorization error (E60002) or there is a running pipeline (E20023)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "User permission is insufficient to perform this action (E00006)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Connector not found E10005", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Error occurred during fetching the connector or failed to update the connector (E00001) or connector error (E60000)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Update the specific connector using ID. It is allowed if there is no running pipeline", "tags": [ "Handling data connections" ] }, "delete": { "description": "AppAdmin", "operationId": "ConnectorController_deleteConnector_v3", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Unique identifier of the entity in UUID v4 format", "schema": { "example": "f5d82b95-523d-438c-1002-bca5dc7748e7", "type": "string" } } ], "responses": { "200": { "description": "Returns true if the connector have been removed otherwise false" }, "400": { "description": "Invalid connector ID (E20017) or there is a running pipeline (E20023)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "User permission is insufficient to perform this action (E00006)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Connector not found (E10005)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Error occurred during fetching the connector or failed to remove the connector (E00001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Delete the specific connector using ID. It is allowed if there is no running pipeline", "tags": [ "Handling data connections" ] } }, "/v2/connector/{id}/tags": { "get": { "operationId": "ConnectorController_getTags_v2", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Unique identifier of the entity in UUID v4 format", "schema": { "example": "f5d82b95-523d-438c-1002-bca5dc7748e7", "type": "string" } } ], "responses": { "200": { "description": "The tags from the connector" }, "400": { "description": "Invalid connector ID (E20017) or Connector tags are disabled (E20042) or Connector type not supports tags (E20043)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Connector not found (E10005)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Failed to fetch connector (E00001) or MQTT error occurred (E60000)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Get tags from the connector", "tags": [ "Handling data connections" ] } }, "/v3/connector/{id}/tags": { "get": { "operationId": "ConnectorController_getTags_v3", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Unique identifier of the entity in UUID v4 format", "schema": { "example": "f5d82b95-523d-438c-1002-bca5dc7748e7", "type": "string" } } ], "responses": { "200": { "description": "The tags from the connector" }, "400": { "description": "Invalid connector ID (E20017) or Connector tags are disabled (E20042) or Connector type not supports tags (E20043)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Connector not found (E10005)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Failed to fetch connector (E00001) or MQTT error occurred (E60000)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Get tags from the connector", "tags": [ "Handling data connections" ] } }, "/v2/connector/vision/classes": { "get": { "operationId": "ConnectorController_getVisionCameraClasses_v2", "parameters": [], "responses": { "200": { "description": "The camera classes from the vision connector" }, "500": { "description": "Failed to fetch camera classes (E60003)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Get camera classes from the vision connector", "tags": [ "Handling data connections" ] } }, "/v3/connector/vision/classes": { "get": { "operationId": "ConnectorController_getVisionCameraClasses_v3", "parameters": [], "responses": { "200": { "description": "The camera classes from the vision connector" }, "500": { "description": "Failed to fetch camera classes (E60003)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Get camera classes from the vision connector", "tags": [ "Handling data connections" ] } }, "/v2/connector/vision/instances": { "get": { "operationId": "ConnectorController_getVisionInstances_v2", "parameters": [], "responses": { "200": { "description": "The instances from the vision connector" }, "500": { "description": "Failed to fetch instances (E60003)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Get instances from the vision connector", "tags": [ "Handling data connections" ] } }, "/v3/connector/vision/instances": { "get": { "operationId": "ConnectorController_getVisionInstances_v3", "parameters": [], "responses": { "200": { "description": "The instances from the vision connector" }, "500": { "description": "Failed to fetch instances (E60003)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Get instances from the vision connector", "tags": [ "Handling data connections" ] } }, "/v2/connector/rib/{id}/meta": { "get": { "operationId": "ConnectorController_getInputSymbols_v2", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Unique identifier of the entity in UUID v4 format", "schema": { "example": "f5d82b95-523d-438c-1002-bca5dc7748e7", "type": "string" } } ], "responses": { "200": { "description": "The RIB input symbol information from the connector", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RibMetaDto" } } } } }, "400": { "description": "Invalid connector ID (E20017)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Connector not found or is not of type RIB (E10005)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Failed to fetch RIB input symbol information from connector (E00001) or RIB general error occurred (E60004)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Get RIB input symbol information from the connector", "tags": [ "Handling data connections" ] } }, "/v3/connector/rib/{id}/meta": { "get": { "operationId": "ConnectorController_getInputSymbols_v3", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Unique identifier of the entity in UUID v4 format", "schema": { "example": "f5d82b95-523d-438c-1002-bca5dc7748e7", "type": "string" } } ], "responses": { "200": { "description": "The RIB input symbol information from the connector", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RibMetaDto" } } } } }, "400": { "description": "Invalid connector ID (E20017)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Connector not found or is not of type RIB (E10005)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Failed to fetch RIB input symbol information from connector (E00001) or RIB general error occurred (E60004)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "summary": "Get RIB input symbol information from the connector", "tags": [ "Handling data connections" ] } }, "/v2/configuration-package/status": { "get": { "description": "Admin", "operationId": "PipelineExternalController_status_v2", "parameters": [], "responses": { "200": { "description": "The operation returns the list of the pipelines with statuses", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PipelineExternalStatusDto" } } } } }, "500": { "description": "Failed to fetch the pipeline list (E00001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PipelineExternalErrorDto" } } } } }, "summary": "Get the status of pipelines", "tags": [ "Pipeline operations for internal components" ] } }, "/v3/configuration-package/status": { "get": { "description": "Admin", "operationId": "PipelineExternalController_status_v3", "parameters": [], "responses": { "200": { "description": "The operation returns the list of the pipelines with statuses", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PipelineExternalStatusDto" } } } } }, "403": { "description": "User permission is insufficient to perform this action (E00006)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Failed to fetch the pipeline list (E00001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PipelineExternalErrorDto" } } } } }, "summary": "Get the status of pipelines", "tags": [ "Pipeline operations for internal components" ] } }, "/v2/configuration-package/deployments/{id}": { "put": { "description": "Admin", "operationId": "PipelineExternalController_saveAgent_v2", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Unique identifier of the entity in UUID v4 format", "schema": { "example": "f5d82b95-523d-438c-1002-bca5dc7748e7", "type": "string" } } ], "requestBody": { "required": true, "description": "The path of the pipeline package and optional meta information", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PipelinePackageDto" } } } }, "responses": { "200": { "description": "The operation returns the deploymentId of the pipeline and the AVAILABLE status", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PipelineExternalStatusDto" } } } }, "400": { "description": "Invalid pipeline ID (E20001) or invalid pipeline name, version (E20022) or invalid path (E20021) or invalid origin ID (E20048) or invalid package ID (E20013) or duplicated pipeline (E20030, E20028) or pipeline parameter names should be unique (E20056) or pipeline variable names should be unique (E20057)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PipelineExternalErrorDto" } } } }, "500": { "description": "Failed to call Model Distributor (E80000) or failed to create pipeline (E10002) or the installed AI Inference Server does not support GPU (E80001) or failed to load configuration file (E40001) or failed to parse configuration file (E40002) or failed to save pipeline configuration (E10009)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PipelineExternalErrorDto" } } } } }, "summary": "Creating new pipeline coming from internal component", "tags": [ "Pipeline operations for internal components" ] }, "delete": { "description": "Admin", "operationId": "PipelineExternalController_softRemove_v2", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Unique identifier of the entity in UUID v4 format", "schema": { "example": "f5d82b95-523d-438c-1002-bca5dc7748e7", "type": "string" } } ], "responses": { "200": { "description": "The operation returns the status of the pipeline along with the occurred error code and message", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PipelineExternalStatusDto" } } } }, "400": { "description": "Missing or invalid pipeline ID (E20001) or pipeline status is incorrect to delete (E20034)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PipelineExternalErrorDto" } } } }, "404": { "description": "No pipeline exist with the given ID (E10001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PipelineExternalErrorDto" } } } }, "500": { "description": "Failed to fetch the pipeline or failed to remove it (E00001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PipelineExternalErrorDto" } } } } }, "summary": "Soft delete the pipeline", "tags": [ "Pipeline operations for internal components" ] } }, "/v3/configuration-package/deployments/{id}": { "put": { "description": "Admin", "operationId": "PipelineExternalController_saveAgent_v3", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Unique identifier of the entity in UUID v4 format", "schema": { "example": "f5d82b95-523d-438c-1002-bca5dc7748e7", "type": "string" } } ], "requestBody": { "required": true, "description": "The path of the pipeline package and optional meta information", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PipelinePackageDto" } } } }, "responses": { "200": { "description": "The operation returns the deploymentId of the pipeline and the AVAILABLE status", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PipelineExternalStatusDto" } } } }, "400": { "description": "Invalid pipeline ID (E20001) or invalid pipeline name, version (E20022) or invalid path (E20021) or invalid origin ID (E20048) or invalid package ID (E20013) or duplicated pipeline (E20030, E20028) or pipeline parameter names should be unique (E20056) or pipeline variable names should be unique (E20057)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PipelineExternalErrorDto" } } } }, "403": { "description": "User permission is insufficient to perform this action (E00006)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Failed to call Model Distributor (E80000) or failed to create pipeline (E10002) or the installed AI Inference Server does not support GPU (E80001) or failed to load configuration file (E40001) or failed to parse configuration file (E40002) or failed to save pipeline configuration (E10009)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PipelineExternalErrorDto" } } } } }, "summary": "Creating new pipeline coming from internal component", "tags": [ "Pipeline operations for internal components" ] }, "delete": { "description": "Admin", "operationId": "PipelineExternalController_softRemove_v3", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Unique identifier of the entity in UUID v4 format", "schema": { "example": "f5d82b95-523d-438c-1002-bca5dc7748e7", "type": "string" } } ], "responses": { "200": { "description": "The operation returns the status of the pipeline along with the occurred error code and message", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PipelineExternalStatusDto" } } } }, "400": { "description": "Missing or invalid pipeline ID (E20001) or pipeline status is incorrect to delete (E20034)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PipelineExternalErrorDto" } } } }, "403": { "description": "User permission is insufficient to perform this action (E00006)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "No pipeline exist with the given ID (E10001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PipelineExternalErrorDto" } } } }, "500": { "description": "Failed to fetch the pipeline or failed to remove it (E00001)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PipelineExternalErrorDto" } } } } }, "summary": "Soft delete the pipeline", "tags": [ "Pipeline operations for internal components" ] } } }, "info": { "title": "AI Inference Server API", "description": "Application programming interface of the AI Inference Server stores data (for example, mapping of variables, parameters, connections, configurations) and allows the product or service to communicate with other internal AI Inference Server components (for example, Model Distributor, Orchestrator, Python Runtime).\n\nYou can access the API specification on an Edge device. The URL is: `/aiinferenceserver/swagger/#`", "version": "2.8.0", "contact": {} }, "tags": [ { "name": "General operations", "description": "Endpoints for retrieving version, handle logs, and configuration at application level." }, { "name": "General user-related operations", "description": "Endpoints for calling and defining user settings." }, { "name": "General operations with a single pipeline", "description": "Endpoints for pipeline creation, activation, and modification and retrieving pipelines." }, { "name": "Handling the execution of a single pipeline", "description": "Endpoints for pipeline execution (for example, start, stop) and getting details about this." }, { "name": "Multiple pipeline operations", "description": "Endpoints for processing multiple pipelines (for example, removing, starting, stopping)." }, { "name": "Handling data connections", "description": "Endpoints for handling data connections (for example, creation, modification). " }, { "name": "Pipeline operations for internal components", "description": "Specific endpoints for handling the pipeline by internal components." } ], "servers": [ { "url": "/" }, { "url": "/aiinferenceserver/api/" } ], "components": { "schemas": { "ApplicationVersionDto": { "type": "object", "properties": { "production": { "type": "string", "description": "Application run in production mode", "example": "true" }, "version": { "type": "string", "description": "Application version", "example": "1.0.0" }, "apiVersion": { "type": "string", "description": "API url version", "example": "1" }, "iedkVersion": { "type": "string", "description": "IEDK version of the edge box", "example": "1.23.3-1" }, "maxNumberOfDeployedPipelines": { "type": "number", "description": "Maximum number of active pipelines", "example": 3 }, "isGPUEnabledApp": { "type": "boolean", "description": "The application can use GPU", "example": false }, "isGPUAvailable": { "type": "boolean", "description": "GPU is available in the system", "example": false }, "isGPUAssigned": { "type": "boolean", "description": "GPU is assigned to the application", "example": false }, "iedSharedMemoryAvailable": { "type": "boolean", "description": "Shared memory is available in the system", "example": false }, "isTelemetryEnabled": { "type": "boolean", "description": "Telemetry is enabled in the application", "example": false }, "useInternalServer": { "type": "boolean", "description": "Telemetry data will be sent to internal or production server", "example": false }, "pythonVersions": { "description": "The list of the supported python versions", "example": [ "3.10.18", "3.11.13", "3.12.11" ], "type": "array", "items": { "type": "string" } }, "deprecatedPythonVersions": { "description": "The list of the deprecated python versions", "example": [ "3.8", "3.10" ], "type": "array", "items": { "type": "string" } } }, "required": [ "production", "version", "apiVersion", "iedkVersion", "maxNumberOfDeployedPipelines", "isGPUEnabledApp", "isGPUAvailable", "isGPUAssigned", "iedSharedMemoryAvailable", "isTelemetryEnabled", "useInternalServer", "pythonVersions", "deprecatedPythonVersions" ] }, "ApplicationConfiguration": { "type": "object", "properties": { "restartEnabled": { "type": "boolean", "description": "The pipeline can be restarted when the application starts", "example": true, "default": false }, "restartCounter": { "type": "integer", "description": "The counter for pipeline restarts", "example": "0", "default": 0 }, "restartedOn": { "type": "string", "description": "Timestamp of the last application start", "example": "2020-06-24T08:18:59.270Z" }, "logFileSize": { "type": "integer", "description": "Maximum size of each log file in byte", "example": 1048576, "default": 10485760 } } }, "ErrorModel": { "type": "object", "properties": { "errorCode": { "type": "string", "description": "Internal error code", "example": "E00000" }, "message": { "type": "string", "description": "Detailed error message", "example": "Unexpected server error." }, "category": { "type": "string", "description": "The category of the error", "example": "DuplicatedEntity" }, "originErrorCode": { "type": "string", "description": "The original error code that came from internal service", "example": "MD20103" }, "originMessage": { "type": "string", "description": "The original error message that came from internal service", "example": "Error happened" }, "metadata": { "type": "object", "description": "The metadata of the error", "example": "{name: 'State Identifier', version: '1.0.1'}" } }, "required": [ "errorCode", "message", "category" ] }, "ApplicationConfigurationDto": { "type": "object", "properties": { "restartEnabled": { "type": "boolean", "description": "Pipeline restart is enabled if it is true", "example": true }, "logFileSize": { "type": "integer", "description": "Maximum size of each log file in byte", "example": 1048576, "default": 10485760 } }, "required": [ "restartEnabled" ] }, "LogMessageDto": { "type": "object", "properties": { "level": { "type": "integer", "description": "The level of the log message: 1-debug, 2-info, 3-warn, 4-error, 5-fatal", "example": "1", "default": 0 }, "application": { "type": "string", "description": "The application name where the logs are coming from", "example": "AI Inference Server - API" }, "message": { "type": "string", "description": "The message of the log" }, "createdOn": { "type": "string", "description": "Date of the creation", "example": "2020-06-24T08:18:59.270Z" }, "pipelineId": { "type": "string", "description": "Unique identifier of pipeline", "example": "f5d82b95-523d-438c-1002-bca5dc7748e7" } }, "required": [ "level", "application", "createdOn" ] }, "LogLevelDto": { "type": "object", "properties": { "debug": { "type": "boolean", "description": "The debug log level is enabled or not", "example": false } }, "required": [ "debug" ] }, "MemoryUsageDto": { "type": "object", "properties": { "total": { "type": "number", "description": "Total amount of the available RAM in bytes", "example": "1024" }, "used": { "type": "number", "description": "Amount of used memory in bytes", "example": "1024" } }, "required": [ "total", "used" ] }, "MemoryUsageDetailsDto": { "type": "object", "properties": { "cpuRuntime": { "description": "Memory usage of the CPU runtime", "allOf": [ { "$ref": "#/components/schemas/MemoryUsageDto" } ] }, "gpuRuntime": { "description": "Memory usage of the GPU runtime", "allOf": [ { "$ref": "#/components/schemas/MemoryUsageDto" } ] }, "gpuHardware": { "description": "Memory usage of the GPU hardware", "allOf": [ { "$ref": "#/components/schemas/MemoryUsageDto" } ] } }, "required": [ "cpuRuntime", "gpuRuntime", "gpuHardware" ] }, "ProcessorUsageDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the entity in UUID v4 format", "example": "f5d82b95-523d-438c-1002-bca5dc7748e7" }, "hasProcessorWarning": { "type": "boolean", "description": "Indicates whether there is a warning related to processor usage", "example": true, "default": false } }, "required": [ "id", "hasProcessorWarning" ] }, "GlobalStatusDto": { "type": "object", "properties": { "cpuRuntime": { "description": "Memory usage of the CPU runtime", "allOf": [ { "$ref": "#/components/schemas/MemoryUsageDto" } ] }, "gpuRuntime": { "description": "Memory usage of the GPU runtime", "allOf": [ { "$ref": "#/components/schemas/MemoryUsageDto" } ] }, "gpuHardware": { "description": "Memory usage of the GPU hardware", "allOf": [ { "$ref": "#/components/schemas/MemoryUsageDto" } ] }, "processorUsage": { "description": "Details about processor usage per pipeline", "type": "array", "items": { "$ref": "#/components/schemas/ProcessorUsageDto" } } }, "required": [ "cpuRuntime", "gpuRuntime", "gpuHardware", "processorUsage" ] }, "UserPreferences": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the user preferences", "example": "7353bbe8-a96d-486d-939e-11f498221fe0" }, "edgeUser": { "type": "string", "description": "The ID of the user in the Edge Management System", "example": "f5d82b95-523d-438c-1002-bca5dc7748e7" }, "allowedDataAnalytics": { "type": "boolean", "description": "Determines whether the Software Analytics is allowed or declined for the user", "example": true, "default": false }, "acceptedTelemetryVersion": { "type": "string", "description": "The accepted telemetry version", "example": "4.8.2-20250328" } }, "required": [ "edgeUser" ] }, "UpdateUserPreferencesDto": { "type": "object", "properties": { "allowedDataAnalytics": { "type": "boolean", "description": "Determines whether the Software Analytics is allowed or declined for the user", "example": true, "default": false }, "acceptedTelemetryVersion": { "type": "string", "description": "The accepted telemetry version", "example": "4.8.2-20250328", "default": "" } } }, "TimeShifting": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the time shifting settings", "example": "f5d82b95-523d-438c-1001-bca5dc7748e7" }, "enabled": { "type": "boolean", "description": "Time shifting is enabled or not", "example": true, "default": false }, "periodicity": { "type": "integer", "description": "Data periodicity in ms", "example": "100" }, "startingPoint": { "type": "string", "description": "Signal reference or First timestamp", "example": "First timestamp", "enum": [ "First timestamp", "Signal reference" ] } }, "required": [ "id" ] }, "Variable": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the component variable", "example": "7353bbe8-a96d-486d-939e-11f498221fe0" }, "pipelineID": { "type": "string", "description": "The ID of the pipeline of the variable", "example": "f5d82b95-523d-438c-1002-bca5dc7748e7" }, "relationRef": { "type": "string", "description": "Name of the source or target component or databus", "example": "Databus" }, "mappable": { "type": "boolean", "description": "Determines whether the variable can be mapped or not", "example": true, "default": false }, "name": { "type": "string", "description": "Name of the variable", "example": "temperature" }, "type": { "type": "string", "description": "Type of the variable", "example": "double" }, "topic": { "type": "string", "description": "Mapping value of the variable", "example": "plc01/j/dp/wheater:temperature" }, "topicName": { "type": "string", "description": "The name of the mapping value", "example": "temperature" }, "originalTopic": { "type": "string", "description": "The original mapping value of the variable", "example": "plc01/j/dp/wheater:temperature" }, "originalTopicName": { "type": "string", "description": "The original name of the mapping value", "example": "temperature" }, "connectorId": { "type": "string", "description": "The ID of the selected connector", "example": "f5d82b95-523d-438c-1002-bca5dc7748e7" }, "input": { "type": "boolean", "description": "Determines whether the variable is input or output", "example": true, "default": true }, "isMetric": { "type": "boolean", "description": "Determines whether the variable is for metrics", "example": true, "default": false }, "timeShiftingReference": { "type": "boolean", "description": "Determines whether the time shifting is using or not", "example": true, "default": false }, "dataPersistency": { "type": "boolean", "description": "Determines whether the data persistency on databus is enabled or not", "example": true, "default": false }, "connectorInfo": { "type": "string", "description": "Information about the required connector, format: connectorType|payloadType|connectorName", "example": "databus|S7Json|S7 Connector" } }, "required": [ "pipelineID", "relationRef", "mappable", "name", "type", "input", "isMetric", "timeShiftingReference", "dataPersistency" ] }, "Component": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the pipeline component", "example": "f5d82b95-523d-438c-2001-bca5dc7748e7" }, "name": { "type": "string", "description": "Name of the pipeline component", "example": "Aggregator" }, "description": { "type": "string", "description": "Information about the component", "example": "Overall information..." }, "mappable": { "type": "boolean", "description": "Determines whether the component can be mapped or not", "example": true, "default": false }, "framework": { "type": "string", "description": "Framework of the pipeline component", "example": "Tensor Flow" }, "entrypoint": { "type": "string", "description": "Entry point of the component", "example": "onnx-mnist.model" }, "runtimeType": { "type": "string", "description": "Runtime type of the pipeline component", "example": "python" }, "runtimeVersion": { "type": "string", "description": "Runtime version of the pipeline component", "example": "3.9" }, "deprecatedPython": { "type": "boolean", "description": "The step use deprecated Python version if it is true", "example": true, "default": false }, "unsupportedPython": { "type": "boolean", "description": "The step use unsupported Python version if it is true", "example": true, "default": false }, "processor": { "type": "string", "description": "Processor of the pipeline component", "example": "CPU" }, "device": { "type": "string", "description": "Selected target device", "example": "IPC227E" }, "mappingStatus": { "type": "string", "description": "Current mapping status of the pipeline component (Warning/Mapped)", "example": "Warning" }, "version": { "type": "string", "description": "Version of the pipeline component", "example": "1.0.0" }, "ordering": { "type": "integer", "description": "Determines the order of the component", "example": "1", "default": "1" }, "replicas": { "type": "integer", "description": "The number of replicas in the parallel execution", "example": "1", "default": "1" }, "variables": { "description": "Input/output variables of the component", "type": "array", "items": { "$ref": "#/components/schemas/Variable" } }, "inputBatch": { "type": "boolean", "description": "Determines whether the component input is in batch mode", "example": true, "default": false }, "outputBatch": { "type": "boolean", "description": "Determines whether the component output is in batch mode", "example": true, "default": false }, "installTransitiveDependencies": { "type": "boolean", "description": "Determines whether transitive dependencies should be installed during the pipeline initialization, using --no-deps flag of pip install", "example": true, "default": true } }, "required": [ "id", "name", "mappable", "mappingStatus" ] }, "ComponentsRelation": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the components relation", "example": "f5d82b95-523d-438c-3001-bca5dc7748e7" }, "sourceID": { "type": "string", "description": "Pipeline component ID from where this relation originates", "example": "f5d82b95-523d-438c-2001-bca5dc7748e7" }, "sourceName": { "type": "string", "description": "Pipeline component name from where this relation originates", "example": "Aggregator" }, "sourceVariable": { "type": "string", "description": "The name of the output variable of the source component", "example": "Temperature" }, "targetID": { "type": "string", "description": "Pipeline component ID at which this relation concludes", "example": "f5d82b95-523d-438c-2002-bca5dc7748e7" }, "targetName": { "type": "string", "description": "Name of the pipeline component at which this relation concludes", "example": "Postprocess" }, "targetVariable": { "type": "string", "description": "The name of the input variable of the target component", "example": "Temperature" } }, "required": [ "id", "sourceName", "sourceVariable", "targetName", "targetVariable" ] }, "Parameter": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the parameter", "example": "7353bbe8-a96d-486d-939e-11f498221fe0" }, "name": { "type": "string", "description": "Name of the parameter", "example": "Param 1" }, "type": { "type": "string", "description": "Type of the parameter", "example": "double" }, "topicBased": { "type": "boolean", "description": "Determines whether the parameter topic based or not", "example": true, "default": false }, "defaultValue": { "type": "string", "description": "Default value of the parameter", "example": "10" }, "value": { "type": "string", "description": "Value of the parameter", "example": "1" }, "topic": { "type": "string", "description": "Topic value of the parameter", "example": "ie/m/j/simatic/v1/s7c1/dp" }, "topicName": { "type": "string", "description": "The name of the mapping value", "example": "temperature" }, "originalTopic": { "type": "string", "description": "The original mapping value of the parameter", "example": "plc01/j/dp/wheater:temperature" }, "originalTopicName": { "type": "string", "description": "The original name of the mapping value", "example": "temperature" }, "connectorId": { "type": "string", "description": "The ID of the selected connector", "example": "f5d82b95-523d-438c-1002-bca5dc7748e7" }, "connectorInfo": { "type": "string", "description": "Information about the required connector, format: connectorType|payloadType|connectorName", "example": "databus|S7Json|S7 Connector" } }, "required": [ "id", "name", "type" ] }, "SelectedTag": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the selected tag", "example": "7353bbe8-a96d-486d-939e-11f498221fe0" }, "connectorId": { "type": "string", "description": "Unique identifier of the connector", "example": "7353bbe8-a96d-486d-939e-11f498221fe0" }, "topic": { "type": "string", "description": "The topic of the connector", "example": "ie/d/j/simatic/v1/s7c1/dp/r/plc1/motor1" }, "pubTopic": { "type": "string", "description": "The topic of the connector for output variables", "example": "ie/d/j/simatic/v1/s7c1/dp/w/plc1/motor1" }, "subtopicName": { "type": "string", "description": "The name of the data point", "example": "Tag1" }, "subtopicId": { "type": "string", "description": "The ID of the data point, this is key that would be used in data publication", "example": "000002" }, "dataType": { "type": "string", "description": "The data type of the data point", "example": "Real" }, "arrayDimensions": { "type": "string", "description": "The dimensions of the array if the data is array", "example": "4,2" }, "readonly": { "type": "boolean", "description": "Determines whether the selected tag can be written or only readable", "example": false, "default": false } }, "required": [ "id", "connectorId", "topic", "subtopicName", "subtopicId", "dataType", "readonly" ] }, "Pipeline": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the pipeline", "example": "7353bbe8-a96d-486d-939e-11f498221fe0" }, "originID": { "type": "string", "description": "Unique identifier of the pipeline's origin", "example": "f5d82b95-523d-438c-2002-bca5dc7748e7" }, "packageId": { "type": "string", "description": "Unique identifier of the pipeline's package", "example": "f5d82b95-523d-438c-2002-bca5dc7748e7" }, "packagePath": { "type": "string", "description": "The path of the configuration package", "example": "/path/" }, "name": { "type": "string", "description": "Name of the pipeline", "example": "My pipeline" }, "status": { "type": "string", "description": "Current Status of the pipeline step (Running/Warning/Mapped)", "example": "Mapped" }, "version": { "type": "string", "description": "Version of the pipeline", "example": "1.0.0" }, "protected": { "type": "boolean", "description": "Determines whether the configuration package is protected", "example": true, "default": false }, "isActive": { "type": "boolean", "description": "Determines whether the pipeline is active", "example": true, "default": false }, "author": { "type": "string", "description": "Author of the pipeline", "example": "Mathilda" }, "description": { "type": "string", "description": "Information about the pipeline", "example": "Overall information..." }, "message": { "type": "string", "description": "Warning message for the pipeline", "example": "missingfile" }, "missingVariables": { "type": "string", "description": "List of the unused variables which were used for time shifting in AI DataLink", "example": "ph1,ph3" }, "createdOn": { "type": "string", "description": "Date of the creation", "example": "2020-06-24T08:18:59.270Z" }, "updatedOn": { "type": "string", "description": "Last modification date of the pipeline", "example": "2021-04-30T08:18:59.271Z" }, "deletedOn": { "type": "string", "description": "Date of the deletion", "example": "2020-06-24T08:18:59.270Z" }, "statusUpdatedOn": { "type": "string", "description": "The date when the pipeline status changed", "example": "2021-04-30T08:18:59.272Z" }, "activatedOn": { "type": "string", "description": "The date of the pipeline activation", "example": "2021-04-30T08:18:59.273Z" }, "initializedOn": { "type": "string", "description": "Date of the initialization", "example": "2021-04-30T08:18:59.274Z" }, "timeShifting": { "description": "Time shifting settings", "allOf": [ { "$ref": "#/components/schemas/TimeShifting" } ] }, "components": { "description": "List of the components for the pipeline", "type": "array", "items": { "$ref": "#/components/schemas/Component" } }, "componentsRelations": { "description": "List of the connections for the pipeline", "type": "array", "items": { "$ref": "#/components/schemas/ComponentsRelation" } }, "parameters": { "description": "Parameters of the pipeline", "type": "array", "items": { "$ref": "#/components/schemas/Parameter" } }, "selectedTags": { "description": "The selected tags of the pipeline", "type": "array", "items": { "$ref": "#/components/schemas/SelectedTag" } }, "parallelEnabled": { "type": "boolean", "description": "Determines whether the parallel step execution instances can be modified.", "default": false }, "hasReadme": { "type": "boolean", "description": "Determines whether the pipeline has readme file.", "default": false }, "external": { "type": "boolean", "description": "It's true if the configuration package has arrived from outside (e.g. from AI Model Manager)" }, "ribCycleTime": { "type": "number", "description": "The cycle time for RIB connector in micro second", "example": "2000" } }, "required": [ "id", "packagePath", "name", "status", "version", "createdOn" ] }, "FileUploadDto": { "type": "object", "properties": { "fileContent": { "type": "string", "format": "binary", "example": "package.zip", "description": "The configuration package to be uploaded" } }, "required": [ "fileContent" ] }, "PipelineSettingsDto": { "type": "object", "properties": { "ribCycleTime": { "type": "number", "description": "The cycle time for RIB connector in micro second", "example": "2000" } }, "required": [ "ribCycleTime" ] }, "IdDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the entity in UUID v4 format", "example": "f5d82b95-523d-438c-1002-bca5dc7748e7" } }, "required": [ "id" ] }, "PipelineVariableDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the component variable", "example": "7353bbe8-a96d-486d-939e-11f498221fe0" }, "name": { "type": "string", "description": "Name of the variable. Cannot be modified, only for making identification easier", "example": "temperature" }, "type": { "type": "string", "description": "Type of the variable. Cannot be modified, only for making identification easier", "example": "double" }, "componentName": { "type": "string", "description": "Name of the component of variable. Cannot be modified, only for making identification easier", "example": "Aggregator" }, "input": { "type": "boolean", "description": "Determines whether the variable is input or output. Cannot be modified, only for making identification easier", "example": true }, "topic": { "type": "string", "description": "Mapping value of the variable", "example": "plc01/j/dp/wheater:temperature" }, "topicName": { "type": "string", "description": "The name of the mapping value", "example": "temperature", "default": "" }, "connectorId": { "type": "string", "description": "Unique identifier of the selected connector", "example": "f5d82b95-523d-438c-1002-bca5dc7748e7", "default": "" }, "dataPersistency": { "type": "boolean", "description": "Determines whether the data persistency on databus is enabled or not", "example": true, "default": false } }, "required": [ "id", "topic" ] }, "UpdatePipelineVariablesDto": { "type": "object", "properties": { "variables": { "description": "The list of the variables", "type": "array", "items": { "$ref": "#/components/schemas/PipelineVariableDto" } } }, "required": [ "variables" ] }, "PipelineParameterDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the parameter", "example": "7353bbe8-a96d-486d-939e-11f498221fe0" }, "name": { "type": "string", "description": "Name of the parameter. Cannot be modified, only for making identification easier", "example": "Param 1" }, "type": { "type": "string", "description": "Type of the parameter. Cannot be modified, only for making identification easier", "example": "double" }, "value": { "type": "string", "description": "Value of the parameter", "example": "1" }, "topic": { "type": "string", "description": "Topic value of the parameter. Can be modified only for the topicBased parameter", "example": "ie/m/j/simatic/v1/s7c1/dp" }, "topicName": { "type": "string", "description": "The name of the mapping value", "example": "temperature" }, "connectorId": { "type": "string", "description": "Unique identifier of the selected connector. Can be modified only for the topicBased parameter", "example": "f5d82b95-523d-438c-1002-bca5dc7748e7", "default": "" }, "connectorName": { "type": "string", "description": "The name of the selected connector. Cannot be modified, only for making identification easier in the logs", "example": "S7 connector", "default": "" } }, "required": [ "id", "type" ] }, "UpdatePipelineParametersDto": { "type": "object", "properties": { "parameters": { "description": "The list of the parameters", "type": "array", "items": { "$ref": "#/components/schemas/PipelineParameterDto" } } }, "required": [ "parameters" ] }, "UpdatePipelineTagsDto": { "type": "object", "properties": { "tags": { "description": "The list of the selected tags", "type": "array", "items": { "$ref": "#/components/schemas/SelectedTag" } } }, "required": [ "tags" ] }, "ComponentReplicasDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the component", "example": "f5d82b95-523d-438c-2001-bca5dc7748e7" }, "replicas": { "type": "integer", "description": "The number of replicas of the component in the parallel execution", "example": "1" } }, "required": [ "id", "replicas" ] }, "ComponentReplicasListDto": { "type": "object", "properties": { "componentReplicas": { "description": "The list of the component replicas", "type": "array", "items": { "$ref": "#/components/schemas/ComponentReplicasDto" } } }, "required": [ "componentReplicas" ] }, "PipelineMissingConnectorDto": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the connector", "example": "IE Vision Connector" }, "connectorType": { "type": "string", "description": "The type of the connector", "example": "databus", "enum": [ "databus", "mqtt", "vision", "zmq", "rib", "metric" ] }, "payloadType": { "type": "string", "description": "The type of the payload: S7Json, String", "example": "String", "enum": [ "String", "S7Json", "VisionConnectorRaw", "ZmqImageOutput", "ZmqPayload", "RIBPayload" ] } }, "required": [ "connectorType", "payloadType" ] }, "PipelineConnectorsDetailsDto": { "type": "object", "properties": { "missingConnectors": { "description": "The list of the missing connectors", "type": "array", "items": { "$ref": "#/components/schemas/PipelineMissingConnectorDto" } }, "createdConnectors": { "description": "The list of the auto created connectors", "type": "array", "items": { "$ref": "#/components/schemas/PipelineMissingConnectorDto" } }, "hasInternalError": { "type": "boolean", "description": "If it is true, then there was an error during connection setup for pre-configured pipeline", "example": true, "default": false } }, "required": [ "missingConnectors", "createdConnectors", "hasInternalError" ] }, "PipelineMessageDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of pipeline", "example": "f5d82b95-523d-438c-1002-bca5dc7748e7" }, "message": { "type": "string", "description": "The system message generated during the activation", "example": "missingfile" }, "hasDeprecatedPython": { "type": "string", "description": "If it is true, the pipeline has at least one step that use deprecated Python version", "example": true, "default": false }, "hasUnsupportedPython": { "type": "string", "description": "If it is true, the pipeline has at least one step that use unsupported Python version", "example": true, "default": false }, "pipelineConnectorsDetails": { "description": "Information about connectors for pre-configured pipelines", "allOf": [ { "$ref": "#/components/schemas/PipelineConnectorsDetailsDto" } ] } }, "required": [ "id", "message", "hasDeprecatedPython", "hasUnsupportedPython" ] }, "IdListDto": { "type": "object", "properties": { "ids": { "description": "The list of the unique identifier of the entity in UUID v4 format", "type": "array", "items": { "type": "string" } } }, "required": [ "ids" ] }, "PipelineOperationDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the pipeline in UUID v4 format", "example": "f5d82b95-523d-438c-1002-bca5dc7748e7" }, "error": { "description": "The error model if error occurred", "example": { "errorCode": "E20022", "message": "Pipeline field validation failed", "category": "ValidationError" }, "allOf": [ { "$ref": "#/components/schemas/ErrorModel" } ] }, "message": { "type": "string", "description": "The system message generated during the activation", "example": "missingfile" }, "hasDeprecatedPython": { "type": "string", "description": "If it is true, the pipeline has at least one step that use deprecated Python version", "example": true, "default": false }, "hasUnsupportedPython": { "type": "string", "description": "If it is true, the pipeline has at least one step that use unsupported Python version", "example": true, "default": false }, "pipelineConnectorsDetails": { "description": "Information about connectors for pre-configured pipelines", "allOf": [ { "$ref": "#/components/schemas/PipelineConnectorsDetailsDto" } ] } }, "required": [ "id", "hasDeprecatedPython", "hasUnsupportedPython" ] }, "MultiplePipelineOperationDto": { "type": "object", "properties": { "pipelines": { "description": "The list of pipeline IDs along with errors or messages if occurred", "type": "array", "items": { "$ref": "#/components/schemas/PipelineOperationDto" } } }, "required": [ "pipelines" ] }, "ExecutionTimeDto": { "type": "object", "properties": { "min": { "type": "integer", "description": "the minimum time", "example": "1234" }, "max": { "type": "integer", "description": "the maximum time", "example": "1234" }, "avg": { "type": "integer", "description": "the average time", "example": "1234" } }, "required": [ "min", "max", "avg" ] }, "PipelineComponentStatusDto": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the component", "example": "SI model" }, "status": { "type": "string", "description": "Status of the component", "example": "Running" }, "logLevel": { "type": "string", "description": "The current log level", "example": "Debug" }, "inputs": { "type": "integer", "description": "Number of inputs consumed by the executor", "example": "1213123" }, "outputs": { "type": "integer", "description": "Number of outputs produced by the executor", "example": "123412" }, "directConnectorInputs": { "type": "integer", "description": "Number of inputs received from the connector", "example": "1213123" }, "directConnectorOutputs": { "type": "integer", "description": "Number of outputs sent directly to the connector", "example": "123412" }, "messageCode": { "type": "string", "description": "The error code provided by Orchestrator", "example": "61001" }, "executionTime": { "description": "The execution time minimum, maximum and average for the given executor", "allOf": [ { "$ref": "#/components/schemas/ExecutionTimeDto" } ] }, "throughput": { "type": "integer", "description": "The number of input passing through the given executor", "example": "123" }, "extraStatisticsInfo": { "type": "object", "description": "Additional statistics" }, "droppedInputs": { "type": "integer", "description": "The number of dropped inputs for the step", "example": "123" }, "instanceType": { "type": "string", "description": "The processor type used by model execution", "example": "gpu" } }, "required": [ "name", "status", "logLevel", "inputs", "outputs", "directConnectorInputs", "directConnectorOutputs", "executionTime" ] }, "PipelineStatusDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Id of the pipeline", "example": "eb7fcd3e-d28e-48dc-a1c0-57569835bbb6" }, "packageId": { "type": "string", "description": "Id of the configuration package", "example": "eb7fcd3e-d28e-48dc-a1c0-57569835bbb6" }, "version": { "type": "string", "description": "Version of the pipeline", "example": "1.0.0" }, "name": { "type": "string", "description": "Name of the pipeline", "example": "State Identifier" }, "status": { "type": "string", "description": "Status of the pipeline", "example": "Running" }, "logLevel": { "type": "string", "description": "Current log level", "example": "Debug" }, "orchestratorStatus": { "type": "string", "description": "Status of the pipeline provided by Orchestrator", "example": "Running" }, "inputs": { "type": "integer", "description": "Total number of inputs consumed by the executor", "example": "1234" }, "timeShiftedInputs": { "type": "integer", "description": "Total number of inputs after inter signal alignment", "example": "1000" }, "outputs": { "type": "integer", "description": "Total number of outputs produced by the executor", "example": "1234" }, "componentStatus": { "description": "Status of the component", "type": "array", "items": { "$ref": "#/components/schemas/PipelineComponentStatusDto" } }, "mainDebugEnabled": { "type": "boolean", "description": "The debug log level for main application components is enabled or not", "example": false }, "runtimeDebugEnabled": { "type": "boolean", "description": "The debug log level for the runtime manager and executors is enabled or not", "example": false }, "errorCode": { "type": "string", "description": "The error code provided by Orchestrator", "example": "400001" }, "droppedPipelineInputs": { "type": "integer", "description": "The number of dropped pipeline inputs", "example": "123" }, "acquisitionTimes": { "description": "The arrival time of the data", "allOf": [ { "$ref": "#/components/schemas/ExecutionTimeDto" } ] }, "payloadTimes": { "description": "The time the data spends on the server", "allOf": [ { "$ref": "#/components/schemas/ExecutionTimeDto" } ] }, "totalTimes": { "description": "Sum of the arrival and payload times", "allOf": [ { "$ref": "#/components/schemas/ExecutionTimeDto" } ] }, "intraStepTimes": { "description": "The time the data is not being executed (e.g. in a script).", "allOf": [ { "$ref": "#/components/schemas/ExecutionTimeDto" } ] } }, "required": [ "id", "packageId", "version", "name", "status", "logLevel", "orchestratorStatus", "inputs", "timeShiftedInputs", "outputs", "componentStatus", "mainDebugEnabled", "runtimeDebugEnabled", "acquisitionTimes", "payloadTimes", "totalTimes", "intraStepTimes" ] }, "MetricsDto": { "type": "object", "properties": { "pipelineExecutionDetails": { "description": "Detailed status of the active pipelines", "type": "array", "items": { "$ref": "#/components/schemas/PipelineStatusDto" } }, "memoryUsage": { "description": "List of the memory usage of different components", "allOf": [ { "$ref": "#/components/schemas/MemoryUsageDetailsDto" } ] } }, "required": [ "pipelineExecutionDetails", "memoryUsage" ] }, "Connector": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the connector", "example": "f5d82b95-523d-438c-7001-bca5dc7748e7" }, "name": { "type": "string", "description": "The name of the connector", "example": "S7 Connector" }, "connectorType": { "type": "string", "description": "The type of the connector", "example": "databus", "enum": [ "databus", "mqtt", "vision", "zmq", "rib", "metric" ] }, "payloadType": { "type": "string", "description": "The type of the payload: S7Json, String or VisionConnectorRaw", "example": "String", "enum": [ "String", "S7Json", "VisionConnectorRaw", "ZmqImageOutput", "ZmqPayload", "RIBPayload" ] }, "host": { "type": "string", "description": "The host name of the connector", "example": "ie-databus" }, "port": { "type": "integer", "description": "The port of the connector", "example": "1883" }, "port2": { "type": "integer", "description": "The secondary port of the connector", "example": "1884" }, "username": { "type": "string", "description": "The name of the user", "example": "username" }, "password": { "type": "string", "description": "The encrypted password" }, "metadataTopic": { "type": "string", "description": "Topic for metadata", "example": "ie/m/j/simatic/v1/s7c1/dp" }, "authenticationRequired": { "type": "boolean", "description": "Determines whether the credentials are required", "example": true, "default": true }, "hasTags": { "type": "boolean", "description": "Determines whether the connector is able to provide tags.", "example": true, "default": false }, "updatedOn": { "type": "string", "description": "Last modification date of the connector", "example": "2021-04-30T08:18:59.271Z" } }, "required": [ "id", "name", "connectorType", "payloadType", "host" ] }, "ConnectorConfigurationDto": { "type": "object", "properties": { "connectorType": { "type": "string", "description": "The type of the connector", "example": "databus", "enum": [ "databus", "mqtt", "vision", "zmq", "rib", "metric" ] }, "payloadType": { "type": "string", "description": "The type of the payload", "example": "String", "enum": [ "String", "S7Json", "VisionConnectorRaw", "ZmqImageOutput", "ZmqPayload", "RIBPayload" ] }, "hasTwoPorts": { "type": "boolean", "description": "Determines whether the connector has two ports or not", "example": false }, "dataPersistency": { "type": "boolean", "description": "Determines whether the data persistency is enabled or not", "example": false }, "hasTopicWildCard": { "type": "boolean", "description": "Determines whether the connector topic can be wildcarded or not", "example": false }, "hasSubtopic": { "type": "boolean", "description": "Determines whether the connector has subtopic or not", "example": false }, "hasTags": { "type": "boolean", "description": "Determines whether the tags are supported or not", "example": false }, "channelModelType": { "type": "string", "description": "The type of the channel model for Orchestrator", "example": "MQTT", "enum": [ "MQTT", "ZMQ", "ZMQ_DEALER" ] }, "inputTypes": { "description": "The list of the allowed input types", "example": [ "String" ], "type": "array", "items": { "type": "string" } }, "outputTypes": { "description": "The list of the allowed output types", "example": [ "String" ], "type": "array", "items": { "type": "string" } } }, "required": [ "connectorType", "payloadType", "hasTwoPorts", "dataPersistency", "hasTopicWildCard", "hasSubtopic", "hasTags", "channelModelType", "inputTypes", "outputTypes" ] }, "ConnectorDto": { "type": "object", "properties": { "name": { "type": "string", "description": "The unique name of the connector", "example": "S7 Connector" }, "connectorType": { "type": "string", "description": "The type of the connector", "example": "databus", "enum": [ "databus", "mqtt", "vision", "zmq", "rib", "metric" ] }, "payloadType": { "type": "string", "description": "The type of the payload: S7Json, String", "example": "String", "enum": [ "String", "S7Json", "VisionConnectorRaw", "ZmqImageOutput", "ZmqPayload", "RIBPayload" ] }, "host": { "type": "string", "description": "The host name of the connector", "example": "ie-databus" }, "port": { "type": "integer", "description": "The port of the connector", "example": "1883" }, "port2": { "type": "integer", "description": "The secondary port of the connector", "example": "1884" }, "username": { "type": "string", "description": "The name of the user", "example": "username" }, "password": { "type": "string", "description": "The password for the user", "example": "password" }, "metadataTopic": { "type": "string", "description": "Topic for metadata", "example": "ie/m/j/simatic/v1/s7c1/dp" }, "authenticationRequired": { "type": "boolean", "description": "Determines whether the credentials are required", "example": true }, "hasTags": { "type": "boolean", "description": "Determines whether the connector is able to provide tags.", "example": true } }, "required": [ "name", "connectorType", "payloadType", "host", "hasTags" ] }, "RibMetaDto": { "type": "object", "properties": { "type": { "type": "string", "description": "Symbol type", "example": "int32_t" }, "name": { "type": "string", "description": "Symbol name", "example": "symbolName" }, "size": { "type": "integer", "description": "Symbol size in bytes", "example": 4 }, "isArray": { "type": "boolean", "description": "True if symbol is an array", "example": false }, "len": { "type": "integer", "description": "Number of elements if array", "example": 3 } }, "required": [ "type", "name", "size", "isArray" ] }, "PipelineExternalStatusDto": { "type": "object", "properties": { "deploymentId": { "type": "string", "description": "Unique identifier of the configuration package", "example": "f5d82b95-523d-438c-7001-bca5dc7748e7" }, "status": { "type": "string", "description": "The status of the configuration package", "example": "available" } }, "required": [ "deploymentId", "status" ] }, "PipelineExternalErrorDto": { "type": "object", "properties": { "code": { "type": "string", "description": "The error code if error occurs", "example": "E00001" }, "message": { "type": "string", "description": "The error message if error occurs", "example": "Internal server error." } } }, "PipelineImportResponseDto": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the pipeline", "example": "Configuration Package" }, "version": { "type": "string", "description": "Version of the pipeline", "example": "1.0.0" }, "originVersion": { "type": "string", "description": "Version of the origin pipeline which should be cloned", "example": "1.0.0" }, "originID": { "type": "string", "description": "ID of the origin pipeline which should be cloned", "example": "eb7fcd3e-d28e-48dc-a1c0-57569835bbb6" }, "packageId": { "type": "string", "description": "Unique identifier of the pipeline's package", "example": "eb7fcd3e-d28e-48dc-a1c0-57569835bbb6" }, "protected": { "type": "boolean", "description": "Determines whether the configuration package is protected", "example": true, "default": false } }, "required": [ "name", "version" ] }, "PipelinePackageDto": { "type": "object", "properties": { "requestOrigin": { "type": "string", "description": "The request is coming from 'internal' or 'external' source", "example": "internal", "enum": [ "internal", "external" ] }, "deploymentDir": { "type": "string", "description": "The path of the unpacked pipeline package", "example": "/path/" }, "metadata": { "description": "The meta information of the pipeline package (e.g. name, version...)", "allOf": [ { "$ref": "#/components/schemas/PipelineImportResponseDto" } ] } }, "required": [ "deploymentDir" ] }, "MockErrorDto": { "type": "object", "properties": { "errorCode": { "type": "string", "description": "The error code representing the specific error encountered.", "example": "PY61001" } } } } } }