Modelon Impact storage and execution API - 4.1.1

Can be used by client to check that the API is of a version it supports. The APIs version is semantic.

Responses

200

A JSON object consisting of the APIs meta data, most notably the semantic version of it.

Example

{
  "version": "1.0.0"
}

500

An internal server error.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

The HTML documentation page for all the Modelon Impact REST API's.

Responses

200

The HTML documentation page.

Example

500

An internal server error.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

When the login succeeds, the response includes a cookie containing an access token which is used for further identification with the REST API. The login is managed by a third party authorization service. To authenticate against the REST API, an API key may be included in the optional request body. The API key can be created in the 'IMPACT API KEY' section of the 'Server management' page.

Parameters

Request body

Optional request body for logging in with an API key.

Example

{
  "secretKey": "secret-api-key"
}

Responses

200

The user is already logged in and the JWT is valid.

Example

{
  "identifier": ""
}

201

The user was logged in and a new JWT was created.

Example

{
  "identifier": ""
}

400

The request could not be processed. The request is most likely not correct.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

401

The request could not be performed because of missing authentication.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

402

The request could not be performed because the system is out of payed for floating seats.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

403

Action is not allowed. Permissions might be insufficient.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

404

The resource could not be found. Typically this means that a resource the request is referencing does not exists. Common resources are workspaces, libraries, model-executables and experiments.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

500

An internal server error.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

Returns a list of all local projects that exists. The query parameter vcsInfo can be used to also get info on how projects are version controlled.

Parameters

Responses

200

OK: The projects were returned.

Example

{
  "data": {
    "items": [
      {
        "id": "79sd8-3n2a4-e3t24",
        "definition": {
          "name": "MyProject",
          "version": "2.0.3-beta.3+build.5",
          "format": "1.0.0",
          "dependencies": [
            {
              "name": "Modelica",
              "versionSpecifier": "4.0.0"
            }
          ],
          "content": [
            {
              "relpath": "SomeLib.mo",
              "contentType": "MODELICA",
              "name": "SomeLib",
              "defaultDisabled": true,
              "id": "79sd8-3n2a4-e3t24"
            }
          ],
          "executionOptions": [
            {
              "customFunction": "steady state",
              "compiler": {
                "generate_html_diagnostics": true,
                "halt_on_warning": true
              },
              "runtime": {
                "use_Brent_in_1d": false
              },
              "simulation": {
                "ncp": 2000
              },
              "solver": {
                "rtol": 0.0001
              }
            }
          ],
          "icon": ".impact/icon.png"
        },
        "projectType": "LOCAL",
        "vcsUri": {
          "serviceKind": "GIT",
          "serviceUrl": "https://github.com",
          "repoUrl": {
            "url": "gitlab.com/group/project",
            "refname": "main",
            "sha1": "3486a89"
          },
          "protocol": "https",
          "subdir": "src"
        },
        "size": ""
      }
    ]
  }
}

401

The request could not be performed because of missing authentication.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

402

The request could not be performed because the system is out of payed for floating seats.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

403

Action is not allowed. Permissions might be insufficient.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

500

An internal server error.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

Returns a list of all 'running' and 'pending' executions.

Responses

200

OK: The active executions were returned.

Example

{
  "data": {
    "items": [
      {
        "status": "running",
        "workspace": {
          "id": "somemodel_1515we151fwe51w"
        },
        "kind": "EXPERIMENT",
        "experiment": {
          "id": "somemodel_1gghhjffffe51w"
        }
      }
    ]
  }
}

401

The request could not be performed because of missing authentication.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

402

The request could not be performed because the system is out of payed for floating seats.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

403

Action is not allowed. Permissions might be insufficient.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

500

An internal server error.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

Will initiate import of a project. After a successful completion of a call to this endpoint, call GET /project-imports/{importId} to check status.

Request body

A zip file of a project given with multipart/form-data to import a project.

Example

{
  "file": "my_project.zip"
}

Responses

201

Project import created and location to check status of import is returned.

Example

{
  "data": {
    "location": "api/project-imports/fd90-4gkl-vf89"
  }
}

401

The request could not be performed because of missing authentication.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

402

The request could not be performed because the system is out of payed for floating seats.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

403

Action is not allowed. Permissions might be insufficient.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

500

An internal server error.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

The project needs to be setup for import by calling POST /project-imports, before calling this API endpoint.

Parameters

Responses

200

Status for a project import and data to resource if import is done and project is ready to be used.

Example

{
  "data": {
    "id": "79sd8-3n2a4-e3t24",
    "status": "",
    "data": {
      "resourceUri": "api/projects/72d3969cca3fc912aca1097bcc49dda0a4481a06",
      "projectId": "72d3969cca3fc912aca1097bcc49dda0a4481a06"
    },
    "error": {
      "message": "Could not import project 'my_project'. Could not read version number of the project 'my_project'. Either the project is corrupt or needs to be updated using an older version of Modelon Impact",
      "code": 12015
    }
  }
}

401

The request could not be performed because of missing authentication.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

402

The request could not be performed because the system is out of payed for floating seats.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

403

Action is not allowed. Permissions might be insufficient.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

404

The resource could not be found. Typically this means that a resource the request is referencing does not exists. Common resources are workspaces, libraries, model-executables and experiments.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

409

The request could not be performed because there is a conflict.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

500

An internal server error.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

This API end point can be be called after a project has been imported.

Parameters

Responses

200

OK: The project import with the specified ID was deleted.

401

