Get All Batches

GET

/api/v1/batches

Parameters

Query Parameters

order_by

string

default: created_at

order_by_direction

string

Allowed values: ASC DESC

limit

integer

default: 100 > 0 < 101

offset

integer

id

Unique id for the batch

Array<string>

default:

Unique id for the batch

id__starts_with

First characters of the batch id

string

""

First characters of the batch id

project_id

Owner project of the batch

Array<string>

default:

Owner project of the batch

user_id

Owner user of the batch

Array<string>

default:

Owner user of the batch

device_type

Device type enum

Array<string>

default:

Device type enum

status

Batch status type enum

Array<string>

default:

Allowed values: PENDING RUNNING DONE CANCELED TIMED_OUT ERROR PAUSED

Batch status type enum

complete

Flag indicating whether the batch is waiting for extra jobs to be pushed

boolean

""

Flag indicating whether the batch is waiting for extra jobs to be pushed

open

Flag indicating whether the batch is waiting for extra jobs to be pushed

boolean

""

Flag indicating whether the batch is waiting for extra jobs to be pushed

min_jobs

Minimum number of jobs in the batch

integer

""

Minimum number of jobs in the batch

max_jobs

Maximum number of jobs in the batch

integer

""

Maximum number of jobs in the batch

start_date

Time when the emulator or QPU indicated a batch was started

string format: date-time

""

Time when the emulator or QPU indicated a batch was started

end_date

Time when the emulator or QPU indicated a batch finished, failed or was cancelled

string format: date-time

""

Time when the emulator or QPU indicated a batch finished, failed or was cancelled

queue_priority

Priority of the batch in the queue.

Array<string>

default:

Allowed values: LOW MEDIUM HIGH

Priority of the batch in the queue.

Responses

200

Successful Response

A list of responses with pagination information.

For backwards compatibility, this also exposes pagination using the following header format:

Access-Control-Expose-Headers: Content-Range
Content-Range: $FIRST_ITEM_IN_BATCH-$LAST_ITEM_IN_BACH/$TOTAL_ITEMS_AVAILABLE

object

status

string

Allowed values: success fail error

message

string

default: OK.

code

string

default: 200

data

required

Array<object>

Response for a batch request which does not include its jobs data.

This schema defines all the fields that can be publicly shared by the API.

object

id

required

string format: uuid

parent_id

string format: uuid

status

required

An enumeration.

string

Allowed values: PENDING RUNNING DONE CANCELED TIMED_OUT ERROR PAUSED

complete

required

boolean

open

required

boolean

priority

required

integer

device_type

required

string

user_id

required

string

project_id

required

string format: uuid

created_at

required

string format: date-time

updated_at

required

string format: date-time

jobs_count

required

integer

jobs_count_per_status

required

object

tags

required

Array<string>

configuration

object

webhook

string

start_datetime

string format: date-time

end_datetime

string format: date-time

queue_priority

required

Values represent the queue a value will be written to, each priority represents the order of preference batches will be executed.

HIGH being the quickers MEDIUM being a lower tier LOW being the lowest tier

string

Allowed values: LOW MEDIUM HIGH

pagination

required

Pagination information

object

total

required

integer

start

required

integer

end

required

integer

422

Validation Error

object

detail

Array<object>

object

loc

required

Array

msg

required

string

type

required

string