Skip to content

Maestro v2.4.1 API

Prasad Talasila edited this page Nov 27, 2024 · 1 revision
{
  "swagger": "2.0",
  "info": {
    "description": "Api Documentation",
    "version": "1.0",
    "title": "Api Documentation",
    "termsOfService": "urn:tos",
    "contact": {},
    "license": {
      "name": "Apache 2.0",
      "url": "http://www.apache.org/licenses/ LICENSE-2.0"
    }
  },
  "host": "localhost:8082",
  "basePath": "/",
  "tags": [
    {
      "name": "maestro-2-scenario-controller",
      "description": "Maestro 2 Scenario Controller"
    },
    {
      "name": "maestro-2-simulation- controller",
      "description": "Maestro 2 Simulation Controller"
    }
  ],
  "paths": {
    "/createSession": {
      "get": {
        "tags": ["maestro-2- simulation- controller"],
        "summary": "createSession",
        "operationId": "createSessionUsingGET",
        "produces": ["application/json"],
        "responses": {
          "200": {
            "description": "OK",
            "schema": { "$ref": "#/definitions/StatusModel" }
          },
          "401": { "description": "Unauthorized" },
          "403": { "description": "Forbidden" },
          "404": { "description": "Not Found" }
        },
        "deprecated": false
      }
    },
    "/destroy/{sessionId}": {
      "get": {
        "tags": ["maestro-2-simulation- controller"],
        "summary": "destroy",
        "operationId": "destroyUsingGET",
        "produces": ["*/*"],
        "parameters": [
          {
            "name": "sessionId",
            "in": "path",
            "description": "sessionId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": { "description": "OK" },
          "401": { "description": "Unauthorized" },
          "403": { "description": "Forbidden" },
          "404": { "description": "Not Found" }
        },
        "deprecated": false
      }
    },
    "/executeAlgorithm": {
      "post": {
        "tags": ["maestro-2-scenario- controller"],
        "summary": "executeAlgorithm",
        "operationId": "executeAlgorithmUsingPOST",
        "consumes": ["application/json"],
        "produces": ["application/octet- stream"],
        "parameters": [
          {
            "in": "body",
            "name": "executableModel",
            "description": "executableModel",
            "required": true,
            "schema": {
              "$ref": "#/definitions/ExecutableMasterAndMultiModelTDO"
            }
          }
        ],
        "responses": {
          "200": { "description": "OK" },
          "201": { "description": "Created" },
          "401": { "description": "Unauthorized" },
          "403": { "description": "Forbidden" },
          "404": { "description": "Not Found" }
        },
        "deprecated": false
      }
    },
    "/executeViaCLI/{sessionId}": {
      "post": {
        "tags": ["maestro-2-simulation- controller"],
        "summary": "executeViaCLI",
        "operationId": "executeViaCLIUsingPOST",
        "consumes": ["application/json"],
        "produces": ["*/*"],
        "parameters": [
          {
            "in": "body",
            "name": "cliExecutionRequestBody",
            "description": "cliExecutionRequestBody",
            "required": true,
            "schema": { "$ref": "#/definitions/CliExecutionRequestBody" }
          },
          {
            "name": "sessionId",
            "in": "path",
            "description": "sessionId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": { "description": "OK" },
          "201": { "description": "Created" },
          "401": { "description": "Unauthorized" },
          "403": { "description": "Forbidden" },
          "404": { "description": "Not Found" }
        },
        "deprecated": false
      }
    },
    "/generateAlgorithmFromMultiModel": {
      "post": {
        "tags": ["maestro-2-scenario- controller"],
        "summary": "generateAlgorithmFromMultiModel",
        "operationId": "generateAlgorithmFromMultiModelUsingPOST",
        "consumes": ["application/json"],
        "produces": ["text/plain"],
        "parameters": [
          {
            "in": "body",
            "name": "multiModel",
            "description": "multiModel",
            "required": true,
            "schema": { "$ref": "#/definitions/ExtendedMultiModel" }
          }
        ],
        "responses": {
          "200": { "description": "OK", "schema": { "type": "string" } },
          "201": { "description": "Created" },
          "401": { "description": "Unauthorized" },
          "403": { "description": "Forbidden" },
          "404": { "description": "Not Found" }
        },
        "deprecated": false
      }
    },
    "/generateAlgorithmFromScenario": {
      "post": {
        "tags": ["maestro-2-scenario- controller"],
        "summary": "generateAlgorithmFromScenario",
        "operationId": "generateAlgorithmFromScenarioUsingPOST",
        "consumes": ["text/plain"],
        "produces": ["text/plain"],
        "parameters": [
          {
            "in": "body",
            "name": "scenario",
            "description": "scenario",
            "required": true,
            "schema": { "type": "string" }
          }
        ],
        "responses": {
          "200": { "description": "OK", "schema": { "type": "string" } },
          "201": { "description": "Created" },
          "401": { "description": "Unauthorized" },
          "403": { "description": "Forbidden" },
          "404": { "description": "Not Found" }
        },
        "deprecated": false
      }
    },
    "/initialize/{sessionId}": {
      "post": {
        "tags": ["maestro-2-simulation- controller"],
        "summary": "initializeSession",
        "operationId": "initializeSessionUsingPOST",
        "consumes": ["application/json", "text/plain"],
        "produces": ["application/ json"],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "description": "body",
            "required": true,
            "schema": { "$ref": "#/definitions/InitializationData" }
          },
          {
            "name": "sessionId",
            "in": "path",
            "description": "sessionId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": { "$ref": "#/definitions/ InitializeStatusModel" }
          },
          "201": { "description": "Created" },
          "401": { "description": "Unauthorized" },
          "403": { "description": "Forbidden" },
          "404": { "description": "Not Found" }
        },
        "deprecated": false
      }
    },
    "/ping": {
      "get": {
        "tags": ["maestro-2- simulation- controller"],
        "summary": "ping",
        "operationId": "pingUsingGET",
        "produces": ["text/plain"],
        "responses": {
          "200": { "description": "OK", "schema": { "type": "string" } },
          "401": { "description": "Unauthorized" },
          "403": { "description": "Forbidden" },
          "404": { "description": "Not Found" }
        },
        "deprecated": false
      }
    },
    "/result/{sessionId}/plain": {
      "get": {
        "tags": ["maestro-2-simulation- controller"],
        "summary": "getResultPlain",
        "operationId": "getResultPlainUsingGET",
        "produces": ["text/csv"],
        "parameters": [
          {
            "name": "sessionId",
            "in": "path",
            "description": "sessionId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": { "$ref": "#/definitions/ Resource" }
          },
          "401": { "description": "Unauthorized" },
          "403": { "description": "Forbidden" },
          "404": { "description": "Not Found" }
        },
        "deprecated": false
      }
    },
    "/result/{sessionId}/zip": {
      "get": {
        "tags": ["maestro-2-simulation- controller"],
        "summary": "getResultZip",
        "operationId": "getResultZipUsingGET",
        "produces": ["application/zip"],
        "parameters": [
          {
            "name": "sessionId",
            "in": "path",
            "description": "sessionId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": { "description": "OK" },
          "401": { "description": "Unauthorized" },
          "403": { "description": "Forbidden" },
          "404": { "description": "Not Found" }
        },
        "deprecated": false
      }
    },
    "/sigverSimulate/{sessionId}": {
      "post": {
        "tags": ["maestro-2-simulation-controller"],
        "summary": "This request executes the algorithm provided in the master model",
        "operationId": "sigverSimulateUsingPOST",
        "consumes": ["application/ json"],
        "produces": ["application/json"],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "description": "body",
            "required": true,
            "schema": { "$ref": "#/definitions/SigverSimulateRequestBody" }
          },
          {
            "name": "sessionId",
            "in": "path",
            "description": "sessionId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": { "$ref": "#/definitions/ StatusModel" }
          },
          "201": { "description": "Created" },
          "401": { "description": "Unauthorized" },
          "403": { "description": "Forbidden" },
          "404": { "description": "Not Found" }
        },
        "deprecated": false
      }
    },
    "/simulate/{sessionId}": {
      "post": {
        "tags": ["maestro-2-simulation-controller"],
        "summary": "This request begins the co-simulation",
        "operationId": "simulateUsingPOST",
        "consumes": ["application/json", "text/plain"],
        "produces": ["application/ json"],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "description": "body",
            "required": true,
            "schema": { "$ref": "#/definitions/SimulateRequestBody" }
          },
          {
            "name": "sessionId",
            "in": "path",
            "description": "sessionId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": { "$ref": "#/definitions/ StatusModel" }
          },
          "201": { "description": "Created" },
          "401": { "description": "Unauthorized" },
          "403": { "description": "Forbidden" },
          "404": { "description": "Not Found" }
        },
        "deprecated": false
      }
    },
    "/status": {
      "get": {
        "tags": ["maestro-2- simulation- controller"],
        "summary": "getStatuses",
        "operationId": "getStatusesUsingGET_1",
        "produces": ["text/plain"],
        "responses": {
          "200": { "description": "OK", "schema": { "type": "string" } },
          "401": { "description": "Unauthorized" },
          "403": { "description": "Forbidden" },
          "404": { "description": "Not Found" }
        },
        "deprecated": false
      }
    },
    "/status/{sessionId}": {
      "get": {
        "tags": ["maestro-2-simulation- controller"],
        "summary": "getStatuses",
        "operationId": "getStatusesUsingGET",
        "produces": ["text/plain"],
        "parameters": [
          {
            "name": "sessionId",
            "in": "path",
            "description": "sessionId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": { "description": "OK", "schema": { "type": "string" } },
          "401": { "description": "Unauthorized" },
          "403": { "description": "Forbidden" },
          "404": { "description": "Not Found" }
        },
        "deprecated": false
      }
    },
    "/stopsimulation/{sessionId}": {
      "get": {
        "tags": ["maestro-2-simulation- controller"],
        "summary": "stop",
        "operationId": "stopUsingGET",
        "produces": ["*/*"],
        "parameters": [
          {
            "name": "sessionId",
            "in": "path",
            "description": "sessionId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": { "description": "OK" },
          "401": { "description": "Unauthorized" },
          "403": { "description": "Forbidden" },
          "404": { "description": "Not Found" }
        },
        "deprecated": false
      },
      "post": {
        "tags": ["maestro-2-simulation- controller"],
        "summary": "stop",
        "operationId": "stopUsingPOST",
        "consumes": ["application/json"],
        "produces": ["*/*"],
        "parameters": [
          {
            "name": "sessionId",
            "in": "path",
            "description": "sessionId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": { "description": "OK" },
          "201": { "description": "Created" },
          "401": { "description": "Unauthorized" },
          "403": { "description": "Forbidden" },
          "404": { "description": "Not Found" }
        },
        "deprecated": false
      }
    },
    "/upload/{sessionId}": {
      "post": {
        "tags": ["maestro-2-simulation- controller"],
        "summary": "uploadFile",
        "operationId": "uploadFileUsingPOST",
        "consumes": ["multipart/form-data"],
        "produces": ["*/*"],
        "parameters": [
          {
            "name": "file",
            "in": "formData",
            "description": "File",
            "required": true,
            "type": "file"
          },
          {
            "name": "sessionId",
            "in": "path",
            "description": "sessionId",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": { "description": "OK" },
          "201": { "description": "Created" },
          "401": { "description": "Unauthorized" },
          "403": { "description": "Forbidden" },
          "404": { "description": "Not Found" }
        },
        "deprecated": false
      }
    },
    "/verifyAlgorithm": {
      "post": {
        "tags": ["maestro-2-scenario- controller"],
        "summary": "verifyAlgorithm",
        "operationId": "verifyAlgorithmUsingPOST",
        "consumes": ["text/plain"],
        "produces": ["application/json"],
        "parameters": [
          {
            "in": "body",
            "name": "masterModelAsString",
            "description": "masterModelAsString",
            "required": true,
            "schema": { "type": "string" }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": { "$ref": "#/definitions/VerificationResult" }
          },
          "201": { "description": "Created" },
          "401": { "description": "Unauthorized" },
          "403": { "description": "Forbidden" },
          "404": { "description": "Not Found" }
        },
        "deprecated": false
      }
    },
    "/version": {
      "get": {
        "tags": ["maestro-2- simulation- controller"],
        "summary": "version",
        "operationId": "versionUsingGET",
        "produces": ["text/plain"],
        "responses": {
          "200": { "description": "OK", "schema": { "type": "string" } },
          "401": { "description": "Unauthorized" },
          "403": { "description": "Forbidden" },
          "404": { "description": "Not Found" }
        },
        "deprecated": false
      }
    },
    "/visualizeTrace": {
      "post": {
        "tags": ["maestro-2-scenario- controller"],
        "summary": "visualizeTrace",
        "operationId": "visualizeTraceUsingPOST",
        "consumes": ["text/plain"],
        "produces": ["video/mp4"],
        "parameters": [
          {
            "in": "body",
            "name": "masterModelAsString",
            "description": "masterModelAsString",
            "required": true,
            "schema": { "type": "string" }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": { "$ref": "#/definitions/FileSystemResource" }
          },
          "201": { "description": "Created" },
          "401": { "description": "Unauthorized" },
          "403": { "description": "Forbidden" },
          "404": { "description": "Not Found" }
        },
        "deprecated": false
      }
    }
  },
  "definitions": {
    "BoundedDifferenceConstraint": {
      "type": "object",
      "properties": {
        "abstol": { "type": "number", "format": "double" },
        "ports": { "type": "array", "items": { "type": "string" } },
        "reltol": { "type": "number", "format": "double" },
        "safety": { "type": "number", "format": "double" },
        "skipDiscrete": { "type": "boolean" },
        "type": { "type": "string" }
      },
      "title": "BoundedDifferenceConstraint"
    },
    "CliExecutionRequestBody": {
      "type": "object",
      "properties": { "executeViaCLI": { "type": "boolean" } },
      "title": "CliExecutionRequestBody"
    },
    "ExecutableMasterAndMultiModelTDO": {
      "type": "object",
      "properties": {
        "masterModel": { "type": "string" },
        "multiModel": { "$ref": "#/definitions/ ExtendedMultiModel" },
        "executionParameters": { "$ref": "#/definitions/ ExecutionParameters" }
      },
      "title": "ExecutableMasterAndMultiModelTDO"
    },
    "ExecutionParameters": {
      "type": "object",
      "properties": {
        "convergenceRelativeTolerance": {
          "type": "number",
          "format": "double"
        },
        "convergenceAbsoluteTolerance": {
          "type": "number",
          "format": "double"
        },
        "convergenceAttempts": { "type": "integer", "format": "int32" },
        "startTime": { "type": "number", "format": "double" },
        "endTime": { "type": "number", "format": "double" },
        "stepSize": { "type": "number", "format": "double" },
        "liveLogInterval": { "type": "number", "format": "double" }
      },
      "title": "ExecutionParameters"
    },
    "ExtendedMultiModel": {
      "type": "object",
      "properties": {
        "fmus": {
          "type": "object",
          "additionalProperties": { "type": "string" }
        },
        "connections": {
          "type": "object",
          "additionalProperties": {
            "type": "array",
            "items": { "type": "string" }
          }
        },
        "parameters": { "type": "object" },
        "logVariables": {
          "type": "object",
          "additionalProperties": {
            "type": "array",
            "items": { "type": "string" }
          }
        },
        "parallelSimulation": { "type": "boolean" },
        "stabalizationEnabled": { "type": "boolean" },
        "global_absolute_tolerance": { "type": "number", "format": "double" },
        "global_relative_tolerance": { "type": "number", "format": "double" },
        "loggingOn": { "type": "boolean" },
        "visible": { "type": "boolean" },
        "simulationProgramDelay": { "type": "boolean" },
        "algorithm": { "$ref": "#/definitions/ IAlgorithmConfig" },
        "overrideLogLevel": {
          "type": "string",
          "enum": [
            "OFF",
            "FATAL",
            "ERROR",
            "WARN",
            "INFO",
            "DEBUG",
            "TRACE",
            "ALL"
          ]
        },
        "environmentParameters": {
          "type": "array",
          "items": { "type": "string" }
        },
        "logLevels": {
          "type": "object",
          "additionalProperties": {
            "type": "array",
            "items": { "type": "string" }
          }
        },
        "sigver": { "$ref": "#/definitions/ Sigver" },
        "faultInjectConfigurationPath": { "type": "string" },
        "faultInjectInstances": {
          "type": "object",
          "additionalProperties": { "type": "string" }
        },
        "convergenceAttempts": { "type": "integer", "format": "int32" },
        "modelTransfers": {
          "type": "object",
          "additionalProperties": { "type": "string" }
        },
        "modelSwaps": {
          "type": "object",
          "additionalProperties": { "$ref": "#/definitions/ ModelSwap" }
        }
      },
      "title": "ExtendedMultiModel"
    },
    "File": {
      "type": "object",
      "properties": {
        "absolute": { "type": "boolean" },
        "absoluteFile": { "$ref": "#/definitions/ File" },
        "absolutePath": { "type": "string" },
        "canonicalFile": { "$ref": "#/ definitions/File" },
        "canonicalPath": { "type": "string" },
        "directory": { "type": "boolean" },
        "executable": { "type": "boolean" },
        "file": { "type": "boolean" },
        "freeSpace": { "type": "integer", "format": "int64" },
        "hidden": { "type": "boolean" },
        "lastModified": { "type": "integer", "format": "int64" },
        "name": { "type": "string" },
        "parent": { "type": "string" },
        "parentFile": { "$ref": "#/definitions/File" },
        "path": { "type": "string" },
        "readable": { "type": "boolean" },
        "totalSpace": { "type": "integer", "format": "int64" },
        "usableSpace": { "type": "integer", "format": "int64" },
        "writable": { "type": "boolean" }
      },
      "title": "File"
    },
    "FileSystemResource": {
      "type": "object",
      "properties": {
        "description": { "type": "string" },
        "file": { "$ref": "#/definitions/File" },
        "filename": { "type": "string" },
        "inputStream": { "$ref": "#/definitions/ InputStream" },
        "open": { "type": "boolean" },
        "outputStream": { "$ref": "#/ definitions/OutputStream" },
        "path": { "type": "string" },
        "readable": { "type": "boolean" },
        "uri": { "$ref": "#/definitions/URI" },
        "url": { "$ref": "#/ definitions/URL" },
        "writable": { "type": "boolean" }
      },
      "title": "FileSystemResource"
    },
    "FixedStepAlgorithmConfig": {
      "title": "FixedStepAlgorithmConfig",
      "allOf": [
        { "$ref": "#/definitions/ IAlgorithmConfig" },
        {
          "type": "object",
          "properties": { "size": { "type": "number", "format": "double" } },
          "title": "FixedStepAlgorithmConfig"
        }
      ]
    },
    "FmuMaxStepSizeConstraint": {
      "type": "object",
      "properties": { "type": { "type": "string" } },
      "title": "FmuMaxStepSizeConstraint"
    },
    "IAlgorithmConfig": {
      "type": "object",
      "discriminator": "type",
      "title": "IAlgorithmConfig",
      "description": "Simulation algorithm."
    },
    "InitializationData": {
      "type": "object",
      "properties": {
        "fmus": {
          "type": "object",
          "additionalProperties": { "type": "string" }
        },
        "connections": {
          "type": "object",
          "additionalProperties": {
            "type": "array",
            "items": { "type": "string" }
          }
        },
        "parameters": { "type": "object" },
        "logVariables": {
          "type": "object",
          "additionalProperties": {
            "type": "array",
            "items": { "type": "string" }
          }
        },
        "parallelSimulation": { "type": "boolean" },
        "stabalizationEnabled": { "type": "boolean" },
        "global_absolute_tolerance": { "type": "number", "format": "double" },
        "global_relative_tolerance": { "type": "number", "format": "double" },
        "loggingOn": { "type": "boolean" },
        "visible": { "type": "boolean" },
        "simulationProgramDelay": { "type": "boolean" },
        "algorithm": { "$ref": "#/definitions/ IAlgorithmConfig" },
        "overrideLogLevel": {
          "type": "string",
          "enum": [
            "OFF",
            "FATAL",
            "ERROR",
            "WARN",
            "INFO",
            "DEBUG",
            "TRACE",
            "ALL"
          ]
        },
        "environmentParameters": {
          "type": "array",
          "items": { "type": "string" }
        },
        "logLevels": {
          "type": "object",
          "additionalProperties": {
            "type": "array",
            "items": { "type": "string" }
          }
        },
        "livestream": {
          "type": "object",
          "additionalProperties": {
            "type": "array",
            "items": { "type": "string" }
          }
        },
        "hasExternalSignals": { "type": "boolean" },
        "faultInjectConfigurationPath": { "type": "string" },
        "faultInjectInstances": {
          "type": "object",
          "additionalProperties": { "type": "string" }
        },
        "convergenceAttempts": { "type": "integer", "format": "int32" },
        "externalSpecs": {
          "type": "array",
          "items": { "$ref": "#/definitions/File" }
        },
        "modelTransfers": {
          "type": "object",
          "additionalProperties": { "type": "string" }
        },
        "modelSwaps": {
          "type": "object",
          "additionalProperties": { "$ref": "#/definitions/ ModelSwap" }
        }
      },
      "title": "InitializationData"
    },
    "InitializeStatusModel": {
      "type": "object",
      "properties": {
        "availableLogLevels": {
          "type": "object",
          "additionalProperties": {
            "type": "array",
            "items": { "$ref": "#/definitions/LogLevelModel" }
          }
        },
        "errors": { "type": "array", "items": { "type": "string" } },
        "lastExecTime": { "type": "integer", "format": "int64" },
        "sessionId": { "type": "string" },
        "status": { "type": "string" },
        "warnings": { "type": "array", "items": { "type": "string" } }
      },
      "title": "InitializeStatusModel"
    },
    "InputStream": { "type": "object", "title": "InputStream" },
    "LogLevelModel": {
      "type": "object",
      "properties": {
        "description": { "type": "string" },
        "name": { "type": "string" }
      },
      "title": "LogLevelModel"
    },
    "ModelSwap": {
      "type": "object",
      "properties": {
        "stepCondition": { "type": "string" },
        "swapCondition": { "type": "string" },
        "swapConnections": {
          "type": "object",
          "additionalProperties": {
            "type": "array",
            "items": { "type": "string" }
          }
        },
        "swapInstance": { "type": "string" }
      },
      "title": "ModelSwap"
    },
    "OutputStream": { "type": "object", "title": "OutputStream" },
    "Resource": {
      "type": "object",
      "properties": {
        "description": { "type": "string" },
        "file": { "$ref": "#/definitions/File" },
        "filename": { "type": "string" },
        "inputStream": { "$ref": "#/definitions/ InputStream" },
        "open": { "type": "boolean" },
        "readable": { "type": "boolean" },
        "uri": { "$ref": "#/definitions/URI" },
        "url": { "$ref": "#/ definitions/URL" }
      },
      "title": "Resource"
    },
    "SamplingConstraint": {
      "type": "object",
      "properties": {
        "base": { "type": "integer", "format": "int32" },
        "rate": { "type": "integer", "format": "int32" },
        "startTime": { "type": "integer", "format": "int32" },
        "type": { "type": "string" }
      },
      "title": "SamplingConstraint"
    },
    "Sigver": {
      "type": "object",
      "properties": {
        "reactivity": {
          "type": "object",
          "additionalProperties": { "type": "string" }
        },
        "verification": { "type": "boolean" }
      },
      "title": "Sigver"
    },
    "SigverSimulateRequestBody": {
      "type": "object",
      "properties": {
        "masterModel": {
          "type": "string",
          "description": "The sigver master model containing both the scenario, connections, initialization and co-sim steps"
        },
        "startTime": {
          "type": "number",
          "format": "double",
          "description": "The start time of the co-simulation"
        },
        "endTime": { "type": "number", "format": "double" },
        "logLevels": {
          "type": "object",
          "additionalProperties": {
            "type": "array",
            "items": { "type": "string" }
          }
        },
        "reportProgress": { "type": "boolean" },
        "liveLogInterval": { "type": "number", "format": "double" }
      },
      "title": "SigverSimulateRequestBody"
    },
    "SimulateRequestBody": {
      "type": "object",
      "properties": {
        "startTime": {
          "type": "number",
          "format": "double",
          "description": "The start time of the co-simulation"
        },
        "endTime": { "type": "number", "format": "double" },
        "logLevels": {
          "type": "object",
          "additionalProperties": {
            "type": "array",
            "items": { "type": "string" }
          }
        },
        "reportProgress": { "type": "boolean" },
        "liveLogInterval": { "type": "number", "format": "double" },
        "masterModel": { "type": "string" }
      },
      "title": "SimulateRequestBody"
    },
    "StatusModel": {
      "type": "object",
      "properties": {
        "errors": { "type": "array", "items": { "type": "string" } },
        "lastExecTime": { "type": "integer", "format": "int64" },
        "sessionId": { "type": "string" },
        "status": { "type": "string" },
        "warnings": { "type": "array", "items": { "type": "string" } }
      },
      "title": "StatusModel"
    },
    "URI": {
      "type": "object",
      "properties": {
        "absolute": { "type": "boolean" },
        "authority": { "type": "string" },
        "fragment": { "type": "string" },
        "host": { "type": "string" },
        "opaque": { "type": "boolean" },
        "path": { "type": "string" },
        "port": { "type": "integer", "format": "int32" },
        "query": { "type": "string" },
        "rawAuthority": { "type": "string" },
        "rawFragment": { "type": "string" },
        "rawPath": { "type": "string" },
        "rawQuery": { "type": "string" },
        "rawSchemeSpecificPart": { "type": "string" },
        "rawUserInfo": { "type": "string" },
        "scheme": { "type": "string" },
        "schemeSpecificPart": { "type": "string" },
        "userInfo": { "type": "string" }
      },
      "title": "URI"
    },
    "URL": {
      "type": "object",
      "properties": {
        "authority": { "type": "string" },
        "content": { "type": "object" },
        "defaultPort": { "type": "integer", "format": "int32" },
        "file": { "type": "string" },
        "host": { "type": "string" },
        "path": { "type": "string" },
        "port": { "type": "integer", "format": "int32" },
        "protocol": { "type": "string" },
        "query": { "type": "string" },
        "ref": { "type": "string" },
        "userInfo": { "type": "string" }
      },
      "title": "URL"
    },
    "VariableStepAlgorithmConfig": {
      "title": "VariableStepAlgorithmConfig",
      "allOf": [
        { "$ref": "#/definitions/ IAlgorithmConfig" },
        {
          "type": "object",
          "properties": {
            "size": {
              "type": "array",
              "items": { "type": "number", "format": "double" }
            },
            "initsize": { "type": "number", "format": "double" },
            "constraints": {
              "type": "object",
              "additionalProperties": {
                "$ref": "#/definitions/ VarStepConstraint"
              }
            }
          },
          "title": "VariableStepAlgorithmConfig"
        }
      ]
    },
    "VerificationResult": {
      "type": "object",
      "properties": {
        "correct": { "type": "boolean" },
        "errorMessage": { "type": "string" },
        "masterModel": { "type": "string" }
      },
      "title": "VerificationResult"
    },
    "ZeroCrossingConstraint": {
      "type": "object",
      "properties": {
        "abstol": { "type": "number", "format": "double" },
        "order": { "type": "integer", "format": "int32" },
        "ports": { "type": "array", "items": { "type": "string" } },
        "safety": { "type": "number", "format": "double" },
        "type": { "type": "string" }
      },
      "title": "ZeroCrossingConstraint"
    }
  }
}
Clone this wiki locally