Skip to content
Pasqal Documentation

Cancel Workload

PUT
/api/v1/workloads/{workload_id}/cancel

Cancel workload by workload_id.

Args: workload (GetWorkloadByIdAndPerformAccessCheck): A dependency that fetches a workload based on the provided workload_id, contingent upon the validation of the specified access_check. Returns: The requested workload.

Raises: WorkloadNotFound(Http status code 404) if workload_id not found or the user is not member of the workload’s project. WorkloadWriteAccessRequired(http status code 403) if the the user if not the owner the workload. WorkloadCancelInvalidStatus: The workload cannot be cancelled.

Parameters

Path Parameters

workload_id
required
Workload Id
string format: uuid

Responses

200

Successful Response

NonPaginatedResponse[ProducedWorkloadResponse]

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
ProducedWorkloadResponse

Response schema for a workload with embedded results as dict.

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
JobStatus

An enumeration.

string
Allowed values: PENDING RUNNING DONE ERROR CANCELED
config
required
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
result
Result
object

422

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string