Get filtered issue statistics

GET /cs-close-api/issue-stats

This API will generate a list of issues Statistics, relying on the Entity and UserName obtained from authentication details, as well as the close period Id.

Query parameters

  • statsSearchCriteria object Required
    Hide statsSearchCriteria attributes Show statsSearchCriteria attributes object
    • name string

      If you specify name as a search criterion, it will include all search results which contains specified name. NOTE: It will not work only as exact match.

    • status string

      Close search filter based on the status enum as per defined values.

      Values are ACTIVE, INACTIVE, DISABLED, NOT_STARTED, IN_PROGRESS, COMPLETE, or DELETED.

    • entityId integer(int32) Required

      periodId for filtering Stats based on specific entity.

    • periodId integer(int32) Required

      periodId for filtering Stats based on specific period.

    • bsoLevels array[string]

      Optional list of BSO levels for filtering.

Responses

GET /cs-close-api/issue-stats 
curl \
 --request GET 'http://close-service:8082/cs-close-api/issue-stats?statsSearchCriteria=%7B%7D'
Response examples (200) 
{
  "complete": {
    "count": 42,
    "criticalCount": 42,
    "routineCount": 42,
    "ids": [
      42
    ],
    "criticalIds": [
      42
    ],
    "routineIds": [
      42
    ]
  },
  "inprocess": {
    "count": 42,
    "criticalCount": 42,
    "routineCount": 42,
    "ids": [
      42
    ],
    "criticalIds": [
      42
    ],
    "routineIds": [
      42
    ]
  },
  "late": {
    "count": 42,
    "criticalCount": 42,
    "routineCount": 42,
    "ids": [
      42
    ],
    "criticalIds": [
      42
    ],
    "routineIds": [
      42
    ]
  }
}
Response examples (400) 
{
  "statusCode": "string",
  "code": "string",
  "message": "string",
  "referenceId": "string",
  "details": {
    "localizedMessage": "string"
  }
}
Response examples (500) 
{
  "statusCode": "string",
  "code": "string",
  "message": "string",
  "referenceId": "string",
  "details": {
    "localizedMessage": "string"
  }
}