Security Timeline API
Add or update a note
Spaces method and path for this operation:
<div><span class="operation-verb patch">patch</span> <span class="operation-path">/s/{space_id}/api/note</span></div>Refer to Spaces for more information.
Creates a new note or updates an existing one.
Create: Send note and omit noteId to create a new saved object.
Update: Send note with the changed fields and set noteId to the note's saved object ID. Optionally include version for optimistic concurrency when the client has it from a prior read.
Requires the Timeline and Notes write privilege (notes_write).
patch/api/note
Request body
Example request
{
"note": {
"created": 1587468588922,
"createdBy": "casetester",
"updated": 1741344876825,
"updatedBy": "casetester",
"eventId": "d3a1d35a3e84a81b2f8f3859e064c224cdee1b4bc",
"note": "This is an example text",
"timelineId": "15c1929b-0af7-42bd-85a8-56e234cc7c4e"
},
"noteId": "709f99c6-89b6-4953-9160-35945c8e174e",
"version": "WzQ2LDFd"
}Response
The persisted note, including noteId and version.
Example response
{
"note": {
"created": 1587468588922,
"createdBy": "casetester",
"updated": 1741344876825,
"updatedBy": "casetester",
"eventId": "d3a1d35a3e84a81b2f8f3859e064c224cdee1b4bc",
"note": "This is an example text",
"timelineId": "15c1929b-0af7-42bd-85a8-56e234cc7c4e",
"noteId": "709f99c6-89b6-4953-9160-35945c8e174e",
"version": "WzQ2LDFd"
}
}