The Tasking class enables access to the UP42 tasking functionality.
Python
tasking = up42.initialize_tasking()
This class also inherits functions from the CatalogBase class.
The construct_order_parameters()
function allows you to fill out an order form for a new tasking order. The returned data type is dict
.
Argument | Overview |
---|---|
data_product_id | str / required The data product ID. |
name | str / required The tasking order name. |
acquisition_start | Union[str, datetime] / required The start date of the acquisition period in the YYYY-MM-DD format. |
acquisition_end | Union[str, datetime] / required The end date of the acquisition period in the YYYY-MM-DD format. |
geometry | Union[FeatureCollection, Feature, dict, list, GeoDataFrame, Polygon, Point] / required The geometry of interest. It can be a POI or an AOI depending on the collection. |
tags | list[str] A list of tags that categorize the order. |
An example with construct_order_parameters()
Python
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"],
)
The get_feasibility()
function returns a list of feasibility studies for tasking orders. The returned data type is list
.
Argument | Overview |
---|---|
feasibility_id | str The feasibility study ID. |
workspace_id | 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 | str The order ID. |
decision | List[str] The status of feasibility studies. The allowed values are as follows:
|
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 . |
An example with get_feasibility()
Python
tasking.get_feasibility(
workspace_id="68567134-27ad-7bd7-4b65-d61adb11fc78",
decision="NOT_DECIDED",
sortby="updatedAt",
descending=False,
)
The choose_feasibility()
function allows you to accept one of the proposed feasibility study options. You can only perform actions with feasibility studies with the NOT_DECIDED
status. The returned data type is dict
.
Argument | Overview |
---|---|
feasibility_id | str / required The feasibility study ID. |
accepted_option_id | str / required The ID of the feasibility option to accept. |
An example with choose_feasibility()
Python
tasking.choose_feasibility(
feasibility_id="68567134-27ad-7bd7-4b65-d61adb11fc78",
accepted_option_id="a0d443a2-41e8-4995-8b54-a5cc4c448227",
)
The get_quotations()
function returns a list of all quotations for tasking orders. The returned data type is list
.
Argument | Overview |
---|---|
quotation_id | str The quotation ID. |
workspace_id | str The workspace ID. Use to get quotations from a specific workspace. Otherwise, quotations from the entire account will be returned. |
order_id | str The order ID. |
decision | List[str] The status of quotations. The allowed values are as follows:
|
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 . |
An example with get_quotations()
Python
tasking.get_quotations(
workspace_id="68567134-27ad-7bd7-4b65-d61adb11fc78",
decision="NOT_DECIDED",
sortby="updatedAt",
descending=False,
)
The decide_quotation()
function 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. The returned data type is dict
.
Argument | Description |
---|---|
quotation_id | str / required The quotation ID. |
decision | str / required The decision made for this quotation. The allowed values are as follows:
|
An example with decide_quotation()
Python
tasking.decide_quotation(
quotation_id="68567134-27ad-7bd7-4b65-d61adb11fc78",
decision="ACCEPTED",
)