Read Features

Iterate features in the space

Iterates all of the features in the space. The features in the response are ordered so that no feature is returned twice. If there are more features which could be loaded, the response FeatureCollection contains the root attribute handle. The value of this attribute can be passed as a query parameter for the following request in order to continue the iteration from the marked position.

get/spaces/{spaceId}/iterate

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.

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
sortstring[]

Specifies the sort order by a list of properties. Ascending assumed if no sort direction (:asc, :desc) is specified

Example: ?sort=p.name:asc,p.color:desc

partinteger[]

Requests disjunct parts of iteration results (used with sort). List of two integers "part,total". part=1,4 read as first part out of 4, ... until part=4,4 .

Example: ?part=7,9

skipCacheboolean

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

handlestring

The handle to continue the iteration.

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.

Response

A FeatureCollection with handle response.

Changes