get map elements - dji-cloud-api

In the first connection, pilot will send out this http request to get the group element list.
Also, if pilot receives a group refresh instruction from WebSocket,
it needs the same interface to request the group element list.
get map elements
In the first connection, pilot will send out this http request to get the group element list. Also, if pilot receives a group refresh instruction from WebSocket, it needs the same interface to request the group element list.

请求参数

Path 参数

workspaceId

string

必需

Query 参数

group_id

string

可选

element group id. The same element group can contain multiple map elements, which is equivalent to grouping map elements. When initiating the request, if the group id parameter is not included, the server needs to return all map elements. If the group id is specified, it only needs to return the set of elements in the specified element group

is_distributed

boolean

可选

Whether the element group is distributed.

workspace_id

可选

workspace id

Header 参数

x-auth-token

string

可选

默认值:

eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ3b3Jrc3BhY2VfaWQiOiJlM2RlYTBmNS0zN2YyLTRkNzktYWU1OC00OTBhZjMyMjgwNjkiLCJzdWIiOiJDbG91ZEFwaVNhbXBsZSIsInVzZXJfdHlwZSI6IjEiLCJuYmYiOjE3NDkwODYzMDEsImxvZyI6IkxvZ2dlcltjb20uZGppLnNhbXBsZS5jb21tb24ubW9kZWwuQ3VzdG9tQ2xhaW1dIiwiaXNzIjoiREpJIiwiaWQiOiJhMTU1OWU3Yy04ZGQ4LTQ3ODAtYjk1Mi0xMDBjYzQ3OTdkYTIiLCJleHAiOjE4MzU0ODYzMDEsImlhdCI6MTc0OTA4NjMwMSwidXNlcm5hbWUiOiJhZG1pblBDIn0.W5x4fh7PWALqknARx8aoGQhK8ci5t6U7mITN1Gbn4H0

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

code

integer

可选

0 means success, non-zero means error.

示例值:

message

string

可选

The response message.

示例值:

success

data

array[object (GetMapElementsResponse) {5}]

可选

The response data.

is_lock

boolean

必需

Whether the element group is locked.

string

group id

必需

正则匹配:

^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

name

string

必需

group name

示例值:

Pilot Share Layer

type

enum<string>

必需

枚举值:

CUSTOMDEFAULTSHARED

elements

array[object (MapGroupElement) {5}]

必需

data collection of elements

示例

{
  "code": 0,
  "message": "",
  "data": [
    {
      "is_lock": false,
      "id": "",
      "name": "",
      "type": "",
      "elements": [
        {
          "create_time": 0,
          "update_time": 0,
          "id": "",
          "name": "",
          "resource": {
            "user_name": "",
            "type": "",
            "content": {
              "type": "",
              "properties": {
                "clampToGround": false,
                "color": ""
              },
              "geometry": {
                "type": ""
              }
            }
          }
        }
      ]
    }
  ]
}