Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 

GET /siem/offense_closing_reasons

 

Retrieve a list of all offense closing reasons.

Retrieve a list of all offense closing reasons.

Table 1: GET /siem/offense_closing_reasons Resource Details

MIME Type

application/json

Table 2: GET /siem/offense_closing_reasons Request Parameter Details

Parameter

Type

Optionality

Data Type

MIME Type

Description

include_reserved

query

Optional

Boolean

text/plain

Optional - If true, reserved closing reasons are included in the response. Defaults to false. Reserved closing reasons cannot be used to close an offense.

include_deleted

query

Optional

Boolean

text/plain

Optional - If true, deleted closing reasons are included in the response. Defaults to false. Deleted closing reasons cannot be used to close an offense.

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.

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.

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 Response Codes

HTTP Response Code

Unique Code

Description

200

 

The closing reasons list was retrieved.

500

1020

An error occurred while the closing reasons list was being retrieved.

Response Description

An array of ClosingReason objects. 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