Get Workloads

GET

/api/v2/workloads

Get list of workloads matching a set of optional filters.

Args: user: the data of the user requesting the workloads ordering_params: ordering params for the list results paginated_params: pagination params for the list results filter_params: the filter params for the list results

Returns: The requested workloads

Parameters

Query Parameters

order_by

Order By

string

default: created_at

order_by_direction

string

Allowed values: ASC DESC

limit

Limit

integer

default: 100 > 0 < 101

offset

Offset

integer

id

Id

Unique id for the workload

Array<string>

default:

Unique id for the workload

id__starts_with

Id Starts With

First characters of the workload id

string

""

First characters of the workload id

project_id

Project Id

Owner project of the workload

Array<string>

default:

Owner project of the workload

status

Job status type enum

Array<string>

default:

Allowed values: PENDING RUNNING DONE ERROR CANCELED

Job status type enum

start_date

Start Date

Time when the emulator or QPU indicated workload was started

string format: date-time

""

Time when the emulator or QPU indicated workload was started

end_date

End Date

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

string format: date-time

""

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

Responses

200

Successful Response

HeaderPaginatedResponse[ProducedMultipleWorkloadResponse]

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

Message

string

default: OK.

code

Code

string

default: 200

data

required

Data

Array<object>

ProducedMultipleWorkloadResponse

Response to a request for workloads to display on a page.

object

id

required

Id

string format: uuid

start_timestamp

Start Timestamp

string format: date-time

end_timestamp

End Timestamp

string format: date-time

created_at

required

Created At

string format: date-time

updated_at

Updated At

string format: date-time

workload_type

required

Workload Type

string

backend

required

Backend

string

status

required

Status

string

config

Config

object

errors

Errors

Array<string>

project_id

required

Project Id

string format: uuid

user_id

required

User Id

string

queue_priority

required

QueuePriority

Values represent the queue a value will be written to, each priority represents the order of preference batches will be executed. Queue priority is processed in a descending order: CRITICAL, HIGH, MEDIUM, LOW, FREE

string

Allowed values: CRITICAL HIGH MEDIUM LOW FREE

pagination

required

JSendPagination

Pagination information

object

total

required

Total

integer

start

required

Start

integer

end

required

End

integer

422

Validation Error

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string