API docs by Redocly

FDS API (1.0.0)

Download OpenAPI specification:Download

Exotrail: contact@exotrail.com

API for Flight Dynamics System

Covariance Matrix

Covariance Matrix related endpoints

retrieveAll_10

Authorizations:
bearer-key

Responses

Response samples

Content type
application/json
[
  • {
    }
]

createCovarianceMatrix

Authorizations:
bearer-key
Request Body schema: application/json
required
date
string

UTC date

frame
required
string
Enum: "EME2000" "ECI" "TEME" "GCRF" "GTOD" "ECF" "TNW" "QSW"

Reference frame

id
string <uuid>
matrix
required
Array of numbers[ items <double >[ items <double > ] ]
orbitType
required
string
Enum: "CARTESIAN" "KEPLERIAN" "EQUINOCTIAL" "CIRCULAR"

Responses

Request samples

Content type
application/json
{
  • "date": "string",
  • "frame": "EME2000",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "matrix": [
    ],
  • "orbitType": "CARTESIAN"
}

Response samples

Content type
application/json
{ }

createDiagonalCovarianceMatrix

Authorizations:
bearer-key
Request Body schema: application/json
required
date
string

UTC date

diagonal
required
Array of numbers <double> [ items <double > ]
frame
required
string
Enum: "EME2000" "ECI" "TEME" "GCRF" "GTOD" "ECF" "TNW" "QSW"

Reference frame

id
string <uuid>
orbitType
required
string
Enum: "CARTESIAN" "KEPLERIAN" "EQUINOCTIAL" "CIRCULAR"

Responses

Request samples

Content type
application/json
{
  • "date": "string",
  • "diagonal": [
    ],
  • "frame": "EME2000",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "orbitType": "CARTESIAN"
}

Response samples

Content type
application/json
{ }

delete_1

Authorizations:
bearer-key
path Parameters
id
required
string <uuid>

Responses

retrieve_2

Authorizations:
bearer-key
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{ }

Telemetry

Telemetry related endpoints

retrieveAll_5

Authorizations:
bearer-key

Responses

Response samples

Content type
application/json
[
  • { }
]

createGpsNmeaTelemetry

Authorizations:
bearer-key
Request Body schema: application/json
required
altitudeStandardDeviation
required
number <double>

Units: [m]

dates
required
Array of strings

List of UTC dates

groundSpeedStandardDeviation
required
number <double>

Units: [m/s]

id
string <uuid>
latitudeStandardDeviation
required
number <double>

Units: [deg]

longitudeStandardDeviation
required
number <double>

Units: [deg]

measurements
required
Array of numbers[ items <double >[ items <double > ] ]

Array of double: latitude, longitude, norm of velocity in ECF frame, altitude, geoid separation. Units: [deg], [deg], [m/s], [m], [m]

Responses

Request samples

Content type
application/json
{
  • "altitudeStandardDeviation": 0.1,
  • "dates": [
    ],
  • "groundSpeedStandardDeviation": 0.1,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "latitudeStandardDeviation": 0.1,
  • "longitudeStandardDeviation": 0.1,
  • "measurements": [
    ]
}

Response samples

Content type
application/json
{ }

createGpsNmeaTelemetryRaw

Authorizations:
bearer-key
Request Body schema: application/json
required
altitudeStandardDeviation
required
number <double>

Units: [m]

groundSpeedStandardDeviation
required
number <double>

Units: [m/s]

id
string <uuid>
latitudeStandardDeviation
required
number <double>

Units: [deg]

longitudeStandardDeviation
required
number <double>

Units: [deg]

nmeaSentences
Array of strings

Responses

Request samples

Content type
application/json
{
  • "altitudeStandardDeviation": 0.1,
  • "groundSpeedStandardDeviation": 0.1,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "latitudeStandardDeviation": 0.1,
  • "longitudeStandardDeviation": 0.1,
  • "nmeaSentences": [
    ]
}

Response samples

Content type
application/json
{ }

createGpsPvTelemetry

Authorizations:
bearer-key
Request Body schema: application/json
required
dates
required
Array of strings

List of UTC dates

frame
string
Enum: "EME2000" "ECI" "TEME" "GCRF" "GTOD" "ECF" "TNW" "QSW"

Frame of definition of the position velocity vectors

id
string <uuid>
measurements
required
Array of numbers[ items <double >[ items <double > ] ]

List containing position and velocity vectors [x y z vx vy vz], Units: [m] [ms^-1]

positionStandardDeviation
required
number <double>

Units: [m]

velocityStandardDeviation
required
number <double>

Units: [ms^-1]

Responses

Request samples

Content type
application/json
{
  • "dates": [
    ],
  • "frame": "EME2000",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "measurements": [
    ],
  • "positionStandardDeviation": 0.1,
  • "velocityStandardDeviation": 0.1
}

Response samples

Content type
application/json
{ }

createOpticalTelemetry

Authorizations:
bearer-key
Request Body schema: application/json
required
azimuthStandardDeviation
required
number <double>

Units: [deg]

dates
required
Array of strings

List of UTC dates

elevationStandardDeviation
required
number <double>

Units: [deg]

groundStationId
required
string <uuid>
id
string <uuid>
measurements
required
Array of numbers[ items <double >[ items <double > ] ]

Array of double: azimuth, elevation. Units: [deg], [deg]

Responses

Request samples

Content type
application/json
{
  • "azimuthStandardDeviation": 0.1,
  • "dates": [
    ],
  • "elevationStandardDeviation": 0.1,
  • "groundStationId": "0e2bedfa-2c13-4217-8e1d-51aa401edc4b",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "measurements": [
    ]
}

Response samples

Content type
application/json
{ }

createRadarTelemetry

Authorizations:
bearer-key
Request Body schema: application/json
required
azimuthStandardDeviation
required
number <double>

Units: [deg]

dates
required
Array of strings

List of UTC dates

elevationStandardDeviation
required
number <double>

Units: [deg]

groundStationId
required
string <uuid>
id
string <uuid>
measurements
required
Array of numbers[ items <double >[ items <double > ] ]

Array of double: range, range rate, azimuth, elevation. Units: [m], [m/s], [deg], [deg]

rangeRateStandardDeviation
required
number <double>

Units: [m/s]

rangeStandardDeviation
required
number <double>

Units: [m]

twoWayMeasurement
required
boolean

Responses

Request samples

Content type
application/json
{
  • "azimuthStandardDeviation": 0.1,
  • "dates": [
    ],
  • "elevationStandardDeviation": 0.1,
  • "groundStationId": "0e2bedfa-2c13-4217-8e1d-51aa401edc4b",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "measurements": [
    ],
  • "rangeRateStandardDeviation": 0.1,
  • "rangeStandardDeviation": 0.1,
  • "twoWayMeasurement": true
}

