Newer Version Available

This content describes an older version of this product. View Latest

Charts Maps Resource

Returns, updates, or deletes a specific map.
Resource URL
1/eclair/maps/<id>
Formats
JSON
Available Version
38.0
HTTP Methods
DELETE GET PATCH
GET Response Body (MapRepresentation)
Property Name Type Description Filter Group and Version Available Version
bounding​Box Bounding​Box​Representation The bounding box of the geo map Small, 38.0 39.0
created​By User​Representation The creator of the map Small, 38.0 38.0
created​Date Date The date when this map was created Small, 38.0 38.0
geo​Data Geo​Data​Representation The geo data of the map Small, 38.0 38.0
id String The 18 character map ID Small, 38.0 38.0
label String The map label Small, 39.0 39.0
name String The map developer name. Small, 39.0 39.0
name​space String The namespace that qualifies the map Small, 39.0 39.0
projection Connect​Eclair​Map​Projection​Type​Enum The map projection. Valid values are:
  • AlbersUSA
  • Equirectangular
  • Mercator
Small, 38.0 38.0
url String The url to the map representation Small, 38.0 38.0
PATCH Request Parameters
Parameter Name Type Description Required or Optional Available Version
geo​Map​Object Object (Map​Input​Representation) All the relevant information about the map, such as {"label": "My Map"}. Required 39.0
PATCH Request Body (MapInputRepresentation)
Property Name Type Description Required or Optional Available Version
bounding​Box Map​Bounding​Box​Input​Representation The map bounding box. Optional 39.0
geo​Data Asset​Reference​Input​Representation The parent geodata asset. Required 39.0
label String The map label. Required 39.0
name String The map developer name. Optional 39.0
projection Connect​Eclair​Map​Projection​Type​Enum The map projection. Valid values are:
  • AlbersUSA
  • Equirectangular
  • Mercator
Required 39.0
PATCH Response Body (MapRepresentation)
Property Name Type Description Filter Group and Version Available Version
bounding​Box Bounding​Box​Representation The bounding box of the geo map Small, 38.0 39.0
created​By User​Representation The creator of the map Small, 38.0 38.0
created​Date Date The date when this map was created Small, 38.0 38.0
geo​Data Geo​Data​Representation The geo data of the map Small, 38.0 38.0
id String The 18 character map ID Small, 38.0 38.0
label String The map label Small, 39.0 39.0
name String The map developer name. Small, 39.0 39.0
name​space String The namespace that qualifies the map Small, 39.0 39.0
projection Connect​Eclair​Map​Projection​Type​Enum The map projection. Valid values are:
  • AlbersUSA
  • Equirectangular
  • Mercator
Small, 38.0 38.0
url String The url to the map representation Small, 38.0 38.0