Appearance
Create Programming Simulation
API Information
- Request Path:
/market/order/programming/simulation/create - Request Method:
POST - Content-Type:
application/json
Request Headers
| Parameter | Type | Required | Description |
|---|---|---|---|
| Authorization | String | Yes | User authentication token |
| Content-Type | String | Yes | Must be set to application/json |
Request Body Structure
| Field | Type | Required | Description | Constraints |
|---|---|---|---|---|
| sensorType | Integer | No | Sensor type | 1=SAR, 2=Optical |
| geometry | String | Yes | Geometry (GeoJSON) | - |
| aoiId | Long | No | AOI ID; when provided, server uses AOI geometry | - |
| startDate | String | Yes | Start Time | yyyy-MM-dd HH:mm or yyyy-MM-dd HH:mm:ss |
| endDate | String | Yes | End Time | yyyy-MM-dd HH:mm or yyyy-MM-dd HH:mm:ss |
| maxCloud | Integer | No | Max Cloud Cover | 0-100 |
| resolutionLevel | Integer | Yes | Resolution level: 1-Ultra High, 2-High Resolution - Submeter, 3-High Resolution, 4-Medium-Low Resolution | 1/2/3/4 |
Request Body Example
json
{
"sensorType": 1,
"geometry": "{\"type\":\"Polygon\",\"coordinates\":[[[102.61282157031928,21.488503948497097],[106.99114976403081,21.488503948497097],[106.99114976403081,18.594746845159506],[102.61282157031928,18.594746845159506],[102.61282157031928,21.488503948497097]]]}",
"startDate": "2026-03-07 14:00:00",
"endDate": "2026-03-11 23:59:59",
"maxCloud": 0,
"resolutionLevel": 2
}Response Body Structure
CommonResponse Object
| Field | Type | Description |
|---|---|---|
| code | Integer | Response status code |
| message | String | Response message |
| data | ProgrammingSimulationCreateResp | Response data |
ProgrammingSimulationCreateResp Object
| Field | Type | Description |
|---|---|---|
| taskNo | String | Simulation task unique identifier |
Response Examples
Success Response
json
{
"code": 200,
"message": "success",
"data": {
"taskNo": "SIM_20260307_xxxx"
}
}Failure Response
json
{
"code": 400,
"message": "Invalid parameters",
"data": null
}Error Code Description
| Error Code | Description |
|---|---|
| 200 | Success |
| 400 | Request parameter error |
| 401 | Unauthorized |
| 500 | Server internal error |
Usage Instructions
- This API is used to create a programming simulation task for the given area and time window
- User authentication is required
- After creation, use the returned
taskNoto query simulation results via/market/order/programming/simulation/results - Simulation results are filled asynchronously via callback; poll results until status is success or failed
Notes
- Simulation is asynchronous; query results later to get pass plans
- Time window must be valid for the selected sensor type and resolution setting