Geospatial

The Geospatial API allows to model a problem domain when data has a geometric or geographic nature. The geospatial data is organized in feature types that are homogeneous collections of features (geospatial items), each having the same spatial representation, such as points, lines, or polygons, and a common set of typed properties. The Geospatial API is aware of Coordinate Reference Systems, and allows transformations. To learn more about geospatial concepts, see the concept guide.

List Coordinate Reference Systems

Required capabilities: geospatialCrsAcl:READ

List the defined Coordinate Reference Systems. The list can be limited to the custom Coordinate Reference Systems defined for the tenant.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
query Parameters
filterOnlyCustom
boolean

Optional parameter to only list custom Coordinate Reference Systems. Defaults to false.

Example: filterOnlyCustom=true
Responses
200

Coordinate reference system list response.

400

Failed request reponse.

get/geospatial/crs
Request samples 
const allCRS = await client.geospatial.crs.list({ filterOnlyCustom : true });
Response samples
application/json
{
  • "items": [
    ]
}

Create Coordinate Reference Systems

Required capabilities: geospatialCrsAcl:WRITE

Creates custom Coordinate Reference Systems.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
Request Body schema: application/json
required

List of custom Coordinate Reference Systems to be created.

required
Array of objects (GeospatialCoordinateReferenceSystem)
Responses
201

Custom coordinate reference system list response.

400

Failed request reponse.

post/geospatial/crs
Request samples
application/json
{
  • "items": [
    ]
}
Response samples
application/json
{
  • "items": [
    ]
}

Get Coordinate Reference Systems

Required capabilities: geospatialCrsAcl:READ

Get Coordinate Reference Systems by their Spatial Reference IDs

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
Request Body schema: application/json
required
Array of objects [ 1 .. 1000 ] items
Responses
200

Coordinate reference system list response.

400

Failed request reponse.

post/geospatial/crs/byids
Request samples
application/json
{
  • "items": [
    ]
}
Response samples
application/json
{
  • "items": [
    ]
}

Delete Coordinate Reference Systems

Required capabilities: geospatialCrsAcl:WRITE

Delete custom Coordinate Reference Systems.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
Request Body schema: application/json

List of custom Coordinate Reference Systems to be deleted.

required
Array of objects [ 1 .. 1000 ] items
Responses
200

Empty response.

400

Failed request reponse.

post/geospatial/crs/delete
Request samples
application/json
{
  • "items": [
    ]
}
Response samples
application/json
{ }

Create feature types

Required capabilities: geospatialAcl:WRITE

Creates feature types. Each tenant can have up to 100 feature types.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
Request Body schema: application/json
required

List of feature types to be created. It is possible to create up to 100 feature types in one request provided the total number of feature types on the tenant will not exceed 100.

required
Array of objects (GeospatialFeatureTypeSpec) [ 1 .. 100 ] items
Responses
201

Feature type list response.

400

Failed request reponse.

post/geospatial/featuretypes
Request samples
application/json
{
  • "items": [
    ]
}
Response samples
application/json
{
  • "items": [
    ]
}

Retrieve feature types

Required capabilities: geospatialAcl:READ

Retrieves feature types by external ids. It is possible to retrieve up to 100 items per request, i.e. the maximum number of feature types for a tenant.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
Request Body schema: application/json
required
required
Array of objects [ 1 .. 100 ] items
Responses
200

Feature type list response.

400

Failed request reponse.

post/geospatial/featuretypes/byids
Request samples
application/json
{
  • "items": [
    ]
}
Response samples
application/json
{
  • "items": [
    ]
}

List feature types

Required capabilities: geospatialAcl:READ

List all feature types

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Responses
200

Feature type list response.

400

Failed request reponse.

post/geospatial/featuretypes/list
Request samples 
const allFeatureTypes = await client.geospatial.featureType.list();
Response samples
application/json
{
  • "items": [
    ]
}

Update feature types

Required capabilities: geospatialAcl:READ geospatialAcl:WRITE

Update one or more feature types

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
Request Body schema: application/json
required

List of feature types to be updated. It is possible to add and remove properties and indexes. WARNING: removing properties will result in data loss in corresponding features.

required
Array of objects (GeospatialUpdateFeatureTypeSpec) [ 1 .. 100 ] items
Responses
200

