Get Queue
GET
/api/v1/devices/{dt_name}/queue
Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” dt_name
required
DeviceTypeName
Enumeration of allowed and legacy device type names
string
Query Parameters
Section titled “Query Parameters ” limit
Limit
integer
offset
Offset
integer
Responses
Section titled “ Responses ”Successful Response
HeaderPaginatedResponse[ProducedBatchQueueResponse]
A list of responses with pagination information.
For backwards compatibility, this also exposes pagination using the following header format:
Access-Control-Expose-Headers: Content-Range
Content-Range: $FIRST_ITEM_IN_BATCH-$LAST_ITEM_IN_BACH/$TOTAL_ITEMS_AVAILABLEobject
status
string
message
Message
string
code
Code
string
data
required
Data
Array<object>
ProducedBatchQueueResponseResponse for a batch request to represents device queue. The response does not includes its jobs and its sequence builder.
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
open
required
Open
boolean
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
jobs_count
required
Jobs Count
integer
jobs_count_per_status
required
Jobs Count Per Status
object
tags
required
Tags
Array<string>
configuration
Configuration
object
backend_configuration
Backend Configuration
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
pagination
required
JSendPagination
Pagination information
object
total
required
Total
integer
start
required
Start
integer
end
required
End
integer
Validation Error
HTTPValidationError
object
detail
Detail
Array<object>
ValidationErrorobject
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string