NEW FlightHub 2 OpenAPI V1.0
  1. Organize Projects
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
      • Get the list of devices under the organization
        GET
      • Obtain the list of devices under the project
        GET
      • Obtain storage upload credentials for the project
        GET
      • Add personnel to the project
        PUT
    • 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
      • Updated flight task status
      • Obtain flight task list
      • Obtain media resources generated by the Flight task
      • Obtain Flight task trajectory information
      • Obtain Flight task information
    • 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. Organize Projects

Get the list of projects under the organization

Developing
GET
/openapi/v0.1/project
Get the list of projects under the organization by setting the user key through the X-User-Token parameter in the Header. This interface will return all project lists under the organization corresponding to the user key.
(1). The data.list.uuid in the project list can be used as a parameter to fill in the X-Project-Uuid in authentication authorization.
(2). The data.list.uuid in the project list can be used as a parameter to pass into [Get Device List Under Project] to obtain information about the devices under the project.

Request

Query Params
page
integer 
optional
Page number for pagination. Default value is 1
Example:
1
page_size
integer 
optional
Number of items per page. Default value is 10
Example:
10
q
string 
optional
Fuzzy search by project name
<= 128 characters
Example:
test
prj_authorized_status
string 
optional
Project scope for query
project-status-authorized : Filter projects that the current user has joined
Example:
project-status-authorized
usage
string 
optional
Query usage
simple : Disable pagination
Example:
simple
sort_column
string 
optional
Project sorting
created_at : Sort by creation time
name : Sort by project name
Example:
created_at
sort_type
string 
optional
Sort order
ASC : Ascending order
DESC : Descending order
Example:
ASC
Header Params
X-Request-Id
string <uuid>
required
Request Unique Identifier
X-Language
enum<string> 
optional
Allowed values:
zhen
Default:
zh

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/project?page=1&page_size=10&q=test&prj_authorized_status=project-status-authorized&usage=simple&sort_column=created_at&sort_type=ASC' \
--header 'X-Request-Id;' \
--header 'X-Language: zh'

Responses

🟢200Success
application/json
Body
code
integer 
required
Non-zero indicates an exception
message
string 
required
Message prompt
data
object 
required
list
array [object {7}] 
required
Example
{
  "code": 0,
  "message": "OK",
  "data": {
    "list": [
      {
        "name": "c2c_test",
        "introduction": "a",
        "uuid": "93df839d-ae74-4f04-842e-2f1f81c89a66",
        "org_uuid": "105ddd05-34ce-46b6-a872-cb32b8c98f64",
        "created_at": 1702498686,
        "updated_at": 1702498686,
        "project_work_center_point": {
          "latitude": 22.906899500237845,
          "longitude": 113.69995967214662
        }
      }
    ]
  }
}
Previous
Organize Project Tutorial
Next
Get the list of devices under the organization
Built with