{ "openapi": "3.0.4", "info": { "title": "AI Asset Manager API", "version": "v3.0", "license": { "name": "Copyright 2025 Siemens AG. All Rights Reserved. Confidential." } }, "tags": [ { "name": "Info" }, { "name": "Apps" }, { "name": "Agents" }, { "name": "Devices" }, { "name": "AI Inference Servers" }, { "name": "Packages" }, { "name": "Training", "description": "Manage training packages" }, { "name": "Deployments" }, { "name": "Workspaces" }, { "name": "WorkspaceProviders" }, { "name": "IEM" } ], "paths": { "/api/v3/agents": { "get": { "description": "**Authorized roles:** `Admin`, `AppAdmin`, `Operator`, `Viewer`\n\nReturns the list of agents with their details.", "tags": [ "Agents" ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "actionState": { "type": "object", "properties": { "actionId": { "type": "string" }, "agentId": { "type": "string" }, "code": { "type": "string" }, "createdAt": { "type": "object" }, "createdBy": { "type": "string" }, "details": {}, "id": { "type": "string" }, "kind": { "type": "string" }, "message": { "type": "string" }, "modifiedAt": { "type": "object" }, "modifiedBy": { "type": "string" }, "state": { "type": "string" } } }, "applicationId": { "type": "string" }, "applicationName": { "type": "string" }, "applicationType": { "type": "string" }, "applicationVersion": { "type": "string" }, "capabilities": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "version": { "type": "string" } } } }, "connectionStatus": { "type": "string" }, "createdAt": { "type": "object" }, "createdBy": { "type": "string" }, "deviceId": { "type": "string" }, "deviceName": { "type": "string" }, "id": { "type": "string" }, "modifiedAt": { "type": "object" }, "modifiedBy": { "type": "string" }, "onboardingAttempts": { "type": "integer" } } } } } } }, "error": { "$ref": "#/components/responses/Error" } }, "deprecated": true }, "post": { "description": "**Authorized roles:** `Admin`, `AppAdmin`, `Operator`\n\nOboard an agent.", "tags": [ "Agents" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "Body": { "type": "object", "properties": { "appId": { "type": "string" }, "deviceId": { "type": "string" } } } } } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "type": "object", "properties": { "actionState": { "type": "object", "properties": { "actionId": { "type": "string" }, "agentId": { "type": "string" }, "code": { "type": "string" }, "createdAt": { "type": "object" }, "createdBy": { "type": "string" }, "details": {}, "id": { "type": "string" }, "kind": { "type": "string" }, "message": { "type": "string" }, "modifiedAt": { "type": "object" }, "modifiedBy": { "type": "string" }, "state": { "type": "string" } } }, "applicationId": { "type": "string" }, "applicationName": { "type": "string" }, "applicationType": { "type": "string" }, "applicationVersion": { "type": "string" }, "capabilities": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "version": { "type": "string" } } } }, "connectionStatus": { "type": "string" }, "createdAt": { "type": "object" }, "createdBy": { "type": "string" }, "deviceId": { "type": "string" }, "deviceName": { "type": "string" }, "id": { "type": "string" }, "modifiedAt": { "type": "object" }, "modifiedBy": { "type": "string" }, "onboardingAttempts": { "type": "integer" } } } } } }, "error": { "$ref": "#/components/responses/Error" } }, "deprecated": true } }, "/api/v3/agents/map-variables": { "post": { "description": "**Authorized roles:** `Admin`, `AppAdmin`, `Operator`, `Viewer`\n\nReturns the patch variables for a list of mappable variables.", "tags": [ "Deployments" ], "parameters": [ { "in": "query", "name": "devId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "appId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "AppID": { "type": "string" }, "Body": { "type": "object", "properties": { "variables": { "type": "array", "items": { "type": "object", "properties": { "componentName": { "type": "string" }, "connector": { "type": "object", "properties": { "dataType": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" } } }, "name": { "type": "string" }, "topic": { "type": "string" }, "topicName": { "type": "string" }, "type": { "type": "string" } } } } } }, "DevID": { "type": "string" } } } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "connectorId": { "type": "string" }, "id": { "type": "string" }, "topic": { "type": "string" }, "topicName": { "type": "string" } } } } } } }, "error": { "$ref": "#/components/responses/Error" } } } }, "/api/v3/agents/pkg-variables": { "post": { "description": "**Authorized roles:** `Admin`, `AppAdmin`, `Operator`, `Viewer`\n\nReturns the mappable variables for a list of package variables.", "tags": [ "Deployments" ], "parameters": [ { "in": "query", "name": "devId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "appId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "pipelineId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "AppID": { "type": "string" }, "Body": { "type": "object", "properties": { "variables": { "type": "array", "items": { "type": "object", "properties": { "isInput": { "type": "boolean" }, "isMetric": { "type": "boolean" }, "name": { "type": "string" }, "type": { "type": "string" } } } } } }, "DevID": { "type": "string" }, "PipeID": { "type": "string" } } } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "componentName": { "type": "string" }, "connector": { "type": "object", "properties": { "dataType": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" } } }, "name": { "type": "string" }, "topic": { "type": "string" }, "topicName": { "type": "string" }, "type": { "type": "string" } } } } } } }, "error": { "$ref": "#/components/responses/Error" } } } }, "/api/v3/agents/{id}": { "delete": { "description": "**Authorized roles:** `Admin`, `AppAdmin`\n\nOffboard an agent.", "tags": [ "Agents" ], "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" } }, { "in": "query", "name": "options", "schema": { "type": "string" } } ], "responses": { "204": { "content": { "application/json": { "schema": {} } } }, "error": { "$ref": "#/components/responses/Error" } }, "deprecated": true }, "get": { "description": "**Authorized roles:** `Admin`, `AppAdmin`, `Operator`, `Viewer`\n\nReturn details about an agent.", "tags": [ "Agents" ], "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "actionState": { "type": "object", "properties": { "actionId": { "type": "string" }, "agentId": { "type": "string" }, "code": { "type": "string" }, "createdAt": { "type": "object" }, "createdBy": { "type": "string" }, "details": {}, "id": { "type": "string" }, "kind": { "type": "string" }, "message": { "type": "string" }, "modifiedAt": { "type": "object" }, "modifiedBy": { "type": "string" }, "state": { "type": "string" } } }, "applicationId": { "type": "string" }, "applicationName": { "type": "string" }, "applicationType": { "type": "string" }, "applicationVersion": { "type": "string" }, "capabilities": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "version": { "type": "string" } } } }, "connectionStatus": { "type": "string" }, "createdAt": { "type": "object" }, "createdBy": { "type": "string" }, "deviceId": { "type": "string" }, "deviceName": { "type": "string" }, "id": { "type": "string" }, "modifiedAt": { "type": "object" }, "modifiedBy": { "type": "string" }, "onboardingAttempts": { "type": "integer" } } } } } }, "error": { "$ref": "#/components/responses/Error" } }, "deprecated": true } }, "/api/v3/alerting": { "get": { "description": "**Authorized roles:** `Admin`, `AppAdmin`, `Operator`, `Viewer`\n\nReturns the alerting configurations.", "tags": [ "Alerting" ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "alert_rules": { "type": "object", "properties": { "groups": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "rules": { "type": "array", "items": { "type": "object", "properties": { "alert": { "type": "string" }, "annotations": { "type": "object", "properties": { "description": { "type": "string" } } }, "expr": { "type": "string" }, "for": { "type": "integer" }, "labels": { "type": "object", "properties": { "alert_name": { "type": "string" }, "notification_channel": { "type": "string" }, "targets": { "type": "string" } } } } } } } } } } }, "alertmanager": { "type": "object", "properties": { "receivers": { "type": "array", "items": { "type": "object", "properties": { "email_configs": { "type": "array", "items": { "type": "object", "properties": { "auth_password": { "type": "string" }, "auth_username": { "type": "string" }, "from": { "type": "string" }, "require_tls": { "type": "boolean" }, "smarthost": { "type": "string" }, "tls_config": { "type": "object", "properties": { "insecure_skip_verify": { "type": "boolean" } } }, "to": { "type": "string" } } } }, "msteamsv2_configs": { "type": "array", "items": { "type": "object", "properties": { "http_config": { "type": "object", "properties": { "tls_config": { "type": "object", "properties": { "insecure_skip_verify": { "type": "boolean" } } } } }, "webhook_url": { "type": "string" } } } }, "name": { "type": "string" } } } }, "route": { "type": "object", "properties": { "receiver": { "type": "string" }, "routes": { "type": "array", "items": { "type": "object", "properties": { "continue": { "type": "boolean" }, "matchers": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "integer" }, "value": { "type": "string" } } } }, "receiver": { "type": "string" } } } } } }, "templates": { "type": "array", "items": { "type": "string" } } } } } } } } }, "error": { "$ref": "#/components/responses/Error" } } }, "put": { "description": "**Authorized roles:** `Admin`, `AppAdmin`, `Operator`\n\nUpdates the alerting configurations.", "tags": [ "Alerting" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "Body": { "type": "object", "properties": { "alert_rules": { "type": "object", "properties": { "groups": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "rules": { "type": "array", "items": { "type": "object", "properties": { "alert": { "type": "string" }, "annotations": { "type": "object", "properties": { "description": { "type": "string" } } }, "expr": { "type": "string" }, "for": { "type": "integer" }, "labels": { "type": "object", "properties": { "alert_name": { "type": "string" }, "notification_channel": { "type": "string" }, "targets": { "type": "string" } } } } } } } } } } }, "alertmanager": { "type": "object", "properties": { "receivers": { "type": "array", "items": { "type": "object", "properties": { "email_configs": { "type": "array", "items": { "type": "object", "properties": { "auth_password": { "type": "string" }, "auth_username": { "type": "string" }, "from": { "type": "string" }, "require_tls": { "type": "boolean" }, "smarthost": { "type": "string" }, "tls_config": { "type": "object", "properties": { "insecure_skip_verify": { "type": "boolean" } } }, "to": { "type": "string" } } } }, "msteamsv2_configs": { "type": "array", "items": { "type": "object", "properties": { "http_config": { "type": "object", "properties": { "tls_config": { "type": "object", "properties": { "insecure_skip_verify": { "type": "boolean" } } } } }, "webhook_url": { "type": "string" } } } }, "name": { "type": "string" } } } }, "route": { "type": "object", "properties": { "receiver": { "type": "string" }, "routes": { "type": "array", "items": { "type": "object", "properties": { "continue": { "type": "boolean" }, "matchers": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "integer" }, "value": { "type": "string" } } } }, "receiver": { "type": "string" } } } } } }, "templates": { "type": "array", "items": { "type": "string" } } } } } } } } } } }, "responses": { "202": { "content": { "application/json": { "schema": {} } } }, "error": { "$ref": "#/components/responses/Error" } } } }, "/api/v3/app-info": { "get": { "description": "**Authorized roles:** `Admin`, `AppAdmin`, `Operator`, `Viewer`\n\nReturns information about the application.", "tags": [ "Info" ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "appVersion": { "type": "string" } } } } } }, "error": { "$ref": "#/components/responses/Error" } } } }, "/api/v3/apps": { "get": { "description": "**Authorized roles:** `Admin`, `AppAdmin`, `Operator`, `Viewer`\n\nList apps.", "tags": [ "Apps" ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "appId": { "type": "string" }, "devId": { "type": "string" }, "sessionId": { "type": "string" }, "status": { "type": "string" }, "updatedAt": { "type": "object" } } } } } } }, "error": { "$ref": "#/components/responses/Error" } } }, "post": { "description": "**Authorized roles:** `Admin`, `AppAdmin`, `Operator`\n\nConnect an AI App.", "tags": [ "Apps" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "Body": { "type": "object", "properties": { "appId": { "type": "string" }, "devId": { "type": "string" } } } } } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "type": "object", "properties": { "appId": { "type": "string" }, "devId": { "type": "string" }, "sessionId": { "type": "string" }, "status": { "type": "string" }, "updatedAt": { "type": "object" } } } } } }, "error": { "$ref": "#/components/responses/Error" } } } }, "/api/v3/apps/{devId}/{appId}": { "delete": { "description": "**Authorized roles:** `Admin`, `AppAdmin`, `Operator`\n\nDisconnect an AI App.", "tags": [ "Apps" ], "parameters": [ { "in": "path", "name": "devId", "schema": { "type": "string" } }, { "in": "path", "name": "appId", "schema": { "type": "string" } } ], "responses": { "204": { "content": { "application/json": { "schema": {} } } }, "error": { "$ref": "#/components/responses/Error" } } }, "get": { "description": "**Authorized roles:** `Admin`, `AppAdmin`, `Operator`, `Viewer`\n\nGet app details.", "tags": [ "Apps" ], "parameters": [ { "in": "path", "name": "devId", "schema": { "type": "string" } }, { "in": "path", "name": "appId", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "appId": { "type": "string" }, "devId": { "type": "string" }, "sessionId": { "type": "string" }, "status": { "type": "string" }, "updatedAt": { "type": "object" } } } } } }, "error": { "$ref": "#/components/responses/Error" } } } }, "/api/v3/apps/{devId}/{appId}/aiis": { "get": { "description": "**Authorized roles:** `Admin`, `AppAdmin`, `Operator`, `Viewer`\n\nReturns information about an AI Inference Server app running on the specified device.", "tags": [ "AI Inference Servers" ], "parameters": [ { "in": "path", "name": "devId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "appId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "agentId": { "type": "string" }, "errors": { "type": "array", "items": { "type": "string" } }, "info": { "type": "object", "properties": { "apiVersion": { "type": "string" }, "isGPUEnabledApp": { "type": "boolean" }, "maxNumberOfDeployedPipelines": { "type": "integer" }, "production": { "type": "string" }, "pythonVersions": { "type": "array", "items": { "type": "string" } }, "version": { "type": "string" } } }, "pipelines": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string" }, "id": { "type": "string" }, "initializedOn": { "type": "string" }, "isActive": { "type": "boolean" }, "name": { "type": "string" }, "packageId": { "type": "string" }, "packageSize": {}, "received": { "type": "string" }, "status": { "type": "string" }, "statusChanged": { "type": "string" }, "steps": { "type": "integer" }, "version": { "type": "string" } } } }, "status": { "type": "string" } } } } } }, "error": { "$ref": "#/components/responses/Error" } } } }, "/api/v3/apps/{devId}/{appId}/aiis/{pipelineId}/{action}": { "patch": { "description": "**Authorized roles:** `Admin`, `AppAdmin`, `Operator`\n\nUpdates a pipeline on an inference server.", "tags": [ "AI Inference Servers" ], "parameters": [ { "in": "path", "name": "devId", "schema": { "type": "string" } }, { "in": "path", "name": "appId", "schema": { "type": "string" } }, { "in": "path", "name": "pipelineId", "schema": { "type": "string" } }, { "in": "path", "name": "action", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } } }, "error": { "$ref": "#/components/responses/Error" } } } }, "/api/v3/configs": { "get": { "description": "**Authorized roles:** `Admin`, `AppAdmin`, `Operator`, `Viewer`\n\nReturns the application configurations.", "tags": [ "Info" ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "telemetry": { "type": "object", "properties": { "obfuscateData": { "type": "boolean" }, "productKey": { "type": "string" }, "productName": { "type": "string" }, "useProductionServer": { "type": "boolean" } } } } } } } }, "error": { "$ref": "#/components/responses/Error" } }, "deprecated": true } }, "/api/v3/deployments": { "get": { "description": "**Authorized roles:** `Admin`, `AppAdmin`, `Operator`, `Viewer`\n\nReturns the list of deployments.", "tags": [ "Deployments" ], "parameters": [ { "in": "query", "name": "pkgId", "schema": { "type": "string" } }, { "in": "query", "name": "devId", "schema": { "type": "string" } }, { "in": "query", "name": "appId", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "appId": { "type": "string" }, "createdAt": { "type": "object" }, "createdBy": { "type": "string" }, "devId": { "type": "string" }, "id": { "type": "string" }, "message": { "type": "string" }, "pipelineId": { "type": "string" }, "pipelineName": { "type": "string" }, "pipelineVersion": { "type": "string" }, "pkgID": { "type": "string" }, "status": { "type": "string" }, "updatedAt": { "type": "object" }, "updatedBy": { "type": "string" } } } } } } }, "error": { "$ref": "#/components/responses/Error" } } }, "post": { "description": "**Authorized roles:** `Admin`, `AppAdmin`\n\nCreate a new deployment.", "tags": [ "Deployments" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "Body": { "type": "object", "properties": { "appId": { "type": "string" }, "devId": { "type": "string" }, "paused": { "type": "boolean" }, "pkgId": { "type": "string" }, "variables": { "type": "array", "items": { "type": "object", "properties": { "connectorId": { "type": "string" }, "id": { "type": "string" }, "topic": { "type": "string" }, "topicName": { "type": "string" } } } } } } } } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "type": "object", "properties": { "appId": { "type": "string" }, "createdAt": { "type": "object" }, "createdBy": { "type": "string" }, "devId": { "type": "string" }, "id": { "type": "string" }, "message": { "type": "string" }, "pipelineId": { "type": "string" }, "pipelineName": { "type": "string" }, "pipelineVersion": { "type": "string" }, "pkgID": { "type": "string" }, "status": { "type": "string" }, "updatedAt": { "type": "object" }, "updatedBy": { "type": "string" } } } } } }, "error": { "$ref": "#/components/responses/Error" } } } }, "/api/v3/devices": { "get": { "description": "**Authorized roles:** `Admin`, `AppAdmin`, `Operator`, `Viewer`\n\nReturns the list of devices.", "tags": [ "Devices" ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "apps": { "type": "array", "items": { "type": "object", "properties": { "applicationId": { "type": "string" }, "deviceId": { "type": "string" }, "deviceName": { "type": "string" }, "title": { "type": "string" }, "versionNumber": { "type": "string" } } } }, "deviceType": { "type": "string" }, "id": { "type": "string" }, "lastOnline": { "type": "integer" }, "name": { "type": "string" }, "status": { "type": "string" } } } } } } }, "error": { "$ref": "#/components/responses/Error" } } } }, "/api/v3/devices/{id}": { "get": { "description": "**Authorized roles:** `Admin`, `AppAdmin`, `Operator`, `Viewer`\n\nReturns detailed information about a specific device.", "tags": [ "Devices" ], "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "apps": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "redirectUrl": { "type": "string" }, "status": { "type": "string" }, "title": { "type": "string" }, "version": { "type": "string" }, "versionId": { "type": "string" } } } }, "errors": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" }, "networks": { "type": "array", "items": { "type": "object", "properties": { "ipAddress": { "type": "string" }, "isGateway": { "type": "boolean" } } } }, "stats": { "type": "object", "properties": { "cpuLoad": { "type": "string" }, "maxCpuLoad": { "type": "string" }, "memTotal": { "type": "string" }, "memUsed": { "type": "string" }, "storageTotal": { "type": "string" }, "storageUsed": { "type": "string" } } } } } } } }, "error": { "$ref": "#/components/responses/Error" } } } }, "/api/v3/iem/login": { "post": { "description": "**Authorized roles:** `Admin`, `AppAdmin`, `Operator`, `Viewer`\n\nAcquire an IEM auth token.", "tags": [ "IEM" ], "requestBody": { "required": true, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "password": { "type": "string", "format": "password" }, "username": { "type": "string" } } } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "access_token": { "type": "string" }, "expires_in": { "type": "number" } } } } } }, "error": { "$ref": "#/components/responses/Error" } }, "deprecated": true } }, "/api/v3/iem/portal-address": { "get": { "description": "**Authorized roles:** `Admin`, `AppAdmin`, `Operator`, `Viewer`\n\nReturns the IEM portal address.", "tags": [ "Info" ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "portalAddress": { "type": "string" } } } } } }, "error": { "$ref": "#/components/responses/Error" } } } }, "/api/v3/packages": { "get": { "description": "**Authorized roles:** `Admin`, `AppAdmin`, `Operator`, `Viewer`\n\nReturn the list of packages.", "tags": [ "Packages" ], "parameters": [ { "in": "query", "name": "pkgId", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "aiamId": { "type": "string" }, "basePackageVersion": { "type": "string" }, "bytes": {}, "desc": { "type": "string" }, "hardwareType": { "type": "string" }, "id": { "type": "string" }, "isDelta": { "type": "boolean" }, "name": { "type": "string" }, "readme": { "type": "string" }, "status": { "type": "string" }, "trainingPkg": { "type": "object", "properties": { "id": { "type": "string" }, "version": { "type": "string" } } }, "variables": { "type": "array", "items": { "type": "object", "properties": { "isInput": { "type": "boolean" }, "isMetric": { "type": "boolean" }, "name": { "type": "string" }, "type": { "type": "string" } } } }, "version": { "type": "string" }, "workspaceId": { "type": "string" } } } } } } }, "error": { "$ref": "#/components/responses/Error" } } } }, "/api/v3/packages/{id}": { "delete": { "description": "**Authorized roles:** `Admin`, `AppAdmin`\n\nDelete a package.", "tags": [ "Packages" ], "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" } } ], "responses": { "204": { "content": { "application/json": { "schema": { "type": "object" } } } }, "error": { "$ref": "#/components/responses/Error" } } }, "get": { "description": "**Authorized roles:** `Admin`, `AppAdmin`, `Operator`, `Viewer`\n\nReturn information about a package.", "tags": [ "Packages" ], "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "aiamId": { "type": "string" }, "basePackageVersion": { "type": "string" }, "bytes": {}, "desc": { "type": "string" }, "hardwareType": { "type": "string" }, "id": { "type": "string" }, "isDelta": { "type": "boolean" }, "name": { "type": "string" }, "readme": { "type": "string" }, "status": { "type": "string" }, "trainingPkg": { "type": "object", "properties": { "id": { "type": "string" }, "version": { "type": "string" } } }, "variables": { "type": "array", "items": { "type": "object", "properties": { "isInput": { "type": "boolean" }, "isMetric": { "type": "boolean" }, "name": { "type": "string" }, "type": { "type": "string" } } } }, "version": { "type": "string" }, "workspaceId": { "type": "string" } } } } } }, "error": { "$ref": "#/components/responses/Error" } } }, "patch": { "description": "**Authorized roles:** `Admin`, `AppAdmin`, `Operator`, `Viewer`\n\nUpdate package status.", "tags": [ "Packages" ], "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "Body": { "type": "object", "properties": { "status": { "type": "string" } } }, "ID": { "type": "string" } } } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "aiamId": { "type": "string" }, "basePackageVersion": { "type": "string" }, "bytes": {}, "desc": { "type": "string" }, "hardwareType": { "type": "string" }, "id": { "type": "string" }, "isDelta": { "type": "boolean" }, "name": { "type": "string" }, "readme": { "type": "string" }, "status": { "type": "string" }, "trainingPkg": { "type": "object", "properties": { "id": { "type": "string" }, "version": { "type": "string" } } }, "variables": { "type": "array", "items": { "type": "object", "properties": { "isInput": { "type": "boolean" }, "isMetric": { "type": "boolean" }, "name": { "type": "string" }, "type": { "type": "string" } } } }, "version": { "type": "string" }, "workspaceId": { "type": "string" } } } } } }, "error": { "$ref": "#/components/responses/Error" } } } }, "/api/v3/packages/{id}/description": { "get": { "description": "**Authorized roles:** `Admin`, `AppAdmin`, `Operator`, `Viewer`\n\nReturns the README.html from a package.", "tags": [ "Packages" ], "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "text/html": { "schema": { "type": "array", "items": {} } } } }, "error": { "$ref": "#/components/responses/Error" } }, "deprecated": true } }, "/api/v3/packages/{id}/download": { "get": { "description": "**Authorized roles:** `Admin`, `AppAdmin`, `Operator`, `Viewer`\n\nReturn information about a package.", "tags": [ "Packages" ], "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/octet-stream": { "schema": { "type": "object", "properties": { "Filename": { "type": "string" }, "Reader": {} } } } } }, "error": { "$ref": "#/components/responses/Error" } } } }, "/api/v3/packages/{id}/variables": { "get": { "description": "**Authorized roles:** `Admin`, `AppAdmin`, `Operator`, `Viewer`\n\nReturn the list of variables for the specified package.", "tags": [ "Packages" ], "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "isInput": { "type": "boolean" }, "isMetric": { "type": "boolean" }, "name": { "type": "string" }, "type": { "type": "string" } } } } } } }, "error": { "$ref": "#/components/responses/Error" } } } }, "/api/v3/packages:v2": { "post": { "description": "**Authorized roles:** `Admin`, `AppAdmin`\n\nUpload a new package to workspace.", "tags": [ "Packages" ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" }, "workspaceId": { "type": "string" } } } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "type": "object", "properties": { "aiamId": { "type": "string" }, "basePackageVersion": { "type": "string" }, "bytes": {}, "desc": { "type": "string" }, "hardwareType": { "type": "string" }, "id": { "type": "string" }, "isDelta": { "type": "boolean" }, "name": { "type": "string" }, "readme": { "type": "string" }, "status": { "type": "string" }, "trainingPkg": { "type": "object", "properties": { "id": { "type": "string" }, "version": { "type": "string" } } }, "variables": { "type": "array", "items": { "type": "object", "properties": { "isInput": { "type": "boolean" }, "isMetric": { "type": "boolean" }, "name": { "type": "string" }, "type": { "type": "string" } } } }, "version": { "type": "string" }, "workspaceId": { "type": "string" } } } } } }, "error": { "$ref": "#/components/responses/Error" } } } }, "/api/v3/training/experiments": { "get": { "description": "**Authorized roles:** `Admin`, `AppAdmin`, `Operator`, `Viewer`\n\nList experiments.", "tags": [ "Training" ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "createdAt": { "type": "string" }, "createdBy": { "type": "string" }, "error": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "newPkgId": { "type": "string" }, "newPkgName": { "type": "string" }, "newPkgVersion": { "type": "string" }, "srcPkgId": { "type": "string" }, "srcPkgVersion": { "type": "string" }, "status": { "type": "string" }, "trainingPkgId": { "type": "string" }, "trainingPkgVersion": { "type": "string" } } } } } } }, "error": { "$ref": "#/components/responses/Error" } } }, "post": { "description": "**Authorized roles:** `Admin`, `AppAdmin`\n\nCreate an experiment.", "tags": [ "Training" ], "parameters": [ { "in": "query", "name": "name", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "trainingPkgId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "trainingPkgVersion", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "srcPkgId", "schema": { "type": "string" } }, { "in": "query", "name": "srcPkgVersion", "schema": { "type": "string" } }, { "in": "query", "name": "newPkgName", "schema": { "type": "string" } }, { "in": "query", "name": "newPkgVersion", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/octet-stream": { "schema": { "type": "object", "properties": { "Body": {}, "ExpName": { "type": "string" }, "NewPkgName": { "type": "string" }, "NewPkgVersion": { "type": "string" }, "SrcPkgID": { "type": "string" }, "SrcPkgVersion": { "type": "string" }, "TPkgID": { "type": "string" }, "TPkgVersion": { "type": "string" } } } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "type": "object", "properties": { "createdAt": { "type": "string" }, "createdBy": { "type": "string" }, "error": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "newPkgId": { "type": "string" }, "newPkgName": { "type": "string" }, "newPkgVersion": { "type": "string" }, "srcPkgId": { "type": "string" }, "srcPkgVersion": { "type": "string" }, "status": { "type": "string" }, "trainingPkgId": { "type": "string" }, "trainingPkgVersion": { "type": "string" } } } } } }, "error": { "$ref": "#/components/responses/Error" } } } }, "/api/v3/training/experiments/{expId}/artifacts": { "get": { "description": "**Authorized roles:** `Admin`, `AppAdmin`, `Operator`, `Viewer`\n\nList an experiment's artifacts.", "tags": [ "Training" ], "parameters": [ { "in": "path", "name": "expId", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "experimentId": { "type": "string" }, "name": { "type": "string" }, "sizeBytes": {} } } } } } }, "error": { "$ref": "#/components/responses/Error" } } } }, "/api/v3/training/experiments/{expId}/artifacts/{name}": { "get": { "description": "**Authorized roles:** `Admin`, `AppAdmin`, `Operator`, `Viewer`\n\nView an experiment artifact's metadata.", "tags": [ "Training" ], "parameters": [ { "in": "path", "name": "expId", "schema": { "type": "string" } }, { "in": "path", "name": "name", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "experimentId": { "type": "string" }, "name": { "type": "string" }, "sizeBytes": {} } } } } }, "error": { "$ref": "#/components/responses/Error" } } } }, "/api/v3/training/experiments/{id}": { "delete": { "description": "**Authorized roles:** `Admin`, `AppAdmin`\n\nDelete an experiment.", "tags": [ "Training" ], "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" } } ], "responses": { "204": { "content": { "application/json": { "schema": {} } } }, "error": { "$ref": "#/components/responses/Error" } } }, "get": { "description": "**Authorized roles:** `Admin`, `AppAdmin`, `Operator`, `Viewer`\n\nView an experiment.", "tags": [ "Training" ], "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "createdAt": { "type": "string" }, "createdBy": { "type": "string" }, "error": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "newPkgId": { "type": "string" }, "newPkgName": { "type": "string" }, "newPkgVersion": { "type": "string" }, "srcPkgId": { "type": "string" }, "srcPkgVersion": { "type": "string" }, "status": { "type": "string" }, "trainingPkgId": { "type": "string" }, "trainingPkgVersion": { "type": "string" } } } } } }, "error": { "$ref": "#/components/responses/Error" } } } }, "/api/v3/training/experiments/{id}/eval": { "get": { "description": "**Authorized roles:** `Admin`, `AppAdmin`, `Operator`\n\nEvaluate an experiment.", "tags": [ "Training" ], "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "cfgFrom", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/octet-stream": { "schema": {} } } }, "error": { "$ref": "#/components/responses/Error" } } } }, "/api/v3/training/packages": { "get": { "description": "**Authorized roles:** `Admin`, `AppAdmin`, `Operator`, `Viewer`\n\nList training packages.", "tags": [ "Training" ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "desc": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "python_version": { "type": "string" }, "size": {}, "status": { "type": "string" }, "updatedAt": { "type": "string" }, "updatedBy": { "type": "string" }, "version": { "type": "string" } } } } } } }, "error": { "$ref": "#/components/responses/Error" } } }, "post": { "description": "**Authorized roles:** `Admin`, `AppAdmin`\n\nImport a training package.", "tags": [ "Training" ], "requestBody": { "required": true, "content": { "application/octet-stream": { "schema": {} } } }, "responses": { "201": { "content": { "application/json": { "schema": { "type": "object", "properties": { "desc": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "python_version": { "type": "string" }, "size": {}, "status": { "type": "string" }, "updatedAt": { "type": "string" }, "updatedBy": { "type": "string" }, "version": { "type": "string" } } } } } }, "error": { "$ref": "#/components/responses/Error" } } } }, "/api/v3/training/packages/{id}/{version}": { "delete": { "description": "**Authorized roles:** `Admin`, `AppAdmin`\n\nDelete a training package.", "tags": [ "Training" ], "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" } }, { "in": "path", "name": "version", "schema": { "type": "string" } } ], "responses": { "204": { "content": { "application/json": { "schema": {} } } }, "error": { "$ref": "#/components/responses/Error" } } }, "get": { "description": "**Authorized roles:** `Admin`, `AppAdmin`, `Operator`, `Viewer`\n\nView a training package.", "tags": [ "Training" ], "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" } }, { "in": "path", "name": "version", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "desc": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "python_version": { "type": "string" }, "size": {}, "status": { "type": "string" }, "updatedAt": { "type": "string" }, "updatedBy": { "type": "string" }, "version": { "type": "string" } } } } } }, "error": { "$ref": "#/components/responses/Error" } } } }, "/api/v3/training/packages/{id}/{version}/download": { "get": { "description": "**Authorized roles:** `Admin`, `AppAdmin`, `Operator`, `Viewer`\n\nDownload a training package.", "tags": [ "Training" ], "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" } }, { "in": "path", "name": "version", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/octet-stream": { "schema": { "type": "object", "properties": { "Filename": { "type": "string" }, "Reader": {} } } } } }, "error": { "$ref": "#/components/responses/Error" } } } }, "/api/v3/user-info": { "get": { "description": "**Authorized roles:** `Admin`, `AppAdmin`, `Operator`, `Viewer`\n\nReturns information about the requesting user.", "tags": [ "Info" ], "parameters": [ { "in": "query", "name": "natsPubKey", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "capabilities": { "type": "array", "items": { "type": "string" } }, "mail": { "type": "string" }, "nats": { "type": "string" }, "role": { "type": "string" } } } } } }, "error": { "$ref": "#/components/responses/Error" } } } }, "/api/v3/workspace-credentials/{id}": { "get": { "description": "**Authorized roles:** `Admin`, `AppAdmin`, `Operator`, `Viewer`\n\nReturns list of workspace credential types.", "tags": [ "WorkspaceProviders" ], "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "createdAt": { "type": "object" }, "createdBy": { "type": "string" }, "credentialTypeId": { "type": "string" }, "endpoint": { "type": "string" }, "id": { "type": "string" }, "modifiedAt": { "type": "object" }, "modifiedBy": { "type": "string" }, "topicPrefix": { "type": "string" } } } } } }, "error": { "$ref": "#/components/responses/Error" } } } }, "/api/v3/workspace-credentialtypes": { "get": { "description": "**Authorized roles:** `Admin`, `AppAdmin`, `Operator`, `Viewer`\n\nReturns list of workspace credential types.", "tags": [ "WorkspaceProviders" ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" } } } } } } }, "error": { "$ref": "#/components/responses/Error" } } } }, "/api/v3/workspace-providers": { "get": { "description": "**Authorized roles:** `Admin`, `AppAdmin`, `Operator`, `Viewer`\n\nReturns list of workspace providers.", "tags": [ "WorkspaceProviders" ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "fullName": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" } } } } } } }, "error": { "$ref": "#/components/responses/Error" } } } }, "/api/v3/workspace-providers/{providerId}/integrationtypes": { "get": { "description": "**Authorized roles:** `Admin`, `AppAdmin`, `Operator`, `Viewer`\n\nReturns list of integration types for a workspace provider.", "tags": [ "WorkspaceProviders" ], "parameters": [ { "in": "path", "name": "providerId", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "provider": { "type": "object", "properties": { "fullName": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" } } }, "providerId": { "type": "string" } } } } } } }, "error": { "$ref": "#/components/responses/Error" } } } }, "/api/v3/workspace-types": { "get": { "description": "**Authorized roles:** `Admin`, `AppAdmin`, `Operator`, `Viewer`\n\nReturns the list of workspace types.", "tags": [ "Workspaces" ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } } } } } } }, "error": { "$ref": "#/components/responses/Error" } } } }, "/api/v3/workspaces": { "get": { "description": "**Authorized roles:** `Admin`, `AppAdmin`, `Operator`, `Viewer`\n\nReturns the list of workspaces.", "tags": [ "Workspaces" ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "connectionStatus": { "type": "string" }, "createdAt": { "type": "object" }, "createdBy": { "type": "string" }, "credential": { "type": "object", "properties": { "createdAt": { "type": "object" }, "createdBy": { "type": "string" }, "credentialTypeId": { "type": "string" }, "endpoint": { "type": "string" }, "id": { "type": "string" }, "modifiedAt": { "type": "object" }, "modifiedBy": { "type": "string" }, "topicPrefix": { "type": "string" } } }, "credentialId": { "type": "string" }, "description": { "type": "string" }, "id": { "type": "string" }, "integrationType": { "type": "object", "properties": { "description": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "provider": { "type": "object", "properties": { "fullName": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" } } }, "providerId": { "type": "string" } } }, "integrationTypeId": { "type": "string" }, "modifiedAt": { "type": "object" }, "modifiedBy": { "type": "string" }, "name": { "type": "string" }, "packages": { "type": "array", "items": { "type": "object", "properties": { "basePackageVersion": { "type": "string" }, "createdAt": { "type": "object" }, "createdBy": { "type": "string" }, "deployments": { "type": "array", "items": { "type": "object", "properties": { "action": { "type": "object", "properties": { "actionId": { "type": "string" }, "code": { "type": "string" }, "createdAt": { "type": "object" }, "createdBy": { "type": "string" }, "deploymentId": { "type": "string" }, "details": {}, "id": { "type": "string" }, "kind": { "type": "string" }, "message": { "type": "string" }, "modifiedAt": { "type": "object" }, "modifiedBy": { "type": "string" }, "state": { "type": "string" } } }, "applicationId": { "type": "string" }, "createdAt": { "type": "object" }, "createdBy": { "type": "string" }, "deviceId": { "type": "string" }, "id": { "type": "string" }, "modifiedAt": { "type": "object" }, "modifiedBy": { "type": "string" }, "name": { "type": "string" }, "packageId": { "type": "string" }, "ruleId": { "type": "string" }, "status": { "type": "object", "properties": { "code": { "type": "string" }, "createdAt": { "type": "object" }, "createdBy": { "type": "string" }, "deploymentId": { "type": "string" }, "details": {}, "id": { "type": "string" }, "message": { "type": "string" }, "modifiedAt": { "type": "object" }, "modifiedBy": { "type": "string" }, "status": { "type": "string" } } } } } }, "descriptionExists": { "type": "boolean" }, "hardwareType": { "type": "string" }, "id": { "type": "string" }, "isDelta": { "type": "boolean" }, "modifiedAt": { "type": "object" }, "modifiedBy": { "type": "string" }, "name": { "type": "string" }, "packageId": { "type": "string" }, "runtimes": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" }, "version": { "type": "string" } } } }, "status": { "type": "string" }, "type": { "type": "string" }, "version": { "type": "string" }, "workspaceId": { "type": "string" } } } }, "protected": { "type": "boolean" }, "workspaceType": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, "workspaceTypeId": { "type": "string" } } } } } } }, "error": { "$ref": "#/components/responses/Error" } } }, "post": { "description": "**Authorized roles:** `Admin`, `AppAdmin`, `Operator`\n\nCreates a workspace.", "tags": [ "Workspaces" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "Body": { "type": "object", "properties": { "credential": { "type": "object", "properties": { "credentialTypeId": { "type": "string" }, "id": { "type": "string" }, "value": { "type": "string" } } }, "description": { "type": "string" }, "integrationTypeId": { "type": "string" }, "name": { "type": "string" }, "workspaceTypeId": { "type": "string" } } } } } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "type": "object", "properties": { "connectionStatus": { "type": "string" }, "createdAt": { "type": "object" }, "createdBy": { "type": "string" }, "credential": { "type": "object", "properties": { "createdAt": { "type": "object" }, "createdBy": { "type": "string" }, "credentialTypeId": { "type": "string" }, "endpoint": { "type": "string" }, "id": { "type": "string" }, "modifiedAt": { "type": "object" }, "modifiedBy": { "type": "string" }, "topicPrefix": { "type": "string" } } }, "credentialId": { "type": "string" }, "description": { "type": "string" }, "id": { "type": "string" }, "integrationType": { "type": "object", "properties": { "description": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "provider": { "type": "object", "properties": { "fullName": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" } } }, "providerId": { "type": "string" } } }, "integrationTypeId": { "type": "string" }, "modifiedAt": { "type": "object" }, "modifiedBy": { "type": "string" }, "name": { "type": "string" }, "packages": { "type": "array", "items": { "type": "object", "properties": { "basePackageVersion": { "type": "string" }, "createdAt": { "type": "object" }, "createdBy": { "type": "string" }, "deployments": { "type": "array", "items": { "type": "object", "properties": { "action": { "type": "object", "properties": { "actionId": { "type": "string" }, "code": { "type": "string" }, "createdAt": { "type": "object" }, "createdBy": { "type": "string" }, "deploymentId": { "type": "string" }, "details": {}, "id": { "type": "string" }, "kind": { "type": "string" }, "message": { "type": "string" }, "modifiedAt": { "type": "object" }, "modifiedBy": { "type": "string" }, "state": { "type": "string" } } }, "applicationId": { "type": "string" }, "createdAt": { "type": "object" }, "createdBy": { "type": "string" }, "deviceId": { "type": "string" }, "id": { "type": "string" }, "modifiedAt": { "type": "object" }, "modifiedBy": { "type": "string" }, "name": { "type": "string" }, "packageId": { "type": "string" }, "ruleId": { "type": "string" }, "status": { "type": "object", "properties": { "code": { "type": "string" }, "createdAt": { "type": "object" }, "createdBy": { "type": "string" }, "deploymentId": { "type": "string" }, "details": {}, "id": { "type": "string" }, "message": { "type": "string" }, "modifiedAt": { "type": "object" }, "modifiedBy": { "type": "string" }, "status": { "type": "string" } } } } } }, "descriptionExists": { "type": "boolean" }, "hardwareType": { "type": "string" }, "id": { "type": "string" }, "isDelta": { "type": "boolean" }, "modifiedAt": { "type": "object" }, "modifiedBy": { "type": "string" }, "name": { "type": "string" }, "packageId": { "type": "string" }, "runtimes": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" }, "version": { "type": "string" } } } }, "status": { "type": "string" }, "type": { "type": "string" }, "version": { "type": "string" }, "workspaceId": { "type": "string" } } } }, "protected": { "type": "boolean" }, "workspaceType": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, "workspaceTypeId": { "type": "string" } } } } } }, "error": { "$ref": "#/components/responses/Error" } } } }, "/api/v3/workspaces/{id}": { "delete": { "description": "**Authorized roles:** `Admin`, `AppAdmin`\n\nDeletes a workspace.", "tags": [ "Workspaces" ], "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" } }, { "in": "header", "name": "Iem-Access-Token", "schema": { "type": "string" } } ], "responses": { "204": { "content": { "application/json": { "schema": {} } } }, "error": { "$ref": "#/components/responses/Error" } } }, "get": { "description": "**Authorized roles:** `Admin`, `AppAdmin`, `Operator`, `Viewer`\n\nReturns workspace details.", "tags": [ "Workspaces" ], "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "connectionStatus": { "type": "string" }, "createdAt": { "type": "object" }, "createdBy": { "type": "string" }, "credential": { "type": "object", "properties": { "createdAt": { "type": "object" }, "createdBy": { "type": "string" }, "credentialTypeId": { "type": "string" }, "endpoint": { "type": "string" }, "id": { "type": "string" }, "modifiedAt": { "type": "object" }, "modifiedBy": { "type": "string" }, "topicPrefix": { "type": "string" } } }, "credentialId": { "type": "string" }, "description": { "type": "string" }, "id": { "type": "string" }, "integrationType": { "type": "object", "properties": { "description": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "provider": { "type": "object", "properties": { "fullName": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" } } }, "providerId": { "type": "string" } } }, "integrationTypeId": { "type": "string" }, "modifiedAt": { "type": "object" }, "modifiedBy": { "type": "string" }, "name": { "type": "string" }, "packages": { "type": "array", "items": { "type": "object", "properties": { "basePackageVersion": { "type": "string" }, "createdAt": { "type": "object" }, "createdBy": { "type": "string" }, "deployments": { "type": "array", "items": { "type": "object", "properties": { "action": { "type": "object", "properties": { "actionId": { "type": "string" }, "code": { "type": "string" }, "createdAt": { "type": "object" }, "createdBy": { "type": "string" }, "deploymentId": { "type": "string" }, "details": {}, "id": { "type": "string" }, "kind": { "type": "string" }, "message": { "type": "string" }, "modifiedAt": { "type": "object" }, "modifiedBy": { "type": "string" }, "state": { "type": "string" } } }, "applicationId": { "type": "string" }, "createdAt": { "type": "object" }, "createdBy": { "type": "string" }, "deviceId": { "type": "string" }, "id": { "type": "string" }, "modifiedAt": { "type": "object" }, "modifiedBy": { "type": "string" }, "name": { "type": "string" }, "packageId": { "type": "string" }, "ruleId": { "type": "string" }, "status": { "type": "object", "properties": { "code": { "type": "string" }, "createdAt": { "type": "object" }, "createdBy": { "type": "string" }, "deploymentId": { "type": "string" }, "details": {}, "id": { "type": "string" }, "message": { "type": "string" }, "modifiedAt": { "type": "object" }, "modifiedBy": { "type": "string" }, "status": { "type": "string" } } } } } }, "descriptionExists": { "type": "boolean" }, "hardwareType": { "type": "string" }, "id": { "type": "string" }, "isDelta": { "type": "boolean" }, "modifiedAt": { "type": "object" }, "modifiedBy": { "type": "string" }, "name": { "type": "string" }, "packageId": { "type": "string" }, "runtimes": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" }, "version": { "type": "string" } } } }, "status": { "type": "string" }, "type": { "type": "string" }, "version": { "type": "string" }, "workspaceId": { "type": "string" } } } }, "protected": { "type": "boolean" }, "workspaceType": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, "workspaceTypeId": { "type": "string" } } } } } }, "error": { "$ref": "#/components/responses/Error" } } }, "put": { "description": "**Authorized roles:** `Admin`, `AppAdmin`, `Operator`\n\nUpdates a workspace.", "tags": [ "Workspaces" ], "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "Body": { "type": "object", "properties": { "credential": { "type": "object", "properties": { "credentialTypeId": { "type": "string" }, "id": { "type": "string" }, "value": { "type": "string" } } }, "description": { "type": "string" }, "name": { "type": "string" } } }, "ID": { "type": "string" } } } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "connectionStatus": { "type": "string" }, "createdAt": { "type": "object" }, "createdBy": { "type": "string" }, "credential": { "type": "object", "properties": { "createdAt": { "type": "object" }, "createdBy": { "type": "string" }, "credentialTypeId": { "type": "string" }, "endpoint": { "type": "string" }, "id": { "type": "string" }, "modifiedAt": { "type": "object" }, "modifiedBy": { "type": "string" }, "topicPrefix": { "type": "string" } } }, "credentialId": { "type": "string" }, "description": { "type": "string" }, "id": { "type": "string" }, "integrationType": { "type": "object", "properties": { "description": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "provider": { "type": "object", "properties": { "fullName": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" } } }, "providerId": { "type": "string" } } }, "integrationTypeId": { "type": "string" }, "modifiedAt": { "type": "object" }, "modifiedBy": { "type": "string" }, "name": { "type": "string" }, "packages": { "type": "array", "items": { "type": "object", "properties": { "basePackageVersion": { "type": "string" }, "createdAt": { "type": "object" }, "createdBy": { "type": "string" }, "deployments": { "type": "array", "items": { "type": "object", "properties": { "action": { "type": "object", "properties": { "actionId": { "type": "string" }, "code": { "type": "string" }, "createdAt": { "type": "object" }, "createdBy": { "type": "string" }, "deploymentId": { "type": "string" }, "details": {}, "id": { "type": "string" }, "kind": { "type": "string" }, "message": { "type": "string" }, "modifiedAt": { "type": "object" }, "modifiedBy": { "type": "string" }, "state": { "type": "string" } } }, "applicationId": { "type": "string" }, "createdAt": { "type": "object" }, "createdBy": { "type": "string" }, "deviceId": { "type": "string" }, "id": { "type": "string" }, "modifiedAt": { "type": "object" }, "modifiedBy": { "type": "string" }, "name": { "type": "string" }, "packageId": { "type": "string" }, "ruleId": { "type": "string" }, "status": { "type": "object", "properties": { "code": { "type": "string" }, "createdAt": { "type": "object" }, "createdBy": { "type": "string" }, "deploymentId": { "type": "string" }, "details": {}, "id": { "type": "string" }, "message": { "type": "string" }, "modifiedAt": { "type": "object" }, "modifiedBy": { "type": "string" }, "status": { "type": "string" } } } } } }, "descriptionExists": { "type": "boolean" }, "hardwareType": { "type": "string" }, "id": { "type": "string" }, "isDelta": { "type": "boolean" }, "modifiedAt": { "type": "object" }, "modifiedBy": { "type": "string" }, "name": { "type": "string" }, "packageId": { "type": "string" }, "runtimes": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" }, "version": { "type": "string" } } } }, "status": { "type": "string" }, "type": { "type": "string" }, "version": { "type": "string" }, "workspaceId": { "type": "string" } } } }, "protected": { "type": "boolean" }, "workspaceType": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, "workspaceTypeId": { "type": "string" } } } } } }, "error": { "$ref": "#/components/responses/Error" } } } } }, "servers": [ { "url": "" }, { "url": "/mlmanager" }, { "url": "/assetmanager" } ], "components": { "schemas": { "Error": { "type": "object", "properties": { "error": { "type": "string" } } } }, "responses": { "Error": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }