SIsimscale
Folders

List Projects in Folder

Changed on

List projects located in a Folder. Filtering or search capabilities are not supported. This only returns the projects of the queried folder, without a recursive expansion to child folders.

get/spaces/{spaceId}/folders/{folderId}/content/projects

Request

  • Base URL
    https://api.simscale.com/v1
  • URL
    https://api.simscale.com/v1/spaces/{spaceId}/folders/{folderId}/content/projects
  • Auth
    API key in header X-API-KEY

Path parameters

spaceIdstring uuid required

The space ID

folderIdstring uuid required

The folder ID

Query parameters

limitinteger

The number of items to return.

pageinteger

The page number. Use in combination with limit.

sortstring

A field to sort by. The available fields are: 'name', 'createdAt' and 'lastModifiedAt'. To indicate sorting direction, the field must be prefixed with '+' (ascending) or '-' (descending), e.g. ?sort=+name

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

OK

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