public_apis.core_fast.main (0.1.0)
Download OpenAPI specification:Download
Get Last Activity Date
Retrieve last_activity_date by projects.
Args: AuthenticatedComputeSuperuser: The authentication dependency, ensuring the user is authenticated and has the necessary permissions.
project_id: Project ID as parameter query. Supports multiple IDs with
&. (/batches/last_activity?project_id=id1&project_id=id2)
Returns: A non-paginated response containing latest activity date by projects.
query Parameters
project_id | Array of strings <uuid> (Project Id) [ items <uuid > ] |
Responses
Response samples
- 200
- 422
{- "data": [
- {
- "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
- "last_activity_date": "2019-08-24T14:15:22Z"
}
]
}
Get All Batches
query Parameters
order_by | string (Order By) Default: "created_at" |
order_by_direction | string (SortDirection) Default: "DESC" Enum: "ASC" "DESC" An enumeration. |
limit | integer (Limit) ( 0 .. 101 ) Default: 100 |
offset | integer (Offset) Default: 0 |
id | Array of strings <uuid> (Id) [ items <uuid > ] Default: "" Unique id for the batch |
id__starts_with | string (Id Starts With) Default: "" First characters of the batch id |
project_id | Array of strings <uuid> (Project Id) [ items <uuid > ] Default: "" Owner project of the batch |
user_id | Array of strings (User Id) Default: "" Owner user of the batch |
device_type | Array of strings (Device Type) Default: "" Device type enum |
status | Array of strings (BatchStatus) Default: "" Items Enum: "PENDING" "RUNNING" "DONE" "CANCELED" "TIMED_OUT" "ERROR" "PAUSED" Batch status type enum |
complete | boolean (Complete) Default: "" Flag indicating whether the batch is waiting for extra jobs to be pushed |
open | boolean (Open) Default: "" Flag indicating whether the batch is waiting for extra jobs to be pushed |
min_jobs | integer (Min Jobs) Default: "" Minimum number of jobs in the batch |
max_jobs | integer (Max Jobs) Default: "" Maximum number of jobs in the batch |
start_date | string <date-time> (Start Date) Default: "" Time when the emulator or QPU indicated a batch was started |
end_date | string <date-time> (End Date) Default: "" Time when the emulator or QPU indicated a batch finished, failed or was cancelled |
queue_priority | Array of strings (QueuePriority) Default: "" Items Enum: "LOW" "MEDIUM" "HIGH" Priority of the batch in the queue. |
Responses
Response samples
- 200
- 422
{- "status": "success",
- "message": "OK.",
- "code": "200",
- "data": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef",
- "status": "PENDING",
- "complete": true,
- "open": true,
- "priority": 0,
- "device_type": "string",
- "user_id": "string",
- "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "jobs_count": 0,
- "jobs_count_per_status": { },
- "tags": [
- "string"
], - "configuration": { },
- "webhook": "string",
- "start_datetime": "2019-08-24T14:15:22Z",
- "end_datetime": "2019-08-24T14:15:22Z",
- "queue_priority": "LOW"
}
], - "pagination": {
- "total": 0,
- "start": 0,
- "end": 0
}
}
Create Batch
Request Body schema: application/jsonrequired
configuration | any (Configuration) |
priority | number (Priority) |
project_id required | string <uuid> (Project Id) |
emulator | string (DeviceTypeName) Enum: "EMU_FREE" "EMU_SV" "EMU_TN" "EMU_C" "FRESNEL" "EMU_FRESNEL" Enumeration of allowed and legacy device type names |
sequence_builder required | string (Sequence Builder) |
tags | Array of strings (Tags) unique |
complete | boolean (Complete) |
open | boolean (Open) |
Array of objects (Jobs) Default: [] |
Responses
Request samples
- Payload
{- "configuration": null,
- "priority": 0,
- "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
- "emulator": "EMU_FREE",
- "sequence_builder": "string",
- "tags": [
- "string"
], - "complete": true,
- "open": true,
- "jobs": [ ]
}
Response samples
- 200
- 422
{- "data": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef",
- "status": "PENDING",
- "complete": true,
- "open": true,
- "priority": 0,
- "device_type": "string",
- "user_id": "string",
- "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "sequence_builder": "string",
- "jobs_count": 0,
- "jobs_count_per_status": { },
- "tags": [
- "string"
], - "configuration": { },
- "webhook": "string",
- "start_datetime": "2019-08-24T14:15:22Z",
- "end_datetime": "2019-08-24T14:15:22Z",
- "jobs": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef",
- "status": "PENDING",
- "runs": 0,
- "batch_id": "4da22c97-b7d5-4e31-8c3a-03870ebc7b20",
- "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "start_timestamp": "2019-08-24T14:15:22Z",
- "end_timestamp": "2019-08-24T14:15:22Z",
- "variables": { },
- "errors": [
- "string"
], - "progress": 100,
- "sequence": "string",
- "creation_order": 0
}
], - "queue_priority": "LOW"
}
}
Response samples
- 200
- 422
{- "data": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef",
- "status": "PENDING",
- "complete": true,
- "open": true,
- "priority": 0,
- "device_type": "string",
- "user_id": "string",
- "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "sequence_builder": "string",
- "jobs_count": 0,
- "jobs_count_per_status": { },
- "tags": [
- "string"
], - "configuration": { },
- "webhook": "string",
- "start_datetime": "2019-08-24T14:15:22Z",
- "end_datetime": "2019-08-24T14:15:22Z",
- "jobs": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef",
- "status": "PENDING",
- "runs": 0,
- "batch_id": "4da22c97-b7d5-4e31-8c3a-03870ebc7b20",
- "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "start_timestamp": "2019-08-24T14:15:22Z",
- "end_timestamp": "2019-08-24T14:15:22Z",
- "variables": { },
- "result": { },
- "full_result": { },
- "errors": [
- "string"
], - "progress": 100,
- "sequence": "string",
- "creation_order": 0
}
], - "child_ids": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
}
Set Batch Status
path Parameters
batch_id required | string <uuid> (Batch Id) |
Request Body schema: application/jsonrequired
status | string (BatchStatus) Enum: "PENDING" "RUNNING" "DONE" "CANCELED" "TIMED_OUT" "ERROR" "PAUSED" An enumeration. |
device_id | string <uuid> (Device Id) |
start_datetime | string <date-time> (Start Datetime) |
end_datetime | string <date-time> (End Datetime) |
Responses
Request samples
- Payload
{- "status": "PENDING",
- "device_id": "3bafab7b-4400-4bcf-8e6e-09f954699940",
- "start_datetime": "2019-08-24T14:15:22Z",
- "end_datetime": "2019-08-24T14:15:22Z"
}
Response samples
- 200
- 422
{- "data": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef",
- "status": "PENDING",
- "complete": true,
- "open": true,
- "priority": 0,
- "device_type": "string",
- "user_id": "string",
- "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "sequence_builder": "string",
- "jobs_count": 0,
- "jobs_count_per_status": { },
- "tags": [
- "string"
], - "configuration": { },
- "webhook": "string",
- "start_datetime": "2019-08-24T14:15:22Z",
- "end_datetime": "2019-08-24T14:15:22Z",
- "queue_priority": "LOW"
}
}
Response samples
- 200
- 422
{- "data": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef",
- "status": "PENDING",
- "complete": true,
- "open": true,
- "priority": 0,
- "device_type": "string",
- "user_id": "string",
- "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "sequence_builder": "string",
- "jobs_count": 0,
- "jobs_count_per_status": { },
- "tags": [
- "string"
], - "configuration": { },
- "webhook": "string",
- "start_datetime": "2019-08-24T14:15:22Z",
- "end_datetime": "2019-08-24T14:15:22Z",
- "jobs": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef",
- "status": "PENDING",
- "runs": 0,
- "batch_id": "4da22c97-b7d5-4e31-8c3a-03870ebc7b20",
- "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "start_timestamp": "2019-08-24T14:15:22Z",
- "end_timestamp": "2019-08-24T14:15:22Z",
- "variables": { },
- "result": { },
- "full_result": { },
- "errors": [
- "string"
], - "progress": 100,
- "sequence": "string",
- "creation_order": 0
}
], - "queue_priority": "LOW"
}
}
Cancel Batches
Cancel a group of batches.
Request Body schema: application/jsonrequired
batch_ids required | Array of strings <uuid> (Batch Ids) [ items <uuid > ] |
Responses
Request samples
- Payload
{- "batch_ids": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
Response samples
- 200
- 422
{- "data": {
- "batches": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef",
- "status": "PENDING",
- "complete": true,
- "open": true,
- "priority": 0,
- "device_type": "string",
- "user_id": "string",
- "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "sequence_builder": "string",
- "jobs_count": 0,
- "jobs_count_per_status": { },
- "tags": [
- "string"
], - "configuration": { },
- "webhook": "string",
- "start_datetime": "2019-08-24T14:15:22Z",
- "end_datetime": "2019-08-24T14:15:22Z",
- "queue_priority": "LOW"
}
], - "errors": {
- "property1": "string",
- "property2": "string"
}
}
}
Response samples
- 200
- 422
{- "data": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef",
- "status": "PENDING",
- "complete": true,
- "open": true,
- "priority": 0,
- "device_type": "string",
- "user_id": "string",
- "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "sequence_builder": "string",
- "jobs_count": 0,
- "jobs_count_per_status": { },
- "tags": [
- "string"
], - "configuration": { },
- "webhook": "string",
- "start_datetime": "2019-08-24T14:15:22Z",
- "end_datetime": "2019-08-24T14:15:22Z",
- "jobs": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef",
- "status": "PENDING",
- "runs": 0,
- "batch_id": "4da22c97-b7d5-4e31-8c3a-03870ebc7b20",
- "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "start_timestamp": "2019-08-24T14:15:22Z",
- "end_timestamp": "2019-08-24T14:15:22Z",
- "variables": { },
- "result": { },
- "full_result": { },
- "errors": [
- "string"
], - "progress": 100,
- "sequence": "string",
- "creation_order": 0
}
], - "queue_priority": "LOW"
}
}
Add Jobs
path Parameters
batch__id required | string <uuid> (Batch Id) |
Request Body schema: application/jsonrequired
runs required | integer (Runs) |
variables | object (Variables) |
Responses
Request samples
- Payload
[- {
- "runs": 0,
- "variables": { }
}
]
Response samples
- 200
- 422
{- "data": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef",
- "status": "PENDING",
- "complete": true,
- "open": true,
- "priority": 0,
- "device_type": "string",
- "user_id": "string",
- "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "sequence_builder": "string",
- "jobs_count": 0,
- "jobs_count_per_status": { },
- "tags": [
- "string"
], - "configuration": { },
- "webhook": "string",
- "start_datetime": "2019-08-24T14:15:22Z",
- "end_datetime": "2019-08-24T14:15:22Z",
- "jobs": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef",
- "status": "PENDING",
- "runs": 0,
- "batch_id": "4da22c97-b7d5-4e31-8c3a-03870ebc7b20",
- "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "start_timestamp": "2019-08-24T14:15:22Z",
- "end_timestamp": "2019-08-24T14:15:22Z",
- "variables": { },
- "result": { },
- "full_result": { },
- "errors": [
- "string"
], - "progress": 100,
- "sequence": "string",
- "creation_order": 0
}
], - "queue_priority": "LOW"
}
}
Rebatch Jobs
path Parameters
batch__id required | string <uuid> (Batch Id) |
query Parameters
id | Array of strings <uuid> (Id) [ items <uuid > ] Default: "" Unique id for the job |
id__starts_with | string (Id Starts With) Default: "" First characters of the job id |
batch_id | Array of strings <uuid> (Batch Id) [ items <uuid > ] Default: "" Owner batch of the job |
project_id | Array of strings <uuid> (Project Id) [ items <uuid > ] Default: "" Owner project of the job |
user_id | Array of strings (User Id) Default: "" Owner user of the job |
status | Array of strings (JobStatus) Default: "" Items Enum: "PENDING" "RUNNING" "DONE" "ERROR" "CANCELED" Job status type enum |
min_runs | integer (Min Runs) Default: "" Minimum number of times the pulser sequence is repeated |
max_runs | integer (Max Runs) Default: "" Maximum number of times the pulser sequence is repeated |
errors | boolean (Errors) Default: "" Whether errors werer returned when executing the job |
origin | Array of strings (JobOrigin) Default: "" Items Enum: "CLIENT" "AZURE" "UNKNOWN" Origin of the job |
start_date | string <date-time> (Start Date) Default: "" Time when the emulator or QPU indicated a job was started |
end_date | string <date-time> (End Date) Default: "" Time when the emulator or QPU indicated a job finished, failed or was cancelled |
Responses
Response samples
- 200
- 422
{- "data": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef",
- "status": "PENDING",
- "complete": true,
- "open": true,
- "priority": 0,
- "device_type": "string",
- "user_id": "string",
- "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "sequence_builder": "string",
- "jobs_count": 0,
- "jobs_count_per_status": { },
- "tags": [
- "string"
], - "configuration": { },
- "webhook": "string",
- "start_datetime": "2019-08-24T14:15:22Z",
- "end_datetime": "2019-08-24T14:15:22Z",
- "jobs": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef",
- "status": "PENDING",
- "runs": 0,
- "batch_id": "4da22c97-b7d5-4e31-8c3a-03870ebc7b20",
- "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "start_timestamp": "2019-08-24T14:15:22Z",
- "end_timestamp": "2019-08-24T14:15:22Z",
- "variables": { },
- "errors": [
- "string"
], - "progress": 100,
- "sequence": "string",
- "creation_order": 0
}
], - "queue_priority": "LOW"
}
}
Cancel Jobs
path Parameters
batch__id required | string <uuid> (Batch Id) |
query Parameters
id | Array of strings <uuid> (Id) [ items <uuid > ] Default: "" Unique id for the job |
id__starts_with | string (Id Starts With) Default: "" First characters of the job id |
batch_id | Array of strings <uuid> (Batch Id) [ items <uuid > ] Default: "" Owner batch of the job |
project_id | Array of strings <uuid> (Project Id) [ items <uuid > ] Default: "" Owner project of the job |
user_id | Array of strings (User Id) Default: "" Owner user of the job |
status | Array of strings (JobStatus) Default: "" Items Enum: "PENDING" "RUNNING" "DONE" "ERROR" "CANCELED" Job status type enum |
min_runs | integer (Min Runs) Default: "" Minimum number of times the pulser sequence is repeated |
max_runs | integer (Max Runs) Default: "" Maximum number of times the pulser sequence is repeated |
errors | boolean (Errors) Default: "" Whether errors werer returned when executing the job |
origin | Array of strings (JobOrigin) Default: "" Items Enum: "CLIENT" "AZURE" "UNKNOWN" Origin of the job |
start_date | string <date-time> (Start Date) Default: "" Time when the emulator or QPU indicated a job was started |
end_date | string <date-time> (End Date) Default: "" Time when the emulator or QPU indicated a job finished, failed or was cancelled |
Responses
Response samples
- 200
- 422
{- "data": {
- "jobs": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef",
- "status": "PENDING",
- "runs": 0,
- "batch_id": "4da22c97-b7d5-4e31-8c3a-03870ebc7b20",
- "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "start_timestamp": "2019-08-24T14:15:22Z",
- "end_timestamp": "2019-08-24T14:15:22Z",
- "variables": { },
- "result": { },
- "full_result": { },
- "errors": [
- "string"
], - "progress": 100,
- "sequence": "string",
- "creation_order": 0
}
], - "errors": {
- "property1": "string",
- "property2": "string"
}
}
}
Get Batch
Get batch by batch_id.
Args: AuthenticatedComputeAny: The authentication dependency, ensuring the user is authenticated and has the necessary permissions user (GetUserInfoWithProjects): A dependency that will fetch the user information. batch_id(UUID): requested batch id
Returns: The requested Batch.
Raises: BatchNotFound(Http status code 404) if batch_id not found or the user is not member of the batch's project.
path Parameters
batch_id required | string <uuid> (Batch Id) |
Responses
Response samples
- 200
- 422
{- "data": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef",
- "status": "PENDING",
- "complete": true,
- "open": true,
- "priority": 0,
- "device_type": "string",
- "user_id": "string",
- "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "sequence_builder": "string",
- "jobs_count": 0,
- "jobs_count_per_status": { },
- "tags": [
- "string"
], - "configuration": { },
- "webhook": "string",
- "start_datetime": "2019-08-24T14:15:22Z",
- "end_datetime": "2019-08-24T14:15:22Z",
- "job_ids": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "child_ids": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "queue_priority": "LOW"
}
}
Cancel Jobs
path Parameters
batch__id required | string <uuid> (Batch Id) |
query Parameters
id | Array of strings <uuid> (Id) [ items <uuid > ] Default: "" Unique id for the job |
id__starts_with | string (Id Starts With) Default: "" First characters of the job id |
batch_id | Array of strings <uuid> (Batch Id) [ items <uuid > ] Default: "" Owner batch of the job |
project_id | Array of strings <uuid> (Project Id) [ items <uuid > ] Default: "" Owner project of the job |
user_id | Array of strings (User Id) Default: "" Owner user of the job |
status | Array of strings (JobStatus) Default: "" Items Enum: "PENDING" "RUNNING" "DONE" "ERROR" "CANCELED" Job status type enum |
min_runs | integer (Min Runs) Default: "" Minimum number of times the pulser sequence is repeated |
max_runs | integer (Max Runs) Default: "" Maximum number of times the pulser sequence is repeated |
errors | boolean (Errors) Default: "" Whether errors werer returned when executing the job |
origin | Array of strings (JobOrigin) Default: "" Items Enum: "CLIENT" "AZURE" "UNKNOWN" Origin of the job |
start_date | string <date-time> (Start Date) Default: "" Time when the emulator or QPU indicated a job was started |
end_date | string <date-time> (End Date) Default: "" Time when the emulator or QPU indicated a job finished, failed or was cancelled |
Responses
Response samples
- 200
- 422
{- "data": {
- "jobs": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef",
- "status": "PENDING",
- "runs": 0,
- "batch_id": "4da22c97-b7d5-4e31-8c3a-03870ebc7b20",
- "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "start_timestamp": "2019-08-24T14:15:22Z",
- "end_timestamp": "2019-08-24T14:15:22Z",
- "variables": { },
- "errors": [
- "string"
], - "progress": 100,
- "sequence": "string",
- "creation_order": 0
}
], - "errors": {
- "property1": "string",
- "property2": "string"
}
}
}
Response samples
- 200
- 422
{- "data": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef",
- "status": "PENDING",
- "complete": true,
- "open": true,
- "priority": 0,
- "device_type": "string",
- "user_id": "string",
- "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "sequence_builder": "string",
- "jobs_count": 0,
- "jobs_count_per_status": { },
- "tags": [
- "string"
], - "configuration": { },
- "webhook": "string",
- "start_datetime": "2019-08-24T14:15:22Z",
- "end_datetime": "2019-08-24T14:15:22Z",
- "jobs": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef",
- "status": "PENDING",
- "runs": 0,
- "batch_id": "4da22c97-b7d5-4e31-8c3a-03870ebc7b20",
- "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "start_timestamp": "2019-08-24T14:15:22Z",
- "end_timestamp": "2019-08-24T14:15:22Z",
- "variables": { },
- "errors": [
- "string"
], - "progress": 100,
- "sequence": "string",
- "creation_order": 0
}
], - "queue_priority": "LOW"
}
}
Response samples
- 200
- 422
{- "data": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef",
- "status": "PENDING",
- "complete": true,
- "open": true,
- "priority": 0,
- "device_type": "string",
- "user_id": "string",
- "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "sequence_builder": "string",
- "jobs_count": 0,
- "jobs_count_per_status": { },
- "tags": [
- "string"
], - "configuration": { },
- "webhook": "string",
- "start_datetime": "2019-08-24T14:15:22Z",
- "end_datetime": "2019-08-24T14:15:22Z",
- "jobs": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef",
- "status": "PENDING",
- "runs": 0,
- "batch_id": "4da22c97-b7d5-4e31-8c3a-03870ebc7b20",
- "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "start_timestamp": "2019-08-24T14:15:22Z",
- "end_timestamp": "2019-08-24T14:15:22Z",
- "variables": { },
- "errors": [
- "string"
], - "progress": 100,
- "sequence": "string",
- "creation_order": 0
}
], - "queue_priority": "LOW"
}
}
Add Jobs
path Parameters
batch__id required | string <uuid> (Batch Id) |
Request Body schema: application/jsonrequired
runs required | integer (Runs) |
variables | object (Variables) |
Responses
Request samples
- Payload
[- {
- "runs": 0,
- "variables": { }
}
]
Response samples
- 200
- 422
{- "data": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef",
- "status": "PENDING",
- "complete": true,
- "open": true,
- "priority": 0,
- "device_type": "string",
- "user_id": "string",
- "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "sequence_builder": "string",
- "jobs_count": 0,
- "jobs_count_per_status": { },
- "tags": [
- "string"
], - "configuration": { },
- "webhook": "string",
- "start_datetime": "2019-08-24T14:15:22Z",
- "end_datetime": "2019-08-24T14:15:22Z",
- "jobs": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef",
- "status": "PENDING",
- "runs": 0,
- "batch_id": "4da22c97-b7d5-4e31-8c3a-03870ebc7b20",
- "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "start_timestamp": "2019-08-24T14:15:22Z",
- "end_timestamp": "2019-08-24T14:15:22Z",
- "variables": { },
- "errors": [
- "string"
], - "progress": 100,
- "sequence": "string",
- "creation_order": 0
}
], - "queue_priority": "LOW"
}
}
Get All Devices
query Parameters
include_legacy | boolean (Include Legacy) Default: false |
order_by | string (Order By) Default: "created_at" |
order_by_direction | string (SortDirection) Default: "DESC" Enum: "ASC" "DESC" An enumeration. |
limit | integer (Limit) ( 0 .. 101 ) Default: 100 |
offset | integer (Offset) Default: 0 |
Responses
Response samples
- 200
- 422
{- "status": "success",
- "message": "OK.",
- "code": "200",
- "data": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "device_type": "string",
- "status": "UP",
- "average_queue_time": 0,
- "max_atom_num": 0
}
], - "pagination": {
- "total": 0,
- "start": 0,
- "end": 0
}
}
Create Device
Request Body schema: application/jsonrequired
status required | string (DeviceStatus) Enum: "UP" "DOWN" An enumeration. |
device_type required | string (DeviceTypeName) Enum: "EMU_FREE" "EMU_SV" "EMU_TN" "EMU_C" "FRESNEL" "EMU_FRESNEL" Enumeration of allowed and legacy device type names |
specs required | string (Specs) |
is_emulator required | boolean (Is Emulator) |
has_execution_logs required | boolean (Has Execution Logs) |
active | boolean (Active) Default: true |
allowed_result_types required | Array of strings (ResultsType) Items Enum: "counter" "run" "sample" "expectation" |
default_result_types required | Array of strings (ResultsType) Items Enum: "counter" "run" "sample" "expectation" |
Responses
Request samples
- Payload
{- "status": "UP",
- "device_type": "EMU_FREE",
- "specs": "string",
- "is_emulator": true,
- "has_execution_logs": true,
- "active": true,
- "allowed_result_types": [
- "counter"
], - "default_result_types": [
- "counter"
]
}
Response samples
- 200
- 422
{- "data": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "device_type": "string",
- "status": "UP",
- "average_queue_time": 0,
- "max_atom_num": 0
}
}
Set Status
path Parameters
device_id required | string <uuid> (Device Id) |
Request Body schema: application/jsonrequired
status required | string (DeviceStatus) Enum: "UP" "DOWN" An enumeration. |
Responses
Request samples
- Payload
{- "status": "UP"
}
Response samples
- 200
- 422
{- "data": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "device_type": "string",
- "status": "UP",
- "average_queue_time": 0,
- "max_atom_num": 0
}
}
Get Queue Size
path Parameters
device required | string (DeviceTypeName) Enum: "EMU_FREE" "EMU_SV" "EMU_TN" "EMU_C" "FRESNEL" "EMU_FRESNEL" Enumeration of allowed and legacy device type names |
Responses
Response samples
- 200
- 422
{- "data": {
- "device_queues": [
- {
- "queue": "string",
- "number_of_batches": 0,
- "number_of_jobs": 0,
- "number_of_shots": 0
}
]
}
}
Get Device Specs By Device Type
path Parameters
device_type required | string (DeviceTypeName) Enum: "EMU_FREE" "EMU_SV" "EMU_TN" "EMU_C" "FRESNEL" "EMU_FRESNEL" Enumeration of allowed and legacy device type names |
Responses
Response samples
- 200
- 422
{- "data": {
- "device_type": "string",
- "specs": "string"
}
}
Update Device Specs
path Parameters
device_type required | string (DeviceTypeName) Enum: "EMU_FREE" "EMU_SV" "EMU_TN" "EMU_C" "FRESNEL" "EMU_FRESNEL" Enumeration of allowed and legacy device type names |
Request Body schema: application/jsonrequired
specs required | string (Specs) |
Responses
Request samples
- Payload
{- "specs": "string"
}
Response samples
- 200
- 422
{- "data": {
- "device_type": "string",
- "specs": "string"
}
}
Get Total Job Device Frequency Statistics
Return a data structure detailing how many jobs have been scheduled within a certain scope of time for a specific device.
Scope of time is limited to HOUR, DAY or MONTH and it returns based on total jobs inside a project.
query Parameters
project_id required | string <uuid> (Project Id) |
scope required | string (Scope) |
Responses
Response samples
- 200
- 422
{- "data": {
- "count": [
- {
- "datetime": "string",
- "devices": {
- "property1": 0,
- "property2": 0
}
}
], - "job_date_scope": "string"
}
}
Post Job Errors
path Parameters
job_id required | string <uuid> (Job Id) |
Request Body schema: application/jsonrequired
errors required | Array of strings (Errors) |
Responses
Request samples
- Payload
{- "errors": [
- "string"
]
}
Response samples
- 200
- 422
{- "data": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef",
- "status": "PENDING",
- "runs": 0,
- "batch_id": "4da22c97-b7d5-4e31-8c3a-03870ebc7b20",
- "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "start_timestamp": "2019-08-24T14:15:22Z",
- "end_timestamp": "2019-08-24T14:15:22Z",
- "variables": { },
- "errors": [
- "string"
], - "progress": 100,
- "sequence": "string",
- "creation_order": 0
}
}
Set Job Status
path Parameters
job_id required | string <uuid> (Job Id) |
Request Body schema: application/jsonrequired
status required | string (JobStatus) Enum: "PENDING" "RUNNING" "DONE" "ERROR" "CANCELED" An enumeration. |
start_timestamp | string <date-time> (Start Timestamp) |
end_timestamp | string <date-time> (End Timestamp) |
Responses
Request samples
- Payload
{- "status": "PENDING",
- "start_timestamp": "2019-08-24T14:15:22Z",
- "end_timestamp": "2019-08-24T14:15:22Z"
}
Response samples
- 200
- 422
{- "data": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef",
- "status": "PENDING",
- "runs": 0,
- "batch_id": "4da22c97-b7d5-4e31-8c3a-03870ebc7b20",
- "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "start_timestamp": "2019-08-24T14:15:22Z",
- "end_timestamp": "2019-08-24T14:15:22Z",
- "variables": { },
- "errors": [
- "string"
], - "progress": 100,
- "sequence": "string",
- "creation_order": 0
}
}
Response samples
- 200
- 422
{- "data": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "status": "PENDING",
- "runs": 0,
- "batch_id": "4da22c97-b7d5-4e31-8c3a-03870ebc7b20",
- "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "start_timestamp": "2019-08-24T14:15:22Z",
- "end_timestamp": "2019-08-24T14:15:22Z",
- "variables": { },
- "result": { },
- "full_result": { },
- "errors": [
- "string"
], - "logs_link": "string",
- "progress": 100,
- "sequence": "string"
}
}
Patch Job
path Parameters
job_id required | string <uuid> (Job Id) |
Request Body schema: application/jsonrequired
status required | string (JobStatus) Enum: "PENDING" "RUNNING" "DONE" "ERROR" "CANCELED" An enumeration. |
start_timestamp | string <date-time> (Start Timestamp) |
end_timestamp | string <date-time> (End Timestamp) |
progress | integer (Progress) [ 0 .. 100 ] |
Responses
Request samples
- Payload
{- "status": "PENDING",
- "start_timestamp": "2019-08-24T14:15:22Z",
- "end_timestamp": "2019-08-24T14:15:22Z",
- "progress": 100
}
Response samples
- 200
- 422
{- "data": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef",
- "status": "PENDING",
- "runs": 0,
- "batch_id": "4da22c97-b7d5-4e31-8c3a-03870ebc7b20",
- "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "start_timestamp": "2019-08-24T14:15:22Z",
- "end_timestamp": "2019-08-24T14:15:22Z",
- "variables": { },
- "errors": [
- "string"
], - "progress": 100,
- "sequence": "string",
- "creation_order": 0
}
}
Response samples
- 200
- 422
{- "data": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef",
- "status": "PENDING",
- "runs": 0,
- "batch_id": "4da22c97-b7d5-4e31-8c3a-03870ebc7b20",
- "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "start_timestamp": "2019-08-24T14:15:22Z",
- "end_timestamp": "2019-08-24T14:15:22Z",
- "variables": { },
- "result": { },
- "full_result": { },
- "errors": [
- "string"
], - "progress": 100,
- "sequence": "string",
- "creation_order": 0
}
}
Get All Jobs
query Parameters
order_by | string (Order By) Default: "created_at" |
order_by_direction | string (SortDirection) Default: "DESC" Enum: "ASC" "DESC" An enumeration. |
limit | integer (Limit) ( 0 .. 101 ) Default: 100 |
offset | integer (Offset) Default: 0 |
id | Array of strings <uuid> (Id) [ items <uuid > ] Default: "" Unique id for the job |
id__starts_with | string (Id Starts With) Default: "" First characters of the job id |
batch_id | Array of strings <uuid> (Batch Id) [ items <uuid > ] Default: "" Owner batch of the job |
project_id | Array of strings <uuid> (Project Id) [ items <uuid > ] Default: "" Owner project of the job |
user_id | Array of strings (User Id) Default: "" Owner user of the job |
status | Array of strings (JobStatus) Default: "" Items Enum: "PENDING" "RUNNING" "DONE" "ERROR" "CANCELED" Job status type enum |
min_runs | integer (Min Runs) Default: "" Minimum number of times the pulser sequence is repeated |
max_runs | integer (Max Runs) Default: "" Maximum number of times the pulser sequence is repeated |
errors | boolean (Errors) Default: "" Whether errors werer returned when executing the job |
origin | Array of strings (JobOrigin) Default: "" Items Enum: "CLIENT" "AZURE" "UNKNOWN" Origin of the job |
start_date | string <date-time> (Start Date) Default: "" Time when the emulator or QPU indicated a job was started |
end_date | string <date-time> (End Date) Default: "" Time when the emulator or QPU indicated a job finished, failed or was cancelled |
Responses
Response samples
- 200
- 422
{- "status": "success",
- "message": "OK.",
- "code": "200",
- "data": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef",
- "status": "PENDING",
- "runs": 0,
- "batch_id": "4da22c97-b7d5-4e31-8c3a-03870ebc7b20",
- "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "start_timestamp": "2019-08-24T14:15:22Z",
- "end_timestamp": "2019-08-24T14:15:22Z",
- "variables": { },
- "result": { },
- "full_result": { },
- "errors": [
- "string"
], - "progress": 100,
- "sequence": "string",
- "creation_order": 0
}
], - "pagination": {
- "total": 0,
- "start": 0,
- "end": 0
}
}
Get Job
Retrieve a job by its ID.
Args: AuthenticatedComputeAny: The authentication dependency, ensuring the user is authenticated and has the necessary permissions
job: GetJobByIdAndPerformAccessCheck access the job by its ID and perform
access checks. The 'deferred_fields' parameter is specified to exclude the
'result' attribute from being loaded from the database.
Returns: NonPaginatedResponse[ProducedFullJobResponse]: A non-paginated response containing the details of the job, excluding the result attribute
path Parameters
job_id required | string <uuid> (Job Id) |
Responses
Response samples
- 200
- 422
{- "data": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef",
- "status": "PENDING",
- "runs": 0,
- "batch_id": "4da22c97-b7d5-4e31-8c3a-03870ebc7b20",
- "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "start_timestamp": "2019-08-24T14:15:22Z",
- "end_timestamp": "2019-08-24T14:15:22Z",
- "variables": { },
- "errors": [
- "string"
], - "logs_link": "string",
- "progress": 100,
- "sequence": "string"
}
}
Get 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
query Parameters
order_by | string (Order By) Default: "created_at" |
order_by_direction | string (SortDirection) Default: "DESC" Enum: "ASC" "DESC" An enumeration. |
limit | integer (Limit) ( 0 .. 101 ) Default: 100 |
offset | integer (Offset) Default: 0 |
id | Array of strings <uuid> (Id) [ items <uuid > ] Default: "" Unique id for the job |
id__starts_with | string (Id Starts With) Default: "" First characters of the job id |
batch_id | Array of strings <uuid> (Batch Id) [ items <uuid > ] Default: "" Owner batch of the job |
project_id | Array of strings <uuid> (Project Id) [ items <uuid > ] Default: "" Owner project of the job |
user_id | Array of strings (User Id) Default: "" Owner user of the job |
status | Array of strings (JobStatus) Default: "" Items Enum: "PENDING" "RUNNING" "DONE" "ERROR" "CANCELED" Job status type enum |
min_runs | integer (Min Runs) Default: "" Minimum number of times the pulser sequence is repeated |
max_runs | integer (Max Runs) Default: "" Maximum number of times the pulser sequence is repeated |
errors | boolean (Errors) Default: "" Whether errors werer returned when executing the job |
origin | Array of strings (JobOrigin) Default: "" Items Enum: "CLIENT" "AZURE" "UNKNOWN" Origin of the job |
start_date | string <date-time> (Start Date) Default: "" Time when the emulator or QPU indicated a job was started |
end_date | string <date-time> (End Date) Default: "" Time when the emulator or QPU indicated a job finished, failed or was cancelled |
Responses
Response samples
- 200
- 422
{- "status": "success",
- "message": "OK.",
- "code": "200",
- "data": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef",
- "status": "PENDING",
- "runs": 0,
- "batch_id": "4da22c97-b7d5-4e31-8c3a-03870ebc7b20",
- "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "start_timestamp": "2019-08-24T14:15:22Z",
- "end_timestamp": "2019-08-24T14:15:22Z",
- "variables": { },
- "errors": [
- "string"
], - "progress": 100,
- "sequence": "string",
- "creation_order": 0
}
], - "pagination": {
- "total": 0,
- "start": 0,
- "end": 0
}
}
Response samples
- 200
- 422
{- "data": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef",
- "status": "PENDING",
- "runs": 0,
- "batch_id": "4da22c97-b7d5-4e31-8c3a-03870ebc7b20",
- "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "start_timestamp": "2019-08-24T14:15:22Z",
- "end_timestamp": "2019-08-24T14:15:22Z",
- "variables": { },
- "errors": [
- "string"
], - "progress": 100,
- "sequence": "string",
- "creation_order": 0
}
}
Get Or Create
Get the learner for the current user.
Args: package: The package to get the learner for. auth_info: The auth info. Used to constrain the account type.
Returns: QueryResults: The learner.
path Parameters
package required | string (ProjectPackage) Enum: "QUANTUM_DISCOVERY" "QUANTUM_DISCOVERY_CHEMISTRY" "QUANTUM_DISCOVERY_LIGHT" "QUANTUM_DISCOVERY_PLAY" "QUANTUM_DISCOVERY_ESSENTIAL" "LEARN_BY_CODING" "VQPU" An enumeration. |
Responses
Response samples
- 200
- 422
{- "data": [
- { }
]
}
Update Progress For User And Package
Update the progress for the current user.
Args: package: The package to update the learner for. updated_learner: The schema containing updated progress.
Returns: QueryResults: The learner.
path Parameters
package required | string (ProjectPackage) Enum: "QUANTUM_DISCOVERY" "QUANTUM_DISCOVERY_CHEMISTRY" "QUANTUM_DISCOVERY_LIGHT" "QUANTUM_DISCOVERY_PLAY" "QUANTUM_DISCOVERY_ESSENTIAL" "LEARN_BY_CODING" "VQPU" An enumeration. |
Request Body schema: application/jsonrequired
required | object (Progress) | ||||||||
|
Responses
Request samples
- Payload
{- "progress": {
- "property1": {
- "stage": "DONE",
- "timecode": 0
}, - "property2": {
- "stage": "DONE",
- "timecode": 0
}
}
}
Response samples
- 200
- 422
{- "data": [
- { }
]
}
Notebook
Get a notebook server for the current user.
Args: package: The package the learner is in. notebook: The specific notebook to spawn
Returns: QueryResults
path Parameters
package required | string (ProjectPackage) Enum: "QUANTUM_DISCOVERY" "QUANTUM_DISCOVERY_CHEMISTRY" "QUANTUM_DISCOVERY_LIGHT" "QUANTUM_DISCOVERY_PLAY" "QUANTUM_DISCOVERY_ESSENTIAL" "LEARN_BY_CODING" "VQPU" An enumeration. |
notebook required | string (Notebook) |
query Parameters
project_id | string <uuid> (Project Id) |
Responses
Response samples
- 200
- 422
{
}
Get For Project
Get the learners for the given project and package.
Args: package: The package to get the learners for. project: The project to get the learners for. ordering_param: The ordering parameters. paginated_params: The pagination parameters.
Returns: QueryResults: The learners.
path Parameters
project_id required | string <uuid> (Project Id) |
query Parameters
order_by | string (Order By) Default: "created_at" |
order_by_direction | string (SortDirection) Default: "DESC" Enum: "ASC" "DESC" An enumeration. |
limit | integer (Limit) ( 0 .. 101 ) Default: 100 |
offset | integer (Offset) Default: 0 |
Responses
Response samples
- 200
- 422
{- "status": "success",
- "message": "OK.",
- "code": "200",
- "data": [
- {
- "user_id": "string",
- "package": "QUANTUM_DISCOVERY",
- "progress": {
- "property1": {
- "stage": "DONE",
- "timecode": 0
}, - "property2": {
- "stage": "DONE",
- "timecode": 0
}
}, - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "pagination": {
- "total": 0,
- "start": 0,
- "end": 0
}
}
Create Use Case
Create a use-case.
Args: use_case: The use-case to create. user_session: The auth info used to check permissions.
Returns: QueryResults: The created use-case.
Request Body schema: application/jsonrequired
project_id | string <uuid> (Project Id) |
title required | string (Title) |
validation_status required | string (Validation Status) |
summary | string (Summary) |
questionnaire_id | integer (Questionnaire Id) |
answers | object (Answers) |
Responses
Request samples
- Payload
{- "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
- "title": "string",
- "validation_status": "string",
- "summary": "string",
- "questionnaire_id": 0,
- "answers": { }
}
Response samples
- 200
- 422
{- "data": [
- { }
]
}
Get Use Case By Id
Get all the data of the requested use-case, including answers.
Args: user_session: The auth info used to check permissions.
Returns: QueryResults: The matching use-case, if found in DB and allowed for user.
path Parameters
use_case_id required | string <uuid> (Use Case Id) |
Responses
Response samples
- 200
- 422
{- "data": [
- { }
]
}
Partial Use Case Update
Updates a use-case, possibly partially.
Args: use_case_id: ID of the Use case to update. use_case: The use-case fields to update. credential: The auth info used to check permissions. credential_acl: contains the projects accessible by the user
Returns: QueryResults: The resulting updated use case.
path Parameters
use_case_id required | string <uuid> (Use Case Id) |
Request Body schema: application/jsonrequired
title | string (Title) |
validation_status | string (Validation Status) |
summary | string (Summary) |
questionnaire_id | integer (Questionnaire Id) |
answers | object (Answers) |
Responses
Request samples
- Payload
{- "title": "string",
- "validation_status": "string",
- "summary": "string",
- "questionnaire_id": 0,
- "answers": { }
}
Response samples
- 200
- 422
{- "data": [
- { }
]
}
Get My Use Cases
Get the list of use-cases created by the logged user in the given project.
Args: project_id: the project (=team) for which to retrieve use-cases. credential: The auth info used to check permissions. paginated_params: arguments provided by the client to control pagination. status: If provided, return only use-cases having that status search: If provided, return only use-cases containing that term
Returns: QueryResults: The matching use-cases found in DB.
path Parameters
project_id required | string <uuid> (Project Id) |
query Parameters
status | string (ValidationStatus) Enum: "DRAFT" "UNDER_REVIEW" "REVIEWER_DRAFT" "REQUIRING_UPDATE" "UPDATED" "REJECTED" "APPROVED" An enumeration. |
search | string (Search) |
limit | integer (Limit) ( 0 .. 101 ) Default: 100 |
offset | integer (Offset) Default: 0 |
Responses
Response samples
- 200
- 422
{- "status": "success",
- "message": "OK.",
- "code": "200",
- "data": [
- {
- "user_id": "string",
- "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
- "title": "string",
- "validation_status": "string",
- "summary": "string",
- "questionnaire_id": 0,
- "last_reviewed_at": "2019-08-24T14:15:22Z",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "user_name": "string",
- "project_name": "string"
}
], - "pagination": {
- "total": 0,
- "start": 0,
- "end": 0
}
}
Get Team Use Cases
Get the list of validated use-cases created by other project (team) members of the logged user.
Args: project_id: the project (=team) for which to retrieve use-cases. credential: The auth info used to check permissions. credential_acl: contains the projects accessible by the user paginated_params: arguments provided by the client to control pagination. status: can be used by a super-user to filter by status; regular users only see APPROVED use-cases. search: If provided, return only use-cases containing that term
Returns: QueryResults: The matching use-cases found in DB.
path Parameters
project_id required | string <uuid> (Project Id) |
query Parameters
status | Array of strings (ValidationStatus) Items Enum: "DRAFT" "UNDER_REVIEW" "REVIEWER_DRAFT" "REQUIRING_UPDATE" "UPDATED" "REJECTED" "APPROVED" |
search | string (Search) |
limit | integer (Limit) ( 0 .. 101 ) Default: 100 |
offset | integer (Offset) Default: 0 |
Responses
Response samples
- 200
- 422
{- "status": "success",
- "message": "OK.",
- "code": "200",
- "data": [
- {
- "user_id": "string",
- "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
- "title": "string",
- "validation_status": "string",
- "summary": "string",
- "questionnaire_id": 0,
- "last_reviewed_at": "2019-08-24T14:15:22Z",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "user_name": "string",
- "project_name": "string"
}
], - "pagination": {
- "total": 0,
- "start": 0,
- "end": 0
}
}
Get Example Use Cases
Get the list of example use-cases provided by Pasqal.
Returns: QueryResults: The matching use-cases found in DB.
query Parameters
limit | integer (Limit) ( 0 .. 101 ) Default: 100 |
offset | integer (Offset) Default: 0 |
Responses
Response samples
- 200
- 422
{- "status": "success",
- "message": "OK.",
- "code": "200",
- "data": [
- {
- "user_id": "string",
- "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
- "title": "string",
- "validation_status": "string",
- "summary": "string",
- "questionnaire_id": 0,
- "last_reviewed_at": "2019-08-24T14:15:22Z",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "user_name": "string",
- "project_name": "string"
}
], - "pagination": {
- "total": 0,
- "start": 0,
- "end": 0
}
}
Review Use Case
path Parameters
use_case_id required | string <uuid> (Use Case Id) |
Request Body schema: application/jsonrequired
additional property | string or AnswerDict (object) |
Any of string |
Responses
Request samples
- Payload
{- "property1": "string",
- "property2": "string"
}
Response samples
- 200
- 422
{- "data": [
- { }
]
}
Create Workload
Request Body schema: application/jsonrequired
project_id required | string <uuid> (Project Id) |
workload_type required | string (WorkloadType) Enum: "algorithm_dqgm" "qadence_circuit" "algorithm_pde_basf" "algorithm_pde_equality" "algorithm_qel_posco" An enumeration. |
backend required | string (BackendName) Enum: "pyq" "pyqtorch" "digital" "emu_c" "pulser_basic" An enumeration. |
config required | object (Config) |
Responses
Request samples
- Payload
{- "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
- "workload_type": "algorithm_dqgm",
- "backend": "pyq",
- "config": { }
}
Response samples
- 200
- 422
{- "data": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "start_timestamp": "2019-08-24T14:15:22Z",
- "end_timestamp": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "workload_type": "string",
- "backend": "string",
- "status": "PENDING",
- "config": { },
- "errors": [
- "string"
], - "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
- "user_id": "string",
- "queue_priority": "LOW",
- "result": { }
}
}
Post Workload Result
path Parameters
workload_id required | string <uuid> (Workload Id) |
Request Body schema: application/jsonrequired
result required | object (Result) |
Responses
Request samples
- Payload
{- "result": { }
}
Response samples
- 200
- 422
{- "data": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "start_timestamp": "2019-08-24T14:15:22Z",
- "end_timestamp": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "workload_type": "string",
- "backend": "string",
- "status": "PENDING",
- "config": { },
- "errors": [
- "string"
], - "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
- "user_id": "string",
- "queue_priority": "LOW",
- "result": { }
}
}
Post Workload Errors
path Parameters
workload_id required | string <uuid> (Workload Id) |
Request Body schema: application/jsonrequired
errors required | Array of strings (Errors) |
Responses
Request samples
- Payload
{- "errors": [
- "string"
]
}
Response samples
- 200
- 422
{- "data": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "start_timestamp": "2019-08-24T14:15:22Z",
- "end_timestamp": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "workload_type": "string",
- "backend": "string",
- "status": "PENDING",
- "config": { },
- "errors": [
- "string"
], - "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
- "user_id": "string",
- "queue_priority": "LOW",
- "result": { }
}
}
Set Workload Status
path Parameters
workload_id required | string <uuid> (Workload Id) |
Request Body schema: application/jsonrequired
status required | string (JobStatus) Enum: "PENDING" "RUNNING" "DONE" "ERROR" "CANCELED" An enumeration. |
start_timestamp | string <date-time> (Start Timestamp) |
end_timestamp | string <date-time> (End Timestamp) |
Responses
Request samples
- Payload
{- "status": "PENDING",
- "start_timestamp": "2019-08-24T14:15:22Z",
- "end_timestamp": "2019-08-24T14:15:22Z"
}
Response samples
- 200
- 422
{- "data": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "start_timestamp": "2019-08-24T14:15:22Z",
- "end_timestamp": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "workload_type": "string",
- "backend": "string",
- "status": "PENDING",
- "config": { },
- "errors": [
- "string"
], - "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
- "user_id": "string",
- "queue_priority": "LOW",
- "result_link": "string"
}
}
Cancel Workload
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.
path Parameters
workload_id required | string <uuid> (Workload Id) |
Responses
Response samples
- 200
- 422
{- "data": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "start_timestamp": "2019-08-24T14:15:22Z",
- "end_timestamp": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "workload_type": "string",
- "backend": "string",
- "status": "PENDING",
- "config": { },
- "errors": [
- "string"
], - "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
- "user_id": "string",
- "queue_priority": "LOW",
- "result": { }
}
}
Get Workload
Get workload by workload_id.
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.
path Parameters
workload_id required | string <uuid> (Workload Id) |
Responses
Response samples
- 200
- 422
{- "data": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "start_timestamp": "2019-08-24T14:15:22Z",
- "end_timestamp": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "workload_type": "string",
- "backend": "string",
- "status": "PENDING",
- "config": { },
- "errors": [
- "string"
], - "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
- "user_id": "string",
- "queue_priority": "LOW",
- "result": { }
}
}
Get Workloads
Get list of workloads matching a set of optional filters.
Args: user: the data of the user requesting the workloads ordering_params: ordering params for the list results paginated_params: pagination params for the list results filter_params: the filter params for the list results
Returns: The requested workloads
query Parameters
order_by | string (Order By) Default: "created_at" |
order_by_direction | string (SortDirection) Default: "DESC" Enum: "ASC" "DESC" An enumeration. |
limit | integer (Limit) ( 0 .. 101 ) Default: 100 |
offset | integer (Offset) Default: 0 |
id | Array of strings <uuid> (Id) [ items <uuid > ] Default: "" Unique id for the workload |
id__starts_with | string (Id Starts With) Default: "" First characters of the workload id |
project_id | Array of strings <uuid> (Project Id) [ items <uuid > ] Default: "" Owner project of the workload |
status | Array of strings (JobStatus) Default: "" Items Enum: "PENDING" "RUNNING" "DONE" "ERROR" "CANCELED" Job status type enum |
start_date | string <date-time> (Start Date) Default: "" Time when the emulator or QPU indicated workload was started |
end_date | string <date-time> (End Date) Default: "" Time when the emulator or QPU indicated workload finished, failed or was cancelled |
Responses
Response samples
- 200
- 422
{- "status": "success",
- "message": "OK.",
- "code": "200",
- "data": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "start_timestamp": "2019-08-24T14:15:22Z",
- "end_timestamp": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "workload_type": "string",
- "backend": "string",
- "status": "string",
- "config": { },
- "errors": [
- "string"
], - "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
- "user_id": "string",
- "queue_priority": "LOW"
}
], - "pagination": {
- "total": 0,
- "start": 0,
- "end": 0
}
}
Get Workload
Get workload by workload_id.
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.
path Parameters
workload_id required | string <uuid> (Workload Id) |
Responses
Response samples
- 200
- 422
{- "data": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "start_timestamp": "2019-08-24T14:15:22Z",
- "end_timestamp": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "workload_type": "string",
- "backend": "string",
- "status": "PENDING",
- "config": { },
- "errors": [
- "string"
], - "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
- "user_id": "string",
- "queue_priority": "LOW",
- "result_link": "string"
}
}
Create
Create a quiz matching the given strapi_quiz_id and user.
If the quiz already exists for the given user, a 400 error will be raised. In this case the user should use the PATCH method to updated their quiz response.
Args: data: The quiz to create. strapi_quiz_id: The id of the quiz in strapi. user: The auth info used to check permissions.
path Parameters
strapi_quiz_id required | string (Strapi Quiz Id) |
Request Body schema: application/jsonrequired
required | Data (object) or Array of Data (objects) (Data) |
Any of object (Data) |
Responses
Request samples
- Payload
{- "data": { }
}
Response samples
- 200
- 422
{- "data": [
- { }
]
}
Update
Update the quiz with the given id.
Args: data: The quiz to update. quiz_id: The id of the quiz in public-apis. user: The auth info used to check permissions.
path Parameters
quiz_id required | string (Quiz Id) |
Request Body schema: application/jsonrequired
required | Data (object) or Array of Data (objects) (Data) |
Any of object (Data) |
Responses
Request samples
- Payload
{- "data": { }
}
Response samples
- 200
- 422
{- "data": [
- { }
]
}