Dataset Payload APIs

DatasetDatasetA data-related element that contains processed data and makes it available for consumption. A Dataset is populated via Pipelines and carries Metadata and access permissions. Payload APIs are user-defined, datasetDatasetA data-related element that contains processed data and makes it available for consumption. A Dataset is populated via Pipelines and carries Metadata and access permissions.-scoped APIs. They are created as named APIs on a datasetDatasetA data-related element that contains processed data and makes it available for consumption. A Dataset is populated via Pipelines and carries Metadata and access permissions. and become available when the datasetDatasetA data-related element that contains processed data and makes it available for consumption. A Dataset is populated via Pipelines and carries Metadata and access permissions. is published (status AVAILABLE). The API standard determines which downstream service is used:

Standard	Service	Typical use
OWS	OGC Web Services through GeoServer	Geospatial layers, maps and features
STA	OGC SensorThings APISensorThings APIA standardized API based on the OGC SensorThings API specification for accessing time series and IoT data. It enables structured retrieval and management of observations and related entities. through FROST	Things, Datastreams and Observations

API specifications and implementation references

• OGC Web Map Service (WMS) standard — standard for requesting georeferenced map images.
• OGC Web Feature Service (WFS) standard — standard for querying and exchanging vector features.
• GeoServer WMS reference — supported WMS operations such as GetCapabilities, GetMap and GetFeatureInfo.
• GeoServer WFS reference — GetCapabilities, DescribeFeatureType and GetFeature request details.
• OGC SensorThings API standard — overview and official standard documents.
• OGC SensorThings API Part 1: Sensing, version 1.1 — normative specification for entities, navigation links and query behavior.

Discover the published APIs

Use the Portal Backend API to retrieve the active named APIs of a published datasetDatasetA data-related element that contains processed data and makes it available for consumption. A Dataset is populated via Pipelines and carries Metadata and access permissions.. See Authentication for how to get a token.

curl --request GET \
  "https://management.<your-domain>/v1/datasets/<dataset-id>/apis" \
  --header "Authorization: Bearer <access_token>" \
  --header "Accept: application/json"

The response contains the API standard, slug, optional version, and the server-generated previewUrl. Use previewUrl as the base URL instead of constructing a host-specific URL yourself. The general URL shape is:

https://<data-api-host>/v1/datasets/<dataset-id>/<api-slug>

The route is provisioned dynamically by the platform. A datasetDatasetA data-related element that contains processed data and makes it available for consumption. A Dataset is populated via Pipelines and carries Metadata and access permissions. in DRAFT or READY does not expose an active payload API.

Access

The authorization decision is datasetDatasetA data-related element that contains processed data and makes it available for consumption. A Dataset is populated via Pipelines and carries Metadata and access permissions.-specific and requires the DATASET_PAYLOAD_READ permission for protected reads. It is separate from the permission to read datasetDatasetA data-related element that contains processed data and makes it available for consumption. A Dataset is populated via Pipelines and carries Metadata and access permissions. metadata. Payload writes require the corresponding payload write permission and are never anonymous.

If the datasetDatasetA data-related element that contains processed data and makes it available for consumption. A Dataset is populated via Pipelines and carries Metadata and access permissions. is configured for open data access, anonymous read requests may be allowed by the gateway policy. Management and discovery requests remain protected, and anonymous clients must not send write requests. Clients should still support 401 Unauthorized and 403 Forbidden because access depends on the datasetDatasetA data-related element that contains processed data and makes it available for consumption. A Dataset is populated via Pipelines and carries Metadata and access permissions. and deployment policy.

For browser applications, use the public data API host and configure CORS for the browser origin. Server-side clients and command-line tools are not subject to CORS.

OWS Payload API

An OWS API exposes the GeoServer OGC Web Services endpoint for the layers and styles attached to the datasetDatasetA data-related element that contains processed data and makes it available for consumption. A Dataset is populated via Pipelines and carries Metadata and access permissions.. The API slug is part of the public route; after the previewUrl, use standard OWS query parameters.

OWS is a family of HTTP-based geospatial services. In this platform, the published OWS API is consumed through GeoServer using WFS for vector features and WMS for rendered map images. The available layers, feature types and operations are returned by GetCapabilities.

Get capabilities

Request WFS capabilities to discover feature types and supported operations:

curl --get "<previewUrl>" \
  --data-urlencode "SERVICE=WFS" \
  --data-urlencode "VERSION=2.0.0" \
  --data-urlencode "REQUEST=GetCapabilities" \
  --header "Authorization: Bearer <access_token>"

The capabilities document contains the layer names and the service URLs that clients such as QGIS can use. Depending on the configured layer, the same endpoint can also serve WMS requests.

Query features as GeoJSON

Use the feature type advertised by GetCapabilities:

curl --get "<previewUrl>" \
  --data-urlencode "SERVICE=WFS" \
  --data-urlencode "VERSION=2.0.0" \
  --data-urlencode "REQUEST=GetFeature" \
  --data-urlencode "typeNames=<workspace>:<feature-type>" \
  --data-urlencode "count=100" \
  --data-urlencode "outputFormat=application/json" \
  --header "Authorization: Bearer <access_token>"

For map images, use the WMS GetMap operation with the layer name, coordinate reference system, bounding box, image size and format required by the OGC WMS specification. Use GetFeatureInfo when a client needs feature attributes for a pixel position in a rendered map.

STA Payload API

An STA API exposes an OGC SensorThings APISensorThings APIA standardized API based on the OGC SensorThings API specification for accessing time series and IoT data. It enables structured retrieval and management of observations and related entities. backed by FROST. It follows the SensorThings entity model and OData query conventions. The available entity sets depend on the data that has been published.

SensorThings Part 1 (Sensing) models resources such as Things, Sensors, Datastreams, Observations, ObservedProperties and Locations. Navigation links connect related resources, while OData query options are used for filtering, paging and expansion. The platform provides the datasetDatasetA data-related element that contains processed data and makes it available for consumption. A Dataset is populated via Pipelines and carries Metadata and access permissions.-scoped route and authorization; the payload semantics follow SensorThings.

List Things

curl --get "<previewUrl>/Things" \
  --data-urlencode "\$top=100" \
  --header "Authorization: Bearer <access_token>" \
  --header "Accept: application/json"

Filter and expand entities

curl --get "<previewUrl>/Datastreams" \
  --data-urlencode "\$filter=name eq 'Temperature'" \
  --data-urlencode "\$expand=Thing,ObservedProperty,Sensor" \
  --header "Authorization: Bearer <access_token>" \
  --header "Accept: application/json"

SensorThings clients can follow the @iot.navigationLink values in the response. Use the service's advertised SensorThings version and capabilities for entity and query details; the platform only adds the datasetDatasetA data-related element that contains processed data and makes it available for consumption. A Dataset is populated via Pipelines and carries Metadata and access permissions.-scoped gateway route and authorization layer.

Common responses

Status	Meaning
200 OK	Payload returned successfully
401 Unauthorized	Token missing, expired or invalid; or anonymous access is not allowed
403 Forbidden	Token is valid but lacks the datasetDatasetA data-related element that contains processed data and makes it available for consumption. A Dataset is populated via Pipelines and carries Metadata and access permissions. payload permission
404 Not Found	DatasetDatasetA data-related element that contains processed data and makes it available for consumption. A Dataset is populated via Pipelines and carries Metadata and access permissions./API is not published, is out of scope, or the requested resource does not exist
400 Bad Request	OWS or STA query parameters are invalid