Create

Create New Order

Create new order and schedule workflow execution (analysis creation) for created area of interest

post

/orders/create

Authorizations

OAuth2AuthorizationCodeBearerAPIKeyHeaderAPIKeyQuery

Body

app_idintegerrequired

Application identifier

start_datestringrequired

The start date of the analysis (YYYY-MM-DD)

end_datestringrequired

The end date of the analysis (YYYY-MM-DD)

area_of_interestall ofrequired

GeoJSON feature describing the area of interest

publicany of

set True/False the value to change the order visibility.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/v2/orders/create' \
  --header 'Content-Type: application/json' \
  --data '{
    "app_id": 123,
    "end_date": "2022-01-01",
    "start_date": "2021-01-01",
    "area_of_interest": {
      "properties": {
        "radius": 0.133
      },
      "geometry": {
        "type": "Point",
        "coordinates": [
          -78.84779139647071,
          -4.0988921451725275
        ]
      }
    }
  }'

200

422

200

{
  "result_id": 47889
}

Successful Response