Skip to content
Pasqal Documentation

Cancel Batches

PATCH
/api/v1/batches/cancel

Cancel a group of batches.

Request Body required

Request to cancel a bunch of batch based on their IDs

object
batch_ids
required
Array<string>

Responses

200

Successful Response

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

Response to a request for cancelling a bunch of batches.

object
batches
required
Array<object>

Response for a batch request that not includes its jobs.

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
sequence_builder
required
string
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
errors
required
object
key
additional properties
string

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string