NEW FlightHub 2 OpenAPI V1.0
  1. Task Management
NEW FlightHub 2 OpenAPI V1.0
  • Root Directory
    • authentication
      • Authentication Tutorial
    • System Service
      • Query FlightHub 2 system status
    • Organize Projects
      • Organize Project Tutorial
      • Get the list of projects under the organization
      • Get the list of devices under the organization
      • Obtain the list of devices under the project
      • Obtain storage upload credentials for the project
      • Add personnel to the project
    • Device Management
      • Device Management Tutorial
      • Device Model Retrieval
      • HMS Information Retrieval
      • Real-time control command distribution
      • Dock camera switch
      • Aircraft Lens Switching
      • Control acquisition
      • Release control
      • Video transmission clarity settings
      • Custom Network RTK Calibration
    • Livestream Management
      • Livestream Management Tutorial
      • Livestream Push
        • Start livestream
      • Bypass Streaming
        • Stream forwarding error code
        • Create Stream Forwarder
        • Enable/Disable stream forwarder
        • Get stream transcoder list
        • Delete stream forwarder
    • Task Management
      • Task Management Tutorial
      • Create Flight Task
        POST
      • Updated flight task status
        PUT
      • Obtain flight task list
        GET
      • Obtain media resources generated by the Flight task
        GET
      • Obtain Flight task trajectory information
        GET
      • Obtain Flight task information
        GET
    • Flight Route Management
      • Flight Route Management Tutorial
      • Flight Route Upload Completion Notification
      • Get the list of flight routes under the project
      • Get flight route details
    • Model Management
      • Model Management Tutorial
      • Model reconstruction coordinate system
      • Get the list of models under the project
      • Get Model Details
      • Model reconstruction
    • Annotation Management
      • Annotation Management Tutorial
      • Create map annotation
  1. Task Management

Obtain Flight task information

GET
/openapi/v0.1/flight-task/{task_uuid}
Obtain flight task information. After starting the connection route task flight, you can use this interface to get task information, the status during the task operation, and information about media files generated by the task, etc.

Request

Path Params
task_uuid
string 
required
Task UUID, the task UUID will be returned after successfully creating a Flight task.
Example:
89328e80-04ee-4089-9482-6bb00ec6bede
Header Params
X-Request-Id
string <uuid>
required
Request Unique Identifier
X-Language
enum<string> 
optional
Allowed values:
zhen
Default:
zh
X-Project-Uuid
string 
optional
Project Number
Default:
{{X-Project-Uuid}}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/openapi/v0.1/flight-task/89328e80-04ee-4089-9482-6bb00ec6bede' \
--header 'X-Request-Id;' \
--header 'X-Language: zh' \
--header 'X-Project-Uuid: {{X-Project-Uuid}}'

Responses

🟢200Success
application/json
Body
code
integer 
required
Non-zero indicates an exception
message
string 
required
Message prompt
data
object 
required
name
string 
required
Task name
uuid
string 
required
Task UUID
task_type
enum<string> 
optional
Task type: Currently only supports immediate tasks
Allowed value:
immediate
sn
string 
required
Dock sn
wayline_uuid
string 
required
Flight route uuid
rth_mode
enum<string> 
required
RTH Mode
Allowed values:
optimalpreset
rth_altitude
integer 
required
RTH Altitude
out_of_control_action_in_flight
enum<string> 
required
Action of the aircraft after losing signal
Allowed values:
return_homecontinue_task
status
enum<string> 
required
Allowed values:
waitingstarting_failureexecutingpausedterminatedsuccesssuspendedtimeout
resumable_status
enum<string> 
required
Resume Flight from Breakpoint
Allowed values:
automanual
begin_at
string 
required
Task schedule execution time
end_at
string 
required
Task End Time
folder_info
object 
required
repeat_type
enum<string> 
required
Task Repeat Mode
Allowed values:
nonrepeatingdailyweeklyabsolute_monthlyrelative_monthly
interval
integer 
required
Repeat interval time: Minimum 1
>= 1
days_of_month
array[integer]
required
Array of execution days each month, which day of the month, 1-31
days_of_week
array[integer]
required
Array of execution days each week, which day of the week, 0-6, 0=Sunday, 1=Monday
week_of_month
integer 
required
Which week of the month,1-4
>= 1<= 4
recurring_task_start_time_list
array[integer]
required
Multiple execution times for repeated tasks, in seconds-level timestamps
continuous_task_periods
array [array] 
required
Multiple execution periods for continuous tasks
min_battery_capacity
integer 
required
inimum battery capacity for continuous task
>= 50<= 100
Example
{
    "code": 0,
    "message": "success",
    "data": {
        "name": "新建计划1",
        "uuid": "0bbc74b4-5e5a-4390-9256-8e4ee08a241b",
        "task_type": "immediate",
        "status": "success",
        "sn": "7CTDM3D00BZNVZ",
        "wayline_uuid": "6eb90ac7-4ec8-4a2c-a470-746e7444e77c",
        "begin_at": "2024-10-29T16:51:47.818707+08:00",
        "end_at": "2024-10-29T16:53:58.818707+08:00",
        "out_of_control_action_in_flight": "return_home",
        "rth_altitude": 100,
        "rth_mode": "preset",
        "resumable_status": "manual"
    }
}
🟠401Unauthorized
Previous
Obtain Flight task trajectory information
Next
Flight Route Management Tutorial
Built with