Skip to content
getgeolens.com
GeoLens Docs

Update Map Endpoint

PUT
/maps/{map_id}
 
curl --request PUT \
  --url https://example.com/api/maps/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "description": "example", "notes": "example", "center_lng": 1, "center_lat": 1, "zoom": 1, "bearing": 1, "pitch": 1, "basemap_style": "example", "show_basemap_labels": true, "visibility": "private", "layers": [ { "dataset_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "sort_order": 0, "visible": true, "opacity": 1, "paint": {}, "layout": {}, "display_name": "example", "filter": [ "example" ], "label_config": {}, "popup_config": { "enabled": true, "expression": "example", "visible_fields": [ "example" ] }, "style_config": {}, "layer_type": "example", "show_in_legend": true } ], "widgets": [ "example" ] }'

Update a map’s metadata and/or replace its layers.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
map_id
required
Map Id
string format: uuid

Request Body required

Section titled “Request Body required ”
Media type application/json
MapUpdate
object
name
Any of:
string
<= 255 characters
description
Any of:
string
<= 2000 characters
notes
Any of:
string
<= 50000 characters
center_lng
Any of:
number
center_lat
Any of:
number
zoom
Any of:
number
<= 24
bearing
Any of:
number
>= -180 <= 180
pitch
Any of:
number
<= 85
basemap_style
Any of:
string
<= 2000 characters
show_basemap_labels
Any of:
boolean
visibility
Any of:
MapVisibility
string
Allowed values: private internal public
layers
Any of:
Array<object>
MapLayerInput
object
dataset_id
required
Dataset Id
string format: uuid
sort_order
Sort Order

Draw order (lower draws first)

integer
0 <= 32767
visible
Visible
boolean
default: true
opacity
Opacity

Layer opacity 0.0-1.0

number
default: 1 <= 1
paint
Any of:
object
key
additional properties
any
layout
Any of:
object
key
additional properties
any
display_name
Any of:
string
<= 255 characters
filter
Any of:
Array
label_config
Any of:
object
key
additional properties
any
popup_config
Any of:
PopupConfig

Per-layer popup configuration: enable/disable + custom title template

  • ordered visible-fields allowlist. Persisted as JSONB on map_layers.
object
enabled
required
Enabled
boolean
expression
Any of:
string
<= 500 characters
visible_fields
Any of:
Array<string>
<= 100 items
style_config
Any of:
object
key
additional properties
any
layer_type
Any of:
string
/^(vector_geolens|raster_geolens|geojson)$/
show_in_legend
Show In Legend

Whether to include in the map legend

boolean
default: true
widgets
Any of:
Array<string>

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
MapResponse
object
id
required
Id
string format: uuid
name
required
Name
string
description
required
Any of:
string
notes
Any of:
string
center_lng
required
Any of:
number
center_lat
required
Any of:
number
zoom
required
Any of:
number
bearing
required
Bearing
number
pitch
required
Pitch
number
basemap_style
required
Basemap Style
string
show_basemap_labels
required
Show Basemap Labels
boolean
visibility
required
MapVisibility
string
Allowed values: private internal public
thumbnail_url
Any of:
string
forked_from_id
Any of:
string format: uuid
forked_from_name
Any of:
string
created_by
required
Any of:
string format: uuid
created_by_username
Any of:
string
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time
layers
required
Layers
Array<object>
MapLayerResponse
object
id
required
Id
string format: uuid
dataset_id
required
Dataset Id
string format: uuid
dataset_name
required
Dataset Name
string
dataset_geometry_type
required
Any of:
string
dataset_table_name
required
Dataset Table Name
string
dataset_extent_bbox
required
Any of:
Array<number>
dataset_column_info
Any of:
Array<object>
object
key
additional properties
any
dataset_feature_count
Any of:
integer
dataset_sample_values
Any of:
object
key
additional properties
any
display_name
Any of:
string
sort_order
required
Sort Order
integer
visible
required
Visible
boolean
opacity
required
Opacity
number
paint
required
Paint
object
key
additional properties
any
layout
required
Layout
object
key
additional properties
any
layer_type
Layer Type
string
default: vector_geolens
dataset_record_type
Any of:
string
filter
Any of:
Array
label_config
Any of:
object
key
additional properties
any
popup_config
Any of:
PopupConfig

Per-layer popup configuration: enable/disable + custom title template

  • ordered visible-fields allowlist. Persisted as JSONB on map_layers.
object
enabled
required
Enabled
boolean
expression
Any of:
string
<= 500 characters
visible_fields
Any of:
Array<string>
<= 100 items
style_config
Any of:
object
key
additional properties
any
show_in_legend
Show In Legend
boolean
default: true
is_3d
Any of:
boolean
layer_count
required
Layer Count
integer
widgets
Any of:
Array<string>
Example 
{
  "visibility": "private",
  "layers": [
    {
      "layer_type": "vector_geolens",
      "show_in_legend": true
    }
  ]
}

422

Section titled “422 ”

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Example generated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}