Map/Map Annotation/Annotation Update
Map/Map Annotation/Annotation CRUD

Annotation Update

Update the attributes of a map annotation. All body fields are optional; only passed fields are updated

put/openapi/v2.0/workspaces/{workspace_id}/elements/{id}

Request

  • Base URL
    (relative, and it does not resolve against the document’s source URL)
  • URL
    /openapi/v2.0/workspaces/{workspace_id}/elements/{id}
  • Auth
    none required

Path parameters

workspace_idstring uuid required

Workspace UUID

idstring uuid required

Annotation Element UUID

Headers

X-User-Tokenstring required

User JWT Token

X-Request-Idstring

Request Unique Identifier

X-Languagestring

Language

Request body

namestring

Annotation Name

statusinteger

Annotation Status

display0 | 1

Display status: 0=hidden, 1=visible

contentobject

GeoJSON Feature Geometry Content

remarkstring

Remark

elevation_load_statusinteger

Elevation Loading Status

target_layer_idstring

Target Layer ID

Example request

{
  "name": "Test Annotation Point - Renamed"
}

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.