Filter all features - Cognite Docs

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))' } } ] }, }; const allFeaturesList = await client.geospatial.feature.list('ocean_temperature', params);

{ "items": [ { "externalId": "measurement_point_765", "temperature": 5.65, "location": { "wkt": "POINT(60.547602 -5.423433)" }, "createdTime": 1629784673505, "lastUpdatedTime": 1629784673505 }, { "externalId": "measurement_point_863", "temperature": 5.03, "location": { "wkt": "POINT(60.585858 -6.474416)" }, "createdTime": 1629784673505, "lastUpdatedTime": 1629784673505 } ], "nextCursor": "pwGTFXeL-JiWO8CZpgP23g" }

Authorizations

Authorization

string

header

required

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

featureTypeExternalId

string

required

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

Maximum string length: 32

Pattern: ^[A-Za-z][A-Za-z0-9_]{0,31}$

Example:

"ocean_measures"

Body

application/json

Feature List Request

allowCrsTransformation

boolean

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:

true

allowDimensionalityMismatch

boolean

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:

true

filter

object

Show child attributes

limit

integer

default:1000

Limits the number of results to be returned.

Required range: 1 <= x <= 1000

output

object

Desired output specification.

Show child attributes

Example:

{
  "properties": {
    "*": {},
    "geometry1": { "srid": 4326 },
    "geometry2": { "srid": 3857 }
  }
}

cursor

string

Example:

"4zj0Vy2fo0NtNMb229mI9r1V3YG5NBL752kQz1cKtwo"

Response

Feature list response.

A list of objects along with possible cursors to get the next page of results

items

object[]

required

Required array length: 1 - 1000 elements

Show child attributes

nextCursor

string

Cursor to get the next page of results (if available).

API reference (20230101-alpha)

Authorizations

Path Parameters

Body

Response