Get Case details

GET 
/cases/:caseId

Returns a Case; available as an Add-On Module

Request

Path Parameters

caseId stringrequired

Case Identifier

Query Parameters

siteId string

Site Identifier

Responses

200

200 OK

Response Headers

• Access-Control-Allow-Origin

  string

• Access-Control-Allow-Methods

  string

• Access-Control-Allow-Headers

  string

application/json

Schema

Schema

case

object

caseId string

Case Identifier

caseNumber string

Case Number

documentNumber string

Document Number

plannedStartDate string

Planned Start Date

startDate string

Start Date

endDate string

End Date

dueDate string

Due Date

insertedDate string

Inserted Timestamp

name string

Case Name

description string

Case Description

metadata

object

status CaseStatus (string)

Status of the Case

Possible values: [NEW, ASSIGNED, IN_PROGRESS, ON_HOLD, ESCALATED, RESOLVED, CLOSED, UNDER_REVIEW, AWAITING_CLIENT_RESPONSE]

userId string

User who added document

Example (from schema)

{
  "case": {
    "caseId": "string",
    "caseNumber": "string",
    "documentNumber": "string",
    "plannedStartDate": "string",
    "startDate": "string",
    "endDate": "string",
    "dueDate": "string",
    "insertedDate": "string",
    "name": "string",
    "description": "string",
    "metadata": {},
    "status": "NEW",
    "userId": "string"
  }
}

Loading...