HERE Interactive Map API v1

{"openapi":"3.0.2","info":{"title":"Interactive Map API v1","description":"Interactive Map API v1 is a REST API for simple access to geo data.","contact":{},"version":"1.22.2","x-olp-service":{"name":"interactive","version":"v1"}},"externalDocs":{"description":"The developer guide and related API references are available here.","url":"https://www.here.com/docs/category/data-api"},"servers":[{"url":"https://use.apilookup.for.a.base.url/"}],"security":[{"Bearer":[]}],"tags":[{"name":"Read Features","description":"Read only endpoints for features."},{"name":"Write Features","description":"Write endpoints for features."},{"name":"Manage Tags","description":"Read and write endpoints for tags."}],"paths":{"/layers/{layerId}/features":{"get":{"tags":["Read Features"],"summary":"Get features by ID","description":"Returns all the features found for the provided list of IDs. The response is always a FeatureCollection, even if there are no features with the provided IDs.","operationId":"Interactive Map API v1 getFeatures","parameters":[{"$ref":"#/components/parameters/LayerId"},{"$ref":"#/components/parameters/Ids"},{"$ref":"#/components/parameters/PropertiesSelection"},{"$ref":"#/components/parameters/Force2D"},{"$ref":"#/components/parameters/VersionRef"},{"$ref":"#/components/parameters/Author"}],"responses":{"200":{"$ref":"#/components/responses/FeatureCollectionResponse"},"401":{"$ref":"#/components/responses/ErrorResponse401"},"403":{"$ref":"#/components/responses/ErrorResponse403"},"404":{"$ref":"#/components/responses/ErrorResponse404"},"513":{"$ref":"#/components/responses/ErrorResponse513"}},"security":[{"ApiKey":[]},{"Bearer":[]}],"x-olp-access-type":"resource"},"put":{"tags":["Write Features"],"summary":"Create or replace multiple features","description":"Create or replace the provided features.","operationId":"Interactive Map API v1 putFeatures","parameters":[{"$ref":"#/components/parameters/LayerId"},{"$ref":"#/components/parameters/VersionRef"}],"requestBody":{"$ref":"#/components/requestBodies/FeatureCollectionRequest"},"responses":{"200":{"$ref":"#/components/responses/FeatureCollectionModificationResponse"},"204":{"$ref":"#/components/responses/EmptyResponse"},"400":{"$ref":"#/components/responses/ErrorResponse400"},"401":{"$ref":"#/components/responses/ErrorResponse401"},"403":{"$ref":"#/components/responses/ErrorResponse403"},"404":{"$ref":"#/components/responses/ErrorResponse404"},"409":{"$ref":"#/components/responses/ErrorResponse409"},"413":{"$ref":"#/components/responses/ErrorResponse413"},"513":{"$ref":"#/components/responses/ErrorResponse513"}},"x-olp-access-type":"resource"},"post":{"tags":["Write Features"],"summary":"Modify features in the layer","description":"Create or patch features.","operationId":"Interactive Map API v1 postFeatures","parameters":[{"$ref":"#/components/parameters/LayerId"},{"$ref":"#/components/parameters/VersionRef"}],"requestBody":{"$ref":"#/components/requestBodies/FeatureCollectionOrFeatureModificationListRequest"},"responses":{"200":{"$ref":"#/components/responses/FeatureCollectionModificationResponse"},"204":{"$ref":"#/components/responses/EmptyResponse"},"400":{"$ref":"#/components/responses/ErrorResponse400"},"401":{"$ref":"#/components/responses/ErrorResponse401"},"403":{"$ref":"#/components/responses/ErrorResponse403"},"404":{"$ref":"#/components/responses/ErrorResponse404"},"409":{"$ref":"#/components/responses/ErrorResponse409"},"413":{"$ref":"#/components/responses/ErrorResponse413"},"513":{"$ref":"#/components/responses/ErrorResponse513"}},"x-olp-access-type":"resource"},"delete":{"tags":["Write Features"],"summary":"Delete multiple features","description":"Delete the features with the provided ids.","operationId":"Interactive Map API v1 deleteFeatures","parameters":[{"$ref":"#/components/parameters/LayerId"},{"$ref":"#/components/parameters/Ids"},{"$ref":"#/components/parameters/VersionRef"},{"name":"eraseContent","in":"query","description":"false - [default]\n\ntrue  - erase, wipe all content","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"$ref":"#/components/responses/FeatureCollectionModificationResponse"},"204":{"$ref":"#/components/responses/EmptyResponse"},"401":{"$ref":"#/components/responses/ErrorResponse401"},"403":{"$ref":"#/components/responses/ErrorResponse403"},"404":{"$ref":"#/components/responses/ErrorResponse404"}},"x-olp-access-type":"resource"}},"/layers/{layerId}/features/{featureId}":{"get":{"tags":["Read Features"],"summary":"Get a feature by ID","description":"Retrieves the feature with the provided identifier.","operationId":"Interactive Map API v1 getFeature","parameters":[{"$ref":"#/components/parameters/LayerId"},{"$ref":"#/components/parameters/FeatureId"},{"$ref":"#/components/parameters/PropertiesSelection"},{"$ref":"#/components/parameters/Force2D"},{"$ref":"#/components/parameters/VersionRef"},{"$ref":"#/components/parameters/Author"}],"responses":{"200":{"$ref":"#/components/responses/FeatureResponse"},"401":{"$ref":"#/components/responses/ErrorResponse401"},"403":{"$ref":"#/components/responses/ErrorResponse403"},"404":{"$ref":"#/components/responses/ErrorResponse404"},"513":{"$ref":"#/components/responses/ErrorResponse513"}},"security":[{"ApiKey":[]},{"Bearer":[]}],"x-olp-access-type":"resource"},"put":{"tags":["Write Features"],"summary":"Create or replace a feature","description":"Creates or replaces a feature in the layer.","operationId":"Interactive Map API v1 putFeature","parameters":[{"$ref":"#/components/parameters/LayerId"},{"$ref":"#/components/parameters/FeatureId"},{"$ref":"#/components/parameters/VersionRef"}],"requestBody":{"$ref":"#/components/requestBodies/FeatureRequest"},"responses":{"200":{"$ref":"#/components/responses/FeatureResponse"},"400":{"$ref":"#/components/responses/ErrorResponse400"},"401":{"$ref":"#/components/responses/ErrorResponse401"},"403":{"$ref":"#/components/responses/ErrorResponse403"},"409":{"$ref":"#/components/responses/ErrorResponse409"},"413":{"$ref":"#/components/responses/ErrorResponse413"},"513":{"$ref":"#/components/responses/ErrorResponse513"}},"x-olp-access-type":"resource"},"patch":{"tags":["Write Features"],"summary":"Patch a feature","description":"Patches an existing feature.","operationId":"Interactive Map API v1 patchFeature","parameters":[{"$ref":"#/components/parameters/LayerId"},{"$ref":"#/components/parameters/FeatureId"},{"$ref":"#/components/parameters/VersionRef"}],"requestBody":{"$ref":"#/components/requestBodies/FeatureRequest"},"responses":{"200":{"$ref":"#/components/responses/FeatureResponse"},"400":{"$ref":"#/components/responses/ErrorResponse400"},"401":{"$ref":"#/components/responses/ErrorResponse401"},"403":{"$ref":"#/components/responses/ErrorResponse403"},"404":{"$ref":"#/components/responses/ErrorResponse404"},"409":{"$ref":"#/components/responses/ErrorResponse409"},"413":{"$ref":"#/components/responses/ErrorResponse413"},"513":{"$ref":"#/components/responses/ErrorResponse513"}},"x-olp-access-type":"resource"},"delete":{"tags":["Write Features"],"summary":"Deletes a feature from the layer","description":"Deletes an existing feature.","operationId":"Interactive Map API v1 deleteFeature","parameters":[{"$ref":"#/components/parameters/LayerId"},{"$ref":"#/components/parameters/FeatureId"},{"$ref":"#/components/parameters/VersionRef"}],"responses":{"204":{"$ref":"#/components/responses/EmptyResponse"},"401":{"$ref":"#/components/responses/ErrorResponse401"},"403":{"$ref":"#/components/responses/ErrorResponse403"},"404":{"$ref":"#/components/responses/ErrorResponse404"}},"x-olp-access-type":"resource"}},"/layers/{layerId}/statistics":{"get":{"tags":["Read Features"],"summary":"Get statistics","description":"Returns statistical information about this layer.","operationId":"Interactive Map API v1 getStatistics","parameters":[{"$ref":"#/components/parameters/LayerId"},{"$ref":"#/components/parameters/SkipCache"}],"responses":{"200":{"$ref":"#/components/responses/StatisticsResponse"},"401":{"$ref":"#/components/responses/ErrorResponse401"},"403":{"$ref":"#/components/responses/ErrorResponse403"},"404":{"$ref":"#/components/responses/ErrorResponse404"}},"security":[{"ApiKey":[]},{"Bearer":[]}],"x-olp-access-type":"resource"}},"/layers/{layerId}/bbox":{"get":{"tags":["Read Features"],"summary":"Get features by bounding box","description":"Return the features which are inside a bounding box stipulated by bbox parameter.","operationId":"Interactive Map API v1 getFeaturesByBBox","parameters":[{"$ref":"#/components/parameters/LayerId"},{"$ref":"#/components/parameters/Clip"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/PropertiesQuery"},{"$ref":"#/components/parameters/PropertiesSelection"},{"$ref":"#/components/parameters/SkipCache"},{"$ref":"#/components/parameters/Clustering"},{"$ref":"#/components/parameters/ClusteringParams"},{"$ref":"#/components/parameters/Force2D"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/BBox"},{"$ref":"#/components/parameters/VersionRef"}],"responses":{"200":{"$ref":"#/components/responses/FeatureCollectionResponse"},"400":{"$ref":"#/components/responses/ErrorResponse400"},"401":{"$ref":"#/components/responses/ErrorResponse401"},"403":{"$ref":"#/components/responses/ErrorResponse403"},"404":{"$ref":"#/components/responses/ErrorResponse404"},"513":{"$ref":"#/components/responses/ErrorResponse513"}},"security":[{"ApiKey":[]},{"Bearer":[]}],"x-olp-access-type":"resource"}},"/layers/{layerId}/tile/{tileType}/{tileId}":{"get":{"tags":["Read Features"],"summary":"Get features in tile","description":"List the features selected by tile type and tile id.","operationId":"Interactive Map API v1 getFeaturesByTile","parameters":[{"$ref":"#/components/parameters/LayerId"},{"$ref":"#/components/parameters/TileType"},{"$ref":"#/components/parameters/TileId"},{"$ref":"#/components/parameters/Clip"},{"$ref":"#/components/parameters/PropertiesQuery"},{"$ref":"#/components/parameters/PropertiesSelection"},{"$ref":"#/components/parameters/SkipCache"},{"$ref":"#/components/parameters/Clustering"},{"$ref":"#/components/parameters/ClusteringParams"},{"$ref":"#/components/parameters/Margin"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/Force2D"},{"$ref":"#/components/parameters/Mode"},{"$ref":"#/components/parameters/VizSampling"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/VersionRef"}],"responses":{"200":{"$ref":"#/components/responses/TileResponse"},"400":{"$ref":"#/components/responses/ErrorResponse400"},"401":{"$ref":"#/components/responses/ErrorResponse401"},"403":{"$ref":"#/components/responses/ErrorResponse403"},"404":{"$ref":"#/components/responses/ErrorResponse404"},"513":{"$ref":"#/components/responses/ErrorResponse513"}},"security":[{"ApiKey":[]},{"Bearer":[]}],"x-olp-access-type":"resource"}},"/layers/{layerId}/spatial":{"get":{"tags":["Read Features"],"summary":"Get features with radius search","description":"List the features which are inside the specified radius.\nThe origin radius point is calculated based either on latitude & longitude or by\nspecifying a features geometry. As third option it is possible to use a H3 index\nas input geometry.\n","operationId":"Interactive Map API v1 getFeaturesBySpatial","parameters":[{"$ref":"#/components/parameters/LayerId"},{"$ref":"#/components/parameters/Latitude"},{"$ref":"#/components/parameters/Longitude"},{"$ref":"#/components/parameters/RefLayerId"},{"$ref":"#/components/parameters/RefFeatureId"},{"$ref":"#/components/parameters/H3Index"},{"$ref":"#/components/parameters/Radius"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/Clip"},{"$ref":"#/components/parameters/PropertiesQuery"},{"$ref":"#/components/parameters/PropertiesSelection"},{"$ref":"#/components/parameters/SkipCache"},{"$ref":"#/components/parameters/Force2D"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/VersionRef"},{"$ref":"#/components/parameters/RefCatalogHrn"}],"responses":{"200":{"$ref":"#/components/responses/FeatureCollectionResponse"},"400":{"$ref":"#/components/responses/ErrorResponse400"},"401":{"$ref":"#/components/responses/ErrorResponse401"},"403":{"$ref":"#/components/responses/ErrorResponse403"},"404":{"$ref":"#/components/responses/ErrorResponse404"},"513":{"$ref":"#/components/responses/ErrorResponse513"}},"security":[{"ApiKey":[]},{"Bearer":[]}],"x-olp-access-type":"resource"},"post":{"tags":["Read Features"],"summary":"Get features which intersects the provided geometry.","description":"List the features which are inside the specified radius.\nThe origin point is calculated based on the geometry provided as payload.\n","operationId":"Interactive Map API v1 getFeaturesBySpatialPost","parameters":[{"$ref":"#/components/parameters/LayerId"},{"$ref":"#/components/parameters/Radius"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/Clip"},{"$ref":"#/components/parameters/PropertiesQuery"},{"$ref":"#/components/parameters/PropertiesSelection"},{"$ref":"#/components/parameters/SkipCache"},{"$ref":"#/components/parameters/Force2D"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/VersionRef"}],"requestBody":{"$ref":"#/components/requestBodies/GeometryRequest"},"responses":{"200":{"$ref":"#/components/responses/FeatureCollectionResponse"},"400":{"$ref":"#/components/responses/ErrorResponse400"},"401":{"$ref":"#/components/responses/ErrorResponse401"},"403":{"$ref":"#/components/responses/ErrorResponse403"},"404":{"$ref":"#/components/responses/ErrorResponse404"},"513":{"$ref":"#/components/responses/ErrorResponse513"}},"security":[{"ApiKey":[]},{"Bearer":[]}],"x-olp-access-type":"resource"}},"/layers/{layerId}/search":{"get":{"tags":["Read Features"],"summary":"Search for features","description":"Searches for features in the layer. The results are unordered and the request does not allow continuation of the search, which is the main difference when compared to the _iterate_ request.","operationId":"Interactive Map API v1 searchFeatures","parameters":[{"$ref":"#/components/parameters/LayerId"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/PropertiesQuery"},{"$ref":"#/components/parameters/PropertiesSelection"},{"$ref":"#/components/parameters/SkipCache"},{"$ref":"#/components/parameters/Force2D"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/VersionRef"},{"$ref":"#/components/parameters/Author"}],"responses":{"200":{"$ref":"#/components/responses/FeatureCollectionResponse"},"400":{"$ref":"#/components/responses/ErrorResponse400"},"401":{"$ref":"#/components/responses/ErrorResponse401"},"403":{"$ref":"#/components/responses/ErrorResponse403"},"404":{"$ref":"#/components/responses/ErrorResponse404"},"513":{"$ref":"#/components/responses/ErrorResponse513"}},"security":[{"ApiKey":[]},{"Bearer":[]}],"x-olp-access-type":"resource"}},"/layers/{layerId}/iterate":{"get":{"tags":["Read Features"],"summary":"Iterate features in the layer","description":"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.","operationId":"Interactive Map API v1 iterateFeatures","parameters":[{"$ref":"#/components/parameters/LayerId"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/PropertiesSelection"},{"$ref":"#/components/parameters/SkipCache"},{"$ref":"#/components/parameters/Force2D"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/VersionRef"},{"$ref":"#/components/parameters/PageToken"}],"responses":{"200":{"$ref":"#/components/responses/IterateResponse"},"400":{"$ref":"#/components/responses/ErrorResponse400"},"401":{"$ref":"#/components/responses/ErrorResponse401"},"403":{"$ref":"#/components/responses/ErrorResponse403"},"404":{"$ref":"#/components/responses/ErrorResponse404"},"513":{"$ref":"#/components/responses/ErrorResponse513"}},"security":[{"ApiKey":[]},{"Bearer":[]}],"x-olp-access-type":"resource"}},"/layers/{layerId}/changesets":{"get":{"tags":["Manage Changesets"],"summary":"Get Changesets","description":"Retrieves a subset of existing Changesets from the space's history.\nThe subset can be defined by providing a version ref that references a version range\ne.g., \"5..6\" or \"0..HEAD\"\n\n\nThe version range can be specified using the `versionRef` query-parameter as follows:\n`<start>..<end>`\n\nWhere `<start>` is the start of the range (exclusive) and `<end>` is the end of the range\n(inclusive). (`5..10` points to the versions in the interval `]5, 10]`)\n\n\nEach successful write transaction to the space is stored as one single Changeset,\nwhich can contain modifications applied to one or more features.\n\n\nThe response payload may be split in multiple pages. The next page token is written in the\nproperty 'nextPageToken', which then can be used to retrieve the next page using the\n'pageToken' parameter on the next call.\n","operationId":"Interactive Map API v1 getChangesets","parameters":[{"$ref":"#/components/parameters/LayerId"},{"$ref":"#/components/parameters/VersionRef"},{"$ref":"#/components/parameters/PageToken"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/Author"},{"$ref":"#/components/parameters/StartTime"},{"$ref":"#/components/parameters/EndTime"}],"responses":{"200":{"$ref":"#/components/responses/ChangesetCollectionResponse"},"400":{"$ref":"#/components/responses/ErrorResponse400"},"401":{"$ref":"#/components/responses/ErrorResponse401"},"403":{"$ref":"#/components/responses/ErrorResponse403"},"404":{"$ref":"#/components/responses/ErrorResponse404"},"513":{"$ref":"#/components/responses/ErrorResponse513"}},"x-olp-access-type":"resource"},"delete":{"tags":["Manage Changesets"],"summary":"Delete Changesets","description":"Deletes one or more changesets where the version number can be specified by the query parameter 'version', where the value must be an integer, bigger than 0 and the comparator should be one of the below list:\n  - <\n  - =lt=\n\n\nExample: To remove changesets older than version number 10, a DELETE /layers/{layerId}/changesets?version=lt=10 could be executed.\n\nThe service will begin the process to remove the versions from version 9 until the version 0. During the deletion process, newer versions can be created and won't be affected.","operationId":"Interactive Map API v1 deleteChangesets","parameters":[{"$ref":"#/components/parameters/LayerId"},{"$ref":"#/components/parameters/VersionLowerThan"}],"responses":{"204":{"$ref":"#/components/responses/EmptyResponse"},"401":{"$ref":"#/components/responses/ErrorResponse401"},"403":{"$ref":"#/components/responses/ErrorResponse403"},"404":{"$ref":"#/components/responses/ErrorResponse404"}},"x-olp-access-type":"resource"}},"/layers/{layerId}/changesets/{version}":{"get":{"tags":["Manage Changesets"],"summary":"Get Changeset","description":"Retrieves one Changeset from the layer by version.\nEach successful write transaction to the layer is stored as one single Changeset, which can contain modifications applied to one or more features.\nThe response payload may be split in multiple pages, next page is written in the property 'nextPageToken', which then, can be retrieved by using the 'pageToken' parameter.","operationId":"Interactive Map API v1 getChangeset","parameters":[{"$ref":"#/components/parameters/LayerId"},{"$ref":"#/components/parameters/VersionPath"},{"$ref":"#/components/parameters/PageToken"},{"$ref":"#/components/parameters/Limit"}],"responses":{"200":{"$ref":"#/components/responses/ChangesetResponse"},"400":{"$ref":"#/components/responses/ErrorResponse400"},"401":{"$ref":"#/components/responses/ErrorResponse401"},"403":{"$ref":"#/components/responses/ErrorResponse403"},"404":{"$ref":"#/components/responses/ErrorResponse404"},"513":{"$ref":"#/components/responses/ErrorResponse513"}},"x-olp-access-type":"resource"}},"/layers/{layerId}/tags":{"get":{"tags":["Manage Tags"],"summary":"List tags","description":"List tags available in the layer.\nList can include system tags when includeSystemTags parameter is set to true.","operationId":"Interactive Map API v1 listTags","parameters":[{"$ref":"#/components/parameters/LayerId"}],"responses":{"200":{"$ref":"#/components/responses/TagsResponse"},"400":{"$ref":"#/components/responses/ErrorResponse400"},"401":{"$ref":"#/components/responses/ErrorResponse401"},"403":{"$ref":"#/components/responses/ErrorResponse403"}}},"post":{"tags":["Manage Tags"],"summary":"Create a tag","description":"Create a tag, which points to a version of the layer.\nIf a version is not provided when creating the tag, then the current HEAD version will be referenced.","operationId":"Interactive Map API v1 createTag","parameters":[{"$ref":"#/components/parameters/LayerId"}],"requestBody":{"$ref":"#/components/requestBodies/TagRequest"},"responses":{"200":{"$ref":"#/components/responses/TagResponse"},"400":{"$ref":"#/components/responses/ErrorResponse400"},"401":{"$ref":"#/components/responses/ErrorResponse401"},"403":{"$ref":"#/components/responses/ErrorResponse403"},"404":{"$ref":"#/components/responses/ErrorResponse404"},"409":{"$ref":"#/components/responses/ErrorResponse409"}}}},"/layers/{layerId}/tags/{tagId}":{"patch":{"tags":["Manage Tags"],"summary":"Update a tag","description":"Update the version of a tag.","operationId":"Interactive Map API v1 updateTag","parameters":[{"$ref":"#/components/parameters/LayerId"},{"$ref":"#/components/parameters/TagId"}],"requestBody":{"$ref":"#/components/requestBodies/TagRequest"},"responses":{"200":{"$ref":"#/components/responses/TagResponse"},"400":{"$ref":"#/components/responses/ErrorResponse400"},"401":{"$ref":"#/components/responses/ErrorResponse401"},"403":{"$ref":"#/components/responses/ErrorResponse403"},"404":{"$ref":"#/components/responses/ErrorResponse404"}}},"get":{"tags":["Manage Tags"],"summary":"Get a tag","description":"Retrieves a tag.","operationId":"Interactive Map API v1 getTag","parameters":[{"$ref":"#/components/parameters/LayerId"},{"$ref":"#/components/parameters/TagId"}],"responses":{"200":{"$ref":"#/components/responses/TagResponse"},"400":{"$ref":"#/components/responses/ErrorResponse400"},"401":{"$ref":"#/components/responses/ErrorResponse401"},"403":{"$ref":"#/components/responses/ErrorResponse403"},"404":{"$ref":"#/components/responses/ErrorResponse404"}}},"delete":{"tags":["Manage Tags"],"summary":"Delete a tag","description":"Deletes a tag.","operationId":"Interactive Map API v1 deleteTag","parameters":[{"$ref":"#/components/parameters/LayerId"},{"$ref":"#/components/parameters/TagId"}],"responses":{"200":{"$ref":"#/components/responses/TagResponse"},"400":{"$ref":"#/components/responses/ErrorResponse400"},"401":{"$ref":"#/components/responses/ErrorResponse401"},"403":{"$ref":"#/components/responses/ErrorResponse403"},"404":{"$ref":"#/components/responses/ErrorResponse404"}}}}},"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"A token obtained from a separate endpoint using client credentials and an OAuth 1.0a HMAC-SHA256 signed request.\n\nFor more information on how to get a bearer token, see the [Identity & Access Management Guide](https://developer.here.com/documentation/identity-access-management/dev_guide/index.html).\n"},"ApiKey":{"type":"apiKey","in":"query","name":"apiKey","description":"A key generated specifically to authenticate API requests. For more information on how to get an API key, see the [Identity & Access Management Guide](https://developer.here.com/documentation/identity-access-management/dev_guide/index.html).\n"}},"parameters":{"Author":{"name":"author","in":"query","description":"Filter the results per author.","required":false,"schema":{"type":"string"}},"Clip":{"name":"clip","in":"query","description":"If set to _true_ the features' geometries are clipped to the geometry of the tile, bounding box or input geometry. Default is _false_.","required":false,"schema":{"type":"boolean"}},"Clustering":{"name":"clustering","in":"query","description":"The clustering algorithm to apply to the data within the result. Providing this query parameter, the data is returned in a clustered way. This means the data is not necessarily returned in its original shape or with its original properties.\nDepending on the chosen clustering algorithm, there could be different mandatory and/or optional parameters to specify the behavior of the algorithm.\nPossible values are:\n\n  * \"hexbin\"\n\n    The hexbin algorithm divides the world in hexagonal \"bins\" on a specified resolution.\n    Each hexagon has an address being described by the H3 addressing scheme.\n    For more information on this topic see: https://eng.uber.com/h3/\n\n  * \"quadbin\"\n\n    The quadbin algorithm takes the geometry input from the request (for example, quadkey / bbox..)\n    and count the features in it. This clustering mode works also for very large layers and\n    can be used for getting an overview where data is present in a given layer. Furthermore,\n    a property filter on one property is applicable.","required":false,"schema":{"type":"string","enum":["hexbin","quadbin"]}},"ClusteringParams":{"name":"clusteringParams","in":"query","required":false,"description":"Some parameters for the chosen clustering algorithm.\n\nDepending on the chosen clustering algorithm, there could be different mandatory and/or\noptional parameters to specify the behavior of the algorithm.\n\n### Clustering-Parameter reference\n\nNOTE: The actual query parameters in the URL look like: `?clustering.aParameterName=aValue`\n\n**Clustering-type: \"hexbin\":**\n\nThere are several parameters needed by the H3 based hexbin algorithm.\nFor more information on this topic see: https://eng.uber.com/h3/\n\n| Parameter   | Type    | Mandatory | Meaning                                                               |\n|-------------|---------|-----------|-----------------------------------------------------------------------|\n| absoluteResolution  | Number  | NO        | integer, The H3 hexagon resolution [0,13]                      |\n| resolution  | Number  | NO        | deprecated, renamed to absoluteResolution                             |\n| relativeResolution | Number  | NO        | integer value [-2,2] to be added to current used resolution  |\n| property    | String  | NO        | A property of the original features for which to calculate statistics |\n| pointmode   | Boolean | NO        | retuns the centroid of hexagons as geojson feature                    |\n| singlecoord | Boolean | NO        | force to evaluate the first object coordinate only (default: false)   |\n| sampling    | String  | NO        | samplingratio of underlying dataset  |\n|             |         |           | string value [off (1/1), low (1/8), lowmed (1/32), med (1/128), medhigh (1/1024), high (1/4096)] (default: off) |\n\n**Clustering-type: \"quadbin\":**\n\nThere are several parameters needed by the quadbin algorithm. You can use one property filter in combination.\n\n| Parameter   | Type    | Mandatory | Meaning                                                               |\n|-------------|---------|-----------|-----------------------------------------------------------------------|\n| relativeResolution | Number  | NO        | integer, The quad resolution [0,4]                                             |\n| noBuffer    | Boolean | NO        | do not place a buffer around quad polygons, default: false            |\n| resolution  | Number  | NO        | deprecated, renamed to resolutionRelative             |\n| countmode   | String  | NO        | [real, estimated, mixed, bool]                                    |\n|             |         |           | real = real feature counts. Best accuracy, but slow.                  |\n|             |         |           |     Not recommended for big result sets                       |\n|             |         |           |                                                                       |\n|             |         |           | estimated = estimated feature counts. Low accuracy, but very fast      |\n|             |         |           |     Recommended for big result sets                           |\n|             |         |           |                                                                       |\n|             |         |           | mixed (default) = estimated feature counts combined with real ones.   |\n|             |         |           |     If the estimation is low a real count gets applied. Fits to the |\n|             |         |           |     most use cases                                        |\n|             |         |           |                                                                       |\n|             |         |           | bool = test if data exists in tile but does not count features  |\n|             |         |           |     The returned count property set to 1, for non empty tiles |\n","style":"form","explode":true,"allowReserved":true,"schema":{"type":"array","items":{"type":"string"},"example":{"clustering.resolution":3,"clustering.property":"a.nested.property"}}},"StartTime":{"name":"startTime","in":"query","description":"Filter changesets by creation time. Start time in milliseconds since the UNIX epoch (exclusive).\n","required":false,"schema":{"type":"integer","format":"int64","minimum":0}},"EndTime":{"name":"endTime","in":"query","description":"Filter changesets by creation time. End time in milliseconds since the UNIX epoch (inclusive).\n","required":false,"schema":{"type":"integer","format":"int64","minimum":0}},"FeatureId":{"name":"featureId","in":"path","description":"The unique identifier of a feature in the layer.","required":true,"schema":{"type":"string"}},"Force2D":{"name":"force2D","in":"query","description":"If set to _true_ the features in the response have only X's and Y's as coordinates.","schema":{"type":"boolean"}},"Ids":{"name":"id","in":"query","description":"A comma separated list of unique feature identifiers. These are the acceptable formats for this field:\n  * id=value1,value2\n  * id=value1,id=value2\n\n\nnot required when eraseContent=true is used.","required":false,"schema":{"type":"array","items":{"type":"string"}}},"Latitude":{"name":"lat","in":"query","description":"The latitude in WGS'84 decimal degree (-90 to +90) of the center Point.","schema":{"type":"number","minimum":-90,"maximum":90}},"Limit":{"name":"limit","in":"query","description":"The maximum number of features in the response. Default is _30000_. Hard limit is _100000_.","schema":{"type":"integer"}},"Longitude":{"name":"lng","in":"query","description":"The longitude in WGS'84 decimal degree (-180 to +180) of the center Point.","schema":{"type":"number","minimum":-180,"maximum":180}},"Margin":{"name":"margin","in":"query","description":"Margin in pixels on the respective projected level around the tile. Default is 0.","schema":{"type":"integer","minimum":0}},"Mode":{"name":"mode","in":"query","description":"Optimize resultset and geometries for dispaly. mode = [raw|viz]\n\nNote: when using mode=viz, the value of \"limit\" parameter will be set to its max value (100000) if not specified otherwise.","required":false,"schema":{"type":"string","enum":["raw","viz"]}},"PageToken":{"name":"pageToken","in":"query","description":"The page token where the iteration will continue.","schema":{"type":"string"}},"PropertiesQuery":{"name":"params","in":"query","description":"Additional feature filters which compare the feature's property value with the one specified in the query, resulting in a subset of features.\n\nThe usage of multiple property names represents an AND operation. The usage of a comma (,) separating the properties values, represents an OR operation.\n\nProperties initiated with 'f.' are used to access values which are added by default in the stored feature. The possible values are: 'f.id', 'f.createdAt', 'f.updatedAt'.\n\nProperties initiated with 'p.' are used to access values in the stored feature which are under the 'properties' property. Use it as a shorthand accessor for 'properties' values.\n\nThe format should follow the specification below\n  * ?p.property_name_1=property_value_1&f.special_property_name_1=special_property_value_1\n\n\nFor example, th

# --- truncated at 32 KB (60 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/here/refs/heads/main/openapi/here-interactive-map-v1-openapi.yml