How to read order schemas
For example, this is Capella Space tasking collection's schema:
{
"$schema": "https://json-schema.org/draft-07/schema",
"type": "object",
"properties": {
"geometry": {
"title": "Geometry",
"type": "object",
"allOf": [
{
"$ref": "#/definitions/Polygon"
}
]
},
"displayName": {
"title": "Order name",
"type": "string"
},
"extraDescription": {
"title": "Description",
"type": "string"
},
"acquisitionStart": {
"title": "Start",
"type": "string",
"format": "date-time"
},
"acquisitionEnd": {
"title": "End",
"type": "string",
"format": "date-time"
},
"acquisitionMode": {
"title": "Acquisition mode",
"description": "In Spotlight (Spot) mode, the antenna beam is focused on a point on the Earth for an extended period. Azimuth resolution increases with the dwell time of the antenna beam on the target, and range resolution increases with the bandwidth. With Sliding spotlight (Site) instead of illuminating a fixed point on the ground, the acquisition angle is slowly varied to slide the illumination point along the ground. Sliding spotlight provides excellent image resolution with larger area coverage than spotlight. In Stripmap (Strip) mode the center of the antenna beam moves in tandem with the satellite.",
"type": "string",
"allOf": [
{
"$ref": "#/definitions/acquisitionMode"
}
]
},
"incidenceAngle": {
"title": "Maximum incidence angle (°)",
"description": "Maximum allowed incidence angle in degree.",
"minimum": 0,
"maximum": 90,
"type": "integer"
},
"polarization": {
"title": "Polarization",
"description": "This constellation is a single-polarization system producing horizontal transmit, horizontal receive (HH) or vertical transmit, vertical receive (VV) imagery. Different polarizations provide different received backscatter data, which can highlight various electrical and geometric properties of the imaged area like surface roughness and moisture content.",
"type": "string",
"allOf": [
{
"$ref": "#/definitions/polarization"
}
]
}
},
"required": [
"geometry",
"displayName",
"acquisitionStart",
"acquisitionEnd",
"acquisitionMode",
"incidenceAngle",
"polarization"
],
"definitions": {
"Polygon": {
"title": "Polygon",
"description": "Polygon Model.",
"type": "object",
"properties": {
"type": {
"title": "Type",
"default": "Polygon",
"const": "Polygon",
"type": "string"
},
"coordinates": {
"type": "array",
"items": {
"type": "array",
"minItems": 4,
"items": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "number"
}
}
}
}
},
"required": [
"coordinates"
]
},
"acquisitionMode": {
"title": "acquisitionMode",
"anyOf": [
{
"const": "spotlight",
"title": "Spotlight"
},
{
"const": "stripmap",
"title": "Stripmap"
},
{
"const": "sliding_spotlight",
"title": "Sliding Spotlight"
}
]
},
"polarization": {
"title": "polarization",
"anyOf": [
{
"const": "hh",
"title": "HH"
},
{
"const": "vv",
"title": "VV"
}
]
}
},
"additionalProperties": false
}
The parameters in the properties field are the properties you can specify. In this example, the following properties can be specified:
- Geometry (in the polygon/AOI format)
- Order name
- Order description
- Acquisition start and end dates
- Acquisition mode (select one of the following):
- Spotlight
- Stripmap
- Sliding Spotlight
- Incidence angle, from 0° to 90°
- Polarization (select one of the following):
- HH
- VV
In the required field, check which properties must be specified in an order placement request. The order placement will fail without them.