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 list

Developing
GET
/openapi/v0.1/flight-task/list
Get the flight task list. You can obtain the flight task list by passing in the task time, task start time, task end time, task type, and task status as filters.

Request

Query Params
sn
string 
required
device sn
name
string 
optional
Task name, optional.
begin_at
number 
required
Task start timestamp
end_at
number 
required
Task end timestamp
task_type
enum<string> 
optional
Task type: immediate, timed, recurring, continuous, optional, if not filled, it will include all types
Allowed values:
immediatetimedrecurringcontinuous
status
array[string]
optional
Task status array: waiting, starting_failure, executing, paused, terminated, success, suspended, timeout, optional, if not filled, it will include all statuses
Example:
[""]
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/list?sn&begin_at&end_at' \
--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
list
array [object {19}] 
required
Example
{
  "code": 0,
  "message": "OK",
  "data": {
    "list": [
      {
        "name": "",
        "uuid": "",
        "task_type": "",
        "status": "",
        "sn": "",
        "landing_dock_sn": "",
        "begin_at": "",
        "end_at": "",
        "run_at": "",
        "completed_at": "",
        "wayline_uuid": "",
        "folder_id": 123,
        "current_waypoint_index": 1,
        "total_waypoints": 3,
        "media_upload_status": "",
        "resumable_status": "",
        "is_break_point_resume": true,
        "operations": {
          "operator_account": ""
        },
        "exceptions": {
          "code": 20000,
          "message": "",
          "happen_at": "",
          "sn": ""
        }
      }
    ]
  }
}
Previous
Updated flight task status
Next
Obtain media resources generated by the Flight task
Built with