Jump to

• Request
• Response
• Examples

Get list of cases

get

/PASService/rest/services/cases

Retrieve a list of cases

Request

Query Parameters

• expand(optional): string
  expand policies
• q(optional): string
  Search Parameter

Back to Top

Response

Supported Media Types

• application/json

200 Response

successful operation

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

Back to Top

Examples

This example describes how to get a list of cases.

Example cURL Command

Use the following cURL command to submit a request on the REST resource:

curl -X GET -H "Accept: application/json" -u username:password "server:port/PASService/rest/services/cases"

Example Response Body

The following shows an example of the response body in JSON format:

"{
  "count" : 41,
  "offset" : 0,
  "limit" : 100,
  "cases" : [ {
    "links" : [ {
      "href" : "http://server:port/PASService/rest/services/cases/294DBD01-5B14-43A3-9A5B-4C309EA848C0",
      "rel" : "self",
      "mediaType" : "application/json",
      "method" : "GET"
    }, {
      "href" : "http://server:port/PASService/rest/services/cases/294DBD01-5B14-43A3-9A5B-4C309EA848C0/policies",
      "rel" : "policies",
      "mediaType" : "application/json",
      "method" : "GET"
    }, {
      "href" : "http://server:port/PASService/rest/services/codes?codeName=CaseStatus&codeValue=02",
      "rel" : "codes/status",
      "mediaType" : "application/json",
      "method" : "GET"
    } ],
    "caseName" : "Case_Name_API_11",
    "caseNumber" : "Case_Name_API_11",
    "creationDate" : "2019-08-06T00:00:00Z",
    "policies" : [ {
      "links" : [ {
        "href" : "http://server:port/PASService/rest/services/cases/294DBD01-5B14-43A3-9A5B-4C309EA848C0/policies/808FE0DF-4C4A-4D05-8925-FD13E6DAB7AC",
        "rel" : "self",
        "mediaType" : "application/json",
        "method" : "GET"
      } ]
    }, {
      "links" : [ {
        "href" : "http://server:port/PASService/rest/services/cases/294DBD01-5B14-43A3-9A5B-4C309EA848C0/policies/BF647EC8-16C0-420B-99EB-4534F3ED2456",
        "rel" : "self",
        "mediaType" : "application/json",
        "method" : "GET"
      } ]
    } ],
    "caseId" : "294DBD01-5B14-43A3-9A5B-4C309EA848C0",
    "companyId" : "7204C2FE-13B1-4A48-8CDA-DE8386C60EF9",
    "status" : "02",
    "updatedDateTime" : "2020-01-06T16:38:53Z",
    "CaseNotes" : {
      "string" : "Test"
    },
    "CaseDetails" : "Case_Name_API_03",
    "Identifier001" : "Identifier8907546"
  }
"

Back to Top