Mapping Service: List & Get Maps

Describe a named map

Returns the description of a named map in JSON format.

The map name should be provided as part of the URL path after /maps/. Hierarchical names with slashes are supported (e.g., Samples/NamedMaps/WorldMap).

Resource dependencies: A named map references one or more named layers in its layers list (each entry includes name and namedTableRef). Each referenced named layer — and the named table it points to — must already exist in the repository before the map can be resolved.

Authorization: Requires EXECUTE permission on the requested map. If the caller lacks permission, the API returns 403 Forbidden; if the map does not exist, it returns 404 Not Found. Both share the same error code (DIS-MS-1016), but the distinct HTTP status and message text make the two cases distinguishable to the caller.

get/v1/spatial/maps/{mapName}

Request

  • Base URL: https://api.cloud.precisely.com
  • URL: https://api.cloud.precisely.com/v1/spatial/maps/{mapName}
  • Auth: API key in header Authorization and HTTP bearer

Path parameters

mapNamestring required

Name of the map (may contain forward slashes for hierarchical names). Example: Samples/NamedMaps/WorldMap

Response

Map description retrieved successfully

Changes

No recorded changes to this operation across all 1 revision of this API.