Sign in
Manage Changesets

Get Changesets

Retrieves a subset of existing Changesets from the space's history. The subset can be defined either by a "startVersion" and an "endVersion" or by providing a version ref that references a version range of a specific branch: e.g., "main:5..6" or "myBranch:0..HEAD".

The version range can be specified using the versionRef query-parameter as follows: <start>..<end>

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

Each successful write transaction to the space is stored as one single Changeset, which can contain modifications applied to one or more features.

The response payload may be split in multiple pages. The next page token is written in the property 'nextPageToken', which then can be used to retrieve the next page using the 'pageToken' parameter on the next call.

get/spaces/{spaceId}/changesets

Path parameters

spaceIdstring required

The unique identifier of the space.

Query parameters

versionRefstring

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"-branch
startVersioninteger

[Deprecated] Please define the version range using the versionRef query parameter.

Defines the start of the version-range [version >= startVersion].

endVersioninteger

[Deprecated] Please define the version range using the versionRef query parameter.

Defines the end of the version-range [version <= endVersion].

pageTokenstring

The page token where the iteration continues.

limitinteger

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

authorstring

Filter the results per author.

startTimeinteger

Filter changesets by creation time. Start time in milliseconds since the UNIX epoch (exclusive).

endTimeinteger

Filter changesets by creation time. End time in milliseconds since the UNIX epoch (inclusive).

Response

A collection of Changesets which contains FeatureCollections grouped by operation.

Changes

Changed in 10 of the 50 revisions of this API.5614

  • 10d7c919d1ca3See the full diff
    • ○

      added the new optional query request parameter author

      new-optional-request-parameter

    • ○

      added the new optional query request parameter endTime

      new-optional-request-parameter

    • ○

      added the new optional query request parameter startTime

      new-optional-request-parameter

  • f8364de657ab2See the full diff
    • ○

      query request parameter endVersion was deprecated

      request-parameter-deprecated

    • ○

      query request parameter startVersion was deprecated

      request-parameter-deprecated

  • a5a97b4943e21See the full diff
    • ○

      added the new optional query request parameter versionRef

      new-optional-request-parameter

  • c39c865eea002See the full diff
    • ○

      the query request parameter endVersion became optional

      request-parameter-became-optional

    • ○

      the query request parameter startVersion became optional

      request-parameter-became-optional

  • 409ef8fb277a11See the full diff
    • ●

      removed the optional property // from the response with the status

      response-optional-property-removed

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

  • a8709c5fe13311See the full diff
    • ●

      removed the optional property // from the response with the status

      response-optional-property-removed

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

  • 539d9580be991See the full diff
    • ▲

      for the query request parameter versionRef, default value main:HEAD was added

      request-parameter-default-value-added

  • ac66f55537d811See the full diff
    • ▲

      removed the media type application/json for the response with the status

      response-media-type-removed

    • ○

      added the media type application/vnd.here.changeset-collection for the response with the status

      response-media-type-added

  • 15451501d2f411See the full diff
    • ▲

      removed the media type application/vnd.here.changeset-collection for the response with the status

      response-media-type-removed

    • ○

      added the media type application/json for the response with the status

      response-media-type-added

  • fb8e107462aa242See the full diff
    • ▲

      the query request parameter endVersion became required

      request-parameter-became-required

    • ▲

      the query request parameter startVersion became required

      request-parameter-became-required

    • ●

      deleted the query request parameter author

      request-parameter-removed

    • ●

      deleted the query request parameter endTime

      request-parameter-removed

    • ●

      deleted the query request parameter startTime

      request-parameter-removed

    • ●

      deleted the query request parameter versionRef

      request-parameter-removed

    • ○

      query request parameter endVersion was reactivated

      request-parameter-reactivated

    • ○

      query request parameter startVersion was reactivated

      request-parameter-reactivated

    This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog