latestOpenAPI 3.0.32026-08-201592,4923.4 MB

53223abaceb7

Projects

Get information about an existing project

get/projects/{projectId}

Response

Successful operation

projectIdstring

spaceIdstring uuid

Always returned by the backend. Optional at project creation. If missing, the project will be created in the Personal Space of the user.

parentFolderIdstring uuid

If missing, the project is located at the root level of the Space.

createdAtstring date-time

namestring required

The project title should contain the application you want to analyze as well as the simulation method you want to use, e.g. 'Heat exchanger - CHT simulation'.

descriptionstring

A meaningful description of the project.

measurementSystem'SI' | 'US_CUSTOMARY' required

The measurement system of the project. Can't be modified.

tagsstring[]

Example response

{
  "projectId": "1234123412341234",
  "spaceId": "49eb49eb-49eb-49eb-49eb-49eb49eb49eb",
  "parentFolderId": "4e9c4e9c-4e9c-4e9c-4e9c-4e9c4e9c4e9c",
  "createdAt": "2020-01-01T01:00:00Z",
  "name": "My first project",
  "description": "My first project description",
  "measurementSystem": "SI",
  "tags": [
    "FEA",
    "CFD"
  ]
}