API reference (20230101)
- Overview
- Overview
- POSTAggregate features
- POSTCompute
- POSTCreate Coordinate Reference Systems
- POSTCreate feature types
- POSTCreate features
- POSTDelete Coordinate Reference Systems
- POSTDelete feature types
- POSTDelete features
- POSTDelete a raster from a feature property
- POSTGet Coordinate Reference Systems
- GETGet features
- POSTList feature types
- PUTPut a raster into a feature property
- POSTRetrieve feature types
- POSTRetrieve features
- POSTSearch and stream features
- POSTSearch features
- POSTUpdate feature types
- POSTUpdate features
- POSTFilter all features
const params = {
filter: {
and: [
{ range:{ property: 'temperature', gt:4.54 } },
{ stWithin: { property:'location', value:'POLYGON((60.547602 -5.423433, 60.547602 -6.474416, 60.585858 -5.423433, 60.547602 -5.423433))' } }
]
},
limit: 100,
output: { jsonStreamFormat: 'NEW_LINE_DELIMITED' as const }
};
const featureStreamString = await client.geospatial.feature.searchStream('ocean_temperature', params);{
"externalId": "my.known.id",
"createdTime": 1730204346000,
"lastUpdatedTime": 1730204346000
}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).
const params = {
filter: {
and: [
{ range:{ property: 'temperature', gt:4.54 } },
{ stWithin: { property:'location', value:'POLYGON((60.547602 -5.423433, 60.547602 -6.474416, 60.585858 -5.423433, 60.547602 -5.423433))' } }
]
},
limit: 100,
output: { jsonStreamFormat: 'NEW_LINE_DELIMITED' as const }
};
const featureStreamString = await client.geospatial.feature.searchStream('ocean_temperature', params);{
"externalId": "my.known.id",
"createdTime": 1730204346000,
"lastUpdatedTime": 1730204346000
}Authorizations
Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to accept OpenID Connect tokens. Use a header key of 'Authorization' with a value of 'Bearer $accesstoken'. The token can be obtained through any flow supported by the identity provider.
Path Parameters
External Id of the feature type provided by client. Must be unique among all feature type external ids within a CDF project.
32^[A-Za-z][A-Za-z0-9_]{0,31}$"ocean_measures"
Body
Search and streaming feature request
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.
true
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.
true
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
- Option 8
- Option 9
- Option 10
- Option 11
- Option 12
- Option 13
- Option 14
- Option 15
- Option 16
- Option 17
- Option 18
Show child attributes
Show child attributes
Desired output specification for streaming.
Show child attributes
Show child attributes
{
"jsonStreamFormat": "LENGTH_PREFIXED",
"properties": {
"*": {},
"geometry1": { "srid": 4326 },
"geometry2": { "srid": 3857 }
}
}Response
The feature search streaming response - it can be length prefixed, new line delimited, record separator delimited or concatenated depending on requested output.
The external ID provided by the client. Must be unique for the resource type.
255"my.known.id"
The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
x >= 01730204346000
The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
x >= 01730204346000
Was this page helpful?