Search documentation
karat

+

K

User Documentation ↗
Version 2.0

Get By Path Resources Batch

POST/api/v2/filesystem/resources/getByPathBatch
Warning

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.

Gets multiple Resources by their absolute paths. Returns a list of resources. If a path does not exist, is inaccessible, or refers to a root folder or space, it will not be included in the response. At most 1,000 paths should be requested at once.

The maximum batch size for this endpoint is 1000.

Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:filesystem-read.

Query parameters

preview
boolean
optional

Enables the use of preview functionality.

Request body

body
list<GetByPathResourcesBatchRequestElement>
Hide child attributes

Hide child attributes

GetByPathResourcesBatchRequestElement
object
Show child attributes

Show child attributes

Response body

GetByPathResourcesBatchResponse
object
Hide child attributes

Hide child attributes

data
list<Resource>
optional
Show child attributes

Show child attributes

Examples

Request

Copied!
1 2 3 4 5 curl -X POST \ \t-H "Content-type: application/json" \ \t-H "Authorization: Bearer $TOKEN" \ "https://$HOSTNAME/api/v2/filesystem/resources/getByPathBatch?preview=true" \ -d '[{"path":"/My Organization-abcd/My Important Project/My Dataset"}]'

Response

Copied!
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 { "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" } ] }