Create tasking and catalog orders.
A class that represents the schema for the order parameters.
Attributes
| Attribute | Description |
|---|---|
dataProduct | str The data product ID. |
displayName | str A human-readable name that describes the order. |
params | Dict[str, Any] Order parameters. |
featureCollection | Dict[str, Any] A GeoJSON feature collection. |
tags | List[str] A list of tags that categorize the order. A tag can consist of letters, numbers, spaces, and special characters ( ., -, _, /, :). |
A class that represents an order in the system.
Examples
Python
order = up42.initialize_order(order_id="ea36dee9-fed6-457e-8400-2c20ebd30f44")
# Check order info
order.info
order.status
order.order_details
# Check whether it's fulfilled
order.is_fulfilled
order.track_status(report_time=150)
# Retrieve asset names
order.get_assets()
Functions
info
Retrieves the metadata of a specific order. Returns dict.
status
Retrieves the order status. Returns OrderStatus.
order_details
Retrieves the details of a specific tasking order. It doesn’t work with catalog orders. Returns dict.
is_fulfilled
Checks if the order is fulfilled. Returns bool:
True: the job has theFULFILLEDstatus.False: the job has any other status.
get_assets
Retrieves assets from orders that have FULFILLED or BEING_FULFILLED statuses. Returns List[asset.Asset].
Use this function to retrieve multiple assets from the same order. To search across all assets in your storage, use the get_assets function from the Storage class.
track_status
Tracks the order status by retrying until the status changes to FULFILLED or FAILED_PERMANENTLY. It will query the order every 120 seconds. Returns str.
| Parameter | Description |
|---|---|
report_time | float An interval between queries, in seconds. The default value is 120. |