|
|
(9 intermediate revisions by one other user not shown) |
Line 1: |
Line 1: |
− | '''List Queues'''
| |
| | | |
− | Template: GET /v1/queues?marker=string& limit=integer&detailed=boolean
| |
− |
| |
− | Normal response code(s): 200
| |
− |
| |
− | Error response codes(s): badRequest (400), unauthorized (401), itemNotFound (404), unauthorized (406)
| |
− |
| |
− | This operation lists queues for the project, sorting the queues alphabetically by name.
| |
− |
| |
− | Note: If you do not specify the limit query parameter, it defaults to 10. Forward-only paging is supported via "next" link.
| |
− | The detailed query parameter defaults to false, which excludes the metadata from the results.
| |
− |
| |
− | Request Example:
| |
− |
| |
− | GET /v1/queues?marker=baz&detailed=true HTTP/1.1
| |
− | Host: marconi.example.com
| |
− |
| |
− | ...
| |
− |
| |
− | Response Example:
| |
− |
| |
− | <code>HTTP/1.1 200 OK
| |
− |
| |
− | {
| |
− | "links: [
| |
− | {
| |
− | "rel": "next",
| |
− | "href": "/v1/queues/fizbit/queues?marker=kooleo&limit=10&detailed=true"
| |
− | }
| |
− | ],
| |
− | "queues": [
| |
− | { "name": "boomerang", "href": "/v1/queues/boomerang", "metadata": {} },
| |
− | { "name": "fizbit", "href": "/v1/queues/fizbit", "metadata": { "handle": "@kgriffs" } },
| |
− |
| |
− | ...
| |
− |
| |
− | { "name": "kooleo", "href": "/v1/queues/kooleo", "metadata": { "something": "something_else" } }
| |
− | ]
| |
− | }
| |
− | </code>
| |