7 Stats Resources

The stats resources contain the following APIs:

GET /stats
GET /stats/metadata
GET /stats/resources

7.1 GET /stats

This API is used to get stats REST API versioning information.

Request URI

http(s)://<server>:<port>/ohmpi-rm/1.0.0/stats

Request Type

HTTP GET

Response Content Type

application/json;charset=UTF-8

Response Parameters

Parameter	Description
version	OHMPI RM version number
description	The description of stats resources
url	The URL of this REST API

Response Status Code

Status Code	Description
200	Success
404	Incorrect URI

Sample Request URI

http://localhost:7001/ohmpi-rm/1.0.0/stats

Sample Response Body

{
  "version": "1.0.0",
  "description": "OHMPI RM Stats Resources",
  "url": "http://localhost:7001/ohmpi-rm/1.0.0/stats"
}

Sample Response Code

200

7.2 GET /stats/metadata

This API is used to get metadata stats information, such as active and inactive count of entity types, relationship types, rulesets, tasks, and domains.

Request URI

http(s)://<server>:<port>/ohmpi-rm/1.0.0/stats/metadata

Request Type

HTTP GET

Response Content Type

application/json;charset=UTF-8

Response Parameters

Parameter	Description
totalActiveEntityTypes	Number of Active Entity Types in RM
totalInactiveEntityTypes	Number of Inactive Entity Types in RM
totalActiveRelationshipTypes	Number of Active Relationship Types in RM
totalInactiveRelationshipTypes	Number of Inactive Relationship Types in RM
totalActiveRulesets	Number of Active Rulesets Types in RM
totalInactiveRulesets	Number of Inactive Rulesets Types in RM
totalActiveTasks	Number of Active Tasks in RM
totalInactiveTasks	Number of Inactive Tasks in RM
totalDomains	Number of Domains in RM
links	Provides information of REST API invoked. For more information, see Section A.3, "Links".

Response Status Code

Status Code	Description
200	Success
404	Incorrect URI
500	Error while processing

Sample Request URI

http://localhost:7001/ohmpi-rm/1.0.0/stats/metadata

Sample Response Body

{
  "links": [
    {
      "href": "/ohmpi-rm/1.0.0/stats/metadata",
      "mediaType": "application/json",
      "rel": "canonical"
    }
  ],
  "totalActiveEntityTypes": 6,
  "totalActiveRelationshipTypes": 10,
  "totalActiveRulesets": 1,
  "totalActiveTasks": 1,
  "totalDomains": 3,
  "totalInactiveEntityTypes": 0,
  "totalInactiveRelationshipTypes": 0,
  "totalInactiveRulesets": 0,
  "totalInactiveTasks": 0
}

Sample Response Code

200

7.3 GET /stats/resources

This API is used to get resources stats information, such as active and inactive count of entity, relationship, potential or resolved relationships, and transactions (last 30 days).

Request URI

http(s)://<server>:<port>/ohmpi-rm/1.0.0/stats/resources

Request Type

HTTP GET

Response Content Type

application/json;charset=UTF-8

Response Parameters

Parameter	Description
totalActiveEntities	Number of Active Entities in RM
totalInactiveEntities	Number of Inactive Entities in RM
totalActiveRelationships	Number of Active Relationships in RM
totalInactiveRelationships	Number of Inactive Relationships in RM
totalPotentialRelationships	Number of Relationships with validity=Potential in RM
totalResolvedRelationships	Number of Relationships with validity=Resolved in RM
totalTransactionsLastMonth	Number of Transactions (Create, Update, Activate, or Deactivate) in last 30 days
links	Provides information of REST API invoked. For more information, see Section A.3, "Links".

Response Status Code

Status Code	Description
200	Success
404	Incorrect URI
500	Error while processing

Sample Request URI

http://localhost:7001/ohmpi-rm/1.0.0/stats/resources

Sample Response Body

{
  "links": [
    {
      "href": "/ohmpi-rm/1.0.0/stats/resources",
      "mediaType": "application/json",
      "rel": "canonical"
    }
  ],
  "totalActiveEntities": 31,
  "totalActiveRelationships": 85,
  "totalInactiveEntities": 20,
  "totalInactiveRelationships": 32,
  "totalPotentialRelationships": 37,
  "totalResolvedRelationships": 80,
  "totalTransactionsLastMonth": 184
}

Sample Response Code

200