Type Alias UpdateScenarioNoteBody

Parameters for updating a scenario note. Any property that is not provided is left unchanged.

type UpdateScenarioNoteBody = {
    content?: string;
    isFilterNote?: boolean;
    metadata?: ScenarioNoteMetadata;
    moduleIds?: number[];
}

Properties

content?: string

New content of the note as HTML. Markdown is not rendered — see ScenarioNotes

isFilterNote?: boolean

Whether the note documents a filter rather than a module

New presentation metadata of the note. Replaces the existing metadata

moduleIds?: number[]

New set of module IDs the note is anchored to. Replaces the existing set