Activate an order

See and approve feasibility studies' quotations using the API.


Overview

After selecting a feasibility study option, you will receive a price quote for your order. To review a price quote and activate your order, you can use the API.

See quotations

To see a list of all quotations for tasking orders, call the /v2/tasking/quotation endpoint.

Request

GET /v2/tasking/quotation HTTP/1.1
Host: api.up42.com
Authorization: Bearer {token}
Query parameterOverview
idstring
The quotation ID.
workspaceIdstring
The workspace ID. Use to get objects from a specific workspace. Otherwise, objects from the entire account will be returned.
orderIdstring
The order ID.
decisionarray of strings
The status of quotations.
sizeinteger
The number of results on a result page. The default value is 20.
pageinteger
The result page number. To get the first page, set the parameter to 0. The default value is 0.
sortstring
The results sorting method that arranges elements in ascending or descending order based on a chosen field. The format is <field name>,<asc or desc>. The default value is createdAt,desc

Response


See response example
{
  "content": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "decision": "NOT_DECIDED",
      "decisionById": "096e3715-e908-473f-b527-d12af3e254b6",
      "decisionByType": "USER",
      "decisionAt": "2019-08-24T14:15:22Z",
      "accountId": "3d07c219-0a88-45be-9cfc-91e9d095a1e9",
      "workspaceId": "ef0efa32-d1c1-43d4-a5e2-fe7b4f00403c",
      "orderId": "b3e1eced-f2bd-4d8c-9765-fbc9d1d222d5",
      "creditsPrice": 1
    }
  ],
  "pageable": {
    "pageable": {},
    "last": true,
    "size": 0,
    "first": true,
    "empty": true,
    "number": 0,
    "numberOfElements": 0,
    "totalElements": 0,
    "totalPages": 0,
    "sort": {},
    "content": {}
  },
  "last": true,
  "totalElements": 1,
  "totalPages": 1,
  "sort": {
    "unsorted": false,
    "sorted": true,
    "empty": false
  },
  "numberOfElements": 1,
  "first": true,
  "size": 10,
  "number": 0,
  "empty": false
}

ParameterOverview
contentarray of objects
The content of the tasking quotation.
content.idstring
The quotation ID.
content.createdAtstring
The time the quotation was created.
content.updatedAtstring
The last time the quotation data was changed.
content.decisionstring
The decision for this quotation:
  • NOT_DECIDED
  • ACCEPTED
  • REJECTED
The default value is NOT_DECIDED.
content.decisionByIdstring
The ID of the user that made a decision on this quotation.
content.decisionByTypestring
The type of user that made a decision on this quotation.
content.decisionAtstring
The time the decision was made on this quotation.
content.accountIdstring
The account ID.
content.workspaceIdstring
The workspace ID.
content.orderIdstring
The order ID.
content.creditsPriceinteger
The amount of credits that will be charged.

Accept a quotation

To accept or reject a quotation for a tasking order, call the /v2/tasking/quotation/{quotation-id} endpoint with the quotation ID as a path parameter. This operation is only allowed on quotations with the NOT_DECIDED status.

Request

PATCH /v2/tasking/quotation/{quotation-id} HTTP/1.1
Host: api.up42.com
Content-Type: application/merge-patch+json
Authorization: Bearer {token}
ParameterOverview
decisionstring / required
The decision made for this quotation:
  • ACCEPTED
  • REJECTED

See request example
{
  "decision": "ACCEPTED"
}

Response

The response is an object from the content array.


See response example
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "decision": "NOT_DECIDED",
  "decisionById": "096e3715-e908-473f-b527-d12af3e254b6",
  "decisionByType": "USER",
  "decisionAt": "2019-08-24T14:15:22Z",
  "accountId": "3d07c219-0a88-45be-9cfc-91e9d095a1e9",
  "workspaceId": "ef0efa32-d1c1-43d4-a5e2-fe7b4f00403c",
  "orderId": "b3e1eced-f2bd-4d8c-9765-fbc9d1d222d5",
  "creditsPrice": 1
}