Mapping Service: List & Get Maps

Describe a named layer

Returns the description of a named layer in JSON format.

The layer name should be provided as part of the URL path after /layers/. Hierarchical names with slashes are supported (e.g., Samples/NamedLayers/SavingsNLoanFeatureLayer).

Resource dependencies: A named layer typically references a named table (see the table field, e.g. NamedTable) that provides its underlying data, and may optionally reference a named label source (namedLabelSourceRef). These referenced resources must already exist in the repository for the layer to render or describe correctly.

Authorization: Requires EXECUTE permission on the requested layer. If the caller lacks permission, the API returns 403 Forbidden; if the layer 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/layers/{layerName}

Request

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

Path parameters

layerNamestring required

Name of the layer (may contain forward slashes for hierarchical names). Example: Samples/NamedLayers/USALayer

Response

Layer description retrieved successfully

Changes

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