GET /forensics/case_management/cases

Retrieves a list of cases.

Retrieves a list of cases.

Table 1. GET /forensics/case_management/cases resource details
MIME Type

application/json

Table 2. GET /forensics/case_management/cases request parameter details
Parameter Type Optionality Data Type MIME Type Description

fields

query

Optional

String

text/plain

Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas.

filter

query

Optional

String

text/plain

Optional - This parameter is used to restrict the elements in a list base on the contents of various fields.

Range

header

Optional

String

text/plain

Optional - Use this parameter to restrict the number of elements that are returned in the list to a specified range. The list is indexed starting at zero.

Table 3. GET /forensics/case_management/cases response codes
HTTP Response Code Unique Code Description

200

The cases were retrieved.

500

1020

An error occurred during the retrieval of the case list.

Response Description

A list of cases. A case contains the following fields:
  • assigned_to - String Array - Usernames of the users who have access to the case. Users must have the FORENSICS role. Authorized services are not allowed.
  • id - Long - ID for the case.
  • name - String - The name of the case.

Response Sample


[
    {
        "assigned_to": [
            "String"
        ],
        "id": 42,
        "name": "String"
    }
]