The request could not be performed because of missing authentication.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

402

The request could not be performed because the system is out of payed for floating seats.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

403

Action is not allowed. Permissions might be insufficient.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

404

The resource could not be found. Typically this means that a resource the request is referencing does not exists. Common resources are workspaces, libraries, model-executables and experiments.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

409

The request could not be performed because there is a conflict.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

500

An internal server error.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

The compressed project will be prepared. After a successful completion of a call to this endpoint, call GET /project-exports/{exportId} to check status.

Request body

Project to export.

Example

{
  "projectId": "my_project"
}

Responses

201

The location for checking status and possible data for compressed project.

Example

{
  "data": {
    "location": "api/project-exports/79sd8-3n2a4-e3t24"
  }
}

400

The request could not be processed. The request is most likely not correct.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

401

The request could not be performed because of missing authentication.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

402

The request could not be performed because the system is out of payed for floating seats.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

403

Action is not allowed. Permissions might be insufficient.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

409

The request could not be performed because there is a conflict.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

500

An internal server error.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

The project needs to be setup for export by calling POST /project-exports, before calling this API endpoint.

Parameters

Responses

200

Status for a project export and data to download it if ready.

Example

{
  "data": {
    "id": "79sd8-3n2a4-e3t24",
    "status": "",
    "data": {
      "downloadUri": "api/exports/79sd8-3n2a4-e3t24",
      "size": 10481015
    },
    "error": {
      "message": "Could not export project 'my_project'. Maximum allowed zip file size of 95MB exceeded",
      "code": 12072
    }
  }
}

401

The request could not be performed because of missing authentication.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

402

The request could not be performed because the system is out of payed for floating seats.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

403

Action is not allowed. Permissions might be insufficient.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

404

The resource could not be found. Typically this means that a resource the request is referencing does not exists. Common resources are workspaces, libraries, model-executables and experiments.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

409

The request could not be performed because there is a conflict.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

500

An internal server error.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

This API end point can be be called after a compressed project has been downloaded.

Parameters

Responses

200

OK: The project export with the specified ID was deleted.

401

The request could not be performed because of missing authentication.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

402

The request could not be performed because the system is out of payed for floating seats.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

403

Action is not allowed. Permissions might be insufficient.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

404

The resource could not be found. Typically this means that a resource the request is referencing does not exists. Common resources are workspaces, libraries, model-executables and experiments.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

409

The request could not be performed because there is a conflict.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

500

An internal server error.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

Returns a project given a project ID. The query parameter vcsInfo can be used to also get info on how the project is version controlled.

Parameters

Responses

200

OK: The project were returned.

Example

{
  "id": "79sd8-3n2a4-e3t24",
  "definition": {
    "name": "MyProject",
    "version": "2.0.3-beta.3+build.5",
    "format": "1.0.0",
    "dependencies": [
      {
        "name": "Modelica",
        "versionSpecifier": "4.0.0"
      }
    ],
    "content": [
      {
        "relpath": "SomeLib.mo",
        "contentType": "MODELICA",
        "name": "SomeLib",
        "defaultDisabled": true,
        "id": "79sd8-3n2a4-e3t24"
      }
    ],
    "executionOptions": [
      {
        "customFunction": "steady state",
        "compiler": {
          "generate_html_diagnostics": true,
          "halt_on_warning": true
        },
        "runtime": {
          "use_Brent_in_1d": false
        },
        "simulation": {
          "ncp": 2000
        },
        "solver": {
          "rtol": 0.0001
        }
      }
    ],
    "icon": ".impact/icon.png"
  },
  "projectType": "LOCAL",
  "vcsUri": {
    "serviceKind": "GIT",
    "serviceUrl": "https://github.com",
    "repoUrl": {
      "url": "gitlab.com/group/project",
      "refname": "main",
      "sha1": "3486a89"
    },
    "protocol": "https",
    "subdir": "src"
  },
  "size": ""
}

401

The request could not be performed because of missing authentication.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

402

The request could not be performed because the system is out of payed for floating seats.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

403

Action is not allowed. Permissions might be insufficient.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

404

The resource could not be found. Typically this means that a resource the request is referencing does not exists. Common resources are workspaces, libraries, model-executables and experiments.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

500

An internal server error.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

Updates a project given project data and a project ID. Only the project definition is allowed to be updated and content entries cannot be added or deleted. Content ID or project format cannot be updated.

Parameters

Request body

The project data that should be used to update the entity server side.

Example

{
  "id": "79sd8-3n2a4-e3t24",
  "definition": {
    "name": "MyProject",
    "version": "2.0.3-beta.3+build.5",
    "format": "1.0.0",
    "dependencies": [
      {
        "name": "Modelica",
        "versionSpecifier": "4.0.0"
      }
    ],
    "content": [
      {
        "relpath": "SomeLib.mo",
        "contentType": "MODELICA",
        "name": "SomeLib",
        "defaultDisabled": true,
        "id": "79sd8-3n2a4-e3t24"
      }
    ],
    "executionOptions": [
      {
        "customFunction": "steady state",
        "compiler": {
          "generate_html_diagnostics": true,
          "halt_on_warning": true
        },
        "runtime": {
          "use_Brent_in_1d": false
        },
        "simulation": {
          "ncp": 2000
        },
        "solver": {
          "rtol": 0.0001
        }
      }
    ],
    "icon": ".impact/icon.png"
  },
  "projectType": "LOCAL",
  "vcsUri": {
    "serviceKind": "GIT",
    "serviceUrl": "https://github.com",
    "repoUrl": {
      "url": "gitlab.com/group/project",
      "refname": "main",
      "sha1": "3486a89"
    },
    "protocol": "https",
    "subdir": "src"
  },
  "size": ""
}