Response samples

Content type
application/json
{ }

deleteTelemetry

Authorizations:
bearer-key
path Parameters
id
required
string <uuid>

Responses

retrieve

Authorizations:
bearer-key
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{ }

Parameter Estimation Request

Parameter Estimation Request related endpoints

retrieveAll_1

Responses

Response samples

Content type
application/json
[
  • { }
]

createDragCoefficientEstimationRequest

Authorizations:
bearer-key
Request Body schema: application/json
required
id
string <uuid>
parameterStandardDeviation
required
number <double> ( 0 .. 1 ]

x in (0,1], Units: [-]

processNoiseStandardDeviation
required
number <double> ( 0 .. 0.1 ]

x in (0,0.1], Units: [-]

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "parameterStandardDeviation": 0,
  • "processNoiseStandardDeviation": 0
}

Response samples

Content type
application/json
{ }

createReflectivityCoefficientEstimationRequest

Authorizations:
bearer-key
Request Body schema: application/json
required
id
string <uuid>
parameterStandardDeviation
required
number <double> ( 0 .. 1 ]

x in (0,1], Units: [-]

processNoiseStandardDeviation
required
number <double> ( 0 .. 0.1 ]

x in (0,0.1], Units: [-]

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "parameterStandardDeviation": 0,
  • "processNoiseStandardDeviation": 0
}

Response samples

Content type
application/json
{ }

createThrustVectorEstimationRequest

Authorizations:
bearer-key
Request Body schema: application/json
required
id
string <uuid>
parameterStandardDeviation
required
number <double> ( 0 .. 1 ]

x in (0,1], Units: [-]

processNoiseStandardDeviation
required
number <double> ( 0 .. 0.1 ]

x in (0,0.1], Units: [-]

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "parameterStandardDeviation": 0,
  • "processNoiseStandardDeviation": 0
}

Response samples

Content type
application/json
{ }

deleteParameterEstimationRequest

Authorizations:
bearer-key
path Parameters
id
required
string <uuid>

Responses

retrieveParameterEstimationRequestById

Authorizations:
bearer-key
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{ }

EphemerisRequestController

Ephemeris request related endpoints

createEphemerisRequest

Authorizations:
bearer-key
Request Body schema: application/json
required
ephemerisTypes
required
Array of strings
Items Enum: "CARTESIAN" "KEPLERIAN" "BATTERY" "QUATERNION" "THRUST" "EULER_ANGLES"

List of requested ephemeris types

id
string <uuid>
step
required
number <double> > 0

Units: [s]

Responses

Request samples

Content type
application/json
{
  • "ephemerisTypes": [
    ],
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "step": 0.1
}

Response samples

Content type
application/json
{
  • "ephemerisTypes": [
    ],
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "step": 0.1
}

delete

Authorizations:
bearer-key
path Parameters
id
required
string <uuid>

Responses

retrieve_1

Authorizations:
bearer-key
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "ephemerisTypes": [
    ],
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "step": 0.1
}

retrieveAll_9

Authorizations:
bearer-key

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Orbit Determination Configuration

Orbit Determination Configuration related endpoints

createUkfOrbitDeterminationConfiguration

Authorizations:
bearer-key
Request Body schema: application/json
required
alpha
required
number <double>

Defines the spread of the sigma points. Typical values from 1E-4 to 1E-1

beta
required
number <double>

Incorporates knowledge about the distribution of the state vector. Beta = 2 is optimal for Gaussian distributions

id
string <uuid>
kappa
required
number <double>

Secondary scaling parameter. Usually set to 0

noiseProviderType
required
string
Enum: "BASIC" "SNC" "DMC" "EDB_CD"

Model for the state noise dynamics

object (OutlierManagerSettingsDto)
processNoiseMatrixId
required
string <uuid>

UUID of the covariance matrix for the state noise distribution

Responses

Request samples

Content type
application/json
{
  • "alpha": 0.1,
  • "beta": 0.1,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "kappa": 0.1,
  • "noiseProviderType": "BASIC",
  • "outlierManagerSettings": {
    },
  • "processNoiseMatrixId": "609e5be9-1c17-490c-a238-867ec39256b1"
}

Response samples

Content type
application/json
{
  • "alpha": 0.1,
  • "beta": 0.1,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "kappa": 0.1,
  • "noiseProviderType": "BASIC",
  • "outlierManagerSettings": {
    },
  • "processNoiseMatrixId": "609e5be9-1c17-490c-a238-867ec39256b1"
}

deleteUkfOrbitDeterminationConfiguration

Authorizations:
bearer-key
path Parameters
id
required
string <uuid>

Responses

retrieveOrbitDeterminationConfigurationById

Authorizations:
bearer-key
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "alpha": 0.1,
  • "beta": 0.1,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "kappa": 0.1,
  • "noiseProviderType": "BASIC",
  • "outlierManagerSettings": {
    },
  • "processNoiseMatrixId": "609e5be9-1c17-490c-a238-867ec39256b1"
}

retrieveAllOrbitDeterminationConfigurations

Authorizations:
bearer-key

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Solar Array

Solar Array related endpoints

createSolarArray

Authorizations:
bearer-key
Request Body schema: application/json
required
id
string <uuid>
maximumPower
number <double>

Units: [W]

satelliteFaces
Array of strings
Items Enum: "PLUS_X" "MINUS_X" "PLUS_Y" "MINUS_Y" "PLUS_Z" "MINUS_Z"
solarArrayAxisInSatelliteFrame
Array of numbers <double> [ items <double > ]
solarArrayDefinitionType
required
string
Enum: "MAXIMUM_POWER" "SURFACE" "SURFACE_AND_POWER"
solarArrayEfficiency
required
number <double>

x in (0,1), Units: [-]

solarArrayNormalInSatelliteFrame
required
Array of numbers <double> [ items <double > ]
solarArrayType
required
string
Enum: "SOLAR_ARRAY_TYPE_BODY" "SOLAR_ARRAY_TYPE_DEPLOYABLE_FIXED" "SOLAR_ARRAY_TYPE_DEPLOYABLE_ROTATING" "SOLAR_ARRAY_TYPE_NONE"
surface
number <double>

Units: [m²]

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "maximumPower": 0.1,
  • "satelliteFaces": [
    ],
  • "solarArrayAxisInSatelliteFrame": [
    ],
  • "solarArrayDefinitionType": "MAXIMUM_POWER",
  • "solarArrayEfficiency": 0.1,
  • "solarArrayNormalInSatelliteFrame": [
    ],
  • "solarArrayType": "SOLAR_ARRAY_TYPE_BODY",
  • "surface": 0.1
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "maximumPower": 0.1,
  • "satelliteFaces": [
    ],
  • "solarArrayAxisInSatelliteFrame": [
    ],
  • "solarArrayDefinitionType": "MAXIMUM_POWER",
  • "solarArrayEfficiency": 0.1,
  • "solarArrayNormalInSatelliteFrame": [
    ],
  • "solarArrayType": "SOLAR_ARRAY_TYPE_BODY",
  • "surface": 0.1
}

