Skip to main content

queues

POST /queues.add_or_update_metadata#

Description#

Add or update queue metadata

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
metadata
required
Metadata items to add or update< queues.metadata_item > array
queue
required
ID of the queuestring

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
updated
optional
Number of queues updated (0 or 1)integer

POST /queues.add_task#

Description#

Adds a task entry to the queue.

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
queue
required
Queue idstring
task
required
Task idstring

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
added
optional
Number of tasks added (0 or 1)integer

POST /queues.create#

Description#

Create a new queue

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
name
required
Queue name Unique within the company.string
system_tags
optional
System tags list. This field is reserved for system use, please don't use it.< string > array
tags
optional
User-defined tags list< string > array

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
id
optional
New queue IDstring

POST /queues.delete#

Description#

Deletes a queue. If the queue is not empty and force is not set to true, queue
will not be deleted.

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
force
optional
Force delete of non-empty queue. Defaults to false
Default : false
boolean
queue
required
Queue idstring

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
deleted
optional
Number of queues deleted (0 or 1)integer

POST /queues.delete_metadata#

Description#

Delete metadata from queue

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
keys
required
The list of metadata keys to delete< string > array
queue
required
ID of the queuestring

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
updated
optional
Number of queues updated (0 or 1)integer

POST /queues.get_all#

Description#

Get all queues

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
id
optional
List of Queue IDs used to filter results< string > array
name
optional
Get only queues whose name matches this pattern (python regular expression
syntax)
string
only_fields
optional
List of document field names (nesting is supported using '.', e.g.
execution.model_labels). If provided, this list defines the query's projection
(only these fields will be returned for each result entry)
< string > array
order_by
optional
List of field names to order by. When search_text is used, '@text_score' can be
used as a field representing the text score of returned documents. Use '-'
prefix to specify descending order. Optional, recommended when using page
< string > array
page
optional
Page number, returns a specific page out of the result list of results.
Minimum value : 0
integer
page_size
optional
Page size, specifies the number of results returned in each page (last page may
contain fewer results)
Minimum value : 1
integer
search_text
optional
Free text search querystring
system_tags
optional
System tags list used to filter results. Prepend '-' to system tag name to
indicate exclusion
< string > array
tags
optional
User-defined tags list used to filter results. Prepend '-' to tag name to
indicate exclusion
< string > array

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
queues
optional
Queues list< queues.queue > array

POST /queues.get_all_ex#

Description#

Get all queues

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
id
optional
List of Queue IDs used to filter results< string > array
name
optional
Get only queues whose name matches this pattern (python regular expression
syntax)
string
only_fields
optional
List of document field names (nesting is supported using '.', e.g.
execution.model_labels). If provided, this list defines the query's projection
(only these fields will be returned for each result entry)
< string > array
order_by
optional
List of field names to order by. When search_text is used, '@text_score' can be
used as a field representing the text score of returned documents. Use '-'
prefix to specify descending order. Optional, recommended when using page
< string > array
page
optional
Page number, returns a specific page out of the result list of results.
Minimum value : 0
integer
page_size
optional
Page size, specifies the number of results returned in each page (last page may
contain fewer results)
Minimum value : 1
integer
search_text
optional
Free text search querystring
system_tags
optional
System tags list used to filter results. Prepend '-' to system tag name to
indicate exclusion
< string > array
tags
optional
User-defined tags list used to filter results. Prepend '-' to tag name to
indicate exclusion
< string > array

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
queues
optional
Queues list< queues.queue > array

POST /queues.get_by_id#

Description#

Gets queue information

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
queue
required
Queue IDstring

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
queue
optional
Queue infoqueues.queue

POST /queues.get_default#

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyobject

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
id
optional
Queue idstring
name
optional
Queue namestring

POST /queues.get_next_task#

Description#

Gets the next task from the top of the queue (FIFO). The task entry is removed
from the queue.

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
queue
required
Queue idstring

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
entry
optional
Entry informationqueues.entry

POST /queues.get_queue_metrics#

Description#

Returns metrics of the company queues. The metrics are avaraged in the
specified interval.

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
from_date
required
Starting time (in seconds from epoch) for collecting metricsnumber
interval
required
Time interval in seconds for a single metrics point. The minimal value is 1integer
queue_ids
optional
List of queue ids to collect metrics for. If not provided or empty then all
then average metrics across all the company queues will be returned.
< string > array
to_date
required
Ending time (in seconds from epoch) for collecting metricsnumber

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
queues
optional
List of the requested queues with their metrics. If no queue ids were requested
then 'all' queue is returned with the metrics averaged accross all the company
queues.
< queues.queue_metrics > array

POST /queues.move_task_backward#

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
count
optional
Number of positions in the queue to move the task forward relative to the
current position. Optional, the default value is 1.
integer
queue
required
Queue idstring
task
required
Task idstring

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
position
optional
The new position of the task entry in the queue (index, -1 represents bottom of
queue)
integer

POST /queues.move_task_forward#

Description#

Moves a task entry one step forward towards the top of the queue.

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
count
optional
Number of positions in the queue to move the task forward relative to the
current position. Optional, the default value is 1.
integer
queue
required
Queue idstring
task
required
Task idstring

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
position
optional
The new position of the task entry in the queue (index, -1 represents bottom of
queue)
integer

POST /queues.move_task_to_back#

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
queue
required
Queue idstring
task
required
Task idstring

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
position
optional
The new position of the task entry in the queue (index, -1 represents bottom of
queue)
integer

POST /queues.move_task_to_front#

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
queue
required
Queue idstring
task
required
Task idstring

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
position
optional
The new position of the task entry in the queue (index, -1 represents bottom of
queue)
integer

POST /queues.remove_task#

Description#

Removes a task entry from the queue.

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
queue
required
Queue idstring
task
required
Task idstring

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
removed
optional
Number of tasks removed (0 or 1)integer

POST /queues.update#

Description#

Update queue information

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
name
optional
Queue name Unique within the company.string
queue
required
Queue idstring
system_tags
optional
System tags list. This field is reserved for system use, please don't use it.< string > array
tags
optional
User-defined tags list< string > array

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
fields
optional
Updated fields names and valuesobject
updated
optional
Number of queues updated (0 or 1)integer