Responses

200

OK: The project were updated.

Example

{
  "id": "79sd8-3n2a4-e3t24",
  "definition": {
    "name": "MyProject",
    "version": "2.0.3-beta.3+build.5",
    "format": "1.0.0",
    "dependencies": [
      {
        "name": "Modelica",
        "versionSpecifier": "4.0.0"
      }
    ],
    "content": [
      {
        "relpath": "SomeLib.mo",
        "contentType": "MODELICA",
        "name": "SomeLib",
        "defaultDisabled": true,
        "id": "79sd8-3n2a4-e3t24"
      }
    ],
    "executionOptions": [
      {
        "customFunction": "steady state",
        "compiler": {
          "generate_html_diagnostics": true,
          "halt_on_warning": true
        },
        "runtime": {
          "use_Brent_in_1d": false
        },
        "simulation": {
          "ncp": 2000
        },
        "solver": {
          "rtol": 0.0001
        }
      }
    ],
    "icon": ".impact/icon.png"
  },
  "projectType": "LOCAL",
  "vcsUri": {
    "serviceKind": "GIT",
    "serviceUrl": "https://github.com",
    "repoUrl": {
      "url": "gitlab.com/group/project",
      "refname": "main",
      "sha1": "3486a89"
    },
    "protocol": "https",
    "subdir": "src"
  },
  "size": ""
}

400

The request could not be processed. The request is most likely not correct.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

401

The request could not be performed because of missing authentication.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

402

The request could not be performed because the system is out of payed for floating seats.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

403

Action is not allowed. Permissions might be insufficient.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

404

The resource could not be found. Typically this means that a resource the request is referencing does not exists. Common resources are workspaces, libraries, model-executables and experiments.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

500

An internal server error.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

Deletes a project given a project ID. Will also delete any reference from workspaces to this project.

Parameters

Responses

200

OK: The project were deleted.

Example

{
  "id": "79sd8-3n2a4-e3t24",
  "definition": {
    "name": "MyProject",
    "version": "2.0.3-beta.3+build.5",
    "format": "1.0.0",
    "dependencies": [
      {
        "name": "Modelica",
        "versionSpecifier": "4.0.0"
      }
    ],
    "content": [
      {
        "relpath": "SomeLib.mo",
        "contentType": "MODELICA",
        "name": "SomeLib",
        "defaultDisabled": true,
        "id": "79sd8-3n2a4-e3t24"
      }
    ],
    "executionOptions": [
      {
        "customFunction": "steady state",
        "compiler": {
          "generate_html_diagnostics": true,
          "halt_on_warning": true
        },
        "runtime": {
          "use_Brent_in_1d": false
        },
        "simulation": {
          "ncp": 2000
        },
        "solver": {
          "rtol": 0.0001
        }
      }
    ],
    "icon": ".impact/icon.png"
  },
  "projectType": "LOCAL",
  "vcsUri": {
    "serviceKind": "GIT",
    "serviceUrl": "https://github.com",
    "repoUrl": {
      "url": "gitlab.com/group/project",
      "refname": "main",
      "sha1": "3486a89"
    },
    "protocol": "https",
    "subdir": "src"
  },
  "size": ""
}

401

The request could not be performed because of missing authentication.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

402

The request could not be performed because the system is out of payed for floating seats.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

403

Action is not allowed. Permissions might be insufficient.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

404

The resource could not be found. Typically this means that a resource the request is referencing does not exists. Common resources are workspaces, libraries, model-executables and experiments.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

500

An internal server error.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

Returns the icon(if it exists) for the project.

Parameters

Responses

200

OK: The image was returned.

Example

401

The request could not be performed because of missing authentication.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

402

The request could not be performed because the system is out of payed for floating seats.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

403

Action is not allowed. Permissions might be insufficient.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

404

The resource could not be found. Typically this means that a resource the request is referencing does not exists. Common resources are workspaces, libraries, model-executables and experiments.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

500

An internal server error.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

Will create a new content entry for a project. For MODELICA content entries an empty structured modelica library will also be created on disk.

Parameters

Request body

Specification for the new content entry.

Example

{
  "new": {
    "relpath": "SomeLib.mo",
    "contentType": "MODELICA",
    "name": "SomeLib",
    "defaultDisabled": true
  }
}

Responses

200

Content entry is created and returned.

Example

{
  "relpath": "SomeLib.mo",
  "contentType": "MODELICA",
  "name": "SomeLib",
  "defaultDisabled": true,
  "id": "79sd8-3n2a4-e3t24"
}

400

The request could not be processed. The request is most likely not correct.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

401

The request could not be performed because of missing authentication.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

402

The request could not be performed because the system is out of payed for floating seats.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

403

Action is not allowed. Permissions might be insufficient.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

500

An internal server error.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

Returns a content entry given project and content IDs.

Parameters

Responses

200

OK: The content entry were returned.

Example

{
  "relpath": "SomeLib.mo",
  "contentType": "MODELICA",
  "name": "SomeLib",
  "defaultDisabled": true,
  "id": "79sd8-3n2a4-e3t24"
}

401

The request could not be performed because of missing authentication.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

402

The request could not be performed because the system is out of payed for floating seats.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

403

Action is not allowed. Permissions might be insufficient.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

