Tasking in SDK

Overview

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

View repository

Constants

Constant	Description	Value
`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"]`

Class: QuotationSorting

A class that provides sorting options for quotations.

Attributes

Attribute	Description
`created_at`	utils.SortingField Sorts by creation date. The default order is ascending.
`updated_at`	utils.SortingField Sorts by update date. The default order is ascending.
`decided_at`	utils.SortingField Sorts by decision date. The default order is ascending.
`credits_price`	utils.SortingField Sorts by price, in credits. The default order is ascending.

1
from itertools import islice
2

3
# Sort by creation date, from the most recent to the earliest
4
quotations_sorted = up42.Quotation.all(sort_by=up42.QuotationSorting.created_at.desc)
10 collapsed lines
5

6
# Sort by the last update date, from the most recent to the earliest
7
# quotations_sorted = up42.Quotation.all(sort_by=up42.QuotationSorting.updated_at.desc)
8

9
# Sort by decision date, from the most recent to the earliest
10
# quotations_sorted = up42.Quotation.all(sort_by=up42.QuotationSorting.decided_at.desc)
11

12
# Sort by price, from the highest to the lowest
13
# quotations_sorted = up42.Quotation.all(sort_by=up42.QuotationSorting.credits_price.desc)
14

15
# Define output for one of the sorting examples
16
for quotation in islice(quotations_sorted, 0, 5): # Print first 5 results
17
    print(f"- Quotation ID: {quotation.id}")
18
    print(f"  Decision:     {quotation.decision}")
19
    print(f"  Price:        {quotation.credits_price} credits")
20
    print(f"  Created at:   {quotation.created_at}\n")

Class: Quotation

A data class that represents a quotation for a tasking order.

Attributes

Attribute	Description
`id`	str The quotation ID.
`created_at`	str The time the quotation was created.
`updated_at`	str The last time the quotation data was changed.
`decided_at`	Optional[str] The time the decision was made on this quotation.
`account_id`	str The account ID.
`workspace_id`	str The workspace ID.
`order_id`	str The order ID.
`credits_price`	int The amount of credits that will be charged.
`decision`	QuotationStatus The decision for this quotation.

1
# Select a quotation
2
quotation_id = "a3210ea7-1570-4c28-9052-d3fbe45ae30c"
3

4
# Get the specific quotation by its ID
5
quotation = next(up42.Quotation.all(quotation_id=quotation_id))
6

7
# Define output
8
print(f"Quotation details for ID:   {quotation.id}")
9
print(f"Created at:                 {quotation.created_at}")
10
print(f"Decided at:                 {quotation.decided_at}")
11
print(f"Order ID:                   {quotation.order_id}")
12
print(f"Price:                      {quotation.credits_price} credits")
13
print(f"Decision:                   {quotation.decision}")

Methods

accept

Marks the quotation as accepted by setting its decision attribute to ACCEPTED. Use save to apply the change.

1
# Select a quotation
2
quotation_id = "b3b17f05-d9b5-47a1-a8d6-e15196f1204e"
3

4
quotation = next(up42.Quotation.all(quotation_id=quotation_id))
5
print(f"Fetched quotation: {quotation.id}")
6
print(f"Initial decision: {quotation.decision}")
7

8
# Accept the quotation locally
9
quotation.accept()
10

11
# Save the decision to the server
12
quotation.save()
13

14
# The object is updated with the server response
15
print(f"Final decision: {quotation.decision}")
16
print(f"Decided at: {quotation.decided_at}")

reject

Marks the quotation as accepted by setting its decision attribute to REJECTED. Use save to apply the change.

1
# Select a quotation
2
quotation_id = "b3b17f05-d9b5-47a1-a8d6-e15196f1204e"
3

4
quotation = next(up42.Quotation.all(quotation_id=quotation_id))
5
print(f"Fetched quotation: {quotation.id}")
6
print(f"Initial decision: {quotation.decision}")
7

8
# Reject the quotation locally
9
quotation.reject()
10

11
# Save the decision to the server
12
quotation.save()
13

14
# The object is updated with the server response
15
print(f"Final decision: {quotation.decision}")
16
print(f"Decided at: {quotation.decided_at}")

save

Saves any changes to the decision status of the quotation and updates the properties.

1
# Select a quotation
2
quotation_id = "b3b17f05-d9b5-47a1-a8d6-e15196f1204e"
3

4
quotation = next(up42.Quotation.all(quotation_id=quotation_id))
5
print(f"Fetched quotation: {quotation.id}")
6
print(f"Initial decision: {quotation.decision}")
7

8
# Accept the quotation locally
9
quotation.accept()
10

11
# Save the decision to the server
12
quotation.save()
13

14
# The object is updated with the server response
15
print(f"Final decision: {quotation.decision}")
16
print(f"Decided at: {quotation.decided_at}")

all

Retrieves quotations based on optional filter parameters. Returns Iterator["Quotation"]. Use itertools.islice to offset and limit the results.

