Write Features

Create or replace multiple features

Create or replace the provided features.

put/layers/{layerId}/features

Request

  • Base URL
    https://use.apilookup.for.a.base.url
  • URL
    https://use.apilookup.for.a.base.url/layers/{layerId}/features
  • Auth
    HTTP bearer

Path parameters

layerIdstring required

The unique identifier of the layer.

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 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]`

Request body

typestring required
bboxnumber[]

Describes the coordinate range of the GeoJSON object.

Example request

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "id": "BfiimUxHjj",
      "geometry": {
        "type": "Point",
        "coordinates": [
          -2.960847,
          53.430828
        ]
      },
      "properties": {
        "name": "Anfield",
        "@ns:com:here:xyz": {
          "createdAt": 1517504700726,
          "updatedAt": 1517504700726
        },
        "amenity": "Football Stadium",
        "capacity": 54074,
        "description": "Home of the Liverpool Football Club."
      }
    }
  ]
}

Response

An array of features and their modifications response.

typestring required
bboxnumber[]

Describes the coordinate range of the GeoJSON object.

insertedstring[]

List of inserted feature IDs.

updatedstring[]

List of updated features IDs.

deletedstring[]

List of deleted features IDs.

Example response

{
  "type": "FeatureCollection",
  "etag": "b9be03f253c53c23",
  "inserted": [
    "BfiimUxHjj"
  ],
  "updated": [
    "cuiImUxOjj"
  ],
  "features": [
    {
      "type": "Feature",
      "id": "BfiimUxHjj",
      "geometry": {
        "type": "Point",
        "coordinates": [
          -2.960847,
          53.430828
        ]
      },
      "properties": {
        "name": "Anfield",
        "@ns:com:here:xyz": {
          "createdAt": 1517504700726,
          "updatedAt": 1517504700726,
          "space": "0FzlE2wX"
        },
        "amenity": "Football Stadium",
        "capacity": 54074,
        "description": "Home of the Liverpool Football Club."
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.