404

The resource could not be found. Typically this means that a resource the request is referencing does not exists. Common resources are workspaces, libraries, model-executables and experiments.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

500

An internal server error.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

Deletes a content entry from a project. Any files on disk that exists for this content is also deleted.

Parameters

Responses

200

OK: The content were deleted.

Example

{
  "relpath": "SomeLib.mo",
  "contentType": "MODELICA",
  "name": "SomeLib",
  "defaultDisabled": true,
  "id": "79sd8-3n2a4-e3t24"
}

401

The request could not be performed because of missing authentication.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

402

The request could not be performed because the system is out of payed for floating seats.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

403

Action is not allowed. Permissions might be insufficient.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

404

The resource could not be found. Typically this means that a resource the request is referencing does not exists. Common resources are workspaces, libraries, model-executables and experiments.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

500

An internal server error.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

Will initiate import of existing content. After a successful completion of a call to this endpoint, call GET /projects/{project}/content-imports/{importId} to check status.

Parameters

Request body

A zip file or a .mo file (For MODELICA content) given with multipart/form-data is used to import content.

Example

{
  "file": "modelica.zip",
  "options": {
    "contentType": "MODELICA"
  }
}

Responses

201

Content import created and location to check status of import is returned.

Example

{
  "data": {
    "location": "api/projects/79sd8-3n2a4-e3t24/content-imports/fd90-4gkl-vf89"
  }
}

401

The request could not be performed because of missing authentication.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

402

The request could not be performed because the system is out of payed for floating seats.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

403

Action is not allowed. Permissions might be insufficient.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

500

An internal server error.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

The content needs to be setup for import by calling POST /content-imports, before calling this API endpoint.

Parameters

Responses

200

Status for a content import and data to resource if import is done and content is ready to be used.

Example

{
  "data": {
    "id": "79sd8-3n2a4-e3t24",
    "status": "",
    "data": {
      "resourceUri": "api/projects/a9g0-adfd/contents/u760-u095-gu45",
      "contentId": "u760-u095-gu45"
    },
    "error": {
      "message": "Could not import MODELICA content, file must end with .mo or .zip.",
      "code": 12015
    }
  }
}

401

The request could not be performed because of missing authentication.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

402

The request could not be performed because the system is out of payed for floating seats.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

403

Action is not allowed. Permissions might be insufficient.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

404

The resource could not be found. Typically this means that a resource the request is referencing does not exists. Common resources are workspaces, libraries, model-executables and experiments.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

409

The request could not be performed because there is a conflict.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

500

An internal server error.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

This API end point can be be called after a content has been imported.

Parameters

Responses

200

OK: The content import with the specified ID was deleted.

401

The request could not be performed because of missing authentication.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

402

The request could not be performed because the system is out of payed for floating seats.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

403

Action is not allowed. Permissions might be insufficient.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

404

The resource could not be found. Typically this means that a resource the request is referencing does not exists. Common resources are workspaces, libraries, model-executables and experiments.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

409

The request could not be performed because there is a conflict.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

500

An internal server error.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

Parameters

Request body

The file with a .fmu extension and options to import.

Example

{
  "file": "PID.fmu",
  "options": {
    "className": "Workspace.Modelica_Electrical_Spice3_Examples_Spice3BenchmarkRtlInverter",
    "mslVersion": "4.0.0",
    "overwrite": false,
    "includePatterns": [
      "variable1",
      "variable2"
    ],
    "excludePatterns": [
      "variable1",
      "variable2"
    ],
    "topLevelInputs": [
      "variable1",
      "variable2"
    ],
    "stepSize": 0.1
  }
}

Responses

201

FMU import created and location to check status of import is returned.

Example

{
  "data": {
    "location": "api/projects/79sd8-3n2a4-e3t24/content/fd90-4gkl-vf89/fmu-imports/123d-4g56-67tr"
  }
}

400

The request could not be processed. The request is most likely not correct.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

401

The request could not be performed because of missing authentication.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

402

The request could not be performed because the system is out of payed for floating seats.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

403

Action is not allowed. Permissions might be insufficient.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

404

The resource could not be found. Typically this means that a resource the request is referencing does not exists. Common resources are workspaces, libraries, model-executables and experiments.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

409

The request could not be performed because there is a conflict.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

500

An internal server error.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

The content needs to be setup for import by calling POST /fmu-imports, before calling this API endpoint.

Parameters

Responses

200

Status for a FMU import and data to resource if import is done and FMU is ready to be used.

Example

{
  "data": {
    "id": "79sd8-3n2a4-e3t24",
    "status": "",
    "data": {
      "resourceUri": "api/projects/a9g0-adfd/contents/u760-u095-gu45",
      "fmuClassPath": "Workspace.PID_Controller.Model",
      "importWarnings": [
        "Specified argument for 'top_level_inputs=['a']' does not match any variable"
      ]
    },
    "error": {
      "message": "Could not generate class MyPackage.PID because there is already a class by that name.",
      "code": 12099
    }
  }
}

401

The request could not be performed because of missing authentication.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

402

The request could not be performed because the system is out of payed for floating seats.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

403

Action is not allowed. Permissions might be insufficient.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

404

The resource could not be found. Typically this means that a resource the request is referencing does not exists. Common resources are workspaces, libraries, model-executables and experiments.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

409

The request could not be performed because there is a conflict.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

500

An internal server error.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

This API end point can be be called after a FMU has been imported.

Parameters

Responses

200

OK: The FMU import with the specified ID was deleted.

