Review feasibility

Reiew feasibility studies for tasking orders using the API.


Overview

After an order is placed, the Operations team will look at the order feasibility. They will evaluate the tasking parameters with the provider to determine if the order is possible with the given parameters or if the order requires modifications with suitable options proposed. You can review and accept the assessments using the API.

See feasibility studies

To see feasibility studies for tasking orders, call the /v2/tasking/feasibility endpoint.

Request

GET /v2/tasking/feasibility HTTP/1.1
Host: api.up42.com
Authorization: Bearer {token}
Query parameterOverview
idstring
The feasibility study 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 feasibility studies.
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": [
    {
      "options": [
        {
          "id": "aa183717-1491-427b-8534-4077f0f86a62",
          "createdAt": "2022-12-13T11:02:44.051539Z",
          "updatedAt": "2022-12-13T11:02:44.051539Z",
          "studyId": "77dece60-1964-4e7b-a318-4f0afc04a232",
          "description": "Option 1 with 30% cloud coverage"
        }
      ],
      "decisionOption": {
        "id": "aa183717-1491-427b-8534-4077f0f86a62",
        "createdAt": "2022-12-13T11:02:44.051539Z",
        "updatedAt": "2022-12-13T11:02:44.051539Z",
        "studyId": "77dece60-1964-4e7b-a318-4f0afc04a232",
        "description": "Option 1 with 30% cloud coverage"
      },
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "decision": "ACCEPTED",
      "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",
      "type": "AUTO"
    }
  ],
  "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 feasibility study.
content.optionsarray of objects
Options available for the feasibility study.
content.decisionOptionobject
The option of the feasibility study that was accepted.
content.idstring
The feasibility study ID.
content.createdAtstring
The time the feasibility study was created.
content.updatedAtstring
The last time the feasibility study was changed.
content.decisionstring
The decision for this feasibility study:
  • NOT_DECIDED
  • ACCEPTED
content.decisionByIdstring
The ID of the user that made a decision on this feasibility study.
content.decisionByTypestring
The type of user that made a decision on this feasibility study.
content.decisionAtstring
The time the decision was made on this feasibility study.
content.accountIdstring
The account ID.
content.workspaceIdstring
The workspace ID.
content.orderIdstring
The order ID.
content.typestring
The feasibility study type:
  • AUTO
  • MANUAL
Parameters of the content.options object
idstring
The feasibility study option ID.
createdAtstring
The time the feasibility study option was created.
updatedAtstring
The last time the feasibility study option was changed.
studyIdstring
The feasibility study ID.
descriptionstring
A description of the feasibility study option.
Parameters of the content.decisionOption object
idstring
The feasibility study option ID.
createdAtstring
The time the feasibility study option was created.
updatedAtstring
The last time the feasibility study option was changed.
studyIdstring
The feasibility study option ID.
descriptionstring
A description of the feasibility study option.

Accept a feasibility study option

To accept one of the proposed feasibility study options, call the /v2/tasking/feasibility/{feasibility-id} endpoint with the feasibility ID as a path parameter. You can only perform actions with feasibility studies with the NOT_DECIDED status.

Request

PATCH /v2/tasking/feasibility/{feasibility-id} HTTP/1.1
Host: api.up42.com
Authorization: Bearer {token}
ParameterOverview
acceptedOptionIdstring
The ID of the feasibility option to accept.
See request example
{
  "acceptedOptionId": "a0d443a2-41e8-4995-8b54-a5cc4c448227"
}

Response

The response is an object from the content array.

See response example
{
  "options": [
    {
      "id": "aa183717-1491-427b-8534-4077f0f86a62",
      "createdAt": "2022-12-13T11:02:44.051539Z",
      "updatedAt": "2022-12-13T11:02:44.051539Z",
      "studyId": "77dece60-1964-4e7b-a318-4f0afc04a232",
      "description": "Option 1 with 30% cloud coverage"
    }
  ],
  "decisionOption": {
    "id": "aa183717-1491-427b-8534-4077f0f86a62",
    "createdAt": "2022-12-13T11:02:44.051539Z",
    "updatedAt": "2022-12-13T11:02:44.051539Z",
    "studyId": "77dece60-1964-4e7b-a318-4f0afc04a232",
    "description": "Option 1 with 30% cloud coverage"
  },
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "decision": "ACCEPTED",
  "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",
  "type": "AUTO"
}