Skip to content
Pasqal Documentation

Get Jobs

GET
/api/v2/jobs

Retrieve jobs. Args: AuthenticatedComputeUser: The authentication dependency, ensuring the user is authenticated and has the necessary permissions User: Logged user information. Ordering_params: The ordering parameters Paginated_params: The pagination parameters Filter_params: The filter parameters Returns: PaginatedResponse[ProducedPartialJobResponse]: A paginated response containing the list of the requested jobs, excluding the job result attribute

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 job

Array<string>
default:

Unique id for the job

id__starts_with

First characters of the job id

string
""

First characters of the job id

batch_id

Owner batch of the job

Array<string>
default:

Owner batch of the job

project_id

Owner project of the job

Array<string>
default:

Owner project of the job

user_id

Owner user of the job

Array<string>
default:

Owner user of the job

status

Job status type enum

Array<string>
default:
Allowed values: PENDING RUNNING DONE ERROR CANCELED

Job status type enum

min_runs

Minimum number of times the pulser sequence is repeated

integer
""

Minimum number of times the pulser sequence is repeated

max_runs

Maximum number of times the pulser sequence is repeated

integer
""

Maximum number of times the pulser sequence is repeated

errors

Whether errors werer returned when executing the job

boolean
""

Whether errors werer returned when executing the job

origin

Origin of the job

Array<string>
default:
Allowed values: CLIENT AZURE UNKNOWN

Origin of the job

start_date

Time when the emulator or QPU indicated a job was started

string format: date-time
""

Time when the emulator or QPU indicated a job was started

end_date

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

string format: date-time
""

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

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 to a request for a job.

This schema defines all the fields that can be publicly shared by the API and do not require significant computational resources. For example, ‘logs_links’ or ‘results link’.

object
id
required
string format: uuid
parent_id
string format: uuid
status
required

An enumeration.

string
Allowed values: PENDING RUNNING DONE ERROR CANCELED
runs
required
integer
batch_id
required
string format: uuid
project_id
required
string format: uuid
created_at
required
string format: date-time
updated_at
required
string format: date-time
start_timestamp
string format: date-time
end_timestamp
string format: date-time
variables
object
errors
Array<string>
progress
integer
<= 100
sequence
string
creation_order
required
integer
slurm_job_id
string
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