Add or update a note
https://{kibana_url}
- PATCH /api/note
- PATCH /s/{space_id}/api/note
Refer to Spaces for more information.
Add a note to a Timeline or update an existing note.
Request
The note to add or update, along with additional metadata.
-
note -
creatednumbernullable -
The time the note was created, using a 13-digit Epoch timestamp.
-
createdBystringnullable -
The user who created the note.
-
updatednumbernullable -
The last time the note was updated, using a 13-digit Epoch timestamp
-
updatedBystringnullable -
The user who last updated the note
-
eventIdstringnullable -
The
_idof the associated event for this note. -
notestringnullable -
The text of the note
-
timelineIdstringrequired -
The
savedObjectIdof the Timeline that this note is associated with -
noteIdstringnullable -
The
savedObjectIdof the note -
versionstringnullable -
The version of the note
Response
Indicates the note was successfully created.
-
dataobjectrequired -
persistNote -
codenumberrequired -
messagestringrequired -
note -
creatednumbernullable -
The time the note was created, using a 13-digit Epoch timestamp.
-
createdBystringnullable -
The user who created the note.
-
updatednumbernullable -
The last time the note was updated, using a 13-digit Epoch timestamp
-
updatedBystringnullable -
The user who last updated the note
-
eventIdstringnullable -
The
_idof the associated event for this note. -
notestringnullable -
The text of the note
-
timelineIdstringrequired -
The
savedObjectIdof the Timeline that this note is associated with -
noteIdstringrequired -
The
savedObjectIdof the note -
versionstringrequired -
The version of the note