Add or update a note

PATCH /api/note
Api key auth Basic auth

Add a note to a Timeline or update an existing note.

application/json

Body Required

The note to add or update, along with additional metadata.

  • note object Required
    Hide note attributes Show note attributes object
    • created number | null

      The time the note was created, using a 13-digit Epoch timestamp.

    • createdBy string | null

      The user who created the note.

    • updated number | null

      The last time the note was updated, using a 13-digit Epoch timestamp

    • updatedBy string | null

      The user who last updated the note

    • eventId string | null

      The _id of the associated event for this note.

    • note string | null

      The text of the note

    • timelineId string Required

      The savedObjectId of the Timeline that this note is associated with

  • noteId string | null

    The savedObjectId of the note

  • version string | null

    The version of the note

Responses

  • 200 application/json

    Indicates the note was successfully created.

    Hide response attribute Show response attribute object
    • note object Required
      Hide note attributes Show note attributes object
      • created number | null

        The time the note was created, using a 13-digit Epoch timestamp.

      • createdBy string | null

        The user who created the note.

      • updated number | null

        The last time the note was updated, using a 13-digit Epoch timestamp

      • updatedBy string | null

        The user who last updated the note

      • eventId string | null

        The _id of the associated event for this note.

      • note string | null

        The text of the note

      • timelineId string Required

        The savedObjectId of the Timeline that this note is associated with

      • noteId string Required

        The savedObjectId of the note

      • version string Required

        The version of the note
PATCH /api/note 
curl \
 --request PATCH 'https://localhost:5601/api/note' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"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"}'
Request examples 
{
  "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 examples (200) 
{
  "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"
  }
}