create map element

POST

/map/api/v1/workspaces/{workspace_id}/element-groups/{group_id}/elements

When user draws a point, line or polygon on the PILOT/Web side.
create map element
When user draws a point, line or polygon on the PILOT/Web side.

请求参数

Path 参数

workspaceId

string

必需

groupId

string

必需

Query 参数

workspace_id

可选

workspace id

group_id

可选

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

Header 参数

x-auth-token

string

可选

默认值:

eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ3b3Jrc3BhY2VfaWQiOiJlM2RlYTBmNS0zN2YyLTRkNzktYWU1OC00OTBhZjMyMjgwNjkiLCJzdWIiOiJDbG91ZEFwaVNhbXBsZSIsInVzZXJfdHlwZSI6IjEiLCJuYmYiOjE3NDkwODYzMDEsImxvZyI6IkxvZ2dlcltjb20uZGppLnNhbXBsZS5jb21tb24ubW9kZWwuQ3VzdG9tQ2xhaW1dIiwiaXNzIjoiREpJIiwiaWQiOiJhMTU1OWU3Yy04ZGQ4LTQ3ODAtYjk1Mi0xMDBjYzQ3OTdkYTIiLCJleHAiOjE4MzU0ODYzMDEsImlhdCI6MTc0OTA4NjMwMSwidXNlcm5hbWUiOiJhZG1pblBDIn0.W5x4fh7PWALqknARx8aoGQhK8ci5t6U7mITN1Gbn4H0

Body 参数application/json

string

必需

element id

正则匹配:

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

name

string

必需

element name

示例值:

PILOT 1

resource

object (ElementResource)

必需

user_name

string

可选

the user who created the element

示例值:

pilot

type

enum<string>

必需

枚举值:

POINTLINE_STRINGPOLYGON

content

object (ElementContent)

必需

示例

{
    "id": "string",
    "name": "PILOT 1",
    "resource": {
        "user_name": "pilot",
        "type": "POINT",
        "content": {
            "type": "Feature",
            "properties": {
                "clampToGround": true,
                "color": "#2D8CF0"
            },
            "geometry": {
                "type": "string"
            }
        }
    }
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/map/api/v1/workspaces//element-groups//elements' \
--header 'x-auth-token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ3b3Jrc3BhY2VfaWQiOiJlM2RlYTBmNS0zN2YyLTRkNzktYWU1OC00OTBhZjMyMjgwNjkiLCJzdWIiOiJDbG91ZEFwaVNhbXBsZSIsInVzZXJfdHlwZSI6IjEiLCJuYmYiOjE3NDkwODYzMDEsImxvZyI6IkxvZ2dlcltjb20uZGppLnNhbXBsZS5jb21tb24ubW9kZWwuQ3VzdG9tQ2xhaW1dIiwiaXNzIjoiREpJIiwiaWQiOiJhMTU1OWU3Yy04ZGQ4LTQ3ODAtYjk1Mi0xMDBjYzQ3OTdkYTIiLCJleHAiOjE4MzU0ODYzMDEsImlhdCI6MTc0OTA4NjMwMSwidXNlcm5hbWUiOiJhZG1pblBDIn0.W5x4fh7PWALqknARx8aoGQhK8ci5t6U7mITN1Gbn4H0' \
--header 'Content-Type: application/json' \
--data-raw '{
    "id": "string",
    "name": "PILOT 1",
    "resource": {
        "user_name": "pilot",
        "type": "POINT",
        "content": {
            "type": "Feature",
            "properties": {
                "clampToGround": true,
                "color": "#2D8CF0"
            },
            "geometry": {
                "type": "string"
            }
        }
    }
}'

返回响应

🟢200成功

application/json

Body

code

integer

可选

0 means success, non-zero means error.

示例值:

message

string

可选

The response message.

示例值:

success

data

object (CreateMapElementResponse)

可选

The response data.

string

必需

element id

正则匹配:

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

示例

{
  "code": 0,
  "message": "",
  "data": {
    "id": ""
  }
}

修改于 2025-06-05 01:52:34

get map elements

update map element