API Reference

Get Builds Batch

POST/api/v2/orchestration/builds/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.

Execute multiple get requests on Build.

The maximum batch size for this endpoint is 100.

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

Query parameters

preview

boolean

optional

Enables the use of preview functionality.

Request body

body

list<GetBuildsBatchRequestElement>

Hide child attributes

GetBuildsBatchRequestElement

object

Show child attributes

Response body

GetBuildsBatchResponse

object

Hide child attributes

data

map<BuildRid, Build>

optional

Show child attributes

Examples

Request

Copied!

curl -X POST \
	-H "Content-type: application/json" \
	-H "Authorization: Bearer $TOKEN" \
	"https://$HOSTNAME/api/v2/orchestration/builds/getBatch?preview=true" \
	-d '[{"buildRid":"ri.foundry.main.build.a4386b7e-d546-49be-8a36-eefc355f5c58"}]'