Create, update and delete several notes of a scenario in one request.
This route is not a batched equivalent of the single-note methods. Entries in create are
sent with an empty metadata object when none is given, because the route stores the value
verbatim and fails with a server error when it is absent. Entries in update replace rather
than merge, which is why BatchScenarioNotesUpdate requires content and moduleIds.
The scenario ID to apply the changes to
The notes to create, update and delete
The created and updated notes and the IDs of the deleted ones
Create a new note in a scenario.
The scenario ID to create the note in
The note to create
The created note
Delete a scenario note.
The scenario ID the note belongs to
The note ID to delete
ID of the deleted note
Get a single scenario note.
The scenario ID the note belongs to
The note ID to get
The requested note
List all notes of a scenario.
The scenario ID to list notes for
The scenario's notes, sorted by ID in descending order
Update a scenario note. Any property that is not provided is left unchanged.
The scenario ID the note belongs to
The note ID to update
The properties to update
The updated note
Class providing methods for working with scenario notes.
Every method is scoped by the parent scenario ID. The
teamIdandorganizationIdquery parameters documented for these endpoints are never read by the API, so they are not offered.Note content must be HTML
contentis stored and rendered as HTML. The API keeps whatever string it is given, minus any tags the server-side sanitizer strips, and performs no Markdown conversion — Markdown syntax therefore survives the round trip untouched and shows up on the scenario canvas as the literal characters###,**and`rather than as formatting. Send HTML:Converting Markdown (or anything else) to HTML is the caller's job; this SDK passes
contentthrough unchanged in both directions.