Get filtered issue statistics

GET /cs-close-api/issue-stats
Oidc Oauth2

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

  • 200 application/json

    API to get Stats based on Entity, UserName, ClosePeriodId

    Hide response attributes Show response attributes object
    • complete object
      Hide complete attributes Show complete attributes object
      • count integer(int32)
      • criticalCount integer(int32)
      • routineCount integer(int32)
      • ids array[integer]
      • criticalIds array[integer]
      • routineIds array[integer]
    • inprocess object
      Hide inprocess attributes Show inprocess attributes object
      • count integer(int32)
      • criticalCount integer(int32)
      • routineCount integer(int32)
      • ids array[integer]
      • criticalIds array[integer]
      • routineIds array[integer]
    • late object
      Hide late attributes Show late attributes object
      • count integer(int32)
      • criticalCount integer(int32)
      • routineCount integer(int32)
      • ids array[integer]
      • criticalIds array[integer]
      • routineIds array[integer]
  • 400 application/json

    Invalid data requested. Error Code(s): [CLOSE_INVALID_STATS]

    Hide response attributes Show response attributes object
    • statusCode string
    • code string
    • message string
    • referenceId string
    • details object
      Hide details attribute Show details attribute object
      • localizedMessage string
  • 500 application/json

    System Error. Error Code(s): [CLOSE_DATA_STATS_ERROR, CLOSE_APP_STATS_ERROR]

    Hide response attributes Show response attributes object
    • statusCode string
    • code string
    • message string
    • referenceId string
    • details object
      Hide details attribute Show details attribute object
      • localizedMessage string
GET /cs-close-api/issue-stats 
curl \
 --request GET 'https://customer.trintech.com/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"
  }
}