Order new geospatial data to be captured over a specific area and at a given time.
Constants
| Constant | Description | Value |
|---|---|---|
Geometry | Geometry types. | Union[catalog.Geometry, geom.Point] |
QuotationDecision | An acceptable decision for a not decided quotation. | Literal["ACCEPTED", "REJECTED"] |
QuotationStatus | Decision statuses for quotations. | Union[Literal["NOT_DECIDED"], QuotationDecision] |
FeasibilityStatus | Decision statuses for feasibility studies. | Literal["NOT_DECIDED", "ACCEPTED"] |
A class that enables access to the tasking functionality. This class also inherits functions from the CatalogBase class.
Functions
Constructs an order form for a specific data product. Returns order.OrderParams.
| Parameter | Description |
|---|---|
data_product_id | str The data product ID. |
name | str The order name. |
acquisition_start | Union[str, datetime.datetime] The start date of the acquisition period in the YYYY-MM-DD format. |
acquisition_end | Union[str, datetime.datetime] The end date of the acquisition period in the YYYY-MM-DD format. |
geometry | Geometry The order geometry. |
tags | Optional[List[str]] A list of tags that categorize the order. |
Python
tasking = up42.initialize_tasking()
tasking.construct_order_parameters(
data_product_id="123eabab-0511-4f36-883a-80928716c3db",
name="PNeo tasking order",
acquisition_start="2023-11-01",
acquisition_end="2023-12-20",
geometry = {
"type": "Polygon",
"coordinates": (
(
(13.375966, 52.515068),
(13.375966, 52.516639),
(13.378314, 52.516639),
(13.378314, 52.515068),
(13.375966, 52.515068),
),
),
},
tags=["project-7", "optical"],
)
Retrieves quotations for tasking orders. Returns list[dict].
| Parameter | Description |
|---|---|
quotation_id | Optional[str] The quotation ID. |
workspace_id | Optional[str] The workspace ID. Use to get quotations from a specific workspace. Otherwise, quotations from the entire account will be returned. |
order_id | Optional[str] The order ID. |
decision | Optional[List[QuotationStatus]] The status of quotations. |
sortby | str Arranges elements in the order specified in descending based on a chosen field. The default value is createdAt. |
descending | bool Determines the arrangement of elements:
True. |
Python
tasking = up42.initialize_tasking()
tasking.get_quotations(
workspace_id="68567134-27ad-7bd7-4b65-d61adb11fc78",
decision="NOT_DECIDED",
sortby="updatedAt",
descending=False,
)
Allows you to accept or reject a quotation for a tasking order. You can only perform actions with feasibility studies with the NOT_DECIDED status. Returns dict.
| Parameter | Description |
|---|---|
quotation_id | str The quotation ID. |
decision | QuotationDecision The decision made for this quotation. |
Python
tasking = up42.initialize_tasking()
tasking.decide_quotation(
quotation_id="68567134-27ad-7bd7-4b65-d61adb11fc78",
decision="ACCEPTED",
)
Retrieves feasibility studies for tasking orders. Returns list[dict].
| Parameter | Description |
|---|---|
feasibility_id | Optional[str] The feasibility study ID. |
workspace_id | Optional[str] The workspace ID. Use to get feasibility studies from a specific workspace. Otherwise, feasibility studies from the entire account will be returned. |
order_id | Optional[str] The order ID. |
decision | Optional[List[FeasibilityStatus]] The status of feasibility studies. |
sortby | str Arranges elements in the order specified in descending based on a chosen field. The default value is createdAt. |
descending | bool Determines the arrangement of elements:
True. |
Python
tasking = up42.initialize_tasking()
tasking.get_feasibility(
workspace_id="68567134-27ad-7bd7-4b65-d61adb11fc78",
decision="NOT_DECIDED",
sortby="updatedAt",
descending=False,
)
Allows you to accept one of the proposed feasibility study options. You can only perform actions with feasibility studies with the NOT_DECIDED status. Returns dict.
| Parameter | Description |
|---|---|
feasibility_id | str The feasibility study ID. |
accepted_option_id | str The ID of the feasibility option to accept. |
Python
tasking = up42.initialize_tasking()
tasking.choose_feasibility(
feasibility_id="68567134-27ad-7bd7-4b65-d61adb11fc78",
accepted_option_id="a0d443a2-41e8-4995-8b54-a5cc4c448227",
)