v1
latestOpenAPI 3.0.22026-07-174950145.6 KBIterate 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.
Path parameters
The unique identifier of the space.
Query parameters
The maximum number of features in the response. Default is 30000. Hard limit is 100000.
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
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
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
If set to true the response is not returned from cache. Default is false.
The handle to continue the iteration.
If set to true the features in the response have only X's and Y's as coordinates.
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:
| Context | Description |
|---|---|
| default | The 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. |
| extension | The operation will be executed only in the extension and no operation will be performed in the extended space. |
| super | Only applicable for read-operations. The operation will be executed only in the space being extended (super space). |
The query parameter used to specify the version of a feature or feature collection to be loaded.
The query parameter used to specify the target version reference when reading or writing features. A reference describes a target tag or a branch and/or a version within that target branch.
Default is: main:HEAD
<br> Version references have the following syntax: <br> `[<branchName (optional, default: main)>:][<version (optional, default: HEAD)>] | [<tagName> (optional)]` <br> The "main"-branch is pointing to the space itself as it has been created in the first place. Defining the branch as part of the reference only becomes necessary if further branches have been created for the space, which should be addressed by the ref. <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: - `main:42` points to version 42 of the "main"-branch - `myTag` points to the version of the tag with ID "myTag" - `myBranch:37` Points to version 37 of the branch with ID "myBranch" - `42` points to version 42 of the "main"-branch - `myBranch:HEAD` points to the latest version of the branch with ID "myBranch" - `HEAD` points to the latest version of the "main"-branch - `myBranch` points to the latest version of the branch with ID "myBranch" - `myBranch:0..HEAD` points to all available versions of the branch with ID "myBranch" - `0..HEAD` also points to all available versions of the "main"-branch - `*` also points to all versions (short form) - `myBranch:*` also points to all versions of branch "myBranch" (short form) - `main:5..10` points to the versions in the interval `]5, 10]` of the "main"-branch - `5..10` also points to the versions in the interval `]5, 10]` of the "main"-branchResponse
A FeatureCollection with handle response.