401

The request could not be performed because of missing authentication.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

402

The request could not be performed because the system is out of payed for floating seats.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

403

Action is not allowed. Permissions might be insufficient.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

404

The resource could not be found. Typically this means that a resource the request is referencing does not exists. Common resources are workspaces, libraries, model-executables and experiments.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

409

The request could not be performed because there is a conflict.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

500

An internal server error.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

The response from this endpoint can be used as a template to create a new workspace by sending it as the request body for the POST /workspaces endpoint.

Responses

200

Workspace definition template.

Example

{
  "name": "My workspace",
  "description": "Workspace with all my projects",
  "defaultProjectId": "79sd8-3n2a4-e3t24",
  "projects": [
    {
      "reference": {
        "id": "ac2d-47ca-a5d5",
        "name": "Hydralics",
        "version": "2.0.3"
      },
      "disabled": true,
      "disabledContent": [
        "79sd8-3n2a4-e3t24",
        "t24e3-a43n2-d879s"
      ]
    }
  ],
  "dependencies": [
    {
      "reference": {
        "id": "ac2d-47ca-a5d5",
        "name": "Hydralics",
        "version": "2.0.3"
      },
      "disabled": true,
      "disabledContent": [
        "79sd8-3n2a4-e3t24",
        "t24e3-a43n2-d879s"
      ]
    }
  ]
}

400

The request could not be processed. The request is most likely not correct.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

401

The request could not be performed because of missing authentication.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

402

The request could not be performed because the system is out of payed for floating seats.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

403

Action is not allowed. Permissions might be insufficient.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

409

The request could not be performed because there is a conflict.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

500

An internal server error.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

The workspace ID in the returned object serve as unique IDs that can be used in other API calls to perform operations for a specific workspace.

Responses

200

All workspaces meta-data and their IDs. The object meta-data contains the workspace id.

Example

{
  "data": {
    "items": [
      {
        "id": "my_workspace",
        "conversion": {
          "state": "UP_TO_DATE"
        },
        "definition": {
          "name": "My workspace",
          "description": "Workspace with all my projects",
          "defaultProjectId": "79sd8-3n2a4-e3t24",
          "projects": [
            {
              "reference": {
                "id": "ac2d-47ca-a5d5",
                "name": "Hydralics",
                "version": "2.0.3"
              },
              "disabled": true,
              "disabledContent": [
                "79sd8-3n2a4-e3t24",
                "t24e3-a43n2-d879s"
              ]
            }
          ],
          "dependencies": [
            {
              "reference": {
                "id": "ac2d-47ca-a5d5",
                "name": "Hydralics",
                "version": "2.0.3"
              },
              "disabled": true,
              "disabledContent": [
                "79sd8-3n2a4-e3t24",
                "t24e3-a43n2-d879s"
              ]
            }
          ],
          "format": "1.0.0",
          "guid": "6d8ae8b3b0594125a0cb7acd6adbb0f9",
          "createdBy": "98dy-a82a-s8tg",
          "createdAt": 1549552749,
          "appMode": {
            "model": ""
          }
        },
        "backup": {
          "name": "My Workspace backup",
          "workspaceId": "my_workspace"
        },
        "sizeInfo": {
          "total": 7014
        }
      }
    ]
  }
}

401

The request could not be performed because of missing authentication.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

402

The request could not be performed because the system is out of payed for floating seats.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

403

Action is not allowed. Permissions might be insufficient.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

409

The request could not be performed because there is a conflict.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

500

An internal server error.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

Creates a new workspace with some name.

Request body

Specification for creating a new workspace.

Example

{
  "new": {
    "name": "My workspace",
    "description": "Workspace with all my projects",
    "defaultProjectId": "79sd8-3n2a4-e3t24",
    "projects": [
      {
        "reference": {
          "id": "ac2d-47ca-a5d5",
          "name": "Hydralics",
          "version": "2.0.3"
        },
        "disabled": true,
        "disabledContent": [
          "79sd8-3n2a4-e3t24",
          "t24e3-a43n2-d879s"
        ]
      }
    ],
    "dependencies": [
      {
        "reference": {
          "id": "ac2d-47ca-a5d5",
          "name": "Hydralics",
          "version": "2.0.3"
        },
        "disabled": true,
        "disabledContent": [
          "79sd8-3n2a4-e3t24",
          "t24e3-a43n2-d879s"
        ]
      }
    ]
  },
  "config": {
    "addDefaultProject": false,
    "addSystemProjects": false
  }
}

Responses

200

OK: Workspace added and the workspace was returned.

Example

{
  "id": "my_workspace",
  "conversion": {
    "state": "UP_TO_DATE"
  },
  "definition": {
    "name": "My workspace",
    "description": "Workspace with all my projects",
    "defaultProjectId": "79sd8-3n2a4-e3t24",
    "projects": [
      {
        "reference": {
          "id": "ac2d-47ca-a5d5",
          "name": "Hydralics",
          "version": "2.0.3"
        },
        "disabled": true,
        "disabledContent": [
          "79sd8-3n2a4-e3t24",
          "t24e3-a43n2-d879s"
        ]
      }
    ],
    "dependencies": [
      {
        "reference": {
          "id": "ac2d-47ca-a5d5",
          "name": "Hydralics",
          "version": "2.0.3"
        },
        "disabled": true,
        "disabledContent": [
          "79sd8-3n2a4-e3t24",
          "t24e3-a43n2-d879s"
        ]
      }
    ],
    "format": "1.0.0",
    "guid": "6d8ae8b3b0594125a0cb7acd6adbb0f9",
    "createdBy": "98dy-a82a-s8tg",
    "createdAt": 1549552749,
    "appMode": {
      "model": ""
    }
  },
  "backup": {
    "name": "My Workspace backup",
    "workspaceId": "my_workspace"
  },
  "sizeInfo": {
    "total": 7014
  }
}