Feature type list response.

400

Failed request reponse.

post/geospatial/featuretypes/update
Request samples
application/json
{
  • "items": [
    ]
}
Response samples
application/json
{
  • "items": [
    ]
}

Delete feature types

Required capabilities: geospatialAcl:WRITE

Delete feature types.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
Request Body schema: application/json
required

List of feature types to be deleted. It is possible to delete a maximum of 10 feature types per request. Feature types must not have related features. Feature types with related features can be deleted using force flag.

recursive
boolean (GeospatialRecursiveDelete)

Indicates if feature types should be deleted together with all related features. Optional parameter, defaults to false.

required
Array of objects [ 1 .. 10 ] items
Responses
200

Empty response.

400

Failed request reponse.

post/geospatial/featuretypes/delete
Request samples
application/json
{
  • "items": [
    ]
}
Response samples
application/json
{ }

Create features

Required capabilities: geospatialAcl:READ geospatialAcl:WRITE

Create features

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
path Parameters
featureTypeExternalId
required
string <= 32 characters ^[A-Za-z][A-Za-z0-9_]{0,31}$

External Id of the feature type provided by client. Must be unique among all feature type external ids within a CDF project.

Example: ocean_measures
Request Body schema: application/json
required
allowCrsTransformation
boolean (GeospatialAllowCrsTransformation)

Optional parameter indicating if input geometry properties should be transformed into the respective Coordinate Reference Systems defined in the feature type specification. If the parameter is true, then input geometries will be transformed when the input and output Coordinate Reference Systems differ. When it is false, then requests with geometries in Coordinate Reference System different from the ones defined in the feature type will result in bad request response code. Transformations apply to property geometries in case of create and update feature, as well as to geometries in spatial filters in search endpoints.

required
Array of objects (GeospatialFeatureSpec) [ 1 .. 1000 ] items
Responses
201

Feature list response.

400

Failed request reponse.

post/geospatial/featuretypes/{featureTypeExternalId}/features
Request samples
application/json
{
  • "items": [
    ]
}
Response samples
application/json
{
  • "items": [
    ]
}

Get features

Required capabilities: geospatialAcl:READ

Get features with paging support

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
path Parameters
featureTypeExternalId
required
string <= 32 characters ^[A-Za-z][A-Za-z0-9_]{0,31}$

External Id of the feature type provided by client. Must be unique among all feature type external ids within a CDF project.

Example: ocean_measures
query Parameters
cursor
string

Cursor for paging through results. In general, if a response contains a nextCursor property, it means that there may be more results, and you should pass that value as the cursor parameter in the next request.

Note that the cursor may or may not be encrypted, but either way, it is not intended to be decoded. Its internal structure is not a part of the public API, and may change without notice. You should treat it as an opaque string and not attempt to craft your own cursors.

Example: cursor=4zj0Vy2fo0NtNMb229mI9r1V3YG5NBL752kQz1cKtwo
limit
integer (SearchLimit) [ 1 .. 1000 ]
Default: 1000

Limits the number of results to be returned.

allowCrsTransformation
boolean (GeospatialAllowCrsTransformation)

Optional parameter indicating if input geometry properties should be transformed into the respective Coordinate Reference Systems defined in the feature type specification. If the parameter is true, then input geometries will be transformed when the input and output Coordinate Reference Systems differ. When it is false, then requests with geometries in Coordinate Reference System different from the ones defined in the feature type will result in bad request response code. Transformations apply to property geometries in case of create and update feature, as well as to geometries in spatial filters in search endpoints.

Example: allowCrsTransformation=true
allowDimensionalityMismatch
boolean (GeospatialAllowDimensionalityMismatch)

Optional parameter indicating if the spatial filter operators allow input geometries with a different dimensionality than the properties they are applied to. For instance, when set to true, if a feature type has a property of type POLYGONZM (4D), its features can be filtered using the stContains operator and a POLYGON (2D) value. This option defaults to false if not specified.

Example: allowDimensionalityMismatch=true
Responses
200

Feature list response.

400

Failed request reponse.

get/geospatial/featuretypes/{featureTypeExternalId}/features
Response samples
application/json
{
  • "items": [
    ],
  • "nextCursor": "pwGTFXeL-JiWO8CZpgP23g"
}

