Render a named map image
Renders a map image for an existing named map, identified by name in the URL path, using query parameters. Returns image/png or image/jpeg based on the format parameter.
For an ad-hoc map defined by layers rather than a saved map, use Render a map image instead.
Map Extent Options:
- Use centerX, centerY with zoom/scale for center-based rendering
- Use bbox for bounding box rendering (no center needed)
Authorization: Requires EXECUTE permission on the named map.
Request
- Base URL: https://api.cloud.precisely.com
- URL: https://api.cloud.precisely.com/v1/spatial/maps/{mapName}/image
- Auth: API key in header Authorization and HTTP bearer
Path parameters
Name of the named map (may contain forward slashes for hierarchical names). Example: Samples/NamedMaps/WorldMap
Query parameters
Image width in pixels
Image height in pixels
Center X coordinate (longitude). Required unless using 'bbox' parameter.
Center Y coordinate (latitude). Required unless using 'bbox' parameter.
Coordinate reference system. Required when center coordinates or bbox are provided.
Zoom level value
Zoom unit (e.g., mi, km, m)
Map scale
Bounding box minimum X (minx). Used together with miny,maxx,maxy.
Bounding box minimum Y (miny). Used together with minx,maxx,maxy.
Bounding box maximum X (maxx). Used together with minx,miny,maxy.
Bounding box maximum Y (maxy). Used together with minx,miny,maxx.
Map resolution in DPI
Background color (hex without #)
Background opacity (0.0-1.0)
Output format (png or jpeg)
Response
Named map image rendered successfully. Returns PNG or JPEG based on the format parameter.
Changes
No recorded changes to this operation across all 1 revision of this API.