v1

latestOpenAPI 3.0.12026-07-24110189356.6 KB

Read Features

Iterate features in the layer

Iterates all of the features in the layer. 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 nextPageToken. 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/layers/{layerId}/iterate

Path parameters

layerIdstring required

The unique identifier of the layer.

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

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.

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 target version reference when reading or writing features. A reference describes a target tag or a version.

Default is: HEAD

<br> Depending on the use-case it can be necessary to specify a range of versions rather than only one version. In such a case the version part of the Ref would look like: `<start>..<end>`

Where <start> is the start of the range (exclusive) and <end> is the end of the range (inclusive).

Another way of specifying a version range is using the star-symbol: *

Using * refers to "all available versions" in the space or branch and is only applicable in the cases in which a version range may be provided.

<br> Samples: - `42` points to version 42 - `HEAD` points to the latest version - `myTag` points to the version of the tag with ID "myTag" - `0..HEAD` points to all available versions - `*` also points to all versions (short form) - `5..10` points to the versions in the interval `]5, 10]`

pageTokenstring

The page token where the iteration will continue.

Response

A FeatureCollection with handle response.