Tasking

Create and manage tasking orders using the SDK.


Overview

Order new geospatial data to be captured over a specific area and at a given time.

View repository

Class: Tasking

A class that enables access to the tasking functionality. This class also inherits functions from the CatalogBase class.

Functions

construct_order_parameters

Constructs an order form for a specific data product.

ParameterDescription
data_product_idstr
The data product ID.
namestr
The order name.
acquisition_startUnion[str, datetime.datetime]
The start date of the acquisition period in the YYYY-MM-DD format.
acquisition_endUnion[str, datetime.datetime]
The end date of the acquisition period in the YYYY-MM-DD format.
geometryUnion[geojson.FeatureCollection, geojson.Feature, dict, list, geopandas.GeoDataFrame, shp_geometry.Polygon, shp_geometry.Point]
The order geometry.
tagsOptional[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"],
)

  

get_quotations

Retrieves quotations for tasking orders. Returns list.

ParameterDescription
quotation_idOptional[str]
The quotation ID.
workspace_idOptional[str]
The workspace ID. Use to get quotations from a specific workspace. Otherwise, quotations from the entire account will be returned.
order_idOptional[str]
The order ID.
decisionOptional[List[str]]
The status of quotations. The allowed values are as follows:
  • NOT_DECIDED
  • ACCEPTED
  • REJECTED
sortbystr
Arranges elements in the order specified in descending based on a chosen field. The default value is createdAt.
descendingbool
Determines the arrangement of elements:
  • True: Arranges elements in descending order based on the field specified in sortby.
  • False: Arranges elements in ascending order based on the field specified in sortby.
The default value is True.

Python

    tasking = up42.initialize_tasking()

tasking.get_quotations(
    workspace_id="68567134-27ad-7bd7-4b65-d61adb11fc78",
    decision="NOT_DECIDED",
    sortby="updatedAt",
    descending=False,
)

  

decide_quotation

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.

ParameterDescription
quotation_idstr
The quotation ID.
decisionstr
The decision made for this quotation. The allowed values are as follows:
  • ACCEPTED
  • REJECTED

Python

    tasking = up42.initialize_tasking()

tasking.decide_quotation(
    quotation_id="68567134-27ad-7bd7-4b65-d61adb11fc78",
    decision="ACCEPTED",
)

  

get_feasibility

Retrieves feasibility studies for tasking orders. Returns list.

ParameterDescription
feasibility_idOptional[str]
The feasibility study ID.
workspace_idOptional[str]
The workspace ID. Use to get feasibility studies from a specific workspace. Otherwise, feasibility studies from the entire account will be returned.
order_idOptional[str]
The order ID.
decisionOptional[List[str]]
The status of feasibility studies. The allowed values are as follows:
  • NOT_DECIDED
  • ACCEPTED
sortbystr
Arranges elements in the order specified in descending based on a chosen field. The default value is createdAt.
descendingbool
Determines the arrangement of elements:
  • True: Arranges elements in descending order based on the field specified in sortby.
  • False: Arranges elements in ascending order based on the field specified in sortby.
The default value is True.

Python

    tasking = up42.initialize_tasking()

tasking.get_feasibility(
    workspace_id="68567134-27ad-7bd7-4b65-d61adb11fc78",
    decision="NOT_DECIDED",
    sortby="updatedAt",
    descending=False,
)

  

choose_feasibility

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.

ParameterDescription
feasibility_idstr
The feasibility study ID.
accepted_option_idstr
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",
)

  

Learn more