SIsimscale
Projects

List projects

Changed on
get/projects

Request

  • Base URL
    https://api.simscale.com/v1
  • URL
    https://api.simscale.com/v1/projects
  • Auth
    API key in header X-API-KEY

Query parameters

limitinteger

The number of items to return.

pageinteger

The page number. Use in combination with limit.

projectTypestring

The type of the projects to return. The possible values are 'SIMULATION' and 'PHYSICS_AI'. Only projects of that type are returned, 'SIMULATION' when the parameter is omitted.

Response

Successful operation

Example response

{
  "_links": {
    "first": {
      "href": "/projects?page={firstPage}&limit={limit}"
    },
    "prev": {
      "href": "/projects?page={previousPage}&limit={limit}"
    },
    "self": {
      "href": "/projects?page={currentPage}&limit={limit}"
    },
    "next": {
      "href": "/projects?page={nextPage}&limit={limit}"
    },
    "last": {
      "href": "/projects?page={lastPage}&limit={limit}"
    }
  },
  "_embedded": [
    {
      "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",
      "visibility": "PUBLIC",
      "ownerUserId": "123456",
      "tags": [
        "FEA",
        "CFD"
      ]
    }
  ]
}

Changes