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/{note_id}

SUMMARY Retrieve a note for an offense.

Retrieve a note for an offense.

Table 1: GET /siem/offenses/{offense_id}/notes/{note_id} resource details:

GET /siem/offenses/{offense_id}/notes/{note_id} resource details

MIME Type

application/json

Table 2: GET /siem/offenses/{offense_id}/notes/{note_id} request parameter details:

GET /siem/offenses/{offense_id}/notes/{note_id} 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 note from.

note_id

path

Required

Number (Integer)

text/plain

Required - The note 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/offenses/{offense_id}/notes/{note_id} response codes:

GET /siem/offenses/{offense_id}/notes/{note_id} response codes

HTTP Response Code Unique Code Description

200

The note was retrieved.

404

1002

No offense was found for the provided offense_id.

404

1003

No note was found for the provided note_id.

422

1005

A request parameter is not valid.

500

1020

An error occurred while attempting to retrieve the note.

Response Description

The Note object for the note ID. 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