401

The request could not be performed because of missing authentication.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

402

The request could not be performed because the system is out of payed for floating seats.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

403

Action is not allowed. Permissions might be insufficient.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

500

An internal server error.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

Parameters

Responses

200

Workspace ID and its meta-data. The object meta-data contains the workspace id.

Example

{
  "id": "my_workspace",
  "conversion": {
    "state": "UP_TO_DATE"
  },
  "definition": {
    "name": "My workspace",
    "description": "Workspace with all my projects",
    "defaultProjectId": "79sd8-3n2a4-e3t24",
    "projects": [
      {
        "reference": {
          "id": "ac2d-47ca-a5d5",
          "name": "Hydralics",
          "version": "2.0.3"
        },
        "disabled": true,
        "disabledContent": [
          "79sd8-3n2a4-e3t24",
          "t24e3-a43n2-d879s"
        ]
      }
    ],
    "dependencies": [
      {
        "reference": {
          "id": "ac2d-47ca-a5d5",
          "name": "Hydralics",
          "version": "2.0.3"
        },
        "disabled": true,
        "disabledContent": [
          "79sd8-3n2a4-e3t24",
          "t24e3-a43n2-d879s"
        ]
      }
    ],
    "format": "1.0.0",
    "guid": "6d8ae8b3b0594125a0cb7acd6adbb0f9",
    "createdBy": "98dy-a82a-s8tg",
    "createdAt": 1549552749,
    "appMode": {
      "model": ""
    }
  },
  "backup": {
    "name": "My Workspace backup",
    "workspaceId": "my_workspace"
  },
  "sizeInfo": {
    "total": 7014
  }
}

400

The request could not be processed. The request is most likely not correct.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

401

The request could not be performed because of missing authentication.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

402

The request could not be performed because the system is out of payed for floating seats.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

403

Action is not allowed. Permissions might be insufficient.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

409

The request could not be performed because there is a conflict.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

500

An internal server error.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

Updates the configuration of the workspace.

Parameters

Request body

Workspace configuration.

Example

{
  "id": "my_workspace",
  "conversion": {
    "state": "UP_TO_DATE"
  },
  "definition": {
    "name": "My workspace",
    "description": "Workspace with all my projects",
    "defaultProjectId": "79sd8-3n2a4-e3t24",
    "projects": [
      {
        "reference": {
          "id": "ac2d-47ca-a5d5",
          "name": "Hydralics",
          "version": "2.0.3"
        },
        "disabled": true,
        "disabledContent": [
          "79sd8-3n2a4-e3t24",
          "t24e3-a43n2-d879s"
        ]
      }
    ],
    "dependencies": [
      {
        "reference": {
          "id": "ac2d-47ca-a5d5",
          "name": "Hydralics",
          "version": "2.0.3"
        },
        "disabled": true,
        "disabledContent": [
          "79sd8-3n2a4-e3t24",
          "t24e3-a43n2-d879s"
        ]
      }
    ],
    "format": "1.0.0",
    "guid": "6d8ae8b3b0594125a0cb7acd6adbb0f9",
    "createdBy": "98dy-a82a-s8tg",
    "createdAt": 1549552749,
    "appMode": {
      "model": ""
    }
  },
  "backup": {
    "name": "My Workspace backup",
    "workspaceId": "my_workspace"
  },
  "sizeInfo": {
    "total": 7014
  }
}

Responses

200

Workspace ID and its meta-data.

Example

{
  "id": "my_workspace",
  "conversion": {
    "state": "UP_TO_DATE"
  },
  "definition": {
    "name": "My workspace",
    "description": "Workspace with all my projects",
    "defaultProjectId": "79sd8-3n2a4-e3t24",
    "projects": [
      {
        "reference": {
          "id": "ac2d-47ca-a5d5",
          "name": "Hydralics",
          "version": "2.0.3"
        },
        "disabled": true,
        "disabledContent": [
          "79sd8-3n2a4-e3t24",
          "t24e3-a43n2-d879s"
        ]
      }
    ],
    "dependencies": [
      {
        "reference": {
          "id": "ac2d-47ca-a5d5",
          "name": "Hydralics",
          "version": "2.0.3"
        },
        "disabled": true,
        "disabledContent": [
          "79sd8-3n2a4-e3t24",
          "t24e3-a43n2-d879s"
        ]
      }
    ],
    "format": "1.0.0",
    "guid": "6d8ae8b3b0594125a0cb7acd6adbb0f9",
    "createdBy": "98dy-a82a-s8tg",
    "createdAt": 1549552749,
    "appMode": {
      "model": ""
    }
  },
  "backup": {
    "name": "My Workspace backup",
    "workspaceId": "my_workspace"
  },
  "sizeInfo": {
    "total": 7014
  }
}

400

The request could not be processed. The request is most likely not correct.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

401

The request could not be performed because of missing authentication.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

402

The request could not be performed because the system is out of payed for floating seats.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

403

Action is not allowed. Permissions might be insufficient.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

409

The request could not be performed because there is a conflict.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

500

An internal server error.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

Parameters

Responses

200

