Sign in
Read Features

Search for features

Searches for features in the space. The results are unordered and the request does not allow continuation of the search, which is the main difference when compared to the iterate request.

get/spaces/{spaceId}/search

Path parameters

spaceIdstring required

The unique identifier of the space.

Query parameters

limitinteger

The maximum number of features in the response. Default is 30000. Hard limit is 100000.

paramsobject

Additional feature filters which compare the feature's property value with the one specified in the query, resulting in a subset of features.

The usage of multiple property names represents an AND operation. The usage of a comma (,) separating the properties values, represents an OR operation.

Properties initiated with 'f.' are used to access values which are added by default in the stored feature. The possible values are: 'f.id', 'f.createdAt', 'f.updatedAt'.

Properties initiated with 'p.' are used to access values in the stored feature which are under the 'properties' property. Use it as a shorthand accessor for 'properties' values.

The format should follow the specification below

  • ?p.property_name_1=property_value_1&f.special_property_name_1=special_property_value_1

For example, the above query, the Features are filtered by 'property' AND 'special property' equals to their respective values.

While in the following example

  • ?p.property_name_1=value_1,value_2

The resulting Features list contains all elements having value_1 OR value_2.

Additionally, to the operators used in the examples above, the query can be written, with the same semantic, by using the long operators: "=gte=", "=lte=", "=gt=", "=lt=" and "=cs=". The following queries yield the same result:

  • ?p.property_name_1>=10
  • ?p.property_name_1=gte=10

The available operators are:

  • "=" - equals
  • "!=" - not equals
  • "=.null" - is null
  • "!=.null" - is not null
  • ">=" or "=gte=" - greater than or equals
  • "<=" or "=lte=" - less than or equals
  • ">" or "=gt=" - greater than
  • "<" or "=lt=" - less than
  • "@>" or "=cs=" - Array contains
{
  "p.myProperty1": "someValue",
  "p.myProperty2!": "not-equal",
  "p.myNumber1": 5,
  "p.myNumber2=gte": 7
}
selectionstring[]

A list of properties to be returned in the features result list. Multiple attributes can be specified by using comma(,).

Example: ?selection=p.name,p.capacity,p.color,rootpropertyname

  • !geometry : special value to omit geometries
skipCacheboolean

If set to true the response is not returned from cache. Default is false.

force2Dboolean

If set to true the features in the response have only X's and Y's as coordinates.

context'default' | 'extension' | 'super'

The context where the operation will be performed on a composite space. If not specified, the operation occurs based on the extension rules. For additional information, see Space.extends.

Available context are:

ContextDescription
defaultThe default value if none is given. For composite spaces the operation occurs based on the extension rules. For normal spaces this is the only valid context.
extensionThe operation will be executed only in the extension and no operation will be performed in the extended space.
superOnly applicable for read-operations. The operation will be executed only in the space being extended (super space).
versionstring

The query parameter used to specify the version of a feature or feature collection to be loaded.

versionRefstring

The query parameter used to specify the version reference pointing to a tag or a version.

authorstring

Filter the results per author.

Response

An array of features response.

Changes