Filter all features

Required capabilities: geospatialAcl:READ

List features based on the feature property filter passed in the body of the request. This operation supports pagination by cursor.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
path Parameters
featureTypeExternalId
required
string <= 32 characters ^[A-Za-z][A-Za-z0-9_]{0,31}$

External Id of the feature type provided by client. Must be unique among all feature type external ids within a CDF project.

Example: ocean_measures
Request Body schema: application/json
required
allowCrsTransformation
boolean (GeospatialAllowCrsTransformation)

Optional parameter indicating if input geometry properties should be transformed into the respective Coordinate Reference Systems defined in the feature type specification. If the parameter is true, then input geometries will be transformed when the input and output Coordinate Reference Systems differ. When it is false, then requests with geometries in Coordinate Reference System different from the ones defined in the feature type will result in bad request response code. Transformations apply to property geometries in case of create and update feature, as well as to geometries in spatial filters in search endpoints.

allowDimensionalityMismatch
boolean (GeospatialAllowDimensionalityMismatch)

Optional parameter indicating if the spatial filter operators allow input geometries with a different dimensionality than the properties they are applied to. For instance, when set to true, if a feature type has a property of type POLYGONZM (4D), its features can be filtered using the stContains operator and a POLYGON (2D) value. This option defaults to false if not specified.

GeospatialFeatureNotFilter (object) or GeospatialFeatureAndFilter (object) or GeospatialFeatureOrFilter (object) or GeospatialFeatureEqualsFilter (object) or GeospatialFeatureMissingFilter (object) or GeospatialFeatureLikeFilter (object) or GeospatialFeatureRegexFilter (object) or GeospatialFeatureRangeFilter (object) or GeospatialFeatureContainsAnyFilter (object) or GeospatialFeatureInFilter (object) or GeospatialFeatureStIntersectsFilter (object) or GeospatialFeatureStIntersects3dFilter (object) or GeospatialFeatureStWithinFilter (object) or GeospatialFeatureStWithinProperlyFilter (object) or GeospatialFeatureStContainsFilter (object) or GeospatialFeatureStContainsProperlyFilter (object) or GeospatialFeatureStWithinDistanceFilter (object) or GeospatialFeatureStWithinDistance3dFilter (object) (GeospatialFeatureFilter)
limit
integer (SearchLimit) [ 1 .. 1000 ]

Limits the number of results to be returned.

object (GeospatialOutput)

Desired output specification.

cursor
string
Responses
200

Feature list response.

400

Failed request reponse.

post/geospatial/featuretypes/{featureTypeExternalId}/features/list
Request samples
application/json
{
  • "filter": {
    },
  • "limit": 100,
  • "cursor": "4zj0Vy2fo0NtNMb229mI9r1V3YG5NBL752kQz1cKtwo"
}
Response samples
application/json
{
  • "items": [
    ],
  • "nextCursor": "pwGTFXeL-JiWO8CZpgP23g"
}

Retrieve features

Required capabilities: geospatialAcl:READ

Retrieves features by external ids. It is possible to retrieve up to 1000 items per request.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
path Parameters
featureTypeExternalId
required
string <= 32 characters ^[A-Za-z][A-Za-z0-9_]{0,31}$

External Id of the feature type provided by client. Must be unique among all feature type external ids within a CDF project.

Example: ocean_measures
Request Body schema: application/json
required
required
Array of objects (GeospatialItemExternalId) [ 1 .. 1000 ] items
object (GeospatialOutput)

Desired output specification.

Responses
200

Feature list response.

400

Failed request reponse.

post/geospatial/featuretypes/{featureTypeExternalId}/features/byids
Request samples
application/json
{
  • "items": [
    ]
}
Response samples
application/json
{
  • "items": [
    ]
}

Update features

Required capabilities: geospatialAcl:READ geospatialAcl:WRITE

Update features. This is a replace operation, i.e., all feature properties have to be sent in the request body even if their values do not change.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
path Parameters
featureTypeExternalId
required
string <= 32 characters ^[A-Za-z][A-Za-z0-9_]{0,31}$

External Id of the feature type provided by client. Must be unique among all feature type external ids within a CDF project.

