Skip to main content
GET
/
api
/
cases
/
{id}
{
  "id": 123,
  "ageing": 123,
  "priority": 123,
  "case_status_order": 123,
  "alert_date": "<string>",
  "alert_risk_rating": "HIGH",
  "assignee": {
    "id": 123,
    "name": "<string>"
  },
  "bucket": {
    "id": 123,
    "name": "<string>"
  },
  "case_action": "<string>",
  "case_status": "<string>",
  "case_subjects": {
    "subject_1": {
      "id": 123,
      "name": "<string>",
      "client_subject_id": "<string>"
    },
    "subject_2": {
      "id": 123,
      "name": "<string>",
      "client_subject_id": "<string>"
    }
  },
  "created_on": "<string>",
  "rule": 123,
  "active_timestamp": "2023-11-07T05:31:56Z"
}
Users can view relevant information ranging from its bucket, rule parameters and audit trail of the case actions for a specific case by specifying the id of the case on the API.

Authorizations

Authorization
string
header
required

JWT token obtained from AWS Cognito or custom authentication service

Path Parameters

id
integer
required

A unique integer value identifying this case.

Response

200 - application/json

Case retrieved successfully.

Case object with all details

id
integer
required

Case ID

case_status
string
required

Current case status

ageing
integer

Days since case creation

priority
integer

Case priority level

case_status_order
integer

Internal case status order

alert_date
string

Alert date timestamp

alert_risk_rating
enum<string>

Risk rating

Available options:
HIGH,
MEDIUM,
LOW,
Unrated
assignee
object

Case assignee information

bucket
object

Bucket information

case_action
string

Last action taken on case

case_subjects
object

Case subjects information

created_on
string

Case creation date

rule
integer

Rule number ID that triggered the case

active_timestamp
string<date-time>

When case became active