(Glue-2108) v3.1 Clean up Queue
- SNP
- Robert Adamec
POST /queues/cleanup endpoint allows the client to clean up the already processed packages from Queue cluster storage. It supports the following input parameters:
Parameter name | Description | Usage | Type |
|---|---|---|---|
queueID | Glue Queue ID (FIFO consumer name) | Mandatory | JSON array object |
All input parameters are case insensitive.
Example of REST API call:
POST | http://servername:portnumber/dvd/glue/api/v3_1/queues/cleanup?sap-client=clientnumber |
|---|
JSON body:
{
"queueID": "ZTEST_SFLIGHT_Q"
}Possible responses:
204 | No data for clean up in Queue. |
|---|---|
200 | Clean up successful. Packages deleted from Queue: 10 |
Functionality is implemented in the SAP class /DVD/GL_EXT2_API_QUE_CLN_V3_1
Error handling
Every error message is raised via code 400. The reason for the error is also provided; however further investigation might be needed on the SAP side.