deleteSolarArray

Authorizations:
bearer-key
path Parameters
id
required
string <uuid>

Responses

retrieveSolarArray

Authorizations:
bearer-key
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "maximumPower": 0.1,
  • "satelliteFaces": [
    ],
  • "solarArrayAxisInSatelliteFrame": [
    ],
  • "solarArrayDefinitionType": "MAXIMUM_POWER",
  • "solarArrayEfficiency": 0.1,
  • "solarArrayNormalInSatelliteFrame": [
    ],
  • "solarArrayType": "SOLAR_ARRAY_TYPE_BODY",
  • "surface": 0.1
}

retrieveAllSolarArrays

Authorizations:
bearer-key

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Maneuver Generation

Maneuver Generation related endpoints

runManeuverGeneration

Authorizations:
bearer-key
Request Body schema: application/json
required
deltaEccentricity
required
number <double>

Units: [-]

deltaInclination
required
number <double>

Units: [deg]

deltaSemiMajorAxis
required
number <double>

Units: [km]

initialOrbitalStateId
required
string <uuid>
maximumDuration
required
number <double>

Units: [s]

quaternionStep
required
number <double>

Units: [s]

requiredOutputOrbitalStates
required
string
Enum: "ALL" "LAST"
strategyId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "deltaEccentricity": 0.1,
  • "deltaInclination": 0.1,
  • "deltaSemiMajorAxis": 0.1,
  • "initialOrbitalStateId": "d60137d3-8f02-459a-b1e1-02f8d1558b5d",
  • "maximumDuration": 0.1,
  • "quaternionStep": 0.1,
  • "requiredOutputOrbitalStates": "ALL",
  • "strategyId": "c855e259-15d8-4385-a60f-bdf8f7695ef7"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "log": {
    },
  • "report": {
    },
  • "request": {
    },
  • "roadmap": { }
}

getManeuverGenerationResult

Authorizations:
bearer-key
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "log": {
    },
  • "report": {
    },
  • "request": {
    },
  • "roadmap": { }
}

getManeuverGeneration

Authorizations:
bearer-key
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "deltaEccentricity": 0.1,
  • "deltaInclination": 0.1,
  • "deltaSemiMajorAxis": 0.1,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "initialOrbitalState": {
    },
  • "maximumDuration": 0.1,
  • "quaternionStep": 0.1,
  • "requiredOutputOrbitalStates": "ALL",
  • "strategy": {
    }
}

getManeuverGenerationResultByRequestId

Authorizations:
bearer-key
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

retrieveAllManeuverGenerations

Authorizations:
bearer-key

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Orbit Extrapolation

Orbit Extrapolation related endpoints

runOrbitExtrapolation

Authorizations:
bearer-key
Request Body schema: application/json
required
ephemerisRequestId
string <uuid>
eventsRequestIds
Array of strings <uuid> [ items <uuid > ]
extrapolateCovariance
boolean

Should the covariance be propagated. Default is false

extrapolationDuration
required
number <double>

Units: [s]

initialOrbitalStateId
required
string <uuid>
measurementsRequestId
string <uuid>
orbitDataMessageRequestId
string <uuid>
requiredOutputOrbitalStates
string
Enum: "ALL" "LAST"

Which orbital states should be included in the output

roadmapId
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "ephemerisRequestId": "2556c3a9-f22f-458f-b4da-5c476fe859d9",
  • "eventsRequestIds": [
    ],
  • "extrapolateCovariance": true,
  • "extrapolationDuration": 0.1,
  • "initialOrbitalStateId": "d60137d3-8f02-459a-b1e1-02f8d1558b5d",
  • "measurementsRequestId": "745e562a-2600-4025-be5d-d430ff2dae4f",
  • "orbitDataMessageRequestId": "7c9de407-bafe-41e3-b357-e37ccb8458fe",
  • "requiredOutputOrbitalStates": "ALL",
  • "roadmapId": "c17cc406-f776-4ae2-967c-6cc230b7f3bf"
}

Response samples

Content type
application/json
{
  • "computedEvents": [
    ],
  • "computedMeasurements": [
    ],
  • "ephemerides": [
    ],
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "log": {
    },
  • "orbitDataMessageOutput": "string",
  • "orbitalStates": [
    ],
  • "request": {
    }
}

getOrbitExtrapolationResult

Authorizations:
bearer-key
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "computedEvents": [
    ],
  • "computedMeasurements": [
    ],
  • "ephemerides": [
    ],
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "log": {
    },
  • "orbitDataMessageOutput": "string",
  • "orbitalStates": [
    ],
  • "request": {
    }
}

getOrbitExtrapolation

Authorizations:
bearer-key
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "ephemerisRequest": {
    },
  • "eventsRequests": [
    ],
  • "extrapolateCovariance": true,
  • "extrapolationDuration": 0.1,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "initialOrbitalState": {
    },
  • "measurementsRequest": { },
  • "orbitDataMessageRequest": { },
  • "requiredOutputOrbitalStates": "ALL",
  • "roadmap": { }
}

getOrbitExtrapolationResultByExtrapolationId

Authorizations:
bearer-key
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

retrieveAllOrbitExtrapolations

Authorizations:
bearer-key

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Orbit

Orbit related endpoints

createCartesianOrbit

Authorizations:
bearer-key
Request Body schema: application/json
required
date
required
string

UTC date

frame
required
string
Enum: "EME2000" "ECI" "TEME" "GCRF" "GTOD" "ECF" "TNW" "QSW"
id
string <uuid>
positionX
required
number <double>

Position X. Units: [km]

positionY
required
number <double>

Position Y. Units: [km]

positionZ
required
number <double>

Position Z. Units: [km]

velocityX
required
number <double>

Velocity X. Units: [km/s]

velocityY
required
number <double>

Velocity Y. Units: [km/s]

velocityZ
required
number <double>

Velocity Z. Units: [km/s]

Responses

Request samples

Content type
application/json
{
  • "date": "string",
  • "frame": "EME2000",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "positionX": 0.1,
  • "positionY": 0.1,
  • "positionZ": 0.1,
  • "velocityX": 0.1,
  • "velocityY": 0.1,
  • "velocityZ": 0.1
}

Response samples

Content type
application/json
{ }

createCircularOrbit

Authorizations:
bearer-key
Request Body schema: application/json
required
argumentOfLatitude
required
number <double>

Units: [deg]

