openapi: 3.0.3
info:
title: OneAtlas WorldDEM Access Ordering API
version: 1.0.1
contact:
email: dl-geo-webservices@airbus.com
description: The OneAtlas WorldDEM API is a tool that provides access to high-resolution global elevation data. This data, collected by satellites and processed using advanced technologies, offers a detailed and accurate representation of the Earth's surface. By integrating the WorldDEM API into their applications, users can benefit from precise terrain information for a wide range of use cases, such as urban planning, disaster response, agriculture, and infrastructure development. This API allows developers to easily incorporate elevation data into their projects, enabling them to create more accurate and effective solutions.
servers:
- url: https://sar.api.oneatlas.airbus.com/v1
description: OneAtlas - Elevation
security:
- basicAuth: []
tags:
- name: Ordering
paths:
/api/v1/feasibility:
post:
summary: Check Feasibility
tags:
- Ordering
requestBody:
content:
application/json:
schema:
description: Feasibility request
oneOf:
- title: PleiadesNeo
properties:
progTypeNames:
enum:
- ONEPLAN
- ONEDAY
- ONENOWATTEMPTS
- ONENOWWEATHER
type: string
mission:
enum:
- PLEIADESNEO
type: string
contractId:
type: string
acquisitionDate:
$ref: '#/components/schemas/AcquisitionDate'
optical:
$ref: '#/components/schemas/Optical'
aoi:
$schema: http://json-schema.org/draft-06/schema#
id: http://local/schemas/public/aoi.json#
properties:
coordinates:
items:
items:
items:
type: number
maxItems: 2
minItems: 2
type: array
minItems: 4
type: array
minItems: 1
type: array
type:
enum:
- Polygon
title: aoi
type: object
required:
- progTypeNames
- mission
- contractId
- acquisitionDate
- optical
- aoi
type: object
example:
progTypeNames:
- ONEPLAN
mission: PLEIADESNEO
contractId: CTR2100XXXX
acquisitionDate:
startDate: '2021-08-31T19:22:11.250Z'
endDate: '2021-09-30T23:59:59.999Z'
optical:
acquisitionMode: MONO
maxCloudCover: 20
maxIncidenceAngle: 30
aoi:
- - - -3.71612548828124
- 40.35910267579197
- - -3.6090087890624893
- 40.35910267579197
- - -3.6090087890624893
- 40.45739708775443
- - -3.71612548828124
- 40.45739708775443
- - -3.71612548828124
- 40.35910267579197
- title: Pleiades and SPOT
properties:
progTypeNames:
enum:
- ONEPLAN
- ONEDAY
- ONENOW
- ONESERIES
type: string
mission:
$ref: '#/components/schemas/Mission'
contractId:
type: string
acquisitionDate:
$ref: '#/components/schemas/AcquisitionDate'
optical:
$ref: '#/components/schemas/Optical'
aoi:
$schema: http://json-schema.org/draft-06/schema#
id: http://local/schemas/public/aoi.json#
properties:
coordinates:
items:
items:
items:
type: number
maxItems: 2
minItems: 2
type: array
minItems: 4
type: array
minItems: 1
type: array
type:
enum:
- Polygon
title: aoi
type: object
required:
- progTypeNames
- mission
- contractId
- acquisitionDate
- optical
- aoi
type: object
example:
progTypeNames:
- ONEPLAN
mission: PLEIADES
contractId: CTR2100XXXX
acquisitionDate:
startDate: '2021-08-31T19:22:11.250Z'
endDate: '2021-09-30T23:59:59.999Z'
optical:
acquisitionMode: MONO
maxCloudCover: 20
maxIncidenceAngle: 30
aoi:
- - - -3.71612548828124
- 40.35910267579197
- - -3.6090087890624893
- 40.35910267579197
- - -3.6090087890624893
- 40.45739708775443
- - -3.71612548828124
- 40.45739708775443
- - -3.71612548828124
- 40.35910267579197
responses:
'200':
content:
application/json:
schema:
oneOf:
- title: SPOT & Pleiades
type: object
properties:
progCapacities:
type: array
items:
type: object
properties:
mission:
$ref: '#/components/schemas/Mission'
progTypes:
type: array
items:
type: object
properties:
name:
enum:
- ONEPLAN
- ONEDAY
- ONENOW
- ONESERIES
type: string
mission:
$ref: '#/components/schemas/Mission'
feasibility:
type: object
properties:
classification:
type: string
enum:
- EASY
- CHALLENGING
automation:
type: string
enum:
- AUTOMATIC
- MAUAL
automationName:
type: string
available:
type: boolean
- title: PleiadesNeo
type: object
properties:
progCapacities:
type: array
items:
type: object
properties:
mission:
type: string
enum:
- PLEIADESNEO
progTypes:
type: array
items:
type: object
properties:
name:
enum:
- ONEPLAN
- ONEDAY
- ONENOWATTEMPTS
- ONENOWWEATHER
type: string
mission:
type: string
enum:
- PLEIADESNEO
feasibility:
type: object
properties:
classification:
type: string
enum:
- EASY
- CHALLENGING
automation:
type: string
enum:
- AUTOMATIC
- MAUAL
automationName:
type: string
available:
type: boolean
expirationDate:
type: string
format: datetime
pattern: ^yyyy-MM-dd'T'HH:mm:ss.SSS'Z$
examples:
SPOT & Pleiades:
value:
progCapacities:
- mission: PLEIADES
progTypes:
- name: ONEPLAN
mission: PLEIADES
feasibility:
classification: CHALLENGING
automation: AUTOMATIC
automationName: AutomaticTasking30
available: true
PleiadesNeo:
value:
progCapacities:
- mission: PLEIADESNEO
progTypes:
- name: ONEPLAN
mission: PLEIADESNEO
feasibility:
classification: CHALLENGING
automation: AUTOMATIC
available: true
expirationDate: '2021-05-12T08:03:19.052Z'
servers:
- description: Tasking API server
url: https://order.api.oneatlas.airbus.com
/api/v1/attempts:
post:
summary: Retrieve Attempts
tags:
- Ordering
description: Get tasking attempts
requestBody:
content:
application/json:
schema:
description: Orders api
oneOf:
- title: PleiadesNeo
properties:
progTypeNames:
enum:
- ONEDAY
- ONENOWATTEMPTS
type: string
mission:
enum:
- PLEIADESNEO
type: string
contractId:
type: string
acquisitionDate:
$ref: '#/components/schemas/AcquisitionDate'
optical:
$ref: '#/components/schemas/Optical'
aoi:
properties:
coordinates:
items:
items:
items:
type: number
maxItems: 2
minItems: 2
type: array
minItems: 4
type: array
minItems: 1
type: array
type:
enum:
- Polygon
title: aoi
type: object
example:
type: Polygon
coordinates:
- - - 23.69574504957747
- 37.91905533651132
- - 23.815564690690753
- 37.91905533651132
- - 23.815564690690753
- 38.033261134969194
- - 23.69574504957747
- 38.033261134969194
- - 23.69574504957747
- 37.91905533651132
required:
- progTypeNames
- mission
- contractId
- acquisitionDate
- optical
- aoi
example:
progTypeNames:
- ONEDAY
missions:
- PLEIADESNEO
acquisitionDate:
startDate: 2023-03-26T00:00.000Z
endDate: '2022-03-29T00:00:00.000Z'
optical:
maxCloudCover: 100
maxIncidenceAngle: 20
aoi:
type: Polygon
coordinates:
- - - 23.69574504957747
- 37.91905533651132
- - 23.815564690690753
- 37.91905533651132
- - 23.815564690690753
- 38.033261134969194
- - 23.69574504957747
- 38.033261134969194
- - 23.69574504957747
- 37.91905533651132
- title: SPOT & Pleiades
properties:
progTypeNames:
enum:
- ONEDAY
- ONENOW
type: string
mission:
$ref: '#/components/schemas/Mission'
contractId:
type: string
acquisitionDate:
$ref: '#/components/schemas/AcquisitionDate'
optical:
$ref: '#/components/schemas/Optical'
aoi:
properties:
coordinates:
items:
items:
items:
type: number
maxItems: 2
minItems: 2
type: array
minItems: 4
type: array
minItems: 1
type: array
type:
enum:
- Polygon
title: aoi
type: object
example:
type: Polygon
coordinates:
- - - 23.69574504957747
- 37.91905533651132
- - 23.815564690690753
- 37.91905533651132
- - 23.815564690690753
- 38.033261134969194
- - 23.69574504957747
- 38.033261134969194
- - 23.69574504957747
- 37.91905533651132
required:
- progTypeNames
- mission
- contractId
- acquisitionDate
- optical
- aoi
example:
progTypeNames:
- ONEDAY
missions:
- PLEIADES
acquisitionDate:
startDate: 2023-03-26T00:00.000Z
endDate: '2022-03-29T00:00:00.000Z'
optical:
maxCloudCover: 100
maxIncidenceAngle: 20
aoi:
type: Polygon
coordinates:
- - - 23.69574504957747
- 37.91905533651132
- - 23.815564690690753
- 37.91905533651132
- - 23.815564690690753
- 38.033261134969194
- - 23.69574504957747
- 38.033261134969194
- - 23.69574504957747
- 37.91905533651132
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/TaskingAttempt'
examples:
SPOT & Pleiades:
value:
progCapacities:
mission: PLEIADES
progTypes:
- name: ONEDAY
mission: PLEIADES
segments:
- id: PNEO1
footprint:
geometry: POLYGON((23.642028 38.043069, 23.642495 37.909283, 23.868104 37.908839, 23.868548 38.04307, 23.642028 38.043069, 23.642028 38.043069))
center: POINT(23.755357 37.97611)
instrumentMode: THR
orderDeadline: '2022-03-26T08:28:00.499Z'
extendedAngle: false
acquisitionStartDate: '2022-03-26T09:15:27.499Z'
acquisitionEndDate: '2022-03-26T09:15:29.671Z'
incidenceAngle: 26.72
segmentKey: 895651bbc3f881c1e1245b224ac69c34668001bd8610e359dfdfbf9b7430ad69c1b92543b80d84a75ed9961c0dca088f38f278c4df90a686f327e2cfc3d0be73::[{"key":"orderDeadLine","value":"2022-03-26T08:28:00.499Z"},{"key":"acqPeriod","value":"2022-03-26T09:15:27.499Z 2022-03-26T09:15:29.671Z"},{"key":"maxIncidenceAngle","value":"30.0"},{"key":"geometryWkt","value":"POLYGON((23.642028 38.043069, 23.642495 37.909283, 23.868104 37.908839, 23.868548 38.04307, 23.642028 38.043069, 23.642028 38.043069))"}]
acrossTrackIncidenceAngle: -7.874962709778218
maxIncidenceAngle: 30
- id: PNEO2
footprint:
geometry: POLYGON((23.644797 38.043069, 23.644964 37.90931, 23.866444 37.908808, 23.86659 38.043069, 23.644797 38.043069, 23.644797 38.043069))
center: POINT(23.755768 37.97608)
instrumentMode: THR
orderDeadline: '2022-03-29T08:35:00.699Z'
extendedAngle: false
acquisitionStartDate: '2022-03-29T09:22:50.699Z'
acquisitionEndDate: '2022-03-29T09:22:52.871Z'
incidenceAngle: 26.98
segmentKey: ef7be0cf8ff00529830ca020a8c9a6ac823f0e59b31c1b242f6a4e88ee5891eaf98605040452702b85dce33e4e9bc5a256a342126a18b2c10506c7cfdaa52682::[{"key":"orderDeadLine","value":"2022-03-29T08:35:00.699Z"},{"key":"acqPeriod","value":"2022-03-29T09:22:50.699Z 2022-03-29T09:22:52.871Z"},{"key":"maxIncidenceAngle","value":"30.0"},{"key":"geometryWkt","value":"POLYGON((23.644797 38.043069, 23.644964 37.90931, 23.866444 37.908808, 23.86659 38.043069, 23.644797 38.043069, 23.644797 38.043069))"}]
acrossTrackIncidenceAngle: 8.063750464703226
maxIncidenceAngle: 30
available: true
PleiadesNeo:
value:
progCapacities:
mission: PLEIADESNEO
progTypes:
- name: ONEDAY
mission: PLEIADESNEO
segments:
- id: PNEO1
footprint:
geometry: POLYGON((23.642028 38.043069, 23.642495 37.909283, 23.868104 37.908839, 23.868548 38.04307, 23.642028 38.043069, 23.642028 38.043069))
center: POINT(23.755357 37.97611)
instrumentMode: THR
orderDeadline: '2022-03-26T08:28:00.499Z'
extendedAngle: false
acquisitionStartDate: '2022-03-26T09:15:27.499Z'
acquisitionEndDate: '2022-03-26T09:15:29.671Z'
incidenceAngle: 26.72
segmentKey: 895651bbc3f881c1e1245b224ac69c34668001bd8610e359dfdfbf9b7430ad69c1b92543b80d84a75ed9961c0dca088f38f278c4df90a686f327e2cfc3d0be73::[{"key":"orderDeadLine","value":"2022-03-26T08:28:00.499Z"},{"key":"acqPeriod","value":"2022-03-26T09:15:27.499Z 2022-03-26T09:15:29.671Z"},{"key":"maxIncidenceAngle","value":"30.0"},{"key":"geometryWkt","value":"POLYGON((23.642028 38.043069, 23.642495 37.909283, 23.868104 37.908839, 23.868548 38.04307, 23.642028 38.043069, 23.642028 38.043069))"}]
acrossTrackIncidenceAngle: -7.874962709778218
maxIncidenceAngle: 30
- id: PNEO2
footprint:
geometry: POLYGON((23.644797 38.043069, 23.644964 37.90931, 23.866444 37.908808, 23.86659 38.043069, 23.644797 38.043069, 23.644797 38.043069))
center: POINT(23.755768 37.97608)
instrumentMode: THR
orderDeadline: '2022-03-29T08:35:00.699Z'
extendedAngle: false
acquisitionStartDate: '2022-03-29T09:22:50.699Z'
acquisitionEndDate: '2022-03-29T09:22:52.871Z'
incidenceAngle: 26.98
segmentKey: ef7be0cf8ff00529830ca020a8c9a6ac823f0e59b31c1b242f6a4e88ee5891eaf98605040452702b85dce33e4e9bc5a256a342126a18b2c10506c7cfdaa52682::[{"key":"orderDeadLine","value":"2022-03-29T08:35:00.699Z"},{"key":"acqPeriod","value":"2022-03-29T09:22:50.699Z 2022-03-29T09:22:52.871Z"},{"key":"maxIncidenceAngle","value":"30.0"},{"key":"geometryWkt","value":"POLYGON((23.644797 38.043069, 23.644964 37.90931, 23.866444 37.908808, 23.86659 38.043069, 23.644797 38.043069, 23.644797 38.043069))"}]
acrossTrackIncidenceAngle: 8.063750464703226
maxIncidenceAngle: 30
available: true
'500':
description: No possible attempt
content:
application/json:
schema:
$ref: '#/components/schemas/NoSensorAvailable'
servers:
- description: Tasking API server
url: https://order.api.oneatlas.airbus.com/
/api/v1/prices:
post:
summary: Calculate a Price
tags:
- Ordering
servers:
- description: Tasking API server
url: https://order.api.oneatlas.airbus.com/
description: '<h3>Archive and Tasking ordering</h3>
'
requestBody:
content:
application/json:
schema:
description: Orders api
title: Orders
oneOf:
- title: Tasking SPOT & Pleiades
properties:
aoi:
type: array
items:
type: object
properties:
id:
format: integer
type: number
description: It is used to identify the aoi on which some options are set (refer to the 'item' parameter below)
name:
type: string
geometry:
$ref: '#/components/schemas/GeojsonGeometry'
programReference:
type: string
contractId:
$ref: '#/components/schemas/contractId'
items:
type: array
items:
type: object
properties:
productTypeId:
type: string
enum:
- PleiadesTaskingOneDay
- SpotTaskingOneDay
- PleiadesTaskingOnePlan
- SpotTaskingOnePlan
- PleiadesTaskingOneNow
- SpotTaskingOneNow
- PleiadesTaskingOneSeries
- SpotTaskingOneSeries
dataSourceIds:
$ref: '#/components/schemas/DataSourceIds'
aoiId:
type: number
format: integer
description: refers to the specific aoi id.
properties:
type: array
items:
anyOf:
- type: object
title: acquisitionMode
properties:
key:
enum:
- acquisitionMode
value:
enum:
- MONO
- STEREO
- TRISTEREO
- type: object
title: notificationThreshold
properties:
key:
enum:
- notificationThreshold
value:
format: float
type: number
maximum: 100
minimum: 0
description: Defines the cloud cover percentage upon which you want the acquisitions to be proposed to you (tasking continues unless you accept the acquisition). If you want to integrate only through API, we advise you to keep notification Threshold = maxCloudCover
- type: object
title: maxCloudCover
properties:
key:
enum:
- maxCloudCover
value:
format: float
type: number
maximum: 100
minimum: 0
description: Defines the cloud cover percentage upon which you want validate automatically the acquisition
- type: object
title: maxIncidenceAngle
properties:
key:
enum:
- maxIncidenceAngle
value:
format: float
type: number
maximum: 90
minimum: 0
description: Defines the maximum incidence angle you want validate automatically the acquisition
- type: object
title: acqPeriod
properties:
key:
enum:
- acqPeriod
value:
$ref: '#/components/schemas/AcqPerod'
- type: object
title: feasibilityAutomation
properties:
key:
enum:
- feasibilityAutomation
description: Value is to be filled with the result of the RETRIEVE FEASIBILITY (key 'automation'). If you want to force a manual feasibility study, use 'MANUAL' and request quotation
value:
enum:
- AUTOMATIC
- MANUAL
- type: object
title: classification
properties:
key:
enum:
- classification
value:
enum:
- CHALLENGING
- EASY
description: Value is to be filled with the result of the RETRIEVE FEASIBILITY (key 'classification')
- type: object
title: acquisitionModeMinBH
properties:
key:
enum:
- acquisitionModeMinBH
description: Only in STEREO and TRISTEREO modes
value:
format: float
type: number
maximum: 0.8
minimum: 0.2
- type: object
title: acquisitionModeMaxBH
properties:
key:
enum:
- acquisitionModeMaxBH
description: Only in STEREO and TRISTEREO modes
value:
format: float
type: number
maximum: 0.8
minimum: 0.2
comments:
$ref: '#/components/schemas/Comments'
segmentKey:
$ref: '#/components/schemas/SegmentKey'
primaryMarket:
type: string
enum:
- AGRI
- GENIE
- GDPUBLIC
- DEFSEC
- DISTRI
- RISQUE
- ENERGIE
- ENV
- FORET
- SANTE
- ASSUR
- IOT
- CARTO
- MARITIME
- PRESSE
- MOBIL
- AUTRE
- TELECOM
- TOURISME
- TRANSPORT
- NQUAL
customerReference:
$ref: '#/components/schemas/CustomerReference'
optionsPerProductType:
type: array
items:
type: object
properties:
# --- truncated at 32 KB (292 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/airbus-oneatlas/refs/heads/main/openapi/airbus-oneatlas-ordering-api-openapi.yml