Skip to main content
GET
List run results

Authorizations

x-api-key
string
header
required

Bulkgrid API key

Path Parameters

runId
string
required

Query Parameters

incremental
enum<string>

Return only missing or dirty rows, plus ordered page IDs.

Available options:
true
known
string<uuid>[]

Row IDs already held by the client.

Maximum array length: 100
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
dirty
string<uuid>[]

Row IDs requiring fresh data.

Maximum array length: 100
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
page
integer
Required range: 0 < x <= 9007199254740991
limit
integer
Required range: 0 < x <= 9007199254740991

Response

Successful response

results
object[]
required
page
integer
required
Required range: 0 < x <= 9007199254740991
limit
integer
required
Required range: 0 < x <= 9007199254740991
total
integer
required
Required range: 0 <= x <= 9007199254740991
ids
string<uuid>[]

Ordered IDs of the complete page, present in incremental responses.

Maximum array length: 100
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
statistics
object