Charts Maps Resource

Get, update, or delete 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
`boundingBox`	BoundingBoxRepresentation	The bounding box of the geo map	Small, 38.0	39.0
`createdBy`	UserRepresentation	The creator of the map	Small, 38.0	38.0
`createdDate`	Date	The date when this map was created	Small, 38.0	38.0
`geoData`	GeoDataRepresentation	The geo data of the map	Small, 38.0	38.0
`id`	String	The 18 character user ID	Small, 38.0	38.0
`label`	String	The label of the map	Small, 39.0	39.0
`name`	String	The name of the map	Small, 38.0	38.0
`namespace`	String	The namespace of the map	Small, 39.0	39.0
`projection`	ConnectEclairMapProjectionTypeEnum	The projection used by the map (AlbersUSA, Equirectangular, or 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
`geoMapObject`	Object (MapInputRepresentation)	List of all relevant information about the map, i.e. { "label": "My Map" }.		39.0

PATCH Request Body

MapInputRepresentation

Property Name	Type	Description	Available Version
`boundingBox`	MapBoundingBoxInputRepresentation	Sets the Map bounding box.	39.0
`geoData`	AssetReferenceInputRepresentation	Sets the parent GeoData.	39.0
`label`	String	Sets the Map label.	39.0
`name`	String	Sets the Map name	39.0
`projection`	ConnectEclairMapProjectionTypeEnum	Sets the Map projection (AlbersUSA, Equirectangular, or Mercator)	39.0

PATCH Response Body

MapRepresentation

Property Name	Type	Description	Filter Group and Version	Available Version
`boundingBox`	BoundingBoxRepresentation	The bounding box of the geo map	Small, 38.0	39.0
`createdBy`	UserRepresentation	The creator of the map	Small, 38.0	38.0
`createdDate`	Date	The date when this map was created	Small, 38.0	38.0
`geoData`	GeoDataRepresentation	The geo data of the map	Small, 38.0	38.0
`id`	String	The 18 character user ID	Small, 38.0	38.0
`label`	String	The label of the map	Small, 39.0	39.0
`name`	String	The name of the map	Small, 38.0	38.0
`namespace`	String	The namespace of the map	Small, 39.0	39.0
`projection`	ConnectEclairMapProjectionTypeEnum	The projection used by the map (AlbersUSA, Equirectangular, or Mercator)	Small, 38.0	38.0
`url`	String	The url to the map representation	Small, 38.0	38.0

Wave REST API Developer Guide