Example: ocean_measures
Request Body schema: application/json
required

List of features to update.

allowCrsTransformation
boolean (GeospatialAllowCrsTransformation)

Optional parameter indicating if input geometry properties should be transformed into the respective Coordinate Reference Systems defined in the feature type specification. If the parameter is true, then input geometries will be transformed when the input and output Coordinate Reference Systems differ. When it is false, then requests with geometries in Coordinate Reference System different from the ones defined in the feature type will result in bad request response code. Transformations apply to property geometries in case of create and update feature, as well as to geometries in spatial filters in search endpoints.

required
Array of objects (GeospatialFeatureSpec) [ 1 .. 1000 ] items
Responses
200

Feature list response.

400

Failed request reponse.

post/geospatial/featuretypes/{featureTypeExternalId}/features/update
Request samples
application/json
{
  • "items": [
    ]
}
Response samples
application/json
{
  • "items": [
    ]
}

Delete features

Required capabilities: geospatialAcl:READ geospatialAcl:WRITE

Delete features.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
path Parameters
featureTypeExternalId
required
string <= 32 characters ^[A-Za-z][A-Za-z0-9_]{0,31}$

External Id of the feature type provided by client. Must be unique among all feature type external ids within a CDF project.

Example: ocean_measures
Request Body schema: application/json
required

List of features to be deleted. It is possible to post a maximum of 1000 items per request.

required
Array of objects (GeospatialItemExternalId) [ 1 .. 1000 ] items
Responses
200

Empty response.

400

Failed request reponse.

post/geospatial/featuretypes/{featureTypeExternalId}/features/delete
Request samples
application/json
{
  • "items": [
    ]
}
Response samples
application/json
{ }

Search features

Required capabilities: geospatialAcl:READ

Search for features based on the feature property filter passed in the body of the request. The result of the search is limited to a maximum of 1000 items. Results in excess of the limit are truncated. This means that the complete result set of the search cannot be retrieved with this method. However, for a given unmodified feature collection, the result of the search is deterministic and does not change over time.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
path Parameters
featureTypeExternalId
required
string <= 32 characters ^[A-Za-z][A-Za-z0-9_]{0,31}$

External Id of the feature type provided by client. Must be unique among all feature type external ids within a CDF project.

Example: ocean_measures
Request Body schema: application/json
allowCrsTransformation
boolean (GeospatialAllowCrsTransformation)

Optional parameter indicating if input geometry properties should be transformed into the respective Coordinate Reference Systems defined in the feature type specification. If the parameter is true, then input geometries will be transformed when the input and output Coordinate Reference Systems differ. When it is false, then requests with geometries in Coordinate Reference System different from the ones defined in the feature type will result in bad request response code. Transformations apply to property geometries in case of create and update feature, as well as to geometries in spatial filters in search endpoints.

allowDimensionalityMismatch
boolean (GeospatialAllowDimensionalityMismatch)

Optional parameter indicating if the spatial filter operators allow input geometries with a different dimensionality than the properties they are applied to. For instance, when set to true, if a feature type has a property of type POLYGONZM (4D), its features can be filtered using the stContains operator and a POLYGON (2D) value. This option defaults to false if not specified.

GeospatialFeatureNotFilter (object) or GeospatialFeatureAndFilter (object) or GeospatialFeatureOrFilter (object) or GeospatialFeatureEqualsFilter (object) or GeospatialFeatureMissingFilter (object) or GeospatialFeatureLikeFilter (object) or GeospatialFeatureRegexFilter (object) or GeospatialFeatureRangeFilter (object) or GeospatialFeatureContainsAnyFilter (object) or GeospatialFeatureInFilter (object) or GeospatialFeatureStIntersectsFilter (object) or GeospatialFeatureStIntersects3dFilter (object) or GeospatialFeatureStWithinFilter (object) or GeospatialFeatureStWithinProperlyFilter (object) or GeospatialFeatureStContainsFilter (object) or GeospatialFeatureStContainsProperlyFilter (object) or GeospatialFeatureStWithinDistanceFilter (object) or GeospatialFeatureStWithinDistance3dFilter (object) (GeospatialFeatureFilter)
limit
integer (SearchLimit) [ 1 .. 1000 ]

