Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
 

POST /siem/offense_closing_reasons

Create an offense closing reason.

Create an offense closing reason.

Table 1: POST /siem/offense_closing_reasons Resource Details

MIME Type

application/json

Table 2: POST /siem/offense_closing_reasons Request Parameter Details

Parameter

Type

Optionality

Data Type

MIME Type

Description

reason

query

Required

String

text/plain

Required - The text of the offense closing reason must be 5 - 60 characters in length.

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: POST /siem/offense_closing_reasons Response Codes

HTTP Response Code

Unique Code

Description

201

 

The closing reason was created.

409

1004

The closing reason already exists.

422

1005

A request parameter is not valid.

500

1020

An error occurred while attempting to create 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