Map/Map Annotation/Annotation Creation
Map/Map Annotation/Annotation CRUD

Create Map Annotation

Create map annotation. Supports creating point, line, and polygon annotations.

post/openapi/v2.0/map/element

Request

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

Headers

X-User-Tokenstring required

User JWT Token

X-Project-Uuidstring uuid required

Project Number

X-Request-Idstring

Request Unique Identifier

X-Languagestring

Language

Request body

idstring

Element ID (optional, generated by backend)

namestring

Annotation Name

source0 | 1

Annotation source: 0=openApi, 1=geo

element_sourceinteger

Reserved field, no need to pass

descstring

Annotation Description

Example request

{
  "name": "Test Annotation Point",
  "resource": {
    "content": {
      "type": "Feature",
      "properties": {
        "color": "#FF0000",
        "clampToGround": true
      },
      "geometry": {
        "type": "Point",
        "coordinates": [
          113.94186,
          22.50203
        ]
      }
    }
  }
}

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.