GET /forensics/case_management/cases/{id}

Retrieves a case based on the supplied id.

Retrieves a case based on the supplied ID.

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

application/json

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

id

path

Required

Number (Integer)

text/plain

Required - The ID of the workflow job to retrieve.

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.

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

404

1002

No case was found for the provided ID.

500

1020

An error occurred during the retrieval of the case.

Response Description

A case that 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"
}