Description

G-Repository related requests to GMUS are added to a queue to ensure that only one G-Repository request is handled at a time. This is a separate queue that has been created for tracking of G-Repository related requests only. The method type for these requests is POST.


How does the queue work? 

  1. The request is added to the GMUS G-Repo queue.
  2. After a few seconds, the request is picked from the queue for processing.
  3. The request is processed (e.g., Scenario, Scenario Chain, Scenario Chain Set, G-Rule, G-Story, etc.)
  4. After processing has been completed, the request is moved into a history table. This table is for tracking what requests have been sent to GMUS.


Who can use these API endpoints? 

  • Any user can use these API endpoints to manage requests in the queue.


When should these API endpoints be used? 

  • Any time a user needs to monitor or clear records in the queue and queue history tables. 
    • Records in Queue - Pending requests that have not been processed yet.
    • Records in Queue History - Requests processed with either a success or failure status.


GMUS G-Repo Queue API Requests


Monitoring the GMUS G-Repo Queue

You can monitor the GMUS G-Repo queue with the following API request.

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


Example: 

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


Clearing the GMUS G-Repo Queue

You can clear the GMUS G-Repo queue with the following API request: 

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


Text

Example: 

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


Clearing the GMUS G-Repo Queue by ID

You can clear the GMUS G-Repo queue by ID with the following API request: 


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


Text

Example:

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


With JSON request payload containing the ID


{id: 112}


Checking the GMUS G-Repo Queue History

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


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


Example: 

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


HTML

To check the queue history for a particular queue Id, you need to pass queueId as a parameter:


{ 
   "queueId": 8
}


Generic

Clearing the GMUS G-Repo Queue History

You can clear the GMUS G-Repo queue history with the following API request:


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


Example: 

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


HTML