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 parameter | Overview |
|---|---|
id | string The quotation ID. |
workspaceId | string The workspace ID. Use to get objects from a specific workspace. Otherwise, objects from the entire account will be returned. |
orderId | string The order ID. |
decision | array of strings The status of quotations. |
size | integer The number of results on a result page. The default value is 20. |
page | integer The result page number. To get the first page, set the parameter to 0. The default value is 0. |
sort | string 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
}| Parameter | Overview |
|---|---|
content | array of objects The content of the tasking quotation. |
content.id | string The quotation ID. |
content.createdAt | string The time the quotation was created. |
content.updatedAt | string The last time the quotation data was changed. |
content.decision | string The decision for this quotation:
NOT_DECIDED. |
content.decisionById | string The ID of the user that made a decision on this quotation. |
content.decisionByType | string The type of user that made a decision on this quotation. |
content.decisionAt | string The time the decision was made on this quotation. |
content.accountId | string The account ID. |
content.workspaceId | string The workspace ID. |
content.orderId | string The order ID. |
content.creditsPrice | integer 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
Authorization: Bearer {token}| Parameter | Overview |
|---|---|
decision | string The decision made for this quotation:
|
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
}