date
required
string

UTC date

eccentricityVectorX
required
number <double>

Eccentricity vector X. Units: [-]

eccentricityVectorY
required
number <double>

Eccentricity vector Y. Units: [-]

frame
required
string
Enum: "EME2000" "ECI" "TEME" "GCRF" "GTOD" "ECF" "TNW" "QSW"
id
string <uuid>
inclination
required
number <double>

Units: [deg]

meanOscType
required
string
Enum: "MEAN" "OSC"
positionAngleType
required
string
Enum: "TRUE" "MEAN" "ECCENTRIC"
raan
required
number <double>

Units: [deg]

semiMajorAxis
required
number <double>

Units: [km]

Responses

Request samples

Content type
application/json
{
  • "argumentOfLatitude": 0.1,
  • "date": "string",
  • "eccentricityVectorX": 0.1,
  • "eccentricityVectorY": 0.1,
  • "frame": "EME2000",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "inclination": 0.1,
  • "meanOscType": "MEAN",
  • "positionAngleType": "TRUE",
  • "raan": 0.1,
  • "semiMajorAxis": 0.1
}

Response samples

Content type
application/json
{ }

createEquinoctialOrbit

Authorizations:
bearer-key
Request Body schema: application/json
required
date
required
string

UTC date

eccentricityVectorX
required
number <double>

Eccentricity vector X. Units: [-]

eccentricityVectorY
required
number <double>

Eccentricity vector Y. Units: [-]

equinoctialLongitude
required
number <double>

Units: [deg]

frame
required
string
Enum: "EME2000" "ECI" "TEME" "GCRF" "GTOD" "ECF" "TNW" "QSW"
id
string <uuid>
inclinationVectorX
required
number <double>

Inclination vector X. Units: [-]

inclinationVectorY
required
number <double>

Inclination vector Y. Units: [-]

meanOscType
required
string
Enum: "MEAN" "OSC"
positionAngleType
required
string
Enum: "TRUE" "MEAN" "ECCENTRIC"
semiMajorAxis
required
number <double>

Units: [km]

Responses

Request samples

Content type
application/json
{
  • "date": "string",
  • "eccentricityVectorX": 0.1,
  • "eccentricityVectorY": 0.1,
  • "equinoctialLongitude": 0.1,
  • "frame": "EME2000",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "inclinationVectorX": 0.1,
  • "inclinationVectorY": 0.1,
  • "meanOscType": "MEAN",
  • "positionAngleType": "TRUE",
  • "semiMajorAxis": 0.1
}

Response samples

Content type
application/json
{ }

createKeplerianOrbit

Authorizations:
bearer-key
Request Body schema: application/json
required
anomaly
required
number <double>

Units: [deg]

argumentOfPerigee
required
number <double>

Units: [deg]

date
required
string

UTC date

eccentricity
required
number <double>

Units: [-]

frame
required
string
Enum: "EME2000" "ECI" "TEME" "GCRF" "GTOD" "ECF" "TNW" "QSW"
id
string <uuid>
inclination
required
number <double>

Units: [deg]

meanOscType
required
string
Enum: "MEAN" "OSC"
positionAngleType
required
string
Enum: "TRUE" "MEAN" "ECCENTRIC"
raan
required
number <double>

Units: [deg]

semiMajorAxis
required
number <double>

Units: [km]

Responses

Request samples

Content type
application/json
{
  • "anomaly": 0.1,
  • "argumentOfPerigee": 0.1,
  • "date": "string",
  • "eccentricity": 0.1,
  • "frame": "EME2000",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "inclination": 0.1,
  • "meanOscType": "MEAN",
  • "positionAngleType": "TRUE",
  • "raan": 0.1,
  • "semiMajorAxis": 0.1
}

Response samples

Content type
application/json
{ }

deleteOrbit

Authorizations:
bearer-key
path Parameters
id
required
string <uuid>

Responses

retrieveOrbitById

Authorizations:
bearer-key
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{ }

retrieveAll_2

Authorizations:
bearer-key

Responses

Response samples

Content type
application/json
[
  • { }
]

Orbital State

Orbital State related endpoints

createOrbitalState

Authorizations:
bearer-key
Request Body schema: application/json
required
covarianceMatrixId
string <uuid>
orbitId
string <uuid>

Orbit ID (osculating or mean) is mandatory if no TLE is provided.

propagationContextId
required
string <uuid>
spacecraftId
required
string <uuid>
object (TLE)

Responses

Request samples

Content type
application/json
{
  • "covarianceMatrixId": "5b5ec652-36e4-4616-a0d9-707fed44d34c",
  • "orbitId": "1715fbdf-0ab7-4b83-a7d3-ef12b11aa213",
  • "propagationContextId": "13f9c5e0-1189-48c8-9910-4eb211e07b0a",
  • "spacecraftId": "10d939b7-63d0-4441-a1c9-dc380aafe23a",
  • "tle": {
    }
}

Response samples

Content type
application/json
{
  • "covarianceMatrixId": "5b5ec652-36e4-4616-a0d9-707fed44d34c",
  • "creationDate": "string",
  • "fittedTle": {
    },
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "meanOrbitId": "dac2598d-25aa-4954-afea-11d2e99e0b13",
  • "osculatingOrbitId": "82197dae-a047-454b-8bad-04fc81ad59d4",
  • "propagationContextId": "13f9c5e0-1189-48c8-9910-4eb211e07b0a",
  • "source": "ORBIT_DETERMINATION",
  • "spacecraftId": "10d939b7-63d0-4441-a1c9-dc380aafe23a"
}

deleteOrbitalState

Authorizations:
bearer-key
path Parameters
id
required
string <uuid>

Responses

retrieveOrbitalStateById

Authorizations:
bearer-key
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "covarianceMatrixId": "5b5ec652-36e4-4616-a0d9-707fed44d34c",
  • "creationDate": "string",
  • "fittedTle": {
    },
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "meanOrbitId": "dac2598d-25aa-4954-afea-11d2e99e0b13",
  • "osculatingOrbitId": "82197dae-a047-454b-8bad-04fc81ad59d4",
  • "propagationContextId": "13f9c5e0-1189-48c8-9910-4eb211e07b0a",
  • "source": "ORBIT_DETERMINATION",
  • "spacecraftId": "10d939b7-63d0-4441-a1c9-dc380aafe23a"
}

retrieveAll_3

Authorizations:
bearer-key

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Measurements Request

Measurements Request related endpoints

retrieveAll_6

Responses

Response samples

Content type
application/json
[
  • { }
]

createGpsNmeaMeasurementsRequest

Authorizations:
bearer-key
Request Body schema: application/json
required
altitudeStandardDeviation
required
number <double>

Expected altitude standard deviation. Units: [m]

