v1

latestOpenAPI 3.1.0Apache 2.02026-07-17143043.7 KB

Querator V1

Complete leased items

Mark leased items as completed. The item can then be removed from the queue by Querator and will not be offered to any other consumers.

If any of the ids provided cannot be marked as completed then the entire request will be rejected with a code 453 Request Failed. It is the responsibility of the client to remove the offending id and try again.

Timeout Semantics

The call will return when the id(s) provided are completed to storage or when request_timeout has been reached. If the call returns with a non 200 response code, the client should consider the items provided as not completed to the queue. The client should NOT cancel the request before request_timeout has been reached. If the call fails to return after request_timeout is reached the client can safely cancel the request.

post/v1/queue.complete

Request body

queue_namestring required

The name of the queue these ids are from

partitioninteger required

The Partition these ids are from

request_timeoutstring required

The duration this request should block before the client will cancel the request

idsstring[] required

A list of the item ids to mark as complete

Response

codeinteger required

The response code

code_textstring

The text explanation of the code

messagestring

The message that contains details explaining the reason for the code