Flight Task/Task Creation

Create Flight Task

Create a wayline flight task. You can use the Wayline Upload Completion Notification interface to obtain the wayline UUID uploaded to FlightHub 2, then call this interface to create a wayline task

post/openapi/v2.0/flight-task

Request

  • Base URL
    (relative, and it does not resolve against the document’s source URL)
  • URL
    /openapi/v2.0/flight-task
  • Auth
    none required

Headers

X-User-Tokenstring required
X-Project-Uuidstring required

Project Number

X-Request-Idstring

Request Unique Identifier

X-Languagestring

Language, e.g., zh / en

Request body

namestring required

Task Name

snstring required

Dock SN

wayline_uuidstring required

Wayline File UUID

time_zonestring required

Time zone, time zone name in TZ database

task_type'immediate' | 'timed' | 'recurring' | 'continuous' required

Task Type

rth_altitudeinteger

Return-to-Home Altitude

rth_mode'optimal' | 'preset'

Return-to-Home Mode

out_of_control_action_in_flight'return_home' | 'continue_task'

UAV Action After Signal Loss

wayline_precision_type'gps' | 'rtk'

Task Precision

resumable_status'auto' | 'manual'

Auto Resume from Breakpoint

repeat_type'nonrepeating' | 'daily' | 'weekly' | 'absolute_monthly' | 'relative_monthly'

Task Repetition Mode

landing_dock_snstring

Landing Dock SN, not required for non-frog-jump tasks

begin_atinteger

Start time, seconds-level timestamp. Not required for immediate tasks. For timed tasks, this is the task execution time. For recurring and continuous tasks, this is the task start time

end_atinteger

End time, seconds-level timestamp; required for recurring/continuous tasks

recurring_task_start_time_listinteger[]

Multiple start execution times for recurring tasks, seconds-level timestamps; must fall on the same day as begin_at

min_battery_capacityinteger

Minimum Battery Level for Continuous Execution

Example request

{
  "name": "spec-test-create-001",
  "sn": "8UUDMAQ00A0018",
  "wayline_uuid": "1474c01d-3982-45e6-b787-0eacae6b83e7",
  "time_zone": "Asia/Shanghai",
  "task_type": "immediate",
  "rth_altitude": 120,
  "rth_mode": "preset",
  "out_of_control_action_in_flight": "return_home",
  "wayline_precision_type": "rtk",
  "resumable_status": "manual",
  "repeat_type": "nonrepeating"
}

Response

Success

codeinteger

Non-zero Indicates Exception

messagestring

Message Prompt

Example response

{
  "message": "success"
}

Changes

No recorded changes to this operation across all 1 revision of this API.