Parameter	Description
`quotation_id`	Optional[str] The quotation ID.
`workspace_id`	Optional[str] The workspace ID. Use to get objects from a specific workspace. Otherwise, objects from the entire account will be returned.
`order_id`	Optional[str] The order ID.
`decision`	Optional[List[QuotationStatus]] The status of quotations.
`sort_by`	Optional[utils.SortingField] The results sorting method that arranges elements in ascending or descending order based on a chosen field.

1
from itertools import islice
2

3
# Search for quotations
4
quotations = up42.Quotation.all(
5
    decision=["NOT_DECIDED"],
6
    order_id="ea36dee9-fed6-457e-8400-2c20ebd30f44",
7
)
8

9
# Define output
10
for quotation in islice(quotations, 0, 5): # Print first 5 results
11
    print(f"- Quotation ID: {quotation.id}")
12
    print(f"  Created at:   {quotation.created_at}")
13
    print(f"  Decided at:   {quotation.decided_at}")
14
    print(f"  Order ID:     {quotation.order_id}")
15
    print(f"  Price:        {quotation.credits_price} credits")
16
    print(f"  Decision:     {quotation.decision}\n")

Class: FeasibilityStudySorting

A class that provides sorting options for feasibility studies.

Attributes

Attribute Description

created_at

utils.SortingField

Sorts by creation date. The default order is ascending.

updated_at

utils.SortingField

Sorts by update date. The default order is ascending.

decided_at

utils.SortingField

Sorts by decision date. The default order is ascending.

1
from itertools import islice
2

3
# Sort by creation date, from the most recent to the earliest
4
feasibility_studies_sorted = up42.FeasibilityStudy.all(sort_by=up42.FeasibilityStudySorting.created_at.desc)
7 collapsed lines
5

6
# Sort by the last update date, from the most recent to the earliest
7
# feasibility_studies_sorted = up42.FeasibilityStudy.all(sort_by=up42.FeasibilityStudySorting.updated_at.desc)
8

9
# Sort by decision date, from the most recent to the earliest
10
# feasibility_studies_sorted = up42.FeasibilityStudy.all(sort_by=up42.FeasibilityStudySorting.decided_at.desc)
11

12
for feasibility_study in islice(feasibility_studies_sorted, 0, 5): # Print 5
13
    print(f"- Feasibility study ID:         {feasibility_study.id}")
14
    print(f"  Order ID:                     {feasibility_study.order_id}")
15
    print(f"  Status:                       {feasibility_study.status}")
16
    print(f"  Study decision:               {feasibility_study.decision}")
17
    print(f"  Available options:            {feasibility_study.options}")
18
    print(f"  Accepted option ID:           {feasibility_study.decision_option.id}")
19
    print(f"  Accepted option description:  {feasibility_study.decision_option.description}\n")

Class: FeasibilityStudyDecisionOption

A data class that represents the option of the feasibility study that was accepted for a given order.

Attributes

Attribute Description

Attribute	Description
`id`	str The feasibility study option ID.
`description`	Optional[str] A description of the feasibility study option.

id

str

The feasibility study option ID.

description

Optional[str]

A description of the feasibility study option.

1
# Select a feasibility study
2
feasibility_study_id = "ea36dee9-fed6-457e-8400-2c20ebd30f44"
3

4
# Fetch feasibility study info
5
feasibility_study = next(up42.FeasibilityStudy.all(feasibility_study_id=feasibility_study_id))
6

7
# Define output
8
print(f"Feasibility study details for ID:   {feasibility_study.id}")
9
print(f"Order ID:                           {feasibility_study.order_id}")
10
print(f"Status:                             {feasibility_study.status}")
11
print(f"Study decision:                     {feasibility_study.decision}")
12
print(f"Available options:                  {feasibility_study.options}")
13
print(f"Accepted option ID:                 {feasibility_study.decision_option.id}")
14
print(f"Accepted option description:        {feasibility_study.decision_option.description}\n")

Class: FeasibilityStudy

A data class that represents a feasibility study for a tasking order.

Attributes

Attribute	Description
`id`	str The feasibility study ID.
`created_at`	str The time the feasibility study was created.
`updated_at`	str The last time the feasibility study was changed.
`account_id`	str The account ID.
`workspace_id`	str The workspace ID.
`order_id`	str The order ID.
`decision`	FeasibilityStatus The decision for this feasibility study.
`options`	List[dict] Options available for the feasibility study.
`decided_at`	Optional[str] The time the decision was made on this feasibility study.
`decision_option`	Optional[FeasibilityStudyDecisionOption] The option of the feasibility study that was accepted.

1
# Select a feasibility study
2
feasibility_study_id = "ea36dee9-fed6-457e-8400-2c20ebd30f44"
3

4
# Fetch feasibility study info
5
feasibility_study = next(up42.FeasibilityStudy.all(feasibility_study_id=feasibility_study_id))
6

