Skip to content
Pasqal Documentation

Cancel Batches

PATCH
/api/v1/batches/cancel

Cancel a group of batches.

Request Body required

ConsumedBatchBulkCancelRequest

Request to cancel a bunch of batch based on their IDs

object
batch_ids
required
Batch Ids
Array<string>

Responses

200

Successful Response

NonPaginatedResponse[ProducedBatchBulkCancelResponse]

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
ProducedBatchBulkCancelResponse

Response to a request for cancelling a bunch of batches.

object
batches
required
Batches
Array<object>
ProducedBatchWithoutJobsResponse

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
Id
string format: uuid
parent_id
Parent Id
string format: uuid
status
required
BatchStatus

An enumeration.

string
Allowed values: PENDING RUNNING DONE CANCELED TIMED_OUT ERROR PAUSED
complete
required
Complete
boolean
open
required
Open
boolean
priority
required
Priority
integer
device_type
required
Device Type
string
user_id
required
User Id
string
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
sequence_builder
required
Sequence Builder
string
jobs_count
required
Jobs Count
integer
jobs_count_per_status
required
Jobs Count Per Status
object
tags
required
Tags
Array<string>
configuration
Configuration
object
webhook
Webhook
string
start_datetime
Start Datetime
string format: date-time
end_datetime
End Datetime
string format: date-time
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
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