Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
 

GET /siem/offenses/{offense_id}/notes

Retrieve a list of notes for an offense.

Retrieve a list of notes for an offense.

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

MIME Type

application/json

Table 2: GET /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 retrieve the notes for.

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

HTTP Response Code

Unique Code

Description

200

 

The note list was retrieved.

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 the note list was being retrieved.

Response Description

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