Program Note

The gpp pnote command group manages program note creation, updates, retrieval, deletion, and restoration.

Use it to interact with program notes in the GPP database.

gpp pnote

 gpp pnote Usage: gpp pnote [OPTIONS] COMMAND [ARGS]... Manage program notes. ╭─ Options ────────────────────────────────────────────────────────────────────╮ │--helpShow this message and exit.│ ╰──────────────────────────────────────────────────────────────────────────────╯ ╭─ Commands ───────────────────────────────────────────────────────────────────╮ │list   Get all program notes.                                             │ │get    Get program note by ID.                                            │ │delete Delete a program note by ID.                                       │ │restoreRestore a program note by ID.                                      │ │create Create a new program note.                                         │ │update Update a program note by ID.                                       │ │schema Display the JSON Schema for the input properties.                  │ ╰──────────────────────────────────────────────────────────────────────────────╯

gpp pnote list

 gpp pnote list Usage: gpp pnote list [OPTIONS] Get all program notes. ╭─ Options ────────────────────────────────────────────────────────────────────╮ │--limitINTEGERMax number of results.│ │--include-deleted--no-include-deletedInclude deleted       │ │entries.              │ │[default:             │ │no-include-deleted]   │ │--helpShow this message and │ │exit.                 │ ╰──────────────────────────────────────────────────────────────────────────────╯

gpp pnote get

 gpp pnote get Usage: gpp pnote get [OPTIONS] PROGRAM_NOTE_ID Get program note by ID. ╭─ Arguments ──────────────────────────────────────────────────────────────────╮ │*program_note_idTEXTProgram note ID.[required]│ ╰──────────────────────────────────────────────────────────────────────────────╯ ╭─ Options ────────────────────────────────────────────────────────────────────╮ │--include-deleted--no-include-deletedInclude deleted entries.     │ │[default: no-include-deleted]│ │--helpShow this message and exit.│ ╰──────────────────────────────────────────────────────────────────────────────╯

gpp pnote delete

 gpp pnote delete Usage: gpp pnote delete [OPTIONS] PROGRAM_NOTE_ID Delete a program note by ID. ╭─ Arguments ──────────────────────────────────────────────────────────────────╮ │*program_note_idTEXTProgram note ID.[required]│ ╰──────────────────────────────────────────────────────────────────────────────╯ ╭─ Options ────────────────────────────────────────────────────────────────────╮ │--helpShow this message and exit.│ ╰──────────────────────────────────────────────────────────────────────────────╯

gpp pnote restore

 gpp pnote restore Usage: gpp pnote restore [OPTIONS] PROGRAM_NOTE_ID Restore a program note by ID. ╭─ Arguments ──────────────────────────────────────────────────────────────────╮ │*program_note_idTEXTProgram note ID.[required]│ ╰──────────────────────────────────────────────────────────────────────────────╯ ╭─ Options ────────────────────────────────────────────────────────────────────╮ │--helpShow this message and exit.│ ╰──────────────────────────────────────────────────────────────────────────────╯

gpp pnote create

 gpp pnote create Usage: gpp pnote create [OPTIONS] Create a new program note. Exactly one of --program-id, --proposal-reference, or --program-reference must be provided to identify the program. Supplying more than one (or none) will result in an error. ╭─ Options ────────────────────────────────────────────────────────────────────╮ │*--from-jsonPATHJSON file with the properties          │ │definition.                            │ │[required]                             │ │--program-idTEXTProgram ID (supply exactly one         │ │identifier).                           │ │--proposal-referenceTEXTProposal reference label (supply       │ │exactly one identifier).               │ │--program-referenceTEXTProgram label reference (supply exactly│ │one identifier).                       │ │--helpShow this message and exit.│ ╰──────────────────────────────────────────────────────────────────────────────╯

gpp pnote update

 gpp pnote update Usage: gpp pnote update [OPTIONS] PROGRAM_NOTE_ID Update a program note by ID. ╭─ Arguments ──────────────────────────────────────────────────────────────────╮ │*program_note_idTEXTProgram note ID to update.[required]│ ╰──────────────────────────────────────────────────────────────────────────────╯ ╭─ Options ────────────────────────────────────────────────────────────────────╮ │*--from-jsonPATHJSON file with the properties definition.│ │[required]                               │ │--helpShow this message and exit.│ ╰──────────────────────────────────────────────────────────────────────────────╯

gpp pnote schema

 gpp pnote schema Usage: gpp pnote schema [OPTIONS] Display the JSON Schema for the input properties. Use this when crafting or validating the JSON files passed with --from-json to the `create` or `update` commands. ╭─ Options ────────────────────────────────────────────────────────────────────╮ │--indentINTEGERIndentation level for pretty      │ │printing.                         │ │[default: 2]                      │ │--sort-keys--no-sort-keysSort object keys alphabetically.│ │[default: no-sort-keys]         │ │--helpShow this message and exit.│ ╰──────────────────────────────────────────────────────────────────────────────╯