Search documentation
karat

+

K

User Documentation ↗
Version 2.0

Get Resources Batch

POST/api/v2/filesystem/resources/getBatch
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.

Fetches multiple resources in a single request. Returns a map from RID to the corresponding resource. If a resource does not exist, or if it is a root folder or space, its RID will not be included in the map. At most 1,000 resources 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<GetResourcesBatchRequestElement>
Hide child attributes

Hide child attributes

GetResourcesBatchRequestElement
object
Show child attributes

Show child attributes

Response body

GetResourcesBatchResponse
object
Hide child attributes

Hide child attributes

data
map<ResourceRid, 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/getBatch?preview=true" \ -d '[{"resourceRid":"ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da"}]'