Gets the status of a tenant.

These are the endpoints for obtaining the status of a particular tenant.

Request

 GET 
 {applicationURL}/reltio/status/tenant/<tenantID>

Request

GET 
 {applicationURL}/reltio/status/tenant/<tenantID>?details=all

Table 1. Parameters

Parameters	Name	Required	Description
Headers	ContentType	Yes	Should be Content-Type:application/json.
Query	details	No	This is the detailed tenant status. Possible values are "short" and "all". The default is "short".

Response

{  
   "Status":"Green",
   "IsExternalQueue":false,
   "Events queue size":0,
   "Matching queue size":0
}

Response

"Detailed tenant status" (details=all)

Example

{
    "Events queue details": {},
    "Matching queue details": {},
    "Recent update time": <TIMESTAMP1>,
    "All background checks are finished for changes until": <TIMESTAMP2>
    "Status": "Green",
    "IsExternalQueue": true,
    "Events queue size": 0,
    "Matching queue size": 0
}

• TIMESTAMP1: time of latest update in tenant.
• TIMESTAMP2: a background process for determining the right border of the time interval that was specified for tenant consistency checks.

TIMESTAMP2 < TIMESTAMP1 means that there are some updates in the tenant which are not checked by background consistency checks. In this case, the status becomes "YELLOW", which in turn means that not all background processes are finished and there are possible temporary inconsistencies.

Refer to Tenant Consistency Definition for detailed explanations of the fields for "Recent update time" and "All background checks are finished for changes until" and how these fields affect determining tenant status.