207 lines
5.3 KiB
Markdown
207 lines
5.3 KiB
Markdown
---
|
|
name: request-queues-routes
|
|
description: Handle 17 OpenAPI operation(s) under /v2/request-queues for the request queues route group.
|
|
---
|
|
|
|
# request queues API Routes
|
|
|
|
Handle 17 OpenAPI operation(s) under /v2/request-queues for the request queues route group.
|
|
|
|
Use the generated operation tools to make real API calls. Do not invent API responses.
|
|
If a tool reports missing setup, return the exact setup field name to the caller.
|
|
For write, update, or delete operations, state the intended action before calling the tool.
|
|
|
|
## Operations
|
|
|
|
### request_queues_get
|
|
|
|
- Operation ID: `request_queues_get`
|
|
- Route: `GET /v2/request-queues`
|
|
- Mode: READ
|
|
- Summary: Get list of request queues
|
|
- Parameters:
|
|
- `offset` in `query`
|
|
- `limit` in `query`
|
|
- `desc` in `query`
|
|
- `unnamed` in `query`
|
|
- `ownership` in `query`
|
|
|
|
### request_queues_post
|
|
|
|
- Operation ID: `request_queues_post`
|
|
- Route: `POST /v2/request-queues`
|
|
- Mode: WRITE
|
|
- Summary: Create request queue
|
|
- Parameters:
|
|
- `name` in `query`
|
|
|
|
### request_queue_get
|
|
|
|
- Operation ID: `request_queue_get`
|
|
- Route: `GET /v2/request-queues/{queueId}`
|
|
- Mode: READ
|
|
- Summary: Get request queue
|
|
- Parameters:
|
|
- `queueId` in `path` required
|
|
|
|
### request_queue_put
|
|
|
|
- Operation ID: `request_queue_put`
|
|
- Route: `PUT /v2/request-queues/{queueId}`
|
|
- Mode: WRITE
|
|
- Summary: Update request queue
|
|
- Parameters:
|
|
- `queueId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### request_queue_delete
|
|
|
|
- Operation ID: `request_queue_delete`
|
|
- Route: `DELETE /v2/request-queues/{queueId}`
|
|
- Mode: WRITE
|
|
- Summary: Delete request queue
|
|
- Parameters:
|
|
- `queueId` in `path` required
|
|
|
|
### request_queue_requests_batch_post
|
|
|
|
- Operation ID: `request_queue_requests_batch_post`
|
|
- Route: `POST /v2/request-queues/{queueId}/requests/batch`
|
|
- Mode: WRITE
|
|
- Summary: Add requests
|
|
- Parameters:
|
|
- `queueId` in `path` required
|
|
- `clientKey` in `query`
|
|
- `forefront` in `query`
|
|
- Body: JSON request body accepted.
|
|
|
|
### request_queue_requests_batch_delete
|
|
|
|
- Operation ID: `request_queue_requests_batch_delete`
|
|
- Route: `DELETE /v2/request-queues/{queueId}/requests/batch`
|
|
- Mode: WRITE
|
|
- Summary: Delete requests
|
|
- Parameters:
|
|
- `queueId` in `path` required
|
|
- `Content-Type` in `header` required
|
|
- `clientKey` in `query`
|
|
- Body: JSON request body accepted.
|
|
|
|
### request_queue_requests_unlock_post
|
|
|
|
- Operation ID: `request_queue_requests_unlock_post`
|
|
- Route: `POST /v2/request-queues/{queueId}/requests/unlock`
|
|
- Mode: WRITE
|
|
- Summary: Unlock requests
|
|
- Parameters:
|
|
- `queueId` in `path` required
|
|
- `clientKey` in `query`
|
|
|
|
### request_queue_requests_get
|
|
|
|
- Operation ID: `request_queue_requests_get`
|
|
- Route: `GET /v2/request-queues/{queueId}/requests`
|
|
- Mode: READ
|
|
- Summary: List requests
|
|
- Parameters:
|
|
- `queueId` in `path` required
|
|
- `clientKey` in `query`
|
|
- `exclusiveStartId` in `query`
|
|
- `limit` in `query`
|
|
- `cursor` in `query`
|
|
- `filter` in `query`
|
|
|
|
### request_queue_requests_post
|
|
|
|
- Operation ID: `request_queue_requests_post`
|
|
- Route: `POST /v2/request-queues/{queueId}/requests`
|
|
- Mode: WRITE
|
|
- Summary: Add request
|
|
- Parameters:
|
|
- `queueId` in `path` required
|
|
- `clientKey` in `query`
|
|
- `forefront` in `query`
|
|
- Body: JSON request body accepted.
|
|
|
|
### request_queue_request_get
|
|
|
|
- Operation ID: `request_queue_request_get`
|
|
- Route: `GET /v2/request-queues/{queueId}/requests/{requestId}`
|
|
- Mode: READ
|
|
- Summary: Get request
|
|
- Parameters:
|
|
- `queueId` in `path` required
|
|
- `requestId` in `path` required
|
|
|
|
### request_queue_request_put
|
|
|
|
- Operation ID: `request_queue_request_put`
|
|
- Route: `PUT /v2/request-queues/{queueId}/requests/{requestId}`
|
|
- Mode: WRITE
|
|
- Summary: Update request
|
|
- Parameters:
|
|
- `queueId` in `path` required
|
|
- `requestId` in `path` required
|
|
- `forefront` in `query`
|
|
- `clientKey` in `query`
|
|
- Body: JSON request body accepted.
|
|
|
|
### request_queue_request_delete
|
|
|
|
- Operation ID: `request_queue_request_delete`
|
|
- Route: `DELETE /v2/request-queues/{queueId}/requests/{requestId}`
|
|
- Mode: WRITE
|
|
- Summary: Delete request
|
|
- Parameters:
|
|
- `queueId` in `path` required
|
|
- `requestId` in `path` required
|
|
- `clientKey` in `query`
|
|
|
|
### request_queue_head_get
|
|
|
|
- Operation ID: `request_queue_head_get`
|
|
- Route: `GET /v2/request-queues/{queueId}/head`
|
|
- Mode: READ
|
|
- Summary: Get head
|
|
- Parameters:
|
|
- `queueId` in `path` required
|
|
- `limit` in `query`
|
|
- `clientKey` in `query`
|
|
|
|
### request_queue_head_lock_post
|
|
|
|
- Operation ID: `request_queue_head_lock_post`
|
|
- Route: `POST /v2/request-queues/{queueId}/head/lock`
|
|
- Mode: WRITE
|
|
- Summary: Get head and lock
|
|
- Parameters:
|
|
- `queueId` in `path` required
|
|
- `lockSecs` in `query` required
|
|
- `limit` in `query`
|
|
- `clientKey` in `query`
|
|
|
|
### request_queue_request_lock_put
|
|
|
|
- Operation ID: `request_queue_request_lock_put`
|
|
- Route: `PUT /v2/request-queues/{queueId}/requests/{requestId}/lock`
|
|
- Mode: WRITE
|
|
- Summary: Prolong request lock
|
|
- Parameters:
|
|
- `queueId` in `path` required
|
|
- `requestId` in `path` required
|
|
- `lockSecs` in `query` required
|
|
- `clientKey` in `query`
|
|
- `forefront` in `query`
|
|
|
|
### request_queue_request_lock_delete
|
|
|
|
- Operation ID: `request_queue_request_lock_delete`
|
|
- Route: `DELETE /v2/request-queues/{queueId}/requests/{requestId}/lock`
|
|
- Mode: WRITE
|
|
- Summary: Delete request lock
|
|
- Parameters:
|
|
- `queueId` in `path` required
|
|
- `requestId` in `path` required
|
|
- `clientKey` in `query`
|
|
- `forefront` in `query`
|