Queues⚓︎
A collection of Items.
Endpoint⚓︎
GET /api/data/{queue}
Parameters⚓︎
| Name | Value |
|---|---|
queue |
The name of the queue. |
Query String Options⚓︎
| Name | Description | Possible Values |
|---|---|---|
headers_only |
When "True", only meta data will be loaded. When "False" content will be parsed. (Defaults to "True".) |
"True" | "True" |
Return Codes⚓︎
| Code | Description |
|---|---|
200 - Ok |
On success. |
404 - Not Found |
When the Queue does not exist. |
500 - Internal Service Error |
On failure. |
Properties⚓︎
Queue.name⚓︎
| Type | Description |
|---|---|
String |
The name of the queue. |
Example
console.log(Queue.name)
// Expected Output
"ce"
Queue.path⚓︎
| Type | Description |
|---|---|
String |
The absolute file path to the Queue. |
Example
console.log(Queue.path)
// Expected Output
"/home/pier/e/queue/Mail/ce"
Queue.items⚓︎
| Type | Description |
|---|---|
Array<Object> |
The Items in the queue. |
Example
console.log(Queue.items)
// Expected Output
[
{ queue: "ce", number: 01, lastUpdated: "2021-03-26T17:12:00-0400" ... }
{ queue: "ce", number: 02, lastUpdated: "2021-05-29T17:12:00-0400" ... }
{ queue: "ce", number: 03, lastUpdated: "2020-12-29T17:12:00-0400" ... }
]