Target

The gpp target command group manages target creation, updates, retrieval, deletion, and restoration.

Use it to interact with targets in the GPP database.

gpp target

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

gpp target list

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

gpp target get

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

gpp target delete

 gpp target delete Usage: gpp target delete [OPTIONS] TARGET_ID Delete a target by ID. ╭─ Arguments ──────────────────────────────────────────────────────────────────╮ │*target_idTEXTTarget ID.[required]│ ╰──────────────────────────────────────────────────────────────────────────────╯ ╭─ Options ────────────────────────────────────────────────────────────────────╮ │--helpShow this message and exit.│ ╰──────────────────────────────────────────────────────────────────────────────╯

gpp target restore

 gpp target restore Usage: gpp target restore [OPTIONS] TARGET_ID Restore a target by ID. ╭─ Arguments ──────────────────────────────────────────────────────────────────╮ │*target_idTEXTTarget ID.[required]│ ╰──────────────────────────────────────────────────────────────────────────────╯ ╭─ Options ────────────────────────────────────────────────────────────────────╮ │--helpShow this message and exit.│ ╰──────────────────────────────────────────────────────────────────────────────╯

gpp target create

 gpp target create Usage: gpp target create [OPTIONS] Create a new target. 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 target update

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

gpp target clone

 gpp target clone Usage: gpp target clone [OPTIONS] Clone a target by ID. ╭─ Options ────────────────────────────────────────────────────────────────────╮ │*--target-idTEXTTarget ID to clone.[required]│ │*--from-jsonPATHJSON file with the properties definition for the│ │new target.                                     │ │[required]                                      │ │--helpShow this message and exit.│ ╰──────────────────────────────────────────────────────────────────────────────╯

gpp target schema

 gpp target schema Usage: gpp target 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.│ ╰──────────────────────────────────────────────────────────────────────────────╯