Limits the number of results to be returned.

object (GeospatialOutput)

Desired output specification.

sort
Array of strings

Sort result by selected fields. Syntax: sort:["field_1","field_2:ASC","field_3:DESC"]. Default sort order is ascending if not specified. Available sort direction: ASC, DESC, ASC_NULLS_FIRST, DESC_NULLS_FIRST, ASC_NULLS_LAST, DESC_NULLS_LAST.

Responses
200

The feature search response.

400

Failed request reponse.

post/geospatial/featuretypes/{featureTypeExternalId}/features/search
Request samples
application/json
{
  • "filter": {
    },
  • "limit": 100,
  • "sort": [
    ]
}
Response samples
application/json
{
  • "items": [
    ]
}

Search and stream features

Required capabilities: geospatialAcl:READ

Search for features based on the feature property filter passed in the body of the request. The streaming response format can be length prefixed, new line delimited, record separator delimited or concatenated depending on requested output (see https://en.wikipedia.org/wiki/JSON_streaming).

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
path Parameters
featureTypeExternalId
required
string <= 32 characters ^[A-Za-z][A-Za-z0-9_]{0,31}$

External Id of the feature type provided by client. Must be unique among all feature type external ids within a CDF project.

Example: ocean_measures
Request Body schema: application/json
allowCrsTransformation
boolean (GeospatialAllowCrsTransformation)

Optional parameter indicating if input geometry properties should be transformed into the respective Coordinate Reference Systems defined in the feature type specification. If the parameter is true, then input geometries will be transformed when the input and output Coordinate Reference Systems differ. When it is false, then requests with geometries in Coordinate Reference System different from the ones defined in the feature type will result in bad request response code. Transformations apply to property geometries in case of create and update feature, as well as to geometries in spatial filters in search endpoints.

allowDimensionalityMismatch
boolean (GeospatialAllowDimensionalityMismatch)

Optional parameter indicating if the spatial filter operators allow input geometries with a different dimensionality than the properties they are applied to. For instance, when set to true, if a feature type has a property of type POLYGONZM (4D), its features can be filtered using the stContains operator and a POLYGON (2D) value. This option defaults to false if not specified.

GeospatialFeatureNotFilter (object) or GeospatialFeatureAndFilter (object) or GeospatialFeatureOrFilter (object) or GeospatialFeatureEqualsFilter (object) or GeospatialFeatureMissingFilter (object) or GeospatialFeatureLikeFilter (object) or GeospatialFeatureRegexFilter (object) or GeospatialFeatureRangeFilter (object) or GeospatialFeatureContainsAnyFilter (object) or GeospatialFeatureInFilter (object) or GeospatialFeatureStIntersectsFilter (object) or GeospatialFeatureStIntersects3dFilter (object) or GeospatialFeatureStWithinFilter (object) or GeospatialFeatureStWithinProperlyFilter (object) or GeospatialFeatureStContainsFilter (object) or GeospatialFeatureStContainsProperlyFilter (object) or GeospatialFeatureStWithinDistanceFilter (object) or GeospatialFeatureStWithinDistance3dFilter (object) (GeospatialFeatureFilter)
limit
number
object (GeospatialOutputStreaming)

Desired output specification for streaming.

Responses
200

The feature search streaming response - it can be length prefixed, new line delimited, record separator delimited or concatenated depending on requested output.

400

Failed request reponse.

post/geospatial/featuretypes/{featureTypeExternalId}/features/search-streaming
Request samples
application/json
{
  • "filter": {
    },
  • "limit": 100,
  • "output": {
    }
}
Response samples
application/json-seq
{
  • "property1": "string",
  • "property2": "string",
  • "externalId": "my.known.id",
  • "createdTime": 1730204346000,
  • "lastUpdatedTime": 1730204346000
}

Aggregate features

Required capabilities: geospatialAcl:READ

Search for features based on the feature property filter and perform requested aggregations on a given property. Aggregations are supported for all filters that do not contain stWithin, stWithinProperly, stContains and stContainsProperly search in 3D geometries.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
path Parameters
featureTypeExternalId
required
string <= 32 characters ^[A-Za-z][A-Za-z0-9_]{0,31}$

External Id of the feature type provided by client. Must be unique among all feature type external ids within a CDF project.

Example: ocean_measures
Request Body schema: application/json
allowDimensionalityMismatch
boolean (GeospatialAllowDimensionalityMismatch)

Optional parameter indicating if the spatial filter operators allow input geometries with a different dimensionality than the properties they are applied to. For instance, when set to true, if a feature type has a property of type POLYGONZM (4D), its features can be filtered using the stContains operator and a POLYGON (2D) value. This option defaults to false if not specified.

GeospatialFeatureNotFilter (object) or GeospatialFeatureAndFilter (object) or GeospatialFeatureOrFilter (object) or GeospatialFeatureEqualsFilter (object) or GeospatialFeatureMissingFilter (object) or GeospatialFeatureLikeFilter (object) or GeospatialFeatureRegexFilter (object) or GeospatialFeatureRangeFilter (object) or GeospatialFeatureContainsAnyFilter (object) or GeospatialFeatureInFilter (object) or GeospatialFeatureStIntersectsFilter (object) or GeospatialFeatureStIntersects3dFilter (object) or GeospatialFeatureStWithinFilter (object) or GeospatialFeatureStWithinProperlyFilter (object) or GeospatialFeatureStContainsFilter (object) or GeospatialFeatureStContainsProperlyFilter (object) or GeospatialFeatureStWithinDistanceFilter (object) or GeospatialFeatureStWithinDistance3dFilter (object) (GeospatialFeatureFilter)
aggregates
Array of strings
Deprecated

This parameter is deprecated. Use output instead. Names of aggregate functions that are requested.

Items Enum: "avg" "count" "max" "min" "stCentroid" "stCollect" "stConvexHull" "stIntersection" "stUnion" "sum" "variance"
property
string
Deprecated

This parameter is deprecated. Use output instead. Property name.

outputSrid
integer (GeospatialReferenceId) [ 0 .. 1000000 ]

EPSG code, e.g. 4326. Only valid for geometry types. See https://en.wikipedia.org/wiki/Spatial_reference_system

groupBy
Array of strings

names of properties to be used for grouping by

sort
Array of strings

Sort result by the selected fields (properties or aggregates). Default sort order is ascending if not specified. Available sort direction: ASC, DESC, ASC_NULLS_FIRST, DESC_NULLS_FIRST, ASC_NULLS_LAST, DESC_NULLS_LAST.

object (GeospatialAggregateOutput)

A list of aggregations which are requested.

Responses
200

The aggregate feature response. The present fields in the response body correspond to requested aggregations.

400

Failed request reponse.

post/geospatial/featuretypes/{featureTypeExternalId}/features/aggregate
Request samples
application/json
{
  • "filter": {
    },
  • "groupBy": [
    ],
  • "sort": [
    ],
  • "output": {
    }
}
Response samples
application/json
{
  • "items": [
    ]
}

Compute

Required capabilities: geospatialAcl:READ geospatialCrsAcl:READ

Compute custom json output structures or well known binary format responses based on calculation or selection of feature properties or direct values given in the request.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
Request Body schema: application/json
One of:
required
object
Responses
200

Compute response.

post/geospatial/compute
Request samples
application/json
{
  • "output": {
    }
}
Response samples
application/json
{
  • "items": [
    ]
}

Put a raster into a feature property

Required capabilities: geospatialAcl:READ geospatialAcl:WRITE

Put a raster into a feature property. The feature property must be of type RASTER.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
path Parameters
featureTypeExternalId
required
string <= 32 characters ^[A-Za-z][A-Za-z0-9_]{0,31}$

External Id of the feature type provided by client. Must be unique among all feature type external ids within a CDF project.

Example: ocean_measures
featureExternalId
required
string <= 256 characters ^[A-Za-z][A-Za-z0-9_]{0,255}$

External Id of the type provided by client. Must be unique among all feature external ids within a CDF project and feature type.

Example: ocean_measure_W87H62
rasterPropertyName
required
string <= 32 characters ^[A-Za-z][A-Za-z0-9_]{0,31}$

Raster Id of the raster property provided by client. Must be unique among all feature property names within a feature type.

Example: bathymetry
query Parameters
srid
required
integer [ 1 .. 999999 ]

mandatory parameter that specifies the SRID of the coordinate reference system of a raster.

Example: srid=3857
format
required
string

mandatory parameter that specifies the format of the input raster.

Value: "XYZ"
Example: format=XYZ
scaleX
number <double>

optional parameter that specifies the pixel scale x in storage. If not specified, the pixel scale remains the same as the input raster.

Example: scaleX=2
scaleY
number <double>

optional parameter that specifies the pixel scale y in storage. If not specified, the pixel scale remains the same as the input raster.

Example: scaleY=2
allowCrsTransformation
boolean

Optional parameter indicating if the input raster coordinates should be transformed into the Coordinate Reference Systems defined for the raster property in the feature type specification. The transformation will typically impact the pixel values. When the parameter is false, requests with rasters in Coordinate Reference System different from the ones defined in the feature type will result in bad request response code.

Example: allowCrsTransformation=true
Request Body schema: application/octet-stream
any <binary>
Responses
200

The raster metadata.

400

Failed request reponse.

put/geospatial/featuretypes/{featureTypeExternalId}/features/{featureExternalId}/rasters/{rasterPropertyName}
Response samples
application/json
{
  • "srid": 3857,
  • "width": 4,
  • "height": 5,
  • "numBands": 1,
  • "scaleX": 1,
  • "scaleY": 1,
  • "skewX": 0,
  • "skewY": 0,
  • "upperLeftX": -0.5,
  • "upperLeftY": -0.5
}

Get a raster from a feature property

Required capabilities: geospatialAcl:READ

Get a raster from a feature property. The feature property must be of type RASTER.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
path Parameters
featureTypeExternalId
required
string <= 32 characters ^[A-Za-z][A-Za-z0-9_]{0,31}$

External Id of the feature type provided by client. Must be unique among all feature type external ids within a CDF project.

Example: ocean_measures
featureExternalId
required
string <= 256 characters ^[A-Za-z][A-Za-z0-9_]{0,255}$

External Id of the type provided by client. Must be unique among all feature external ids within a CDF project and feature type.

Example: ocean_measure_W87H62
rasterPropertyName
required
string <= 32 characters ^[A-Za-z][A-Za-z0-9_]{0,31}$

Raster Id of the raster property provided by client. Must be unique among all feature property names within a feature type.

Example: bathymetry
Request Body schema: application/json
One of:

XYZ specification for the output raster

srid
integer (GeospatialReferenceId) [ 0 .. 1000000 ]

EPSG code, e.g. 4326. Only valid for geometry types. See https://en.wikipedia.org/wiki/Spatial_reference_system

scaleX
number <double>
scaleY
number <double>
format
required
string
Value: "XYZ"
object
Responses
200

The binary file of the raster in the specified format

400

Failed request reponse.

post/geospatial/featuretypes/{featureTypeExternalId}/features/{featureExternalId}/rasters/{rasterPropertyName}
Request samples
application/json
{
  • "srid": 4326,
  • "scaleX": 0,
  • "scaleY": 0,
  • "format": "GTiff",
  • "options": {
    }
}
Response samples
application/json
{
  • "error": {
    }
}

Delete a raster from a feature property

Required capabilities: geospatialAcl:READ geospatialAcl:WRITE

Delete a raster from a feature property. If there is no raster already, the operation is a no-op.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
path Parameters
featureTypeExternalId
required
string <= 32 characters ^[A-Za-z][A-Za-z0-9_]{0,31}$

External Id of the feature type provided by client. Must be unique among all feature type external ids within a CDF project.

Example: ocean_measures
featureExternalId
required
string <= 256 characters ^[A-Za-z][A-Za-z0-9_]{0,255}$

External Id of the type provided by client. Must be unique among all feature external ids within a CDF project and feature type.

Example: ocean_measure_W87H62
rasterPropertyName
required
string <= 32 characters ^[A-Za-z][A-Za-z0-9_]{0,31}$

Raster Id of the raster property provided by client. Must be unique among all feature property names within a feature type.

Example: bathymetry
Responses
200

Empty response.

400

Failed request reponse.

post/geospatial/featuretypes/{featureTypeExternalId}/features/{featureExternalId}/rasters/{rasterPropertyName}/delete
Response samples
application/json
{ }
➔ Next to 3D Models