generationStep
required
integer <int32>

Units: [s]

groundSpeedStandardDeviation
required
number <double>

Expected ground speed standard deviation. Units: [m/s]

id
string <uuid>
latitudeStandardDeviation
required
number <double>

Expected latitude standard deviation. Units: [deg]

longitudeStandardDeviation
required
number <double>

Expected longitude standard deviation. Units: [deg]

Responses

Request samples

Content type
application/json
{
  • "altitudeStandardDeviation": 0.1,
  • "generationStep": 0,
  • "groundSpeedStandardDeviation": 0.1,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "latitudeStandardDeviation": 0.1,
  • "longitudeStandardDeviation": 0.1
}

Response samples

Content type
application/json
{ }

createGpsMeasurementsRequest

Authorizations:
bearer-key
Request Body schema: application/json
required
frame
required
string
Enum: "EME2000" "ECI" "TEME" "GCRF" "GTOD" "ECF" "TNW" "QSW"
generationStep
required
integer <int32>

Units: [s]

id
string <uuid>
positionStandardDeviation
required
number <double>

Units: [m]

velocityStandardDeviation
required
number <double>

Units: [m/s]

Responses

Request samples

Content type
application/json
{
  • "frame": "EME2000",
  • "generationStep": 0,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "positionStandardDeviation": 0.1,
  • "velocityStandardDeviation": 0.1
}

Response samples

Content type
application/json
{ }

createOpticalMeasurementsRequest

Authorizations:
bearer-key
Request Body schema: application/json
required
azimuthStandardDeviation
required
number <double>

Units: [deg]

elevationStandardDeviation
required
number <double>

Units: [deg]

generationStep
required
integer <int32>

Units: [s]

groundStationId
required
string <uuid>

The UUID of the observation station

id
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "azimuthStandardDeviation": 0.1,
  • "elevationStandardDeviation": 0.1,
  • "generationStep": 0,
  • "groundStationId": "0e2bedfa-2c13-4217-8e1d-51aa401edc4b",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Response samples

Content type
application/json
{ }

createRadarMeasurementsRequest

Authorizations:
bearer-key
Request Body schema: application/json
required
azimuthStandardDeviation
required
number <double>

Units: [deg]

elevationStandardDeviation
required
number <double>

Units: [deg]

generationStep
required
integer <int32>

Units: [s]

groundStationId
required
string <uuid>

The UUID of the tracking station

id
string <uuid>
rangeRateStandardDeviation
required
number <double>

Units: [m/s]

rangeStandardDeviation
required
number <double>

Units: [m]

twoWayMeasurement
required
boolean

True for a two way signal

Responses

Request samples

Content type
application/json
{
  • "azimuthStandardDeviation": 0.1,
  • "elevationStandardDeviation": 0.1,
  • "generationStep": 0,
  • "groundStationId": "0e2bedfa-2c13-4217-8e1d-51aa401edc4b",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "rangeRateStandardDeviation": 0.1,
  • "rangeStandardDeviation": 0.1,
  • "twoWayMeasurement": true
}

Response samples

Content type
application/json
{ }

deleteMeasurementsRequest

Authorizations:
bearer-key
path Parameters
id
required
string <uuid>

Responses

retrieveMeasurementsRequestById

Authorizations:
bearer-key
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{ }

TLE SGP4 Extrapolation

TLE SGP4 Extrapolation related endpoints

extrapolateTle

Authorizations:
bearer-key
Request Body schema: application/json
required
dates
required
Array of strings
required
object (TLE)

Responses

Request samples

Content type
application/json
{
  • "dates": [
    ],
  • "initialTle": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "orbits": [
    ],
  • "tleExtrapolation": {
    }
}

getTleExtrapolationResult

Authorizations:
bearer-key
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "orbits": [
    ],
  • "tleExtrapolation": {
    }
}

getTleExtrapolation

Authorizations:
bearer-key
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "dates": [
    ],
  • "initialTle": {
    }
}

getTleExtrapolationResultByExtrapolationId

Authorizations:
bearer-key
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

retrieveAllTleExtrapolations

Authorizations:
bearer-key

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Orbit Data Message Request

Orbit Data Message Request related endpoints

retrieveAll_4

Responses

Response samples

Content type
application/json
[
  • { }
]

createOemRequest

Authorizations:
bearer-key
Request Body schema: application/json
required
creator
required
string
ephemeridesStep
required
number <double>

Units: [s]

frame
required
string
Enum: "EME2000" "ECI" "TEME" "GCRF" "GTOD" "ECF" "TNW" "QSW"

The frame must be inertial

id
string <uuid>
objectId
required
string
objectName
required
string
writeAcceleration
boolean

Include the accelerations in the output file

writeCovariance
boolean

Include the covariance matrices in the output file

Responses

Request samples

Content type
application/json
{
  • "creator": "string",
  • "ephemeridesStep": 0.1,
  • "frame": "EME2000",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "objectId": "string",
  • "objectName": "string",
  • "writeAcceleration": true,
  • "writeCovariance": true
}

Response samples

Content type
application/json
{ }

deleteOrbitDataMessageRequest

Authorizations:
bearer-key
path Parameters
id
required
string <uuid>

Responses

retrieveOrbitDataMessageRequestById

Authorizations:
bearer-key
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{ }

Orbit Determination

Orbit Determination related endpoints

getOrbitDeterminationResult

Authorizations:
bearer-key
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "estimatedStates": [
    ],
  • "firingAnalysisReport": {
    },
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "inDepthResults": {
    },
  • "log": {
    },
  • "report": {
    },
  • "request": { },
  • "status": "SUCCESS"
}

runUkfOrbitDetermination

Authorizations:
bearer-key
Request Body schema: application/json
required
configurationId
required
string <uuid>
estimatedResultsMinStep
number <double>

Minimum step for the estimated results. Unit: s.

initialOrbitalStateId
required
string <uuid>
parameterEstimationRequestIds
Array of strings <uuid> [ items <uuid > ]
roadmapId
string <uuid>
telemetryId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "configurationId": "254ffdcc-3725-465c-b0a0-22afb2bec267",
  • "estimatedResultsMinStep": 0.1,
  • "initialOrbitalStateId": "d60137d3-8f02-459a-b1e1-02f8d1558b5d",
  • "parameterEstimationRequestIds": [
    ],
  • "roadmapId": "c17cc406-f776-4ae2-967c-6cc230b7f3bf",
  • "telemetryId": "d68cc54d-e0c9-4d44-be7d-1ee9a4219304"
}

Response samples

Content type
application/json
{
  • "estimatedStates": [
    ],
  • "firingAnalysisReport": {
    },
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "inDepthResults": {
    },
  • "log": {
    },
  • "report": {
    },
  • "request": { },
  • "status": "SUCCESS"
}

