Description

Note: All requests in this article use the POST method type. 

• Monitoring the GMUS Queue
• Clearing the Queue by ID
• Checking the GMUS Queue History
• Run a Scenario from a secured request

Monitoring the GMUS Queue

You can monitor the GMUS queue with the following API request.

http://<ipAddress>:<portNumber>/rest/listQueue

http://<ipAddress>:8070/rest/listQueue

Clearing the GMUS Queue

http://<ipAddress>:<portNumber>/rest/clearQueue

Example: 

http://<ipAddress>:8070/rest/clearQueue

Clearing the Queue by ID

http://<ipAddress>:<portNumber>/rest/clearQueueById

Example:

http://<ipAddress>:8070/rest/112

Checking the GMUS Queue History

You can check the GMUS queue history with the following API request.  The history by default lasts for 3 hours only for a queue process. But the hours can be configured using a property historyDurationInHours from GMUS properties file.

http://<ipAddress>:<portNumber>/rest/listQueueHistory

http://<ipAddress>:8070/rest/listQueueHistory

{ 
   "queueId": 8
}

http://<ipAddress>:<portNumber>/rest/clearQueueHistory

http://<ipAddress>:8070/rest/clearQueueHistory

In order to run GMUS for secured requests, your request URL must have the domain, genrocket.com instead of localhost. If you are on Windows, you need to add the domain name in C:\Windows\System32\Drivers\etc\hosts file. If you are on Linux/Mac, you need to add the domain name in /etc/hosts file. You need to update line that starts with 127.0.0.1 to something like 

127.0.0.1 localhost test.genrocket.com

Run a Scenario from a secured request:

A secured REST request is made to the GMUS to run a Scenario on port 8443.  

• URL: https://test.genrocket.com:8443/rest/scenario
• Method Type: POST

Parameters (with example values):

{
  "clientAppId" : "XXXXXXXX-1e47-abcd-ba66-XXXXXXXXXXXX",
  "clientUserId": "XXXXXXXX-abcd-4284-aa45-XXXXXXXXXXXX",
  "username"    : "jane.doe@gmail.com",
  "scenario"    : "UserScenario.grs",
  "scenarioPath": "/home/jDoe/Download/output",
  "inMemory"    : false

}