7
# Define output
8
print(f"Feasibility study details for ID:   {feasibility_study.id}")
9
print(f"Order ID:                           {feasibility_study.order_id}")
10
print(f"Status:                             {feasibility_study.status}")
11
print(f"Study decision:                     {feasibility_study.decision}")
12
print(f"Available options:                  {feasibility_study.options}")
13
print(f"Accepted option ID:                 {feasibility_study.decision_option.id}")
14
print(f"Accepted option description:        {feasibility_study.decision_option.description}\n")

Methods

all

Retrieves feasibility studies based on optional filter parameters. Returns Iterator["FeasibilityStudy"]. Use itertools.islice to offset and limit the results.

Parameter	Description
`feasibility_study_id`	Optional[str] The feasibility study ID.
`workspace_id`	Optional[str] The workspace ID.
`order_id`	Optional[str] The order ID.
`decision`	Optional[List[FeasibilityStatus]] The decision for this feasibility study.
`sort_by`	Optional[utils.SortingField]] The results sorting method that arranges elements in ascending or descending order based on a chosen field.

1
from itertools import islice
2

3
# Select an order
4
order_id = "ea36dee9-fed6-457e-8400-2c20ebd30f44"
5

6
# Search for feasibility studies
7
feasibility_studies = up42.FeasibilityStudy.all(
8
    order_id=order_id,
9
    decision=["NOT_DECIDED"],
10
)
11

12
# Define output
13
for feasibility_study in islice(feasibility_studies, 0, 5): # Print first 5 results
14
    print(f"- Feasibility study ID:         {feasibility_study.id}")
15
    print(f"  Order ID:                     {feasibility_study.order_id}")
16
    print(f"  Status:                       {feasibility_study.status}")
17
    print(f"  Study decision:               {feasibility_study.decision}")
18
    print(f"  Available options:            {feasibility_study.options}")
19
    print(f"  Accepted option ID:           {feasibility_study.decision_option.id}")
20
    print(f"  Accepted option description:  {feasibility_study.decision_option.description}\n")

accept

Selects a feasibility study option for acceptance. Use save to apply the change.

Parameter Description

Parameter	Description
`option_id`	str The ID of the option to accept.

option_id

str

The ID of the option to accept.

1
# Select a feasibility study
6 collapsed lines
2
feasibility_study_id = "ea36dee9-fed6-457e-8400-2c20ebd30f44"
3

4
# Get the specific feasibility study by its ID
5
feasibility_study = next(up42.FeasibilityStudy.all(feasibility_study_id=feasibility_study_id))
6
print(f"Fetched feasibility study: {feasibility_study.id}")
7
print(f"Initial decision: {feasibility_study.decision}")
8

9
# Print available options
6 collapsed lines
10
available_options = feasibility_study.options
11
print("\nAvailable options:")
12
for option in available_options:
13
    description = option.get('description', 'No description')
14
    print(f"  - ID:          {option['id']}")
15
    print(f"    Description: {description}")
16

17
# Accept a specific feasibility study option locally
18
option_to_accept_id = "033b4a5a-c492-4eba-915e-2000a0a84049"
19
feasibility_study.accept(option_id=option_to_accept_id)
20

21
# Save the decision to the server
22
feasibility_study.save()
23

24
# The object is updated with the server response
25
print(f"Final decision: {feasibility_study.decision}")
26
print(f"Chosen option ID: {feasibility_study.decision_option.id}")
27
print(f"Decided at: {feasibility_study.decided_at}")

save

Saves any changes to the decision status of the feasibility study option and updates the properties.

1
# Select a feasibility study
6 collapsed lines
2
feasibility_study_id = "ea36dee9-fed6-457e-8400-2c20ebd30f44"
3

4
# Get the specific feasibility study by its ID
5
feasibility_study = next(up42.FeasibilityStudy.all(feasibility_study_id=feasibility_study_id))
6
print(f"Fetched feasibility study: {feasibility_study.id}")
7
print(f"Initial decision: {feasibility_study.decision}")
8

9
# Print available options
6 collapsed lines
10
available_options = feasibility_study.options
11
print("\nAvailable options:")
12
for option in available_options:
13
    description = option.get('description', 'No description')
14
    print(f"  - ID:          {option['id']}")
15
    print(f"    Description: {description}")
16

17
# Accept a specific feasibility study option locally
18
option_to_accept_id = "033b4a5a-c492-4eba-915e-2000a0a84049"
19
feasibility_study.accept(option_id=option_to_accept_id)
20

21
# Save the decision to the server
22
feasibility_study.save()
23

24
# The object is updated with the server response
25
print(f"Final decision: {feasibility_study.decision}")
26
print(f"Chosen option ID: {feasibility_study.decision_option.id}")
27
print(f"Decided at: {feasibility_study.decided_at}")

Learn more

API docs | Tasking

Console docs | Tasking

Recently viewed

Recommended articles

Search results

No results found

Tasking in SDK

Create and manage tasking orders using the SDK.

Overview

Constants

Class: QuotationSorting

Attributes

Class: Quotation

Attributes

Methods

accept

reject

save

all

Class: FeasibilityStudySorting

Attributes

Class: FeasibilityStudyDecisionOption

Attributes

Class: FeasibilityStudy

Attributes

Methods

all

accept

save

Learn more