getOrbitDetermination

Authorizations:
bearer-key
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{ }

getOrbitDeterminationResultByDeterminationId

Authorizations:
bearer-key
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

retrieveAllOrbitDeterminations

Authorizations:
bearer-key

Responses

Response samples

Content type
application/json
[
  • { }
]

Battery

Battery related endpoints

retrieveAllBatteries

Authorizations:
bearer-key

Responses

Response samples

Content type
application/json
[
  • {
    }
]

createBattery

Authorizations:
bearer-key
Request Body schema: application/json
required
depthOfDischarge
required
number <double> [ 0 .. 1 ]

x in (0,1), Units: [-]

id
string <uuid>
initialCharge
required
number <double> [ 0 .. 1 ]

x in (0,1], Units: [-]

minimumChargeForFiring
required
number <double> [ 0 .. 1 ]

x in (0,1), Units: [-]

nominalCapacity
required
number <double> >= 0

Units: [Wh]

Responses

Request samples

Content type
application/json
{
  • "depthOfDischarge": 1,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "initialCharge": 1,
  • "minimumChargeForFiring": 1,
  • "nominalCapacity": 0.1
}

Response samples

Content type
application/json
{
  • "depthOfDischarge": 1,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "initialCharge": 1,
  • "minimumChargeForFiring": 1,
  • "nominalCapacity": 0.1
}

deleteBattery

Authorizations:
bearer-key
path Parameters
id
required
string <uuid>

Responses

retrieveBattery

Authorizations:
bearer-key
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "depthOfDischarge": 1,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "initialCharge": 1,
  • "minimumChargeForFiring": 1,
  • "nominalCapacity": 0.1
}

Maneuver Strategy

Maneuver Strategy related endpoints

retrieveAll_7

Authorizations:
bearer-key

Responses

Response samples

Content type
application/json
[
  • {
    }
]

createManeuverStrategy

Authorizations:
bearer-key
Request Body schema: application/json
required
id
string <uuid>
numberOfRestOrbits
required
integer <int32>

Units: [-]

numberOfShiftOrbits
required
integer <int32>

Units: [-]

numberOfThrustOrbits
required
integer <int32>

Units: [-]

orbitalDutyCycle
number <double>

Units: [%]

stopThrustAtEclipse
required
boolean
thrustArcDefinition
required
string
Enum: "DUTY_CYCLE" "THRUST_DURATION"
thrustArcDuration
number <double>

Units: [s]

thrustArcsNumber
required
string
Enum: "ONE" "TWO"
thrustArcsPosition
required
string
Enum: "ASCENDING_AND_DESCENDING_NODES" "ASCENDING_NODE" "CUSTOM" "DESCENDING_NODE" "APOGEE_AND_PERIGEE" "APOGEE" "PERIGEE" "ASCENDING_AND_DESCENDING_ANTINODES" "ASCENDING_ANTINODE" "DESCENDING_ANTINODE" "MEAN_LONGITUDE"

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "numberOfRestOrbits": 0,
  • "numberOfShiftOrbits": 0,
  • "numberOfThrustOrbits": 0,
  • "orbitalDutyCycle": 0.1,
  • "stopThrustAtEclipse": true,
  • "thrustArcDefinition": "DUTY_CYCLE",
  • "thrustArcDuration": 0.1,
  • "thrustArcsNumber": "ONE",
  • "thrustArcsPosition": "ASCENDING_AND_DESCENDING_NODES"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "numberOfRestOrbits": 0,
  • "numberOfShiftOrbits": 0,
  • "numberOfThrustOrbits": 0,
  • "orbitalDutyCycle": 0.1,
  • "stopThrustAtEclipse": true,
  • "thrustArcDefinition": "DUTY_CYCLE",
  • "thrustArcDuration": 0.1,
  • "thrustArcsNumber": "ONE",
  • "thrustArcsPosition": "ASCENDING_AND_DESCENDING_NODES"
}

deleteManoeuvreStrategy

Authorizations:
bearer-key
path Parameters
id
required
string <uuid>

Responses

retrieveManoeuvreStrategyById

Authorizations:
bearer-key
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "numberOfRestOrbits": 0,
  • "numberOfShiftOrbits": 0,
  • "numberOfThrustOrbits": 0,
  • "orbitalDutyCycle": 0.1,
  • "stopThrustAtEclipse": true,
  • "thrustArcDefinition": "DUTY_CYCLE",
  • "thrustArcDuration": 0.1,
  • "thrustArcsNumber": "ONE",
  • "thrustArcsPosition": "ASCENDING_AND_DESCENDING_NODES"
}

Spacecraft

Spacecraft related endpoints

createBoxSpacecraft

Authorizations:
bearer-key
Request Body schema: application/json
required
batteryId
required
string <uuid>
dragCoefficient
required
number <double>

Units: [-]

id
string <uuid>
maxAngularAcceleration
required
number <double>

Units: [deg/s²]

maxAngularVelocity
required
number <double>

Units: [deg/s]

platformMass
required
number <double>
reflectionCoefficient
number <double>

Units: [-]

solarArrayId
required
string <uuid>
spacecraftLengthX
required
number <double>

Units: [m]

spacecraftLengthY
required
number <double>

Units: [m]

spacecraftLengthZ
required
number <double>

Units: [m]

thrusterId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "batteryId": "c2b3dd8f-c3ea-4036-9ad2-c21f056c3506",
  • "dragCoefficient": 0.1,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "maxAngularAcceleration": 0.1,
  • "maxAngularVelocity": 0.1,
  • "platformMass": 0.1,
  • "reflectionCoefficient": 0.1,
  • "solarArrayId": "77b1aa4c-e672-446e-9a7d-e261d263336f",
  • "spacecraftLengthX": 0.1,
  • "spacecraftLengthY": 0.1,
  • "spacecraftLengthZ": 0.1,
  • "thrusterId": "f558f6c8-2eb4-4ff1-8f14-b1e59e289093"
}

Response samples

Content type
application/json
{ }

createSphericalSpacecraft

Authorizations:
bearer-key
Request Body schema: application/json
required
dragCoefficient
required
number <double>

Units: [-]

id
string <uuid>
platformMass
required
number <double>

Units: [kg]

reflectionCoefficient
number <double>

Units: [-]

sphericalCrossSection
required
number <double>

Units: [m²]

Responses

Request samples

Content type
application/json
{
  • "dragCoefficient": 0.1,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "platformMass": 0.1,
  • "reflectionCoefficient": 0.1,
  • "sphericalCrossSection": 0.1
}

Response samples

Content type
application/json
{ }

deleteSpacecraft

Authorizations:
bearer-key
path Parameters
id
required
string <uuid>

Responses

retrieveSpacecraft

