UNISPHERE
  • Welcome to Unisphere Product Documentation
  • NOVA
    • Get started
      • Create an account
      • Create a new mission
      • Create your assets
      • Edit your Mission
      • Manage your profile
        • Settings
    • Mission types
      • Local-Flight
      • Multi-Location
      • Route
    • Assets
      • Aircraft Type
      • Performance Set
      • Limit Set
        • Limit thresholds types
        • Weather and Operational Parameters
      • Locations & Routes
    • Mission results
      • NOW
        • Local-Flight
        • Multi-Location
        • Route
      • AWARE
        • Local-Flight
        • Multi-Location
        • Route
      • CAST
        • Local-Flight
        • Multi-Location
        • Route
      • Maps
    • Glossary
    • NOVA Release Log
  • OPERATIONAL ANALYTICS
    • Create your analysis
    • Manage your analysis
    • Analytics assets
    • Analysis types
      • Wind Analysis
      • Service Availability
      • Benchmark Analysis
    • Analysis results
      • Wind Analysis
      • Service Availability
      • Benchmark Analysis
      • Map Overview
  • UNISPHERE APIs
    • Introduction to Unisphere APIs
    • API Access
    • Flight Trajectory Simulation - FTS
      • FTS2 Endpoints
    • Check My Flight - CMF
      • CMF Endpoints
      • CMF Supporting Functions
    • Check My Mission - CMM
      • CMM Endpoints
      • CMM Supporting Functions
    • Data Storage & Logging
    • Asset Management Endpoints
    • API Key Management
    • Utilities & Health
    • Explanatory Notes
      • Available Parameters
      • Speeds
    • Geo Information Service
  • FAQ
Powered by GitBook
On this page

Was this helpful?

  1. UNISPHERE APIs
  2. Check My Mission - CMM

CMM Endpoints

PreviousCheck My Mission - CMMNextCMM Supporting Functions

Last updated 5 months ago

Was this helpful?

Get Results

Get Extended Results

Get Cmm

get
Authorizations
Path parameters
simulation_idstringrequired
Query parameters
extendedbooleanoptionalDefault: false
Responses
application/json
any ofoptional
application/json
get
GET /check-my-mission/v1/cmm/{simulation_id} HTTP/1.1
Host: 
x-api-key: YOUR_API_KEY
Accept: */*

{
  "simulation_id": "text",
  "simulation_time": "2025-04-16T10:05:29.555Z",
  "route_distance": 1,
  "zero_wind_flight_time": 1,
  "elevation_at_take_off": 1,
  "elevation_at_landing": 1,
  "routes": [
    {
      "flight_status": {
        "evaluation": "nominal",
        "reasons_moderate": [
          "text"
        ],
        "reasons_severe": [
          "text"
        ]
      },
      "take_off_time": "2025-04-16T10:05:29.555Z",
      "flight_time": 1,
      "landing_time": "2025-04-16T10:05:29.555Z",
      "soc_at_take_off_percent": 1,
      "soc_at_landing_percent": 1,
      "endurance_at_take_off": 1,
      "endurance_at_landing": 1,
      "min_max_weather_parameters": [
        {
          "parameter": "text",
          "min": 1,
          "max": 1
        }
      ]
    }
  ]
}

Get Cmm Extended

get
Authorizations
Path parameters
simulation_idstringrequired
take_off_timestringrequired
Responses
application/json
objectoptional
application/json
get
GET /check-my-mission/v1/cmm/{simulation_id}/{take_off_time} HTTP/1.1
Host: 
x-api-key: YOUR_API_KEY
Accept: */*

{
  "simulation_id": "text",
  "simulation_time": "2025-04-16T10:05:29.555Z",
  "route_distance": 1,
  "zero_wind_flight_time": 1,
  "elevation_at_take_off": 1,
  "elevation_at_landing": 1,
  "segments": [
    {
      "latitude": 1,
      "longitude": 1,
      "altitude": 1,
      "timeframe": "text",
      "status": "nominal",
      "speed_gs": {
        "value": 1,
        "unit": "text"
      },
      "speed_eas": {
        "value": 1,
        "unit": "text"
      },
      "weather_parameter": [
        {
          "name": "text",
          "type": "text",
          "value": 1,
          "unit": "text",
          "status": "nominal"
        }
      ]
    }
  ]
}
  • POSTPost Cmm1
  • POSTPost Cmm2
  • POSTPost Cmm3
  • Get Results
  • GETGet Cmm
  • Get Extended Results
  • GETGet Cmm Extended

Post Cmm1

post
Authorizations
Body
mission_idstringrequired
Responses
application/json
objectoptional
application/json
post
POST /check-my-mission/v1/cmm1 HTTP/1.1
Host: 
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 21

{
  "mission_id": "text"
}
{
  "simulation_id": "text"
}

Post Cmm2

post
Authorizations
Body
performance_set_idstring · uuidrequired
limit_set_idsstring · uuid[]required
routeobject[] · min: 2 · max: 100required
Responses
application/json
objectoptional
application/json
post
POST /check-my-mission/v1/cmm2 HTTP/1.1
Host: 
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 203

{
  "performance_set_id": "123e4567-e89b-12d3-a456-426614174000",
  "limit_set_ids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "route": [
    {
      "altitude": 100,
      "altitude_type": "AGL",
      "latitude": 52.52,
      "longitude": 13.404
    }
  ]
}
{
  "simulation_id": "text"
}

Post Cmm3

post
Authorizations
Body
performance_parametersobject[]required
limit_parametersobject[]required
routeobject[] · min: 2 · max: 100required
Responses
application/json
objectoptional
application/json
post
POST /check-my-mission/v1/cmm3 HTTP/1.1
Host: 
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 305

{
  "performance_parameters": [
    {
      "name": "text",
      "type": "text",
      "unit": "text",
      "value": 1
    }
  ],
  "limit_parameters": [
    {
      "name": "text",
      "type": "text",
      "limits": [
        {}
      ],
      "unit": "text",
      "altitude": 1,
      "altitude_type": "text",
      "altitude_unit": "text"
    }
  ],
  "route": [
    {
      "altitude": 100,
      "altitude_type": "AGL",
      "latitude": 52.52,
      "longitude": 13.404
    }
  ]
}
{
  "simulation_id": "text"
}