Cancel Jobs

PATCH

/api/v2/batches/{batch__id}/cancel/jobs

Parameters

Path Parameters

batch__id

required

Batch Id

string format: uuid

Query Parameters

id

Id

Unique id for the job

Array<string>

default:

Unique id for the job

id__starts_with

Id Starts With

First characters of the job id

string

""

First characters of the job id

batch_id

Batch Id

Owner batch of the job

Array<string>

default:

Owner batch of the job

project_id

Project Id

Owner project of the job

Array<string>

default:

Owner project of the job

user_id

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

Min Runs

Minimum number of times the pulser sequence is repeated

integer

""

Minimum number of times the pulser sequence is repeated

max_runs

Max Runs

Maximum number of times the pulser sequence is repeated

integer

""

Maximum number of times the pulser sequence is repeated

errors

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

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

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

NonPaginatedResponse[ProducedPartialJobBulkCancelResponse]

Represents a response with either a list of items or a single item in a single page.

Generic Parameters: - A (TypeVar): The type bound to this class, which can be a single BaseModel, a list of BaseModels, or None.

Usage: - To respond with an unpaginated list of FooResponse items from an API endpoint, ensure that your function returns NonPaginatedResponse[List[FooResponse]].

- To respond with a single `FooResponse` item from an API endpoint,
  make sure that your function returns `NonPaginatedResponse[FooResponse]`
  and that Python recognizes it.

object

data

ProducedPartialJobBulkCancelResponse

Response to a request for cancelling a bunch of jobs without the results of the jobs.

object

jobs

required

Jobs

Array<object>

ProducedPartialJobResponse

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

Id

string format: uuid

parent_id

Parent Id

string format: uuid

status

required

JobStatus

An enumeration.

string

Allowed values: PENDING RUNNING DONE ERROR CANCELED

runs

required

Runs

integer

batch_id

required

Batch Id

string format: uuid

project_id

required

Project Id

string format: uuid

created_at

required

Created At

string format: date-time

updated_at

required

Updated At

string format: date-time

start_timestamp

Start Timestamp

string format: date-time

end_timestamp

End Timestamp

string format: date-time

variables

Variables

object

errors

Errors

Array<string>

progress

Progress

integer

<= 100

sequence

Sequence

string

creation_order

required

Creation Order

integer

slurm_job_id

Slurm Job Id

string

errors

required

Errors

object

key

additional properties

string

422

Validation Error

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string