Authorizations:
bearer-key
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{ }

retrieveAll

Authorizations:
bearer-key

Responses

Response samples

Content type
application/json
[
  • { }
]

Thruster

Thruster related endpoints

createChemicalThruster

Authorizations:
bearer-key
Request Body schema: application/json
required
id
string <uuid>
impulse
required
number <double>

Units: [Ns]

maximumThrustDuration
required
number <double>

Units: [s]

propellantMass
required
number <double>

Units: [kg]

thrust
required
number <double>

Units: [N]

thrusterAxisInSatelliteFrame
required
Array of numbers <double> [ items <double > ]
thrusterIsp
required
number <double>

Units: [s]

thrusterTotalMass
required
number <double>

Wet mass. Units: [kg]

warmUpDuration
required
number <double>

Units: [s]

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "impulse": 0.1,
  • "maximumThrustDuration": 0.1,
  • "propellantMass": 0.1,
  • "thrust": 0.1,
  • "thrusterAxisInSatelliteFrame": [
    ],
  • "thrusterIsp": 0.1,
  • "thrusterTotalMass": 0.1,
  • "warmUpDuration": 0.1
}

Response samples

Content type
application/json
{ }

createElectricalThruster

Authorizations:
bearer-key
Request Body schema: application/json
required
id
string <uuid>
impulse
required
number <double>

Units: [Ns]

maximumThrustDuration
required
number <double>

Units: [s]

propellantMass
required
number <double>

Units: [kg]

standByPower
required
number <double>

Units: [W]

thrust
required
number <double>

Units: [N]

thrusterAxisInSatelliteFrame
required
Array of numbers <double> [ items <double > ]
thrusterIsp
required
number <double>

Units: [s]

thrusterPower
required
number <double>

Units: [W]

thrusterTotalMass
required
number <double>

Wet mass. Units: [kg]

warmUpDuration
required
number <double>

Units: [s]

warmUpPower
required
number <double>

Units: [W]

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "impulse": 0.1,
  • "maximumThrustDuration": 0.1,
  • "propellantMass": 0.1,
  • "standByPower": 0.1,
  • "thrust": 0.1,
  • "thrusterAxisInSatelliteFrame": [
    ],
  • "thrusterIsp": 0.1,
  • "thrusterPower": 0.1,
  • "thrusterTotalMass": 0.1,
  • "warmUpDuration": 0.1,
  • "warmUpPower": 0.1
}

Response samples

Content type
application/json
{ }

deleteThruster

Authorizations:
bearer-key
path Parameters
id
required
string <uuid>

Responses

retrieveThruster

Authorizations:
bearer-key
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{ }

retrieveAllThrusters

Authorizations:
bearer-key

Responses

Response samples

Content type
application/json
[
  • { }
]

Roadmap

Roadmap related endpoints

createRoadmap

Authorizations:
bearer-key
Request Body schema: application/json
required
finalDate
required
string

UTC date

id
string <uuid>
initialDate
required
string

UTC date

roadmapActionIDs
required
Array of strings <uuid> [ items <uuid > ]

The UUIDs of the roadmap actions (firing, attitude or quaternion) to be executed

Responses

Request samples

Content type
application/json
{
  • "finalDate": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "initialDate": "string",
  • "roadmapActionIDs": [
    ]
}

Response samples

Content type
application/json
{ }

deleteRoadmap

Authorizations:
bearer-key
path Parameters
id
required
string <uuid>

Responses

retrieveRoadmap

Authorizations:
bearer-key
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{ }

retrieveAllRoadmaps

Authorizations:
bearer-key

Responses

Response samples

Content type
application/json
[
  • { }
]

Events Request

Events Request related endpoints

createEventRequest

Authorizations:
bearer-key
Request Body schema: application/json
required
eventsType
required
Array of strings
Items Enum: "NODE" "ECLIPSE" "ORBITAL_6AMPM" "ORBITAL_NOON_MIDNIGHT" "APSIDE"
id
string <uuid>
startDate
string

UTC date

Responses

Request samples

Content type
application/json
{
  • "eventsType": [
    ],
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "startDate": "string"
}

Response samples

Content type
application/json
{ }

createSensorEventRequest

Authorizations:
bearer-key
Request Body schema: application/json
required
ephemeridesStep
required
number <double>
eventsType
required
Array of strings
Items Value: "SUN_IN_FOV"
id
string <uuid>
sensorAxisInSpacecraftFrame
required
Array of numbers <double> [ items <double > ]
sensorFieldOfViewHalfAngle
required
number <double>

The half angle defining the conical field of view. Units [deg]

startDate
string

UTC date

Responses

Request samples

Content type
application/json
{
  • "ephemeridesStep": 0.1,
  • "eventsType": [
    ],
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "sensorAxisInSpacecraftFrame": [
    ],
  • "sensorFieldOfViewHalfAngle": 0.1,
  • "startDate": "string"
}

Response samples

Content type
application/json
{ }

createStationVisibilityEventRequest

Authorizations:
bearer-key
Request Body schema: application/json
required
groundStationIDs
required
Array of strings <uuid> [ items <uuid > ]

The station's UUID

id
string <uuid>
startDate
string

UTC date

Responses

Request samples

Content type
application/json
{
  • "groundStationIDs": [
    ],
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "startDate": "string"
}

Response samples

Content type
application/json
{ }

deleteEventRequest

Authorizations:
bearer-key
path Parameters
id
required
string <uuid>

Responses

retrieveEventsRequest

Authorizations:
bearer-key
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{ }

retrieveAll_8

Authorizations:
bearer-key

Responses

Response samples

Content type
application/json
[
  • { }
]

Ground Station

Ground Station related endpoints

createGroundStation

Authorizations:
bearer-key
Request Body schema: application/json
required
altitude
required
number <double>

Units: [km]

elevationMask
Array of numbers[ items <double >[ items <double > ] ]

Units: Double[deg][deg]

id
string <uuid>
latitude
required
number <double>

Units: [deg]

longitude
required
number <double>

Units: [deg]

minElevation
number <double>

Units: [deg]

name
required
string

Responses

Request samples

Content type
application/json
{
  • "altitude": 0.1,
  • "elevationMask": [
    ],
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "latitude": 0.1,
  • "longitude": 0.1,
  • "minElevation": 0.1,
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "altitude": 0.1,
  • "elevationMask": [
    ],
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "latitude": 0.1,
  • "longitude": 0.1,
  • "minElevation": 0.1,
  • "name": "string"
}

deleteGroundStation

Authorizations:
bearer-key
path Parameters
id
required
string <uuid>

Responses

retrieveGroundStation

Authorizations:
bearer-key
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "altitude": 0.1,
  • "elevationMask": [
    ],
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "latitude": 0.1,
  • "longitude": 0.1,
  • "minElevation": 0.1,
  • "name": "string"
}