OK: The workspace was deleted.

400

The request could not be processed. The request is most likely not correct.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

401

The request could not be performed because of missing authentication.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

402

The request could not be performed because the system is out of payed for floating seats.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

403

Action is not allowed. Permissions might be insufficient.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

409

The request could not be performed because there is a conflict.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

500

An internal server error.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

Parameters

Responses

200

List of conversions that would occur if the POST /workspace-conversions was called. Also lists potential issues with conversions. These issues can be ignore by giving the ID when starting the conversion process. Note that this can lead to the converted workspace missing some content.

Example

{
  "data": {
    "conversions": [
      {
        "from": "0.8",
        "to": "0.9",
        "issues": [
          {
            "id": "t24e3-sd879-2a43n",
            "message": "Symbolic link for library Hydralics 4.10 cannot be converted, you need to checkout svn.company.com/Project01 in the new structure",
            "details": {
              "type": "GIT_CHECKOUT_MISSING",
              "url": "gitlab.com/group/project",
              "branch": "main"
            }
          }
        ]
      }
    ],
    "backup": {
      "disk": {
        "free": 0,
        "required": 0
      }
    }
  }
}

400

The request could not be processed. The request is most likely not correct.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

401

The request could not be performed because of missing authentication.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

402

The request could not be performed because the system is out of payed for floating seats.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

403

Action is not allowed. Permissions might be insufficient.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

409

The request could not be performed because there is a conflict.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

500

An internal server error.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

Get workspace dependencies.

Parameters

Responses

200

OK: The workspace dependencies were returned.

Example

{
  "data": {
    "items": [
      {
        "id": "79sd8-3n2a4-e3t24",
        "definition": {
          "name": "MyProject",
          "version": "2.0.3-beta.3+build.5",
          "format": "1.0.0",
          "dependencies": [
            {
              "name": "Modelica",
              "versionSpecifier": "4.0.0"
            }
          ],
          "content": [
            {
              "relpath": "SomeLib.mo",
              "contentType": "MODELICA",
              "name": "SomeLib",
              "defaultDisabled": true,
              "id": "79sd8-3n2a4-e3t24"
            }
          ],
          "executionOptions": [
            {
              "customFunction": "steady state",
              "compiler": {
                "generate_html_diagnostics": true,
                "halt_on_warning": true
              },
              "runtime": {
                "use_Brent_in_1d": false
              },
              "simulation": {
                "ncp": 2000
              },
              "solver": {
                "rtol": 0.0001
              }
            }
          ],
          "icon": ".impact/icon.png"
        },
        "projectType": "LOCAL",
        "vcsUri": {
          "serviceKind": "GIT",
          "serviceUrl": "https://github.com",
          "repoUrl": {
            "url": "gitlab.com/group/project",
            "refname": "main",
            "sha1": "3486a89"
          },
          "protocol": "https",
          "subdir": "src"
        },
        "size": ""
      }
    ]
  }
}

400

The request could not be processed. The request is most likely not correct.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

401

The request could not be performed because of missing authentication.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

402

The request could not be performed because the system is out of payed for floating seats.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

403

Action is not allowed. Permissions might be insufficient.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

409

The request could not be performed because there is a conflict.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

500

An internal server error.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

Will initiate import of a project and add it as a dependency to the workspace. After a successful completion of a call to this endpoint, call GET /workspaces/{workspace}/dependency-imports/{importId} to check status.

Parameters

Request body

A mol or zip file given with multipart/form-data is used to import the project as dependency.

Example

{
  "file": "myProject.mol"
}

Responses

201

Dependency import created and location to check status of import is returned.

Example

{
  "data": {
    "location": "api/workspaces/MyWorkspace/dependency-imports/fd90-4gkl-vf89"
  }
}

401

The request could not be performed because of missing authentication.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

402

The request could not be performed because the system is out of payed for floating seats.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

403

Action is not allowed. Permissions might be insufficient.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

500

An internal server error.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

The project to be added as a dependency needs to be setup for import by calling POST /dependency-imports, before calling this API endpoint.

Parameters

Responses

200

Status for a project import and data to resource if import is done and the project is ready to be used.

Example

{
  "data": {
    "id": "79sd8-3n2a4-e3t24",
    "status": "",
    "data": {
      "resourceUri": "api/projects/u760-u095-gu45",
      "projectId": "u760-u095-gu45"
    },
    "error": {
      "message": "Could not import project, file must end with .mol or .zip.",
      "code": 12015
    }
  }
}

401

The request could not be performed because of missing authentication.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

402

The request could not be performed because the system is out of payed for floating seats.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

403

Action is not allowed. Permissions might be insufficient.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

404

The resource could not be found. Typically this means that a resource the request is referencing does not exists. Common resources are workspaces, libraries, model-executables and experiments.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

409

The request could not be performed because there is a conflict.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

500

An internal server error.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

This API end point can be be called after a project has been imported and added as a workspace depenendency.

Parameters

Responses

200

OK: The project import with the specified ID was deleted.

401

The request could not be performed because of missing authentication.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

402

The request could not be performed because the system is out of payed for floating seats.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

403

Action is not allowed. Permissions might be insufficient.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

404

The resource could not be found. Typically this means that a resource the request is referencing does not exists. Common resources are workspaces, libraries, model-executables and experiments.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

409

The request could not be performed because there is a conflict.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

500

An internal server error.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

Will initiate import of a project and add it to the workspace. After a successful completion of a call to this endpoint, call GET /workspaces/{workspace}/project-imports/{importId} to check status.

