Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 

POST /siem/offenses/{offense_id}/notes

 

Create a note on an offense.

Create a note on an offense.

Table 1: POST /siem/offenses/{offense_id}/notes Resource Details

MIME Type

application/json

Table 2: POST /siem/offenses/{offense_id}/notes Request Parameter Details

Parameter

Type

Optionality

Data Type

MIME Type

Description

offense_id

path

Required

Number (Integer)

text/plain

Required - The offense ID to add the note to.

note_text

query

Required

String

text/plain

Required - The note text.

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/offenses/{offense_id}/notes Response Codes

HTTP Response Code

Unique Code

Description

201

 

The note was created.

404

1002

No offense was found for the provided offense_id.

422

1005

A request parameter is not valid.

500

1020

An error occurred while attempting to create the note.

Response Description

The Note object that was created. A Note object contains the following fields:

  • id - Number - The ID of the note.

  • create_time - Number - The number of milliseconds since epoch when the note was created.

  • username - String - The user or authorized service that created the note.

  • note_text - String - The note text.

Response Sample