Skip to content

Implement --search-id support in orders request #388

Closed
@jreiberkyle

Description

@jreiberkyle

Blocked by #509

Implement support for the --search-id parameter in order creation in the orders API and CLI.

CLI Interface

Options:
 ...
  --search-id TEXT  ID of search from which to populate item IDs.
 ...

Usage (in CLI documentation and/or usage guide)

  When creating an order description from scratch, the following options are
  required: --name, --bundle, and one (and only one) of --id or --search-id.

 ...

  To create a clipped order using stdin:

  $ planet orders create \
      --name test_order \
      --bundle analytic \
      --id 20200922_183724_23_106a,20200922_183722_17_106a \
      --clip - < aoi.geojson

  Accomplishing the same thing but with a search id instead of item ids:

  $ planet orders create \
      --name test_order \
      --bundle analytic \
      --search-id 897802165e8d4bd587e342a4b399eda6 \
      --clip - < aoi.geojson

 ...
 
  Finally, it may be desirable to create a test order and, once satisfied,
  populate the order with item ids from a saved search. To do this, use --like
  and --search-id:

  $ planet orders create \
      --like 49b8d32e-2fba-4924-bd38-f7344aa48d91 \
      --search-id 897802165e8d4bd587e342a4b399eda6

Metadata

Metadata

Assignees

Labels

CLI/SDK InterfaceUpdate the CLI and SDK to the finalized interface

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions