Spatial Maps API

WMS entrypoint (GetCapabilities, GetMap, GetFeatureInfo)

Handles all WMS requests based on the REQUEST parameter. Dynamic styling via SLD_BODY is supported only on POST requests.

GetCapabilities Example:

  • SERVICE=WMS
  • REQUEST=GetCapabilities
  • VERSION=1.3.0

GetMap Example:

  • SERVICE=WMS
  • REQUEST=GetMap
  • VERSION=1.3.0
  • LAYERS=LayerName
  • STYLES=
  • CRS=EPSG:4326
  • BBOX=-100,0,90,100
  • WIDTH=400
  • HEIGHT=300
  • FORMAT=image/png

GetFeatureInfo Example:

  • SERVICE=WMS
  • REQUEST=GetFeatureInfo
  • VERSION=1.3.0
  • LAYERS=LayerName
  • QUERY_LAYERS=LayerName
  • CRS=EPSG:4326
  • BBOX=-100,0,90,100
  • WIDTH=400
  • HEIGHT=300
  • I=200
  • J=150
  • INFO_FORMAT=text/xml

Authorization: Requires a valid Bearer JWT or API key (see security schemes below). Unlike the Mapping API's named-resource endpoints, WMS does not perform a per-layer EXECUTE-permission check — layer availability is governed by the WMS layer configuration rather than per-caller ACLs.

get/v1/spatial/wms

Request

  • Base URL: https://api.cloud.precisely.com
  • URL: https://api.cloud.precisely.com/v1/spatial/wms
  • Auth: one of:
    • HTTP bearer
    • API key in header Authorization

Query parameters

REQUESTstring required

WMS operation (GetCapabilities, GetMap, GetFeatureInfo)

SERVICEstring required

Service type (always WMS)

VERSIONstring

WMS version (1.1.1 or 1.3.0)

LAYERSstring

Comma-separated list of layers (required for GetMap/GetFeatureInfo)

STYLESstring

Comma-separated list of styles (required for GetMap)

SRSstring

Spatial Reference System (for WMS 1.1.1)

CRSstring

Coordinate Reference System (for WMS 1.3.0)

BBOXstring

Bounding box (minx,miny,maxx,maxy)

WIDTHinteger

Image width in pixels

HEIGHTinteger

Image height in pixels

FORMATstring

Image format (for GetMap)

QUERY_LAYERSstring

Comma-separated list of layers to query (for GetFeatureInfo)

INFO_FORMATstring

Output format (for GetFeatureInfo)

Iinteger

Pixel column coordinate (for WMS 1.3.0 GetFeatureInfo)

Jinteger

Pixel row coordinate (for WMS 1.3.0 GetFeatureInfo)

Xinteger

Pixel column coordinate (for WMS 1.1.1 GetFeatureInfo)

Yinteger

Pixel row coordinate (for WMS 1.1.1 GetFeatureInfo)

TRANSPARENTstring

Transparency (TRUE/FALSE)

BGCOLORstring

Background color (hex)

EXCEPTIONSstring

Exception format

Headers

X-Request-Idstring

Optional request correlation ID for tracing and logging. If not provided, a UUID will be automatically generated. The value is echoed back in the response header.

Response

WMS response returned successfully

Changes

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