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.
List all child Resources of the Folder.
This is a paged endpoint. The page size will be limited to 2,000 results per page. If no page size is provided, this page size will also be used as the default.
integerThe page size to use for the endpoint.
stringThe page token indicates where to start paging. This should be omitted from the first page's request.
To fetch the next page, clients should take the value from the nextPageToken field of the previous response
and use it to populate the pageToken field of the next request.
booleanEnables the use of preview functionality.
objectlist<Resource>objectstringThe unique resource identifier (RID) of a Resource.
stringThe display name of the Resource
stringThe description of the Resource
stringThe documentation associated with the Resource
stringThe full path to the resource, including the resource name itself
string (enum)The type of the Resource derived from the Resource Identifier (RID).
Enum values: ARTIFACTS_REPOSITORY, BELLASO_CIPHER_CHANNEL, BLOBSTER_DOCUMENT, BLOBSTER_IMAGE, CARBON_WORKSPACE, COMPASS_FOLDER, COMPASS_WEB_LINK, CONTOUR_ANALYSIS, DATA_HEALTH_MONITORING_VIEW, EDDIE_LOGIC, EDDIE_PIPELINE, FFORMS_FORM, FOUNDRY_DATASET, FOUNDRY_ACADEMY_TUTORIAL, FOUNDRY_CONTAINER_SERVICE_CONTAINER, FOUNDRY_ML_OBJECTIVE, FOUNDRY_TEMPLATES_TEMPLATE, FUSION_DOCUMENT, HUBBLE_EXPLORATION_LAYOUT, MACHINERY_DOCUMENT, MAGRITTE_AGENT, MAGRITTE_SOURCE, MARKETPLACE_BLOCK_SET_INSTALLATION, MARKETPLACE_LOCAL, MARKETPLACE_REMOTE_STORE, MIO_MEDIA_SET, MODELS_MODEL, MODELS_MODEL_VERSION, MONOCLE_GRAPH, NOTEPAD_NOTEPAD, NOTEPAD_NOTEPAD_TEMPLATE, OBJECT_SENTINEL_MONITOR, OBJECT_SET_VERSIONED_OBJECT_SET, OPUS_GRAPH, OPUS_MAP, OPUS_MAP_LAYER, QUIVER_ANALYSIS, REPORT_REPORT, SLATE_DOCUMENT, SOLUTION_DESIGN_DIAGRAM, STEMMA_REPOSITORY, TABLES_TABLE, TAURUS_WORKFLOW, THIRD_PARTY_APPLICATIONS_APPLICATION, VECTOR_WORKBOOK, WORKSHOP_MODULE
stringThe user that created the Resource.
stringThe user that last updated the Resource.
stringThe timestamp that the Resource was last created.
stringThe timestamp that the Resource was last modified. For folders, this includes any of its descendants. For top level folders (spaces and projects), this is not updated by child updates for performance reasons.
string (enum)The trash status of the Resource. If trashed, this could either be because the Resource itself has been trashed or because one of its ancestors has been trashed.
Enum values: DIRECTLY_TRASHED, ANCESTOR_TRASHED, NOT_TRASHED
stringThe parent folder Resource Identifier (RID). For projects, this will be the Space RID.
stringThe Project Resource Identifier (RID) that the Resource lives in. If the Resource itself is a Project, this value will still be populated with the Project RID.
stringThe Space Resource Identifier (RID) that the Resource lives in.
stringThe page token indicates where to start paging. This should be omitted from the first page's request.
To fetch the next page, clients should take the value from the nextPageToken field of the previous response
and use it to populate the pageToken field of the next request.
1
2
3
curl \
-H "Authorization: Bearer $TOKEN" \
"https://$HOSTNAME/api/v2/filesystem/folders/ri.compass.main.folder.01a79a9d-e293-48db-a585-9ffe221536e8/children?pageSize=100&pageToken=v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z&preview=true"1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
{
"data": [
{
"projectRid": "ri.compass.main.folder.4cae7c13-b59f-48f6-9ef2-dbde603e4e33",
"updatedTime": "2024-09-25T17:29:35.974Z",
"updatedBy": "f05f8da4-b84c-4fca-9c77-8af0b13d11de",
"displayName": "My Dataset",
"description": "This dataset contains important data about Empyrean Airlines",
"rid": "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da",
"type": "FOUNDRY_DATASET",
"spaceRid": "ri.compass.main.folder.a86ad5f5-3db5-48e4-9fdd-00aa3e5731ca",
"trashStatus": "NOT_TRASHED",
"parentFolderRid": "ri.compass.main.folder.4cae7c13-b59f-48f6-9ef2-dbde603e4e33",
"path": "/Empyrean Airlines/My Important Project/My Dataset",
"createdBy": "f05f8da4-b84c-4fca-9c77-8af0b13d11de",
"createdTime": "2024-09-25T17:29:35.974Z"
}
],
"nextPageToken": "v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z"
}