Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
ON THIS PAGE
 

GET /siem/offense_closing_reasons/{closing_reason_id}

SUMMARY Retrieve an offense closing reason.

Retrieve an offense closing reason.

Table 1: GET /siem/offense_closing_reasons/{closing_reason_id} resource details:

GET /siem/offense_closing_reasons/{closing_reason_id} resource details
MIME Type

application/json

Table 2: GET /siem/offense_closing_reasons/{closing_reason_id} request parameter details:

GET /siem/offense_closing_reasons/{closing_reason_id} request parameter details
Parameter Type Optionality Data Type MIME Type Description

closing_reason_id

path

Required

Number (Integer)

text/plain

Required - The closing reason ID.

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 /siem/offense_closing_reasons/{closing_reason_id} response codes:

GET /siem/offense_closing_reasons/{closing_reason_id} response codes
HTTP Response Code Unique Code Description

200

The closing reason was retrieved.

404

1002

No closing reason was found for the provided closing_reason_id.

422

1005

A request parameter is not valid.

500

1020

An error occurred while attempting to retrieve the closing reason.

Response Description

A ClosingReason object. A closing reason object contains the following fields:
  • id - Number - The ID of the closing reason.
  • text - String - The text of the closing reason.
  • is_deleted - Boolean - Determines whether the closing reason is deleted. Deleted closing reasons cannot be used to close an offense.
  • is_reserved - Boolean - Determines whether the closing reason is reserved. Reserved closing reasons cannot be used to close an offense.

Response Sample