This endpoint is in preview and may be modified or removed at any time.
To use this endpoint, add preview=true to the request query parameters.
Get the Project with the specified rid.
Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:filesystem-read.
objectstringThe unique resource identifier (RID) of a Project.
stringThe display name of the Project. Must be unique and cannot contain a /
stringThe description associated with the Project.
stringThe documentation associated with the Project.
stringThe full path to the resource, including the resource name itself
stringThe Foundry user who created this resource
stringThe Foundry user who last updated this resource
stringThe time at which the resource was created.
stringThe time at which the resource was most recently updated.
string (enum)The trash status of the Project.
Enum values: DIRECTLY_TRASHED, ANCESTOR_TRASHED, NOT_TRASHED
stringThe Space Resource Identifier (RID) that the Project lives in.
1
2
3
curl \
-H "Authorization: Bearer $TOKEN" \
"https://$HOSTNAME/api/v2/filesystem/projects/ri.compass.main.folder.01a79a9d-e293-48db-a585-9ffe221536e8?preview=true"1
2
3
4
5
6
7
8
9
10
11
12
13
{
"path": "/Empyrean Airlines/My Important Project",
"updatedTime": "2024-09-25T17:29:35.974Z",
"updatedBy": "f05f8da4-b84c-4fca-9c77-8af0b13d11de",
"createdBy": "f05f8da4-b84c-4fca-9c77-8af0b13d11de",
"displayName": "My Important Project",
"documentation": "project documentation",
"description": "project description",
"createdTime": "2024-09-25T17:29:35.974Z",
"rid": "ri.compass.main.folder.01a79a9d-e293-48db-a585-9ffe221536e8",
"spaceRid": "ri.compass.main.folder.a86ad5f5-3db5-48e4-9fdd-00aa3e5731ca",
"trashStatus": "NOT_TRASHED"
}| Error Name | ||
|---|---|---|
Project | Error Code | NOT_FOUND |
| Status Code | 404 | |
| Description | The given Project could not be found. | |
| Parameters | projectRid | |
See Errors for a general overview of errors in the platform.