(Glue-2208) Clean up Queue

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

Parameter name

Description

Usage

Type

queueID

SNP 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/queues/cleanup?sap-client=800 

POST

http://servername:portnumber/dvd/glue/api/v3/queues/cleanup?sap-client=800 

JSON body: 

{ "queueID": "ZTR_CUSTOMER_FIFO_C" }

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_QUEUE_CLEANUP

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.