Parameters

Request body

A zip file given with multipart/form-data is used to import the editable project.

Example

{
  "file": "myProject.zip"
}

Responses

201

Project import created and location to check status of import is returned.

Example

{
  "data": {
    "location": "api/workspaces/MyWorkspace/project-imports/fd90-4gkl-vf89"
  }
}

401

The request could not be performed because of missing authentication.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

402

The request could not be performed because the system is out of payed for floating seats.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

403

Action is not allowed. Permissions might be insufficient.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

500

An internal server error.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

The editable project to be added to the workspace needs to be setup for import by calling POST /project-imports, before calling this API endpoint.

Parameters

Responses

200

Status for a project import and data to resource if import is done and the project is ready to be used.

Example

{
  "data": {
    "id": "79sd8-3n2a4-e3t24",
    "status": "",
    "data": {
      "resourceUri": "api/projects/u760-u095-gu45",
      "projectId": "u760-u095-gu45"
    },
    "error": {
      "message": "Could not import project, file must end with .mol or .zip.",
      "code": 12015
    }
  }
}

401

The request could not be performed because of missing authentication.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

402

The request could not be performed because the system is out of payed for floating seats.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

403

Action is not allowed. Permissions might be insufficient.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

404

The resource could not be found. Typically this means that a resource the request is referencing does not exists. Common resources are workspaces, libraries, model-executables and experiments.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

409

The request could not be performed because there is a conflict.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

500

An internal server error.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

This API end point can be be called after a project has been imported and added to the workspace.

Parameters

Responses

200

OK: The project import with the specified ID was deleted.

401

The request could not be performed because of missing authentication.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

402

The request could not be performed because the system is out of payed for floating seats.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

403

Action is not allowed. Permissions might be insufficient.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

404

The resource could not be found. Typically this means that a resource the request is referencing does not exists. Common resources are workspaces, libraries, model-executables and experiments.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

409

The request could not be performed because there is a conflict.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

500

An internal server error.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

Get workspace projects.

Parameters

Responses

200

OK: The workspace projects were returned.

Example

{
  "data": {
    "items": [
      {
        "id": "79sd8-3n2a4-e3t24",
        "definition": {
          "name": "MyProject",
          "version": "2.0.3-beta.3+build.5",
          "format": "1.0.0",
          "dependencies": [
            {
              "name": "Modelica",
              "versionSpecifier": "4.0.0"
            }
          ],
          "content": [
            {
              "relpath": "SomeLib.mo",
              "contentType": "MODELICA",
              "name": "SomeLib",
              "defaultDisabled": true,
              "id": "79sd8-3n2a4-e3t24"
            }
          ],
          "executionOptions": [
            {
              "customFunction": "steady state",
              "compiler": {
                "generate_html_diagnostics": true,
                "halt_on_warning": true
              },
              "runtime": {
                "use_Brent_in_1d": false
              },
              "simulation": {
                "ncp": 2000
              },
              "solver": {
                "rtol": 0.0001
              }
            }
          ],
          "icon": ".impact/icon.png"
        },
        "projectType": "LOCAL",
        "vcsUri": {
          "serviceKind": "GIT",
          "serviceUrl": "https://github.com",
          "repoUrl": {
            "url": "gitlab.com/group/project",
            "refname": "main",
            "sha1": "3486a89"
          },
          "protocol": "https",
          "subdir": "src"
        },
        "size": ""
      }
    ]
  }
}

400

The request could not be processed. The request is most likely not correct.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

401

The request could not be performed because of missing authentication.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

402

The request could not be performed because the system is out of payed for floating seats.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

403

Action is not allowed. Permissions might be insufficient.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

409

The request could not be performed because there is a conflict.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

500

An internal server error.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

Create an empty projects and adds it to workspace.

Parameters

Request body

Specification for the new content entry.

Example

{
  "new": {
    "name": "MyProject"
  }
}

Responses

200

Project is created, added to workspace. The created project is returned.

Example

{
  "id": "79sd8-3n2a4-e3t24",
  "definition": {
    "name": "MyProject",
    "version": "2.0.3-beta.3+build.5",
    "format": "1.0.0",
    "dependencies": [
      {
        "name": "Modelica",
        "versionSpecifier": "4.0.0"
      }
    ],
    "content": [
      {
        "relpath": "SomeLib.mo",
        "contentType": "MODELICA",
        "name": "SomeLib",
        "defaultDisabled": true,
        "id": "79sd8-3n2a4-e3t24"
      }
    ],
    "executionOptions": [
      {
        "customFunction": "steady state",
        "compiler": {
          "generate_html_diagnostics": true,
          "halt_on_warning": true
        },
        "runtime": {
          "use_Brent_in_1d": false
        },
        "simulation": {
          "ncp": 2000
        },
        "solver": {
          "rtol": 0.0001
        }
      }
    ],
    "icon": ".impact/icon.png"
  },
  "projectType": "LOCAL",
  "vcsUri": {
    "serviceKind": "GIT",
    "serviceUrl": "https://github.com",
    "repoUrl": {
      "url": "gitlab.com/group/project",
      "refname": "main",
      "sha1": "3486a89"
    },
    "protocol": "https",
    "subdir": "src"
  },
  "size": ""
}

400

The request could not be processed. The request is most likely not correct.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

401

The request could not be performed because of missing authentication.

Example

{
  "error": {
    "message": "There was an error X because of Y",
    "code": 12012
  }
}

402