Skip to content

Replace a note, linking the new one to it

POST
/v1/note/{id}/supersede
curl --request POST \
--url http://localhost:8090/v1/note/example/supersede \
--header 'Content-Type: application/json' \
--data '{ "text": "example", "tag": "finding", "actor": "example", "nodeIds": [ "example" ], "sessionId": "example" }'

Not idempotent: every call creates a new note. Only the note’s author (or an org admin) may supersede it.

id
required
string
Media typeapplication/json
object
text
required
string
tag
string
default: note
Allowed values: finding decision reminder note
actor
string
nodeIds
Array<string>
sessionId

Session name or id

string

The old note’s id and the new note

Media typeapplication/json
object
status
string
Allowed values: superseded
oldNoteId
string
newNote
object
id
required
string
text
required
string
tag
required
string
actor
string
nullable
nodeIds
required
Array<string>
at
required

ISO timestamp

string
stale
required
boolean
staleReason
string
nullable

Example

{
"status": "superseded"
}