retrieveAllStations

Authorizations:
bearer-key

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Propagation Context

Propagation Context related endpoints

createPropagationContext

Authorizations:
bearer-key
Request Body schema: application/json
required
atmosphereType
string
Enum: "HARRIS_PRIESTER" "NRL_MSISE00"

Required if perturbations include DRAG

earthPotentialDeg
integer <int32> >= 2

Required if perturbations include EARTH_POTENTIAL. Value must be earthPotentialDeg > 2. Units: [-]

earthPotentialOrd
integer <int32>

Required if perturbations include EARTH_POTENTIAL. Value must be 0 <= earthPotentialOrd <= earthPotentialDeg. Units: [-]

id
string <uuid>
integratorMaxStep
number <double> [ 0.001 .. 86400 ]
Default: 100

Units: [s]. Default 100 s. Must be integratorMaxStep > integratorMinStep.

integratorMinStep
number <double> [ 0.001 .. 86400 ]
Default: 0.01

Units: [s]. Default 0.01 s. Must be integratorMinStep > 0.001 s.

integratorType
string
Enum: "DORMAND_PRINCE_853" "DORMAND_PRINCE_54" "ADAMS_MOULTON" "RUNGE_KUTTA"
perturbations
Array of strings unique
Items Enum: "EARTH_POTENTIAL" "SRP" "THIRD_BODY" "DRAG" "CONSTANT_THRUST" "IMPULSIVE_THRUST"

Default to DORMAND_PRINCE_853.

solarFlux
number <double>

Required if perturbations include DRAG. Units: [sfu]

Responses

Request samples

Content type
application/json
{
  • "atmosphereType": "HARRIS_PRIESTER",
  • "earthPotentialDeg": 2,
  • "earthPotentialOrd": 0,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "integratorMaxStep": 100,
  • "integratorMinStep": 0.01,
  • "integratorType": "DORMAND_PRINCE_853",
  • "perturbations": [
    ],
  • "solarFlux": 0.1
}

Response samples

Content type
application/json
{
  • "atmosphereType": "HARRIS_PRIESTER",
  • "earthPotentialDeg": 2,
  • "earthPotentialOrd": 0,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "integratorMaxStep": 100,
  • "integratorMinStep": 0.01,
  • "integratorType": "DORMAND_PRINCE_853",
  • "perturbations": [
    ],
  • "solarFlux": 0.1
}

deletePropagationContext

Authorizations:
bearer-key
path Parameters
id
required
string <uuid>

Responses

retrieveContext

Authorizations:
bearer-key
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "atmosphereType": "HARRIS_PRIESTER",
  • "earthPotentialDeg": 2,
  • "earthPotentialOrd": 0,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "integratorMaxStep": 100,
  • "integratorMinStep": 0.01,
  • "integratorType": "DORMAND_PRINCE_853",
  • "perturbations": [
    ],
  • "solarFlux": 0.1
}

retrieveAllContexts

Authorizations:
bearer-key

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Roadmap Action

Roadmap Action related endpoints

createAttitudeAction

Authorizations:
bearer-key
Request Body schema: application/json
required
attitudeMode
required
string
Enum: "PROGRADE" "RETROGRADE" "NORMAL" "ANTI_NORMAL" "RADIAL" "ANTI_RADIAL" "QUATERNION" "NONE" "SUN_POINTING" "TELECOM" "PAYLOAD" "TRANSITIONAL" "LOF_ALIGNED_LVLH_CCSDS" "RETROGRADE_NADIR"

Attitude list, can contains quaternions

id
string <uuid>
Array of objects (QuaternionActionDto)

List of quaternions related to the current attitude. Required if attitudeMode is QUATERNION

transitionDate
required
string

UTC date

Responses

Request samples

Content type
application/json
{
  • "attitudeMode": "PROGRADE",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "quaternions": [
    ],
  • "transitionDate": "string"
}

Response samples

Content type
application/json
{ }

createFiringAction

Authorizations:
bearer-key
Request Body schema: application/json
required
firingAttitude
required
string
Enum: "PROGRADE" "RETROGRADE" "NORMAL" "ANTI_NORMAL" "RADIAL" "ANTI_RADIAL" "QUATERNION" "NONE" "SUN_POINTING" "TELECOM" "PAYLOAD" "TRANSITIONAL" "LOF_ALIGNED_LVLH_CCSDS" "RETROGRADE_NADIR"
firingDuration
required
number <double>

Units: [s]

id
string <uuid>
postFiringAttitude
required
string
Enum: "PROGRADE" "RETROGRADE" "NORMAL" "ANTI_NORMAL" "RADIAL" "ANTI_RADIAL" "QUATERNION" "NONE" "SUN_POINTING" "TELECOM" "PAYLOAD" "TRANSITIONAL" "LOF_ALIGNED_LVLH_CCSDS" "RETROGRADE_NADIR"
startFiring
required
string

UTC date

warmUpAttitude
string
Enum: "PROGRADE" "RETROGRADE" "NORMAL" "ANTI_NORMAL" "RADIAL" "ANTI_RADIAL" "QUATERNION" "NONE" "SUN_POINTING" "TELECOM" "PAYLOAD" "TRANSITIONAL" "LOF_ALIGNED_LVLH_CCSDS" "RETROGRADE_NADIR"
warmUpDuration
required
number <double>

Units: [s]

Responses

Request samples

Content type
application/json
{
  • "firingAttitude": "PROGRADE",
  • "firingDuration": 0.1,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "postFiringAttitude": "PROGRADE",
  • "startFiring": "string",
  • "warmUpAttitude": "PROGRADE",
  • "warmUpDuration": 0.1
}

Response samples

Content type
application/json
{ }

createQuaternionAction

Authorizations:
bearer-key
Request Body schema: application/json
required
id
string <uuid>
q0
required
number <double>
Default: 1

Scalar component. Units: [-]

q1
required
number <double>

Vector part of the quaternion. First component. Units: [-]

q2
required
number <double>

Vector part of the quaternion. Second component. Units: [-]

q3
required
number <double>

Vector part of the quaternion. Third component. Units: [-]

transitionDate
required
string

UTC date

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "q0": 1,
  • "q1": 0.1,
  • "q2": 0.1,
  • "q3": 0.1,
  • "transitionDate": "string"
}

Response samples

Content type
application/json
{ }

deleteRoadmapAction

Authorizations:
bearer-key
path Parameters
id
required
string <uuid>

Responses

retrieveRoadmapAction

Authorizations:
bearer-key
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{ }

retrieveAllRoadmapActions

Authorizations:
bearer-key

Responses

Response samples

Content type
application/json
[
  • { }
]