Type Alias CreateScenarioNoteBody

Parameters for creating a new scenario note. Every property is optional; posting an empty body creates an empty note.

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

Properties

content?: string

Content of the note as HTML, for example <p>text</p>. Markdown is not rendered — see ScenarioNotes

isFilterNote?: boolean

Whether the note documents a filter rather than a module

Presentation metadata of the note

moduleIds?: number[]

IDs of the scenario modules to anchor the note to