# Automated Driving Zones Documentation ## Guides - [Welcome to ADZ](https://docs.here.com/automated-driving-zones/docs/getting-started.md) # Anonymizer Documentation ## Guides - [Azure VM](https://docs.here.com/anonymizer/docs/preproc-azure-vm.md) - [Kubernetes](https://docs.here.com/anonymizer/docs/preproc-kubernetes-index.md) - [AWS EKS](https://docs.here.com/anonymizer/docs/preproc-aws-eks.md) - [Azure AKS](https://docs.here.com/anonymizer/docs/preproc-azure-aks.md) - [Docker standalone](https://docs.here.com/anonymizer/docs/preproc-standalone-deployment.md) - [How to install HERE Anonymizer Preprocessor](https://docs.here.com/anonymizer/docs/preproc-installation.md) - [How to run HERE Anonymizer Preprocessor locally in Docker](https://docs.here.com/anonymizer/docs/preproc-run-in-docker.md) - [HERE Anonymizer Preprocessor configuration](https://docs.here.com/anonymizer/docs/preproc-configuration.md) - [HERE Anonymizer Preprocessor data connectors](https://docs.here.com/anonymizer/docs/preproc-connectors-index.md) - [Amazon S3](https://docs.here.com/anonymizer/docs/preproc-amazon-s3.md) - [Azure Blob Storage](https://docs.here.com/anonymizer/docs/preproc-blob-storage.md) - [HERE Anonymizer Preprocessor data lifecycle](https://docs.here.com/anonymizer/docs/preproc-data-lifecycle.md) - [How to perform health checks in HERE Anonymizer Preprocessor](https://docs.here.com/anonymizer/docs/preproc-health-checks.md) - [Introduction to HERE Anonymizer Preprocessor](https://docs.here.com/anonymizer/docs/preproc-intro.md) - [Logging in HERE Anonymizer Preprocessor](https://docs.here.com/anonymizer/docs/preproc-logging.md) - [Monitoring and metrics in HERE Anonymizer Preprocessor](https://docs.here.com/anonymizer/docs/preproc-metrics.md) - [Configuration of HERE Anonymizer Self-Hosted](https://docs.here.com/anonymizer/docs/anonymizer-configuration.md) - [Azure Blob Storage](https://docs.here.com/anonymizer/docs/anonymizer-azure-blob.md) - [Azure Event Hubs](https://docs.here.com/anonymizer/docs/anonymizer-event-hubs.md) - [Apache Kafka](https://docs.here.com/anonymizer/docs/anonymizer-kafka.md) - [AWS Kinesis Data Streams](https://docs.here.com/anonymizer/docs/anonymizer-kinesis.md) - [HERE platform stream layer](https://docs.here.com/anonymizer/docs/anonymizer-olp-stream.md) - [RabbitMQ](https://docs.here.com/anonymizer/docs/anonymizer-rabbit.md) - [AWS S3](https://docs.here.com/anonymizer/docs/anonymizer-s3.md) - [AWS SQS](https://docs.here.com/anonymizer/docs/anonymizer-sqs.md) - [Data connectors in HERE Anonymizer Self-Hosted](https://docs.here.com/anonymizer/docs/anonymizer-connectors.md) - [Custom data formats](https://docs.here.com/anonymizer/docs/anonymizer-custom-data-formats.md) - [GPX](https://docs.here.com/anonymizer/docs/anonymizer-gpx.md) - [HERE probe JSON](https://docs.here.com/anonymizer/docs/anonymizer-here-probe.md) - [SDII](https://docs.here.com/anonymizer/docs/anonymizer-sdii.md) - [SENSORIS](https://docs.here.com/anonymizer/docs/anonymizer-sensoris.md) - [Data message formats in HERE Anonymizer Self-Hosted](https://docs.here.com/anonymizer/docs/anonymizer-data-formats.md) - [Data lifecycle in HERE Anonymizer Self-Hosted](https://docs.here.com/anonymizer/docs/anonymizer-data-lifecycle.md) - [How to perform health checks in HERE Anonymizer Self-Hosted](https://docs.here.com/anonymizer/docs/anonymizer-health-checks.md) - [Introduction to HERE Anonymizer Self-Hosted](https://docs.here.com/anonymizer/docs/anonymizer-intro.md) - [Logging in HERE Anonymizer Self-Hosted](https://docs.here.com/anonymizer/docs/anonymizer-logging.md) - [How to access monitoring and metrics in HERE Anonymizer Self-Hosted](https://docs.here.com/anonymizer/docs/anonymizer-monitoring-metrics.md) - [Alerts detection and routing](https://docs.here.com/anonymizer/docs/anonymizer-alerts-detection-and-routing.md) - [Density-aware anonymization](https://docs.here.com/anonymizer/docs/anonymizer-density-aware-anonymization.md) - [Insights events generation](https://docs.here.com/anonymizer/docs/anonymizer-insights-events-generation.md) - [Origin-destination obfuscation](https://docs.here.com/anonymizer/docs/anonymizer-origin-destination.md) - [POI proximity data removal](https://docs.here.com/anonymizer/docs/anonymizer-poi-proximity-data-removal.md) - [Probe event handling](https://docs.here.com/anonymizer/docs/anonymizer-probe-event-handling.md) - [Region selection exclusion](https://docs.here.com/anonymizer/docs/anonymizer-region-selection-exclusion.md) - [Region selection inclusion](https://docs.here.com/anonymizer/docs/anonymizer-region-selection-inclusion.md) - [Route tracking](https://docs.here.com/anonymizer/docs/anonymizer-route-tracking.md) - [Smart gapping](https://docs.here.com/anonymizer/docs/anonymizer-split-and-gap.md) - [Start and end cutting](https://docs.here.com/anonymizer/docs/anonymizer-start-end-cut.md) - [Staypoint prediction](https://docs.here.com/anonymizer/docs/anonymizer-staypoints.md) - [Whitelisting](https://docs.here.com/anonymizer/docs/anonymizer-whitelisting.md) - [Anonymization](https://docs.here.com/anonymizer/docs/anonymizer-anonymization.md) - [Anonymization management queue](https://docs.here.com/anonymizer/docs/anonymizer-management-queue.md) - [Operational modes of HERE Anonymizer Self-Hosted](https://docs.here.com/anonymizer/docs/anonymizer-operational-modes.md) - [AWS EKS](https://docs.here.com/anonymizer/docs/anonymizer-aws-eks.md) - [Azure AKS](https://docs.here.com/anonymizer/docs/anonymizer-azure-aks.md) - [Rescaling](https://docs.here.com/anonymizer/docs/anonymizer-kubernetes-rescaling.md) - [Kubernetes](https://docs.here.com/anonymizer/docs/anonymizer-kubernetes.md) - [Rescaling](https://docs.here.com/anonymizer/docs/anonymizer-docker-rescaling.md) - [Double processing](https://docs.here.com/anonymizer/docs/anonymizer-double-processing.md) - [Parallelism](https://docs.here.com/anonymizer/docs/anonymizer-parallelism.md) - [Standalone deployment](https://docs.here.com/anonymizer/docs/anonymizer-standalone-deployment.md) - [AWS EC2](https://docs.here.com/anonymizer/docs/anonymizer-aws-ec2.md) - [Azure VM](https://docs.here.com/anonymizer/docs/anonymizer-azure-vm.md) - [How to install HERE Anonymizer Self-Hosted](https://docs.here.com/anonymizer/docs/anonymizer-installation.md) - [How to get and manage HERE Anonymizer Self-Hosted licenses](https://docs.here.com/anonymizer/docs/anonymizer-licensing.md) - [How to run HERE Anonymizer Self-Hosted locally in Docker](https://docs.here.com/anonymizer/docs/anonymizer-run-in-docker.md) ## Changelog - [HERE Anonymizer Self-Hosted](https://docs.here.com/anonymizer/changelog/anonymizer-self-hosted.md) # Coverage Documentation ## Guides - [Coverage information](https://docs.here.com/coverage/docs/here-coverage-information.md) # Data API Documentation ## Guides - [How to get API information for an HRN](https://docs.here.com/data-api/docs/get-apis-for-an-hrn.md) - [How to get information about platform APIs](https://docs.here.com/data-api/docs/get-platform-apis.md) - [Introduction to the HERE API Lookup Service](https://docs.here.com/data-api/docs/readme-api-lookup-developer-guide.md) - [How to share a catalog](https://docs.here.com/data-api/docs/catalog-sharing.md) - [How to create a catalog](https://docs.here.com/data-api/docs/creating-a-catalog.md) - [How to delete catalog versions](https://docs.here.com/data-api/docs/delete-catalog-versions.md) - [How to delete a catalog](https://docs.here.com/data-api/docs/deleting-a-catalog.md) - [How to edit catalog metadata](https://docs.here.com/data-api/docs/editing-catalog-metadata.md) - [How to retrieve metadata from a catalog or layer](https://docs.here.com/data-api/docs/getting-catalog-metadata.md) - [Catalogs](https://docs.here.com/data-api/docs/catalogs.md) - [How to set catalog-level notifications](https://docs.here.com/data-api/docs/notification-catalog.md) - [Data API best practices](https://docs.here.com/data-api/docs/data-api-data.md) - [Data security and durability](https://docs.here.com/data-api/docs/data-security.md) - [Manage data storage and throughput limits](https://docs.here.com/data-api/docs/data-storage-limits.md) - [Get started with the Data API](https://docs.here.com/data-api/docs/get-started-data-api.md) - [Introduction to the Data API](https://docs.here.com/data-api/docs/data-api-intro.md) - [Configure index layer settings](https://docs.here.com/data-api/docs/creating-index-layer.md) - [How to delete an index layer](https://docs.here.com/data-api/docs/delete-a-layer.md) - [How to delete data from an index layer](https://docs.here.com/data-api/docs/deleting-data-index.md) - [How to get data from an index layer](https://docs.here.com/data-api/docs/getting-data-index.md) - [How to use part queries](https://docs.here.com/data-api/docs/part-query-support.md) - [How to publish data to an index layer](https://docs.here.com/data-api/docs/publishing-data-index.md) - [How to update data in an index layer](https://docs.here.com/data-api/docs/updating-data-index.md) - [Layers](https://docs.here.com/data-api/docs/layers.md) - [How to configure interactive map layer settings](https://docs.here.com/data-api/docs/creating-interactive-layer.md) - [How to delete an interactive layer](https://docs.here.com/data-api/docs/delete-a-layer-interactive-map-layer.md) - [How to delete versions of data from an interactive map layer](https://docs.here.com/data-api/docs/deleting-changeset-interactive.md) - [How to delete data from an interactive map layer](https://docs.here.com/data-api/docs/deleting-data-interactive.md) - [How to get data from an interactive map layer](https://docs.here.com/data-api/docs/getting-data-interactive.md) - [How to get features by bounding box](https://docs.here.com/data-api/docs/getting-interactive-boundingbox.md) - [How to get changeset statistics](https://docs.here.com/data-api/docs/getting-interactive-changeset-statistics.md) - [How to get changesets by version](https://docs.here.com/data-api/docs/getting-interactive-changesets-by-version.md) - [How to get all changesets](https://docs.here.com/data-api/docs/getting-interactive-changesets.md) - [How to get features by id](https://docs.here.com/data-api/docs/getting-interactive-featureid.md) - [How to get features by iterating](https://docs.here.com/data-api/docs/getting-interactive-iterate.md) - [How to get features by search](https://docs.here.com/data-api/docs/getting-interactive-search.md) - [How to get features by spatial search](https://docs.here.com/data-api/docs/getting-interactive-spatial.md) - [How to get statistics](https://docs.here.com/data-api/docs/getting-interactive-statistics.md) - [How to get features by tile type and tile id](https://docs.here.com/data-api/docs/getting-interactive-tile.md) - [How to set interactive map layer-level notifications](https://docs.here.com/data-api/docs/notification-interactive-map-layer.md) - [How to publish data to an interactive map layer](https://docs.here.com/data-api/docs/publishing-data-interactive.md) - [How to update data in an interactive map layer](https://docs.here.com/data-api/docs/updating-data-interactive.md) - [How to create a layer](https://docs.here.com/data-api/docs/layer-creating.md) - [How to reconfigure a layer](https://docs.here.com/data-api/docs/layer-editing-configuration.md) - [Configure object store layer settings](https://docs.here.com/data-api/docs/creating-objectstore-layer.md) - [How to delete a layer](https://docs.here.com/data-api/docs/delete-a-layer-object-store-listing.md) - [How to delete data from an object store layer](https://docs.here.com/data-api/docs/deleting-data-objectstore.md) - [How to list object keys from the object store layer](https://docs.here.com/data-api/docs/getting-data-objectstore-listing.md) - [How to get data from an object store layer](https://docs.here.com/data-api/docs/getting-data-objectstore.md) - [How to publish data to an object store layer](https://docs.here.com/data-api/docs/publishing-data-objectstore.md) - [Archive stream data](https://docs.here.com/data-api/docs/archive-stream-data.md) - [Configure stream layer settings](https://docs.here.com/data-api/docs/creating-stream-layer.md) - [Delete a streamer layer](https://docs.here.com/data-api/docs/delete-a-layer-stream-layers.md) - [How to get data from a stream layer](https://docs.here.com/data-api/docs/getting-data-stream.md) - [Publish data to a stream layer](https://docs.here.com/data-api/docs/publishing-data-stream.md) - [How to unsubscribe from a stream layer](https://docs.here.com/data-api/docs/stream-unsubscribe.md) - [How to update layer configurations](https://docs.here.com/data-api/docs/update-layer-configurations.md) - [Manage a composite layer](https://docs.here.com/data-api/docs/composite-layer.md) - [How to configure versioned layer settings](https://docs.here.com/data-api/docs/creating-versioned-layer.md) - [How to delete a versioned layer](https://docs.here.com/data-api/docs/delete-a-layer-versioned-layers.md) - [How to get data from a versioned layer](https://docs.here.com/data-api/docs/getting-data-versioned.md) - [How to get partition metadata](https://docs.here.com/data-api/docs/getting-partition-metadata.md) - [How to set versioned layer-level notifications](https://docs.here.com/data-api/docs/notification-versioned-layer.md) - [How to create and partition GeoJSON data](https://docs.here.com/data-api/docs/partition-geojson-data.md) - [Manage catalogs with partitions](https://docs.here.com/data-api/docs/partitions.md) - [How to publish data to a versioned layer](https://docs.here.com/data-api/docs/publishing-data-versioned.md) - [Manage version dependencies](https://docs.here.com/data-api/docs/version-dependencies.md) - [Configure volatile layer settings](https://docs.here.com/data-api/docs/creating-volatile-layer.md) - [How to delete a volatile layer](https://docs.here.com/data-api/docs/delete-a-layer-volatile-layers.md) - [How to get data from a volatile layer](https://docs.here.com/data-api/docs/getting-data-volatile.md) - [How to publish data to a volatile layer](https://docs.here.com/data-api/docs/publishing-data-volatile.md) - [How to Work with GeoJSON data](https://docs.here.com/data-api/docs/working-with-geojson-data-volatile-layers.md) - [Schemas](https://docs.here.com/data-api/docs/schemas.md) - [How to browse for schemas](https://docs.here.com/data-api/docs/schemas-browsing.md) - [How to create a schema](https://docs.here.com/data-api/docs/schemas-creating.md) - [How to delete a schema](https://docs.here.com/data-api/docs/schemas-deleting.md) - [How to share a schema](https://docs.here.com/data-api/docs/schemas-sharing.md) - [How to update a schema](https://docs.here.com/data-api/docs/schemas-updating.md) ## API Reference - [Cancels a multipart upload](https://docs.here.com/data-api/reference/cancelmultipartupload.md): Cancels an entire multipart upload operation. You can only cancel a multipart upload before it has been completed. Please keep in mind that the actual URL for this operation must be obtained from the response body of start multipart operation that is 'POST /layers/{layerId}/data/{dataHandle}/multiparts' from the 'delete' element under the top level 'links' element of the response. - [Checks if a data handle exists](https://docs.here.com/data-api/reference/checkblobexists.md): Checks if a blob exists for the requested data handle. - [Completes a multipart upload](https://docs.here.com/data-api/reference/completemultipartupload.md): Call this API when all parts have been uploaded. Please keep in mind that the actual URL for this operation must be obtained from the response body of start multipart operation that is 'POST /layers/{layerId}/data/{dataHandle}/multiparts' from the 'complete' element under the top level 'links' element of the response. - [Deletes a data blob from an index layer.](https://docs.here.com/data-api/reference/deleteblob.md): Deletes a data blob from the underlying storage mechanism (volume). The DELETE method works only for index layers. DELETE requests for blobs stored for other kind of layers will be rejected. The DELETE request is successfully accepted even if the data blob does not exist. - [Gets a blob](https://docs.here.com/data-api/reference/getblob.md): Retrieves a blob from storage. - [Gets the status of a multipart upload.](https://docs.here.com/data-api/reference/getmultipartuploadstatus.md): Gets the status of a multipart upload. The status can be received only when the upload has been completed. Please keep in mind that the actual URL for this operation must be obtained from the response body of start multipart operation that is 'POST /layers/{layerId}/data/{dataHandle}/multiparts' from the 'status' element under the top level 'links' element of the response. - [Publishes a data blob](https://docs.here.com/data-api/reference/putblob.md): Persists the data blob in the underlying storage mechanism (volume). Use this upload mechanism for blobs smaller than 50 MB. The size limit for blobs uploaded this way is 5 GB but we do not recommend uploading blobs this large with this method, so use multipart upload instead. When the operation completes successfully there is no guarantee that the data blob will be immediately available although in most cases it will be. To check if the data blob is available use the HEAD method. - [Starts a multipart upload of a blob and returns URLs for the next multipart upload operations. The URLs contain the upload token.](https://docs.here.com/data-api/reference/startmultipartupload.md): Publishes large data blobs where the data payload needs to be split into multiple parts. The multipart upload start is to be followed by the individual parts upload and completed with a call to complete the upload. The limit of the blob uploaded this way is 50GB. - [Uploads a part](https://docs.here.com/data-api/reference/uploadpart.md): Upload a single part of a multipart upload for the blob. Every uploaded part except the last one must have a minimum 5 MB of data and maximum of 5 GB, but we do not recommend uploading parts this large. The maximum number of parts is 10,000. Please keep in mind that the actual URL for this operation must be obtained from the response body of start multipart operation that is 'POST /layers/{layerId}/data/{dataHandle}/multiparts' from the 'uploadPart' element under the top level 'links' element of the response. - [Cancels a multipart upload.](https://docs.here.com/data-api/reference/cancelmultipartuploadbykey.md): Cancels an entire multipart upload operation. You can only cancel a multipart upload before it has been completed. - [Completes a multipart upload.](https://docs.here.com/data-api/reference/completemultipartuploadbykey.md): Call this API when all parts have been uploaded. - [Deletes a data blob.](https://docs.here.com/data-api/reference/deleteblobbykey.md): Deletes a data blob. - [Gets a blob.](https://docs.here.com/data-api/reference/getblobbykey.md): Retrieves a blob from storage. - [Checks if a key exists and get object metadata.](https://docs.here.com/data-api/reference/getblobmetadatabykey.md): Checks if a blob exists for the requested key. You can also use it to fetch object metadata. - [Gets the status of a multipart upload.](https://docs.here.com/data-api/reference/getmultipartuploadstatusbykey.md): Gets the status of a multipart upload. The status can be received only when the upload has been completed. - [List keys.](https://docs.here.com/data-api/reference/listkeys.md): List virtual directory-like structure created from keys in the storage where '/' is used as a separator. - [Publishes a data blob or copies an existing blob.](https://docs.here.com/data-api/reference/putblobbykey.md): Persists the data blob up to 192 MB. When the operation completes successfully, there is no guarantee that the data blob will be immediately available, although in most cases, it will be. To check if the data blob is available, use the ´HEAD´ method. The maximum key length is 450 characters. - [Starts a multipart upload.](https://docs.here.com/data-api/reference/startmultipartuploadbykey.md): Publishes large data blobs where the data payload needs to be split into multiple parts. The multipart upload start is to be followed by the individual parts upload and completed with a call to complete the upload. The limit of the blob uploaded this way is 500GB. Max key length is 450 characters. - [Uploads a part or creates a new part from part of an existing blob.](https://docs.here.com/data-api/reference/uploadpartbykey.md): Upload or copy a single part of a multipart upload or multipart copy for the blob. Every part except the last one must have a minimum 5 MB of data and maximum of 96 MB. The length of every part except the last must be a multiple of 1MB (1024KB). The maximum number of parts is 10,000. - [Checks the existence of a catalog](https://docs.here.com/data-api/reference/catalogexists.md): Checks whether a catalog with the specified HRN exists. - [Mark a catalog as disabled or re-enable catalog](https://docs.here.com/data-api/reference/changecatalogstate.md): Allows to mark a catalog status as disabled or to re-enable it. - [Creates a catalog](https://docs.here.com/data-api/reference/createcatalog.md): Creates a new catalog with the specified layers. The create catalog operation runs asynchronously. Once you've submitted the catalog for creation, you'll receive a randomly generated token that you can use to monitor the status of the operation. - [Create data subsets](https://docs.here.com/data-api/reference/createdatasubsets.md): Creates one or more data subsets for the given catalog. - Maximum **1000** data subsets can be created in a single request. - This is an **asynchronous** operation: the request returns a status link which can be used to check the operation result. - [Deletes a catalog](https://docs.here.com/data-api/reference/deletecatalog.md): Deletes a catalog and any layers within that catalog. - [Delete a specific data subset](https://docs.here.com/data-api/reference/deletedatasubset.md): Deletes a specific data subset identified by `dataSubsetId`. - This is an **asynchronous** operation: the request returns a status link which can be used to check the deletion status. - [Delete a layer](https://docs.here.com/data-api/reference/deletelayer.md): Deletes a layer of the catalog. - [Disable automatic version deletion](https://docs.here.com/data-api/reference/disableautomaticversiondeletion.md): Disable automatic retired versions cleanup. - [Gets the details of a catalog](https://docs.here.com/data-api/reference/getcatalog.md): Gets the full catalog configuration for the requested catalog. The catalog configuration contains descriptive and structural information such as layer definitions and layer types. - [Gets a list of all catalogs](https://docs.here.com/data-api/reference/getcatalogs.md): Lists all catalogs that your account has access to. To get access to a catalog, your administrator must associate this catalog in your HERE platform account. By default, the list provides summary data for each catalog such as the title, the configuration URL, and the resource type. Note: If you have access to tens of thousands of catalogs or more, and it takes the server more than 50 seconds to generate the result, a partial response may be returned. Our testing indicates that a user with permission to access 50000 catalogs takes roughly 50 seconds to generate the result. - [Gets a list of catalogs in the current page](https://docs.here.com/data-api/reference/getcatalogspage.md): When the result of `Gets a list of all catalogs` i.e. `getCatalogs` operation is divided into multiple pages, you get a list of catalogs in the current page using this catalogs context route. - [Gets catalog status information](https://docs.here.com/data-api/reference/getcatalogstate.md): Query status, time of disablement or enablement by catalog and who changed the status from enabled to disabled and vice versa. - [Retrieve the details of a specific data subset.](https://docs.here.com/data-api/reference/getdatasubset.md): Retrieve the details of a specific data subset. - [Retrieves the details of all accessible data subsets.](https://docs.here.com/data-api/reference/getdatasubsets.md): Retrieves the details of all accessible data subsets which could contain the given areaId, areaIds, layerId or layerIds. - [Get Data Subsets Fingerprint](https://docs.here.com/data-api/reference/getdatasubsetsfingerprint.md): Retrieve a fingerprint that represents the accessible data subset configuration of the calling user. - [Gets the status of a create, update or delete catalog request.](https://docs.here.com/data-api/reference/getoperationstatus.md): Takes the randomly generated token that you receive when you submit a catalog for creation. You can use it to monitor the status of your request. - [Retrieve the details of a specific subset.](https://docs.here.com/data-api/reference/getsubset.md): This endpoint is deprecated. Use **/catalogs/{catalogHrn}/dataSubsets/{dataSubsetId}** instead. **BETA** Retrieve the details of a specific subset. - [Retrieves the details of all accessible subsets.](https://docs.here.com/data-api/reference/getsubsets.md): This endpoint is deprecated. Use **/catalogs/{catalogHrn}/dataSubsets** instead. **BETA** Retrieves the details of all accessible subsets which contain the given areaId or areaIds. - [Get Subsets Fingerprint](https://docs.here.com/data-api/reference/getsubsetsfingerprint.md): This endpoint is deprecated. Use **/catalogs/{catalogHrn}/dataSubsetsFingerprint** instead. **BETA** Retrieve a fingerprint that represents the accessible subset configuration of the calling user. - [Modify a catalog](https://docs.here.com/data-api/reference/patchcatalog.md): Modify some fields of the catalog. The existing HTTP PUT method only allows a complete replacement of a catalog configuration, HTTP PATCH method is used to modify some fields of existing catalog configuration. All fields are optional. Specify field value to modify it, not specified fields are ignored. To remove the field value use the null value. For more information, see RFC 7396 - JSON Merge Patch. - [Modify a catalog layer](https://docs.here.com/data-api/reference/patchlayer.md): Modify some fields of the catalog layer. HTTP PATCH method is used to modify some fields of existing layer configuration. All fields are optional. Specify field value to modify it, not specified fields are ignored. To remove the field value use the null value. For more information see RFC 7396 - JSON Merge Patch. - [Updates a catalog](https://docs.here.com/data-api/reference/updatecatalog.md): Updates any descriptive and structural information in the catalog. To update a catalog, send a new version of your catalog configuration with the updated data and any required fields. - [Creates multiple subscriptions in a single request.](https://docs.here.com/data-api/reference/batchcreatesubscriptions.md): Creates multiple subscriptions between source and target catalogs/layers in batch. - [Gets status of batch subscripton creation](https://docs.here.com/data-api/reference/batchgetsubscriptionstatus.md): Status of batch subscription creation - [Checks the existence of a subscription.](https://docs.here.com/data-api/reference/checksubscriptionexists.md): Checks whether a subscription with the specified HRN exists. - [Creates a subscription](https://docs.here.com/data-api/reference/createsubscription.md): Creates a subscription between the source catalog/layer and target catalog/layer. - [Deletes a subscription.](https://docs.here.com/data-api/reference/deletesubscription-1.md): Deletes a subscription associated with the HRN. - [Gets the configuration of the subscription](https://docs.here.com/data-api/reference/getsubscription.md): Returns the configuration of the subscription associated with the HRN. - [Gets the status of the subscription create/delete process.](https://docs.here.com/data-api/reference/getsubscriptionstatus.md): Returns the configuration of the subscription associated with the HRN. - [Gets a list of all subscriptions.](https://docs.here.com/data-api/reference/listsubscriptions.md): Lists all subscriptions that your account has access to. - [Returns the status of the delete request](https://docs.here.com/data-api/reference/getdeleterequeststatus.md): Returns the details of the specified delete request. Delete request can be in one of the following states: Scheduled, Processing, Failed, Succeeded. See Data API Developer’s Guide in the Documentation section for the delete request state diagram. - [Get partIds for parallel queries.](https://docs.here.com/data-api/reference/getparts.md): Returns a list of Part Ids which represent the layer parts that can be used to limit the scope of a query operation. This allows to run parallel queries with multiple parts. The user has to provide the desired number of parts and the service will return a list of Part Ids. Please note in some cases the requested number of parts will make them too small and in this case the service might return lesser amount of the parts than requested. - [Inserts index data to an index layer](https://docs.here.com/data-api/reference/insertindexes.md): Adds index data for a given data blob to an index layer. For more information, see [Publish to an Index Layer](https://www.here.com/docs/bundle/data-api-developer-guide/page/rest/publishing-data-index.html). - [Deletes the partitions that match the query](https://docs.here.com/data-api/reference/performdelete.md): Deletes the partitions that match the query in the index layer. Returns the delete request ID, which you can use to query the status of the delete operation. - [Gets the partitions that match the query](https://docs.here.com/data-api/reference/performquery.md): Queries the index layer for the partitions that match the query. Returns each partition that matches the query, including each partition's data handle, which you use with the `blob` API to retrieve data for each partition. - [Updates index layer partitions](https://docs.here.com/data-api/reference/performupdate.md): Modifies partitions in an index layer. - [CORS support for the endpoint for ingesting generic data](https://docs.here.com/data-api/reference/ingestdatacors.md): Enable CORS by returning correct headers - [CORS support for sending a list of partitions to a stream layer](https://docs.here.com/data-api/reference/ingestpartitionscors.md): Enable CORS by returning correct headers - [CORS support for sending a list of SDII messages to a stream layer](https://docs.here.com/data-api/reference/ingestsdiicors.md): Enable CORS by returning correct headers - [Endpoint for ingesting generic data](https://docs.here.com/data-api/reference/ingestdata.md): Sends streaming data to a specified layer in the HERE platform - [Send a list of partitions to a stream layer](https://docs.here.com/data-api/reference/ingestpartitions.md): Upload partitions to the given layer. For better performance batch your partitions (e.g. 1000 per request), rather than uploading them individually. - [Send a list of SDII messages to a stream layer](https://docs.here.com/data-api/reference/ingestsdii.md): Consumes individual SDII messages and SDII MessageLists. The endpoint automatically breaks SDII MessageLists down and stores the data as individual SDII messages. Note that this endpoint does not support compression. If you are sending data to stream layer that has compression enabled, you must use the `/layers/` endpoint and all compression and decompression must be handled by your application. - [Delete Changesets](https://docs.here.com/data-api/reference/deletechangesets.md): 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: - < - =lt= Example: To remove changesets older than version number 10, a DELETE /layers/{layerId}/changesets?version=lt=10 could be executed. The 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. - [Get Changeset](https://docs.here.com/data-api/reference/getchangeset.md): Retrieves one Changeset from the layer by version. Each successful write transaction to the layer 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, next page is written in the property 'nextPageToken', which then, can be retrieved by using the 'pageToken' parameter. - [Get Changesets](https://docs.here.com/data-api/reference/getchangesets.md): Retrieves a subset of existing Changesets from the space's history. The subset can be defined by providing a version ref that references a version range e.g., "5..6" or "0..HEAD" The version range can be specified using the `versionRef` query-parameter as follows: `..` Where `` is the start of the range (exclusive) and `` is the end of the range (inclusive). (`5..10` points to the versions in the interval `]5, 10]`) 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. - [Create a tag](https://docs.here.com/data-api/reference/createtag.md): Create a tag, which points to a version of the layer. If a version is not provided when creating the tag, then the current HEAD version will be referenced. - [Delete a tag](https://docs.here.com/data-api/reference/deletetag.md): Deletes a tag. - [Get a tag](https://docs.here.com/data-api/reference/gettag.md): Retrieves a tag. - [List tags](https://docs.here.com/data-api/reference/listtags.md): List tags available in the layer. List can include system tags when includeSystemTags parameter is set to true. - [Update a tag](https://docs.here.com/data-api/reference/updatetag.md): Update the version of a tag. - [Get a feature by ID](https://docs.here.com/data-api/reference/getfeature.md): Retrieves the feature with the provided identifier. - [Get features by ID](https://docs.here.com/data-api/reference/getfeatures.md): 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. - [Get features by bounding box](https://docs.here.com/data-api/reference/getfeaturesbybbox.md): Return the features which are inside a bounding box stipulated by bbox parameter. - [Get features with radius search](https://docs.here.com/data-api/reference/getfeaturesbyspatial.md): List the features which are inside the specified radius. The origin radius point is calculated based either on latitude & longitude or by specifying a features geometry. As third option it is possible to use a H3 index as input geometry. - [Get features which intersects the provided geometry.](https://docs.here.com/data-api/reference/getfeaturesbyspatialpost.md): List the features which are inside the specified radius. The origin point is calculated based on the geometry provided as payload. - [Get features in tile](https://docs.here.com/data-api/reference/getfeaturesbytile.md): List the features selected by tile type and tile id. - [Get statistics](https://docs.here.com/data-api/reference/getstatistics.md): Returns statistical information about this layer. - [Iterate features in the layer](https://docs.here.com/data-api/reference/iteratefeatures.md): 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. - [Search for features](https://docs.here.com/data-api/reference/searchfeatures.md): 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. - [Deletes a feature from the layer](https://docs.here.com/data-api/reference/deletefeature.md): Deletes an existing feature. - [Delete multiple features](https://docs.here.com/data-api/reference/deletefeatures.md): Delete the features with the provided ids. - [Patch a feature](https://docs.here.com/data-api/reference/patchfeature.md): Patches an existing feature. - [Modify features in the layer](https://docs.here.com/data-api/reference/postfeatures.md): Create or patch features. - [Create or replace a feature](https://docs.here.com/data-api/reference/putfeature.md): Creates or replaces a feature in the layer. - [Create or replace multiple features](https://docs.here.com/data-api/reference/putfeatures.md): Create or replace the provided features. - [Gets a list of available catalog versions that respect the given dependencies](https://docs.here.com/data-api/reference/compatibleversions.md): Given a list of HRNs and versions provided by the user, returns a list of versions of this catalog for which the listed HRN are either present in the direct or indirect dependencies with the same version, or are not present. Depending on 'strict' flag versions that don't depend on any of the provided catalog HRNs, can also be considered compatible. The compatible versions are returned in reverse order, from the newest to the oldest. When there is no compatible version the service returns an empty list. When the catalog has no version a 404 is returned. - [Gets changes for the version range.](https://docs.here.com/data-api/reference/getchanges.md): Gets the latest partition metadata in a version range for a versioned layer or a time range for a volatile layer. For versioned layers the range is expressed as a start and end version and returns only the latest changes for the partitions which were added and removed inbetween the specified start and end versions. If a partition was created and deleted between the versions specified in the `startVersion` and `endVersion` parameters, the partition is included in the response with an empty `dataHandle` value. For example, if you request versions `0` to `10`, and a partition was created in version `3` and then deleted in version `7`, it is included in the response with an empty `dataHandle` value. - [Get partIds for parallel queries of changes for the version range.](https://docs.here.com/data-api/reference/getchangesparts.md): Returns a list of Part Ids which represent the parts that can be used to limit the scope of queries of changes for the version range. This allows to run parallel queries with multiple parts. The user has to provide the desired number of parts and the service will return a list of Part Ids. Please note in some cases the requested number of parts will make them too small and in this case the service might return lesser amount of the parts than requested. - [Gets layer versions for catalog version](https://docs.here.com/data-api/reference/getlayersversion.md): Returns information about layer versions for the catalog version. It will return an error if the catalog does not have any versions or if the version passed in the query parameter does not exist. If a layer does not have any data for the requested version it is excluded from the response. - [Gets partitions](https://docs.here.com/data-api/reference/getpartitions.md): Gets the metadata for all partitions in a specific layer. - [Get partIds for parallel queries of the metadata for all partitions in a specific layer.](https://docs.here.com/data-api/reference/getpartitionsparts.md): Returns a list of Part Ids which represent the parts that can be used to limit the scope of queries of the metadata for all partitions in a specific layer. This allows to run parallel queries with multiple parts. The user has to provide the desired number of parts and the service will return a list of Part Ids. Please note in some cases the requested number of parts will make them too small and in this case the service might return lesser amount of the parts than requested. - [Gets the latest available catalog version](https://docs.here.com/data-api/reference/latestversion.md): Returns information about the latest version for the given catalog. If the catalog doesn't contain any versions a 404 will be returned. - [Gets catalog versions](https://docs.here.com/data-api/reference/listversions.md): Returns information about specific catalog version(s). If the catalog doesn't contain any versions 404 will be returned. Maximum number of versions to be returned per call is 1000 versions. If requested range is bigger than 1000 versions 400 Bad Request will be returned. Expected either pair 'startVersion' and 'endVersion', or 'version' query parameter, otherwise 400 Bad Request will be returned. - [Gets the earliest available catalog version](https://docs.here.com/data-api/reference/minimumversion.md): Returns minimum version for the given catalog. If the catalog doesn't contain any versions 404 will be returned. - [Sets the earliest available catalog version](https://docs.here.com/data-api/reference/setminimumversion.md): Sets minimum version for the given catalog. All prior versions will be deleted. If the catalog doesn't contain any versions, a 404 will be returned. - [Delete subscriptions for provided catalogHRN and stream layer ID.](https://docs.here.com/data-api/reference/deletesubscriptions.md) - [Get all subscriptions for target layer](https://docs.here.com/data-api/reference/getsubscriptions.md) - [Subscribe for Catalog change notifications](https://docs.here.com/data-api/reference/subscribe-1.md) - [Cancels a publication](https://docs.here.com/data-api/reference/cancelpublication.md): Cancels a publication if it has not yet been submitted. Will fail if attempting to cancel a submitted publication. This allows the specified publication to be abandoned. See Data API Developer’s Guide in the Documentation section for publication states diagram and all possible publication states transitions. - [Gets a publication](https://docs.here.com/data-api/reference/getpublication.md): Returns the details of the specified publication. Publication can be in one of these states: Initialized, Submitted, Cancelled, Failed, Succeeded, Expired. See Data API Developer’s Guide in the Documentation section for the publication state diagram. - [Initialize a new publication](https://docs.here.com/data-api/reference/initpublication.md): Initializes a new publication for publishing metadata. Determines the publication type based on the provided layer IDs. A publication can only consist of layer IDs that have the same layer type. For example, you can have a publication for multiple layers of type `versioned`, but you cannot have a single publication that publishes to both `versioned` and `volatile` layers. In addition, you may only have one `versioned` publication in process at a time. The body field `versionDependencies` is optional and is used for `versioned` layers to declare version dependencies. - [Submits a publication](https://docs.here.com/data-api/reference/submitpublication.md): Submits the publication and initiates post processing if necessary. Publication state becomes `Submitted` directly after submission and `Succeeded` after successful processing. See Data API Developer’s Guide in the Documentation section for complete publication states diagram. - [Upload partitions](https://docs.here.com/data-api/reference/uploadpartitions.md): Upload partitions to the given layer. Dependending on the publication type, post processing may be required before the partitions are published. For better performance batch your partitions (e.g. 10000 per request), rather than uploading them individually. - [Gets changes for the version or time range for the specific partition(s).](https://docs.here.com/data-api/reference/getchangesbyid.md): Gets the latest partition changes for a version range in a versioned layer or a time range for a volatile layer. Only the latest change for each changed partition is returned, not intermediate changes. If the response contains a partition with an empty 'dataHandle' value, the partition was deleted at the version indicated by the 'version' field of the partition object. If a partition was created and deleted between the versions specified in the `startVersion` and `endVersion` parameters, the partition is included in the response with an empty `dataHandle` value. For example, if you request versions `0` to `10`, and a partition was created in version `3` and then deleted in version `7`, it is included in the response with an empty `dataHandle` value. - [Gets metadata for the requested partitions](https://docs.here.com/data-api/reference/getpartitionsbyid.md): Gets metadata for specific partition ids. If the layer specified in the request does not exist, the request results in an error. If a partition specified in the request does not exist, the response does not include this partition. Maximum allowed number of partitions ids per call is 100. - [Gets index metadata of versioned](https://docs.here.com/data-api/reference/quadtreeindex.md): Gets metadata for the requested index. Only available for versioned layers where the partitioning scheme is `heretile`. - [Gets index metadata for volatile layers](https://docs.here.com/data-api/reference/quadtreeindexvolatile.md): Gets metadata for the requested index. Only available for volatile layers where the partitioning scheme is `heretile`. - [Commits offsets of the last message read](https://docs.here.com/data-api/reference/commitoffsets.md): After reading data, you should commit the offset of the last message read from each partition so that your application can resume reading new messages from the correct partition in the event that there is a disruption to the subscription, such as an application crash. An offset can also be useful if you delete a subscription then recreate a subscription for the same layer, because the new subscription can start reading data from the offset. To read messages already committed, use the /seek endpoint, then use /partitions. The base path to use is the value of 'nodeBaseURL' returned from /subscribe POST request. - [Consumes data from a layer](https://docs.here.com/data-api/reference/consumedata.md): Consumes data from a layer. Returns messages from a stream layer formatted similar to a [Partition object](https://heremaps.github.io/here-workspace-examples-java-scala/scala/com/here/platform/data/client/scaladsl/Partition.html). If the data size is less than 1 MB, the `data` field will be populated. If the data size is greater than 1 MB, a data handle will be returned pointing to the object stored in the Blob store. The base path to be used is the value of 'nodeBaseURL' returned from /subscribe POST request. - [Delete subscription to a layer](https://docs.here.com/data-api/reference/deletesubscription.md): Deletes a subscription to a layer (topic). This operation removes the subscription from the service. The base path to use is the value of 'nodeBaseURL' returned from /subscribe POST request. - [Expose the endpoint to consume the data of the layer directly](https://docs.here.com/data-api/reference/endpoint.md): Returns a list of Kafka Broker URL's, client ID (required to enforce quotas), and Group ID prefix. Type is set to a consumer. - [Exposes the endpoint to use to produce and consume the data of the layer directly](https://docs.here.com/data-api/reference/endpointbyconsumer.md): Exposes the endpoint to use to produce and consume the data of the layer directly, per type of user - consumer or producer. It returns a list of Kafka Broker URL's, client ID (required to enforce quotas), and Group ID prefix. - [Seek to predefined offset.](https://docs.here.com/data-api/reference/seektooffset.md): Enables you to start reading data from a specified offset. You can move the message pointer to any offset in the layer (topic). Message consumption will start from that offset. Once you seek to an offset, there is no returning to the initial offset, unless the initial offset is saved. The base path to use is the value of 'nodeBaseURL' returned from /subscribe POST request. - [Enable message consumption from a specific stream layer.](https://docs.here.com/data-api/reference/subscribe.md): Enables message consumption from a specific stream layer (topic). Use the base path returned from the API Lookup service. Note: For **mode = parallel**, one unit of parallelism currently equals 1 MBps inbound or 2 MBps outbound, whichever is greater, rounded up to the nearest integer. The number of subscriptions within the same group cannot exceed the parallelism allowed. For more details see [Get Data from a Stream Layer](https://www.here.com/docs/bundle/data-api-developer-guide/page/rest/getting-data-stream.html). - [Checks if a data handle exists](https://docs.here.com/data-api/reference/checkhandleexists.md): Checks if a volatile blob exists for the requested data handle. - [Deletes a volatile data blob](https://docs.here.com/data-api/reference/deletevolatileblob.md): Deletes a volatile data blob from the underlying storage mechanism (volume). - [Gets a volatile blob](https://docs.here.com/data-api/reference/getvolatileblob.md): Retrieves a volatile data blob from storage. - [Modifies ttl for a specific volatile data blob](https://docs.here.com/data-api/reference/patchvolatileblob.md): Modify ttl of the volatile data blob in the underlying storage mechanism (volume). - [Publishes a volatile data blob](https://docs.here.com/data-api/reference/putvolatileblob.md): Persists the volatile data blob in the underlying storage mechanism (volume). # Data SDK Documentation ## Guides - [Run the HERE Data SDK for Typescript examples](https://docs.here.com/data-sdk/docs/datasdktypescript-examples.md) - [Get started with HERE Data SDK for TypeScript](https://docs.here.com/data-sdk/docs/get-started-with-here-data-sdk-for-typescript.md) - [How to create platform client settings](https://docs.here.com/data-sdk/docs/create-platform-client-settings.md) - [HERE Data SDK for TypeScript details and prerequisites](https://docs.here.com/data-sdk/docs/here-data-sdk-for-typescript-details-and-prerequisites.md) - [How to work with a cache](https://docs.here.com/data-sdk/docs/work-with-cache.md) - [How to authenticate to the HERE platform](https://docs.here.com/data-sdk/docs/authenticate.md) - [How to get catalog metadata](https://docs.here.com/data-sdk/docs/get-catalog-metadata.md) - [How to get data from an index layer](https://docs.here.com/data-sdk/docs/get-data-index-layer.md) - [How to get data from an interactive map layer](https://docs.here.com/data-sdk/docs/get-data-interactive-map-layer.md) - [How to get data from an object store layer](https://docs.here.com/data-sdk/docs/get-data-object-store-layer.md) - [How to get data from a stream layer](https://docs.here.com/data-sdk/docs/get-data-stream-layer.md) - [How to get data from a versioned layer](https://docs.here.com/data-sdk/docs/get-data-versioned-layer.md) - [How to get data from a volatile layer](https://docs.here.com/data-sdk/docs/get-data-volatile-layer.md) - [How to get data](https://docs.here.com/data-sdk/docs/get-data.md) - [How to get partition metadata from an index layer](https://docs.here.com/data-sdk/docs/get-partition-metadata-index-layer.md) - [How to get data and partition metadata from a stream layer](https://docs.here.com/data-sdk/docs/get-partition-metadata-stream-layer.md) - [How to get partition metadata from a versioned layer](https://docs.here.com/data-sdk/docs/get-partition-metadata-versioned-layer.md) - [How to get partition metadata from a volatile layer](https://docs.here.com/data-sdk/docs/get-partition-metadata-volatile-layer.md) - [How to get partition metadata](https://docs.here.com/data-sdk/docs/get-partition-metadata.md) - [How to delete data from an interactive map layer](https://docs.here.com/data-sdk/docs/delete-data-from-interactive-map-layer.md) - [How to delete data from an object store layer](https://docs.here.com/data-sdk/docs/delete-data-from-object-store-layer.md) - [How to publish and delete data](https://docs.here.com/data-sdk/docs/how-to-publish-and-delete-data.md) - [How to update data and publish it to an interactive map layer](https://docs.here.com/data-sdk/docs/publish-data-to-interactive-map-layer.md) - [How to publish data to an object store layer](https://docs.here.com/data-sdk/docs/publish-data-to-object-store-layer.md) - [How to publish data to a versioned layer](https://docs.here.com/data-sdk/docs/publish-data-to-versioned-layer.md) - [HERE Data SDK for TypeScript use cases](https://docs.here.com/data-sdk/docs/here-data-sdk-for-typescript-use-cases.md) - [Introduction to HERE Data SDK for TypeScript](https://docs.here.com/data-sdk/docs/introduction-to-here-data-sdk-for-typescript.md) - [HERE Data SDK for Python credentials setup](https://docs.here.com/data-sdk/docs/pysdk-credentials.md) - [HERE Data SDK for Python usage guide](https://docs.here.com/data-sdk/docs/pysdk-here-sdk-concepts.md) - [How to configure HERE Data SDK for Python](https://docs.here.com/data-sdk/docs/pysdk-config.md) - [How to use HERE content bindings](https://docs.here.com/data-sdk/docs/pysdk-here-content.md) - [How to use Pandas and GeoPandas](https://docs.here.com/data-sdk/docs/pysdk-here-geopandas-adapter.md) - [How to use geotiles and partitioning](https://docs.here.com/data-sdk/docs/pysdk-here-geotiles.md) - [How to visualize data](https://docs.here.com/data-sdk/docs/pysdk-here-inspector.md) - [How to perform catalog operations](https://docs.here.com/data-sdk/docs/pysdk-here-platform-catalogs.md) - [How to perform layer operations](https://docs.here.com/data-sdk/docs/pysdk-here-platform-layers.md) - [How to perform project operations](https://docs.here.com/data-sdk/docs/pysdk-here-platform-projects.md) - [How to access location services](https://docs.here.com/data-sdk/docs/pysdk-here-platform-services.md) - [How to perform Platform operations](https://docs.here.com/data-sdk/docs/pysdk-here-platform.md) - [HERE Data SDK for Python installation](https://docs.here.com/data-sdk/docs/pysdk-install.md) - [Introduction to HERE Data SDK for Python](https://docs.here.com/data-sdk/docs/pysdk-intro.md) - [Documentation license](https://docs.here.com/data-sdk/docs/pysdk-license.md) - [HERE Data SDK for Python tutorials and examples](https://docs.here.com/data-sdk/docs/pysdk-notebooks.md) - [HERE Map Content bindings](https://docs.here.com/data-sdk/docs/pysdk-hmc.md) - [Upgrading HERE Data SDK for Python to newer versions](https://docs.here.com/data-sdk/docs/pysdk-upgrade.md) ## Changelog - [HERE SDK for Python V2](https://docs.here.com/data-sdk/changelog/olp-analytics-sdk-docs.md) # Embedded Editor Documentation ## Guides - [Embedded Editor feedback resource](https://docs.here.com/embedded-editor/docs/resources-feedback.md) - [How to automatically detect a mobile device's location](https://docs.here.com/embedded-editor/docs/example-auto-detect-location-on-mobile.md) - [How to close the iframe after submitting feedback](https://docs.here.com/embedded-editor/docs/example-close-iframe.md) - [How to filter and display feedback options for use cases](https://docs.here.com/embedded-editor/docs/example-specific-use-case.md) - [How to detect and use the user's preset language](https://docs.here.com/embedded-editor/docs/example-specify-lang.md) - [How to specify a starting location relative to the user](https://docs.here.com/embedded-editor/docs/example-specify-start-location-for-map.md) - [How to set the map zoom level](https://docs.here.com/embedded-editor/docs/example-specify-zoom.md) - [Get started with the Embedded Editor](https://docs.here.com/embedded-editor/docs/get-started.md) - [Introduction to the Embedded Editor](https://docs.here.com/embedded-editor/docs/introduction-to-the-embedded-editor.md) - [Embedded Editor concepts](https://docs.here.com/embedded-editor/docs/key-concepts.md) - [How to construct an Embedded Editor request](https://docs.here.com/embedded-editor/docs/request-constructing.md) # HERE Geocoding & Search Documentation ## Guides - [HERE Batch API v7 endpoints](https://docs.here.com/geocoding-and-search/docs/api-endpoints.md) - [HERE Batch API v7 error messages](https://docs.here.com/geocoding-and-search/docs/error-messages.md) - [HERE Batch API v7 HTTP status codes](https://docs.here.com/geocoding-and-search/docs/http-status-codes.md) - [Job status](https://docs.here.com/geocoding-and-search/docs/job-status.md) - [HERE Batch API v7 request parameters](https://docs.here.com/geocoding-and-search/docs/request-params.md) - [Get started with HERE Batch API v7](https://docs.here.com/geocoding-and-search/docs/batch-api-quick-start.md) - [Alternative Columns - Stage 1](https://docs.here.com/geocoding-and-search/docs/deprecation-alternative-column-names-stage-1.md) - [Alternative Columns - Stage 2](https://docs.here.com/geocoding-and-search/docs/deprecation-alternative-column-names-stage-2.md) - [Deprecation and Change Notice](https://docs.here.com/geocoding-and-search/docs/deprecation-and-change-notice.md) - [Feature maturity](https://docs.here.com/geocoding-and-search/docs/batch-feature-maturity.md) - [Gzip compression](https://docs.here.com/geocoding-and-search/docs/batch-gzip-compression.md) - [Construct a HERE Batch API v7 request](https://docs.here.com/geocoding-and-search/docs/construct-a-here-batch-api-v7-request.md) - [Job](https://docs.here.com/geocoding-and-search/docs/job.md) - [Job lifecycle](https://docs.here.com/geocoding-and-search/docs/job-lifecycle.md) - [Limits and performance](https://docs.here.com/geocoding-and-search/docs/limits-and-performance.md) - [Job completion notifications](https://docs.here.com/geocoding-and-search/docs/notifications.md) - [Reading job output](https://docs.here.com/geocoding-and-search/docs/reading-job-output.md) - [Output data](https://docs.here.com/geocoding-and-search/docs/output-data.md) - [Submitting a batch job](https://docs.here.com/geocoding-and-search/docs/submitting-a-batch-job.md) - [Input data](https://docs.here.com/geocoding-and-search/docs/input-data.md) - [How to cancel a job](https://docs.here.com/geocoding-and-search/docs/cancel-job.md) - [How to remove a job](https://docs.here.com/geocoding-and-search/docs/delete-job.md) - [How to run a full batch job](https://docs.here.com/geocoding-and-search/docs/full-scenario.md) - [Use geocoding with HERE Batch API v7](https://docs.here.com/geocoding-and-search/docs/geocoding.md) - [Get job results](https://docs.here.com/geocoding-and-search/docs/get-job-results.md) - [Get job status](https://docs.here.com/geocoding-and-search/docs/get-job-status.md) - [Use lookup with HERE Batch API v7](https://docs.here.com/geocoding-and-search/docs/lookup.md) - [Configure result limits per record](https://docs.here.com/geocoding-and-search/docs/multiple-results.md) - [Use reverse geocoding with HERE Batch API v7](https://docs.here.com/geocoding-and-search/docs/reverse-geocoding.md) - [Introduction to HERE Batch API v7](https://docs.here.com/geocoding-and-search/docs/readme.md) - [EV Charge Points](https://docs.here.com/geocoding-and-search/docs/ev-attributes.md) - [Configure request parameters](https://docs.here.com/geocoding-and-search/docs/configure-request-parameters.md) - [Handling political views in HERE Geocoding and Search API v7](https://docs.here.com/geocoding-and-search/docs/political-views.md) - [Provide city and district information for postal codes](https://docs.here.com/geocoding-and-search/docs/postal-code-mode.md) - [Response enrichment](https://docs.here.com/geocoding-and-search/docs/response-enrichment.md) - [Response enrichment with map references](https://docs.here.com/geocoding-and-search/docs/response-items-enrichment-mapref.md) - [Response enrichment with navigation attributes](https://docs.here.com/geocoding-and-search/docs/response-items-enrichment-nav.md) - [Response enrichment with related items](https://docs.here.com/geocoding-and-search/docs/response-items-enrichment-related.md) - [Response language](https://docs.here.com/geocoding-and-search/docs/response-language.md) - [Filter by result type](https://docs.here.com/geocoding-and-search/docs/result-types-filter.md) - [Use address lookup by postal code (SGP, IRL)](https://docs.here.com/geocoding-and-search/docs/code-geocode-address-bundle.md) - [Search for an address by postal code and house number](https://docs.here.com/geocoding-and-search/docs/code-geocode-hpc-hsn.md) - [Japan address system in HERE Geocoding and Search API v7](https://docs.here.com/geocoding-and-search/docs/japan.md) - [Geocode local coverage](https://docs.here.com/geocoding-and-search/docs/geocode-local-coverage.md) - [Supported political views](https://docs.here.com/geocoding-and-search/docs/political-views-coverage.md) - [Search local coverage](https://docs.here.com/geocoding-and-search/docs/search-local-coverage.md) - [Feature maturity](https://docs.here.com/geocoding-and-search/docs/feature-maturity.md) - [Get credentials](https://docs.here.com/geocoding-and-search/docs/get-credentials-ols.md) - [Client activity tracking](https://docs.here.com/geocoding-and-search/docs/client-activity-tracking.md) - [Gzip compression](https://docs.here.com/geocoding-and-search/docs/gzip-compression.md) - [HERE Geocoding and Search API v7 implementation tips](https://docs.here.com/geocoding-and-search/docs/here-geocoding-and-search-api-v7-implementation-tips.md) - [Prepare for extensibility](https://docs.here.com/geocoding-and-search/docs/prepare-for-extensibility.md) - [Get started with HERE Geocoding and Search API v7](https://docs.here.com/geocoding-and-search/docs/get-started-with-here-geocoding-and-search-api-v7.md) - [Construct a request to HERE Geocoding & Search API v7](https://docs.here.com/geocoding-and-search/docs/request-constructing.md) - [Test your application](https://docs.here.com/geocoding-and-search/docs/testing-an-app.md) - [Limit results to one or several countries](https://docs.here.com/geocoding-and-search/docs/code-autocomplete-country-filter.md) - [Choose a language render a result](https://docs.here.com/geocoding-and-search/docs/code-autocomplete-language.md) - [Handle secondary unit information](https://docs.here.com/geocoding-and-search/docs/code-autocomplete-mpa.md) - [Limit results to specific types](https://docs.here.com/geocoding-and-search/docs/code-autocomplete-result-type-filter.md) - [Limit results using a spatial reference](https://docs.here.com/geocoding-and-search/docs/code-autocomplete-spatial-reference.md) - [Render results and use highlighting](https://docs.here.com/geocoding-and-search/docs/code-autocomplete-title.md) - [Autocomplete](https://docs.here.com/geocoding-and-search/docs/autocomplete.md) - [Get suggestions for a place using an incomplete category query](https://docs.here.com/geocoding-and-search/docs/code-autosuggest-incomplete-category-query.md) - [Get suggestions for a place using an incomplete location query](https://docs.here.com/geocoding-and-search/docs/code-autosuggest-incomplete-location-query.md) - [Correct query spelling mistakes](https://docs.here.com/geocoding-and-search/docs/code-autosuggest-misspelled-location-query.md) - [Get term suggestions for the last term in the query](https://docs.here.com/geocoding-and-search/docs/code-autosuggest-query-term-completion.md) - [Autosuggest](https://docs.here.com/geocoding-and-search/docs/autosuggest.md) - [Search for an address using a location](https://docs.here.com/geocoding-and-search/docs/code-discover-address.md) - [Search for a place using a category](https://docs.here.com/geocoding-and-search/docs/code-discover-category.md) - [Search for a place using a chain](https://docs.here.com/geocoding-and-search/docs/code-discover-chain.md) - [Search for places by category near a location](https://docs.here.com/geocoding-and-search/docs/code-discover-ontology-location.md) - [Search for a place using a phone number](https://docs.here.com/geocoding-and-search/docs/code-discover-phone.md) - [Search places near other places](https://docs.here.com/geocoding-and-search/docs/code-discover-place-near-place.md) - [Search for a place using a name](https://docs.here.com/geocoding-and-search/docs/code-discover-place.md) - [Search for an address near a geo-position](https://docs.here.com/geocoding-and-search/docs/code-discover-position.md) - [Search for places by category within a corridor](https://docs.here.com/geocoding-and-search/docs/code-discover-route.md) - [Discover](https://docs.here.com/geocoding-and-search/docs/discover.md) - [Browse](https://docs.here.com/geocoding-and-search/docs/endpoint-browse-brief.md) - [Lookup](https://docs.here.com/geocoding-and-search/docs/endpoint-lookup-brief.md) - [Multi-Reverse geocode](https://docs.here.com/geocoding-and-search/docs/endpoint-multi-reverse-geocode-brief.md) - [Signals](https://docs.here.com/geocoding-and-search/docs/endpoint-signals-brief.md) - [Geocode an address](https://docs.here.com/geocoding-and-search/docs/code-geocode-address.md) - [Geocode an area](https://docs.here.com/geocoding-and-search/docs/code-geocode-area.md) - [Limit results to one or several countries](https://docs.here.com/geocoding-and-search/docs/code-geocode-country-filter.md) - [Use house number fallback](https://docs.here.com/geocoding-and-search/docs/code-geocode-hsn-fallback.md) - [Formulate a hybrid query](https://docs.here.com/geocoding-and-search/docs/code-geocode-hybrid.md) - [Geocode an address with secondary unit](https://docs.here.com/geocoding-and-search/docs/code-geocode-mpa.md) - [Request and use parsing information](https://docs.here.com/geocoding-and-search/docs/code-geocode-parsing.md) - [Geocode a place](https://docs.here.com/geocoding-and-search/docs/code-geocode-place.md) - [Formulate a qualified query](https://docs.here.com/geocoding-and-search/docs/code-geocode-qualified.md) - [Exclude place results](https://docs.here.com/geocoding-and-search/docs/code-geocode-result-types-filter.md) - [Use result scoring](https://docs.here.com/geocoding-and-search/docs/code-geocode-scoring.md) - [Use spatial references](https://docs.here.com/geocoding-and-search/docs/code-geocode-spatial-reference.md) - [Geocode](https://docs.here.com/geocoding-and-search/docs/geocode.md) - [HERE Geocoding and Search API v7 endpoints](https://docs.here.com/geocoding-and-search/docs/here-geocoding-and-search-api-v7-endpoints.md) - [Find nearby addresses limited by a spatial filter](https://docs.here.com/geocoding-and-search/docs/code-revgeocode-circle.md) - [Improve Reverse Geocoding accuracy by snapping to Micro Point address](https://docs.here.com/geocoding-and-search/docs/code-revgeocode-mpa.md) - [Find multiple nearby addresses using geocoordinates](https://docs.here.com/geocoding-and-search/docs/code-revgeocode-multiple.md) - [Limit results to specific types](https://docs.here.com/geocoding-and-search/docs/code-revgeocode-result-type-filter.md) - [Improve street match by considering drive direction](https://docs.here.com/geocoding-and-search/docs/code-revgeocode-track-position.md) - [Reverse geocode](https://docs.here.com/geocoding-and-search/docs/reverse-geocode.md) - [Reverse geocoding using Postman](https://docs.here.com/geocoding-and-search/docs/reverse-geocode-tutorial.md) - [Introduction to HERE Geocoding & Search API v7](https://docs.here.com/geocoding-and-search/docs/introduction-to-here-geocoding-search-api-v7.md) - [Result types](https://docs.here.com/geocoding-and-search/docs/result-types.md) - [Places cuisine system](https://docs.here.com/geocoding-and-search/docs/food-types-category-system-full.md) - [Places categories and cuisines](https://docs.here.com/geocoding-and-search/docs/places-categories-and-cuisines.md) - [Places category system](https://docs.here.com/geocoding-and-search/docs/places-category-system-full.md) - [Places chain system A-M](https://docs.here.com/geocoding-and-search/docs/places-chain-system-a-m.md) - [Places chain system N-Z](https://docs.here.com/geocoding-and-search/docs/places-chain-system-n-z.md) - [Address results](https://docs.here.com/geocoding-and-search/docs/result-types-address.md) - [Place results](https://docs.here.com/geocoding-and-search/docs/result-types-place.md) - [Follow-up queries](https://docs.here.com/geocoding-and-search/docs/result-types-query.md) - [How to find geo-coordinates using Autosuggest](https://docs.here.com/geocoding-and-search/docs/geo-coordinates-tutorial.md) - [How to implement search along the route](https://docs.here.com/geocoding-and-search/docs/implementing-route.md) - [Action on Autosuggest response](https://docs.here.com/geocoding-and-search/docs/code-signals-autosuggest.md) - [Action on Browse response](https://docs.here.com/geocoding-and-search/docs/code-signals-browse.md) - [Action on Lookup response](https://docs.here.com/geocoding-and-search/docs/code-signals-lookup.md) - [Send user actions](https://docs.here.com/geocoding-and-search/docs/send-user-actions.md) - [API Changes](https://docs.here.com/geocoding-and-search/docs/api-changes.md) - [Functional and Behavioral Changes](https://docs.here.com/geocoding-and-search/docs/functional-behavioral-changes.md) - [Changes](https://docs.here.com/geocoding-and-search/docs/changes.md) - [Known Issues](https://docs.here.com/geocoding-and-search/docs/known-issues.md) - [Limitations and Workarounds](https://docs.here.com/geocoding-and-search/docs/limitations-workarounds.md) - [New Features](https://docs.here.com/geocoding-and-search/docs/new-features.md) - [Resolved Issues](https://docs.here.com/geocoding-and-search/docs/resolved-issues.md) - [Highlights](https://docs.here.com/geocoding-and-search/docs/highlights.md) - [Overview](https://docs.here.com/geocoding-and-search/docs/overview.md) ## API Reference - [Autocomplete](https://docs.here.com/geocoding-and-search/reference/get_autocomplete.md): This endpoint completes entered keystrokes to a valid street address or administrative area to speed-up entering address queries. - [Autosuggest](https://docs.here.com/geocoding-and-search/reference/get_autosuggest.md): This endpoint suggests address or place candidates based on an incomplete or misspelled query, from which the user selects the best query to submit. _NOTE: The response may contain **experimental** elements not documented here. Any undocumented element is **subject to removal** at any time._ - [Autosuggest](https://docs.here.com/geocoding-and-search/reference/post_autosuggest.md): **BETA, RESTRICTED** This endpoint suggests address or place candidates based on an incomplete or misspelled query, from which the user selects the best query to submit. _NOTE: The response may contain **experimental** elements not documented here. Any undocumented element is **subject to removal** at any time._ - [Browse](https://docs.here.com/geocoding-and-search/reference/get_browse.md): This endpoint provides search results for places based on different filters, such as categories or name, ranked by distance from a given search center. The only mandatory elements exposed in the response are ID and position. The other elements shown in the response samples section are only dataset attributes suggestions. - [Browse](https://docs.here.com/geocoding-and-search/reference/post_browse.md): **BETA, RESTRICTED** This endpoint provides search results for places based on different filters, such as categories or name, ranked by distance from a given search center. The only mandatory elements exposed in the response are ID and position. The other elements shown in the response samples section are only dataset attributes suggestions. - [Discover](https://docs.here.com/geocoding-and-search/reference/get_discover.md): This endpoint processes a free-form text query for an address or place, and returns results in order of relevance. - [Discover](https://docs.here.com/geocoding-and-search/reference/post_discover.md): **BETA, RESTRICTED** This endpoint processes a free-form text query for an address or place, and returns results in order of relevance. - [Geocode](https://docs.here.com/geocoding-and-search/reference/get_geocode.md): This endpoint allows you to find the geo-coordinates of a known address, place, locality or administrative area, even if the query is incomplete or partly incorrect. It also returns a complete postal address string and address details. It supports structured, unstructured and hybrid queries - combinations of structured and unstructured query elements. - [Lookup By ID](https://docs.here.com/geocoding-and-search/reference/get_lookup.md): This endpoint looks up a known place using the HERE ID included in the request. - [Multi-Reverse Geocode](https://docs.here.com/geocoding-and-search/reference/post_multi-revgeocode.md): This endpoint returns addresses/places for a list of geo-coordinates specified in the request. - [Reverse Geocode](https://docs.here.com/geocoding-and-search/reference/get_revgeocode.md): This endpoint returns the nearest address to geo coordinates specified in the request. - [Signals](https://docs.here.com/geocoding-and-search/reference/post_signals.md): **RESTRICTED** This endpoint receives user interaction data from previous search results to improve future result quality. - [Tests the basic health of the service.](https://docs.here.com/geocoding-and-search/reference/gethealth-1.md) - [Tests the basic health of the service.](https://docs.here.com/geocoding-and-search/reference/gethealth.md) - [Retrieves the OpenAPI v3 specification.](https://docs.here.com/geocoding-and-search/reference/getopenapi-1.md): Retrieves the OpenAPI v3 specification for this service in YAML or JSON format based on the Accept header. Use Accept: text/yaml, application/vnd.oai.openapi, or application/openapi+yaml for YAML format. Use Accept: application/json or application/openapi+json for JSON format. - [Retrieves the OpenAPI v3 specification.](https://docs.here.com/geocoding-and-search/reference/getopenapi.md): Retrieves the OpenAPI v3 specification for this service in YAML or JSON format based on the Accept header. Use Accept: text/yaml, application/vnd.oai.openapi, or application/openapi+yaml for YAML format. Use Accept: application/json or application/openapi+json for JSON format. - [Retrieves API version information.](https://docs.here.com/geocoding-and-search/reference/getversion-1.md) - [Retrieves API version information.](https://docs.here.com/geocoding-and-search/reference/getversion.md) - [Deletes a job](https://docs.here.com/geocoding-and-search/reference/deletejob-1.md): Deletes a job. - [Deletes a job](https://docs.here.com/geocoding-and-search/reference/deletejob.md): Deletes a job. - [Deletes multiple jobs](https://docs.here.com/geocoding-and-search/reference/deletejobs-1.md): Deletes all jobs the user is authorized to access, filtered on criteria provided in the query. If **none** of the jobs matches the criteria, a `200 - OK` response is returned with an empty list of job IDs. - [Deletes multiple jobs](https://docs.here.com/geocoding-and-search/reference/deletejobs.md): Deletes all jobs the user is authorized to access, filtered on criteria provided in the query. If **none** of the jobs matches the criteria, a `200 - OK` response is returned with an empty list of job IDs. - [Returns the details of a job](https://docs.here.com/geocoding-and-search/reference/getjob-1.md): Fetches the details of the job with the specified ID. - [Returns the details of a job](https://docs.here.com/geocoding-and-search/reference/getjob.md): Fetches the details of the job with the specified ID. - [Returns the errors of a job](https://docs.here.com/geocoding-and-search/reference/getjoberrors-1.md): Fetches the errors of the job with the specified ID, given that it has completed with errors, as a downloadable stream of data. If the job does not yet have any errors available, this operation responds with a `404 - NOT FOUND` response. If the job did not produce any errors, the operation responds with a `204 - NO CONTENT` response - [Returns the errors of a job](https://docs.here.com/geocoding-and-search/reference/getjoberrors.md): Fetches the errors of the job with the specified ID, given that it has completed with errors, as a downloadable stream of data. If the job does not yet have any errors available, this operation responds with a `404 - NOT FOUND` response. If the job did not produce any errors, the operation responds with a `204 - NO CONTENT` response - [Returns the results of a job](https://docs.here.com/geocoding-and-search/reference/getjobresults-1.md): Fetches the results of the job with the specified ID, given that it has completed successfully, as a downloadable stream of data. If the job does not (yet) have any results available, this operation responds with a `404 - NOT FOUND` response. - [Returns the results of a job](https://docs.here.com/geocoding-and-search/reference/getjobresults.md): Fetches the results of the job with the specified ID, given that it has completed successfully, as a downloadable stream of data. If the job does not (yet) have any results available, this operation responds with a `404 - NOT FOUND` response. - [Returns the details of multiple jobs](https://docs.here.com/geocoding-and-search/reference/getjobs-1.md): Fetches the details of all jobs the user is authorized to access - filtered on criteria provided in the query. If **none** of the jobs matches criteria, an empty array is returned in the `200 - OK` response. - [Returns the details of multiple jobs](https://docs.here.com/geocoding-and-search/reference/getjobs.md): Fetches the details of all jobs the user is authorized to access - filtered on criteria provided in the query. If **none** of the jobs matches criteria, an empty array is returned in the `200 - OK` response. - [Creates a new job](https://docs.here.com/geocoding-and-search/reference/postjob-1.md): Creates a new job from the supplied input and query parameters. A `201 - CREATED` response returns the job's unique ID, which should be used in future operations on the job. - [Creates a new job](https://docs.here.com/geocoding-and-search/reference/postjob.md): Creates a new job from the supplied input and query parameters. A `201 - CREATED` response returns the job's unique ID, which should be used in future operations on the job. - [Starts a job](https://docs.here.com/geocoding-and-search/reference/startjob-1.md): Schedules a job for immediate execution and responds with a `200 - OK` if successful. If the job is already running this operation does nothing and will respond with the same `200 - OK` response. If the job was previously halted, this operation will continue execution from the point where it was stopped. If you wish to restart a job from its beginning, you should create a new job and delete the existing one. Take note, this operation will return a `429 - TOO MANY REQUESTS` if the allowed number of concurrently running jobs is exceeded. - [Starts a job](https://docs.here.com/geocoding-and-search/reference/startjob.md): Schedules a job for immediate execution and responds with a `200 - OK` if successful. If the job is already running this operation does nothing and will respond with the same `200 - OK` response. If the job was previously halted, this operation will continue execution from the point where it was stopped. If you wish to restart a job from its beginning, you should create a new job and delete the existing one. Take note, this operation will return a `429 - TOO MANY REQUESTS` if the allowed number of concurrently running jobs is exceeded. - [Stops a job](https://docs.here.com/geocoding-and-search/reference/stopjob-1.md): This operation will schedule a job to be halted and responds with a `200 - OK` if successful. If the job is **not** currently running, then this operation does nothing but will still return a `200 - OK` response. Once the job has been stopped, you can continue from where the job halted by starting it again. - [Stops a job](https://docs.here.com/geocoding-and-search/reference/stopjob.md): This operation will schedule a job to be halted and responds with a `200 - OK` if successful. If the job is **not** currently running, then this operation does nothing but will still return a `200 - OK` response. Once the job has been stopped, you can continue from where the job halted by starting it again. - [(BETA) Delete a notification](https://docs.here.com/geocoding-and-search/reference/deletenotification-1.md): (BETA) Delete a notification by its id. - [(BETA) Delete a notification](https://docs.here.com/geocoding-and-search/reference/deletenotification.md): (BETA) Delete a notification by its id. - [(BETA) Get a notification](https://docs.here.com/geocoding-and-search/reference/getnotification-1.md): (BETA) Get a notification by id. - [(BETA) Get a notification](https://docs.here.com/geocoding-and-search/reference/getnotification.md): (BETA) Get a notification by id. - [(BETA) Get all notifications](https://docs.here.com/geocoding-and-search/reference/getnotifications-1.md): (BETA) Get all notifications that the current client has access to. - [(BETA) Get all notifications](https://docs.here.com/geocoding-and-search/reference/getnotifications.md): (BETA) Get all notifications that the current client has access to. - [(BETA) Create a new notification](https://docs.here.com/geocoding-and-search/reference/postnotification-1.md): (BETA) Create a new notification. To configure a notification, the **type** as well as the the **config** property needs to be defined. Each type requires individual properties as listed below. ### `webHook` For the notification of the type `webHook` only a **url** parameter is required. This URL is called via a GET request, after the job is completed. To individualize the request, property placeholders in the URL are substituted if surrounded by '${' and '}' These placeholders can be in the path or a query parameter. Available properties are: - JOB_ID - JOB_NAME - JOB_STATUS - JOB_OUTPUT_TYPE - JOB_RECORDS_SUCCEEDED - JOB_RECORDS_FAILED - JOB_RECORDS_TOTAL - JOB_RECORDS_VALID - JOB_RECORDS_INVALID An example for the url property would be: 'https://myPublicDomain.de?jobId=${JOB_ID}&status=${JOB_STATUS}' - [(BETA) Create a new notification](https://docs.here.com/geocoding-and-search/reference/postnotification.md): (BETA) Create a new notification. To configure a notification, the **type** as well as the the **config** property needs to be defined. Each type requires individual properties as listed below. ### `webHook` For the notification of the type `webHook` only a **url** parameter is required. This URL is called via a GET request, after the job is completed. To individualize the request, property placeholders in the URL are substituted if surrounded by '${' and '}' These placeholders can be in the path or a query parameter. Available properties are: - JOB_ID - JOB_NAME - JOB_STATUS - JOB_OUTPUT_TYPE - JOB_RECORDS_SUCCEEDED - JOB_RECORDS_FAILED - JOB_RECORDS_TOTAL - JOB_RECORDS_VALID - JOB_RECORDS_INVALID An example for the url property would be: 'https://myPublicDomain.de?jobId=${JOB_ID}&status=${JOB_STATUS}' - [(BETA) Replace a notification](https://docs.here.com/geocoding-and-search/reference/putnotification-1.md): (BETA) Replace a notification. To configure a notification, the **type** as well as the the **config** property needs to be defined. Each type requires individual properties as listed below. ### `webHook` For the notification of the type `webHook` only a **url** parameter is required. This URL is called via a GET request, after the job is completed. To individualize the request, property placeholders in the URL are substituted if surrounded by '${' and '}' These placeholders can be in the path or a query parameter. Available properties are: - JOB_ID - JOB_NAME - JOB_STATUS - JOB_OUTPUT_TYPE - JOB_RECORDS_SUCCEEDED - JOB_RECORDS_FAILED - JOB_RECORDS_TOTAL - JOB_RECORDS_VALID - JOB_RECORDS_INVALID An example for the url property would be: 'https://myPublicDomain.de?jobId=${JOB_ID}&status=${JOB_STATUS}' - [(BETA) Replace a notification](https://docs.here.com/geocoding-and-search/reference/putnotification.md): (BETA) Replace a notification. To configure a notification, the **type** as well as the the **config** property needs to be defined. Each type requires individual properties as listed below. ### `webHook` For the notification of the type `webHook` only a **url** parameter is required. This URL is called via a GET request, after the job is completed. To individualize the request, property placeholders in the URL are substituted if surrounded by '${' and '}' These placeholders can be in the path or a query parameter. Available properties are: - JOB_ID - JOB_NAME - JOB_STATUS - JOB_OUTPUT_TYPE - JOB_RECORDS_SUCCEEDED - JOB_RECORDS_FAILED - JOB_RECORDS_TOTAL - JOB_RECORDS_VALID - JOB_RECORDS_INVALID An example for the url property would be: 'https://myPublicDomain.de?jobId=${JOB_ID}&status=${JOB_STATUS}' - [(BETA) Test a notification](https://docs.here.com/geocoding-and-search/reference/testnotification-1.md): (BETA) Test a notification with dummy parameters. This allows, to test the endpoint without letting a job run. - [(BETA) Test a notification](https://docs.here.com/geocoding-and-search/reference/testnotification.md): (BETA) Test a notification with dummy parameters. This allows, to test the endpoint without letting a job run. ## Changelog - [HERE Batch API v7](https://docs.here.com/geocoding-and-search/changelog/ols-batch-service.md) # GIS Data Suite Documentation ## Guides - [Address locator](https://docs.here.com/gis-data-suite/docs/address-locator.md) - [Quality level attribute (quality_level)](https://docs.here.com/gis-data-suite/docs/quality-level-attribute-quality_level.md) - [Places aliases table (Places_Aliases)](https://docs.here.com/gis-data-suite/docs/places-aliases-table-places_aliases.md) - [Places table (Places)](https://docs.here.com/gis-data-suite/docs/places-table-places.md) - [Point/micropoint address display info (AddressPts_Display)](https://docs.here.com/gis-data-suite/docs/pointmicropoint-address-display-info-addresspts_display.md) - [Point/micropoint address route info (AddressPts_Route)](https://docs.here.com/gis-data-suite/docs/pointmicropoint-address-route-info-addresspts_route.md): Reference for the AddressPts_Route feature class fields used for cartographic route information. - [Esri® system fields](https://docs.here.com/gis-data-suite/docs/esri-system-fields.md): Reference table of Esri system fields commonly included in HERE GIS Data Suite feature classes and tables. - [Alternative place names](https://docs.here.com/gis-data-suite/docs/alternative-place-names.md) - [Autocompletion in locators](https://docs.here.com/gis-data-suite/docs/autocompletion-in-locators.md) - [How to use category names](https://docs.here.com/gis-data-suite/docs/how-to-use-category-names.md) - [Places locator](https://docs.here.com/gis-data-suite/docs/places-locator.md) - [Introduction to HERE GIS Data Suite Addresses and Places](https://docs.here.com/gis-data-suite/docs/readme.md) - [Carrier segment feature class (Carrier_Segment)](https://docs.here.com/gis-data-suite/docs/carrier-segment-feature-class-carrier_segment.md) - [Category segment feature class (Category_Segment)](https://docs.here.com/gis-data-suite/docs/category-segment-feature-class-category_segment.md) - [Mobile area neighbours table (Mobile_Area_Neighbours)](https://docs.here.com/gis-data-suite/docs/mobile-area-neighbours-table-mobile_area_neighbours.md) - [Mobile areas feature class (Mobile_Areas)](https://docs.here.com/gis-data-suite/docs/mobile-areas-feature-class-mobile_areas.md) - [Esri® system fields](https://docs.here.com/gis-data-suite/docs/esri-system-fields-1.md) - [Introduction to HERE GIS Data Suite Cellular Signals](https://docs.here.com/gis-data-suite/docs/introduction-to-here-gis-data-suite-cellular-signals.md) - [Terminology - HERE GIS Data Suite Cellular Signals](https://docs.here.com/gis-data-suite/docs/terminology-here-gis-data-suite-cellular-signals.md) - [Traffic sign types](https://docs.here.com/gis-data-suite/docs/traffic-sign-types.md) - [Streets feature class (Streets)](https://docs.here.com/gis-data-suite/docs/streets-feature-class-streets.md) - [Z-level crossings table (Z_Level_Crossings)](https://docs.here.com/gis-data-suite/docs/z-level-crossings-table-z_level_crossings.md) - [Esri® system fields](https://docs.here.com/gis-data-suite/docs/esri-system-fields-3.md) - [HOV lanes feature class (HOV_Lanes)](https://docs.here.com/gis-data-suite/docs/hov-lanes-feature-class-hov_lanes.md) - [Network dataset junctions feature class (NETWORK_ND_Junctions)](https://docs.here.com/gis-data-suite/docs/network-dataset-junctions-feature-class-network_nd_junctions.md) - [Network dataset turns feature class (NETWORK_TURNS)](https://docs.here.com/gis-data-suite/docs/network-dataset-turns-feature-class-network_turns.md) - [Network ND dataset component (NETWORK_ND)](https://docs.here.com/gis-data-suite/docs/network-nd-dataset-component-network_nd.md) - [Routing streets feature class (routing_streets)](https://docs.here.com/gis-data-suite/docs/routing-streets-feature-class-routing_streets.md) - [Routing streets override feature class (routing_streets_Override)](https://docs.here.com/gis-data-suite/docs/routing-streets-override-feature-class-routing_streets_override.md) - [Signposts streets feature class (Signpost_Streets)](https://docs.here.com/gis-data-suite/docs/signposts-streets-feature-class-signpost_streets.md) - [Signposts table (Signposts)](https://docs.here.com/gis-data-suite/docs/signposts-table-signposts.md) - [Black spot roads feature class (BlackSpot_Roads)](https://docs.here.com/gis-data-suite/docs/black-spot-roads-feature-class-blackspot_roads.md) - [Daily profiles table (DailyProfiles)](https://docs.here.com/gis-data-suite/docs/daily-profiles-table-dailyprofiles.md) - [Distance markers feature class (Distance_Markers)](https://docs.here.com/gis-data-suite/docs/distance-markers-feature-class-distance_markers.md) - [Driver alert signs/warnings (DriverAlert_Signs_and_Warnings)](https://docs.here.com/gis-data-suite/docs/driver-alert-signswarnings-driveralert_signs_and_warnings.md) - [Exits feature class (Exits)](https://docs.here.com/gis-data-suite/docs/exits-feature-class-exits.md) - [Overtaking zones feature class (Overtaking_Zones)](https://docs.here.com/gis-data-suite/docs/overtaking-zones-feature-class-overtaking_zones.md) - [Preferred truck routes feature class (Preferred_Truck_Routes)](https://docs.here.com/gis-data-suite/docs/preferred-truck-routes-feature-class-preferred_truck_routes.md) - [Railway crossings feature class (Railway_Crossings)](https://docs.here.com/gis-data-suite/docs/railway-crossings-feature-class-railway_crossings.md) - [Safety cameras feature class (Safety_Cameras)](https://docs.here.com/gis-data-suite/docs/safety-cameras-feature-class-safety_cameras.md): This `Safety_Cameras` feature class indicates the presence of a safety camera including red light and/or speed cameras and cameras monitoring bus only lanes. - [School speed zones feature class (School_Speed_Zones)](https://docs.here.com/gis-data-suite/docs/school-speed-zones-feature-class-school_speed_zones.md) - [Black spots feature class (BlackSpots)](https://docs.here.com/gis-data-suite/docs/signs-signals-and-warnings.md) - [Special speed limits feature class (Special_Speed_Limits)](https://docs.here.com/gis-data-suite/docs/special-speed-limits-feature-class-special_speed_limits.md) - [Streets daily profiles table (Streets_DailyProfiles)](https://docs.here.com/gis-data-suite/docs/streets-daily-profiles-table-streets_dailyprofiles.md) - [Streets TMC table (Streets_TMC)](https://docs.here.com/gis-data-suite/docs/streets-tmc-table-streets_tmc.md) - [Time zones table (TimeZones)](https://docs.here.com/gis-data-suite/docs/time-zones-table-timezones.md) - [Traffic lights feature class (Traffic_Lights)](https://docs.here.com/gis-data-suite/docs/traffic-lights-feature-class-traffic_lights.md) - [Truck restrictions feature class (Truck_Restrictions)](https://docs.here.com/gis-data-suite/docs/truck-restrictions-feature-class-truck_restrictions.md) - [Details of road infrastructure data](https://docs.here.com/gis-data-suite/docs/details-of-road-infrastructure-data.md) - [Historic traffic patterns](https://docs.here.com/gis-data-suite/docs/historic-traffic-patterns.md) - [Key features](https://docs.here.com/gis-data-suite/docs/key-features-of-here-gis-data-suite-road-infrastructure-rules-regulations-and-traffic.md) - [Specialized transportation data](https://docs.here.com/gis-data-suite/docs/specialized-transportation-data.md) - [Network dataset](https://docs.here.com/gis-data-suite/docs/network-dataset.md) - [Network dataset attributes table](https://docs.here.com/gis-data-suite/docs/network-dataset-attributes-table.md) - [Travel modes table](https://docs.here.com/gis-data-suite/docs/travel-modes-table.md) - [Introduction](https://docs.here.com/gis-data-suite/docs/rirrt-readme.md) - [HERE GIS Data Suite coverage](https://docs.here.com/gis-data-suite/docs/here-gis-data-suite-coverage.md) - [Historic traffic data](https://docs.here.com/gis-data-suite/docs/historic-traffic-data.md) - [Traffic, lights, signs, and warnings](https://docs.here.com/gis-data-suite/docs/traffic-lights-signs-and-warnings.md) - [Basic foundational dataset](https://docs.here.com/gis-data-suite/docs/basic-foundational-dataset.md) - [Admin area level 1 feature class (Admin_Area_Level1)](https://docs.here.com/gis-data-suite/docs/admin-area-level-1-feature-class-admin_area_level1.md) - [Admin area level 2 feature class (Admin_Area_Level2)](https://docs.here.com/gis-data-suite/docs/admin-area-level-2-feature-class-admin_area_level2.md) - [Admin area level 8 feature class (Admin_Area_Level8)](https://docs.here.com/gis-data-suite/docs/admin-area-level-8-feature-class-admin_area_level8.md) - [Admin cities feature class (Admin_Cities)](https://docs.here.com/gis-data-suite/docs/admin-cities-feature-class-admin_cities.md) - [Admin lines feature class (Admin_Lines)](https://docs.here.com/gis-data-suite/docs/admin-lines-feature-class-admin_lines.md) - [Admin table (Admin)](https://docs.here.com/gis-data-suite/docs/admin-table-admin.md) - [Country feature class (Country)](https://docs.here.com/gis-data-suite/docs/country-feature-class-country.md) - [World countries feature class (World_Countries)](https://docs.here.com/gis-data-suite/docs/world-countries-feature-class-world_countries.md) - [Buildings feature class (Buildings_3D)](https://docs.here.com/gis-data-suite/docs/buildings-feature-class-buildings_3d.md) - [Glaciers feature class (Glaciers)](https://docs.here.com/gis-data-suite/docs/glaciers-feature-class-glaciers.md) - [Grassland feature class(Grassland)](https://docs.here.com/gis-data-suite/docs/grassland-feature-classgrassland.md) - [Islands feature class (Islands)](https://docs.here.com/gis-data-suite/docs/islands-feature-class-islands.md) - [Mountain range centerlines (Mountain_Range_Centrelines)](https://docs.here.com/gis-data-suite/docs/mountain-range-centerlines-mountain_range_centrelines.md) - [Barren sparsely vegetated (Barren_Sparsely_Vegetated)](https://docs.here.com/gis-data-suite/docs/new-category-barren-sparsely-vegetated-barren_sparsely_vegetated.md) - [Oceans feature class (Oceans)](https://docs.here.com/gis-data-suite/docs/oceans-feature-class-oceans.md) - [Woodland feature class (Woodland)](https://docs.here.com/gis-data-suite/docs/woodland-feature-class-woodland.md) - [Esri® system fields](https://docs.here.com/gis-data-suite/docs/esri-system-fields-2.md) - [Bridges feature class (Bridges)](https://docs.here.com/gis-data-suite/docs/bridges-feature-class-bridges.md) - [Major roads feature class (Major_Roads)](https://docs.here.com/gis-data-suite/docs/major-roads-feature-class-major_roads.md) - [Get started with HERE GIS Data Suite](https://docs.here.com/gis-data-suite/docs/get-started-with-here-gis-data-suite.md) - [Introduction to HERE GIS Data Suite](https://docs.here.com/gis-data-suite/docs/introduction-to-here-gis-data-suite.md) - [Key features - HERE GIS Data Suite](https://docs.here.com/gis-data-suite/docs/key-features-here-gis-data-suite.md) - [Release metadata table (Release_Metadata)](https://docs.here.com/gis-data-suite/docs/release-metadata-table-release_metadata.md) - [Hazardous material (Hazardous_Material_Types)](https://docs.here.com/gis-data-suite/docs/hazardous-material-hazardous_material_types.md) - [Language info fields](https://docs.here.com/gis-data-suite/docs/language-info-fields.md) - [Modified speed factors](https://docs.here.com/gis-data-suite/docs/modified-speed-factors.md) - [Postal code data](https://docs.here.com/gis-data-suite/docs/postal-code-data.md) - [Postal area centroids HD (Postal_Area_Centroids_HD)](https://docs.here.com/gis-data-suite/docs/postal-area-centroids-hd-postal_area_centroids_hd.md) - [Postal area centroids (Postal_Area_Centroids)](https://docs.here.com/gis-data-suite/docs/postal-area-centroids-postal_area_centroids.md) - [Postal points](https://docs.here.com/gis-data-suite/docs/postal-points.md) - [Postal polygons gen (Postal_Polygons_Gen)](https://docs.here.com/gis-data-suite/docs/postal-polygons-gen-postal_polygons_gen.md) - [Postal polygons HD (Postal_Polygons_HD)](https://docs.here.com/gis-data-suite/docs/postal-polygons-hd-postal_polygons_hd.md) - [ Postal polygons ultragen (Postal_Polygons_Ultragen)](https://docs.here.com/gis-data-suite/docs/postal-polygons-ultragen-postal_polygons_ultragen.md) - [Postal polygons ungen (Postal_Polygons_Ungen)](https://docs.here.com/gis-data-suite/docs/postal-polygons-ungen-postal_polygons_ungen.md) - [Transliteration types](https://docs.here.com/gis-data-suite/docs/transliteration-types.md) - [Transport preferred route types](https://docs.here.com/gis-data-suite/docs/transport-preferred-route-types.md) - [Vector tile packages](https://docs.here.com/gis-data-suite/docs/vector-tile-packages.md) # HERE Destination Weather Documentation ## Guides - [How to comply with attribution requirements](https://docs.here.com/destination-weather/docs/attribution-requirements-1.md) - [How to construct a request in the HERE Destination Weather API](https://docs.here.com/destination-weather/docs/construct-a-request-1.md) - [How to use cross-domain JavaScript requests](https://docs.here.com/destination-weather/docs/cross-domain-javascript-requests-1.md) - [Get started with the HERE Destination Weather API](https://docs.here.com/destination-weather/docs/get-started-1.md) - [How to request an astronomy forecast](https://docs.here.com/destination-weather/docs/astronomy-forecast-request-1.md) - [How to request NWS weather alerts](https://docs.here.com/destination-weather/docs/nws-weather-alerts-request-1.md) - [How to request a seven day weather forecast](https://docs.here.com/destination-weather/docs/seven-day-weather-forecast-request-1.md) - [How to request severe weather alerts](https://docs.here.com/destination-weather/docs/severe-weather-alerts-request-1.md) - [How to make a weather observation request](https://docs.here.com/destination-weather/docs/weather-observation-request-1.md) - [HERE server environments](https://docs.here.com/destination-weather/docs/here-server-env-1.md) - [Weather alerts along the route resource](https://docs.here.com/destination-weather/docs/resource-weather-alerts-1.md) - [Weather alerts for a single car location resource](https://docs.here.com/destination-weather/docs/resource-weather-alerts-single-location-1.md) - [How to retrieve a weather map tile](https://docs.here.com/destination-weather/docs/resource-weather-tile-1.md) - [Destination Weather API Tile coverage](https://docs.here.com/destination-weather/docs/tile-coverage-1.md) - [Air quality](https://docs.here.com/destination-weather/docs/aq-1.md) - [Volcanic ashfall](https://docs.here.com/destination-weather/docs/as-1.md) - [Avalanche](https://docs.here.com/destination-weather/docs/av-1.md) - [Civil danger](https://docs.here.com/destination-weather/docs/cd-1.md) - [Coastal event](https://docs.here.com/destination-weather/docs/ce-1.md) - [Dust storm or sandstorm](https://docs.here.com/destination-weather/docs/du-1.md) - [Earthquake](https://docs.here.com/destination-weather/docs/ea-1.md) - [Evacuation](https://docs.here.com/destination-weather/docs/ev-1.md) - [Fire danger](https://docs.here.com/destination-weather/docs/fd-1.md) - [Flood](https://docs.here.com/destination-weather/docs/fl-1.md) - [Fog](https://docs.here.com/destination-weather/docs/fo-1.md) - [Hazardous materials](https://docs.here.com/destination-weather/docs/hm-1.md) - [High waves](https://docs.here.com/destination-weather/docs/hw-1.md) - [Ice or freezing rain](https://docs.here.com/destination-weather/docs/ic-1.md) - [Ice in waterway](https://docs.here.com/destination-weather/docs/im-1.md) - [Low water](https://docs.here.com/destination-weather/docs/lw-1.md) - [Warning](https://docs.here.com/destination-weather/docs/ot-1.md) - [Rain](https://docs.here.com/destination-weather/docs/ra-1.md) - [Radiological hazard](https://docs.here.com/destination-weather/docs/rh-1.md) - [Smoke or smog](https://docs.here.com/destination-weather/docs/sm-1.md) - [Snow](https://docs.here.com/destination-weather/docs/sn-1.md) - [Shelter in place](https://docs.here.com/destination-weather/docs/sp-1.md) - [Extremely high temperature](https://docs.here.com/destination-weather/docs/th-1.md) - [Extremely low temperature](https://docs.here.com/destination-weather/docs/tl-1.md) - [Thunderstorm](https://docs.here.com/destination-weather/docs/ts-1.md) - [Tsunami](https://docs.here.com/destination-weather/docs/tu-1.md) - [High UV index](https://docs.here.com/destination-weather/docs/uv-1.md) - [Volcano](https://docs.here.com/destination-weather/docs/vo-1.md) - [Wind](https://docs.here.com/destination-weather/docs/wi-1.md) - [How to calculate X and Y coordinates for a weather tile](https://docs.here.com/destination-weather/docs/calculate-weather-tile-1.md) - [How to get weather alerts for a single car location](https://docs.here.com/destination-weather/docs/example-alerts-single-location-request-1.md) - [How to get a Doppler radar weather tile](https://docs.here.com/destination-weather/docs/example-doppler-request.md) - [How to get a global precipitation weather tile](https://docs.here.com/destination-weather/docs/example-precip-request-1.md) - [How to get weather alerts for a route](https://docs.here.com/destination-weather/docs/example-weather-alerts-request.md) - [Introduction](https://docs.here.com/destination-weather/docs/readme-1.md) - [Destination Weather API Response status codes](https://docs.here.com/destination-weather/docs/response-status-codes-1.md) - [AddressType](https://docs.here.com/destination-weather/docs/address-type.md) - [AlertItemType](https://docs.here.com/destination-weather/docs/alert-items-type-1.md) - [AlertProvinceType](https://docs.here.com/destination-weather/docs/alert-province-type.md) - [AlertZoneCountyType](https://docs.here.com/destination-weather/docs/alert-zone-county-type.md) - [AlertsType](https://docs.here.com/destination-weather/docs/alerts-type-1.md) - [AstronomyItemType](https://docs.here.com/destination-weather/docs/astronomy-items-type-1.md) - [AstronomyType](https://docs.here.com/destination-weather/docs/astronomy-type-1.md) - [DailyForecastType](https://docs.here.com/destination-weather/docs/daily-forecast-type-1.md) - [ForecastLocationType](https://docs.here.com/destination-weather/docs/forecast-location-type-1.md) - [ForecastType](https://docs.here.com/destination-weather/docs/forecast-type-1.md) - [HourlyForecastType](https://docs.here.com/destination-weather/docs/hourly-forecast-type-1.md) - [LocationMetadata](https://docs.here.com/destination-weather/docs/location-metadata-1.md) - [LocationType](https://docs.here.com/destination-weather/docs/location-type.md) - [NWSAlertItemType](https://docs.here.com/destination-weather/docs/nws-alert-items-type-1.md) - [NWSAlertsType](https://docs.here.com/destination-weather/docs/nws-alerts-type-1.md) - [ObservationType](https://docs.here.com/destination-weather/docs/observation-type-1.md) - [PlaceMetadata](https://docs.here.com/destination-weather/docs/place-metadata-1.md) - [TimeSegmentType](https://docs.here.com/destination-weather/docs/time-segment-type-1.md) - [WeatherItemType](https://docs.here.com/destination-weather/docs/weather-items-type-1.md) - [WeekDayType](https://docs.here.com/destination-weather/docs/week-day-type.md) - [Standard API Elements](https://docs.here.com/destination-weather/docs/standard-api-elements.md) - [Mapping of supported NWS warning or watch types](https://docs.here.com/destination-weather/docs/mapping-of-supported-nws-warning-or-watch-types-1.md) - [WeatherReport response overview](https://docs.here.com/destination-weather/docs/report-response-1.md) - [How to a request a general weather report](https://docs.here.com/destination-weather/docs/resource-report-1.md) - [HERE Destination Weather API Resources](https://docs.here.com/destination-weather/docs/resources-1.md) - [Response data types](https://docs.here.com/destination-weather/docs/response-data-types-1.md) - [Supported global alerts](https://docs.here.com/destination-weather/docs/supported-global-alerts-1.md) - [Supported languages in the HERE Destination Weather API](https://docs.here.com/destination-weather/docs/supported-languages-1.md) - [Supported NWS warning or watch types](https://docs.here.com/destination-weather/docs/supported-nws-warning-or-watch-types-1.md) ## API Reference - [Health](https://docs.here.com/destination-weather/reference/gethealth.md): Returns the health status of the service. - [This API specification](https://docs.here.com/destination-weather/reference/getopenapi.md): Returns this API specification in YAML format. - [Version](https://docs.here.com/destination-weather/reference/getversion.md): Returns the version of the service. - [Weather alerts](https://docs.here.com/destination-weather/reference/weatheralert.md): Weather alerts along the route or around a single location. - [Weather radar image](https://docs.here.com/destination-weather/reference/weatherradarimage.md): Retrieves a Doppler radar image - [Weather report](https://docs.here.com/destination-weather/reference/weatherreport.md): Retrieves weather reports, weather forecasts, severe weather alerts. # HERE EV Products Documentation ## Guides - [HTTP Status Codes](https://docs.here.com/ev-products/docs/evapiv2-http-status-codes.md) - [Namespace and Schema](https://docs.here.com/ev-products/docs/evapiv2-resource-schema.md) - [Resources](https://docs.here.com/ev-products/docs/evapiv2-resources.md) - [HERE EV Charge Points API v2 Response Data Types](https://docs.here.com/ev-products/docs/here-ev-charge-points-api-v2-response-data-types.md) - [EVSEs Response](https://docs.here.com/ev-products/docs/resource-type-response-evses.md) - [Stations Count Response](https://docs.here.com/ev-products/docs/resource-type-response-stations-count.md) - [Connector Statuses Response](https://docs.here.com/ev-products/docs/response-connector-statuses.md) - [Connector Types Response](https://docs.here.com/ev-products/docs/response-connector-types.md) - [EVSEs Connector Response](https://docs.here.com/ev-products/docs/response-evses-connector.md) - [EVSEs EVSE Response](https://docs.here.com/ev-products/docs/response-evses-evse.md) - [EVSEs Pool Response](https://docs.here.com/ev-products/docs/response-evses-pool.md) - [EVSEs Station Response](https://docs.here.com/ev-products/docs/response-evses-station.md) - [Power Feed Types Response](https://docs.here.com/ev-products/docs/response-power-feed-types.md) - [Roamings Response](https://docs.here.com/ev-products/docs/response-roamings.md) - [Stations Response](https://docs.here.com/ev-products/docs/response-stations.md) - [HERE EV Charge Points API v2 - API reference](https://docs.here.com/ev-products/docs/here-ev-charge-points-api-v2-api-reference.md) - [AddressType](https://docs.here.com/ev-products/docs/here-ev-products-resource-type-address.md) - [AnnualOpeningHoursDetailType](https://docs.here.com/ev-products/docs/here-ev-products-resource-type-annual-hours-detail.md) - [ChargingConnectorsListType](https://docs.here.com/ev-products/docs/here-ev-products-resource-type-charging-connectors-list.md) - [ChargingPointType](https://docs.here.com/ev-products/docs/here-ev-products-resource-type-charging-point.md) - [ConnectorDetailType](https://docs.here.com/ev-products/docs/here-ev-products-resource-type-connector-detail.md) - [Connector Types](https://docs.here.com/ev-products/docs/here-ev-products-resource-type-connector-types.md) - [ConnectorType](https://docs.here.com/ev-products/docs/here-ev-products-resource-type-connector.md) - [CorridorType](https://docs.here.com/ev-products/docs/here-ev-products-resource-type-corridor.md) - [EVStationsSearchRequest](https://docs.here.com/ev-products/docs/here-ev-products-resource-type-ev-request.md) - [EVStationDetailsType](https://docs.here.com/ev-products/docs/here-ev-products-resource-type-ev-station-details.md) - [EVStationType](https://docs.here.com/ev-products/docs/here-ev-products-resource-type-ev-station.md) - [NameIdType](https://docs.here.com/ev-products/docs/here-ev-products-resource-type-name-id.md) - [OpeningHoursDetailType](https://docs.here.com/ev-products/docs/here-ev-products-resource-type-opening-hours-detail.md) - [OpeningHoursType](https://docs.here.com/ev-products/docs/here-ev-products-resource-type-opening-hours.md) - [PaymentMethodsType](https://docs.here.com/ev-products/docs/here-ev-products-resource-type-payment-methods.md) - [PositionType](https://docs.here.com/ev-products/docs/here-ev-products-resource-type-position.md) - [Powerfeed Types](https://docs.here.com/ev-products/docs/here-ev-products-resource-type-power-feed-types.md) - [PriceType](https://docs.here.com/ev-products/docs/here-ev-products-resource-type-price-type.md) - [Charge card (eMSP) acceptance](https://docs.here.com/ev-products/docs/here-ev-products-resource-type-roaming.md) - [TimePeriodType](https://docs.here.com/ev-products/docs/here-ev-products-resource-type-time-period.md) - [UnitType](https://docs.here.com/ev-products/docs/here-ev-products-resource-type-unit.md) - [ValueLabelType](https://docs.here.com/ev-products/docs/here-ev-products-resource-type-value-label.md) - [HERE EV Charge Points API v2 Data Types](https://docs.here.com/ev-products/docs/resource-types.md) - [Connector Statuses](https://docs.here.com/ev-products/docs/resource-type-connector-statuses-new.md) - [ContactType](https://docs.here.com/ev-products/docs/resource-type-contacts.md) - [EVStationsListType](https://docs.here.com/ev-products/docs/resource-type-ev-stations-list.md) - [Introduction to the HERE EV Charge Points API v2](https://docs.here.com/ev-products/docs/evapiv2-readme.md) - [How to create basic elements of a request](https://docs.here.com/ev-products/docs/evapiv2-request-constructing.md) - [How to create cross-domain JavaScript requests](https://docs.here.com/ev-products/docs/evapiv2-request-cross-domain-js-2.md) - [How to get location details](https://docs.here.com/ev-products/docs/evapiv2-example-charging-station-details.md) - [How to get list of charging stations](https://docs.here.com/ev-products/docs/evapiv2-example-charging-station.md) - [HERE EV Charge Points API v2 Tutorials](https://docs.here.com/ev-products/docs/here-ev-charge-points-api-v2-tutorials.md) - [Get started with the HERE EV Charge Points API v2](https://docs.here.com/ev-products/docs/here-ev-products-quick-start.md) - [HERE EV Charge Points API v2 Developer Guide](https://docs.here.com/ev-products/docs/here-ev-charge-points-api-v2-developer-guide.md): The articles in this section provide a guide to using the HERE EV Charge Points API v2. - [API Changes](https://docs.here.com/ev-products/docs/api-changes.md) - [Functional and Behavioral Changes](https://docs.here.com/ev-products/docs/functional-behavioral-changes.md) - [Known Issues](https://docs.here.com/ev-products/docs/known-issues.md) - [Limitations and Workarounds](https://docs.here.com/ev-products/docs/limitations-workarounds.md) - [Resolved Issues](https://docs.here.com/ev-products/docs/resolved-issues.md) - [Changes](https://docs.here.com/ev-products/docs/changes.md) - [Highlights](https://docs.here.com/ev-products/docs/highlights.md) - [Concepts of the HERE EV Charge Points API v3](https://docs.here.com/ev-products/docs/concepts-guide.md) - [Get started with HERE EV Charge Points API v3](https://docs.here.com/ev-products/docs/quick-start-platform-overview.md) - [Introduction to HERE EV Charge Points API v3](https://docs.here.com/ev-products/docs/readme-guide.md) - [Tutorials](https://docs.here.com/ev-products/docs/tutorial-main.md) - [How to get data for one or multiple charging locations](https://docs.here.com/ev-products/docs/tutorial-basic.md) - [Connectors tutorial](https://docs.here.com/ev-products/docs/tutorial-connectors.md) - [How to get dynamic status for charging locations](https://docs.here.com/ev-products/docs/tutorial-dynamic.md) - [How to get country coverage for eMSPs, CPOs, and connector details](https://docs.here.com/ev-products/docs/tutorial-metadata.md) - [How to get nearby places information for locations](https://docs.here.com/ev-products/docs/tutorial-nearby.md) - [How to get EV charge point predictions](https://docs.here.com/ev-products/docs/tutorial-predictions.md) - [How to get Tariffs for connector groups or EVSE](https://docs.here.com/ev-products/docs/tutorial-tariffs.md) - [How to get data for EV Truck charging locations](https://docs.here.com/ev-products/docs/tutorial-truck.md) - [HERE EV Charge Points API v3 migration guide](https://docs.here.com/ev-products/docs/evapi-v3-migration-guide.md) - [HERE EV Products - Changelog](https://docs.here.com/ev-products/docs/changelog-ev-products.md) - [EV concepts](https://docs.here.com/ev-products/docs/introduction-to-here-ev-products-concepts.md) - [Get started](https://docs.here.com/ev-products/docs/introduction-to-here-ev-products-quick-start-platform.md) - [Introduction](https://docs.here.com/ev-products/docs/introduction-to-here-ev-products-readme.md) - [Access the static EV data layer](https://docs.here.com/ev-products/docs/tutorial-hmc.md) - [Access the dynamic status updates layer](https://docs.here.com/ev-products/docs/tutorial-stream.md) - [Tutorials on HERE EV Charge Points API v3](https://docs.here.com/ev-products/docs/introduction-to-here-ev-products-tutorial-evapi3.md) - [Tutorials on Search](https://docs.here.com/ev-products/docs/introduction-to-here-ev-products-tutorial-gs7.md) - [Tutorials on HERE SDK](https://docs.here.com/ev-products/docs/introduction-to-here-ev-products-tutorial-sdk.md) - [Tutorials on EV Routing](https://docs.here.com/ev-products/docs/introduction-to-here-ev-products-tutorials-routing.md) ## API Reference - [Tests basic health of the service](https://docs.here.com/ev-products/reference/gethealth.md) - [Retrieves this API specification in OpenAPI 3 format](https://docs.here.com/ev-products/reference/getopenapi.md) - [Retrieves API specification version information](https://docs.here.com/ev-products/reference/getversion.md) - [Fetch a single location](https://docs.here.com/ev-products/reference/getlocation.md): Allows fetching a single location given its ID. The set of returned location properties can be controlled via the `fields` parameter. - [Fetch multiple locations](https://docs.here.com/ev-products/reference/getlocations.md): Returns data for the specified location identifiers in the `items` property of the response. If no data is found for a location identifier, it appears in the `missing` property. - [Fetch metadata by countries.](https://docs.here.com/ev-products/reference/getcountrymeta.md): Fetch metadata by countries, such as a list of e-Mobility Service Providers (eMSPs). If you don't specify any countries, the response includes all available countries. If you don't specify any fields, the response includes only the list of available countries. ## Changelog - [HERE EV Charge Points API v3](https://docs.here.com/ev-products/changelog/sit_ev-charge-points-api-v3.md) # HERE Fuel Prices Documentation ## Guides - [HERE Fuel Prices API concepts](https://docs.here.com/fuel-prices/docs/concepts.md) - [Introduction to the HERE Fuel Prices API](https://docs.here.com/fuel-prices/docs/fuel-prices-intro.md) - [Fuel types and categories](https://docs.here.com/fuel-prices/docs/fuel-types-mapping.md) - [Get started with the HERE Fuel Prices API](https://docs.here.com/fuel-prices/docs/get-started.md) - [AddressType](https://docs.here.com/fuel-prices/docs/resource-type-address.md) - [AnnualOpeningHoursDetailType](https://docs.here.com/fuel-prices/docs/resource-type-annual-opening-hours-details.md) - [ContactType](https://docs.here.com/fuel-prices/docs/resource-type-contact.md) - [CorridorSearchRequest](https://docs.here.com/fuel-prices/docs/resource-type-corridor-request.md) - [CorridorType](https://docs.here.com/fuel-prices/docs/resource-type-corridor.md) - [FuelPriceType](https://docs.here.com/fuel-prices/docs/resource-type-fuel-price.md) - [FuelStationDetailType](https://docs.here.com/fuel-prices/docs/resource-type-fuel-station-details.md) - [FuelStationType](https://docs.here.com/fuel-prices/docs/resource-type-fuel-station.md) - [FuelStationsListType](https://docs.here.com/fuel-prices/docs/resource-type-fuel-stations-list.md) - [FuelType](https://docs.here.com/fuel-prices/docs/resource-type-fuel-type.md) - [OpeningHoursDetailsType](https://docs.here.com/fuel-prices/docs/resource-type-opening-hours-detail.md) - [OpeningHoursType](https://docs.here.com/fuel-prices/docs/resource-type-opening-hours.md) - [OperationalStateType](https://docs.here.com/fuel-prices/docs/resource-type-operational-state.md) - [PositionType](https://docs.here.com/fuel-prices/docs/resource-type-position.md) - [TimePeriodType](https://docs.here.com/fuel-prices/docs/resource-type-time-period.md) - [ValueLabelType](https://docs.here.com/fuel-prices/docs/resource-type-value-label.md) - [HERE Fuel Prices API HTTP status codes](https://docs.here.com/fuel-prices/docs/http-status-codes.md) - [Cross-Domain JavaScript Requests](https://docs.here.com/fuel-prices/docs/request-cross-domain-js.md) - [Resources](https://docs.here.com/fuel-prices/docs/resources.md) - [Fuel brands](https://docs.here.com/fuel-prices/docs/resource-fuelbrands.md) - [Fueltypes](https://docs.here.com/fuel-prices/docs/resource-fueltypes.md) - [Station Details](https://docs.here.com/fuel-prices/docs/resource-station-details.md) - [Stations Along the Route](https://docs.here.com/fuel-prices/docs/resource-stations-corridor.md) - [Stations Count](https://docs.here.com/fuel-prices/docs/resource-stations-count.md) - [Stations by PVID or station id](https://docs.here.com/fuel-prices/docs/resource-stations-pvid.md) - [Stations](https://docs.here.com/fuel-prices/docs/resource-stations.md) - [Fuel brands response](https://docs.here.com/fuel-prices/docs/resource-type-response-fuel-brands.md) - [Fuel stations CountType response](https://docs.here.com/fuel-prices/docs/resource-type-response-fuel-stations-count.md) - [Fuel stations response](https://docs.here.com/fuel-prices/docs/resource-type-response-fuel-stations.md) - [Fuel types response](https://docs.here.com/fuel-prices/docs/resource-type-response-fuel-types.md) - [HERE server environments for HERE Fuel Prices API](https://docs.here.com/fuel-prices/docs/server-environment.md) - [How to create a fuel price request for all fuel types](https://docs.here.com/fuel-prices/docs/example-fuel-price-all.md) - [How to create a fuel price request](https://docs.here.com/fuel-prices/docs/example-fuel-price.md) - [How to get details for a fuel station](https://docs.here.com/fuel-prices/docs/example-fuel-station-details.md) - [How to get details for a fuel station by PVID or station ID](https://docs.here.com/fuel-prices/docs/example-fuel-station-pvid.md) - [How to get a list of fuel stations](https://docs.here.com/fuel-prices/docs/example-fuel-station.md) - [Tutorials](https://docs.here.com/fuel-prices/docs/tutorials.md) ## API Reference - [Fuel service is alive check](https://docs.here.com/fuel-prices/reference/fuelisalive.md): Fuel service is working properly - [Fuel service version](https://docs.here.com/fuel-prices/reference/fuelversion.md): Fuel service version - [Fuel station details](https://docs.here.com/fuel-prices/reference/fuelstationdetail-1.md): Retrieves fuel station details for given station id - [Fuel stations search](https://docs.here.com/fuel-prices/reference/fuelstationssearch-1.md): Retrieves fuel stations within geospatial area - [Fuel brands](https://docs.here.com/fuel-prices/reference/fuelbrands-1.md): Returns all available fuel station brands. Fuel station brand can be used as brands query parameter in Fuel stations search - [Fuel types](https://docs.here.com/fuel-prices/reference/fueltypes-1.md): Returns all available fuel types. Fuel type id can be used as fuelType query parameter in Fuel stations search - [Health](https://docs.here.com/fuel-prices/reference/gethealth.md): Returns the health status of the service - [This API specification](https://docs.here.com/fuel-prices/reference/getopenapi.md): Returns this API specification in YAML format. - [Version](https://docs.here.com/fuel-prices/reference/getversion.md): Returns the version of the service - [Return multiple fuel stations](https://docs.here.com/fuel-prices/reference/fuelstationbulk.md): Retrieves multiple fuel stations by station ids - [One fuel station data](https://docs.here.com/fuel-prices/reference/fuelstationdetail.md): Retrieves single fuel station information for given station id - [Fuel stations along the route search](https://docs.here.com/fuel-prices/reference/fuelstationscorridorsearch.md): Retrieves fuel stations along the route - [Number of fuel stations](https://docs.here.com/fuel-prices/reference/fuelstationscount.md): Return number of fuel stations within given geospatial area - [Fuel stations search](https://docs.here.com/fuel-prices/reference/fuelstationssearch.md): Retrieves fuel stations within geospatial area - [Fuel brands](https://docs.here.com/fuel-prices/reference/fuelbrands.md): Returns all available fuel station brands. Fuel station brand can be used as brands query parameter in Fuel stations search - [Fuel types](https://docs.here.com/fuel-prices/reference/fueltypes.md): Returns all available fuel types. Fuel type id can be used as fuelType query parameter in Fuel stations search # HERE Map Rendering Documentation ## Guides - [Map Image API v3 Changelog](https://docs.here.com/map-rendering/docs/map-image-changelog.md) - [Map coverage](https://docs.here.com/map-rendering/docs/coverage-info-map-image-api.md) - [Customize map features](https://docs.here.com/map-rendering/docs/additional-map-features.md) - [Obtain high-resolution map images](https://docs.here.com/map-rendering/docs/high-dpi-images.md) - [Adjust map readability](https://docs.here.com/map-rendering/docs/adjust-map-readability.md) - [Modify label and icon size](https://docs.here.com/map-rendering/docs/label-icon-size.md) - [Conceal cut-off labels](https://docs.here.com/map-rendering/docs/label-truncation.md) - [Enhance map borders with padding](https://docs.here.com/map-rendering/docs/padding.md) - [Include the copyright notice](https://docs.here.com/map-rendering/docs/copyright-notice.md) - [Compact overlay encoding](https://docs.here.com/map-rendering/docs/custom-overlay.md) - [GeoJSON format](https://docs.here.com/map-rendering/docs/geojson-overlay.md) - [Explore custom overlay options](https://docs.here.com/map-rendering/docs/display-additional-data.md) - [Retrieve road shield icons](https://docs.here.com/map-rendering/docs/icon-service.md) - [Optimize image dimensions and image format](https://docs.here.com/map-rendering/docs/image-properties.md) - [Personalize the map language](https://docs.here.com/map-rendering/docs/languages.md) - [Adjust map position](https://docs.here.com/map-rendering/docs/map-positioning.md) - [Set map bounds](https://docs.here.com/map-rendering/docs/set-position-bounds.md) - [Define map center](https://docs.here.com/map-rendering/docs/set-position-center.md) - [Position map based on overlay](https://docs.here.com/map-rendering/docs/set-positon-overlay.md) - [Retrieve viewport data from the API response header](https://docs.here.com/map-rendering/docs/viewport-zoom.md) - [Explore geopolitical views](https://docs.here.com/map-rendering/docs/political-views.md) - [Keep track of your requests](https://docs.here.com/map-rendering/docs/request-tracking-map-image-api.md) - [Choose the map resource type](https://docs.here.com/map-rendering/docs/resources.md) - [Add a scale bar overlay](https://docs.here.com/map-rendering/docs/scalebar.md) - [Define the map styles](https://docs.here.com/map-rendering/docs/styles.md) - [Adjust map features](https://docs.here.com/map-rendering/docs/adjust-map-features.md) - [Center map at specific location](https://docs.here.com/map-rendering/docs/center-specific-location.md) - [Create a proximity circle](https://docs.here.com/map-rendering/docs/create-proximity-circle.md) - [Customize maps with compact overlay encoding](https://docs.here.com/map-rendering/docs/customize-compact-encoding.md) - [Customize GeoJSON overlay](https://docs.here.com/map-rendering/docs/customize-geojson-overlay.md) - [Define map image bounds](https://docs.here.com/map-rendering/docs/define-map-bounds.md) - [Examples](https://docs.here.com/map-rendering/docs/examples.md) - [Localize map labels](https://docs.here.com/map-rendering/docs/localize-map-labels.md) - [Personalize map style](https://docs.here.com/map-rendering/docs/personalize-map-style.md) - [Introduction](https://docs.here.com/map-rendering/docs/introduction-map-image-api.md) - [Get started](https://docs.here.com/map-rendering/docs/quickstart-map-image-api.md) - [Add layers of information by using compact overlay encoding](https://docs.here.com/map-rendering/docs/add-custom-style.md) - [Add layers of information by using GeoJSON](https://docs.here.com/map-rendering/docs/add-geojson-overlay.md) - [Handle requests with complex overlay data](https://docs.here.com/map-rendering/docs/flexible-polyline.md) - [Obtain a map image through address look-up](https://docs.here.com/map-rendering/docs/geocoding-tutorial.md) - [Display routing information on a map image](https://docs.here.com/map-rendering/docs/routing-tutorial.md) - [Overlay proximity circles on a map image](https://docs.here.com/map-rendering/docs/uncertainty-circle.md) - [Migrate from Map Image API v1 to Map Image API v3](https://docs.here.com/map-rendering/docs/map-image-api-migration-guide.md) - [Raster Tile API v3 Changelog](https://docs.here.com/map-rendering/docs/raster-tile-changelog.md) - [Advanced raster tile](https://docs.here.com/map-rendering/docs/advanced-raster-tile.md) - [Features](https://docs.here.com/map-rendering/docs/features.md) - [Geopolitical views](https://docs.here.com/map-rendering/docs/geopolitical-views.md) - [Image formats](https://docs.here.com/map-rendering/docs/image-formats.md) - [Map languages](https://docs.here.com/map-rendering/docs/languages-raster-tile-api.md) - [The Mercator projection](https://docs.here.com/map-rendering/docs/mercator-projection.md) - [Request tracking](https://docs.here.com/map-rendering/docs/request-tracking-raster-tile-api.md) - [Required copyright notice](https://docs.here.com/map-rendering/docs/required-copyright-notice.md) - [Styles](https://docs.here.com/map-rendering/docs/styles-raster-tile-api.md) - [Map coverage](https://docs.here.com/map-rendering/docs/coverage-info-raster-tile-api.md) - [Visualize terrain data in 3D with HERE DEM](https://docs.here.com/map-rendering/docs/example-dem.md) - [Render raster maps with the HERE Maps API for JavaScript](https://docs.here.com/map-rendering/docs/example-jsapi.md) - [Render raster maps with Leaflet](https://docs.here.com/map-rendering/docs/example-leaflet.md) - [Introduction](https://docs.here.com/map-rendering/docs/introduction-raster-tile-api.md) - [HERE Raster Tile API playground](https://docs.here.com/map-rendering/docs/playground.md) - [Get started](https://docs.here.com/map-rendering/docs/quickstart-raster-tile-api.md) - [Best practices for map tile caching](https://docs.here.com/map-rendering/docs/cache-maps-raster-tile-api.md) - [Specify features to be rendered on a map tile](https://docs.here.com/map-rendering/docs/example-features.md) - [Specify the language of the map tile labels](https://docs.here.com/map-rendering/docs/example-language.md) - [Get the map tile based on geopolitical view](https://docs.here.com/map-rendering/docs/example-political-view.md) - [Specify the label and icon size](https://docs.here.com/map-rendering/docs/example-ppi.md) - [Obtain high-resolution map tiles](https://docs.here.com/map-rendering/docs/example-resolution.md) - [Select the map tile type](https://docs.here.com/map-rendering/docs/example-resource.md) - [Specify the map tile image size](https://docs.here.com/map-rendering/docs/example-size.md) - [Specify the style and appearance of a map tile](https://docs.here.com/map-rendering/docs/example-style.md) - [Migrate from HERE Map Tile API v2 to HERE Raster Tile API v3](https://docs.here.com/map-rendering/docs/migration-guide-raster-tile-api.md) - [Vector Tile API Changelog](https://docs.here.com/map-rendering/docs/vector-tile-changelog.md) - [Best practices for map tile caching](https://docs.here.com/map-rendering/docs/cache-maps-vector-tile-api.md) - [Geopolitical views](https://docs.here.com/map-rendering/docs/geopolitical-views-vector-tile-api.md) - [Available map languages](https://docs.here.com/map-rendering/docs/languages-vector-tile-api.md) - [Map parameter](https://docs.here.com/map-rendering/docs/map-parameter.md) - [Polygonal roads](https://docs.here.com/map-rendering/docs/polygonal-roads.md) - [Request tracking](https://docs.here.com/map-rendering/docs/request-tracking-vector-tile-api.md) - [Required copyright notice](https://docs.here.com/map-rendering/docs/required-copyright-notice-vector-tile-api.md) - [Traffic](https://docs.here.com/map-rendering/docs/traffic.md) - [Map coverage](https://docs.here.com/map-rendering/docs/coverage-info-vector-tile-api.md) - [Vector tiles with the HERE Maps API for JavaScript](https://docs.here.com/map-rendering/docs/jsla.md) - [Mapbox](https://docs.here.com/map-rendering/docs/mapbox.md) - [MapLibre](https://docs.here.com/map-rendering/docs/maplibre.md) - [Tangram](https://docs.here.com/map-rendering/docs/tangram.md) - [Introduction](https://docs.here.com/map-rendering/docs/introduction-vector-tile-api.md) - [Get started](https://docs.here.com/map-rendering/docs/quickstart-vector-tile-api.md) - [Names](https://docs.here.com/map-rendering/docs/common-names.md) - [Properties](https://docs.here.com/map-rendering/docs/common-properties.md) - [Types](https://docs.here.com/map-rendering/docs/common-types.md) - [Road network values](https://docs.here.com/map-rendering/docs/networks.md) - [Content](https://docs.here.com/map-rendering/docs/content.md) - [Encoding specification](https://docs.here.com/map-rendering/docs/encoding-specification.md) - [Layer schema](https://docs.here.com/map-rendering/docs/layer-schema.md) - [boundaries](https://docs.here.com/map-rendering/docs/boundaries.md) - [buildings](https://docs.here.com/map-rendering/docs/buildings.md) - [contours](https://docs.here.com/map-rendering/docs/contours.md) - [earth](https://docs.here.com/map-rendering/docs/earth.md) - [hillshade](https://docs.here.com/map-rendering/docs/hillshade.md) - [Layer reference](https://docs.here.com/map-rendering/docs/layers.md) - [landuse](https://docs.here.com/map-rendering/docs/landuse.md) - [places](https://docs.here.com/map-rendering/docs/places.md) - [pois (points of interest)](https://docs.here.com/map-rendering/docs/pois.md) - [road_labels](https://docs.here.com/map-rendering/docs/roadlabels.md) - [roads](https://docs.here.com/map-rendering/docs/roads.md) - [transit V2](https://docs.here.com/map-rendering/docs/transit-v2.md) - [transit](https://docs.here.com/map-rendering/docs/transit.md) - [water](https://docs.here.com/map-rendering/docs/water.md) ## API Reference - [Tests basic health of the service](https://docs.here.com/map-rendering/reference/gethealth.md): Checks the fundamental health status of the service. Useful for identifying and discarding connectivity issues. - [Returns the OpenAPI 3.0 definition of this API (current file)](https://docs.here.com/map-rendering/reference/getopenapi.md) - [Retrieves the API Specification version](https://docs.here.com/map-rendering/reference/getversion.md): Fetches details regarding the API Specification version. Offers purely informational insights into the API's last update. - [Retrieve an icon in the requested format](https://docs.here.com/map-rendering/reference/geticon.md): Retrieve customizable icons based on style, country, state, and road class - [Retrieve a map image in the requested format](https://docs.here.com/map-rendering/reference/getimage.md): Retrieve a section of the map by specifying its dimensions (width and height). Additionally, you can optionally choose from various parameters to modify the output. - [Returns copyright information](https://docs.here.com/map-rendering/reference/getcopyright.md): Retrieves both the copyright information and the coordinates of the bounding box to which the text applies. If your products and/or services use map data that is made accessible using this service, you shall provide end-users of your products and/or services with notice, in a reasonably conspicuous manner. For more information, see [Include the copyright notice](https://docs.here.com/map-rendering/docs/copyright-notice). - [Returns features per style](https://docs.here.com/map-rendering/reference/getfeatures.md): Returns the list of available features per style. You can use these values to request an image with particular features specified as query parameters. Use only the features that are available for a particular style. For more information, see [Customize map features](https://docs.here.com/map-rendering/docs/additional-map-features). - [Returns a list of accepted values for specific API parameters](https://docs.here.com/map-rendering/reference/getinfo.md): Provides details on acceptable values for API parameters, such as PPI (Pixels Per Inch), styles, and other relevant parameters. - [Returns the available map languages](https://docs.here.com/map-rendering/reference/getlanguages.md): Returns the list of available map languages per resource. You can use these values to request an image with labels in a particular language. The values follow ISO 639-1 two-letter language code and, optionally, ISO 15924 four-letter script code. For more information, see [Personalize the map language](https://docs.here.com/map-rendering/docs/languages). - [Returns geopolitical views](https://docs.here.com/map-rendering/reference/getpoliticalviews.md): Provides a catalog of available geopolitical views. These values enable the request of an image featuring a specific country view. For more information on geopolitical views, see [Explore geopolitical views](https://docs.here.com/map-rendering/docs/political-views). - [Tests basic health of the service](https://docs.here.com/map-rendering/reference/gethealth-1.md): Tests basic health of the service. This can be used to discard connectivity problems. - [Returns OpenAPI 3.0 definition of the API (current file)](https://docs.here.com/map-rendering/reference/getopenapi-1.md) - [Retrieves API Specification version information](https://docs.here.com/map-rendering/reference/getversion-1.md): Retrieves API Specification version information. This is purely informational to know when the API has been updated. - [Returns the copyright](https://docs.here.com/map-rendering/reference/getcopyright-1.md): Returns the copyright. If your products and/or services use map data that is made accessible using this service, you shall provide end-users of your products and/or services with notice, in a reasonably conspicuous manner. - [Returns styles features](https://docs.here.com/map-rendering/reference/getfeatures-1.md): Returns the list of available features per style. Then these values can be used to request a tile with particular features specified as query parameters. Must be consistent with 'style' parameter. - [Returns information about accepted values of some API parameters](https://docs.here.com/map-rendering/reference/getinfo-1.md): Returns information about accepted values of some API parameters, like accepted ppi, styles, and so on. Also returns the map version. This version is valid only for 24h. - [Returns map languages](https://docs.here.com/map-rendering/reference/getlanguages-1.md): Returns the list of available map languages per resource. These values can then be used to request a tile with a particular language for the labels. The values follow ISO 639-1 two-letter language code and, optionally, ISO 15924 four-letter script code. - [Returns geopolitical views](https://docs.here.com/map-rendering/reference/getpoliticalviews-1.md): Returns the list of available geopolitical views. These values can then be used to request a tile with a particular country view. For more information on geopolitical views, see [Geopolitical views](https://docs.here.com/map-rendering/docs/geopolitical-views). - [Retrieve the rendered map tile in requested format](https://docs.here.com/map-rendering/reference/gettile.md): Retrieve the rendered map tile in requested format. It is possible to select among different parameters to modify the output, like a different style, languages, label size, and so on. - [Vector Tile Service basic health check endpoint](https://docs.here.com/map-rendering/reference/gethealth-2.md): Used to check the basic health status of the service - [Returns open api specifications of v2. By default output format is json. Set request header 'accept = application/x-yaml' to get in yaml format.](https://docs.here.com/map-rendering/reference/getopenapi-2.md): Returns open api specifications of v2. By default output format is json. Set request header 'accept = application/x-yaml' to get in yaml format. - [Returns various version information.](https://docs.here.com/map-rendering/reference/getversion-2.md): Returns various version information. - [Retrieves the protocol buffer encoded binary tile.](https://docs.here.com/map-rendering/reference/gettile-1.md): Retrieves the protocol buffer encoded binary tile. - [Returns the copyright](https://docs.here.com/map-rendering/reference/getcopyright-2.md): Returns the copyright - [Returns OMV-2 layers documentation.](https://docs.here.com/map-rendering/reference/getdocs.md): Returns OMV-2 layers documentation. - [Returns the map version. This version is valid only for 24h](https://docs.here.com/map-rendering/reference/getinfo-2.md): Returns the map version. This version is valid only for 24h - [Returns the map languages.](https://docs.here.com/map-rendering/reference/getlanguages-2.md): Returns the list of available map languages per map variant. - [Returns the specified protocol buffer file format.](https://docs.here.com/map-rendering/reference/getproto.md): Returns the specified protocol buffer file format. - [Returns the political views.](https://docs.here.com/map-rendering/reference/getpviews.md): Returns the list of available political views. - [Returns a list of available protocol buffer formats.](https://docs.here.com/map-rendering/reference/listproto.md): Returns a list of available protocol buffer formats. ## Changelog - [MIA 3.0.124 - Map Update](https://docs.here.com/map-rendering/changelog/mia-3-0-124-2026-06-08.md) - [MIA 3.0.79 - Satellite Storage Fix](https://docs.here.com/map-rendering/changelog/mia-service-3-0-79-2026-01-13.md) # HERE Parking Documentation ## Guides - [How to request parking facility details](https://docs.here.com/parking/docs/examples-facility-detail.md) - [How to search for parking facilities](https://docs.here.com/parking/docs/examples-proximity-search.md) - [Examples](https://docs.here.com/parking/docs/examples.md) - [Get started](https://docs.here.com/parking/docs/get-started-off-street-parking.md) - [Introduction](https://docs.here.com/parking/docs/introduction-off-street-parking.md) - [How to construct a request](https://docs.here.com/parking/docs/request-constructing-off-street-parking.md) - [Cross-Domain JavaScript Requests](https://docs.here.com/parking/docs/request-cross-domain-js-off-street-parking.md) - [HTTP Status Codes](https://docs.here.com/parking/docs/http-status-codes.md) - [Off Street Parking API Reference](https://docs.here.com/parking/docs/off-street-parking-api-reference.md) - [Off Street Parking Resources](https://docs.here.com/parking/docs/off-street-parking-resources.md) - [How to retrieve facility details](https://docs.here.com/parking/docs/resource-facilities-detail.md) - [How to retrieve facilities by ID](https://docs.here.com/parking/docs/resource-facilities-pvid.md) - [How to retrieve a list of parking facilities](https://docs.here.com/parking/docs/resource-facilities.md) - [Off Street Parking Response data types](https://docs.here.com/parking/docs/off-street-parking-response-data-types.md) - [Parking facilities result type](https://docs.here.com/parking/docs/resource-type-response-facilities.md) - [Resource data structures](https://docs.here.com/parking/docs/resource-data-structures.md) - [Address](https://docs.here.com/parking/docs/resource-type-address.md) - [Annual Opening Hours Detail](https://docs.here.com/parking/docs/resource-type-annual-opening-hours-detail.md) - [Calculated Parking Price](https://docs.here.com/parking/docs/resource-type-calculated-parking-price.md) - [Contact](https://docs.here.com/parking/docs/resource-type-contact.md) - [Name Id](https://docs.here.com/parking/docs/resource-type-name-id.md) - [Name List](https://docs.here.com/parking/docs/resource-type-name-list.md) - [Opening Hours Detail](https://docs.here.com/parking/docs/resource-type-opening-hours-detail.md) - [Opening Hours](https://docs.here.com/parking/docs/resource-type-opening-hours.md) - [Parking Facilities List](https://docs.here.com/parking/docs/resource-type-parking-facilities-list.md) - [Parking Facilities Price List](https://docs.here.com/parking/docs/resource-type-parking-facilities-price-list.md) - [Parking Facility Availability](https://docs.here.com/parking/docs/resource-type-parking-facility-availability.md) - [Parking Facility Detail](https://docs.here.com/parking/docs/resource-type-parking-facility-detail.md) - [Parking Facility Price](https://docs.here.com/parking/docs/resource-type-parking-facility-price.md) - [Parking Facility](https://docs.here.com/parking/docs/resource-type-parking-facility.md) - [Position](https://docs.here.com/parking/docs/resource-type-position.md) - [Time Period](https://docs.here.com/parking/docs/resource-type-time-period.md) - [Value Label](https://docs.here.com/parking/docs/resource-type-value-label.md) - [Resource schema](https://docs.here.com/parking/docs/resource-schema.md) - [On-Street Parking API Reference](https://docs.here.com/parking/docs/on-street-parking-api-reference.md) - [On-Street Parking Resources](https://docs.here.com/parking/docs/on-street-parking-resources.md) - [Parking/Segments](https://docs.here.com/parking/docs/resource-doc.md) - [Address](https://docs.here.com/parking/docs/data-type-address.md) - [Applicable Date](https://docs.here.com/parking/docs/data-type-applicable-date.md) - [Availability](https://docs.here.com/parking/docs/data-type-availability.md) - [Contact Info](https://docs.here.com/parking/docs/data-type-contact-info.md) - [Cost](https://docs.here.com/parking/docs/data-type-cost.md) - [Exception](https://docs.here.com/parking/docs/data-type-exception.md) - [On-Street Parking Response](https://docs.here.com/parking/docs/data-type-on-street-parking-response.md) - [Oriented Segment Ref](https://docs.here.com/parking/docs/data-type-oriented-segment-ref.md) - [Parking Restriction](https://docs.here.com/parking/docs/data-type-parking-restriction.md) - [Parking Segment](https://docs.here.com/parking/docs/data-type-parking-segment.md) - [Payment Info](https://docs.here.com/parking/docs/data-type-payment-info.md) - [Payment Method](https://docs.here.com/parking/docs/data-type-payment-method.md) - [Price Schema](https://docs.here.com/parking/docs/data-type-price-schema.md) - [Price](https://docs.here.com/parking/docs/data-type-price.md) - [Probability](https://docs.here.com/parking/docs/data-type-probability.md) - [Segment Anchor](https://docs.here.com/parking/docs/data-type-segment-anchor.md) - [Segment Ref](https://docs.here.com/parking/docs/data-type-segment-ref-1.md) - [Time Range](https://docs.here.com/parking/docs/data-type-time-range.md) - [TPEG OpenLR](https://docs.here.com/parking/docs/data-type-tpeg-openlr.md) - [On-Street Parking Response Data Types](https://docs.here.com/parking/docs/on-street-parking-response-data-types.md) - [HTTP Status Codes](https://docs.here.com/parking/docs/http-status-codes-error-handling.md) - [Response Status Codes](https://docs.here.com/parking/docs/response-status-codes.md) - [Get Started](https://docs.here.com/parking/docs/quick-start.md) - [Introduction](https://docs.here.com/parking/docs/readme-summary.md) # HERE Positioning Documentation ## Guides - [Perform clock correction with I/NAV](https://docs.here.com/positioning/docs/client-implementation-consideration.md) - [How to manage correction data](https://docs.here.com/positioning/docs/correction-data-updates.md) - [Accepted GNSS API data types](https://docs.here.com/positioning/docs/data-types.md) - [Code bias overview](https://docs.here.com/positioning/docs/description-code-bias-corrections.md) - [How to mitigate ionospheric errors](https://docs.here.com/positioning/docs/description-ionospheric-corrections.md) - [LPP 18.3.0 ASN.1 Schema](https://docs.here.com/positioning/docs/lpp-18-3-0-asn1-schema.md) - [Send data as protobuf](https://docs.here.com/positioning/docs/protobuf-message.md) - [GNSS Assistance Data](https://docs.here.com/positioning/docs/concept-gnss-assistance.md) - [HD GNSS Correction Data](https://docs.here.com/positioning/docs/concept-hd-gnss-assistance.md) - [Predicted GNSS Assistance Data](https://docs.here.com/positioning/docs/concept-predicted-gnss-assistance.md) - [How to use Single Shot Requests and Subscriptions](https://docs.here.com/positioning/docs/concept-single-shot-request.md) - [HERE Server Environments](https://docs.here.com/positioning/docs/server-environments-concepts.md) - [Terminology](https://docs.here.com/positioning/docs/terminology-concepts.md) - [Get started with the HERE GNSS API](https://docs.here.com/positioning/docs/quick-start.md) - [Introduction to the HERE GNSS API](https://docs.here.com/positioning/docs/readme-developer-s-guide.md) - [How to transfer data with the HERE HD GNSS API](https://docs.here.com/positioning/docs/api-overview.md) - [How to set up a client](https://docs.here.com/positioning/docs/client-implementation.md) - [JSON schema definitions for MQTT messages](https://docs.here.com/positioning/docs/json-messages-1.md) - [Protobuf definitions for MQTT messages](https://docs.here.com/positioning/docs/protobuf-messages.md) - [How to run tests on HERE server environments](https://docs.here.com/positioning/docs/server-environments.md) - [Get started with the HERE platform](https://docs.here.com/positioning/docs/quick-start-platform.md) - [HERE HD GNSS Positioning API Terminology](https://docs.here.com/positioning/docs/terminology.md) - [Introduction to the HERE HD GNSS Positioning API](https://docs.here.com/positioning/docs/readme-guide.md) - [Introduction to the HERE GNSS API](https://docs.here.com/positioning/docs/gnss-dev-guide-intro.md) - [Get started with the HERE GNSS API](https://docs.here.com/positioning/docs/gnss-quick-start.md) - [Perform clock correction with I/NAV](https://docs.here.com/positioning/docs/gnss-client-implementation-consideration.md) - [Correct data with updates](https://docs.here.com/positioning/docs/gnss-correction-data-updates.md) - [Accepted GNSS API data types](https://docs.here.com/positioning/docs/gnss-data-types.md) - [Code bias overview](https://docs.here.com/positioning/docs/gnss-description-code-bias-corrections.md) - [How to correct ionospheric information](https://docs.here.com/positioning/docs/gnss-description-ionospheric-corrections.md) - [LPP 18.3.0 ASN.1 Schema](https://docs.here.com/positioning/docs/gnss-lpp-18-3-0-asn1-schema.md) - [Send data as protobuf](https://docs.here.com/positioning/docs/gnss-protobuf-message.md) - [GNSS Assistance Data](https://docs.here.com/positioning/docs/gnss-concept-gnss-assistance.md) - [HD GNSS Correction Data](https://docs.here.com/positioning/docs/gnss-concept-hd-gnss-assistance.md) - [Predicted GNSS Assistance Data](https://docs.here.com/positioning/docs/gnss-concept-predicted-gnss-assistance.md) - [How to use Single Shot Requests and Subscriptions](https://docs.here.com/positioning/docs/gnss-concept-single-shot-request.md) - [Server Environments](https://docs.here.com/positioning/docs/gnss-server-environments-concepts.md) - [Terminology](https://docs.here.com/positioning/docs/gnss-terminology-concepts.md) - [How to construct a location request](https://docs.here.com/positioning/docs/construct-locate-request.md) - [How to test with the HERE server environment](https://docs.here.com/positioning/docs/server-environment.md) - [Supported network technologies](https://docs.here.com/positioning/docs/supported-network-technologies.md) - [How to optimize data accuracy](https://docs.here.com/positioning/docs/tips-for-data-accuracy.md) - [Get started with the HERE Network Positioning API](https://docs.here.com/positioning/docs/quick-start-developer-guide.md) - [Introduction](https://docs.here.com/positioning/docs/readme-developer-guide.md) - [How to find a position with cell and WLAN](https://docs.here.com/positioning/docs/example-cell-and-wlan.md) - [How to find a position with cellular data](https://docs.here.com/positioning/docs/example-cell.md) - [How to find a position with WLAN](https://docs.here.com/positioning/docs/example-wlan.md) - [Migration Guide](https://docs.here.com/positioning/docs/readme-summary.md) - [Get started with the HERE Network Positioning API v1](https://docs.here.com/positioning/docs/get-started-with-the-here-network-positioning-api-v1.md) - [How to a request an indoor position](https://docs.here.com/positioning/docs/request-first-locate-indoor.md) - [How to request a position](https://docs.here.com/positioning/docs/request-first-locate.md) - [How to get indoor floor level coordinates with Bluetooth](https://docs.here.com/positioning/docs/example-bt-indoor.md) - [How to retrieve coordinates with cell and WLAN](https://docs.here.com/positioning/docs/example-cell-and-wlan-examples.md) - [How to contribute measurements to fix invalid GNSS info](https://docs.here.com/positioning/docs/example-contribute-gsm-invalid-examples.md) - [How to contribute multiple technology measurements](https://docs.here.com/positioning/docs/example-contribute-multi-cell-examples.md) - [How to contribute TDSCDMA, Neighboring Cell, and GNSS information](https://docs.here.com/positioning/docs/example-contribute-tdscdma-nmr.md) - [How to contribute WLAN, GNSS, and Country Info](https://docs.here.com/positioning/docs/example-contribute-wlan-gnss-examples.md) - [How to contribute GSM, WLAN, and GNSS info](https://docs.here.com/positioning/docs/example-contribute-wlan-gsm-examples.md) - [How to contribute WCDMA and WLAN information](https://docs.here.com/positioning/docs/example-contribute-wlan-wlanlocation.md) - [How to retrieve coordinates with GSM](https://docs.here.com/positioning/docs/example-gsm.md) - [How to retrieve coordinates with LTE](https://docs.here.com/positioning/docs/example-lte.md) - [How to get coordinates with WCDMA](https://docs.here.com/positioning/docs/example-wcdma.md) - [How to get coordinates with WLAN](https://docs.here.com/positioning/docs/example-wlan-examples.md) - [How to get indoor floor level coordinates with WLAN](https://docs.here.com/positioning/docs/example-wlan-indoor.md) - [Examples](https://docs.here.com/positioning/docs/examples.md) - [How to construct a request](https://docs.here.com/positioning/docs/how-to-construct-a-request.md) - [How to test in the HERE Server Environment](https://docs.here.com/positioning/docs/server-environment-request-constructing.md) - [How to find a position](https://docs.here.com/positioning/docs/how-to-find-a-position.md) - [Tips for Optimizing Data Accuracy](https://docs.here.com/positioning/docs/tips-for-data-accuracy-finding-positions.md) - [Recommendations for Indoor Positioning WiFi and Bluetooth Scanning](https://docs.here.com/positioning/docs/tips-for-data-accuracy-indoor.md) - [Key Concepts in the HERE Network Positioning API v1](https://docs.here.com/positioning/docs/key-concepts-in-the-here-network-positioning-api-v1.md) - [Supported Network Technologies](https://docs.here.com/positioning/docs/supported-network-technologies-key-concepts.md) - [Error Response](https://docs.here.com/positioning/docs/error-response.md) - [Responses](https://docs.here.com/positioning/docs/responses.md) - [Successful Response for Contribution](https://docs.here.com/positioning/docs/successful-contribute-response.md) - [Successful Response for Locate Request](https://docs.here.com/positioning/docs/successful-locate-response.md) - [Introduction](https://docs.here.com/positioning/docs/what-is.md) ## API Reference - [Locate](https://docs.here.com/positioning/reference/post_locate.md): Request WGS-84 compliant geocoordinates for a location based on 2G/3G/4G cell and/or WLAN measurements. - [API version](https://docs.here.com/positioning/reference/getapiversion.md): Retrieves API Specification version information - [Service health](https://docs.here.com/positioning/reference/gethealth.md): Tests basic health of the service - [OpenAPI specification](https://docs.here.com/positioning/reference/getopenapi.md): Retrieves OpenAPI specification of this API - [Location query](https://docs.here.com/positioning/reference/postlocate.md): Request WGS-84 compliant geographical coordinates for a location based on 2G/3G/4G cell and/or WLAN measurements. # HERE Routing Documentation ## Guides - [HERE Geofencing API v8 - Changelog](https://docs.here.com/routing/docs/geofencing-changelog.md) - [How to check if the asset's position is inside a geofence](https://docs.here.com/routing/docs/asset-position-in-geofence.md) - [How to retrieve geofence geometry](https://docs.here.com/routing/docs/retrieve-geofence-geometry.md) - [How to upload a new layer in HERE Geofencing API v8](https://docs.here.com/routing/docs/upload-layer.md) - [Get started with HERE Geofencing API v8](https://docs.here.com/routing/docs/get-started-geofencing.md) - [Introduction to HERE Geofencing API](https://docs.here.com/routing/docs/intro-geofencing.md) - [Relationship between geofence polygons and layers](https://docs.here.com/routing/docs/geofence-polygons-layers.md) - [Impact of geofence proximity and search radius on asset distance](https://docs.here.com/routing/docs/geofence-proximity-search-radius.md) - [How to read a HERE Geofencing API v8 response](https://docs.here.com/routing/docs/geofencing-reading-response.md) - [Request tracing in HERE Geofencing API v8](https://docs.here.com/routing/docs/geofencing-request-tracing.md) - [Isoline with multiple components](https://docs.here.com/routing/docs/isoline-v8-multi-component-isoline.md) - [Request tracing in HERE Isoline Routing v8](https://docs.here.com/routing/docs/isoline-v8-request-tracing.md) - [HERE Isoline Routing v8 response structure](https://docs.here.com/routing/docs/isoline-v8-response.md) - [Get started with HERE Isoline Routing v8](https://docs.here.com/routing/docs/isoline-v8-get-started.md) - [Introduction to HERE Isoline Routing v8](https://docs.here.com/routing/docs/isoline-v8-intro.md) - [How to avoid features in isoline calculation](https://docs.here.com/routing/docs/isoline-v8-avoid-features.md) - [How to use avoid options](https://docs.here.com/routing/docs/isoline-v8-avoid-options.md) - [How to request consumption-based isolines](https://docs.here.com/routing/docs/isoline-v8-consumption-based-isoline.md) - [How to request an isoline for a specific time](https://docs.here.com/routing/docs/isoline-v8-departure-time-isoline.md) - [How to request distance-based isolines](https://docs.here.com/routing/docs/isoline-v8-distance-isoline.md) - [How to request multi-range isolines](https://docs.here.com/routing/docs/isoline-v8-multi-range-isoline.md) - [How to optimize isolines](https://docs.here.com/routing/docs/isoline-v8-optimization.md) - [How to request isolines for pedestrian use-cases](https://docs.here.com/routing/docs/isoline-v8-pedestrian-isoline.md) - [How to request reverse direction isolines](https://docs.here.com/routing/docs/isoline-v8-reverse-time-isoline.md) - [How to request time-based isolines](https://docs.here.com/routing/docs/isoline-v8-time-isoline.md) - [API changes](https://docs.here.com/routing/docs/isoline-v8-api-changes.md) - [Functional and behavioral changes](https://docs.here.com/routing/docs/isoline-v8-functional-behavioral-changes.md) - [Known Issues and workarounds](https://docs.here.com/routing/docs/isoline-v8-known-issues.md) - [Limitations and workarounds](https://docs.here.com/routing/docs/isoline-v8-limitations-workarounds.md) - [Resolved issues](https://docs.here.com/routing/docs/isoline-v8-resolved-issues.md) - [Overview](https://docs.here.com/routing/docs/isoline-v8-release-notes.md) - [Flexible mode](https://docs.here.com/routing/docs/flexible-mode.md) - [Modes in HERE Matrix Routing API v8](https://docs.here.com/routing/docs/matrix-modes.md) - [Profile mode](https://docs.here.com/routing/docs/profile-mode.md) - [Region mode](https://docs.here.com/routing/docs/region-mode.md) - [Profiles in matrix calculations](https://docs.here.com/routing/docs/matrix-profiles.md) - [Regions and regionDefinition](https://docs.here.com/routing/docs/matrix-region.md) - [Traffic in HERE Matrix Routing API v8](https://docs.here.com/routing/docs/matrix-traffic.md) - [Truck parameters in HERE Matrix Routing API v8](https://docs.here.com/routing/docs/matrix-truck-parameters.md) - [Violation mapping in HERE Matrix Routing API v8](https://docs.here.com/routing/docs/matrix-violation-mapping.md) - [Waypoint parameters in HERE Matrix Routing API v8](https://docs.here.com/routing/docs/matrix-waypoint-parameters.md) - [Routing matrix](https://docs.here.com/routing/docs/matrix.md) - [Get started with HERE Matrix Routing API v8](https://docs.here.com/routing/docs/get-started-matrix.md) - [Introduction to HERE Matrix Routing API v8](https://docs.here.com/routing/docs/matrix-routing-intro.md) - [Transport modes available in HERE Matrix Routing API v8](https://docs.here.com/routing/docs/matrix-transport-modes.md) - [How to calculate a matrix in Flexible mode](https://docs.here.com/routing/docs/calculate-flexible.md) - [How to calculate a matrix in Profile mode](https://docs.here.com/routing/docs/calculate-profile.md) - [How to calculate a matrix in Region mode](https://docs.here.com/routing/docs/calculate-region.md) - [API changes](https://docs.here.com/routing/docs/matrix-api-changes.md) - [Functional and behavioral changes](https://docs.here.com/routing/docs/matrix-functional-behavioral-changes.md) - [Known issues](https://docs.here.com/routing/docs/matrix-known-issues.md) - [Resolved issues](https://docs.here.com/routing/docs/matrix-resolved-issues.md) - [Overview](https://docs.here.com/routing/docs/matrix-rn-overview.md) - [HERE Route Matching API v8 - Changelog](https://docs.here.com/routing/docs/route-matching-changelog.md) - [HERE Route Matching API v8 request examples](https://docs.here.com/routing/docs/example-requests-route-matching.md) - [How to detect speeding violations with GPS traces](https://docs.here.com/routing/docs/detect-speeding-gps.md) - [How to detect traffic violations in GPS traces](https://docs.here.com/routing/docs/detect-traffic-violations.md) - [How to match GPS traces to the most probable route](https://docs.here.com/routing/docs/match-traces-to-routes.md) - [Get started with HERE Route Matching API v8](https://docs.here.com/routing/docs/get-started-route-matching.md) - [Introduction to HERE Route Matching API v8](https://docs.here.com/routing/docs/intro-route-matching.md) - [Custom road network overlays - deprecated](https://docs.here.com/routing/docs/custom-routes.md) - [Real-time driver alerts and Electronic Horizon](https://docs.here.com/routing/docs/driver-alerts-and-electronic-horizon.md) - [Legal driver rest time regulations and parameters](https://docs.here.com/routing/docs/driver-rest-time.md) - [Driving analytics and risk assessment data](https://docs.here.com/routing/docs/driving-analytics.md) - [HERE Route Matching API v8 limitations for Japan](https://docs.here.com/routing/docs/japan-route-matching.md) - [Request tracing in HERE Route Matching API v8](https://docs.here.com/routing/docs/request-tracing-route-matching.md) - [Road link attributes in HERE Route Matching API v8 response](https://docs.here.com/routing/docs/road-link-attributes.md) - [How to control routing with access restrictions](https://docs.here.com/routing/docs/routing-access-restrictions.md) - [Toll cost calculation and route optimization](https://docs.here.com/routing/docs/toll-cost-route-matching.md) - [GPS trace file formats and accuracy requirements](https://docs.here.com/routing/docs/trace-files.md) - [Track vehicles with real-time ETA predictions](https://docs.here.com/routing/docs/track-and-route-route-matching.md) - [Truck restrictions and environmental zone rules](https://docs.here.com/routing/docs/truck-restrictions-env-zones.md) - [Vehicle types and measures](https://docs.here.com/routing/docs/vehicle-types-and-measures-route-matching.md) - [Warning codes reference for HERE Route Matching API v8](https://docs.here.com/routing/docs/warning-codes.md) - [Fuel consumption](https://docs.here.com/routing/docs/routing-v8-consumption-ice-empirical.md) - [Calculate fuel consumption and CO2 emissions per section](https://docs.here.com/routing/docs/routing-v8-calculate-fuel-consumption.md) - [Calculate a route with driver schedule](https://docs.here.com/routing/docs/routing-v8-driver-schedule.md) - [Specify preferred language for route data](https://docs.here.com/routing/docs/routing-v8-language-preferences.md) - [Supported languages](https://docs.here.com/routing/docs/routing-v8-supported-languages.md) - [Re-evaluate route with different options](https://docs.here.com/routing/docs/routing-v8-reevaluate-route.md) - [URL encoding in HERE Routing API v8](https://docs.here.com/routing/docs/routing-v8-request-encoding.md) - [Request tracing in HERE Routing API v8](https://docs.here.com/routing/docs/routing-v8-request-tracing.md) - [How to import a route from traces](https://docs.here.com/routing/docs/routing-v8-route-import.md) - [Ferry usage in routing](https://docs.here.com/routing/docs/routing-v8-using-ferries.md) - [What is a route handle](https://docs.here.com/routing/docs/routing-v8-whatis-route-handle.md) - [Time Domain additional syntax](https://docs.here.com/routing/docs/routing-v8-time-domain-additional-syntax.md) - [Time Domain basics](https://docs.here.com/routing/docs/routing-v8-time-domain-basics.md) - [Time Domain fuzzy terms](https://docs.here.com/routing/docs/routing-v8-time-domain-fuzzy-terms.md) - [What is an action](https://docs.here.com/routing/docs/routing-v8-action.md) - [Duration, baseDuration, typicalDuration, mlDuration](https://docs.here.com/routing/docs/routing-v8-duration.md) - [What is a notice](https://docs.here.com/routing/docs/routing-v8-notice.md) - [Route geometry in HERE Routing API v8](https://docs.here.com/routing/docs/routing-v8-route-geometry.md) - [What are route sections](https://docs.here.com/routing/docs/routing-v8-route-section.md) - [What is a span](https://docs.here.com/routing/docs/routing-v8-span.md) - [Car routing coverage](https://docs.here.com/routing/docs/routing-v8-car-routing-coverage.md) - [Countries which support state exclusion](https://docs.here.com/routing/docs/routing-v8-countries-with-state-exclusion.md) - [Country-Specific coverage exceptions](https://docs.here.com/routing/docs/routing-v8-country-exceptions.md) - [Coverage levels](https://docs.here.com/routing/docs/routing-v8-coverage-levels.md) - [EV car routing coverage](https://docs.here.com/routing/docs/routing-v8-ev-routing-coverage.md) - [Countries with intermediate coverage](https://docs.here.com/routing/docs/routing-v8-intermediate-countries.md) - [Navigable countries](https://docs.here.com/routing/docs/routing-v8-navigable-countries.md) - [Country with entry map coverage](https://docs.here.com/routing/docs/routing-v8-non-navigable-countries.md) - [Scooter routing coverage](https://docs.here.com/routing/docs/routing-v8-scooter-routing-coverage.md) - [Truck routing coverage](https://docs.here.com/routing/docs/routing-v8-truck-routing-coverage.md) - [Auxiliary consumption at waypoints](https://docs.here.com/routing/docs/routing-v8-aux-consumption-at-waypoint.md) - [Calculate consumption per section](https://docs.here.com/routing/docs/routing-v8-calculate-consumption-section.md) - [Calculate a route with a minimum arrival charge](https://docs.here.com/routing/docs/routing-v8-calculate-route-min-charge.md) - [Calculate a route with charging along the way](https://docs.here.com/routing/docs/routing-v8-calculate-route-with-charging.md) - [Empirical consumption model for EVs](https://docs.here.com/routing/docs/routing-v8-consumption-ev-empirical.md) - [Physical consumption model for EVs](https://docs.here.com/routing/docs/routing-v8-consumption-ev-physical.md) - [Calculate state of charge along a route](https://docs.here.com/routing/docs/routing-v8-display-state-of-charge-en-route.md) - [EV routing in HERE Routing API v8](https://docs.here.com/routing/docs/routing-v8-ev-routing.md) - [Calculate a route with user-introduced charging stops](https://docs.here.com/routing/docs/routing-v8-user-introduced-charging-stops.md) - [Adjust the current route after a deviation](https://docs.here.com/routing/docs/routing-v8-adjust-route-after-deviation.md) - [Instructions for turn-by-turn navigation](https://docs.here.com/routing/docs/routing-v8-guidance.md) - [Update the current route](https://docs.here.com/routing/docs/routing-v8-update-current-route.md) - [How to get alternative routes](https://docs.here.com/routing/docs/routing-v8-get-alternative-routes.md) - [Instructions for display](https://docs.here.com/routing/docs/routing-v8-instructions-display.md) - [Request instructions with different types of units](https://docs.here.com/routing/docs/routing-v8-units-of-measurement.md) - [Shaping routes with passthrough waypoints](https://docs.here.com/routing/docs/routing-v8-passthrough-waypoint.md) - [Use a specific ferry](https://docs.here.com/routing/docs/routing-v8-use-specific-ferry.md) - [Route summary](https://docs.here.com/routing/docs/routing-v8-route-summary.md) - [Calculate duration for route through ferry](https://docs.here.com/routing/docs/routing-v8-duration-route-ferry.md) - [No-through restrictions](https://docs.here.com/routing/docs/routing-v8-no-through-restrictions.md) - [Seasonal closures](https://docs.here.com/routing/docs/routing-v8-seasonal-closures.md) - [Time-dependent restrictions](https://docs.here.com/routing/docs/routing-v8-time-dependent-restrictions.md) - [Time-dependent routing](https://docs.here.com/routing/docs/routing-v8-time-dependent-routing.md) - [Vehicle properties](https://docs.here.com/routing/docs/routing-v8-vehicle-properties.md) - [How to avoid areas in routes](https://docs.here.com/routing/docs/routing-v8-avoid-area.md) - [How to avoid segments in routes](https://docs.here.com/routing/docs/routing-v8-avoid-segments.md) - [How to calculate a route with specific U-turn permission at stopover waypoint](https://docs.here.com/routing/docs/routing-v8-u-turn-permission.md) - [Avoidance](https://docs.here.com/routing/docs/routing-v8-avoidance.md) - [How to exclude territories from routing](https://docs.here.com/routing/docs/routing-v8-exclude-territories.md) - [How to use high occupancy lanes](https://docs.here.com/routing/docs/routing-v8-high-occupancy-lanes.md) - [How to use routing zones](https://docs.here.com/routing/docs/routing-v8-routing-zones.md) - [How to use speed cap](https://docs.here.com/routing/docs/routing-v8-speed-cap.md) - [Get started with HERE Routing API v8](https://docs.here.com/routing/docs/routing-v8-get-started.md) - [Introduction to HERE Routing API v8](https://docs.here.com/routing/docs/routing-v8-intro.md) - [HERE Routing API Reference Client](https://docs.here.com/routing/docs/routing-v8-reference-client.md) - [Get toll cost information for route](https://docs.here.com/routing/docs/routing-v8-tolls-for-route.md) - [Get toll cost for multi-section route](https://docs.here.com/routing/docs/routing-v8-tolls-multileg.md) - [Toll cost spanning across multiple toll system providers](https://docs.here.com/routing/docs/routing-v8-tolls-multiple-systems.md) - [Get toll cost with route import service](https://docs.here.com/routing/docs/routing-v8-tolls-routeimport.md) - [Get toll costs when paying with transponders](https://docs.here.com/routing/docs/routing-v8-tolls-transponders.md) - [Get total toll cost excluding vignette price](https://docs.here.com/routing/docs/routing-v8-total-toll-no-vignette.md) - [Get total toll cost with vignette price](https://docs.here.com/routing/docs/routing-v8-total-toll-with-vignette.md) - [Traffic in routing](https://docs.here.com/routing/docs/routing-v8-traffic-in-routing.md) - [Get traffic incidents in route spans](https://docs.here.com/routing/docs/routing-v8-traffic-incidents-spans.md) - [How to customize walking speed](https://docs.here.com/routing/docs/routing-v8-walking-speed.md) - [Bicycle routing](https://docs.here.com/routing/docs/routing-v8-bicycle-routing.md) - [Bus and taxi routing](https://docs.here.com/routing/docs/routing-v8-bus-taxi-routing.md) - [Car routing](https://docs.here.com/routing/docs/routing-v8-car-routing.md) - [Network-restricted truck](https://docs.here.com/routing/docs/routing-v8-network-restricted-truck.md) - [Scooter routing](https://docs.here.com/routing/docs/routing-v8-scooter-routing.md) - [HERE Routing API v8 Transport modes overview](https://docs.here.com/routing/docs/routing-v8-transport-modes-overview.md) - [Truck routing](https://docs.here.com/routing/docs/routing-v8-truck-routing.md) - [How to specify arrival direction at destination](https://docs.here.com/routing/docs/routing-v8-arrival-direction.md) - [How to set waypoints based on GPS](https://docs.here.com/routing/docs/routing-v8-gps-waypoints.md) - [How to add via waypoints to a route](https://docs.here.com/routing/docs/routing-v8-intermediate-waypoints.md) - [How to calculate route to the correct side of the street](https://docs.here.com/routing/docs/routing-v8-route-sideofstreet.md) - [How to set waypoints based on UI interactions](https://docs.here.com/routing/docs/routing-v8-ui-interactions-waypoints.md) - [How to set waypoints based on search results](https://docs.here.com/routing/docs/routing-v8-waypoints-from-search.md) - [Waypoints overview](https://docs.here.com/routing/docs/routing-v8-waypoints-overview.md) - [How to track weight change on waypoints](https://docs.here.com/routing/docs/routing-v8-waypoints-weight-change.md) - [Changes](https://docs.here.com/routing/docs/routing-v8-changes.md) - [API changes](https://docs.here.com/routing/docs/routing-v8-api-changes.md) - [Functional and behavioral changes](https://docs.here.com/routing/docs/routing-v8-functional-behavioral-changes.md) - [Known issues and workarounds](https://docs.here.com/routing/docs/routing-v8-known-issues.md) - [Resolved issues](https://docs.here.com/routing/docs/routing-v8-resolved-issues.md) - [Overview](https://docs.here.com/routing/docs/routing-v8-release-notes.md) - [HERE Waypoints Sequence API v8 - Changelog](https://docs.here.com/routing/docs/waypoints-sequence-changelog.md) - [How to use the break times parameter](https://docs.here.com/routing/docs/break-times.md) - [How to save time with clusters of destinations](https://docs.here.com/routing/docs/example-car-clustered.md) - [How to optimize a car route by traffic information](https://docs.here.com/routing/docs/example-car.md) - [How to optimize a sequence for time constraints](https://docs.here.com/routing/docs/example-constraints.md) - [How to find EV charging points](https://docs.here.com/routing/docs/example-ev-charging.md) - [How to obtain traffic info and rest time constraints](https://docs.here.com/routing/docs/example-truck-rest.md) - [How to request a truck waypoints sequence](https://docs.here.com/routing/docs/truck-waypoints-sequence.md) - [Get started with HERE Waypoints Sequence API v8](https://docs.here.com/routing/docs/get-started-waypoints-sequence.md) - [Introduction to HERE Waypoints Sequence API v8](https://docs.here.com/routing/docs/intro-waypoints-sequence.md) - [Key concepts - HERE Waypoints Sequence API v8](https://docs.here.com/routing/docs/key-concepts-waypoints-sequence.md) - [Japan map limitations](https://docs.here.com/routing/docs/japan-waypoints-sequence.md) - [How to optimize waypoints](https://docs.here.com/routing/docs/optimizing-waypoints.md) - [How to do pickup along the route](https://docs.here.com/routing/docs/pickup-waypoints.md) - [How to read a pickup response](https://docs.here.com/routing/docs/reading-pickup-response.md) - [How to read a HERE Waypoints Sequence API v8 response](https://docs.here.com/routing/docs/reading-response-waypoints-sequence.md) - [How to construct a request in HERE Waypoints Sequence API v8](https://docs.here.com/routing/docs/request-constructing.md) ## API Reference - [Simple and fast search for geometries on HERE Map Content layers, extensible with custom geometry layers](https://docs.here.com/routing/reference/geofence.md): Simple and fast search for geometries on HERE Map Content layers, extensible with custom geometry layers - [Simple and fast access to your custom geofence attributes](https://docs.here.com/routing/reference/geofenceattributes.md): Simple and fast access to your custom geofence attributes - [Simple and fast search for geometries on HERE Map Content layers, extensible with custom geometry layers](https://docs.here.com/routing/reference/geofencepost.md): Simple and fast search for geometries on HERE Map Content layers, extensible with custom geometry layers - [Delete some of my Geometry Layers. To delete complete maps, leave the layerNames field in parameter 'id' empty](https://docs.here.com/routing/reference/v8deletemapslayers.md) - [Modify Geometries in Existing Layers](https://docs.here.com/routing/reference/v8modifypost.md): Modify geometries using an HTTP POST request. After receiving the response, there is a delay of several seconds to compile, store and make the modified geometries available in the service. Note: The level (tile grid size) of the layer can only be changed by re-uploading the whole layer, not as a modification operation. - [Import Geometries in a WKT or Shape File](https://docs.here.com/routing/reference/v8uploadpost.md): Import polygons, polylines or points in WKT (Wellknown Text) or Shapefile format geometries using an HTTP POST request. A layer can contain only one geometry type - polygons, polylines or points, but not a mix of different types. After the response there is a delay of several seconds to compile, store and make the geometries available in the service. - [Match GPS traces to get the most probably driven path. Use &routeMatch=1 for default route matching behavior. Compatible with version 2 route matching.](https://docs.here.com/routing/reference/matchroutev8compatibilitytov2get.md) - [Match GPS traces to get the most probable driven path. Must use `&routeMatch=1` for default route matching behavior. Compatible with version 2 route matching.](https://docs.here.com/routing/reference/matchroutev8compatibilitytov2post.md) - [Submit an overlay map for customized route matching.- Deprecated](https://docs.here.com/routing/reference/overlayuploadv8.md): Submit an overlay map with custom modifications, such as block road links, remove restrictions from road links, or insert new road links into the network. The modifications that you submit, as part of your overlay maps, are only visible to you but not to other customers. Also, these modifications are not uploaded to the official HERE map. Route matching can consider overlay maps. Note: This feature is deprecated. - [Health status of the service](https://docs.here.com/routing/reference/gethealth-1.md): Returns the health of the service - [Retrieves this API specification in OpenAPI 3 format](https://docs.here.com/routing/reference/getopenapi-1.md) - [Full version of the API](https://docs.here.com/routing/reference/getversion-1.md): Returns the version of the service - [Health status of the service](https://docs.here.com/routing/reference/gethealth-3.md): Returns the health of the service - [Retrieves this API specification in OpenAPI 3 format](https://docs.here.com/routing/reference/getopenapi-3.md) - [Full version of the API](https://docs.here.com/routing/reference/getversion-3.md): Returns the version of the service - [Get Isolines for specified ranges around a center point](https://docs.here.com/routing/reference/calculateisolines-1.md): Retrieves a list of polylines that captures the approximate reachable area from the specified center point constrained by the provided parameters. - [Get Isolines for specified ranges around a center point](https://docs.here.com/routing/reference/calculateisolines.md): Retrieves a list of polylines that captures the approximate reachable area from the specified center point constrained by the provided parameters. - [Calculate isolines via POST](https://docs.here.com/routing/reference/calculateisolinespost-1.md): Retrieves a list of polylines that captures the approximate reachable area from the specified center point constrained by the provided parameters. At the moment, only select parameters are permitted in the POST payload. In particular, those parameters that due to request size may be limited in the query string. See the request body section below. These parameters can be provided either in the query string or in the POST body. All other parameters can only be provided in the query string at the moment. - [Calculate isolines via POST](https://docs.here.com/routing/reference/calculateisolinespost.md): Retrieves a list of polylines that captures the approximate reachable area from the specified center point constrained by the provided parameters. At the moment, only select parameters are permitted in the POST payload. In particular, those parameters that due to request size may be limited in the query string. See the request body section below. These parameters can be provided either in the query string or in the POST body. All other parameters can only be provided in the query string at the moment. - [Health status of the service](https://docs.here.com/routing/reference/gethealth.md): Returns HTTP status code describing the health of the service. - [This API specification](https://docs.here.com/routing/reference/getopenapi.md): Returns this API specification in YAML format. - [Full version of the API](https://docs.here.com/routing/reference/getversion.md): Full version of the API implemented by the service. - [List supported predefined profiles.](https://docs.here.com/routing/reference/getprofiles.md): It is guaranteed that with each minor API change profiles are only added to this list, but are never removed or modified. - [Result of successfully completed calculation.](https://docs.here.com/routing/reference/getmatrix.md) - [Status of submitted matrix calculation](https://docs.here.com/routing/reference/getmatrixstatus.md): Returns the status of a submitted asynchronous matrix calculation. Redirects to the matrix result if the calculation is successfully completed. **NOTE:** Please make sure to directly use the `statusUrl` returned by the /v8/matrix call to check this status endpoint, including the provided region URL. Due to global load balancing, using matrix.router.hereapi.com for the status endpoint may end up resolving to a different region than the initial calculation, resulting in a 404 error. - [Submit matrix for calculation](https://docs.here.com/routing/reference/postmatrix.md): Calculates a routing matrix based on provided `origins` and `destinations`. Response will be provided synchronously (see `200` response) or asynchronously (see `202` response) depending on the `async` query parameter. Travel times will be included by default i.e., when `matrixAttributes` parameter is not specified. For other supported attributes, the corresponding flags must be specified in `matrixAttributes`. Maximum request size is 10 MiB (uncompressed). - [Get profile definition by its ID.](https://docs.here.com/routing/reference/getprofile.md) - [Health status of the service](https://docs.here.com/routing/reference/gethealth-2.md): Returns the health of the service - [Retrieves this API specification in OpenAPI 3 format](https://docs.here.com/routing/reference/getopenapi-2.md) - [Full version of the API](https://docs.here.com/routing/reference/getversion-2.md): Returns the version of the service - [Health status of the service](https://docs.here.com/routing/reference/gethealth-4.md): Returns the health of the service - [Retrieves this API specification in OpenAPI 3 format](https://docs.here.com/routing/reference/getopenapi-4.md) - [Full version of the API](https://docs.here.com/routing/reference/getversion-4.md): Returns the version of the service - [Calculate routes via GET](https://docs.here.com/routing/reference/calculateroutes-1.md): Calculates a route using a generic vehicle/pedestrian mode, e.g. car, truck, pedestrian, etc... - [Calculate routes via GET](https://docs.here.com/routing/reference/calculateroutes.md): Calculates a route using a generic vehicle/pedestrian mode, e.g. car, truck, pedestrian, etc... - [Calculate routes via POST](https://docs.here.com/routing/reference/calculateroutespost-1.md): Calculates a route using a generic vehicle/pedestrian mode, e.g. car, truck, pedestrian, etc... At the moment, only selected parameters are permitted in the POST body, particularly those that may be restricted in the query string due to request size limitations. See the request body section below for details. All other parameters must be provided in the query string. If a parameter is provided in both the query string and the POST body, their values are merged. Post body size limit is 10MiB. - [Calculate routes via POST](https://docs.here.com/routing/reference/calculateroutespost.md): Calculates a route using a generic vehicle/pedestrian mode, e.g. car, truck, pedestrian, etc... At the moment, only selected parameters are permitted in the POST body, particularly those that may be restricted in the query string due to request size limitations. See the request body section below for details. All other parameters must be provided in the query string. If a parameter is provided in both the query string and the POST body, their values are merged. Post body size limit is 10MiB. - [Get route by handle via GET](https://docs.here.com/routing/reference/getroutesbyhandle-1.md): Decodes and returns a route from a previously calculated route handle. **Disclaimer: A route handle is not suitable for persistent route storage! It can be invalidated at any time.** A route handle encodes a previously calculated route. A route can be decoded from a handle as long as the service uses the same map data and encoding that were used when retrieving the handle. Thus it is suitable for caching routes compactly. It can be used to retrieve updated traffic information or other data along the route. However, a user should be prepared to recalculate the route when decoding the handle fails. All parameters of the `/routes` endpoint are supported, except for `destination`, `via`, `alternatives` and `routingMode`. See also the `return` parameter of `/routes` endpoint. The `origin` parameter can be provided to update the start of the previously calculated route. The `transportMode` parameter does not have to match the transport mode previously used for route calculation. However, when using a different transport mode, the request may fail, e.g. when the route has road segments forbidden for the provided transport mode. Please refer to the Developer Guide for more information and examples. - [Get route by handle via GET](https://docs.here.com/routing/reference/getroutesbyhandle.md): Decodes and returns a route from a previously calculated route handle. **Disclaimer: A route handle is not suitable for persistent route storage! It can be invalidated at any time.** A route handle encodes a previously calculated route. A route can be decoded from a handle as long as the service uses the same map data and encoding that were used when retrieving the handle. Thus it is suitable for caching routes compactly. It can be used to retrieve updated traffic information or other data along the route. However, a user should be prepared to recalculate the route when decoding the handle fails. All parameters of the `/routes` endpoint are supported, except for `destination`, `via`, `alternatives` and `routingMode`. See also the `return` parameter of `/routes` endpoint. The `origin` parameter can be provided to update the start of the previously calculated route. The `transportMode` parameter does not have to match the transport mode previously used for route calculation. However, when using a different transport mode, the request may fail, e.g. when the route has road segments forbidden for the provided transport mode. Please refer to the Developer Guide for more information and examples. - [Get route by handle via POST](https://docs.here.com/routing/reference/getroutesbyhandlepost-1.md): Decodes and returns a route from a previously calculated route handle. **Disclaimer: A route handle is not suitable for persistent route storage! It can be invalidated at any time.** A route handle encodes a previously calculated route. A route can be decoded from a handle as long as the service uses the same map data and encoding that were used when retrieving the handle. Thus it is suitable for caching routes compactly. It can be used to retrieve updated traffic information or other data along the route. However, a user should be prepared to recalculate the route when decoding the handle fails. All parameters of the `/routes` endpoint are supported, except for `destination`, `via`, `alternatives` and `routingMode`. See also the `return` parameter of `/routes` endpoint. The `origin` parameter can be provided to update the start of the previously calculated route. The `transportMode` parameter does not have to match the transport mode previously used for route calculation. However, when using a different transport mode, the request may fail, e.g. when the route has road segments forbidden for the provided transport mode. Only selected parameters are permitted in the POST body. See the request body section below for details. If a parameter is provided in both the query string and the POST body, their values are merged. Post body size limit is 10MiB. Please refer to the Developer Guide for more information and examples. - [Get route by handle via POST](https://docs.here.com/routing/reference/getroutesbyhandlepost.md): Decodes and returns a route from a previously calculated route handle. **Disclaimer: A route handle is not suitable for persistent route storage! It can be invalidated at any time.** A route handle encodes a previously calculated route. A route can be decoded from a handle as long as the service uses the same map data and encoding that were used when retrieving the handle. Thus it is suitable for caching routes compactly. It can be used to retrieve updated traffic information or other data along the route. However, a user should be prepared to recalculate the route when decoding the handle fails. All parameters of the `/routes` endpoint are supported, except for `destination`, `via`, `alternatives` and `routingMode`. See also the `return` parameter of `/routes` endpoint. The `origin` parameter can be provided to update the start of the previously calculated route. The `transportMode` parameter does not have to match the transport mode previously used for route calculation. However, when using a different transport mode, the request may fail, e.g. when the route has road segments forbidden for the provided transport mode. Only selected parameters are permitted in the POST body. See the request body section below for details. If a parameter is provided in both the query string and the POST body, their values are merged. Post body size limit is 10MiB. Please refer to the Developer Guide for more information and examples. - [Calculate a route from a sequence of trace points](https://docs.here.com/routing/reference/importroute-1.md): Creates a route from a sequence of trace points. Post body size limit is 10MiB. For best results, use 1Hz GPS data or any points that have a spacing of a few meters between them. For traces with less frequent points, the Route Import service will attempt to create an approximate reconstruction. In some situations, when consecutive points are too far apart (more than about 30 kilometers of on-road distance), they could be considered unreachable and one of them could fail to be matched. - [Calculate a route from a sequence of trace points](https://docs.here.com/routing/reference/importroute.md): Creates a route from a sequence of trace points. Post body size limit is 10MiB. For best results, use 1Hz GPS data or any points that have a spacing of a few meters between them. For traces with less frequent points, the Route Import service will attempt to create an approximate reconstruction. In some situations, when consecutive points are too far apart (more than about 30 kilometers of on-road distance), they could be considered unreachable and one of them could fail to be matched. - [/v8/findsequence2](https://docs.here.com/routing/reference/findsequenceget.md): Compute best Sequence for Waypoints (Travelling Salesman Problem). - [/v8/findsequence2](https://docs.here.com/routing/reference/findsequencepost.md): Compute best Sequence for Waypoints (Travelling Salesman Problem). # HERE Safety Cameras Documentation ## Guides - [Response data types](https://docs.here.com/safety-cameras/docs/response-data-types.md) - [Response status codes](https://docs.here.com/safety-cameras/docs/response-status-codes.md) - [ Introduction](https://docs.here.com/safety-cameras/docs/introduction.md) - [Changelog](https://docs.here.com/safety-cameras/docs/safety-cameras-changelog.md) - [How to get a list of safety cameras inside a bounding box](https://docs.here.com/safety-cameras/docs/example-bbox-request.md) - [How to list safety cameras around a position](https://docs.here.com/safety-cameras/docs/example-circle-request.md) - [How to get a list of safety cameras along a route](https://docs.here.com/safety-cameras/docs/example-corridor-request.md) - [How to retrieve a list of safety cameras](https://docs.here.com/safety-cameras/docs/example-request.md) - [How to get a list of safety cameras in a geospatial area](https://docs.here.com/safety-cameras/docs/resource-data-spatial.md) - [How to get a list of all safety cameras in a country](https://docs.here.com/safety-cameras/docs/resource-data.md) ## Changelog - [added-active-camera-flag](https://docs.here.com/safety-cameras/changelog/added-active-camera-flag.md) - [removed-german-cameras-due](https://docs.here.com/safety-cameras/changelog/removed-german-cameras-due.md) - [added-japan-static-cameras](https://docs.here.com/safety-cameras/changelog/added-japan-static-cameras.md) - [added-argentina-and-brazil](https://docs.here.com/safety-cameras/changelog/added-argentina-and-brazil.md) - [decrease-default-corridor-width](https://docs.here.com/safety-cameras/changelog/decrease-default-corridor-width.md) # HERE SDK Documentation ## Guides - [Examples and use cases](https://docs.here.com/here-sdk/docs/android-venues-use-cases.md) - [Use the Indoor Maps component](https://docs.here.com/here-sdk/docs/android-venues.md) - [Access map data on-the-fly](https://docs.here.com/here-sdk/docs/android-access-map-data-on-the-fly.md) - [Adjust the map view](https://docs.here.com/here-sdk/docs/android-camera.md) - [Add custom layers](https://docs.here.com/here-sdk/docs/android-custom-map-styles.md) - [Interact with the map](https://docs.here.com/here-sdk/docs/android-gestures.md) - [Add predefined map features](https://docs.here.com/here-sdk/docs/android-map-features.md) - [Add map items](https://docs.here.com/here-sdk/docs/android-map-items.md) - [Add predefined map schemes](https://docs.here.com/here-sdk/docs/android-map-schemes.md) - [Create styles with the HERE Style Editor](https://docs.here.com/here-sdk/docs/android-map-style-editor.md) - [Get started with Maps](https://docs.here.com/here-sdk/docs/android-maps.md) - [Electronic Horizon](https://docs.here.com/here-sdk/docs/android-electronic-horizon.md) - [Build a navigation app](https://docs.here.com/here-sdk/docs/android-navigation-app-tutorial.md) - [Handle route deviations](https://docs.here.com/here-sdk/docs/android-navigation-deviation.md) - [Get lane assistance](https://docs.here.com/here-sdk/docs/android-navigation-lane-guidance.md) - [Optimize navigation](https://docs.here.com/here-sdk/docs/android-navigation-optimization.md) - [Navigate trucks](https://docs.here.com/here-sdk/docs/android-navigation-truck.md) - [Add voice guidance](https://docs.here.com/here-sdk/docs/android-navigation-voice-guidance.md) - [Stay aware with warners](https://docs.here.com/here-sdk/docs/android-navigation-warners.md) - [Get started with Navigation](https://docs.here.com/here-sdk/docs/android-navigation.md) - [Install map data](https://docs.here.com/here-sdk/docs/android-offline-maps-installation.md) - [Alternative options](https://docs.here.com/here-sdk/docs/android-offline-maps-options.md) - [Offline routing features](https://docs.here.com/here-sdk/docs/android-offline-maps-routing.md) - [Offline search features](https://docs.here.com/here-sdk/docs/android-offline-maps-search.md) - [Update map data](https://docs.here.com/here-sdk/docs/android-offline-maps-update.md) - [Get started with offline maps](https://docs.here.com/here-sdk/docs/android-offline-maps.md) - [Enable background updates](https://docs.here.com/here-sdk/docs/android-get-locations-enable-background-updates.md) - [Optimize Positioning](https://docs.here.com/here-sdk/docs/android-get-locations-optimization.md) - [Get started with Positioning](https://docs.here.com/here-sdk/docs/android-get-locations.md) - [Build a GPX recording app](https://docs.here.com/here-sdk/docs/android-hiking-app-tutorial.md) - [Advanced routing features](https://docs.here.com/here-sdk/docs/android-routing-advanced.md) - [Get routes for electric vehicles](https://docs.here.com/here-sdk/docs/android-routing-ev.md) - [Add route options](https://docs.here.com/here-sdk/docs/android-routing-options.md) - [Add UI building blocks](https://docs.here.com/here-sdk/docs/android-routing-ui.md) - [Get started with Routing](https://docs.here.com/here-sdk/docs/android-routing.md) - [Search & Geocoding features](https://docs.here.com/here-sdk/docs/android-search-geocoding.md) - [Get started with Search](https://docs.here.com/here-sdk/docs/android-search.md) - [Traffic Engine](https://docs.here.com/here-sdk/docs/android-traffic-engine.md) - [Additional traffic features](https://docs.here.com/here-sdk/docs/android-traffic-features.md) - [Visualize traffic on routes](https://docs.here.com/here-sdk/docs/android-traffic-render.md) - [Update traffic information](https://docs.here.com/here-sdk/docs/android-traffic-update.md) - [Get started with Traffic](https://docs.here.com/here-sdk/docs/android-traffic.md) - [Components](https://docs.here.com/here-sdk/docs/android-components.md) - [Set a scope to differentiate multiple apps](https://docs.here.com/here-sdk/docs/android-multiple-apps.md) - [Get started](https://docs.here.com/here-sdk/docs/android-get-started.md) - [Coverage information](https://docs.here.com/here-sdk/docs/android-coverage-information.md) - [Licenses explained](https://docs.here.com/here-sdk/docs/android-introduction-editions.md) - [Feature list](https://docs.here.com/here-sdk/docs/android-introduction-feature-list.md) - [Minimum requirements](https://docs.here.com/here-sdk/docs/android-introduction-requirements.md) - [Introduction](https://docs.here.com/here-sdk/docs/android-readme.md) - [Maps and services](https://docs.here.com/here-sdk/docs/android-customization-catalogs.md) - [UI components](https://docs.here.com/here-sdk/docs/android-customization-ui.md) - [Use custom map catalogs](https://docs.here.com/here-sdk/docs/android-maps-byod.md) - [Best practices](https://docs.here.com/here-sdk/docs/android-key-concepts.md) - [Manage data and OTA costs](https://docs.here.com/here-sdk/docs/android-optimization.md) - [Engines](https://docs.here.com/here-sdk/docs/android-tips-engines.md) - [Supplemental information](https://docs.here.com/here-sdk/docs/android-tips-supplements.md) - [Community and support](https://docs.here.com/here-sdk/docs/android-tips-support.md) - [Debugging and troubleshooting](https://docs.here.com/here-sdk/docs/android-tips-troubleshooting.md) - [Update from previous versions](https://docs.here.com/here-sdk/docs/android-update-version.md) - [FAQ](https://docs.here.com/here-sdk/docs/android-use-cases.md) - [Integration with Android Auto](https://docs.here.com/here-sdk/docs/android-android-auto.md) - [Examples](https://docs.here.com/here-sdk/docs/android-examples.md) - [Integrate the HERE SDK](https://docs.here.com/here-sdk/docs/android-integrate-here-sdk.md) - [Add a map view with Jetpack Compose](https://docs.here.com/here-sdk/docs/android-map-view-jetpack-compose.md) - [Tutorials](https://docs.here.com/here-sdk/docs/android-tutorials.md) - [Legal and privacy requirements](https://docs.here.com/here-sdk/docs/android-about.md) - [Transactions and usage stats](https://docs.here.com/here-sdk/docs/android-billing.md) - [Examples and use cases](https://docs.here.com/here-sdk/docs/flutter-venues-use-cases.md) - [Use the Indoor Maps component](https://docs.here.com/here-sdk/docs/flutter-venues.md) - [Access map data on-the-fly](https://docs.here.com/here-sdk/docs/flutter-access-map-data-on-the-fly.md) - [Integration with CarPlay and Android Auto](https://docs.here.com/here-sdk/docs/flutter-android-auto.md) - [Adjust the map view](https://docs.here.com/here-sdk/docs/flutter-camera.md) - [Add custom layers](https://docs.here.com/here-sdk/docs/flutter-custom-map-styles.md) - [Interact with the map](https://docs.here.com/here-sdk/docs/flutter-gestures.md) - [Add predefined map features](https://docs.here.com/here-sdk/docs/flutter-map-features.md) - [Add map items](https://docs.here.com/here-sdk/docs/flutter-map-items.md) - [Add predefined map schemes](https://docs.here.com/here-sdk/docs/flutter-map-schemes.md) - [Create styles with the HERE Style Editor](https://docs.here.com/here-sdk/docs/flutter-map-style-editor.md) - [Get started with Maps](https://docs.here.com/here-sdk/docs/flutter-maps.md) - [Electronic Horizon](https://docs.here.com/here-sdk/docs/flutter-electronic-horizon.md) - [Build a navigation app](https://docs.here.com/here-sdk/docs/flutter-navigation-app-tutorial.md) - [Handle route deviations](https://docs.here.com/here-sdk/docs/flutter-navigation-deviation.md) - [Get lane assistance](https://docs.here.com/here-sdk/docs/flutter-navigation-lane-guidance.md) - [Optimize navigation](https://docs.here.com/here-sdk/docs/flutter-navigation-optimization.md) - [Navigate trucks](https://docs.here.com/here-sdk/docs/flutter-navigation-truck.md) - [Add voice guidance](https://docs.here.com/here-sdk/docs/flutter-navigation-voice-guidance.md) - [Stay aware with warners](https://docs.here.com/here-sdk/docs/flutter-navigation-warners.md) - [Get started with Navigation](https://docs.here.com/here-sdk/docs/flutter-navigation.md) - [Install map data](https://docs.here.com/here-sdk/docs/flutter-offline-maps-installation.md) - [Alternative options](https://docs.here.com/here-sdk/docs/flutter-offline-maps-options.md) - [Offline routing features](https://docs.here.com/here-sdk/docs/flutter-offline-maps-routing.md) - [Offline search features](https://docs.here.com/here-sdk/docs/flutter-offline-maps-search.md) - [Update map data](https://docs.here.com/here-sdk/docs/flutter-offline-maps-update.md) - [Get started with offline maps](https://docs.here.com/here-sdk/docs/flutter-offline-maps.md) - [Enable background updates](https://docs.here.com/here-sdk/docs/flutter-get-locations-enable-background-updates.md) - [Optimize Positioning](https://docs.here.com/here-sdk/docs/flutter-get-locations-optimization.md) - [Get started with Positioning](https://docs.here.com/here-sdk/docs/flutter-get-locations.md) - [Build a GPX recording app](https://docs.here.com/here-sdk/docs/flutter-hiking-app-tutorial.md) - [Advanced routing features](https://docs.here.com/here-sdk/docs/flutter-routing-advanced.md) - [Get routes for electric vehicles](https://docs.here.com/here-sdk/docs/flutter-routing-ev.md) - [Add route options](https://docs.here.com/here-sdk/docs/flutter-routing-options.md) - [Add UI building blocks](https://docs.here.com/here-sdk/docs/flutter-routing-ui.md) - [Get started with Routing](https://docs.here.com/here-sdk/docs/flutter-routing.md) - [Search & Geocoding features](https://docs.here.com/here-sdk/docs/flutter-search-geocoding.md) - [Get started with Search](https://docs.here.com/here-sdk/docs/flutter-search.md) - [Traffic Engine](https://docs.here.com/here-sdk/docs/flutter-traffic-engine.md) - [Additional traffic features](https://docs.here.com/here-sdk/docs/flutter-traffic-features.md) - [Visualize traffic on routes](https://docs.here.com/here-sdk/docs/flutter-traffic-render.md) - [Update traffic information](https://docs.here.com/here-sdk/docs/flutter-traffic-update.md) - [Get started with Traffic](https://docs.here.com/here-sdk/docs/flutter-traffic.md) - [Components](https://docs.here.com/here-sdk/docs/flutter-components.md) - [Set a scope to differentiate multiple apps](https://docs.here.com/here-sdk/docs/flutter-multiple-apps.md) - [Get started](https://docs.here.com/here-sdk/docs/flutter-get-started.md) - [Coverage information](https://docs.here.com/here-sdk/docs/flutter-coverage-information.md) - [Licenses explained](https://docs.here.com/here-sdk/docs/flutter-introduction-editions.md) - [Feature list](https://docs.here.com/here-sdk/docs/flutter-introduction-feature-list.md) - [Minimum requirements](https://docs.here.com/here-sdk/docs/flutter-introduction-requirements.md) - [Introduction](https://docs.here.com/here-sdk/docs/flutter-readme.md) - [Maps and services](https://docs.here.com/here-sdk/docs/flutter-customization-catalogs.md) - [UI components](https://docs.here.com/here-sdk/docs/flutter-customization-ui.md) - [Use custom map catalogs](https://docs.here.com/here-sdk/docs/flutter-maps-byod.md) - [Best practices](https://docs.here.com/here-sdk/docs/flutter-key-concepts.md) - [Manage data and OTA costs](https://docs.here.com/here-sdk/docs/flutter-optimization.md) - [Engines](https://docs.here.com/here-sdk/docs/flutter-tips-engines.md) - [Supplemental information](https://docs.here.com/here-sdk/docs/flutter-tips-supplements.md) - [Community and support](https://docs.here.com/here-sdk/docs/flutter-tips-support.md) - [Debugging and troubleshooting](https://docs.here.com/here-sdk/docs/flutter-tips-troubleshooting.md) - [Update from previous versions](https://docs.here.com/here-sdk/docs/flutter-update-version.md) - [FAQ](https://docs.here.com/here-sdk/docs/flutter-use-cases.md) - [Examples](https://docs.here.com/here-sdk/docs/flutter-examples.md) - [Integrate the HERE SDK](https://docs.here.com/here-sdk/docs/flutter-integrate-here-sdk.md) - [Tutorials](https://docs.here.com/here-sdk/docs/flutter-tutorials.md) - [Legal and privacy requirements](https://docs.here.com/here-sdk/docs/flutter-about.md) - [Transactions and usage stats](https://docs.here.com/here-sdk/docs/flutter-billing.md) - [Maps and services](https://docs.here.com/here-sdk/docs/ios-customization-catalogs.md) - [UI components](https://docs.here.com/here-sdk/docs/ios-customization-ui.md) - [Use custom map catalogs](https://docs.here.com/here-sdk/docs/ios-maps-byod.md) - [Best practices](https://docs.here.com/here-sdk/docs/ios-key-concepts.md) - [Manage data and OTA costs](https://docs.here.com/here-sdk/docs/ios-optimization.md) - [Engines](https://docs.here.com/here-sdk/docs/ios-tips-engines.md) - [Supplemental information](https://docs.here.com/here-sdk/docs/ios-tips-supplements.md) - [Community and support](https://docs.here.com/here-sdk/docs/ios-tips-support.md) - [Debugging and troubleshooting](https://docs.here.com/here-sdk/docs/ios-tips-troubleshooting.md) - [Update from previous versions](https://docs.here.com/here-sdk/docs/ios-update-version.md) - [FAQ](https://docs.here.com/here-sdk/docs/ios-use-cases.md) - [Integration with CarPlay](https://docs.here.com/here-sdk/docs/ios-carplay.md) - [Examples](https://docs.here.com/here-sdk/docs/ios-examples.md) - [Integrate the HERE SDK](https://docs.here.com/here-sdk/docs/ios-integrate-here-sdk.md) - [Tutorials](https://docs.here.com/here-sdk/docs/ios-tutorials.md) - [Legal and privacy requirements](https://docs.here.com/here-sdk/docs/ios-about.md) - [Transactions and usage stats](https://docs.here.com/here-sdk/docs/ios-billing.md) - [Examples and use cases](https://docs.here.com/here-sdk/docs/ios-venues-use-cases.md) - [Use the Indoor Maps component](https://docs.here.com/here-sdk/docs/ios-venues.md) - [Access map data on-the-fly](https://docs.here.com/here-sdk/docs/ios-access-map-data-on-the-fly.md) - [Adjust the map view](https://docs.here.com/here-sdk/docs/ios-camera.md) - [Add custom layers](https://docs.here.com/here-sdk/docs/ios-custom-map-styles.md) - [Interact with the map](https://docs.here.com/here-sdk/docs/ios-gestures.md) - [Add predefined map features](https://docs.here.com/here-sdk/docs/ios-map-features.md) - [Add map items](https://docs.here.com/here-sdk/docs/ios-map-items.md) - [Add predefined map schemes](https://docs.here.com/here-sdk/docs/ios-map-schemes.md) - [Create styles with the HERE Style Editor](https://docs.here.com/here-sdk/docs/ios-map-style-editor.md) - [Get started with Maps](https://docs.here.com/here-sdk/docs/ios-maps.md) - [Electronic Horizon](https://docs.here.com/here-sdk/docs/ios-electronic-horizon.md) - [Build a navigation app](https://docs.here.com/here-sdk/docs/ios-navigation-app-tutorial.md) - [Handle route deviations](https://docs.here.com/here-sdk/docs/ios-navigation-deviation.md) - [Get lane assistance](https://docs.here.com/here-sdk/docs/ios-navigation-lane-guidance.md) - [Optimize navigation](https://docs.here.com/here-sdk/docs/ios-navigation-optimization.md) - [Navigate trucks](https://docs.here.com/here-sdk/docs/ios-navigation-truck.md) - [Add voice guidance](https://docs.here.com/here-sdk/docs/ios-navigation-voice-guidance.md) - [Stay aware with warners](https://docs.here.com/here-sdk/docs/ios-navigation-warners.md) - [Get started with Navigation](https://docs.here.com/here-sdk/docs/ios-navigation.md) - [Install map data](https://docs.here.com/here-sdk/docs/ios-offline-maps-installation.md) - [Alternative options](https://docs.here.com/here-sdk/docs/ios-offline-maps-options.md) - [Offline routing features](https://docs.here.com/here-sdk/docs/ios-offline-maps-routing.md) - [Offline search features](https://docs.here.com/here-sdk/docs/ios-offline-maps-search.md) - [Update map data](https://docs.here.com/here-sdk/docs/ios-offline-maps-update.md) - [Get started with offline maps](https://docs.here.com/here-sdk/docs/ios-offline-maps.md) - [Optimize Positioning](https://docs.here.com/here-sdk/docs/ios-get-locations-optimization.md) - [Get started with Positioning](https://docs.here.com/here-sdk/docs/ios-get-locations.md) - [Build a GPX recording app](https://docs.here.com/here-sdk/docs/ios-hiking-app-tutorial.md) - [Advanced routing features](https://docs.here.com/here-sdk/docs/ios-routing-advanced.md) - [Get routes for electric vehicles](https://docs.here.com/here-sdk/docs/ios-routing-ev.md) - [Add route options](https://docs.here.com/here-sdk/docs/ios-routing-options.md) - [Add UI building blocks](https://docs.here.com/here-sdk/docs/ios-routing-ui.md) - [Get started with Routing](https://docs.here.com/here-sdk/docs/ios-routing.md) - [Search & Geocoding features](https://docs.here.com/here-sdk/docs/ios-search-geocoding.md) - [Get started with Search](https://docs.here.com/here-sdk/docs/ios-search.md) - [Traffic Engine](https://docs.here.com/here-sdk/docs/ios-traffic-engine.md) - [Additional traffic features](https://docs.here.com/here-sdk/docs/ios-traffic-features.md) - [Visualize traffic on routes](https://docs.here.com/here-sdk/docs/ios-traffic-render.md) - [Update traffic information](https://docs.here.com/here-sdk/docs/ios-traffic-update.md) - [Get started with Traffic](https://docs.here.com/here-sdk/docs/ios-traffic.md) - [Components](https://docs.here.com/here-sdk/docs/ios-components.md) - [Get started](https://docs.here.com/here-sdk/docs/ios-get-started.md) - [Set a scope to differentiate multiple apps](https://docs.here.com/here-sdk/docs/ios-multiple-apps.md) - [Introduction](https://docs.here.com/here-sdk/docs/ios-readme.md) - [Coverage information](https://docs.here.com/here-sdk/docs/ios-coverage-information.md) - [Licenses explained](https://docs.here.com/here-sdk/docs/ios-introduction-editions.md) - [Feature list](https://docs.here.com/here-sdk/docs/ios-introduction-feature-list.md) - [Minimum requirements](https://docs.here.com/here-sdk/docs/ios-introduction-requirements.md) ## Changelog - [HERE SDK for Flutter (Navigate)](https://docs.here.com/here-sdk/changelog/here-sdk-flutter-navigate-prod.md) - [HERE SDK for Flutter (Explore)](https://docs.here.com/here-sdk/changelog/here-sdk-flutter-explore-prod.md) - [HERE SDK for iOS (Navigate)](https://docs.here.com/here-sdk/changelog/here-sdk-ios-navigate-prod.md) - [HERE SDK for iOS (Explore)](https://docs.here.com/here-sdk/changelog/here-sdk-ios-explore-prod.md) - [HERE SDK for Android (Navigate)](https://docs.here.com/here-sdk/changelog/here-sdk-android-navigate-prod.md) # HERE Style Editor Documentation ## Guides - [HERE icon resources licensing terms](https://docs.here.com/style-editor/docs/here-icons-license.md) - [How to hide icons](https://docs.here.com/style-editor/docs/hide-icons.md) - [Icon design guidelines](https://docs.here.com/style-editor/docs/icon-design-guidelines.md) - [POI Icons](https://docs.here.com/style-editor/docs/index-poi.md) - [Icon mapping documentation within HERE maps](https://docs.here.com/style-editor/docs/index-icon-mapping.md) - [POI - Japan - Default View](https://docs.here.com/style-editor/docs/japan-day-master-list.md) - [POI - Japan - Logistics View](https://docs.here.com/style-editor/docs/japan-logistics-day-master-list.md) - [POI - Logistics View](https://docs.here.com/style-editor/docs/logistics-day-master-list.md) - [Other Icons](https://docs.here.com/style-editor/docs/misc-day-master-list.md) - [POI - Default View](https://docs.here.com/style-editor/docs/row-day-master-list.md) - [Vehicle Restriction Icons](https://docs.here.com/style-editor/docs/truck-day-master-list.md) - [How to use the schematic map view](https://docs.here.com/style-editor/docs/dmt.md) - [HERE Style Editor styling for Japan](https://docs.here.com/style-editor/docs/japan-index.md) - [How to use MapView controls](https://docs.here.com/style-editor/docs/mapview-controls.md) - [How to save and export](https://docs.here.com/style-editor/docs/save-and-export.md) - [How to manage icons](https://docs.here.com/style-editor/docs/manage-icons.md) - [How to Replace map icons](https://docs.here.com/style-editor/docs/replace-icons.md) - [Features and modes](https://docs.here.com/style-editor/docs/features-and-modes.md) - [HERE default map styles](https://docs.here.com/style-editor/docs/default-map-styles-index.md) - [Get started with HERE Style Editor](https://docs.here.com/style-editor/docs/get-started.md) - [How to use the attributes panel](https://docs.here.com/style-editor/docs/attributes-panel-style-editor.md) - [How to style Attributes](https://docs.here.com/style-editor/docs/how-to-style-attributes.md) - [Explore the HERE Style Editor interface](https://docs.here.com/style-editor/docs/interface-overview.md) - [How to use the Layers panel](https://docs.here.com/style-editor/docs/layers-panel-style-editor.md) - [How to use overlays](https://docs.here.com/style-editor/docs/overlays.md) - [How to select base map styles](https://docs.here.com/style-editor/docs/map-styles.md) - [How to use the Modifiers panel](https://docs.here.com/style-editor/docs/modifiers-panel.md) - [How to style with Modifiers](https://docs.here.com/style-editor/docs/use-style-modifiers.md) - [HERE Style Editor compatibility notes](https://docs.here.com/style-editor/docs/compatibility-notes.md) - [HERE Style Editor keyboard shortcuts](https://docs.here.com/style-editor/docs/keyboard-shortcuts.md) - [Introduction to HERE Style Editor](https://docs.here.com/style-editor/docs/style-editor-intro.md) - [How to use advanced map styling for automotive day and night navigation](https://docs.here.com/style-editor/docs/advanced-map-styling.md) - [How to use quick map styling](https://docs.here.com/style-editor/docs/quick-map-styling.md) - [How to use day and night map styles for Japan](https://docs.here.com/style-editor/docs/region-specific-styling.md) - [Styling use cases](https://docs.here.com/style-editor/docs/user-journeys-parent.md) # HERE Tour Planning Documentation ## Guides - [Fleet Optimization Package concepts](https://docs.here.com/tour-planning/docs/concepts-fleetoptimizationpackagedevguide.md) - [Fleet Optimization Package tutorials](https://docs.here.com/tour-planning/docs/fleet-optimization-package-tutorials.md) - [How to get your coordinates](https://docs.here.com/tour-planning/docs/tutorial-geocoding.md) - [How to plan your routes](https://docs.here.com/tour-planning/docs/tutorial-routing.md) - [How to create your optimized tours](https://docs.here.com/tour-planning/docs/tutorial-tour-planning.md) - [Get started with the Fleet Optimization Package](https://docs.here.com/tour-planning/docs/get-started.md) - [Introduction to the Fleet Optimization Package](https://docs.here.com/tour-planning/docs/readme-fleetoptimizationpackagedevguide.md) - [Use preferred routes with avoid options](https://docs.here.com/tour-planning/docs/avoid.md) - [Optimize car routes by travel time or distance](https://docs.here.com/tour-planning/docs/car-mode-optimization.md) - [Replan routes dynamically](https://docs.here.com/tour-planning/docs/dynamic-replanning.md) - [Assign otherwise unreachable jobs by ignoring route violations](https://docs.here.com/tour-planning/docs/ignore-route-violations.md) - [Configure location-specific parking durations for more realistic service times](https://docs.here.com/tour-planning/docs/location-specific-parking.md) - [Map route violations to control job assignment](https://docs.here.com/tour-planning/docs/map-route-violations.md) - [Use relations to replan tours](https://docs.here.com/tour-planning/docs/relations.md) - [Optimize routes with side-of-street preferences](https://docs.here.com/tour-planning/docs/side-of-street.md) - [Improve dispatch with vehicle-dependent stop base durations](https://docs.here.com/tour-planning/docs/stop-base-duration.md) - [Resolve equal solutions with tie-breaking objectives](https://docs.here.com/tour-planning/docs/tiebreak.md) - [Understand traffic modes](https://docs.here.com/tour-planning/docs/traffic-modes.md) - [Use objective functions for specific optimization goals](https://docs.here.com/tour-planning/docs/using-objective-functions.md) - [Check coverage by country](https://docs.here.com/tour-planning/docs/country-support.md) - [Manage tour planning billing](https://docs.here.com/tour-planning/docs/billing.md) - [Implement custom time-distance matrices](https://docs.here.com/tour-planning/docs/custom-matrix.md) - [Obtain route polylines for the tour](https://docs.here.com/tour-planning/docs/polylines.md) - [Explore experimental features](https://docs.here.com/tour-planning/docs/experimental-features.md) - [Find answers to frequently asked questions](https://docs.here.com/tour-planning/docs/faq.md) - [Introduction to HERE Tour Planning API](https://docs.here.com/tour-planning/docs/introduction-tour-planning.md) - [Set route limits](https://docs.here.com/tour-planning/docs/limits.md) - [Limit maximum distance](https://docs.here.com/tour-planning/docs/max-distance.md) - [Limit maximum driving time](https://docs.here.com/tour-planning/docs/max-driving-time.md) - [Limit maximum shift time](https://docs.here.com/tour-planning/docs/max-shift-time.md) - [Set maximum number of stops](https://docs.here.com/tour-planning/docs/max-stops.md) - [Set minimum number of stops](https://docs.here.com/tour-planning/docs/min-stops.md) - [Customize pedestrian walking speed](https://docs.here.com/tour-planning/docs/pedestrian-speed.md) - [Enforce speed limits](https://docs.here.com/tour-planning/docs/speed-cap.md) - [Use alternative locations](https://docs.here.com/tour-planning/docs/alternative-locations.md) - [Minimize tour overlap for driver-friendly routes](https://docs.here.com/tour-planning/docs/minimize-tour-overlap.md) - [Optimize tours by territories](https://docs.here.com/tour-planning/docs/territory.md) - [Increase fleet effectiveness by scheduling EV recharges at designated stations](https://docs.here.com/tour-planning/docs/ev-recharge-points.md) - [Plan efficient routes for EV fleets](https://docs.here.com/tour-planning/docs/ev-support.md) - [Plan efficient routes for waste management fleets](https://docs.here.com/tour-planning/docs/waste-management.md) - [Account for breaks](https://docs.here.com/tour-planning/docs/breaks.md) - [Cluster nearby stops](https://docs.here.com/tour-planning/docs/cluster-nearby.md) - [Monitor fuel consumption and CO₂ emissions](https://docs.here.com/tour-planning/docs/co-emissions.md) - [Plan employee transportation](https://docs.here.com/tour-planning/docs/employee-pickup-dropoff.md) - [Calculate excess costs per tour](https://docs.here.com/tour-planning/docs/excess-costs.md) - [Assign jobs to groups](https://docs.here.com/tour-planning/docs/group-jobs.md) - [Optimize tours for diverse vehicle types](https://docs.here.com/tour-planning/docs/heterogeneous.md) - [Allow customer-based service durations](https://docs.here.com/tour-planning/docs/house-key.md) - [Control job task position](https://docs.here.com/tour-planning/docs/job-task-order.md) - [Plan multi-day long-haul tours](https://docs.here.com/tour-planning/docs/long-haul.md) - [Define mixed load restrictions](https://docs.here.com/tour-planning/docs/mixing-restrictions.md) - [Handle multiple tasks per job](https://docs.here.com/tour-planning/docs/multi-job.md) - [Enable multiple reload points](https://docs.here.com/tour-planning/docs/multi-reloads.md) - [Include multiple shifts](https://docs.here.com/tour-planning/docs/multiple-shifts.md) - [Combine pickup and delivery in tour planning](https://docs.here.com/tour-planning/docs/pickup-delivery.md) - [Prioritize jobs](https://docs.here.com/tour-planning/docs/priority.md) - [Incorporate rest times](https://docs.here.com/tour-planning/docs/rest-times.md) - [Assign jobs based on skills](https://docs.here.com/tour-planning/docs/skills.md) - [Set soft time windows](https://docs.here.com/tour-planning/docs/soft-time-windows.md) - [Optimize tours for cost](https://docs.here.com/tour-planning/docs/time-distance-optimization-vrp.md) - [Limit the start time of activities through time windows](https://docs.here.com/tour-planning/docs/time-windows.md) - [Get started with HERE Tour Planning API](https://docs.here.com/tour-planning/docs/quick-start.md) - [Understand API errors](https://docs.here.com/tour-planning/docs/api-errors.md) - [Get multiple unassigned job reasons](https://docs.here.com/tour-planning/docs/multiple-unassigned-reasons.md) - [Troubleshoot unassigned jobs](https://docs.here.com/tour-planning/docs/troubleshoot-unassigned-jobs.md) - [Configuration](https://docs.here.com/tour-planning/docs/configuration.md) - [Learn key concepts](https://docs.here.com/tour-planning/docs/glossary.md) - [Objectives](https://docs.here.com/tour-planning/docs/objectives.md) - [Problem](https://docs.here.com/tour-planning/docs/problem.md) - [HERE server environments](https://docs.here.com/tour-planning/docs/request-environment.md) - [Solution](https://docs.here.com/tour-planning/docs/solution.md) - [Solve the capacitated vehicle routing problem](https://docs.here.com/tour-planning/docs/capacitated-vrp.md) - [Solve open vehicle routing problems](https://docs.here.com/tour-planning/docs/open-vrp.md) - [Follow best practices for problem formulation](https://docs.here.com/tour-planning/docs/problem-formulation.md) - [Understand the traveling salesman problem](https://docs.here.com/tour-planning/docs/traveling-salesman-problem.md) - [API Changes](https://docs.here.com/tour-planning/docs/api-changes.md) - [Behavioral changes](https://docs.here.com/tour-planning/docs/behavioral-changes.md) - [New Features](https://docs.here.com/tour-planning/docs/new-features.md) - [Overview](https://docs.here.com/tour-planning/docs/release-notes-overview.md) - [Highlights](https://docs.here.com/tour-planning/docs/release-notes-highlights.md) ## API Reference - [Cancel a problem by problem or status Id](https://docs.here.com/tour-planning/reference/cancelproblem.md): Cancel a previously submitted vehicle routing problem. This action stops the solver from processing the problem and prevents any further updates or solutions from being generated. - [Get solution by problem or status Id](https://docs.here.com/tour-planning/reference/getsolution.md): Retrieve a solution for a previously submitted vehicle routing problem. - [Get status update by Id](https://docs.here.com/tour-planning/reference/getstatus.md): Provides an interface to retrieve the status ID of an asynchronous request. - [**ALPHA** Upload a Routing Matrix](https://docs.here.com/tour-planning/reference/post_matrices.md): **ALPHA** Upload a [routing matrix](https://docs.here.com/tour-planning/docs/custom-matrix) for use in subsequent asynchronous requests. To gain access to this endpoint, contact your regional HERE representative. - [Submit a Vehicle Routing Problem to solve it asynchronously.](https://docs.here.com/tour-planning/reference/submitproblemasync.md): Solve a [vehicle routing problem](https://docs.here.com/tour-planning/docs/problem) asynchronously by optimizing vehicle routes and schedules for jobs (deliveries or pickups) from a depot, including constraints like vehicle capacity, job demand, time windows, and required skills. - [CORS support](https://docs.here.com/tour-planning/reference/options_matrices.md): Enable CORS by returning correct headers. - [CORS support](https://docs.here.com/tour-planning/reference/options_problems-async.md): Enable CORS by returning correct headers. - [CORS support](https://docs.here.com/tour-planning/reference/options_problems-problemid-cancel.md): Enable CORS by returning correct headers. - [CORS support](https://docs.here.com/tour-planning/reference/options_problems-problemid-solution.md): Enable CORS by returning correct headers. - [CORS support](https://docs.here.com/tour-planning/reference/options_problems.md): Enable Cross-Origin Resource Sharing (CORS) by returning the appropriate headers. - [CORS support](https://docs.here.com/tour-planning/reference/options_status-statusid.md): Enable CORS by returning correct headers. - [Submit a Vehicle Routing Problem to solve it synchronously](https://docs.here.com/tour-planning/reference/post_problems.md): Solve a [vehicle routing problem](https://docs.here.com/tour-planning/docs/problem) synchronously by optimizing vehicle routes and schedules for jobs (deliveries or pickups) from a depot, including constraints like vehicle capacity, job demand, time windows, and required skills. - [Health status of the service.](https://docs.here.com/tour-planning/reference/gethealth.md): Retrieve the current health status of the service. - [Full version of the API.](https://docs.here.com/tour-planning/reference/getversion.md): Retrieve the current version of the service. # HERE Traffic Analytics Speed Data Documentation ## Guides - [Get started with Traffic Analytics](https://docs.here.com/traffic-analytics/docs/get-started.md) - [Introduction to Traffic Analytics](https://docs.here.com/traffic-analytics/docs/readme.md) - [Traffic Analytics revision history](https://docs.here.com/traffic-analytics/docs/revision-history.md) - [API access for Traffic Analytics](https://docs.here.com/traffic-analytics/docs/concepts-api-access.md) - [File formats for Traffic Analytics](https://docs.here.com/traffic-analytics/docs/concepts-file-formats.md) - [Path data for Traffic Analytics](https://docs.here.com/traffic-analytics/docs/concepts-path-data.md) - [GPS probe data for Traffic Analytics](https://docs.here.com/traffic-analytics/docs/gps-probe-data.md) - [Traffic Analytics concepts](https://docs.here.com/traffic-analytics/docs/traffic-analytics-concepts.md) - [Service Level Agreement for Traffic Analytics](https://docs.here.com/traffic-analytics/docs/sla.md) - [Tutorial for Traffic Analytics speed data](https://docs.here.com/traffic-analytics/docs/tutorial-for-traffic-analytics-speed-data.md) - [Sample Traffic Analytics speed data query and results](https://docs.here.com/traffic-analytics/docs/sample-speed-data-query-and-results.md) - [Date range for Traffic Analytics](https://docs.here.com/traffic-analytics/docs/date-range.md) - [How to use time filters](https://docs.here.com/traffic-analytics/docs/how-to-use-time-filters.md) - [Predefined time changes for Traffic Analytics](https://docs.here.com/traffic-analytics/docs/predefined-time-ranges.md) - [Using Traffic Analytics](https://docs.here.com/traffic-analytics/docs/using-traffic-analytics.md) - [Location for Traffic Analytics (HERE Map admin levels 1-4)](https://docs.here.com/traffic-analytics/docs/location.md) - [Output file naming conventions](https://docs.here.com/traffic-analytics/docs/output-file-naming-conventions.md) - [Query criteria for Traffic Analytics](https://docs.here.com/traffic-analytics/docs/query-criteria.md) - [Road segment referencing for Traffic Analytics](https://docs.here.com/traffic-analytics/docs/referencing.md) - [Resolution of data in time increments for Traffic Analytics](https://docs.here.com/traffic-analytics/docs/resolution.md) - [Average-mean speed](https://docs.here.com/traffic-analytics/docs/average-mean-speed-mean.md) - [Confidence in the query response](https://docs.here.com/traffic-analytics/docs/confidence-confidence.md) - [Date in the query response](https://docs.here.com/traffic-analytics/docs/date-date-time.md) - [Epoch in the query response](https://docs.here.com/traffic-analytics/docs/epoch-epoch.md) - [Free flow speed](https://docs.here.com/traffic-analytics/docs/free-flow-speed-freeflow.md) - [Gap filling in the query response](https://docs.here.com/traffic-analytics/docs/gap-filling-gapfill.md) - [Harmonic mean speed](https://docs.here.com/traffic-analytics/docs/harmonic-mean-speed.md) - [Select output fields for Traffic Analytics](https://docs.here.com/traffic-analytics/docs/select-output-fields-for-traffic-analytics.md) - [Length in the query response](https://docs.here.com/traffic-analytics/docs/length-length.md) - [Minimum and maximum speeds](https://docs.here.com/traffic-analytics/docs/minimum-and-maximum-speeds-min-and-max.md) - [Probe count in the query response](https://docs.here.com/traffic-analytics/docs/probe-count.md) - [Road segment reference - TMC or LINK-DIR](https://docs.here.com/traffic-analytics/docs/road-segment-reference-tmc-or-link-dir.md) - [Sample count in the query response](https://docs.here.com/traffic-analytics/docs/sample-count-count.md) - [Speed limit in the query response](https://docs.here.com/traffic-analytics/docs/speed-limit-spdlimit.md) - [Standard deviation in the query response](https://docs.here.com/traffic-analytics/docs/standard-deviation-stddev.md) - [Vehicle Distance Traveled](https://docs.here.com/traffic-analytics/docs/vehicle-distance-traveled.md) - [Gap filling for Traffic Analytics](https://docs.here.com/traffic-analytics/docs/gap-filling.md) - [Source data for Traffic Analytics](https://docs.here.com/traffic-analytics/docs/source-data-for-traffic-analytics.md) - [Using path data with Traffic Analytics](https://docs.here.com/traffic-analytics/docs/path-data.md) - [Using vehicle probe points with Traffic Analytics](https://docs.here.com/traffic-analytics/docs/per-vehicle-or-per-probe.md) - [Speed percentile values for Traffic Analytics - PCT-5 to PCT-95](https://docs.here.com/traffic-analytics/docs/speed-percentiles-pct-5-to-pct-95.md) - [Select a vehicle type to use for Traffic Analytics](https://docs.here.com/traffic-analytics/docs/vehicle-type.md) - [Submit your Traffic Analytics query](https://docs.here.com/traffic-analytics/docs/submit-your-query.md) - [How to use days of the week with Traffic Analytics](https://docs.here.com/traffic-analytics/docs/days-of-the-week.md) - [How to use a HERE functional class with Traffic Analytics](https://docs.here.com/traffic-analytics/docs/functional-class.md) - [TMC codes for Traffic Analytics](https://docs.here.com/traffic-analytics/docs/tmc-codes-for-traffic-analytics.md) - [How to use a PVID list with Traffic Analytics](https://docs.here.com/traffic-analytics/docs/pvid-list.md) - [How to use road names in Traffic Analytics](https://docs.here.com/traffic-analytics/docs/road-names.md) - [Standardize TMC in FGDB](https://docs.here.com/traffic-analytics/docs/standardize-tmc-in-fgdb.md) - [Standardize TMC in NAVSTREETS](https://docs.here.com/traffic-analytics/docs/standardize-tmc-in-navstreets.md) - [Standardize TMC in RDF (Oracle example)](https://docs.here.com/traffic-analytics/docs/standardize-tmc-in-rdf-oracle.md) - [Standardize TMC in RDF (SQL server example)](https://docs.here.com/traffic-analytics/docs/standardize-tmc-in-rdf-sql-server.md) - [Using TMC codes with the HERE Map](https://docs.here.com/traffic-analytics/docs/using-tmc-codes-with-the-here-map.md) # HERE Traffic API Documentation ## Guides - [Advanced Traffic](https://docs.here.com/traffic-api/docs/advanced-traffic-flow.md) - [Flow](https://docs.here.com/traffic-api/docs/flow.md) - [Geospatial filters](https://docs.here.com/traffic-api/docs/geospatial-filters-here-traffic-api-v7-concepts.md) - [Incidents](https://docs.here.com/traffic-api/docs/incidents-here-traffic-api-v7-concepts.md) - [Location referencing](https://docs.here.com/traffic-api/docs/location-referencing-here-traffic-api-v7-concepts.md) - [Real-Time Traffic](https://docs.here.com/traffic-api/docs/real-time-traffic-here-traffic-api-v7-concepts.md) - [Supported translation languages in HERE Traffic API v7](https://docs.here.com/traffic-api/docs/languages-here-traffic-api-v7-coverage-information.md) - [Traffic coverage](https://docs.here.com/traffic-api/docs/traffic-here-traffic-api-v7-coverage-information.md) - [Use geospatial filtering](https://docs.here.com/traffic-api/docs/filter-geospatial-here-traffic-api-v7-tutorials.md) - [Filter flow by functional class](https://docs.here.com/traffic-api/docs/flow-filter-functional-class-flow-1.md) - [Filter flow by jam factor](https://docs.here.com/traffic-api/docs/flow-filter-jam-factor-flow-1.md) - [How to request flow data](https://docs.here.com/traffic-api/docs/how-to-request-flow-data.md) - [Request an incident by ID](https://docs.here.com/traffic-api/docs/incidents-by-id-incidents-1.md) - [Filter incidents by functional class](https://docs.here.com/traffic-api/docs/incidents-filter-functional-class-incidents-1.md) - [Request incidents in a different language](https://docs.here.com/traffic-api/docs/incidents-parameter-lang-incidents-1.md) - [How to request incident data](https://docs.here.com/traffic-api/docs/how-to-request-incident-data.md) - [HERE Traffic API v7 tutorials](https://docs.here.com/traffic-api/docs/here-traffic-api-v7-tutorials.md) - [Introduction to HERE Traffic API v7](https://docs.here.com/traffic-api/docs/introduction-to-here-traffic-api-v7.md) - [Request tracing](https://docs.here.com/traffic-api/docs/request-tracing-readme.md) - [Get started with HERE Traffic API v7](https://docs.here.com/traffic-api/docs/send-request-readme.md) - [API Changes](https://docs.here.com/traffic-api/docs/api-changes.md) - [Known Issues](https://docs.here.com/traffic-api/docs/known-issues.md) - [Resolved Issues](https://docs.here.com/traffic-api/docs/resolved-issues.md) - [Traffic Changes](https://docs.here.com/traffic-api/docs/traffic-changes.md) - [Highlights](https://docs.here.com/traffic-api/docs/highlights.md) - [Release notes overview](https://docs.here.com/traffic-api/docs/release-notes-overview.md) - [Raster tiles](https://docs.here.com/traffic-api/docs/raster-tiles.md) - [Call info](https://docs.here.com/traffic-api/docs/info.md) - [Styles](https://docs.here.com/traffic-api/docs/styles.md) - [Traffic flow](https://docs.here.com/traffic-api/docs/traffic-flow.md) - [Request tracing](https://docs.here.com/traffic-api/docs/request-tracing-concepts.md) - [Traffic coverage](https://docs.here.com/traffic-api/docs/traffic-coverage-information-2.md) - [Introduction](https://docs.here.com/traffic-api/docs/here-traffic-raster-tile-introduction.md) - [Get started](https://docs.here.com/traffic-api/docs/quick-start-platform.md) - [Required Copyright Notice](https://docs.here.com/traffic-api/docs/required-copyright-notice.md) - [Apply the traffic congestion filter](https://docs.here.com/traffic-api/docs/apply-the-traffic-congestion-filter.md) - [Change the image size](https://docs.here.com/traffic-api/docs/change-the-image-size.md) - [Request flow](https://docs.here.com/traffic-api/docs/request-flow.md) - [Set the style](https://docs.here.com/traffic-api/docs/set-the-style.md) - [Using HERE Maps API for JavaScript](https://docs.here.com/traffic-api/docs/using-here-maps-api-for-javascript.md) - [API Changes](https://docs.here.com/traffic-api/docs/api-changes-1.md) - [Changes](https://docs.here.com/traffic-api/docs/changes.md) - [Known Issues](https://docs.here.com/traffic-api/docs/known-issues-1.md) - [Highlights](https://docs.here.com/traffic-api/docs/highlights-1.md) - [Overview](https://docs.here.com/traffic-api/docs/overview.md) - [Get started with the HERE Traffic Vector Tile API](https://docs.here.com/traffic-api/docs/get-started-with-traffic-vector-tile.md) - [Obtain a traffic vector tile with flow and incident events](https://docs.here.com/traffic-api/docs/flow-and-incident.md) - [Obtain a traffic vector tile with flow events](https://docs.here.com/traffic-api/docs/flow-event.md) - [Obtain a traffic vector tile with incidents events](https://docs.here.com/traffic-api/docs/incident-event.md) - [Required copyright notice - HERE Traffic Vector Tile API](https://docs.here.com/traffic-api/docs/required-copyright-notice-developer-s-guide.md) - [Introduction to the HERE Traffic Vector Tile API](https://docs.here.com/traffic-api/docs/traffc-vector-tile-introduction.md) - [HERE Traffic Vector Tile API data layers](https://docs.here.com/traffic-api/docs/traffic-vector-tile-layers.md) - [HERE Traffic Vector Tile API coverage](https://docs.here.com/traffic-api/docs/traffic-vector-tile-traffic.md) - [Vector tile schema - HERE Traffic Vector Tile API](https://docs.here.com/traffic-api/docs/vector-tile-schema.md) - [API Changes](https://docs.here.com/traffic-api/docs/api-changes-2.md) - [Changes](https://docs.here.com/traffic-api/docs/here-traffic-vector-tile-api-release-notes-changes.md) - [Known Issues](https://docs.here.com/traffic-api/docs/known-issues-2.md) - [Highlights](https://docs.here.com/traffic-api/docs/highlights-2.md) - [Overview](https://docs.here.com/traffic-api/docs/here-traffic-vector-tile-api-release-notes-overview.md) ## API Reference - [Health status of the service](https://docs.here.com/traffic-api/reference/gethealth.md): Returns the health of the service - [OpenAPI 3.0 definition.](https://docs.here.com/traffic-api/reference/getopenapi.md): Returns the OpenAPI 3.0 definition of this API. - [API version information](https://docs.here.com/traffic-api/reference/getversion.md): Returns version information of the API Specification. - [Map version information](https://docs.here.com/traffic-api/reference/getinfo.md): Returns the map version. This version is valid only for 24h at maximum. - [Retrieves the rendered map tile in requested format.](https://docs.here.com/traffic-api/reference/gettile.md): Map tile in requested format. - [Health status of the service](https://docs.here.com/traffic-api/reference/gethealth-1.md): Returns the health of the service - [Retrieves this API specification in OpenAPI 3 format](https://docs.here.com/traffic-api/reference/getopenapi-1.md): Returns the OpenAPI specification of the Traffic API v7 - [Full version of the API](https://docs.here.com/traffic-api/reference/getversion-1.md): Returns the version of the service - [Real-Time Flow Information](https://docs.here.com/traffic-api/reference/getflow.md): Get real-time traffic flow data for a geospatial area. - [Real-Time Flow Information](https://docs.here.com/traffic-api/reference/getflowwithbodyparams.md): Get real-time traffic flow data for a geospatial area with geospatial filter. - [Real-Time Incident Information](https://docs.here.com/traffic-api/reference/getincidents.md): Get traffic incidents for a geospatial area. - [Real-Time Incident Information for the given id](https://docs.here.com/traffic-api/reference/getincidentsbyid.md): Get traffic incident for a given id. The id can be prefixed with a namespace. If no namespace is specified, the default namespace is "here:traffic:incident". - [Real-Time Incident Information for the given id](https://docs.here.com/traffic-api/reference/getincidentsbyidwithbodyparams.md): Get traffic incident for a given id. The id can be prefixed with a namespace. If no namespace is specified, the default namespace is "here:traffic:incident". - [Real-Time Incident Information](https://docs.here.com/traffic-api/reference/getincidentswithbodyparams.md): Get traffic incidents for a geospatial area. - [Health status of the service](https://docs.here.com/traffic-api/reference/gethealth-2.md): Returns the health of the service - [OpenAPI 3.0 definition.](https://docs.here.com/traffic-api/reference/getopenapi-2.md): Returns the OpenAPI 3.0 definition of this API. - [API version information](https://docs.here.com/traffic-api/reference/getversion-2.md): Returns version information of the API Specification. - [Retrieves the protocol buffer encoded binary tile.](https://docs.here.com/traffic-api/reference/gettile-1.md): Retrieves the protocol buffer encoded binary tile with the traffic data. # HERE Transit Documentation ## Guides - [API Changes](https://docs.here.com/transit/docs/api-changes.md) - [Functional and Behavioral Changes](https://docs.here.com/transit/docs/functional-behavioral-changes.md) - [Changes](https://docs.here.com/transit/docs/changes.md) - [Known Issues and Workarounds](https://docs.here.com/transit/docs/known-issues.md) - [New Features](https://docs.here.com/transit/docs/new-features.md) - [Resolved Issues](https://docs.here.com/transit/docs/resolved-issues.md) - [Highlights](https://docs.here.com/transit/docs/highlights.md) - [Overview](https://docs.here.com/transit/docs/release-notes-overview.md) - [Migrating to the Intermodal Routing API(overview/index.md)](https://docs.here.com/transit/docs/migrating-to-the-intermodal-routing-apioverviewindexmd.md) - [New features in v8](https://docs.here.com/transit/docs/intermodal-migration-summary.md) - [Action - Public Transit API v8](https://docs.here.com/transit/docs/action-transit.md) - [Copyright notices - Public Transit API v8](https://docs.here.com/transit/docs/copyrights-transit.md) - [Coverage information - Public Transit API v8 - Table 2](https://docs.here.com/transit/docs/coverage-info-2.md) - [Coverage information - Public Transit API v8 - Table 1](https://docs.here.com/transit/docs/coverage-info.md) - [Types of coverage - Public Transit API v8](https://docs.here.com/transit/docs/coverage-transit.md) - [Modes of transport - Public Transit API v8](https://docs.here.com/transit/docs/modes-transit.md) - [Flexible polyline - Public Transit API v8](https://docs.here.com/transit/docs/polyline-transit.md) - [Route - Public Transit API v8](https://docs.here.com/transit/docs/route-transit.md) - [Route - Public Transit API v8](https://docs.here.com/transit/docs/route.md) - [Section - Public Transit API v8](https://docs.here.com/transit/docs/section-transit.md) - [Transport - Public Transit API v8](https://docs.here.com/transit/docs/transport-transit.md) - [How to search next departures by IDs](https://docs.here.com/transit/docs/by-ids-example.md) - [How to search next departures by location](https://docs.here.com/transit/docs/by-location-example.md) - [Public Transit Next Departures API examples](https://docs.here.com/transit/docs/departures-index.md) - [How to send a request to the Public Transit Next Departures API](https://docs.here.com/transit/docs/send-request-1.md) - [Public Transit Routing API examples](https://docs.here.com/transit/docs/examples-index.md) - [How to calculate a transit Route](https://docs.here.com/transit/docs/route-example.md) - [How to send a request to the Transit Routing API](https://docs.here.com/transit/docs/send-request-transit.md) - [How to obtain the shape of a transit route](https://docs.here.com/transit/docs/shape-example.md) - [Get started with the Public Transit API v8](https://docs.here.com/transit/docs/quick-start-1.md) - [Introduction to the Public Transit API v8](https://docs.here.com/transit/docs/readme-public-transit-api-v8.md) - [How to search stations by IDs](https://docs.here.com/transit/docs/by-ids-example-1.md) - [How to search Stations by location](https://docs.here.com/transit/docs/by-location-example-1.md) - [How to search Stations by name and location](https://docs.here.com/transit/docs/by-name-and-location-example.md) - [Public Transit Station Search API examples](https://docs.here.com/transit/docs/search-index.md) - [How to send a request to the Public Transit Next Departures API](https://docs.here.com/transit/docs/send-request-public-trans.md) - [Public Transit Next Departures](https://docs.here.com/transit/docs/departures-migration.md) - [Migrate to latest Public Transit API](https://docs.here.com/transit/docs/migrate-to-latest-public-transit-api.md) - [Public Transit Station Search](https://docs.here.com/transit/docs/stations-migration.md) - [Public Transit Routing](https://docs.here.com/transit/docs/transit-routing-migration.md) - [Highlights](https://docs.here.com/transit/docs/highlights-1.md) ## API Reference - [Health](https://docs.here.com/transit/reference/gethealth-1.md): Returns the health of the service - [Retrieves this API specification in OpenAPI 3 format](https://docs.here.com/transit/reference/getopenapi-1.md) - [Version](https://docs.here.com/transit/reference/getversion-1.md): Returns the version of the service - [Health](https://docs.here.com/transit/reference/gethealth-2.md): Returns the health of the service - [Routes](https://docs.here.com/transit/reference/getintermodalroutes-1.md): Lists intermodal routes. All or a combination of the following services may be utilized by the intermodal algorithm to generate intermodal routes: * Vehicle routing. * Intermodal routing with real-time and timetable departures. * Pedestrian routing with pedestrian connectivity. * Park and Ride service that combines vehicle and public transit routing. * Real-time traffic and traffic incidents. * Public transit service delays/disruptions information from transit authorities. * Amenities available at transit stations or nearby (such as parking, EV charging stations, etc.). * Sharing services available at transit stations or nearby (such as car sharing, taxi, bicycle, etc.). - [Routes](https://docs.here.com/transit/reference/getintermodalroutes.md): Lists intermodal routes. All or a combination of the following services may be utilized by the intermodal algorithm to generate intermodal routes: * Vehicle routing. * Intermodal routing with real-time and timetable departures. * Pedestrian routing with pedestrian connectivity. * Park and Ride service that combines vehicle and public transit routing. * Real-time traffic and traffic incidents. * Public transit service delays/disruptions information from transit authorities. * Amenities available at transit stations or nearby (such as parking, EV charging stations, etc.). * Sharing services available at transit stations or nearby (such as car sharing, taxi, bicycle, etc.). - [Health](https://docs.here.com/transit/reference/gethealth.md): Returns the health status of the service - [Retrieves this API specification in OpenAPI 3 format](https://docs.here.com/transit/reference/getopenapi.md) - [Version](https://docs.here.com/transit/reference/getversion.md): Returns the version of the service - [Departures](https://docs.here.com/transit/reference/getdepartures.md): Lists public transit departures. Discovers subsequent departures using structured or topological queries. The service accepts two types of queries as shown in the table below: | Query | Parameter | Description | |-------|-----------|-------------| | Departures by IDs | `ids` | takes a comma-separated list of station/stop identifiers | | Departures by Location | `in` | takes a pair of coordinates to define the center and a radius to define the extent of a circular area where to search for departures | Select a query from `one of` the options above to visualize the request parameters. - [Routes](https://docs.here.com/transit/reference/getroutes.md): Lists public transit routes. The service supports several use cases as follows: * define routes based on arrival or departure times. * filter specific transit modes, such as rail and metro only. * plan routes hours or days in advance. * set a maximum distance for the walk to the nearest transit stop/station or the speed of the walk. * define how many changes or transfers the journey may include. * request turn-by-turn navigation. * request route polyline in order to view the route over a map. - [Stations](https://docs.here.com/transit/reference/getstations.md): Lists public transit stations. Discovers stations using structured or topological queries. The service accepts three types of queries as shown in the table below: | Query | Parameter | Description | |-------|-----------|-------------| | Stations by IDs | `ids` | Takes a comma-separated list of station/stop identifiers. | | Stations by location | `in` | Takes a pair of coordinates to define the center and a radius to define the extent of a circular area where to search for departures. | | Stations by name and location | `name` and `in` | Takes the station name or part of the name to search for. It is composed of one or more space-separated words and does not support stopwords. | Select a query from `one of` the options above to visualize the request parameters. # HERE WeGo Pro Documentation ## Guides - [HERE Deeplinking API error management](https://docs.here.com/wego-pro/docs/errors-dl.md) - [How to activate a device for HERE WeGo Pro](https://docs.here.com/wego-pro/docs/activate-device-dl.md) - [How to share a location](https://docs.here.com/wego-pro/docs/share-location-dl.md) - [How to share a place](https://docs.here.com/wego-pro/docs/share-place-dl.md) - [How to share a route](https://docs.here.com/wego-pro/docs/share-route-dl.md) - [How to share settings](https://docs.here.com/wego-pro/docs/share-settings-dl.md) - [Introduction to the HERE Deeplinking API](https://docs.here.com/wego-pro/docs/readme-here-deeplinking-api-developer-guide-dl.md) - [HERE Deeplinking API URL format](https://docs.here.com/wego-pro/docs/request-format-dl.md) - [HERE WeGo Pro admin responsibilities](https://docs.here.com/wego-pro/docs/admin.md) - [HERE WeGo Pro Coverage](https://docs.here.com/wego-pro/docs/coverage.md) - [Using pass-through waypoints](https://docs.here.com/wego-pro/docs/deeplinking-waypoints.md) - [HERE WeGo Pro deeplinking](https://docs.here.com/wego-pro/docs/deeplinking.md) - [HERE WeGo Pro integration samples](https://docs.here.com/wego-pro/docs/integrations.md) - [HERE WeGo Pro Mobile Device Management (MDM) support](https://docs.here.com/wego-pro/docs/mdm-support.md) - [HERE WeGo Pro live tracking](https://docs.here.com/wego-pro/docs/tracking.md) - [Generate QR codes for truck switching in HERE WeGo Pro](https://docs.here.com/wego-pro/docs/tutorial-switch-trucks.md) - [Activation flow of HERE WeGo Pro](https://docs.here.com/wego-pro/docs/activation-flow.md) - [Introduction to HERE WeGo Pro](https://docs.here.com/wego-pro/docs/wego-introduction.md) - [Environment and base URLs](https://docs.here.com/wego-pro/docs/env-and-base-urls.md) - [Get started with HERE WeGo Pro Live Tracking API](https://docs.here.com/wego-pro/docs/get-started-live-tracking.md) - [HTTP error codes](https://docs.here.com/wego-pro/docs/http-error-codes.md) - [Introduction to HERE WeGo Pro](https://docs.here.com/wego-pro/docs/live-tracking-introduction.md) - [Live tracking report](https://docs.here.com/wego-pro/docs/live-tracking-report.md) - [Tutorial for HERE WeGo Pro Live Tracking API](https://docs.here.com/wego-pro/docs/tutorial-live-tracking-api.md) - [API Changes in HERE WeGo Pro](https://docs.here.com/wego-pro/docs/api-changes.md) - [New Features in HERE WeGo Pro](https://docs.here.com/wego-pro/docs/new-features.md) - [Resolved Issues in HERE WeGo Pro](https://docs.here.com/wego-pro/docs/resolved-issues.md) - [Highlights for HERE WeGo Pro](https://docs.here.com/wego-pro/docs/highlights.md) - [Introduction to HERE WeGo Pro](https://docs.here.com/wego-pro/docs/wego-intro.md) - [Features included in HERE WeGo Pro](https://docs.here.com/wego-pro/docs/features.md) - [HERE WeGo Pro truck features](https://docs.here.com/wego-pro/docs/truck-features.md) - [Get started with HERE WeGo Pro](https://docs.here.com/wego-pro/docs/get-started.md) - [Mirroring support for HERE WeGo Pro](https://docs.here.com/wego-pro/docs/mirroring-support.md) - [Introduction to HERE WeGo Pro](https://docs.here.com/wego-pro/docs/readme-here-wego-pro-user-guide.md) ## API Reference - [Get paginated feature groups](https://docs.here.com/wego-pro/reference/getfeaturegroups.md): Endpoint to get a paginated list of feature groups sorted alphabetically by name. - [Get feature group with its features](https://docs.here.com/wego-pro/reference/getfeaturegroupwithfeatures.md): Endpoint to get a feature group with its associated features. - [Add a feature group to a subscription](https://docs.here.com/wego-pro/reference/addfeaturegrouptosubscription_1.md): Endpoint to add a feature group to a subscription. - [Add a feature group to a subscription](https://docs.here.com/wego-pro/reference/addfeaturegrouptosubscription_2.md): Endpoint to add a feature group to a subscription. - [Add a feature group to a subscription](https://docs.here.com/wego-pro/reference/addfeaturegrouptosubscription.md): Endpoint to add a feature group to a subscription. - [Create new subscription keys](https://docs.here.com/wego-pro/reference/createsubscriptionkeyspublic.md): Endpoint to create new subscription keys - [Deactivate subscription devices](https://docs.here.com/wego-pro/reference/deactivatedevices.md): Endpoint to deactivate devices associated with the given subscription - [Deactivate subscription](https://docs.here.com/wego-pro/reference/deactivatesubscription.md): Endpoint to deactivate a subscription - [Delete associated devices](https://docs.here.com/wego-pro/reference/deleteassociateddevices.md): Endpoint to delete all devices associated with a given subscription key - [Get active subscriptions](https://docs.here.com/wego-pro/reference/getactivesubscriptions.md): Endpoint to get a paginated list of active subscriptions for an organization - [Get subscription details by subscription key](https://docs.here.com/wego-pro/reference/getsubscriptionbykey.md): Endpoint to retrieve subscription details by their unique Subscription Key. - [Get subscription devices details by subscription key](https://docs.here.com/wego-pro/reference/getsubscriptiondevices.md): Endpoint to retrieve subscription devices by Subscription Key. - [Remove a feature group from a subscription](https://docs.here.com/wego-pro/reference/removefeaturegroupfromsubscription_1.md): Endpoint to remove a feature group from a subscription. - [Remove a feature group from a subscription](https://docs.here.com/wego-pro/reference/removefeaturegroupfromsubscription_2.md): Endpoint to remove a feature group from a subscription. - [Remove a feature group from a subscription](https://docs.here.com/wego-pro/reference/removefeaturegroupfromsubscription.md): Endpoint to remove a feature group from a subscription. - [Update subscription by ID](https://docs.here.com/wego-pro/reference/updatesubscriptionbyid.md): Endpoint to update an existing subscription's details. - [Update subscription by Subscription Key](https://docs.here.com/wego-pro/reference/updatesubscriptionbykey.md): Endpoint to update an existing subscription's details. - [Get user tracking report](https://docs.here.com/wego-pro/reference/getorganizationtrackingreport.md): Get tracking report for all users of an organization # Identity and Access Management Documentation ## Guides - [Get started with HERE from Amazon Web Services Marketplace](https://docs.here.com/identity-and-access-management/docs/amazon-web-services.md) - [Concepts](https://docs.here.com/identity-and-access-management/docs/concepts.md) - [How to enable cross realm trust sharing](https://docs.here.com/identity-and-access-management/docs/cross-realm-trust-sharing-guide.md) - [Resolve common error codes](https://docs.here.com/identity-and-access-management/docs/error-messages.md) - [FAQ](https://docs.here.com/identity-and-access-management/docs/faq.md) - [How to troubleshoot 403 Forbidden errors](https://docs.here.com/identity-and-access-management/docs/troubleshooting-access-denials.md) - [How to find rate limit rules](https://docs.here.com/identity-and-access-management/docs/how-to-find-rate-limit-rules.md) - [Fetch rate limit endpoints using the CLI](https://docs.here.com/identity-and-access-management/docs/rate-limit-endpoints.md) - [How to create Maven Repository credentials](https://docs.here.com/identity-and-access-management/docs/get-platform-repository-credentials.md) - [Manage authentication](https://docs.here.com/identity-and-access-management/docs/manage-authentication.md) - [SAML FAQs](https://docs.here.com/identity-and-access-management/docs/saml-faqs.md) - [How to set up SAML with the platform portal UI](https://docs.here.com/identity-and-access-management/docs/saml-setup.md) - [How to set up SAML with the OLP CLI](https://docs.here.com/identity-and-access-management/docs/saml-setup2.md) - [Control resource access with Access Filters](https://docs.here.com/identity-and-access-management/docs/access-filters.md) - [Manage authorization](https://docs.here.com/identity-and-access-management/docs/manage-authorization.md) - [Manage permissions and organization settings](https://docs.here.com/identity-and-access-management/docs/organization-settings.md) - [IAM APIs overview](https://docs.here.com/identity-and-access-management/docs/api-overview.md) - [How to authorize with OAuth 2.0](https://docs.here.com/identity-and-access-management/docs/how-to-authorize-with-oauth-20.md) - [OIDC tokens](https://docs.here.com/identity-and-access-management/docs/plat-using-oidc.md) - [Manage your individual or organization platform account](https://docs.here.com/identity-and-access-management/docs/manage-your-individual-or-organization-platform-account.md) - [How to invite users](https://docs.here.com/identity-and-access-management/docs/invite-users.md) - [Manage API and OAuth access](https://docs.here.com/identity-and-access-management/docs/manage-api-oauth.md) - [How to manage apps](https://docs.here.com/identity-and-access-management/docs/manage-apps.md) - [How to manage groups](https://docs.here.com/identity-and-access-management/docs/manage-groups.md) - [How to manage projects](https://docs.here.com/identity-and-access-management/docs/manage-projects.md) - [Manage your user account](https://docs.here.com/identity-and-access-management/docs/manage-user-account.md) - [How to manage users](https://docs.here.com/identity-and-access-management/docs/manage-users.md) - [How to authorize with an API key](https://docs.here.com/identity-and-access-management/docs/plat-using-apikeys.md) - [Manage access with SSO](https://docs.here.com/identity-and-access-management/docs/sso.md) - [How to move or migrate resources into projects](https://docs.here.com/identity-and-access-management/docs/migration-guide.md) - [Create a HERE account](https://docs.here.com/identity-and-access-management/docs/plat-obtain-user-credentials.md) - [Premium IAM Features](https://docs.here.com/identity-and-access-management/docs/premium-iam-features.md) - [Introduction to HERE Identity and Access Management](https://docs.here.com/identity-and-access-management/docs/readme.md) - [How to get an OAuth 2.0 token with Python](https://docs.here.com/identity-and-access-management/docs/python-oauth-token.md) ## API Reference - [Delete API Key](https://docs.here.com/identity-and-access-management/reference/deleteapikey.md): Deletes API key of the application. This API key can no longer be used for authentication or authorization. Since API key cannot be recovered once deleted, it is recommended that the client application calling this end-point should enforce a confirmation of delete action (Example: Confirm box saying: Are you sure you want to delete this API Key?).
Access Control: * The calling principal must have **"manage"** or **"write"** action permission for the resource **"{app}"** in the **"account"** service. * The calling principal MUST NOT include a project scope. - [Disable API Key](https://docs.here.com/identity-and-access-management/reference/disableapikey.md): Disables API key of the application.
Access Control: * The calling principal must have **"manage"** or **"write"** action permission for the resource **"{app}"** in the **"account"** service. * The calling principal MUST NOT include a project scope. - [Enable API Key](https://docs.here.com/identity-and-access-management/reference/enableapikey.md): Enables API key of the application.
Access Control: * The calling principal must have **"manage"** or **"write"** action permission for the resource **"{app}"** in the **"account"** service. * The calling principal MUST NOT include a project scope. - [Generate API Key](https://docs.here.com/identity-and-access-management/reference/generateapikey.md): This generates a new API key that you use for authenticating an application. Note that the API key is contained in the field named `apiKeyId`. The value in the field `apiKey` is the HERE Resource Name (HRN) prefixed with “hrn" followed by the API key, and is not usable as an API key in the request. A maximum of two API keys can be maintained per application.
Access Control: * The calling principal must have **"manage"** or **"write"** action permission for the resource **"{app}"** in the **"account"** service. * The calling principal MUST NOT include a project scope. - [Retrieve API Key by user](https://docs.here.com/identity-and-access-management/reference/getapikeybyuser.md): Retrieves API key of the application.
Access Control: * The calling principal must have **"read"** action permission for the resource **"{app}"** in the **"account"** service. * The calling principal MUST NOT include a project scope. - [Get API Keys](https://docs.here.com/identity-and-access-management/reference/getapikeys.md): Lists the API keys generated for an application.
Access Control: * The calling principal must have **"read"** action permission for the resource **"{app}"** in the **"account"** service. * The calling principal MUST NOT include a project scope. - [Update API Key](https://docs.here.com/identity-and-access-management/reference/updateapikey.md): Updates API key of the application.
Access Control: * The calling principal must have **"manage"** or **"write"** action permission for the resource **"{app}"** in the **"account"** service. * The calling principal MUST NOT include a project scope. - [Get App Code](https://docs.here.com/identity-and-access-management/reference/getappcode.md): Get the App Code configured for an application. App Codes are deprecated and in a read-only state. An App can either have 0 or 1 App Code, depending whether they have appCodeEnabled or not. To retrieve the appCode via this endpoint the App needs to have appCodeEnabled=true and appCodeVisible=true.
An App Code can be used with certain classic HLS Services that still support app_id and app_code values in the query string for authentication.
Access Control: * The calling principal must have **"manage"** action permission for the resource **"{app}"** in the **"account"** service. * The calling principal MUST NOT include a project scope. - [Create Access Key](https://docs.here.com/identity-and-access-management/reference/createaccesskey.md): Create a new access key for the requested application.
Access Control: * The calling principal must have **"manage"** or **"write"** action permission for the resource **"{app}"** in the **"account"** service. * The calling principal MUST NOT include a project scope. - [Delete Access Key](https://docs.here.com/identity-and-access-management/reference/deleteaccesskey.md): Delete the requested access key for the requested application.
Access Control: * The calling principal must have **"manage"** or **"write"** action permission for the resource **"{app}"** in the **"account"** service. * The calling principal MUST NOT include a project scope. - [Disable Access Key](https://docs.here.com/identity-and-access-management/reference/disableaccesskey.md): Disable the requested access key for the given application.
Access Control: * The calling principal must have **"manage"** or **"write"** action permission for the resource **"{app}"** in the **"account"** service. * The calling principal MUST NOT include a project scope. - [Enable Access Key](https://docs.here.com/identity-and-access-management/reference/enableaccesskey.md): Enable the requested access key for the given application.
Access Control: * The calling principal must have **"manage"** or **"write"** action permission for the resource **"{app}"** in the **"account"** service. * The calling principal MUST NOT include a project scope. - [Get Access Keys](https://docs.here.com/identity-and-access-management/reference/getaccesskeys.md): Retrieve the list of access keys associated with the requested application.
Access Control: * The calling principal must have **"read"** action permission for the resource **"{app}"** in the **"account"** service. * The calling principal MUST NOT include a project scope. - [Create Application](https://docs.here.com/identity-and-access-management/reference/createapplication.md): Create a new application. * A new app will be created and a clientId will be automatically generated and assigned to it. * The application will be created in the same realm the user/app belongs to. This information is obtained from the User/Client Access Token. * The user/app creating the app will be granted permission to 'manage' and delegate application management ('share'). This user/app can now delegate access to the application in more granular fashion (all sharable actions - read, write, manage, share) to another identity in his realm via the share/grants APIs. * The app created by an app will inherit the creator user id of the caller app. The creator user id does not get permissions to the new app. * Any authenticated user has access to create an application. * Any authenticated app that has the 'appCreationEnabled' property enabled by any of its managers has access to create an application.
Access Control: * The calling principal must be in a realm of type **"olp"**. * The calling principal must have **"createApp"** action permission in the **"account"** service. * The calling principal MUST NOT include a project scope. - [Delete Application](https://docs.here.com/identity-and-access-management/reference/deleteapplication.md): Delete the application identified by the provided HRN.
Access Control: * The calling principal must have **"manage"** action permission for the resource **"{app}"** in the **"account"** service. * The calling principal MUST NOT include a project scope. - [Delete application default scope](https://docs.here.com/identity-and-access-management/reference/deleteapplicationdefaultscope.md): Delete the default scope for the application identified by the provided HRN.
Access Control: * The calling principal must have **"manage"** or **"write"** action permission for the resource **"{app}"** in the **"account"** service. * The calling principal MUST NOT include a project scope. - [Disables the app's ability to create another app.](https://docs.here.com/identity-and-access-management/reference/disableappcreation.md): Disable the property "appCreationEnabled" for the application.
Access Control: * The calling principal must have **"manage"** action permission for the resource **"{app}"** in the **"account"** service. * The calling principal MUST NOT include a project scope. - [Enables the app's ability to create another app.](https://docs.here.com/identity-and-access-management/reference/enableappcreation.md): Enable the property "appCreationEnabled" for the application.
Access Control: * The calling principal must have **"manage"** action permission for the resource **"{app}"** in the **"account"** service. * The calling principal MUST NOT include a project scope. - [Verify the app's ability to create another app.](https://docs.here.com/identity-and-access-management/reference/getappcreationenabled.md): Verify if the property "appCreationEnabled" for the application is enabled.
Access Control: * The calling principal must have **"read"** action permission for the resource **"{app}"** in the **"account"** service. * The calling principal MUST NOT include a project scope. - [Get Application](https://docs.here.com/identity-and-access-management/reference/getapplication.md): Retrieve the application identified by the provided HRN.
Access Control: * The calling principal must have **"read"** action permission for the resource **"{app}"** in the **"account"** service. * The calling principal MUST NOT include a project scope. - [Get application default scope](https://docs.here.com/identity-and-access-management/reference/getapplicationdefaultscope.md): Get the default scope for the application identified by the provided HRN.
Access Control: * The calling principal must have **"manage"** or **"read"** action permission for the resource **"{app}"** in the **"account"** service. - [Get Applications](https://docs.here.com/identity-and-access-management/reference/listapplications.md): List applications over which the calling party OR one of the groups the calling party is a member of has an exact match permission on as defined below. Exact match permissions include: service = **"account"** and action = **"read"**, **"write"**, or **"manage"** and service = **"authorization"** and action = **"share"**.
Access Control: * The calling principal MUST NOT include a project scope. - [Create or update application default scope](https://docs.here.com/identity-and-access-management/reference/setapplicationdefaultscope.md): Create or update the default scope for the application identified by the provided HRN. Application Default Scope Management APIs enabled authorized identities to manage the the default scope for a given application. The default scope represents the default value for the "scope" parameter when requesting a client_credentials OAuth2 token if no "scope" parameter is specified. If a "scope" parameter is specified when requesting a client_credentials OAuth2 token, the default scope value will be disregarded.
Access Control: * The calling principal must have **"manage"** or **"write"** action permission for the resource **"{app}"** in the **"account"** service. - [Update Application](https://docs.here.com/identity-and-access-management/reference/updateapplication.md): Update the application identified by the provided HRN.
Access Control: * The calling principal must have **"manage"** or **"write"** action permission for the resource **"{app}"** in the **"account"** service. * The calling principal MUST NOT include a project scope. - [List the Apps which have attached the specified Identity Provider](https://docs.here.com/identity-and-access-management/reference/listappsforprovider.md): List the Apps that have attached the specified Identity Provider.
Access Control: * The calling principal must have either **"read"** or **"readIdentityProviders"** action permission for the resource **"{app}"** in the **"account"** service. * The calling principal MUST NOT include a project scope. - [Delete a Device by HRN](https://docs.here.com/identity-and-access-management/reference/deletedevice.md): Delete the Device specified by HRN.
Access Control: * The calling principal must have **"manageDevices"** action permission for the resource **"{realm}"** in the **"account"** service. The *realm* is identified in the **"{device}"**. * The calling principal MUST NOT include a project scope. - [Delete Devices](https://docs.here.com/identity-and-access-management/reference/deletedevices.md): Delete a Device by its Identity Provider and ExternalId. Deleting multiple Devices at a time is not currently supported.
Access Control: * The calling principal must have **"manageDevices"** action permission for the resource **"{realm}"** in the **"account"** service. The *realm* is realm of the device. * The calling principal MUST NOT include a project scope. - [Get a Device by HRN](https://docs.here.com/identity-and-access-management/reference/getdevice.md): Get the Device specified by HRN.
Access Control: * The calling principal must have **"readDevices"** action permission for the resource **"{realm}"** in the **"account"** service. The *realm* is identified in the **"{device}"**. * The calling principal MUST NOT include a project scope. - [List Devices](https://docs.here.com/identity-and-access-management/reference/listdevices.md): List Devices.
Access Control: * The calling principal must have **"readDevices"** action permission for the resource **"{realm}"** in the **"account"** service. The *realm* is either taken from the query string parameters, or if absent defaults to the *realm* in the request access token. * The calling principal MUST NOT include a project scope. - [List Project Devices](https://docs.here.com/identity-and-access-management/reference/listprojectdevices.md): List Devices in the specified Project.
Access Control: * The calling principal must have **"readDevices"** action permission for the resource **"{project}"** in the **"account"** service. * The calling principal MUST NOT include a project scope. - [Update a Device by HRN](https://docs.here.com/identity-and-access-management/reference/updatedevice.md): Update the Device specified by HRN.
Access Control: * The calling principal must have **"manageDevices"** action permission for the resource **"{realm}"** in the **"account"** service. The *realm* is identified in the **"{device}"**. * The calling principal MUST NOT include a project scope. - [Add a new trusted OpenID Connect Identity Provider to a Realm](https://docs.here.com/identity-and-access-management/reference/addidentityprovider.md): Add a new trusted Identity Provider to a Realm. Currently, only OAuth 2.0/OpenID Connect Providers can be used. **NOTE:** You can create a maximum of 5 Identity Providers in a Realm.
Access Control: * The calling principal must have either **"manageIdentityProviders"** action permission for the resource **"{realm}"** in the **"account"** service. * The calling principal MUST NOT include a project scope. - [Attach an Issuer URL to an Identity Provider](https://docs.here.com/identity-and-access-management/reference/createidentityproviderissuerattachment.md): Attach a new Issuer URL to an Identity Provider. **NOTE:** The maximum number of Issuers for an Identity Provider is 2.
Access Control: * The calling principal must have either **"manageIdentityProviders"** action permission for the resource **"{realm}"** in the **"account"** service. * The calling principal MUST NOT include a project scope. - [Delete a trusted Identity Provider for a Realm](https://docs.here.com/identity-and-access-management/reference/deleteidentityprovider.md): Delete a trusted Identity Provider for a Realm.
Access Control: * The calling principal must have either **"manageIdentityProviders"** action permission for the resource **"{realm}"** in the **"account"** service. * The calling principal MUST NOT include a project scope. - [Detach an Issuer from an Identity Provider](https://docs.here.com/identity-and-access-management/reference/deleteidentityproviderissuerattachment.md): Detaches an Issuer from an Identity Provider.
Access Control: * The calling principal must have either **"manageIdentityProviders"** action permission for the resource **"{realm}"** in the **"account"** service. * The calling principal MUST NOT include a project scope. - [Get a trusted Identity Provider for a Realm](https://docs.here.com/identity-and-access-management/reference/getidentityprovider.md): Get a trusted Identity Provider for a Realm.
Access Control: * The calling principal must have either **"readIdentityProviders"** action permission for the resource **"{realm}"** in the **"account"** service. * The calling principal MUST NOT include a project scope. - [Get an Issuer URL for an Identity Provider](https://docs.here.com/identity-and-access-management/reference/getidentityproviderissuerattachment.md): Get an Issuer URL to an Identity Provider. **NOTE:** The maximum number of Issuers for an Identity Provider is 2.
Access Control: * The calling principal must have either **"readIdentityProviders"** action permission for the resource **"{realm}"** in the **"account"** service. * The calling principal MUST NOT include a project scope. - [List Issuers for an Identity Provider](https://docs.here.com/identity-and-access-management/reference/listidentityproviderissuerattachments.md): Get a list of Issuers for an Identity Provider.
Access Control: * The calling principal must have either **"readIdentityProviders"** action permission for the resource **"{realm}"** in the **"account"** service. * The calling principal MUST NOT include a project scope. - [List trusted OpenID Connect Identity Providers for a Realm](https://docs.here.com/identity-and-access-management/reference/listidentityproviders.md): List trusted OpenID Connect Providers for a Realm.
Access Control: * The calling principal must have either **"readIdentityProviders"** action permission for the resource **"{realm}"** in the **"account"** service. * The calling principal MUST NOT include a project scope. - [Update a trusted Identity Provider for a Realm](https://docs.here.com/identity-and-access-management/reference/updateidentityprovider.md): Update a trusted Identity Provider for a Realm.
Access Control: * The calling principal must have either **"manageIdentityProviders"** action permission for the resource **"{realm}"** in the **"account"** service. * The calling principal MUST NOT include a project scope. - [Update an Issuer for an App](https://docs.here.com/identity-and-access-management/reference/updateidentityproviderissuerattachment.md): Update an Issuer for an Identity Provider.
Access Control: * The calling principal must have either **"manageIdentityProviders"** action permission for the resource **"{realm}"** in the **"account"** service. * The calling principal MUST NOT include a project scope. - [Attach a trusted OpenID Connect Identity Provider to an App](https://docs.here.com/identity-and-access-management/reference/createappidentityproviderattachment.md): Attach a new trusted OpenID Connect Identity Provider to an App. The App must be constrained to a Project. To constrain an App to a Project, use the Access Manager -> Apps -> My Apps -> Edit app -> specify "DEFAULT ACCESS TO A PROJECT", and check "Allow access only in this project". An App may have at most 2 IdentityProviders attached to it.
Access Control: * The calling principal must have either **"manage"** action permission for the resource **"{app}"** in the **"account"** service or **"readIdentityProviders"** action permission for the callers **"{realm}"** in the **"account"** service. * The calling principal MUST NOT include a project scope. - [Detach a trusted OpenID Connect Identity Provider for an App](https://docs.here.com/identity-and-access-management/reference/deleteappidentityproviderattachment.md): Detaches a trusted OpenID Connect Identity Provider from an App.
Access Control: * The calling principal must either have **"manage"** action permission for the resource **"{app}"** in the **"account"** service, and that the App is constrained to a Project or have **"readIdentityProviders"** action permission for the callers **"{realm}"** in the **"account"** service. * The calling principal MUST NOT include a project scope. - [Gets a trusted OpenID Connect Identity Provider for an App](https://docs.here.com/identity-and-access-management/reference/getappidentityproviderattachment.md): Gets a trusted OpenID Connect Identity Provider configured for an App.
Access Control: * The calling principal must either have **"read"** action permission for the resource **"{app}"** in the **"account"** service and that the App is constrained to a Project or have **"readIdentityProviders"** action permission for the callers **"{realm}"** in the **"account"** service. * The calling principal MUST NOT include a project scope. - [List trusted OpenID Connect Identity Providers for an App](https://docs.here.com/identity-and-access-management/reference/listappidentityproviders.md): List trusted OpenID Connect Identity Providers for an App.
Access Control: * The calling principal must have either **"read"** or **"readIdentityProviders"** action permission for the resource **"{app}"** in the **"account"** service. * The calling principal MUST NOT include a project scope. - [Update a trusted OpenID Connect Identity Provider for an App](https://docs.here.com/identity-and-access-management/reference/updateappidentityproviderattachment.md): Update a trusted OpenID Connect Identity Provider for an App.
Access Control: * The calling principal must either have **"manage"** action permission for the resource **"{app}"** in the **"account"** service, and that the App is constrained to a Project or have **"readIdentityProviders"** action permission for the callers **"{realm}"** in the **"account"** service. * The calling principal MUST NOT include a project scope. - [Create an mTLS Identity Provider](https://docs.here.com/identity-and-access-management/reference/createmtlsidentityprovider.md): Create an mTLS Identity Provider and define the Certificate Authority.
* The provided Certificate Authority will be installed as a trusted mTLS Identity Provider and bound to the given realm * A single Certificate Authority can be bound to one and only one realm at any one point in time. * Certificates issued by the Certificate Authority can be used to authenticate identities in the realm via the /mtls/token endpoint Certificate Revocation: * If the provided Certificate Authority contains a CRL Distribution Point URL, this URL will be used to periodically retrieve revoked certificates and prevent such certificates from authenticating to the platform. * If the provided Certificate Authority contains an OCSP responder URL, this URL will be used to check the status of individual certificates to determine if they are revoked. * The timeliness between a certificate being revoked by the Certificate Authority and the same revoked certificate being denied by an mTLS Authenticator in the platform is not defined by this specification. **NOTE:** A maximum of 10 mTLS Identity Providers can be created per realm.
Access Control: * The calling principal must have **"manageMtlsIdentityProviders"** action permission for the resource **"{realm}"** in the **"account"** service. * The calling principal MUST NOT include a project scope. - [Remove mTLS Identity Provider](https://docs.here.com/identity-and-access-management/reference/deletemtlsidentityprovider.md): Delete an mTLS Identity Provider configured for the realm.
Access Control: * The calling principal must have **"manageMtlsIdentityProviders"** action permission for the resource **"{realm}"** in the **"account"** service. * The calling principal MUST NOT include a project scope. - [Get an mTLS Authenticator](https://docs.here.com/identity-and-access-management/reference/getmtlsauthenticatorforidp.md): Get an mTLS Authenticator configured to authenticate certificates for the specified mTLS Identity Provider.
Access Control: * The calling principal must have **"readMtlsIdentityProviders"** action permission for the resource **"{realm}"** in the **"account"** service. * The calling principal MUST NOT include a project scope. - [Get an mTLS Identity Provider](https://docs.here.com/identity-and-access-management/reference/getmtlsidentityprovider.md): Get an mTLS Identity Provider configured for the realm.
Access Control: * The calling principal must have **"readMtlsIdentityProviders"** action permission for the resource **"{realm}"** in the **"account"** service. * The calling principal MUST NOT include a project scope. - [Get the list of mTLS Identity Providers](https://docs.here.com/identity-and-access-management/reference/getmtlsidentityproviders.md): Get the list of mTLS Identity Providers configured for the realm.
Access Control: * The calling principal must have **"readMtlsIdentityProviders"** action permission for the resource **"{realm}"** in the **"account"** service. * The calling principal MUST NOT include a project scope. - [List the mTLS Authenticators configured for an App](https://docs.here.com/identity-and-access-management/reference/listmtlsauthenticatorsforapp.md): Get the list of mTLS Authenticators that the app is configured to authenticate certificates for the associated mTLS Identity Provider.
Access Control: * The calling principal must have **"read"** action permission for the resource **"{app}"** in the **"account"** service and **"readMtlsIdentityProviders"** action permission for the resource **"{realm}"** in the **"account"** service. * The calling principal MUST NOT include a project scope. - [List the mTLS Authenticators configured for the specified mTLS Identity Provider](https://docs.here.com/identity-and-access-management/reference/listmtlsauthenticatorsforidp.md): Get the list of mTLS Authenticators that are configured to authenticate certificates for the specified mTLS Identity Provider.
An mTLS Identity Provider always has **1** mTLS Authenticator configured automatically by default: * The Default Authenticator is capable of authenticating certificates issued by the Certificate Authority of the mTLS Identity Provider. * The Default Authenticator maps each authenticating certificate to an identity of **accountType** __car__ in the realm * The Default Authenticator uses the Subject.CN field from the certificate to identify and map to the **carId** field of the car * The Default Authenticator is automatically created with a new app in the realm that is included in all access tokens provided by the authenticator * The Default Authenticator is enabled by default when it is created * The Default Authenticator and its corresponding app is automatically deleted when its mTLS Identity Provider is deleted
Access Control: * The calling principal must have **"readMtlsIdentityProviders"** action permission for the resource **"{realm}"** in the **"account"** service. * The calling principal MUST NOT include a project scope. - [Update an mTLS Authenticator](https://docs.here.com/identity-and-access-management/reference/updatemtlsauthenticatorforidp.md): Update an mTLS Authenticator configured to authenticate certificates for the specified mTLS Identity Provider.
Access Control: * The calling principal must have **"manageMtlsIdentityProviders"** action permission for the resource **"{realm}"** in the **"account"** service. * The calling principal MUST NOT include a project scope. - [Update mTLS Identity Provider](https://docs.here.com/identity-and-access-management/reference/updatemtlsidentityprovider.md): Update an mTLS Identity Provider configured for the realm.
Access Control: * The calling principal must have **"manageMtlsIdentityProviders"** action permission for the resource **"{realm}"** in the **"account"** service. * The calling principal MUST NOT include a project scope. - [Create a SAML identity provider](https://docs.here.com/identity-and-access-management/reference/createidpconfig.md): Create an identity provider * Supports the creation of SAML identity providers. * Addition of identity providers will not enable them by default, it needs to be enabled explicitly.
Access Control: * The calling principal must have **"manageSamlIdentityProviders"** action permission for the resource **"{realm}"** in the **"account"** service. * The calling principal MUST NOT include a project scope. - [Remove SAML identity provider](https://docs.here.com/identity-and-access-management/reference/deleteidpconfig.md): Deletes a SAML identity provider for a realm.
Access Control: * The calling principal must have **"manageSamlIdentityProviders"** action permission for the resource **"{realm}"** in the **"account"** service. * The calling principal MUST NOT include a project scope. - [Disable identity provider](https://docs.here.com/identity-and-access-management/reference/disableidpconfig.md): Disables a SAML identity provider for a realm. If no other enabled SAML identity provider exists, the realm login method will be changed to 'password'.
Access Control: * The calling principal must have **"manageSamlIdentityProviders"** action permission for the resource **"{realm}"** in the **"account"** service. * The calling principal MUST NOT include a project scope. - [Enable identity provider](https://docs.here.com/identity-and-access-management/reference/enableidpconfig.md): Enables a SAML identity provider for a realm. If there is any other enabled SAML identity provider, it will be disabled. The realm's login method will be changed to 'saml'. 'password' logins can also be allowed, if the 'allowPasswordLogin' parameter was provided.
Access Control: * The calling principal must have **"manageSamlIdentityProviders"** action permission for the resource **"{realm}"** in the **"account"** service. * The calling principal MUST NOT include a project scope. - [Get a SAML identity provider](https://docs.here.com/identity-and-access-management/reference/getidpconfig.md): Get a SAML identity provider configuration for a realm.
Access Control: * The calling principal must have **"readSamlIdentityProviders"** action permission for the resource **"{realm}"** in the **"account"** service. * The calling principal MUST NOT include a project scope. - [Get the list of SAML identity providers](https://docs.here.com/identity-and-access-management/reference/getidpconfigs.md): Get the list of SAML identity providers configured with the realm.
Access Control: * The calling principal must have **"readSamlIdentityProviders"** action permission for the resource **"{realm}"** in the **"account"** service. * The calling principal MUST NOT include a project scope. - [Update SAML identity provider](https://docs.here.com/identity-and-access-management/reference/updateidpconfig.md): Update a SAML identity provider for a realm.
Access Control: * The calling principal must have **"manageSamlIdentityProviders"** action permission for the resource **"{realm}"** in the **"account"** service. * The calling principal MUST NOT include a project scope. - [/realms/{realmHrnOrMe}/pricingTermsAcceptance](https://docs.here.com/identity-and-access-management/reference/acceptrealmplatformpricingterms.md): Accept the Platform Pricing Terms.
Access Control: * The calling principal must have **"realmAcceptServiceTerms"** action permission for the resource **"{realm}"** in the **"account"** service. * The calling principal MUST NOT include a project scope. - [/realms/{realmHrnOrMe}/pricingTermsAcceptance](https://docs.here.com/identity-and-access-management/reference/getrealmplatformpricingterms.md): Get the organization's Pricing Terms acceptance details.
Access Control: * The calling principal must have either **"readServiceTerms"** action permission for the resource **"{realm}"** in the **"account"** service. * The calling principal MUST NOT include a project scope. - [/realms/{realmHrnOrMe}/serviceTermsAcceptance](https://docs.here.com/identity-and-access-management/reference/acceptrealmplatformserviceterms.md): Accept the Platform Service Terms.
Access Control: * The calling principal must have either **"realmAcceptServiceTerms"** action permission for the resource **"{realm}"** in the **"account"** service. * The calling principal MUST NOT include a project scope. - [Retrieve Platform Service Terms](https://docs.here.com/identity-and-access-management/reference/getplatformserviceterms.md): Retrieves the Platform Service Terms. The response of this API endpoint may not be applicable to the realms with offline contract signed. - [/realms/{realmHrnOrMe}/serviceTermsAcceptance](https://docs.here.com/identity-and-access-management/reference/getrealmplatformserviceterms.md): Get the realm's Platform Service Terms.
Access Control: * The calling principal must have **"realmAcceptServiceTerms"** action permission for the resource **"{realm}"** in the **"account"** service. * The calling principal MUST NOT include a project scope. - [/realms/{realmHrn}/serviceTermsAcceptanceHistory](https://docs.here.com/identity-and-access-management/reference/getrealmplatformservicetermshistory.md): Get the realm's Platform Service Terms history.
Access Control: * The calling principal must have either **"readServiceTerms"** action permission for the resource **"{realm}"** in the **"account"** service. * The calling principal MUST NOT include a project scope. - [List of supported SAML Identity Provider templates](https://docs.here.com/identity-and-access-management/reference/listofidptemplates.md): List of supported SAML Identity Provider templates.
Access Control: * The calling principal must have **"readIdpTemplates"** action permission in the **"account"** service. * The calling principal MUST NOT include a project scope. - [Create Secret](https://docs.here.com/identity-and-access-management/reference/createsecret.md): Creates a new Secret for use in Platform runtimes. The Secret will be enabled on creation. A maximum of 5 Secrets are maintained per User or App at any given point. A Secret can be used to store third-party credentials for use in Platform runtimes.
Assigns "read", "manage", "addGrant:read", and "addGrant:manage" rights to the caller. The calling User or App can now delegate access to the Secret in more granular fashion, using 'read' or 'manage' to another identity in its Realm using the grants APIs. For secure Production systems, HERE recommends creating a delegate App in your Realm, granting only the 'read' permission to that App via the 'grantReadTo' query string parameter, and using that App as RunAsId in your Platform runtime.
Access Control: * The calling principal must be in a realm of type **"olp"**. * The calling principal MUST NOT include a project scope. - [Delete Secret](https://docs.here.com/identity-and-access-management/reference/deletesecret.md): Deletes the Secret. This Secret is no longer available for authentication or authorization. Since the Secret cannot be recovered once deleted, it is recommended that the caller of this end-point should enforce a confirmation of delete action (Example: Confirm box saying: Are you sure you want to delete this Secret?).
Access Control: * The calling principal must have **"manage"** action permission for the resource **"{secret}"** in the **"account"** service. * The calling principal MUST NOT include a project scope. - [Disable Secret](https://docs.here.com/identity-and-access-management/reference/disablesecret.md): Disables the Secret.
Access Control: * The calling principal must have **"manage"** action permission for the resource **"{secret}"** in the **"account"** service. * The calling principal MUST NOT include a project scope. - [Enable Secret](https://docs.here.com/identity-and-access-management/reference/enablesecret.md): Enables the Secret.
Access Control: * The calling principal must have **"manage"** action permission for the resource **"{secret}"** in the **"account"** service. * The calling principal MUST NOT include a project scope. - [Retrieve Secret](https://docs.here.com/identity-and-access-management/reference/getsecret.md): Retrieves the specified Secret.
Access Control: * The calling principal must have **"read"** action permission for the resource **"{secret}"** in the **"account"** service. * The calling principal MUST NOT include a project scope. - [List Secrets](https://docs.here.com/identity-and-access-management/reference/listsecrets.md): Lists the secrets stored for the calling user or app.
Access Control: * The calling principal must be in a realm of type **"olp"**. * The calling principal MUST NOT include a project scope. - [Update Secret](https://docs.here.com/identity-and-access-management/reference/updatesecret.md): Updates a Secret.
Access Control: * The calling principal must have **"manage"** action permission for the resource **"{secret}"** in the **"account"** service. * The calling principal MUST NOT include a project scope. - [/support](https://docs.here.com/identity-and-access-management/reference/deletesupportaccess.md): Delete the support access entry. * Invalidate any existing logins associated with the deleted support entry * Delete any AccountExecutive user accounts that have been created in the realm that are associated with the deleted support entry
**NOTE:** This API will return 404 if Account Executive support access is not enabled for the realm.
Access Control: * The calling principal must have **"manageAccountExecutives"** permission in the **"account"** service. * The calling principal MUST NOT include a project scope. - [/support](https://docs.here.com/identity-and-access-management/reference/getsupportaccess.md): Get the support access entry that enables AccountExecutive logins for the calling principal's realm.
NOTE: This API will return 404 if Account Executive support access is not enabled for the realm.
Access Control: * The calling principal must have **"readAccountExecutives"** permission in the **"account"** service. * The calling principal MUST NOT include a project scope. - [/support](https://docs.here.com/identity-and-access-management/reference/registersupportaccessuser.md): Register support access for an authorized user or users to enable AccountExecutive logins to the calling principal's realm. The registered authorized user(s) will be allowed to login as Account Executives to the realm. * If the registered authorized user's emailAddress is not the wildcard value '*', an email notification will be sent indicating that the user has been invited as an AccountExecutive to the realm. * If the registered authorized user's emailAddress is the wildcard value '*', no email notification will be sent
**NOTE:** A maximum of 5 individual email addresses and/or a single wildcard entry '*' may be registered for AccountExecutive access. This API is idempotent and may be called repeatedly with the same request parameters. If an already registered email address is provided, a duplicate email notification will be sent.
**NOTE:** This API will return 404 if Account Executive support access is not enabled for the realm.
Access Control: * The calling principal must have **"manageAccountExecutives"** permission in the **"account"** service. * This API is rate limited to a maximum of **6** calls per minute per realm * The calling principal MUST NOT include a project scope. - [Add multiple Trusted Domains to an application](https://docs.here.com/identity-and-access-management/reference/addmanytrusteddomains.md): Add Trusted Domains to an application. A maximum of 3000 Trusted Domains per application are allowed.
Access Control: * The calling principal must have **"manage"** or **"write"** action permission for the resource **"{app}"** in the **"account"** service. * The calling principal MUST NOT include a project scope. - [Add a Trusted Domain to an application](https://docs.here.com/identity-and-access-management/reference/addtrusteddomain.md): Add a Trusted Domain to an application. A maximum of 3000 Trusted Domains per application are allowed.
Access Control: * The calling principal must have **"manage"** or **"write"** action permission for the resource **"{app}"** in the **"account"** service. * The calling principal MUST NOT include a project scope. - [Delete multiple Trusted Domains associated with an application](https://docs.here.com/identity-and-access-management/reference/deletemanytrusteddomains.md): Delete many Trusted Domains associated with an application.
Access Control: * The calling principal must have **"manage"** or **"write"** action permission for the resource **"{app}"** in the **"account"** service. * The calling principal MUST NOT include a project scope. - [Delete a Trusted Domain associated with an application](https://docs.here.com/identity-and-access-management/reference/deletetrusteddomain.md): Delete a Trusted Domain associated with an application.
Access Control: * The calling principal must have **"manage"** or **"write"** action permission for the resource **"{app}"** in the **"account"** service. * The calling principal MUST NOT include a project scope. - [Disable Trusted Domains for an application](https://docs.here.com/identity-and-access-management/reference/disabletrusteddomains.md): Disables Trusted Domains for the application.
Access Control: * The calling principal must have **"manage"** or **"write"** action permission for the resource **"{app}"** in the **"account"** service. * The calling principal MUST NOT include a project scope. - [Enable Trusted Domains for an application](https://docs.here.com/identity-and-access-management/reference/enabletrusteddomains.md): Enables Trusted Domains for the application. A maximum of 3000 Trusted Domains per application are allowed.
Access Control: * The calling principal must have **"manage"** or **"write"** action permission for the resource **"{app}"** in the **"account"** service. * The calling principal MUST NOT include a project scope. - [Retrieve a Trusted Domain associated with an application](https://docs.here.com/identity-and-access-management/reference/gettrusteddomain.md): Retrieve a Trusted Domain associated with an application.
Access Control: * The calling principal must have **"read"** action permission for the resource **"{app}"** in the **"account"** service. * The calling principal MUST NOT include a project scope. - [Retrieve whether Trusted Domains is enabled/disabled for an application](https://docs.here.com/identity-and-access-management/reference/gettrusteddomainsenabled.md): Whether Trusted Domains is enabled, or disabled, for the application.
Access Control: * The calling principal must have **"read"** action permission for the resource **"{app}"** in the **"account"** service. * The calling principal MUST NOT include a project scope. - [Retrieve a list of Trusted Domains associated with an application](https://docs.here.com/identity-and-access-management/reference/listtrusteddomains.md): Retrieve a list of Trusted Domains associated with an application.
Access Control: * The calling principal must have **"read"** action permission for the resource **"{app}"** in the **"account"** service. * The calling principal MUST NOT include a project scope. - [Activate User Account](https://docs.here.com/identity-and-access-management/reference/activateuseraccount.md): Activate the provided user account.
Access Control: * The calling principal must have **"manage"** action permission for the resource **"{user}"** in the **"account"** service. * The calling principal MUST NOT include a project scope. - [Deactivate User Account](https://docs.here.com/identity-and-access-management/reference/deactivateuseraccount.md): Deactivate the provided user account. All access tokens will be invalidated.
Access Control: * The calling principal must have **"manage"** action permission for the resource **"{user}"** in the **"account"** service. * The calling principal MUST NOT include a project scope. - [Delete User Account](https://docs.here.com/identity-and-access-management/reference/deleteuseraccount.md): Delete the provided user account.
Access Control: * The calling principal must have **"manage"** action permission for the resource **"{user}"** in the **"account"** service. * The calling principal MUST NOT include a project scope. - [Get Accessible Applications of a User](https://docs.here.com/identity-and-access-management/reference/getusermanagedapps.md): List the applications which the provided user has been assigned an exact matching permission over OR a group the provided user is a member of has been assigned an exact match permission.
Access Control: * The calling principal must have **"manage"** action permission for the resource **"{user}"** in the **"account"** service. * The calling principal MUST NOT include a project scope. - [Create Access Filter](https://docs.here.com/identity-and-access-management/reference/createaccessfilter.md): Create an Access Filter available to be attached to a user or app to control access. A maximum of 100 Access Filters may be created in a realm.
Access Control: * The calling principal must have **"manageAccessFilters"** action permission in the **"authorization"** service. * The calling principal MUST NOT include a project scope. - [Delete Access Filter](https://docs.here.com/identity-and-access-management/reference/deleteaccessfilter.md): Delete an Access Filter.
Access Control: * The calling principal must have **"manageAccessFilters"** action permission in the **"authorization"** service. * The calling principal MUST NOT include a project scope. - [Get Access Filter](https://docs.here.com/identity-and-access-management/reference/getaccessfilter.md): Get the details of an Access Filter.
Access Control: * The calling principal must have **"readAccessFilters"** action permission in the **"authorization"** service. * The calling principal MUST NOT include a project scope. - [Get Access Filter Members](https://docs.here.com/identity-and-access-management/reference/getaccessfiltermembers.md): Get the list of realm members that are assigned this Access Filter.
Access Control: * The calling principal must have **"readAccessFilters"** action permission in the **"authorization"** service. * The calling principal MUST NOT include a project scope. - [Get Access Filters](https://docs.here.com/identity-and-access-management/reference/getaccessfilters.md): Retrieve the list of Access Filters available.
Access Control: * The calling principal must have **"readAccessFilters"** action permission in the **"authorization"** service. * The calling principal MUST NOT include a project scope. - [Update Access Filter](https://docs.here.com/identity-and-access-management/reference/updateaccessfilter.md): Update an Access Filter.
Access Control: * The calling principal must have **"manageAccessFilters"** action permission in the **"authorization"** service. * The calling principal MUST NOT include a project scope. - [Create or update a cross realm trust](https://docs.here.com/identity-and-access-management/reference/createcrossrealmtrust.md): Create or update a CrossRealmTrust that allows LinkableResources to be received from the source of the resource. The source HRN is defined by either the home project or the realm of the resource. The CrossRealmTrust is established with a target specified in the path which could either be a specific project or the entire realm. An access token from an identity with appropriate privileges in the target realm should be used to create/update the CrossRealmTrust.
Access Control: * The calling principal must have **"manageCrossRealmTrust"** action permission for the resource **"{realm}"** in the **"authorization"** service. The **"{realm}"** here represents the HRN of represent the target realm. * This permission is granted to all entities with roles OrgAdmin or CrossRealmTrustManager. * The calling principal MUST NOT include a project scope. - [Delete a cross realm trust](https://docs.here.com/identity-and-access-management/reference/deletecrossrealmtrust.md): Delete an existing CrossRealmTrust to no longer allow LinkableResources to be offered by the source Project or Realm into the context of the target Realm or a Project therein. Deleting an existing CrossRealmTrust will disable the accessibility of any resources already linked to the projects of the target realm. It will also hide any resources already made available to the target realm. An access token from an identity with appropriate privileges in the target realm should be used to delete the CrossRealmTrust.
Access Control: * The calling principal must have **"manageCrossRealmTrust"** action permission for the resource **"{realm}"** in the **"authorization"** service. The **"{realm}"** here represents the HRN of represent the target realm. * This permission is granted to all entities with roles OrgAdmin or CrossRealmTrustManager. * The calling principal MUST NOT include a project scope. - [Get a cross realm trust](https://docs.here.com/identity-and-access-management/reference/getcrossrealmtrust.md): Get a single CrossRealmTrust object identified by source and target realms or projects. An entity can get the CrossRealmTrust created for its realm or granted from its realm to other realms based on the "rlm" claim in the access token.
Access Control: * The calling principal must have **"readCrossRealmTrust"** action permission for the resource **"{realm}"** in the **"authorization"** service. The **"{realm}"** here represents the HRN of the target realm. * This permission is granted to all entities by default policy. This permission is also explicitly granted to all entities with roles OrgAdmin or CrossRealmTrustManager. * The calling principal MUST NOT include a project scope. - [Get a list of cross realm trusts](https://docs.here.com/identity-and-access-management/reference/getcrossrealmtrusts.md): Get a list of CrossRealmTrusts established for the Realm or Project of the requesting User or App, where the realm/project is either source or target. An entity can get the CrossRealmTrusts created for its realm/project or granted from its realm/project to other realms/projects based on the "rlm" claim in the access token. Among query parameters sourceRealm, sourceProject, targetProject and targetRealm supports only one filter at a time. Caller entity's realm must match realm specified in sourceProject or targetProject query parameter.
Access Control: * The calling principal must have **"readCrossRealmTrust"** action permission for the resource **"{realm}"** in the **"authorization"** service. The **"{realm}"** here represents the HRN of the target realm. * This permission is granted to all entities by default policy. This permission is also explicitly granted to all entities with roles OrgAdmin or CrossRealmTrustManager. * The calling principal MUST NOT include a project scope. - [Grant access to a resource to an entity.](https://docs.here.com/identity-and-access-management/reference/addgrant.md): Grant access to a resource to an entity. The result of this call is that the specified entity will have permission to take the specified action against the specified resource.
Access Control: * The calling principal must have either **"addGrant:{actionId}"** or **"share"** action permission for the resource **"{resourceHrn}"** in the **"authorization"** service. * The realm of the calling principal MUST match the realm of the requested app. * The calling principal MUST NOT include a project scope. - [Get a single grant given to an entity](https://docs.here.com/identity-and-access-management/reference/getgrant.md): Get a single grant given to an entity. This calls returns any permission to take the specified action against the specified resource on the requested entity.
Access Control: * The calling principal must have either **"listGrants"** or **"share"** action permission for the resource **"{resourceHrn}"** in the **"authorization"** service. * The realm of the calling principal MUST match the realm of the requested app. * The calling principal MUST NOT include a project scope. - [Get grants given to a user, app, or group](https://docs.here.com/identity-and-access-management/reference/getgrants.md): Get grants. This call describes the permissions assigned to the specified entity that grant access to the specified resource. Empty list is returned if no permissions are found for the resource hrn provided regardless of the resource being present or not
Access Control: * The calling principal must have either **"listGrants"** or **"share"** action permission for the resource **"{resourceHrn}"** in the **"authorization"** service. * The realm of the calling principal MUST match the realm of the requested app. * The calling principal MUST NOT include a project scope. - [List grants on users, apps, or groups](https://docs.here.com/identity-and-access-management/reference/listgrants.md): List grants on user, apps, or groups. This call describes the permissions assigned to any user, app, or group **in the same realm as the calling principal unless includeCrossRealmGrants is true** that has been granted access to the specified resource through an exact matching permission. Permissions granted through policies and roles are not included.
Access Control: * The calling principal must have either **"listGrants"** or **"share"** action permission for the resource **"{resourceHrn}"** in the **"authorization"** service. * The realm of the calling principal MUST match the realm of the requested app. * The calling principal MUST NOT include a project scope. - [Revoke access to a resource from an entity](https://docs.here.com/identity-and-access-management/reference/removegrant.md): Revoke access to a resource from an entity. The result of this call is that the specified entity will have any directly assigned permission to take the specified action against the specified resource removed.
Access Control: * The calling principal must have either **"removeGrant:{actionId}"** or **"share"** action permission for the resource **"{resourceHrn}"** in the **"authorization"** service. * The realm of the calling principal MUST match the realm of the requested entity. * The calling principal MUST NOT include a project scope. - [Add a member to a group](https://docs.here.com/identity-and-access-management/reference/addgroupmember.md): Add a single member to a group.
Access Control: * The calling principal must have **"manageMembers"** action permission for the resource **"{group}"** in the **"authorization"** service. Here **group** is the group identified by the provided group HRN. * The calling principal MUST NOT include a project scope. - [Create group](https://docs.here.com/identity-and-access-management/reference/creategroup.md): Create a group within the realm that is associated with the calling party. The calling party will be made a member and an administrator of the created group.
Access Control: * The calling principal must have **"createGroup"** action permission for the calling party **"{realm}"** in the **"authorization"** service. * The calling principal MUST NOT include a project scope. - [delete group](https://docs.here.com/identity-and-access-management/reference/deletegroup.md): Delete the group identified by the provided group HRN.
Access Control: * The calling principal must have **"deleteGroup"** action permission for the resource **"{group}"** in the **"authorization"** service. Here **group** is the group identified by the provided group HRN. * The calling principal MUST NOT include a project scope. - [Get single group](https://docs.here.com/identity-and-access-management/reference/getgroup.md): Retrieve the group identified by the provided group HRN.
Access Control: * The calling principal must have **"readMembers"** action permission for the calling party **"{realm}"** in the **"authorization"** service. * The calling principal MUST NOT include a project scope. - [Get single Group member](https://docs.here.com/identity-and-access-management/reference/getgroupmember.md): Retrieve a single group member.
Access Control: * The calling principal must have **"readMembers"** action permission for the resource **"{group}"** in the **"authorization"** service. Here **group** is the group identified by the provided group HRN. * The calling principal MUST NOT include a project scope. - [Get Group members](https://docs.here.com/identity-and-access-management/reference/getgroupmembers.md): Retrieve the list of members of the group identified by the provided group HRN.
Access Control: * The calling principal must have **"readMembers"** action permission for the resource **"{group}"** in the **"authorization"** service. Here **group** is the group identified by the provided group HRN. * The calling principal MUST NOT include a project scope. - [Get group permissions](https://docs.here.com/identity-and-access-management/reference/getgrouppermissions.md): Retrieve the **unscoped** permissions a given group has been assigned.
Access Control: * The calling principal must have **"readPermissions"** action permission for the resource **"{group}"** in the **"authorization"** service. Here **group** is the group identified by the provided group HRN. * The calling principal MUST NOT include a project scope. - [Get Group Policies](https://docs.here.com/identity-and-access-management/reference/getgrouppolicies.md): Get all policies attached to the requested group.
Access Control: * The calling principal must have **"readPolicies"** action permission for the resource **"{group}"** in the **"authorization"** service. Here **group** is the group identified by the provided group HRN. - [Get Group Policy Permissions](https://docs.here.com/identity-and-access-management/reference/getgrouppolicypermissions.md): Get all **unscoped** permissions that are in a policy attached to the requested group.
Access Control: * The calling principal must have **"readPolicies"** action permission for the resource **"{group}"** in the **"authorization"** service. Here **group** is the group identified by the provided group HRN. - [Get group roles](https://docs.here.com/identity-and-access-management/reference/getgrouproles.md): List the roles which are associated with the provided group.
Access Control: * The calling principal must have **"readRoles"** action permission for the resource **"{group}"** in the **"authorization"** service. Here **group** is the group identified by the provided group HRN. * The calling principal MUST NOT include a project scope. - [Get groups](https://docs.here.com/identity-and-access-management/reference/getgroups.md): Retrieve the list of groups within the realm associated with the calling party.
Access Control: * The calling principal must have **"readMembers"** action permission for the calling party **"{realm}"** in the **"authorization"** service. * The calling principal MUST NOT include a project scope. - [Get My Groups](https://docs.here.com/identity-and-access-management/reference/getmygroups.md): Retrieve a list of groups of a member.
Access Control: * The calling principal MUST NOT include a project scope. - [Removes the calling party from a group](https://docs.here.com/identity-and-access-management/reference/leavegroup.md): Remove the calling party from the group. This operation will also remove administrative roles from this member.
Access Control: * The calling principal must have **"manageMembers"** action permission for the resource **"{group}"** in the **"authorization"** service. Here **group** is the group identified by the provided group HRN. * The calling principal MUST NOT include a project scope. - [Remove a member from the group.](https://docs.here.com/identity-and-access-management/reference/removegroupmember.md): Remove a member from the group. This operation will also remove administrative roles from this member.
Access Control: * The calling principal must have **"manageMembers"** action permission for the resource **"{group}"** in the **"authorization"** service. Here **group** is the group identified by the provided group HRN. * The calling principal MUST NOT include a project scope. - [Update group](https://docs.here.com/identity-and-access-management/reference/updategroup.md): Update the group identified by the provided group HRN by updating all writable group fields including name and description.
Access Control: * The calling principal must have **"updateGroup"** action permission for the resource **"{group}"** in the **"authorization"** service. Here **group** is the group identified by the provided group HRN. * The calling principal MUST NOT include a project scope. - [Add the member to the requested Project](https://docs.here.com/identity-and-access-management/reference/addprojectmember.md): Add the member to the requested Project.
Access Control: * The calling principal must have **"manageMembers"** action permission for the resource **"{project}"** in the **"authorization"** service. * The calling principal MUST NOT include a project scope. - [Attach Project Policy to Member](https://docs.here.com/identity-and-access-management/reference/attachprojectpolicytomember.md): Attaches the Project Policy to the member of the Project.
Access Control: * The calling principal must have both **"manageMembers"** and **"managePolicies"** action permissions for the resource **"{project}"** in the **"authorization"** service. * In the Project workflow, the above permission is granted to all Project Admins and Resource Managers. * The calling principal MUST NOT include a project scope. - [Attach a single Project Policy to all Members of a Project](https://docs.here.com/identity-and-access-management/reference/attachprojectpolicytoproject.md): Attaches the Project Policy to all members of the specified Project. Attaching a ProjectPolicy at the Project-level means its permissions will be applied for all Project members.
**Note:** The maximum number of ProjectPolicies attached at the Project-level is 5.
Access Control: * The calling principal must have both **"manageMembers"** and **"managePolicies"** action permissions for the resource **"{project}"** in the **"authorization"** service. * In the Project workflow, the above permission is granted to all Project Admins and Resource Managers. * The calling principal MUST NOT include a project scope. - [Create the requested Project Policy](https://docs.here.com/identity-and-access-management/reference/createprojectpolicy.md): Create the requested custom policy in the Project.
Access Control: * The calling principal must have **"managePolicies"** action permission for the resource **"{project}"** in the **"authorization"** service. * In the Project workflow, the above permission is granted to all Project Admins and Resource Managers. * The calling principal MUST NOT include a project scope. - [Remove the member from the specified Project](https://docs.here.com/identity-and-access-management/reference/deleteprojectmember.md): Remove the member from the specified Project.
Access Control: * The calling principal must have **"manageMembers"** action permission for the resource **"{project}"** in the **"authorization"** service. * The calling principal MUST NOT include a project scope. - [Delete the custom Project Policy](https://docs.here.com/identity-and-access-management/reference/deleteprojectpolicy.md): Delete the custom policy in the Project.
Access Control: * The calling principal must have **"managePolicies"** action permission for the resource **"{project}"** in the **"authorization"** service. * In the Project workflow, the above permission is granted to all Project Admins and Resource Managers. * The calling principal MUST NOT include a project scope. - [Detach the Project Policy from a Member](https://docs.here.com/identity-and-access-management/reference/detachprojectpolicyfrommember.md): Detached the requested custom Project Policy from a Member.
Access Control: * The calling principal must have both **"manageMembers"** and **"managePolicies"** action permissions for the resource **"{project}"** in the **"authorization"** service. * In the Project workflow, the above permission is granted to all Project Admins and Resource Managers. * The calling principal MUST NOT include a project scope. - [Detach the Project Policy from the Project-level for all Members](https://docs.here.com/identity-and-access-management/reference/detachprojectpolicyfromproject.md): Detached the requested custom Project Policy from the Project. The specified ProjectPolicy will no longer be applied to all Project members, unless attached to them individually or through their group membership.
The ProjectPolicy is still available to attach to individual members.
Access Control: * The calling principal must have both **"manageMembers"** and **"managePolicies"** action permissions for the resource **"{project}"** in the **"authorization"** service. * In the Project workflow, the above permission is granted to all Project Admins and Resource Managers. * The calling principal MUST NOT include a project scope. - [Get the list of all Project Members with the attached Policy](https://docs.here.com/identity-and-access-management/reference/getallprojectmemberswithattachedpolicy.md): Get the list of all Project Members with the attached Policy.
Access Control: * The calling principal must have **"read"** action permission for the resource **"{project}"** in the **"authorization"** service. * In the Project workflow, the above permission is granted to all Project Members, Project Admins, Org Admins. * The calling principal MUST NOT include a project scope. - [Get the list of Attached Project Policies For a Member](https://docs.here.com/identity-and-access-management/reference/getattachedprojectpoliciesformember.md): Get the list of Attached Project Policies For a Member.
Access Control: * The calling principal must have **"read"** action permission for the resource **"{project}"** in the **"authorization"** service. * In the Project workflow, the above permission is granted to all Project Members, Project Admins, Org Admins. * The calling principal MUST NOT include a project scope. - [Get the list of Attached Project Policies For all Members of a Project](https://docs.here.com/identity-and-access-management/reference/getattachedprojectpoliciesforproject.md): Get the list of Attached Project Policies For all Members of a Project.
**Note:** The maximum number of ProjectPolicies attached at the Project-level is 5.
Access Control: * The calling principal must have **"read"** action permission for the resource **"{project}"** in the **"authorization"** service. * In the Project workflow, the above permission is granted to all Project Members, Project Admins, Org Admins. * The calling principal MUST NOT include a project scope. - [Get the attached Project Policy for a Member](https://docs.here.com/identity-and-access-management/reference/getattachedprojectpolicyformember.md): Get the attached Project Policy For a Member.
Access Control: * The calling principal must have **"read"** action permission for the resource **"{project}"** in the **"authorization"** service. * In the Project workflow, the above permission is granted to all Project Members, Project Admins, Org Admins. * The calling principal MUST NOT include a project scope. - [Get the attached Project Policy at the Project-level.](https://docs.here.com/identity-and-access-management/reference/getattachedprojectpolicyforproject.md): Get the attached Project Policy at the Project-level.
**Note:** The maximum number of ProjectPolicies attached at the Project-level is **5**.
Access Control: * The calling principal must have **"read"** action permission for the resource **"{project}"** in the **"authorization"** service. * In the Project workflow, the above permission is granted to all Project Members, Project Admins, Org Admins. * The calling principal MUST NOT include a project scope. - [Get Effective Permissions for Member](https://docs.here.com/identity-and-access-management/reference/geteffectiveprojectpermissionsformember.md): Get the list of **scoped** permissions that are effective for this member when operating in the project scope.
Access Control: * The calling principal must have **"read"** action permission for the resource **"{project}"** in the **"authorization"** service. * In the Project workflow, the above permission is granted to all Project Members, Project Admins, Org Admins. * The calling principal MUST NOT include a project scope. - [Get Project Access Filter](https://docs.here.com/identity-and-access-management/reference/getprojectaccessfilter.md): Retrieve the Access Filter attached to this project.
Access Control: * The calling principal must have **"read"** action permission for the resource **"{project}"** in the **"authorization"** service. * The calling principal MUST NOT include a project scope. - [Get project linkable permissions](https://docs.here.com/identity-and-access-management/reference/getprojectlinkablepermissions.md): Get the list of **linkable** permissions that are associated with resources in the realm that have been specifically made available to be linked to the requested project and can be done so by the requested member. Note this list does NOT include linkable permissions associated with resource plans attached to the realm.
Access Control: * The calling principal must have **"read"** action permission for the resource **"{project}"** in the **"authorization"** service. * The calling principal MUST NOT include a project scope. - [Get the requested Project Member](https://docs.here.com/identity-and-access-management/reference/getprojectmember.md): Get the requested Project Member.
Access Control: * The calling principal must have **"read"** action permission for the resource **"{project}"** in the **"authorization"** service. * The calling principal MUST NOT include a project scope. - [Get the Project Policy](https://docs.here.com/identity-and-access-management/reference/getprojectpolicy.md): Get the requested Project Policy.
Access Control: * The calling principal must have **"read"** action permission for the resource **"{project}"** in the **"authorization"** service. * In the Project workflow, the above permission is granted to all Project Members, Project Admins, Org Admins. * The calling principal MUST NOT include a project scope. - [List the Policies in a Project](https://docs.here.com/identity-and-access-management/reference/getprojectpolicylist.md): List the Policies that can be attached to members of the Project. This list will contain all the HERE provided policies and any custom user defined policies created in the Project.
Access Control: * The calling principal must have **"read"** action permission for the resource **"{project}"** in the **"authorization"** service. * In the Project workflow, the above permission is granted to all Project Members, Project Admins, Org Admins. * The calling principal MUST NOT include a project scope. - [Get the Project Settings.](https://docs.here.com/identity-and-access-management/reference/getprojectsettings.md): Get the Project Settings for the specified Project. The setting *defaultNewMemberProjectPolicies* defines the default ProjectPolicy(ies) that are applied to new Project members when they are added to the Project. For a newly-created Project, there are two *defaultNewMemberProjectPolicies* set: * all-access-all-project-resources * resource-creation-access-all-project-resources
Access Control: * The calling principal must have **"read"** action permission for the resource **"{project}"** in the **"authorization"** service. * In the Project workflow, the above permission is granted to all Project Members, Project Admins, Org Admins. * The calling principal MUST NOT include a project scope. - [Remove the caller from the specified Project](https://docs.here.com/identity-and-access-management/reference/leaveproject.md): Remove the caller from the specified Project.
Access Control: * The calling principal MUST NOT include a project scope. - [Get the list of members of the Project](https://docs.here.com/identity-and-access-management/reference/listprojectmembers.md): Get the list of members of the Project. **Note:** If 'onlyIncludeIdentities' query parameter is set to true, 'total' is NOT returned in Response.
Access Control: * The calling principal must have **"read"** action permission for the resource **"{project}"** in the **"authorization"** service. * In the Project workflow, the above permission is granted to all Project Members, Project Admins, Org Admins. * The calling principal MUST NOT include a project scope. - [Set Attached Policies for Member](https://docs.here.com/identity-and-access-management/reference/setattachedprojectpoliciestomember.md): Sets the Attached Policies list for the specified Project Member, overwriting any pre-existing Attached Policies. The request body will replace any pre-existing Policy attachment(s), and replace that list with those Policies identified in the request body.
Access Control: * The calling principal must have both **"manageMembers"** and **"managePolicies"** action permissions for the resource **"{project}"** in the **"authorization"** service. * In the Project workflow, the above permission is granted to all Project Admins and Resource Managers. * The calling principal MUST NOT include a project scope. - [Set Attached Policies for all Members](https://docs.here.com/identity-and-access-management/reference/setattachedprojectpoliciestoproject.md): Sets the Attached Policies list for all Project Members, overwriting any pre-existing Attached Policies at the Project-level. Setting these ProjectPolicies as Attached at the Project-level means their permissions will be applied for all Project members. Project Policies attached at the Project-level will be added to any Project Policies that have been directly attached to any Member Group, User, App, or Device. The request body will replace any pre-existing Policy attachment(s), and replace that list with those Policies identified in the request body.
**Note:** The maximum number of ProjectPolicies attached at the Project-level is 5.
Access Control: * The calling principal must have both **"manageMembers"** and **"managePolicies"** action permissions for the resource **"{project}"** in the **"authorization"** service. * In the Project workflow, the above permission is granted to all Project Admins and Resource Managers. * The calling principal MUST NOT include a project scope. - [Update the requested Project Policy](https://docs.here.com/identity-and-access-management/reference/updateprojectpolicy.md): Update the requested custom policy in the Project.
Access Control: * The calling principal must have **"managePolicies"** action permission for the resource **"{project}"** in the **"authorization"** service. * In the Project workflow, the above permission is granted to all Project Admins and Resource Managers. * The calling principal MUST NOT include a project scope. - [Update the ProjectSettings for a Project.](https://docs.here.com/identity-and-access-management/reference/updateprojectsettings.md): Update the Project Settings.
The setting *defaultNewMemberProjectPolicies* defines the default ProjectPolicy(ies) that are applied to new Project members when they are added to the Project. For a newly-created Project, there are two *defaultNewMemberProjectPolicies* set: * all-access-all-project-resources * resource-creation-access-all-project-resources
Access Control: * The calling principal must have **"manage"** action permission for the resource **"{project}"** in the **"authorization"** service. * In the Project workflow, the above permission is granted to all Project Admins and Resource Managers. * The calling principal MUST NOT include a project scope. - [Checks the existance of a project in caller realm.](https://docs.here.com/identity-and-access-management/reference/checkprojectexistance.md): Checks whether a project exists with requested project hrn in caller realm. If project does not exist in the same realm it will return 404.
Access Control: * The calling principal MUST NOT include a project scope. - [Create the requested Project](https://docs.here.com/identity-and-access-management/reference/createproject.md): Create the requested Project in the callers realm
Access Control: * The calling principal must have **"createProject"** action permission in the **"authorization"** service. * The calling principal MUST NOT include a project scope. - [Delete the specified Project](https://docs.here.com/identity-and-access-management/reference/deleteproject.md): Delete the specified Project.
Access Control: * The calling principal must have **"manage"** action permission for the resource **"{project}"** in the **"authorization"** service. * The calling principal MUST NOT include a project scope. - [Get the list of all Projects in the Org](https://docs.here.com/identity-and-access-management/reference/getallprojectlist.md): Get the list of all Projects in the Organization.
Access Control: * The calling principal must have **"listAllProjects"** action permission in the **"authorization"** service. * The calling principal MUST NOT include a project scope. - [Get the requested Project](https://docs.here.com/identity-and-access-management/reference/getproject.md): Get the requested Project.
Access Control: * The calling principal must have **"read"** action permission for the resource **"{project}"** in the **"authorization"** service. * The calling principal MUST NOT include a project scope. - [Get the list of Projects that you are a project admin or a member based on the "canManage" or "isMember" parameter's value](https://docs.here.com/identity-and-access-management/reference/getprojectlist.md): Get the list of Projects you are a project admin or a member based on the "canManage" or "isMember" parameter's value.
**Note:** If neither "canManage" nor "isMember" is specified, "isMember=true" projects are returned. Supported values for "canManage" / "isMember" is : [true]
Access Control: * The calling principal MUST NOT include a project scope. - [Update the specified Project](https://docs.here.com/identity-and-access-management/reference/patchproject.md): Update the specified Project.
Access Control: * The calling principal must have **"write"** action permission for the resource **"{project}"** in the **"authorization"** service. * The calling principal MUST NOT include a project scope. - [Add a resource to the requested Project as a Resource Home or Resource Reference(Link)](https://docs.here.com/identity-and-access-management/reference/addprojectresourcerelation.md): Add the resource to the requested Project as a home or a reference(link).
Access Control: * **When relation=home**, The requested resource will be assigned the requested project as its resource home. The resource **MUST NOT** already have an existing resource home. * The calling principal must have **manageResourceHome** action permission for the resource **"{project}"** **AND** the **share** action for the resource **"{resource}"** in the **"{authorization}"** service. * The calling principal must have **manageResourceHome** action permission for the specified project in the **"{authorization}"** service **AND** all **requiredToAddToProjects** actions defined by the service for the resource **"{resource}"**. * The calling principal MUST NOT include a project scope. * **When relation=reference**, Link the resource to the requested Project as a reference(link). The requested resource will be assigned to the requested project as reference(link). The resource **MUST** be available to the caller to attach as a resource reference(link). A resource is referenceable if it has been marked as referenceable and the caller has permission to all reference enabled actions against the resource OR The resource has been made linkable to the project/realm for the project linking enabled action. The exclusive list of resources available to the caller to attach as a resource reference(link) is accessible via a call to /resources?referenceable=true or /resources?linkable=true * The calling principal must have **manageResourceReferences** action permission for the resource **"{project}"** in the **"{authorization}"** service. * The calling principal is a **member** of the specified project. * The calling principal must have permission to attach the resource as a referenceable resource. A resource is referenceable to the caller if: * It has been marked as referenceable and The caller has permission to all reference enabled actions against the resource. OR * The resource has been made linkable to the project/realm for the project linking enabled action * This API works for tokens with or without a project scope. - [Add resources to the requested Project as a Resource Home or Resource Reference(Link)](https://docs.here.com/identity-and-access-management/reference/addprojectresourcerelations.md): Add a list of resources to the requested Project as a home or a reference(link).
Access Control: * **When relation=home**, The requested resources will be assigned to the requested project as their resource home. This API is idempotent. Any preexisting resources that already are homed to the specified project, will be silently ignored. Resource type must be specified either in query parameter or for individual resources. When resource type is specified in individual resources, it will take precedence over resource type specified as query parameter. * The calling principal must have **manageResourceHome** action permission for the resource **"{project}"** **AND** the **share** action for the resource **"{resource}"** in the **"{authorization}"** service. * The calling principal must have **manageResourceHome** action permission for the specified project in the **"{authorization}"** service **AND** all **requiredToAddToProjects** actions defined by the service for the resource **"{resource}"**. * The calling principal MUST NOT include a project scope. * **When relation=reference**, Link the resource to the requested Project as a reference(link). The requested resources will be assigned to the requested project as reference(link). The resources **MUST** be available to the caller to attach as a resource reference(link). A resource is referenceable if it has been marked as referenceable and the caller has permission to all reference enabled actions against the resource OR The resource has been made linkable to the project/realm for the project linking enabled action. The exclusive list of resources available to the caller to attach as a resource reference(link) is accessible via a call to /resources?referenceable=true or /resources?linkable=true * The calling principal must have **manageResourceReferences** action permission for the resource **"{project}"** in the **"{authorization}"** service. * The calling principal is a **member** of the specified project. * The calling principal must have permission to attach the resource as a referenceable resource. A resource is referenceable to the caller if: * It has been marked as referenceable and The caller has permission to all reference enabled actions against the resource. OR * The resource has been made linkable to the project/realm for the project linking enabled action * This API works for tokens with or without a project scope. - [Remove a Resource Relation(Home or Link) from a project](https://docs.here.com/identity-and-access-management/reference/deleteprojectresourcereference.md): Remove the resource from the project. The requested resource may only be linked as a reference, or added as a home from outside of Projects. Removing other home resource requires deleting the resource from the resource service. When relation=home, A resource cannot be removed from a project if it belongs to a Resource Policy. Managers of the resource need to remove any ResourcePolicyAttachments before removing the home.
Access Control: * **When relation=home**, * The calling principal must have **"manageResourceHome"** action permission for the resource **"{project}"** in the **"authorization"** service **AND** all **requiredToAddToProjects** actions defined by the service for the specified resource. * **When relation=reference**, * The calling principal must have **"manageResourceReferences"** action permission for the resource **"{project}"** in the **"authorization"** service. If not, check if caller is a project member, otherwise check if calling principal can effectively manage the resource. * The calling principal MUST NOT include a project scope. - [Get a resource that is linked to a Project as either a Resource Home or Resource Reference(Link)](https://docs.here.com/identity-and-access-management/reference/getprojectresource.md): Get the resource that is linked to the requested Project. The requested resource may be linked as either a home or a reference(link).
Access Control: * The calling principal must have **"read"** action permission for the resource **"{project}"** in the **"authorization"** service. * The calling principal MUST NOT include a project scope. - [Get the list of resources in the requested Project & referenced in(linked to) the Project](https://docs.here.com/identity-and-access-management/reference/listprojectresources.md): Get the list of resources in the requested Project & referenced in(linked to) the Project.
Access Control: * The calling principal must have **"read"** action permission for the resource **"{project}"** in the **"authorization"** service. * The calling principal MUST NOT include a project scope. - [Attach Entity Access Filter](https://docs.here.com/identity-and-access-management/reference/attachentityaccessfilter.md): Attach an Access Filter to this entity. A maximum of **5** Access Filters may be attached to a single entity.
Access Control: * The calling principal must have **"manageAccessFilter"** action permission for the resource **"{member}"** in the **"authorization"** service. * The calling principal MUST NOT include a project scope. - [Attach Realm Access Filter](https://docs.here.com/identity-and-access-management/reference/attachrealmaccessfilter.md): Update the Access Filter attached to this realm. Only a single access filter may be attached to a realm. If an Access Filter is already attached to the realm, this operation will replace it with a new one.
Access Control: * The calling principal must have **"manageAccessFilter"** action permission for the resource **"{realm}"** in the **"authorization"** service. * The calling principal MUST NOT include a project scope. - [Cancel a user invitation to a realm](https://docs.here.com/identity-and-access-management/reference/cancelrealmmemberinvite.md): Cancel an invitation to the realm.
Access Control: * The calling principal must have **"manageInvites"** action permission for the resource **"{realm}"** in the **"authorization"** service. * The calling principal MUST NOT include a project scope. - [Create and send a user invitation for a realm](https://docs.here.com/identity-and-access-management/reference/createrealmmemberinvite.md): Create and send an invitation to add a new member to the realm,optionally assign membership to one or more groups if the Inviter is also a **GroupAdmin** for the group and optionally invite with one or more roles assigned.
Access Control: * In order to invite a new user to the **"{realm}"**: * The calling principal must have **"manageInvites"** action permission for the resource **"{realm}"** in the **"authorization"** service. * In order to invite a new user to the **"{realm}"** as a member of the **"{group}"**: * The calling principal must have **"manageInvites"** action permission for the resource **"{realm}"** **AND** **"manageMembers"** action permission for the resource **"{group}"** in the **"authorization"** service. * In order to invite a new user to the **"{realm}"** to have roles. For each **"{role}"**: * The calling principal must have **"manageInvites"** action permission for the resource **"{realm}"** **AND** **"manageEntities"** action permission for the resource **"{role}"** in the **"authorization"** service. * This API is rate limited to a maximum of **6** invites per realm per minute. * The calling principal MUST NOT include a project scope. - [Detach Entity Access Filter](https://docs.here.com/identity-and-access-management/reference/detachentityaccessfilter.md): Remove the Access Filter attached to this entity.
Access Control: * The calling principal must have **"manageAccessFilter"** action permission for the resource **"{member}"** in the **"authorization"** service. * The calling principal MUST NOT include a project scope. - [Get Entity Access Filter](https://docs.here.com/identity-and-access-management/reference/getentityaccessfilter.md): Retrieve an Access Filter attached to this entity.
Access Control: * The calling principal must have **"readAccessFilter"** action permission for the resource **"{member}"** in the **"authorization"** service. * The calling principal MUST NOT include a project scope. - [Get Entity Access Filters](https://docs.here.com/identity-and-access-management/reference/getentityaccessfilters.md): Retrieve the Access Filters attached to this entity.
Access Control: * The calling principal must have **"readAccessFilter"** action permission for the resource **"{member}"** in the **"authorization"** service. * The calling principal MUST NOT include a project scope. - [Get entity group membership](https://docs.here.com/identity-and-access-management/reference/getentitygroupmembership.md): Retrieve the groups a given entity is a member of.
Access Control: * The calling principal must have **"readGroups"** action permission for the resource **"{member}"** in the **"authorization"** service. * The calling principal MUST NOT include a project scope. - [Get entity managed group](https://docs.here.com/identity-and-access-management/reference/getentitymanagedgroups.md): Retrieve the list of groups over which the provided entity has been granted the role of GroupAdmin.
Access Control: * The calling principal must have **"readGroups"** action permission for the resource **"{member}"** in the **"authorization"** service. * The calling principal MUST NOT include a project scope. - [Get entity permissions](https://docs.here.com/identity-and-access-management/reference/getentitypermissions.md): Retrieve the **unscoped** permissions a given entity has been assigned.
Access Control: * The calling principal must have **"readPermissions"** action permission for the resource **"{member}"** in the **"authorization"** service. * The calling principal MUST NOT include a project scope. - [Get Entity Plan Policies](https://docs.here.com/identity-and-access-management/reference/getentityplanpolicies.md): Get all policies associated with a plan attached to the requested entity.
Access Control: * The calling principal must have **"readPlans"** action permission for the resource **"{member}"** in the **"authorization"** service. * The calling principal MUST NOT include a project scope. - [Get Entity Plan Policy Permissions](https://docs.here.com/identity-and-access-management/reference/getentityplanpolicypermissions.md): Get all **unscoped** permissions that are in a policy associated with a plan attached to the requested entity.
Access Control: * The calling principal must have **"readPlans"** action permission for the resource **"{member}"** in the **"authorization"** service. * The calling principal MUST NOT include a project scope. - [Get Entity Plans](https://docs.here.com/identity-and-access-management/reference/getentityplans.md): Get all plans attached to the requested entity. **Note:** Plans can only be attached to apps. Requesting plans attached to a user will return 404.
Access Control: * The calling principal must have **"readPlans"** action permission for the resource **"{member}"** in the **"authorization"** service. * The calling principal MUST NOT include a project scope. - [Get Entity Policies](https://docs.here.com/identity-and-access-management/reference/getentitypolicies.md): Get all policies attached to the requested entity. **Note:** Policies can only be attached to apps. Requesting policies attached to a user will return 404.
Access Control: * The calling principal must have **"readPolicies"** action permission for the resource **"{member}"** in the **"authorization"** service. * The calling principal MUST NOT include a project scope. - [Get Entity Policy Permissions](https://docs.here.com/identity-and-access-management/reference/getentitypolicypermissions.md): Get all **unscoped** permissions that are in a policy attached to the requested entity.
Access Control: * The calling principal must have **"readPolicies"** action permission for the resource **"{member}"** in the **"authorization"** service. * The calling principal MUST NOT include a project scope. - [Get entity project membership](https://docs.here.com/identity-and-access-management/reference/getentityprojectmembership.md): Retrieve the projects a given entity is a member of.
Access Control: * The calling principal must have **"manage"** action permission for the resource **"{member}"** in the **"authorization"** service. - [Get entity roles](https://docs.here.com/identity-and-access-management/reference/getentityroleassignments.md): Retrieve the roles a given entity has been assigned.
Access Control: * The calling principal must have **"readRoles"** action permission for the resource **"{member}"** in the **"authorization"** service. * The calling principal MUST NOT include a project scope. - [Get Policy Permissions](https://docs.here.com/identity-and-access-management/reference/getpolicypermissions.md): Get all **unscoped** permissions associated with a policy that is attached to a realm.
Access Control: * The calling principal must have **"readPolicies"** action permission for the resource **"{realm}"** in the **"authorization"** service. * The calling principal MUST NOT include a project scope. - [Get Realm Access Filter](https://docs.here.com/identity-and-access-management/reference/getrealmaccessfilter.md): Retrieve the Access Filter attached to this realm.
Access Control: * The calling principal must have **"readAccessFilter"** action permission for the resource **"{realm}"** in the **"authorization"** service. * The calling principal MUST NOT include a project scope. - [Get Realm limits](https://docs.here.com/identity-and-access-management/reference/getrealmlimits.md): Retrieve the list of limits associated with this realm. A limit with the same **"type"** __may__ appear in the list multiple times. In this case, the actual limit that is enforced by the same is the highest of all configured values.
Access Control: * The calling principal must have **"readLimits"** action permission for the resource **"{realm}"** in the **"authorization"** service. * The calling principal MUST NOT include a project scope. - [Get realm linkable permissions](https://docs.here.com/identity-and-access-management/reference/getrealmlinkablepermissions.md): Get the list of **linkable** permissions that are associated with all resources in this realm that have specifically been made available to be linked to any project in the realm. Note this list does NOT include linkable permissions associated with resource plans attached to the realm.
Access Control: * The calling principal must have **"readPermissions"** action permission for the resource **"{realm}"** in the **"authorization"** service. * The calling principal MUST NOT include a project scope. - [Get realm member](https://docs.here.com/identity-and-access-management/reference/getrealmmember.md): Retrieve the user or application details of the member defined by member HRN.
Access Control: * The calling principal must have **"readMembers"** action permission for the resource **"{realm}"** in the **"authorization"** service. * The calling principal MUST NOT include a project scope. - [Get list of supported invite targets for the realm](https://docs.here.com/identity-and-access-management/reference/getrealmmemberinvitetargets.md): Get the list of supported invite targets for the realm. An invite target determines what application a user is directed to use in the invitation email. The value **"platform"** is available by default in every realm. Additional supported values are available depending on the realm's configuration.
Access Control: * The calling principal must have **"manageInvites"** action permission for the resource **"{realm}"** in the **"account"** service. * The calling principal MUST NOT include a project scope. - [Get realm members](https://docs.here.com/identity-and-access-management/reference/getrealmmembers.md): Retrieve the list of members within the realm.
Access Control: * The calling principal must have **"readMembers"** action permission for the resource **"{realm}"** in the **"authorization"** service. * The calling principal MUST NOT include a project scope. - [Get realm permissions](https://docs.here.com/identity-and-access-management/reference/getrealmpermissions.md): Retrieve the effective permissions associated with the realm.
Access Control: * The calling principal must have **"readPermissions"** action permission for the resource **"{realm}"** in the **"authorization"** service. * The calling principal MUST NOT include a project scope. - [Get Realm Plan Policies](https://docs.here.com/identity-and-access-management/reference/getrealmplanpolicies.md): Get all policies associated with a plan attached to a realm.
Access Control: * The calling principal must have **"readPlans"** action permission for the resource **"{realm}"** in the **"authorization"** service. * The calling principal MUST NOT include a project scope. - [Get Realm Plan Policy Permissions](https://docs.here.com/identity-and-access-management/reference/getrealmplanpolicypolicies.md): Get all **unscoped** permissions associated with a policy that is in a plan that is attached to a realm.
Access Control: * The calling principal must have **"readPlans"** action permission for the resource **"{realm}"** in the **"authorization"** service. * The calling principal MUST NOT include a project scope. - [Get Realm Plans](https://docs.here.com/identity-and-access-management/reference/getrealmplans.md): Get all plans attached to the requested realm.
Access Control: * The calling principal must have **"readPlans"** action permission for the resource **"{realm}"** in the **"authorization"** service. * The calling principal MUST NOT include a project scope. - [Get Realm Policies](https://docs.here.com/identity-and-access-management/reference/getrealmpolicies.md): Get all policies attached to the requested realm.
Access Control: * The calling principal must have **"readPolicies"** action permission for the resource **"{realm}"** in the **"authorization"** service. * The calling principal MUST NOT include a project scope. - [Get Realm Resource Plan Action Policies](https://docs.here.com/identity-and-access-management/reference/getrealmresourceplanactionpolicies.md): Get all service action policies associated with a resource plan attached to a realm.
Access Control: * The calling principal must have **"readPlans"** action permission for the resource **"{realm}"** in the **"authorization"** service. * The calling principal MUST NOT include a project scope. - [Get Realm Resource Plan Action Policy Permissions](https://docs.here.com/identity-and-access-management/reference/getrealmresourceplanactionpolicypermissions.md): Get all permissions associated with a service action policy that is in a resource plan that is attached to a realm.
Access Control: * The calling principal must have **"readPlans"** action permission for the resource **"{realm}"** in the **"authorization"** service. * The calling principal MUST NOT include a project scope. - [Get Realm Resource Plan Resource Policies](https://docs.here.com/identity-and-access-management/reference/getrealmresourceplanresourcepolicies.md): Get all resource policies associated with a resource plan attached to a realm.
Access Control: * The calling principal must have **"readPlans"** action permission for the resource **"{realm}"** in the **"authorization"** service. * The calling principal MUST NOT include a project scope. - [Get Realm Resource Plan Resource Policy Permissions](https://docs.here.com/identity-and-access-management/reference/getrealmresourceplanresourcepolicypermissions.md): Get all **linkable** permissions associated with a resource policy that is in a resource plan that is attached to a realm.
Access Control: * The calling principal must have **"readPlans"** action permission for the resource **"{realm}"** in the **"authorization"** service. * The calling principal MUST NOT include a project scope. - [Get Realm Resource Plans](https://docs.here.com/identity-and-access-management/reference/getrealmresourceplans.md): Get all resource plans attached to the requested realm.
Access Control: * The calling principal must have **"readPlans"** action permission for the resource **"{realm}"** in the **"authorization"** service. * The calling principal MUST NOT include a project scope. - [Resend an invitation to a user in a realm](https://docs.here.com/identity-and-access-management/reference/resendrealmmemberinvite.md): Resend an invitation to a new member to the realm.
Access Control: * The calling principal must have **"manageInvites"** action permission for the resource **"{realm}"** in the **"authorization"** service. * This API is rate limited to a maximum of **6** invites per realm per minute. * The calling principal MUST NOT include a project scope. - [Search for invitations in a realm](https://docs.here.com/identity-and-access-management/reference/searchrealmmemberinvites.md): Search for invitations in the realm, optionally providing a group.
Access Control: * The calling principal must have either **"manageInvites"** or **"readMembers"** action permission for the resource **"{realm}"** in the **"authorization"** service. * The calling principal MUST NOT include a project scope. - [Update and send an invitation to a user in a realm](https://docs.here.com/identity-and-access-management/reference/sendupdatedrealmmemberinvite.md): Update and resend an invitation to add a new member to the realm, optionally assign membership to one or more groups if the Inviter is also a **GroupAdmin** for the group and optionally invite with one or more roles assigned.
Access Control: * In order to invite a new user to the **"{realm}"**: * The calling principal must have **"manageInvites"** action permission for the resource **"{realm}"** in the **"authorization"** service. * In order to invite a new user to the **"{realm}"** as a member of the **"{group}"**: * The calling principal must have **"manageInvites"** action permission for the resource **"{realm}"** **AND** **"manageMembers"** action permission for the resource **"{group}"** in the **"authorization"** service. * In order to invite a new user to the **"{realm}"** to have roles. For each **"{role}"**: * The calling principal must have **"manageInvites"** action permission for the resource **"{realm}"** **AND** **"manageEntities"** action permission for the resource **"{role}"** in the **"authorization"** service. * This API is rate limited to a maximum of **6** invites per realm per minute. * The calling principal MUST NOT include a project scope. - [Get a list of ways the resource has been made linkable](https://docs.here.com/identity-and-access-management/reference/getlistofwaysresourceislinkable.md): Get a list of ways this resource has been made linkable.
Access Control: * The calling principal must have permission to take all the **"requiredToMakeLinkable"** actions against the service inferred via the reserved resource prefix of the resource in the path in the scope of the home project of the resource. * This API works only with tokens that are scoped to the home project of the resource. - [Get external resources available in the realm to the caller.](https://docs.here.com/identity-and-access-management/reference/getrealmexternalresources.md): Get the list of resources that have been made specifically available in the caller's realm via direct Plan, Policy, or ResourcePlan attachments and are accessible to the caller according to the caller's Access Filters.

This will specifically include:
* Any resource that is accessible in the realm via a Plan attachment to the realm and is an exact match in a permission. * Any resource that is accessible in the realm via a Policy attachment to the realm and is an exact match in a permission. * Any resource that is accessible in the realm via a ResourcePlan attachment to the realm.
The returned list will ONLY include the above. In addition, it will be further filtered according to the following: * If the caller contains NO project scope, the returned list will ONLY include resources accessible to the caller for **unscoped** access according to the Access Filters associated with the caller. * If the caller contains a project scope, the returned list will ONLY include resources accessible to the caller for **scoped** access according to the Access Filters associated with the caller. * The returned list WILL NOT contain resources that are only available via wildcard permissions specified in an attached Plan or Policy on the realm.
Access Control: * The calling principal MAY include a project scope. - [Get a single resource](https://docs.here.com/identity-and-access-management/reference/getresource.md): Get the Resource that the caller is allowed to see based on the input query parameters **Note:** - If the presented access token has **a project scope**: - If **referenceable=true**, the response will ONLY return the resource if it is available to the caller to link to the project in the token's project scope. - If the presented access token has **no scope**: - For **referenceable=true**, the response will ONLY return the resource if it is a HERE public resource that is available to the caller to link to ANY project or available to be linked to ANY project via Resource Plan Attachments or by virtue of being a Linkable resource to the realm - [Get the linkability of a resource](https://docs.here.com/identity-and-access-management/reference/getresourcelinkability.md): Get the availability for linking this resource to either a project or realm.
Access Control: * The calling principal must have permission to take all the **"requiredToMakeLinkable"** actions against the service inferred via the reserved resource prefix of the resource in the path in the scope of the home project of the resource. * This API works only with tokens that are scoped to the home project of the resource. - [Get the requested Projects that the resource belongs to or is referenced in(linked to)](https://docs.here.com/identity-and-access-management/reference/getresourceprojects.md): Get the list of Projects that the resource belongs to or is referenced in(linked to). When includeCrossRealmProjects=true and a cross-realm trust is established between home project or realm of the resource and a project or realm that resource is linked to, then returned list will also include that project. In other cases the returned list will only include projects that are in the caller's realm. **Note:** - If the presented access token has **a project scope**, the response will include: - The home project of the resource - The list of Projects that the resource has been linked to - If the presented access token has **no scope**, the response will include: - The list of Projects filtered out based on the membership of the caller unless includeNonMemberProjects=true.
Access Control for project scoped call: * The calling principal must have permission to take all the **"requiredToMakeLinkable"** actions against the service inferred via the reserved resource prefix of the resource in the path in the scope of the home project of the resource. - [Get a list of resources](https://docs.here.com/identity-and-access-management/reference/getresources.md): Get a list of Resources that the caller is allowed to see based on the input query parameters. **Note:** - If the presented access token has **a project scope**: - The response will only include resources from that project or, - If **referenceable=true** or **linkable=true**, the response will ONLY include the resources that are available to the caller to link to the project in the token's project scope. - If the presented access token has **no scope**: - For access=**default** or access=**manage**: - The response will include resources from all projects that the caller has access to. - For raiEnabled types, the response will also include resources that exist outside of any project. - For all other types, the response will NOT include resources that exist outside of any project. - For access=**readOutsideProject**: - For raiEnabled types, the response will ONLY include resources that exist outside of a project. - For all other types, the response will be empty. - For **referenceable=true** or **linkable=true**, the response will include the HERE public resources that are available to the caller to link to ANY project and all resources available to be linked to ANY project via Resource Plan Attachments or by virtue of being a Linkable resource to the realm - raiEnabled types = [catalog, service, schema, artifact]
Access Control: * This API works for tokens with or without a project scope. - [Get the resource settings](https://docs.here.com/identity-and-access-management/reference/getresourcesettings.md): Get the settings of a resource. By default, all resources are available to be added to a resource policy by entities that have permission to take the "requiredToMakeLinkable" actions against the resource service.
Access Control: * The calling principal must have permission to take all the **"requiredToMakeLinkable"** actions against the service inferred via the reserved resource prefix of the resource in the path in the scope of the home project of the resource. * This API works only with tokens that are scoped to the home project of the resource. - [Get a list of actions for the resource type](https://docs.here.com/identity-and-access-management/reference/getresourcetypeactionlist.md): Gets the actions list for the resource type based on the query parameters. - [Get List of all the resources in the realm of the caller](https://docs.here.com/identity-and-access-management/reference/listrealmresources.md): Get List of all the resources in the realm of the caller.
Access Control: * The calling principal must have **"listRealmResources"** action permission in the **"authorization"** service. * This API works only with tokens that are scoped to a project. - [Make a resource Linkable](https://docs.here.com/identity-and-access-management/reference/makeresourcelinkable.md): Adds a listing to make this resource linkable to either a project or entire realm. The resource must belong to a project to be made linkable. Either projectHrn or realmHrn must be provided to make the resource linkable to.
Access Control: * The calling principal must have permission to take all the **"requiredToMakeLinkable"** actions against the service inferred via the reserved resource prefix of the resource in the path in the scope of the home project of the resource. * This API works only with tokens that are scoped to the home project of the resource. * This API does not support the resources of type **"pipeline"**. - [Remove the linkability of a resource](https://docs.here.com/identity-and-access-management/reference/removeresourcelinkability.md): Remove the linkability of this resource against the requested project or realm. **Note:** This action does not have any impact on pre-existing links.
Access Control: * The calling principal must have permission to take all the **"requiredToMakeLinkable"** actions against the service inferred via the reserved resource prefix of the resource in the path in the scope of the home project of the resource. * This API works only with tokens that are scoped to the home project of the resource. - [Update the linkability of a resource](https://docs.here.com/identity-and-access-management/reference/updateresourcelinkability.md): Update the linkability of this resource against the requested project or realm.
Access Control: * The calling principal must have permission to take all the **"requiredToMakeLinkable"** actions against the service inferred via the reserved resource prefix of the resource in the path in the scope of the home project of the resource. * This API works only with tokens that are scoped to the home project of the resource. * This API does not support the resources of type **"pipeline"**. - [Set or update the resource setting](https://docs.here.com/identity-and-access-management/reference/updateresourcesettings.md): Set or update the resource setting. By default, all resources are available to be added to a resource policy by entities that have permission to take the "requiredToMakeLinkable" actions against the resource service. Optionally a developer managing a resource can mark the resource as available to be added to a resource policy by any entity within its home realm and choose one or more "projectLinkingEnabled" allowed actions for this setting
Access Control: * The calling principal must have permission to take all the **"requiredToMakeLinkable"** actions against the service inferred via the reserved resource prefix of the resource in the path in the scope of the home project of the resource. * This API works only with tokens that are scoped to the home project of the resource. - [Add resources to a resource policy](https://docs.here.com/identity-and-access-management/reference/addresourcestoresourcepolicy.md): Add the specified list of resources to the Resource Policy with allowedActions in a batch. A maximum of 100 resources may be contained in a single Resource Policy. If a batch would push the ResourcePolicy over-limit, the entire batch fails with an error code indicating available capacity. Note: The allowed actions list must match the Resource's resource setting allowed actions available for resource policy. By default all "projectLinkingEnabled" are allowed to be added for a resource in a resource policy. Adding a resource to a resource policy enables the ability of the resource to be made linkable to other realms. This batch API response returns a status that can be polled to get information about the batch request.
Access Control: * The calling principal must have **"manageResourcePolicy"** action permission for the resource **"{resourcePolicy}"** in the **"authorization"** service. **AND** * According to the resource setting, The calling principal **must either** have permission to take all the "requiredToMakeLinkable" actions against the service inferred via the reserved resource prefix of the resource in the path in the scope of the home project of the resource **or** the Resource's resource setting is configured to allow anyone within the home realm of the resource to create a resource policy. * When the access token is project scoped, all the resources added to a resource policy must either be homed or referenced in the project. * This API works for tokens with or without a project scope. - [Add a resource to a resource policy](https://docs.here.com/identity-and-access-management/reference/addresourcetoresourcepolicy.md): Add a resource to the Resource Policy with allowedActions. A maximum of 100 resources may be contained in a single Resource Policy. Note: The allowed actions list must match the Resource's resource setting allowed actions available for resource policy. By default all "projectLinkingEnabled" are allowed to be added for a resource in a resource policy. Adding a resource to a resource policy enables the ability of the resource to be made linkable to other realms.
Access Control: * The calling principal must have **"manageResourcePolicy"** action permission for the resource **"{resourcePolicy}"** in the **"authorization"** service. **AND** * According to the resource setting, The calling principal **must either** have permission to take all the "requiredToMakeLinkable" actions against the service inferred via the reserved resource prefix of the resource in the path in the scope of the home project of the resource **or** the Resource's resource setting is configured to allow anyone within the home realm of the resource to create a resource policy. * When the access token is project scoped, all the resources added to a resource policy must either be homed or referenced in the project. * This API works for tokens with or without a project scope. - [Create a resource policy](https://docs.here.com/identity-and-access-management/reference/createresourcepolicy.md): Create a resource policy. A resource policy packages resources that are to be made linkable to realms. A resource policy can be homed to a project or created outside of the context of a project. Once a resource home is created for the resource policy, all access to the resource policy would need to be in the context of the project scope. For an unscoped resource policy, the creator is granted "manageResourcePolicy", "addGrant:manageResourcePolicy" access on the resource policy HRN. For a resource policy scoped to a project all members of the home project get the "projectEnabled" action "manageResourcePolicy" access on the resource policy.
Access Control: * The calling principal must have **"createResourcePolicy"** action permission in the **"authorization"** service. * The unscoped access to this api is granted via the default authorization policy. * The scoped access to this api is granted via the default "projectEnabled" action for members of the project. * This API works for tokens with or without a project scope. - [Delete resource from a resource policy](https://docs.here.com/identity-and-access-management/reference/deleteresourcefromresourcepolicy.md): Delete a resource from a Resource Policy. Also supports comma-separated list of resources in the path for batch delete operation.
Access Control: * The calling principal must have **manageResourcePolicy** action permission for the resource **"{resourcePolicy}"** in the **"{authorization}"** service. **OR** * The calling principal **must** have permission to take all the "requiredToMakeLinkable" actions against the service inferred via the reserved resource prefix of the resource in the path in the scope of the home project of the resource. * This API works for tokens with or without a project scope. - [Delete a resource policy](https://docs.here.com/identity-and-access-management/reference/deleteresourcepolicy.md): Delete a resource policy.
Access Control: * The calling principal must have **"manageResourcePolicy"** action permission for the resource **"{resourcePolicy}"** in the **"authorization"** service. * This API works for tokens with or without a project scope. - [Get all resources in a resource policy](https://docs.here.com/identity-and-access-management/reference/getallresourcesinresourcepolicy.md): Get a list of resources in a Resource Policy.
Access Control: * The calling principal must have **"readResourcePolicies"** action permission in the **"authorization"** service. * The unscoped access to this api is granted via the default authorization policy. * The scoped access to this api is granted via the default "projectEnabled" action for members of the project. * This API works for tokens with or without a project scope. - [Get a resource in a resource policy](https://docs.here.com/identity-and-access-management/reference/getresourceinresourcepolicy.md): Get resource in a Resource Policy.
Access Control: * The calling principal must have **"readResourcePolicies"** action permission in the **"authorization"** service. * The calling principal MUST NOT include a project scope. * The unscoped access to this api is granted via the default authorization policy. * The scoped access to this api is granted via the default "projectEnabled" action for members of the project. * This API works for tokens with or without a project scope. - [Get a list of Resource Policies](https://docs.here.com/identity-and-access-management/reference/getresourcepolicies.md): Get a list of Resource Policies. If an unscoped access token is used, all resource policies(unscoped and scoped) within the realm of the caller are returned. If a project scoped access token is used, resource policies within the project are returned.
Access Control: * The calling principal must have **"readResourcePolicies"** action permission in the **"authorization"** service. * The unscoped access to this api is granted via the default authorization policy. * The scoped access to this api is granted via the default "projectEnabled" action for members of the project. * This API works for tokens with or without a project scope. - [Get a resource policy](https://docs.here.com/identity-and-access-management/reference/getresourcepolicy.md): Get details of a Resource Policy.
Access Control: * The calling principal must have **"readResourcePolicies"** action permission in the **"authorization"** service. * The unscoped access to this api is granted via the default authorization policy. * The scoped access to this api is granted via the default "projectEnabled" action for members of the project. * This API works for tokens with or without a project scope. - [Get the status of resource policy resources batch addition](https://docs.here.com/identity-and-access-management/reference/getresourcepolicyresourcesstatus.md): Get the status of resource policy resources batch addition.
Access Control: * The calling principal must have **"manageResourcePolicy"** action permission for the resource **"{resourcePolicy}"** in the **"authorization"** service. * The unscoped access to this api is granted via the default authorization policy. * The scoped access to this api is granted via the default "projectEnabled" action for members of the project. * This API works for tokens with or without a project scope. - [Update a resource policy](https://docs.here.com/identity-and-access-management/reference/updateresourcepolicy.md): Update a resource policy.
Access Control: * The calling principal must have **"manageResourcePolicy"** action permission for the resource **"{resourcePolicy}"** in the **"authorization"** service. * This API works for tokens with or without a project scope. - [Assign a role to an entity](https://docs.here.com/identity-and-access-management/reference/addroleentity.md): Assign the role provided to the given entity. If the provided role is associated with a group, the entity being assigned the role must be a member of the associated group.
Access Control: * The calling principal must have **"manageEntities"** action permission for the resource **"{role}"** in the **"authorization"** service. * The calling principal MUST NOT include a project scope. - [Revoke a role from an entity](https://docs.here.com/identity-and-access-management/reference/deleteroleentity.md): Remove the role provided to from the given member.
Access Control: * The calling principal must have **"manageEntities"** action permission for the resource **"{role}"** in the **"authorization"** service. * The calling principal MUST NOT include a project scope. - [Get My Roles](https://docs.here.com/identity-and-access-management/reference/getmyroles.md): Retrieve the list of roles which have been assigned to the calling party.
Access Control: * The calling principal MUST NOT include a project scope. - [Get Role](https://docs.here.com/identity-and-access-management/reference/getrole.md): Get the role identified by the provided Role HRN.
Access Control: * The calling principal must have **"readRoles"** action permission for the callers **"{realm}"** in the **"authorization"** service. * The calling principal MUST NOT include a project scope. - [Get Role Access Filter](https://docs.here.com/identity-and-access-management/reference/getroleaccessfilter.md): Retrieve the Access Filter attached to this role if there is one.
Access Control: * The calling principal must have **"readFilter"** action permission for the resource **"{role}"** in the **"authorization"** service. * The calling principal MUST NOT include a project scope. - [Get role entities](https://docs.here.com/identity-and-access-management/reference/getroleentities.md): Retrieve the list of entities which have been assigned the role as identified by the provided role HRN.
Access Control: * The calling principal must have **"readEntities"** action permission for the resource **"{role}"** in the **"authorization"** service. * The calling principal MUST NOT include a project scope. - [Get a single role entity](https://docs.here.com/identity-and-access-management/reference/getroleentity.md): Retrieve a single entity which has been assigned the role as identified by the provided role HRN.
Access Control: * The calling principal must have **"readEntities"** action permission for the resource **"{role}"** in the **"authorization"** service. * The calling principal MUST NOT include a project scope. - [Get Role Permission](https://docs.here.com/identity-and-access-management/reference/getrolepermission.md): Get a single permission associated with the role identified by the provided Role HRN.
Access Control: * The calling principal must have **"readPermissions"** action permission for the resource **"{role}"** in the **"authorization"** service. * The calling principal MUST NOT include a project scope. - [Get Role Permissions](https://docs.here.com/identity-and-access-management/reference/getrolepermissions.md): Get the **unscoped** permissions associated with the role identified by the provided Role HRN.
Access Control: * The calling principal must have **"readPermissions"** action permission for the resource **"{role}"** in the **"authorization"** service. * The calling principal MUST NOT include a project scope. - [Get Roles](https://docs.here.com/identity-and-access-management/reference/getroles.md): Retrieve the list of roles within the context of the provided realm.
Access Control: * The calling principal must have **"readRoles"** action permission for the callers **"{realm}"** in the **"authorization"** service. * The calling principal MUST NOT include a project scope. - [Get Resource Types](https://docs.here.com/identity-and-access-management/reference/getresourcetypes.md): Get resource types for all services.
Access Control: * The calling principal must have **"readServices"** action permission in the **"authorization"** service. * The calling principal MUST NOT include a project scope. - [Get Service Information](https://docs.here.com/identity-and-access-management/reference/getserviceinfo.md): Get service information.
Access Control: * The calling principal must have **"readServices"** action permission in the **"authorization"** service. * The calling principal MUST NOT include a project scope. - [Get Service Information by service id](https://docs.here.com/identity-and-access-management/reference/getserviceinfobyid.md): Get service information by service id.
Access Control: * The calling principal must have **"readServices"** action permission in the **"authorization"** service. * The calling principal MUST NOT include a project scope. - [Get my app permissions](https://docs.here.com/identity-and-access-management/reference/getmyapppermissions-1.md): Get a pageable list of permissions directly assigned to your application. Permissions assigned indirectly via group memberships or policy or plans are not returned in this response. - [Get my app permissions](https://docs.here.com/identity-and-access-management/reference/getmyapppermissions.md): Get a pageable list of permissions directly assigned to your application. Permissions assigned indirectly via group memberships or policy or plans are not returned in this response. - [Get my permissions](https://docs.here.com/identity-and-access-management/reference/getmypermissions-1.md): Get a pageable list of permissions assigned to you - [Get my permissions](https://docs.here.com/identity-and-access-management/reference/getmypermissions.md): Get a pageable list of permissions assigned to you - [Introspect application authorizations](https://docs.here.com/identity-and-access-management/reference/introspectapplicationauthorization-1.md): Retrieve the application authorization associated with the application. - [Introspect application authorizations](https://docs.here.com/identity-and-access-management/reference/introspectapplicationauthorization.md): Retrieve the application authorization associated with the application. - [Get my authorization details](https://docs.here.com/identity-and-access-management/reference/userauthorizationdetails-1.md): Get the authorization details of the user represented by the Authorization header. The response includes all roles and permissions of the user. - [Get my authorization details](https://docs.here.com/identity-and-access-management/reference/userauthorizationdetails.md): Get the authorization details of the user represented by the Authorization header. The response includes all roles and permissions of the user. - [Removes all permissions identified by resource and id pair.](https://docs.here.com/identity-and-access-management/reference/removepermissionsbyresource-1.md): Used to remove permissions from an user, app or group. This API works only with tokens that are not scoped to a project. - [Removes all permissions identified by resource and id pair.](https://docs.here.com/identity-and-access-management/reference/removepermissionsbyresource.md): Used to remove permissions from an user, app or group. This API works only with tokens that are not scoped to a project. - [Share permissions to an application](https://docs.here.com/identity-and-access-management/reference/shareappauthorization-1.md): Share permissions to an application.
This API works only with tokens that are not scoped to a project.

Access Control: * Requires the calling principal to have the following permission: * action: share * serviceId: authorization * resource: {resourceHrn} - [Share permissions to an application](https://docs.here.com/identity-and-access-management/reference/shareappauthorization.md): Share permissions to an application.
This API works only with tokens that are not scoped to a project.

Access Control: * Requires the calling principal to have the following permission: * action: share * serviceId: authorization * resource: {resourceHrn} - [Share permissions to a group](https://docs.here.com/identity-and-access-management/reference/sharegroupauthorization-1.md): Share permissions to a group.
This API works only with tokens that are not scoped to a project.

Access Control: * Requires the calling principal to have the following permission: * action: share * serviceId: authorization * resource: {resourceHrn} - [Share permissions to a group](https://docs.here.com/identity-and-access-management/reference/sharegroupauthorization.md): Share permissions to a group.
This API works only with tokens that are not scoped to a project.

Access Control: * Requires the calling principal to have the following permission: * action: share * serviceId: authorization * resource: {resourceHrn} - [Share permissions to a user](https://docs.here.com/identity-and-access-management/reference/shareuserauthorization-1.md): Share permissions to a user.
This API works only with tokens that are not scoped to a project.

Access Control: * Requires the calling principal to have the following permission: * action: share * serviceId: authorization * resource: {resourceHrn} - [Share permissions to a user](https://docs.here.com/identity-and-access-management/reference/shareuserauthorization.md): Share permissions to a user.
This API works only with tokens that are not scoped to a project.

Access Control: * Requires the calling principal to have the following permission: * action: share * serviceId: authorization * resource: {resourceHrn} - [Revoke a HERE device access token that was obtained via token exchange.](https://docs.here.com/identity-and-access-management/reference/deletedevicetoken-1.md): Revoke the HERE device access token, provided in the Authorization: Bearer header for this request, that was previously obtained via token exchange API. - [Request an OAuth 2.0 access token that identifies your identity](https://docs.here.com/identity-and-access-management/reference/getoauth2accesstoken-1.md): Request an OAuth 2.0 access token that identifies your identity ## **Grant Types:** ### **Client Credentials Grant Type [client_credentials]** * **Request a client token that identifies your application by providing your client credentials.** - Use grant type - client_credentials - An optional scope can be added to the request body to request a project scoped access token - This API requires clients to use certain OAuth Core signature headers. The request must be signed with the provisioned client access key secret (here.access.key.secret) as documented in [Signing Requests](http://oauth.net/core/1.0/#signing_process) - Developers may wish to try out the sample Java code in [documentation](https://developer.here.com/documentation/identity-access-management/dev_guide/topics/sdk.html) demonstrating this API ### **Token Exchange Grant Type [urn:ietf:params:oauth:grant-type:token-exchange]** * **Create a new HERE access token via exchange of an existing trusted OpenID Connect Identity Provider access token.** - Use grant type - urn:ietf:params:oauth:grant-type:token-exchange - Client authentication via the Authorization header is not required - The subject_token identifies the access context in the third-party issuer's identity namespace, and the "sub" claim within that token uniquely identifies the security principal within that identity provider's namespace - If used with a IdentityProvider that is configured for accountType=device, and a "sub" claim is present, a DeviceAccount is created upon first token exchange and re-used for subsequent tokens with the same "sub" claim value - See also [OAuth 2.0 Token Exchange](https://www.rfc-editor.org/rfc/rfc8693) ### **External Issuer Grant Type [jwtIssNotHERE]** * **Sign In with OpenID Connect compliant OEM token** - Use grant type - jwtIssNotHERE - The OEM access token is used in the authorization header - [Tests basic health of the service](https://docs.here.com/identity-and-access-management/reference/gethealth-1.md) - [Tests basic health of the service](https://docs.here.com/identity-and-access-management/reference/gethealth.md) - [Retrieves this API specification in OpenAPI 3 format](https://docs.here.com/identity-and-access-management/reference/getopenapi-1.md) - [Retrieves this API specification in OpenAPI 3 format](https://docs.here.com/identity-and-access-management/reference/getopenapi.md) - [Retrieves API specification version information](https://docs.here.com/identity-and-access-management/reference/getversion-1.md) - [Retrieves API specification version information](https://docs.here.com/identity-and-access-management/reference/getversion.md) - [Get endpoint](https://docs.here.com/identity-and-access-management/reference/getendpoint-1.md): Get metadata about the specific endpoint. - [Get endpoint](https://docs.here.com/identity-and-access-management/reference/getendpoint.md): Get metadata about the specific endpoint. - [Get endpoints](https://docs.here.com/identity-and-access-management/reference/getendpoints-1.md): Get metadata about endpoints that are subject to rate limiting rules. - [Get endpoints](https://docs.here.com/identity-and-access-management/reference/getendpoints.md): Get metadata about endpoints that are subject to rate limiting rules. - [Get rate limit rule for the caller](https://docs.here.com/identity-and-access-management/reference/getratelimitrulecaller-1.md): Get a single rate limit rule that is actively enforced for the calling identity. - [Get rate limit rule for the caller](https://docs.here.com/identity-and-access-management/reference/getratelimitrulecaller.md): Get a single rate limit rule that is actively enforced for the calling identity. - [Get rate limit rule for the caller's realm](https://docs.here.com/identity-and-access-management/reference/getratelimitruledefault-1.md): Get a single rate limit rule that is actively enforced for any generic identity from the calling identity's realm whose rules are not overridden by custom rules or a custom tier. - [Get rate limit rule for the caller's realm](https://docs.here.com/identity-and-access-management/reference/getratelimitruledefault.md): Get a single rate limit rule that is actively enforced for any generic identity from the calling identity's realm whose rules are not overridden by custom rules or a custom tier. - [Get rate limit rule for an identity](https://docs.here.com/identity-and-access-management/reference/getratelimitruleidentity-1.md): Get a single rate limit rule that is actively enforced for the given identity.
Access Control: * The calling principal must have either **"readRateLimitRules"** action permission for the resource **"{identityHrn}"** in the **"iam-config"** service or **"manage"** action permission for the resource **"{identityHrn}"** in the **"account"** service. * The calling principal MUST NOT include a project scope. - [Get rate limit rule for an identity](https://docs.here.com/identity-and-access-management/reference/getratelimitruleidentity.md): Get a single rate limit rule that is actively enforced for the given identity.
Access Control: * The calling principal must have either **"readRateLimitRules"** action permission for the resource **"{identityHrn}"** in the **"iam-config"** service or **"manage"** action permission for the resource **"{identityHrn}"** in the **"account"** service. * The calling principal MUST NOT include a project scope. - [Get list of rate limit rules for the caller's realm](https://docs.here.com/identity-and-access-management/reference/getratelimitrulesdefault-1.md): Get the list of rate limit rules that are actively enforced for any generic identity from the calling identity's realm whose rules are not overridden by custom rules or a custom tier. - [Get list of rate limit rules for the caller's realm](https://docs.here.com/identity-and-access-management/reference/getratelimitrulesdefault.md): Get the list of rate limit rules that are actively enforced for any generic identity from the calling identity's realm whose rules are not overridden by custom rules or a custom tier. - [Get list of rate limit rules for an identity](https://docs.here.com/identity-and-access-management/reference/getratelimitrulesidentity-1.md): Get the list of rate limit rules that are actively enforced for the given identity.
Access Control: * The calling principal must have either **"readRateLimitRules"** action permission for the resource **"{identityHrn}"** in the **"iam-config"** service or **"manage"** action permission for the resource **"{identityHrn}"** in the **"account"** service. * The calling principal MUST NOT include a project scope. - [Get list of rate limit rules for an identity](https://docs.here.com/identity-and-access-management/reference/getratelimitrulesidentity.md): Get the list of rate limit rules that are actively enforced for the given identity.
Access Control: * The calling principal must have either **"readRateLimitRules"** action permission for the resource **"{identityHrn}"** in the **"iam-config"** service or **"manage"** action permission for the resource **"{identityHrn}"** in the **"account"** service. * The calling principal MUST NOT include a project scope. - [Get list of rate limit rules for the caller](https://docs.here.com/identity-and-access-management/reference/getratelimitrulesme-1.md): Get the list of rate limit rules that are actively enforced for the calling identity. - [Get list of rate limit rules for the caller](https://docs.here.com/identity-and-access-management/reference/getratelimitrulesme.md): Get the list of rate limit rules that are actively enforced for the calling identity. # Indoor Map Documentation ## Guides - [Concepts - HERE Indoor Map](https://docs.here.com/indoor-map/docs/concepts.md) - [How to add new users to the Indoor Maps project](https://docs.here.com/indoor-map/docs/indoor-add-new-users.md) - [How to use the Data API to fetch indoor maps](https://docs.here.com/indoor-map/docs/indoor-data-api.md) - [How to add indoor maps to mobile applications](https://docs.here.com/indoor-map/docs/indoor-hsdk.md) - [How to add indoor maps to your web applications](https://docs.here.com/indoor-map/docs/indoor-jsapi.md) - [How to order and update indoor maps](https://docs.here.com/indoor-map/docs/indoor-map-order.md) - [How to prepare to use indoor maps](https://docs.here.com/indoor-map/docs/indoor-onboard.md) - [Indoor routing service](https://docs.here.com/indoor-map/docs/indoor-routing-service.md) - [How to calculate indoor route](https://docs.here.com/indoor-map/docs/indoor-calculate-route.md) - [Indoor waypoints overview](https://docs.here.com/indoor-map/docs/indoor-waypoints.md) - [Get started with HERE Indoor Map](https://docs.here.com/indoor-map/docs/indoor-map-quick-start.md) - [Introduction to HERE Indoor Map](https://docs.here.com/indoor-map/docs/indoor-map-readme.md) ## API Reference - [Tests basic health of the service](https://docs.here.com/indoor-map/reference/gethealth.md) - [Retrieves this API specification in OpenAPI 3 format](https://docs.here.com/indoor-map/reference/getopenapi.md) - [Returns the full version of the API](https://docs.here.com/indoor-map/reference/getversion.md) - [Calculates indoor routes via GET](https://docs.here.com/indoor-map/reference/getroute.md): Calculates a route through a HERE indoor map # Introduction to Mapping Concepts Documentation ## Guides - [Geopolitical views and administrative data](https://docs.here.com/intro-to-mapping-concepts/docs/admin-data.md) - [How to make a tile API request](https://docs.here.com/intro-to-mapping-concepts/docs/calculate-tiles.md) - [Feature tile assignment](https://docs.here.com/intro-to-mapping-concepts/docs/feature-tile-assignment.md) - [HEREtile map tiling scheme](https://docs.here.com/intro-to-mapping-concepts/docs/here-tiling-scheme.md) - [Catalogs, layers, partitions, and tiles](https://docs.here.com/intro-to-mapping-concepts/docs/catalogs-layers-partitions-and-tiles.md) - [Tile zoom levels and sizes](https://docs.here.com/intro-to-mapping-concepts/docs/tile-pixels.md) - [Digital mapping models](https://docs.here.com/intro-to-mapping-concepts/docs/digital-mapping-models.md) - [Basic road model](https://docs.here.com/intro-to-mapping-concepts/docs/model-core.md) - [Lane model](https://docs.here.com/intro-to-mapping-concepts/docs/model-lane.md) - [Localization model](https://docs.here.com/intro-to-mapping-concepts/docs/model-local.md) - [References to HERE Map Content entities](https://docs.here.com/intro-to-mapping-concepts/docs/entities-referencing.md) - [Features and attributes](https://docs.here.com/intro-to-mapping-concepts/docs/features-and-attributes.md) - [Topology reference types for lane attributes](https://docs.here.com/intro-to-mapping-concepts/docs/top-ref-types-lane.md) - [Topology reference types for road attributes](https://docs.here.com/intro-to-mapping-concepts/docs/top-ref-types-road.md) - [Data formats, filters, and the quality index](https://docs.here.com/intro-to-mapping-concepts/docs/formats-filters-quality.md) - [Global Positioning System](https://docs.here.com/intro-to-mapping-concepts/docs/gps.md) - [Introduction to Mapping Concepts](https://docs.here.com/intro-to-mapping-concepts/docs/mapping-concepts-intro.md) - [Points-of-Interest](https://docs.here.com/intro-to-mapping-concepts/docs/points-of-interest.md) - [Map foundations - topology and geometry](https://docs.here.com/intro-to-mapping-concepts/docs/topology.md) # Map Attributes API Documentation ## Guides - [HERE Map Attributes API v8 - Changelog](https://docs.here.com/map-attributes/docs/map-attributes-changelog.md) - [Bring your own data - deprecated](https://docs.here.com/map-attributes/docs/byod-deprecated.md) - [Cellular coverage in HERE Map Attributes API v8](https://docs.here.com/map-attributes/docs/cellular-coverage.md) - [HERE Map Attributes API v8 layers available in Japan](https://docs.here.com/map-attributes/docs/layers-in-japan.md) - [Maps and layers in HERE Map Attributes API v8](https://docs.here.com/map-attributes/docs/maps-and-layers.md) - [Routing zones in HERE Map Attributes API v8](https://docs.here.com/map-attributes/docs/routing-zones.md) - [Get HERE map content for map display](https://docs.here.com/map-attributes/docs/here-map-content-for-map-display.md) - [Get map attributes along a path](https://docs.here.com/map-attributes/docs/map-attributes-along-a-path.md) - [Get map attributes for a reverse-geocoded position](https://docs.here.com/map-attributes/docs/map-attributes-for-reverse-geocoded-position.md) - [Get HERE map content for driver alerts](https://docs.here.com/map-attributes/docs/map-content-for-driver-alerts.md) - [Get HERE map content for trip analysis](https://docs.here.com/map-attributes/docs/map-content-for-trip-analysis.md) - [Get started with HERE Map Attributes API v8](https://docs.here.com/map-attributes/docs/get-started-map-attributes.md) - [Introduction to HERE Map Attributes API v8](https://docs.here.com/map-attributes/docs/intro-map-attributes.md) ## API Reference - [Retrieve the POIs that are reachable within a certain time or distance from the main route](https://docs.here.com/map-attributes/reference/searchrouteisolinev8-1.md): Retrieve the POIs that are reachable within a certain time or distance from the main route - [Retrieve the POIs that are reachable within a certain time or distance from the main route](https://docs.here.com/map-attributes/reference/searchrouteisolinev8.md): Retrieve the POIs that are reachable within a certain time or distance from the main route - [Landing page for inline documentation](https://docs.here.com/map-attributes/reference/v8contenthtml-1.md): Landing page for inline documentation in HTML format - [Landing page for inline documentation](https://docs.here.com/map-attributes/reference/v8contenthtml.md): Landing page for inline documentation in HTML format - [Delete some of my Geometry Layers. To delete complete maps and overlays, leave the layerNames field in parameter 'id' empty - deprecated, use HERE Geofencing API.](https://docs.here.com/map-attributes/reference/v8deletemapslayers-1.md) - [Delete some of my Geometry Layers. To delete complete maps and overlays, leave the layerNames field in parameter 'id' empty - deprecated, use HERE Geofencing API.](https://docs.here.com/map-attributes/reference/v8deletemapslayers.md) - [Simple and fast access to the rich HERE Map Content](https://docs.here.com/map-attributes/reference/v8getmapattributes_1-1.md): Simple and fast access to the rich HERE Map Content - [Simple and fast access to the rich HERE Map Content](https://docs.here.com/map-attributes/reference/v8getmapattributes_1.md): Simple and fast access to the rich HERE Map Content - [Simple and fast access to the rich HERE Map Content](https://docs.here.com/map-attributes/reference/v8getmapattributes-1.md): Simple and fast access to the rich HERE Map Content - [Simple and fast access to the rich HERE Map Content](https://docs.here.com/map-attributes/reference/v8getmapattributes.md): Simple and fast access to the rich HERE Map Content - [Map Attributes along a route path.](https://docs.here.com/map-attributes/reference/v8getmapattributesforapath_1-1.md): The path endpoint can be used to enrich a given continuous route path with HERE Map content attributes. - [Map Attributes along a route path.](https://docs.here.com/map-attributes/reference/v8getmapattributesforapath_1.md): The path endpoint can be used to enrich a given continious route path with HERE Map content attributes. - [Map Attributes along a route path.](https://docs.here.com/map-attributes/reference/v8getmapattributesforapath-1.md): The path endpoint can be used to enrich a given continuous route path with HERE Map content attributes. - [Map Attributes along a route path.](https://docs.here.com/map-attributes/reference/v8getmapattributesforapath.md): The path endpoint can be used to enrich a given continious route path with HERE Map content attributes. - [Map Attributes for individual segments.](https://docs.here.com/map-attributes/reference/v8getmapattributesformultisegment_1-1.md): The segments endpoint can be used to enrich multiple unconnected segments with HERE Map content attributes. - [Map Attributes for individual segments.](https://docs.here.com/map-attributes/reference/v8getmapattributesformultisegment_1.md): The segments endpoint can be used to enrich multiple unconnected segments with HERE Map content attributes. - [Map Attributes for individual segments.](https://docs.here.com/map-attributes/reference/v8getmapattributesformultisegment-1.md): The segments endpoint can be used to enrich multiple unconnected segments with HERE Map content attributes. - [Map Attributes for individual segments.](https://docs.here.com/map-attributes/reference/v8getmapattributesformultisegment.md): The segments endpoint can be used to enrich multiple unconnected segments with HERE Map content attributes. - [Service parameter boundary values](https://docs.here.com/map-attributes/reference/v8getserviceconfiguration-1.md): Numeric constants and limits for the service calls. Will never become more strict, but can become more relaxed in future releases. - [Service parameter boundary values](https://docs.here.com/map-attributes/reference/v8getserviceconfiguration.md): Numeric constants and limits for the service calls. Will never become more strict, but can become more relaxed in future releases. - [Tile IDs containing a given value](https://docs.here.com/map-attributes/reference/v8index-1.md): Retrieve the IDs of tiles that contain a given (set of) attribute value(s). Does not work for custom layers. - [Tile IDs containing a given value](https://docs.here.com/map-attributes/reference/v8index.md): Retrieve the IDs of tiles that contain a given (set of) attribute value(s). Does not work for custom layers. - [List the layer attributes across all layers](https://docs.here.com/map-attributes/reference/v8layerattributeshtml-1.md): List the layer attributes across all layers in basic HTML format - [List the layer attributes across all layers](https://docs.here.com/map-attributes/reference/v8layerattributeshtml.md): List the layer attributes across all layers in basic HTML format - [List the layer attributes across all layers](https://docs.here.com/map-attributes/reference/v8layerattributesjson-1.md): List the map layer attributes across all layers - [List the layer attributes across all layers](https://docs.here.com/map-attributes/reference/v8layerattributesjson.md): List the map layer attributes across all layers - [Show the layer documentation for a specific layer (public/private) in HTML format. Public layer documentation list the attributes and corresponding official attribute description, for private layers attribute description might be empty.](https://docs.here.com/map-attributes/reference/v8layerdochtml-1.md) - [Show the layer documentation for a specific layer (public/private) in HTML format. Public layer documentation list the attributes and corresponding official attribute description, for private layers attribute description might be empty.](https://docs.here.com/map-attributes/reference/v8layerdochtml.md) - [Show the layer documentation for a specific layer (public/private) in JSON format. Public layer documentation list the attributes and corresponding official attribute description, for private layers attribute description might be empty.](https://docs.here.com/map-attributes/reference/v8layerdocjson-1.md) - [Show the layer documentation for a specific layer (public/private) in JSON format. Public layer documentation list the attributes and corresponding official attribute description, for private layers attribute description might be empty.](https://docs.here.com/map-attributes/reference/v8layerdocjson.md) - [List the available map layers (public/private/both) in HTML format. To see only the layers of a given map region, like Postal Code Boundaries or WEU, then specify it as map 'region'](https://docs.here.com/map-attributes/reference/v8layerslisthtml-1.md) - [List the available map layers (public/private/both) in HTML format. To see only the layers of a given map region, like Postal Code Boundaries or WEU, then specify it as map 'region'](https://docs.here.com/map-attributes/reference/v8layerslisthtml.md) - [List the available map layers (public/private/both) in JSON format. To see only the layers of a given map region, like Postal Code Boundaries or WEU, then specify it as map 'region'](https://docs.here.com/map-attributes/reference/v8layerslistjson-1.md) - [List the available map layers (public/private/both) in JSON format. To see only the layers of a given map region, like Postal Code Boundaries or WEU, then specify it as map 'region'](https://docs.here.com/map-attributes/reference/v8layerslistjson.md) - [List available layer indexes](https://docs.here.com/map-attributes/reference/v8mapindexeshtml-1.md): List the available indexes of custom and public layers. - [List available layer indexes](https://docs.here.com/map-attributes/reference/v8mapindexeshtml.md): List the available indexes of custom and public layers. - [List available layer indexes](https://docs.here.com/map-attributes/reference/v8mapindexesjson-1.md): List the available indexes of custom and public layers. - [List available layer indexes](https://docs.here.com/map-attributes/reference/v8mapindexesjson.md): List the available indexes of custom and public layers. - [List all maps (public/private/both) available to the app in HTML format.](https://docs.here.com/map-attributes/reference/v8mapslisthtml-1.md) - [List all maps (public/private/both) available to the app in HTML format.](https://docs.here.com/map-attributes/reference/v8mapslisthtml.md) - [List available map (public/private/both) regions/releases available to the app.](https://docs.here.com/map-attributes/reference/v8mapslistjson-1.md) - [List available map (public/private/both) regions/releases available to the app.](https://docs.here.com/map-attributes/reference/v8mapslistjson.md) - [Modify Geometries in Existing Layers - deprecated, use HERE Geofencing API](https://docs.here.com/map-attributes/reference/v8modifypost-1.md): Modify geometries using an HTTP GET or POST request. After the response there is a delay of several seconds to compile, store and make the modified geometries available in the service. Note: The level (tile grid size) of the layer can only be changed by uploading the whole layer, not as a modification operation.

Note: The feature to modify custom layers is deprecated. It will be only supported in self-hosting in maintenance mode. - [Modify Geometries in Existing Layers - deprecated, use HERE Geofencing API](https://docs.here.com/map-attributes/reference/v8modifypost.md): Modify geometries using an HTTP GET or POST request. After the response there is a delay of several seconds to compile, store and make the modified geometries available in the service. Note: The level (tile grid size) of the layer can only be changed by uploading the whole layer, not as a modification operation.

Note: The feature to modify custom layers is deprecated. It will be only supported in self-hosting in maintenance mode. - [Import Geometries in a WKT or Shape File - deprecated, use HERE Geofencing API](https://docs.here.com/map-attributes/reference/v8uploadpost-1.md): Import polygons, polylines or points in WKT (Wellknown Text) or Shapefile format geometries using an HTTP POST request, or import WKT geometries using HTTP GET. A layer can contain only one geometry type - polygons, polylines or points, but not a mix of different types. After the response there is a delay of several seconds to compile, store and make the geometries available in the service.

Note: The feature to import custom layers is deprecated. It will be only supported in self-hosting in maintenance mode. - [Import Geometries in a WKT or Shape File - deprecated, use HERE Geofencing API](https://docs.here.com/map-attributes/reference/v8uploadpost.md): Import polygons, polylines or points in WKT (Wellknown Text) or Shapefile format geometries using an HTTP POST request, or import WKT geometries using HTTP GET. A layer can contain only one geometry type - polygons, polylines or points, but not a mix of different types. After the response there is a delay of several seconds to compile, store and make the geometries available in the service.

Note: The feature to import custom layers is deprecated. It will be only supported in self-hosting in maintenance mode. # Map Feedback API Documentation ## Guides - [API Changes](https://docs.here.com/map-feedback/docs/api-changes.md) - [Functional and Behavioral Changes](https://docs.here.com/map-feedback/docs/functional-behavioral-changes.md) - [Changes](https://docs.here.com/map-feedback/docs/changes.md) - [Known Issues](https://docs.here.com/map-feedback/docs/known-issues.md) - [Limitations and Workarounds](https://docs.here.com/map-feedback/docs/limitations-workarounds.md) - [Resolved Issues](https://docs.here.com/map-feedback/docs/resolved-issues.md) - [Highlights](https://docs.here.com/map-feedback/docs/highlights.md) - [Overview](https://docs.here.com/map-feedback/docs/readme.md) - [Feedback submission request body](https://docs.here.com/map-feedback/docs/request-type-feedback-submission-body.md) - [Error report types](https://docs.here.com/map-feedback/docs/resource-type-errors.md) - [Feedback response](https://docs.here.com/map-feedback/docs/resource-type-response-feedback.md) - [Feedback status response](https://docs.here.com/map-feedback/docs/resource-type-response-tracking.md) - [Feature Categories](https://docs.here.com/map-feedback/docs/feature-categories.md) - [HTTP request headers](https://docs.here.com/map-feedback/docs/http-request-headers.md) - [HTTP status codes](https://docs.here.com/map-feedback/docs/http-status-codes.md) - [Feedback response properties](https://docs.here.com/map-feedback/docs/reference-type-feedback-response.md) - [Job solution details](https://docs.here.com/map-feedback/docs/reference-type-feedback-response-job-solution-details.md) - [Carto types](https://docs.here.com/map-feedback/docs/resource-type-carto-type.md) - [Place category matching table](https://docs.here.com/map-feedback/docs/resource-type-category-matching.md) - [Place types](https://docs.here.com/map-feedback/docs/resource-type-place-type.md) - [Feedback request properties](https://docs.here.com/map-feedback/docs/resource-type-properties.md) - [Address and city-specific properties](https://docs.here.com/map-feedback/docs/resource-type-address-properties.md) - [Carto-specific properties](https://docs.here.com/map-feedback/docs/resource-type-carto-properties.md) - [EV charge point-specific properties](https://docs.here.com/map-feedback/docs/resource-type-ev-properties.md) - [Media-specific properties](https://docs.here.com/map-feedback/docs/resource-type-media-properties.md) - [Media attachment file types](https://docs.here.com/map-feedback/docs/resource-type-media-type.md) - [Other properties](https://docs.here.com/map-feedback/docs/resource-type-other-properties.md) - [Place-specific properties](https://docs.here.com/map-feedback/docs/resource-type-place-properties.md) - [Product properties](https://docs.here.com/map-feedback/docs/resource-type-product-properties.md) - [Road conditions](https://docs.here.com/map-feedback/docs/resource-type-road-conditions.md) - [Road network properties](https://docs.here.com/map-feedback/docs/resource-type-road-network-properties.md) - [Road-specific properties](https://docs.here.com/map-feedback/docs/resource-type-road-properties.md) - [Safety camera properties](https://docs.here.com/map-feedback/docs/resource-type-safety-camera-public-properties.md) - [Sign-specific properties](https://docs.here.com/map-feedback/docs/resource-type-sign-properties.md) - [SLI-specific properties](https://docs.here.com/map-feedback/docs/resource-type-sli-properties.md) - [Traffic-specific properties](https://docs.here.com/map-feedback/docs/resource-type-traffic-properties.md) - [Feedback](https://docs.here.com/map-feedback/docs/resource-feedback.md) - [Submit feedback with the HERE Map Feedback API](https://docs.here.com/map-feedback/docs/key-concepts-submit-feedback.md) - [Get Started with the HERE Map Feedback API](https://docs.here.com/map-feedback/docs/quick-start.md) - [How to construct a HERE Map Feedback API request](https://docs.here.com/map-feedback/docs/request-constructing.md) - [How to submit address Feedback](https://docs.here.com/map-feedback/docs/example-address-feedback.md) - [How to submit cartographic Feedback](https://docs.here.com/map-feedback/docs/example-carto-feedback.md) - [How to submit EV charge point feedback](https://docs.here.com/map-feedback/docs/example-ev-feedback.md) - [How to submit feedback with media attachments](https://docs.here.com/map-feedback/docs/example-media-attachments-feedback.md) - [How to submit other types of feedback](https://docs.here.com/map-feedback/docs/example-other-feedback.md) - [How to submit place feedback](https://docs.here.com/map-feedback/docs/example-place-feedback.md) - [How to submit product feedback](https://docs.here.com/map-feedback/docs/example-product-feedback.md) - [How to reopen feedback](https://docs.here.com/map-feedback/docs/example-reopen-feedback.md) - [How to submit road conditions feedback](https://docs.here.com/map-feedback/docs/example-road-conditions-feedback.md) - [How to submit road feedback](https://docs.here.com/map-feedback/docs/example-road-feedback.md) - [How to submit safety camera feedback](https://docs.here.com/map-feedback/docs/example-safety-camera-public-feedback.md) - [How to submit road sign feedback](https://docs.here.com/map-feedback/docs/example-sign-feedback.md) - [How to track feedback status](https://docs.here.com/map-feedback/docs/example-track-feedback.md) - [Introduction to the HERE Map Feedback API](https://docs.here.com/map-feedback/docs/what-is.md) # Maps API for JavaScript Documentation ## Guides - [Apply best practices for efficient map rendering](https://docs.here.com/maps-api-for-js/docs/best-practices.md) - [Configure Content Security Policy](https://docs.here.com/maps-api-for-js/docs/content-security-policy.md) - [Set custom domain names and service paths](https://docs.here.com/maps-api-for-js/docs/custom-configurations.md) - [Cluster data for visualization](https://docs.here.com/maps-api-for-js/docs/clustering.md) - [Understand DefaultLayers options](https://docs.here.com/maps-api-for-js/docs/defaultlayers-options.md) - [Display interactive map layers](https://docs.here.com/maps-api-for-js/docs/display-iml.md) - [Enable draggable directions](https://docs.here.com/maps-api-for-js/docs/draggable-directions.md) - [Customize map display through features and modes](https://docs.here.com/maps-api-for-js/docs/features-modes.md) - [Resolve geocoding and address lookups](https://docs.here.com/maps-api-for-js/docs/geocoding.md) - [Trigger actions or events based on specific areas through geofencing](https://docs.here.com/maps-api-for-js/docs/geofencing.md) - [Display GeoJSON data](https://docs.here.com/maps-api-for-js/docs/geojson-support.md) - [Apply custom geopolitical views](https://docs.here.com/maps-api-for-js/docs/geopolitical-views.md) - [Display maps with Japan data](https://docs.here.com/maps-api-for-js/docs/get-started-japan.md) - [Display GPX data](https://docs.here.com/maps-api-for-js/docs/gpx-support.md) - [Display a heatmap at a specific location](https://docs.here.com/maps-api-for-js/docs/heat-map-tutorial.md) - [Integrate HERE Indoor Map](https://docs.here.com/maps-api-for-js/docs/indoor-maps.md) - [Enhance map content with KML](https://docs.here.com/maps-api-for-js/docs/kml-support.md) - [Customize maps with map controls and UI](https://docs.here.com/maps-api-for-js/docs/map-controls-ui.md) - [Configure region-specific maps](https://docs.here.com/maps-api-for-js/docs/map-region-specifics.md) - [Calculate routes and directions](https://docs.here.com/maps-api-for-js/docs/routing.md) - [Customize maps with styles exported from the HERE Style Editor](https://docs.here.com/maps-api-for-js/docs/style-editor.md) - [Display real-time traffic data](https://docs.here.com/maps-api-for-js/docs/traffic.md) - [View and apply vehicle restrictions](https://docs.here.com/maps-api-for-js/docs/vehicle-profile.md) - [Visualize routes with multiple stops by using the Waypoints Sequence service](https://docs.here.com/maps-api-for-js/docs/waypoints.md) - [Build HERE Maps with Angular](https://docs.here.com/maps-api-for-js/docs/angular-practices.md) - [Build HERE Maps with Vue.js](https://docs.here.com/maps-api-for-js/docs/map-to-vue-tutorial.md) - [Bundle the HERE Maps API for JavaScript with Webpack and Rollup](https://docs.here.com/maps-api-for-js/docs/get-started-bundling.md) - [Bundle the HERE Maps API for JavaScript with Vite](https://docs.here.com/maps-api-for-js/docs/vite-bundling.md) - [Build HERE Maps with React](https://docs.here.com/maps-api-for-js/docs/react-practices.md) - [Build HERE Maps with TypeScript](https://docs.here.com/maps-api-for-js/docs/typescript.md) - [Explore HERE Maps API for JavaScript versions](https://docs.here.com/maps-api-for-js/docs/api-versions.md) - [Supported browsers and platforms](https://docs.here.com/maps-api-for-js/docs/browser-support.md) - [Introduction to HERE Maps API for JavaScript](https://docs.here.com/maps-api-for-js/docs/introduction-maps-api-for-javascript.md) - [Available API modules](https://docs.here.com/maps-api-for-js/docs/modules.md) - [Handle map events](https://docs.here.com/maps-api-for-js/docs/map-events.md) - [Use geoshapes](https://docs.here.com/maps-api-for-js/docs/geo-shapes.md) - [Manage map objects](https://docs.here.com/maps-api-for-js/docs/map-objects.md) - [Add markers](https://docs.here.com/maps-api-for-js/docs/marker-objects.md) - [Display custom overlays](https://docs.here.com/maps-api-for-js/docs/overlays.md) - [Understand map types](https://docs.here.com/maps-api-for-js/docs/map-types.md) - [Get started with HERE Maps API for JavaScript](https://docs.here.com/maps-api-for-js/docs/quick-start.md) - [Switch from Google to HERE Maps API for JavaScript geocoding](https://docs.here.com/maps-api-for-js/docs/switch-here-js-geocode-tutorial.md) - [Switch from Google to HERE Maps API for JavaScript](https://docs.here.com/maps-api-for-js/docs/switch-here-js-map-tutorial.md) - [Switch from Google to HERE Maps API for JavaScript routing](https://docs.here.com/maps-api-for-js/docs/switch-here-js-route-tutorial.md) - [Take a snapshot of the map](https://docs.here.com/maps-api-for-js/docs/capture-map-area.md) - [Circle on a map](https://docs.here.com/maps-api-for-js/docs/circle-on-the-map.md) - [Context menu](https://docs.here.com/maps-api-for-js/docs/context-menu.md) - [Adding an Overlay to the Map](https://docs.here.com/maps-api-for-js/docs/custom-tile-overlay.md) - [Display an indoor map](https://docs.here.com/maps-api-for-js/docs/display-an-indoor-map.md) - [Display GeoJSON data](https://docs.here.com/maps-api-for-js/docs/display-geojson-on-map.md) - [Display GPX data](https://docs.here.com/maps-api-for-js/docs/display-gpx-data.md) - [Display KML data](https://docs.here.com/maps-api-for-js/docs/display-kml-on-map.md) - [DOM marker rotation](https://docs.here.com/maps-api-for-js/docs/dom-marker-rotation.md) - [Draggable geo shapes](https://docs.here.com/maps-api-for-js/docs/draggable-geo-shapes.md) - [Draggable marker](https://docs.here.com/maps-api-for-js/docs/draggable-marker.md) - [Extruded geo shapes](https://docs.here.com/maps-api-for-js/docs/extruded-geoshapes.md) - [Finding the nearest marker](https://docs.here.com/maps-api-for-js/docs/finding-the-nearest-marker.md) - [Image overlay](https://docs.here.com/maps-api-for-js/docs/image-overlay.md) - [Indoor Map - Restrict map movement](https://docs.here.com/maps-api-for-js/docs/indoor-map-movement.md) - [Indoor map UI interactions](https://docs.here.com/maps-api-for-js/docs/indoor-map-ui-interactions.md) - [Interactive base map](https://docs.here.com/maps-api-for-js/docs/interactive-basemap.md) - [Map at a specific location](https://docs.here.com/maps-api-for-js/docs/map-at-specified-location.md) - [Map object events](https://docs.here.com/maps-api-for-js/docs/map-object-events-displayed.md) - [Map object event delegation](https://docs.here.com/maps-api-for-js/docs/map-objects-event-delegation.md) - [Changing from the metric system](https://docs.here.com/maps-api-for-js/docs/map-scale-bar-changing-from-the-metric-system.md) - [Map using view bounds](https://docs.here.com/maps-api-for-js/docs/map-using-view-bounds.md) - [Map with custom MapSettings UI Control](https://docs.here.com/maps-api-for-js/docs/map-with-custom-map-settings-ui-control.md) - [DOM marker](https://docs.here.com/maps-api-for-js/docs/map-with-dom-marker.md) - [Map with isoline route for an EV vehicle](https://docs.here.com/maps-api-for-js/docs/map-with-isoline-route.md) - [Map with pedestrian route from A to B](https://docs.here.com/maps-api-for-js/docs/map-with-pedestrian-route-from-a-to-b.md) - [Map with route from A to B using public transport](https://docs.here.com/maps-api-for-js/docs/map-with-route-from-a-to-b-using-public-transport.md) - [Map with driving route from A to B](https://docs.here.com/maps-api-for-js/docs/map-with-route-from-a-to-b.md) - [Marker clustering with custom theme](https://docs.here.com/maps-api-for-js/docs/marker-clustering-with-custom-theme.md) - [Marker clustering](https://docs.here.com/maps-api-for-js/docs/marker-clustering.md) - [Marker on the map](https://docs.here.com/maps-api-for-js/docs/markers-on-the-map.md) - [Animated markers](https://docs.here.com/maps-api-for-js/docs/markers-update-position-with-animation.md) - [Markers with altitude](https://docs.here.com/maps-api-for-js/docs/markers-with-altitude.md) - [Multi-language support](https://docs.here.com/maps-api-for-js/docs/multi-language-support.md) - [Open an InfoBubble on mouse click](https://docs.here.com/maps-api-for-js/docs/open-infobubble.md) - [Order overlapping markers](https://docs.here.com/maps-api-for-js/docs/ordering-overlapping-markers.md) - [Panning the map](https://docs.here.com/maps-api-for-js/docs/panning-the-map.md) - [Polygon on the map](https://docs.here.com/maps-api-for-js/docs/polygon-on-the-map.md) - [Polygon with holes on the map](https://docs.here.com/maps-api-for-js/docs/polygon-with-holes-on-the-map.md) - [Polyline on the map](https://docs.here.com/maps-api-for-js/docs/polyline-on-the-map.md) - [Calculate a location from a mouse click](https://docs.here.com/maps-api-for-js/docs/position-on-mouse-click.md) - [Rectangle on the map](https://docs.here.com/maps-api-for-js/docs/rectangle-on-the-map.md) - [Resizable circle](https://docs.here.com/maps-api-for-js/docs/resizable-circle.md) - [Resizable polygon](https://docs.here.com/maps-api-for-js/docs/resizable-polygon.md) - [Resizable polyline](https://docs.here.com/maps-api-for-js/docs/resizable-polyline.md) - [Resizable rectangle](https://docs.here.com/maps-api-for-js/docs/resizable-rectangle.md) - [Restrict map movement](https://docs.here.com/maps-api-for-js/docs/restrict-map-movement.md) - [Search for the address of a known location](https://docs.here.com/maps-api-for-js/docs/search-for-address-of-known-location.md) - [Search for a landmark](https://docs.here.com/maps-api-for-js/docs/search-for-landmark.md) - [Search for a location based on an address](https://docs.here.com/maps-api-for-js/docs/search-for-location-based-on-address.md) - [Search for a location given a structured address](https://docs.here.com/maps-api-for-js/docs/search-for-location-given-structured-address.md) - [Set a map style exported from the HERE Style Editor](https://docs.here.com/maps-api-for-js/docs/set-style-exported-from-style-editor.md) - [SVG graphic markers](https://docs.here.com/maps-api-for-js/docs/svg-graphic-markers.md) - [Synchronising two maps](https://docs.here.com/maps-api-for-js/docs/synchronising-two-maps.md) - [Interactive map layer](https://docs.here.com/maps-api-for-js/docs/transit-iml.md) - [Map with the truck routes and road restrictions](https://docs.here.com/maps-api-for-js/docs/truck-routing-road-restrictions.md) - [Zoom into bounds](https://docs.here.com/maps-api-for-js/docs/zoom-into-bounds.md) - [Zoom to a set of markers](https://docs.here.com/maps-api-for-js/docs/zoom-set-of-markers.md) - [Migrate from the HERE Maps API for JavaScript version 3.1 to version 3.2](https://docs.here.com/maps-api-for-js/docs/migration-guide.md) - [API Changes](https://docs.here.com/maps-api-for-js/docs/api-changes.md) - [Functional and Behavioral Changes](https://docs.here.com/maps-api-for-js/docs/functional-behavioral-changes.md) - [Changes](https://docs.here.com/maps-api-for-js/docs/changes.md) - [Known Issues](https://docs.here.com/maps-api-for-js/docs/known-issues.md) - [Limitations and Workarounds](https://docs.here.com/maps-api-for-js/docs/limitations-workarounds.md) - [Resolved Issues](https://docs.here.com/maps-api-for-js/docs/resolved-issues.md) - [Highlights](https://docs.here.com/maps-api-for-js/docs/highlights.md) - [Overview](https://docs.here.com/maps-api-for-js/docs/overview.md) # Phonetic Training Data Documentation ## Guides - [File Formats](https://docs.here.com/voice-phonetic-transcriptions/docs/file-formats.md) - [Concepts](https://docs.here.com/voice-phonetic-transcriptions/docs/concepts.md) - [Phonetic Language](https://docs.here.com/voice-phonetic-transcriptions/docs/phonetic-language.md) - [Phonetic Transcription](https://docs.here.com/voice-phonetic-transcriptions/docs/phonetic-transcription.md) - [Plain Text](https://docs.here.com/voice-phonetic-transcriptions/docs/plain-text.md) - [Preferred](https://docs.here.com/voice-phonetic-transcriptions/docs/preferred.md) - [French (FRE) NT-Sampa Chart](https://docs.here.com/voice-phonetic-transcriptions/docs/french-nt-sampa-chart.md) - [German (GER) NT-Sampa Chart](https://docs.here.com/voice-phonetic-transcriptions/docs/german-nt-sampa-chart.md) - [NT SAMPA](https://docs.here.com/voice-phonetic-transcriptions/docs/nt-sampa.md) - [Italian (ITA) NT-Sampa Chart](https://docs.here.com/voice-phonetic-transcriptions/docs/italian-nt-sampa-chart.md) - [Spanish (SPA) NT-Sampa Chart](https://docs.here.com/voice-phonetic-transcriptions/docs/spanish-nt-sampa-chart.md) - [Additional Characters Published in UKE (Words of Scottish and Welsh origin)](https://docs.here.com/voice-phonetic-transcriptions/docs/additional-characters-uke.md) - [UK English (UKE) NT-Sampa Chart](https://docs.here.com/voice-phonetic-transcriptions/docs/uk-english-nt-sampa-chart.md) - [Irish English (IRE) Additional NT-SAMPA Characters](https://docs.here.com/voice-phonetic-transcriptions/docs/irish-english-additional.md) - [US English (ENG) NT-Sampa Chart](https://docs.here.com/voice-phonetic-transcriptions/docs/us-english-nt-sampa-chart.md) - [Introduction](https://docs.here.com/voice-phonetic-transcriptions/docs/readme.md) # Platform Status API Documentation ## Guides - [Platform Status web page](https://docs.here.com/system-status/docs/concept-1.md) - [Platform Status REST API](https://docs.here.com/system-status/docs/concept-2.md) - [Get Platform Status for all services](https://docs.here.com/system-status/docs/tutorial-1.md) - [Get Platform Status for a specific service](https://docs.here.com/system-status/docs/tutorial-2.md) - [Introduction to Platform Status API](https://docs.here.com/system-status/docs/platform-status-introduction.md) - [Get started with Platform Status API](https://docs.here.com/system-status/docs/quick-start-platform.md) # Policies Documentation ## Guides - [Location Services Essential Data Processing](https://docs.here.com/policies/docs/location-services-essential-data-processing.md) - [Incident Management communication channels](https://docs.here.com/policies/docs/communication-channels.md) - [Expectations and updates](https://docs.here.com/policies/docs/expectation-updates.md) - [Incident Management FAQs](https://docs.here.com/policies/docs/faqs.md) - [Incident Management lifecycle](https://docs.here.com/policies/docs/incident-lifecycle.md) - [Incident priority](https://docs.here.com/policies/docs/incident-priority.md) - [Incident resolution and response times](https://docs.here.com/policies/docs/incident-response-time.md) - [Incident Management introduction](https://docs.here.com/policies/docs/incident-management-introduction.md) - [Limits and Quotas](https://docs.here.com/policies/docs/limits-and-quotas.md) - [Product Lifecycle Policy](https://docs.here.com/policies/docs/product-lifecycle-policy.md) - [HERE SLA terminology and concept definitions](https://docs.here.com/policies/docs/definitions.md) - [HERE SLA exclusions and limitations](https://docs.here.com/policies/docs/exclusions-and-limitations.md) - [HERE Service Level Agreement Introduction](https://docs.here.com/policies/docs/here-service-level-agreement.md) - [HERE incident management process](https://docs.here.com/policies/docs/incident-management.md) - [HERE Services maintenance](https://docs.here.com/policies/docs/maintenance.md) - [Service reports](https://docs.here.com/policies/docs/reporting.md) - [HERE incident root cause analysis](https://docs.here.com/policies/docs/root-cause-analysis.md) - [Requests Per Second (RPS) capacity planning](https://docs.here.com/policies/docs/rps-capacity-planning.md) - [Service availability](https://docs.here.com/policies/docs/service-availability.md) - [Service credits](https://docs.here.com/policies/docs/service-credits.md) - [Service response time](https://docs.here.com/policies/docs/service-response.md) # HERE Tracking API Documentation ## Guides - [Creating aliases](https://docs.here.com/tracking/docs/aliases.md) - [Organize devices and resources with labels](https://docs.here.com/tracking/docs/labels.md) - [Creating and managing metadata](https://docs.here.com/tracking/docs/metadata.md) - [Authentication](https://docs.here.com/tracking/docs/authentication.md) - [Ingesting telemetry](https://docs.here.com/tracking/docs/ingestion.md) - [How to ingest telemetry with input streams](https://docs.here.com/tracking/docs/input-streams.md) - [Ingesting device positioning data](https://docs.here.com/tracking/docs/positioning.md) - [Manage device shadows](https://docs.here.com/tracking/docs/shadows.md) - [How to review telemetry data](https://docs.here.com/tracking/docs/telemetry.md) - [Manage trace output streams](https://docs.here.com/tracking/docs/traces-output-streams.md) - [Query device traces](https://docs.here.com/tracking/docs/traces.md) - [How to create associations](https://docs.here.com/tracking/docs/associations.md) - [Enable events in output streams](https://docs.here.com/tracking/docs/events-output-streams.md) - [How to create and manage events](https://docs.here.com/tracking/docs/events.md) - [How to use external location events](https://docs.here.com/tracking/docs/external-location-events.md) - [Creating and editing geofences](https://docs.here.com/tracking/docs/geofences.md) - [Creating and managing rules](https://docs.here.com/tracking/docs/rules.md) - [Generating event data with sensor rules](https://docs.here.com/tracking/docs/sensor-rules.md) - [HRN](https://docs.here.com/tracking/docs/hrn.md) - [Supported Devices](https://docs.here.com/tracking/docs/supported-devices.md) - [How to use sensors](https://docs.here.com/tracking/docs/sensors.md) - [How to use virtual devices](https://docs.here.com/tracking/docs/virtual-devices.md) - [Sensos integration](https://docs.here.com/tracking/docs/sensos.md) - [Create and manage locations](https://docs.here.com/tracking/docs/locations.md) - [Organize a journey with segments](https://docs.here.com/tracking/docs/segments.md) - [Estimate shipment times](https://docs.here.com/tracking/docs/shipment-times.md) - [Create and manage shipments](https://docs.here.com/tracking/docs/tracking-api-and-shipments.md) - [Claiming a device as an owner](https://docs.here.com/tracking/docs/owner.md) - [Manage devices and resources with projects](https://docs.here.com/tracking/docs/projects.md) - [Creating device licenses with vendors](https://docs.here.com/tracking/docs/vendor.md) - [Get started](https://docs.here.com/tracking/docs/getting-started.md) - [Introduction to the HERE Tracking API](https://docs.here.com/tracking/docs/here-tracking-api-introduction.md) - [Schema](https://docs.here.com/tracking/docs/schemas-main.md) - [Optimize positioning result](https://docs.here.com/tracking/docs/tips-for-data-accuracy.md) - [Create a Shipment](https://docs.here.com/tracking/docs/getting-started-15-create-a-shipment.md) - [How to authenticate to the REST API](https://docs.here.com/tracking/docs/getting-started-0-login-user.md) - [Geofence events](https://docs.here.com/tracking/docs/getting-started-6-geofence-events.md) - [Process sensor data](https://docs.here.com/tracking/docs/getting-started-7-process-sensor-data-in-the-cloud.md) - [Use Aliases, Metadata and Labels](https://docs.here.com/tracking/docs/getting-started-8-aliases-and-metadata-and-labels.md) - [Set desired configuration of the device](https://docs.here.com/tracking/docs/getting-started-9-update-the-device-desired-shadow.md) - [Receive events from output stream](https://docs.here.com/tracking/docs/getting-started-21-event-output-streams.md) - [Receive traces from output stream](https://docs.here.com/tracking/docs/getting-started-22-traces-output-streams.md) - [How to provision a virtual device](https://docs.here.com/tracking/docs/getting-started-2-provisioning-a-device.md) - [Send data using input stream](https://docs.here.com/tracking/docs/getting-started-20-input-streams.md) - [How to claim a virtual device](https://docs.here.com/tracking/docs/getting-started-3-claiming-ownership-of-a-device.md) - [Send data to the cloud](https://docs.here.com/tracking/docs/getting-started-4-send-data-to-the-cloud.md) - [See data in the cloud](https://docs.here.com/tracking/docs/getting-started-5-see-data-in-the-cloud.md) - [API Changes](https://docs.here.com/tracking/docs/api-changes.md) - [New Features](https://docs.here.com/tracking/docs/new-features.md) - [Overview](https://docs.here.com/tracking/docs/readme.md) ## API Reference - [Deletes all aliases of a device](https://docs.here.com/tracking/reference/delete_aliases-v2-trackingid-1.md): Deletes all aliases of a device identified by the `trackingId`. Note that one needs to supply an HTTP header `x-confirm` with the value `true` to force the deletion. If the header is not provided, the request will fail. - [Deletes all aliases of a specified type for a device](https://docs.here.com/tracking/reference/delete_aliases-v2-trackingid-type-1.md): Deletes all aliases of a specified type for a device identified by the `trackingId`. Note that one needs to supply an HTTP header `x-confirm` with the value `true` to force the deletion. If the header is not provided, the request will fail. - [Deletes an alias](https://docs.here.com/tracking/reference/delete_aliases-v2-trackingid-type-externalid-1.md): Deletes the specified alias. - [Deletes an alias](https://docs.here.com/tracking/reference/delete_aliases-v2-trackingid-type-externalid.md): Deletes the specified alias. - [Deletes all aliases of a specified type for a device](https://docs.here.com/tracking/reference/delete_aliases-v2-trackingid-type.md): Deletes all aliases of a specified type for a device identified by the `trackingId`. Note that one needs to supply an HTTP header `x-confirm` with the value `true` to force the deletion. If the header is not provided, the request will fail. - [Deletes all aliases of a device](https://docs.here.com/tracking/reference/delete_aliases-v2-trackingid.md): Deletes all aliases of a device identified by the `trackingId`. Note that one needs to supply an HTTP header `x-confirm` with the value `true` to force the deletion. If the header is not provided, the request will fail. - [Gets all aliases](https://docs.here.com/tracking/reference/get_aliases-v2-1.md): Gets all aliases of a project. If `type` query parameter is provided, the response will contain only aliases of the given type. If `externalId` query parameter is specified, the response will contain only aliases that match the given external ID. The following wildcards can be used: '*' matches any number of any characters, '?' matches a single character. If `after` query parameter is provided, the successful response will only contain aliases that were created after the specified timestamp. Parameters `after` and `pageToken` are mutually exclusive and cannot be provided at the same time. The returned results are sorted in ascending order by the alias creation time. - [Gets service health](https://docs.here.com/tracking/reference/get_aliases-v2-health-1.md) - [Gets service health](https://docs.here.com/tracking/reference/get_aliases-v2-health.md) - [Gets the tracking ID associated with an alias](https://docs.here.com/tracking/reference/get_aliases-v2-trackingid-1.md): Gets the `trackingId` associated with an alias. - [Gets the tracking ID associated with an alias](https://docs.here.com/tracking/reference/get_aliases-v2-trackingid-2.md): Gets the `trackingId` associated with an alias. - [Gets all aliases of a specified type for a device](https://docs.here.com/tracking/reference/get_aliases-v2-trackingid-type-1.md): Gets all aliases of a specified type for a device identified by the `trackingId`. - [Gets all aliases of a specified type for a device](https://docs.here.com/tracking/reference/get_aliases-v2-trackingid-type.md): Gets all aliases of a specified type for a device identified by the `trackingId`. - [Gets the tracking ID associated with an alias](https://docs.here.com/tracking/reference/get_aliases-v2-trackingid.md): Gets the `trackingId` associated with an alias. - [Gets service version](https://docs.here.com/tracking/reference/get_aliases-v2-version-1.md) - [Gets service version](https://docs.here.com/tracking/reference/get_aliases-v2-version.md) - [Gets all aliases](https://docs.here.com/tracking/reference/get_aliases-v2.md): Gets all aliases of a project. If `type` query parameter is provided, the response will contain only aliases of the given type. If `externalId` query parameter is specified, the response will contain only aliases that match the given external ID. The following wildcards can be used: '*' matches any number of any characters, '?' matches a single character. If `after` query parameter is provided, the successful response will only contain aliases that were created after the specified timestamp. Parameters `after` and `pageToken` are mutually exclusive and cannot be provided at the same time. The returned results are sorted in ascending order by the alias creation time. - [Creates multiple aliases for a device](https://docs.here.com/tracking/reference/put_aliases-v2-trackingid-batch-1.md): Creates a set of aliases for a device identified by the `trackingId`. An alias must be unique within a project. - [Creates multiple aliases for a device](https://docs.here.com/tracking/reference/put_aliases-v2-trackingid-batch.md): Creates a set of aliases for a device identified by the `trackingId`. An alias must be unique within a project. - [Creates an alias](https://docs.here.com/tracking/reference/put_aliases-v2-trackingid-type-externalid-1.md): Creates an alias for the `trackingId`. An alias must be unique within a project. - [Creates an alias](https://docs.here.com/tracking/reference/put_aliases-v2-trackingid-type-externalid.md): Creates an alias for the `trackingId`. An alias must be unique within a project. - [Disassociates a device and a geofence](https://docs.here.com/tracking/reference/delete_associations-v3-trackingid-geofences-geofenceid-1.md): Deletes an association between the geofence `geofenceId` and the device `trackingId`. - [Disassociates a device and a geofence](https://docs.here.com/tracking/reference/delete_associations-v3-trackingid-geofences-geofenceid.md): Deletes an association between the geofence `geofenceId` and the device `trackingId`. - [Disassociates a device and a rule](https://docs.here.com/tracking/reference/delete_associations-v3-trackingid-rules-ruleid-1.md): Deletes an association between the rule `ruleId` and the device `trackingId`. - [Disassociates a device and a rule](https://docs.here.com/tracking/reference/delete_associations-v3-trackingid-rules-ruleid.md): Deletes an association between the rule `ruleId` and the device `trackingId`. - [Disassociates a device and a sensor rule](https://docs.here.com/tracking/reference/delete_associations-v3-trackingid-sensors-sensorruleid-1.md): Deletes the association between the sensor rule `sensorRuleId` and the device `trackingId`. - [Disassociates a device and a sensor rule](https://docs.here.com/tracking/reference/delete_associations-v3-trackingid-sensors-sensorruleid.md): Deletes the association between the sensor rule `sensorRuleId` and the device `trackingId`. - [Gets all devices associated with a geofence](https://docs.here.com/tracking/reference/get_associations-v3-geofences-geofenceid-1.md): Gets all devices associated with the geofence `geofenceId`. - [Gets all devices associated with a geofence](https://docs.here.com/tracking/reference/get_associations-v3-geofences-geofenceid.md): Gets all devices associated with the geofence `geofenceId`. - [Gets service health](https://docs.here.com/tracking/reference/get_associations-v3-health-1.md) - [Gets service health](https://docs.here.com/tracking/reference/get_associations-v3-health.md) - [Gets all devices associated with a rule](https://docs.here.com/tracking/reference/get_associations-v3-rules-ruleid-1.md): Gets all devices associated with the rule `ruleId`. - [Gets all devices associated with a rule](https://docs.here.com/tracking/reference/get_associations-v3-rules-ruleid.md): Gets all devices associated with the rule `ruleId`. - [Gets all devices associated with a sensor rule](https://docs.here.com/tracking/reference/get_associations-v3-sensors-sensorruleid-1.md): Gets all devices associated with the sensor rule `sensorRuleId`. - [Gets all devices associated with a sensor rule](https://docs.here.com/tracking/reference/get_associations-v3-sensors-sensorruleid.md): Gets all devices associated with the sensor rule `sensorRuleId`. - [Gets geofences associated with a device](https://docs.here.com/tracking/reference/get_associations-v3-trackingid-geofences-1.md): Gets a list of geofences associated with the device `trackingId`. - [Gets geofences associated with a device](https://docs.here.com/tracking/reference/get_associations-v3-trackingid-geofences.md): Gets a list of geofences associated with the device `trackingId`. - [Gets rules associated with a device](https://docs.here.com/tracking/reference/get_associations-v3-trackingid-rules-1.md): Gets a list of rules associated with the device `trackingId`. - [Gets rules associated with a device](https://docs.here.com/tracking/reference/get_associations-v3-trackingid-rules.md): Gets a list of rules associated with the device `trackingId`. - [Gets sensor rules associated with a device](https://docs.here.com/tracking/reference/get_associations-v3-trackingid-sensors-1.md): Gets a list of sensor rules associated with the device `trackingId`. - [Gets sensor rules associated with a device](https://docs.here.com/tracking/reference/get_associations-v3-trackingid-sensors.md): Gets a list of sensor rules associated with the device `trackingId`. - [Gets service version](https://docs.here.com/tracking/reference/get_associations-v3-version-1.md) - [Gets service version](https://docs.here.com/tracking/reference/get_associations-v3-version.md) - [Associates rules with a device](https://docs.here.com/tracking/reference/post_associations-v3-devices-trackingid-batchcreate-1.md): Associates rules with the device `trackingId`. - [Associates rules with a device](https://docs.here.com/tracking/reference/post_associations-v3-devices-trackingid-batchcreate.md): Associates rules with the device `trackingId`. - [Disassociates rules from a device](https://docs.here.com/tracking/reference/post_associations-v3-devices-trackingid-batchdelete-1.md): Disassociates rules from the device identified by `trackingId`. - [Disassociates rules from a device](https://docs.here.com/tracking/reference/post_associations-v3-devices-trackingid-batchdelete.md): Disassociates rules from the device identified by `trackingId`. - [Updates rules associations for devices](https://docs.here.com/tracking/reference/put_associations-v3-devices-batchupdate-1.md): Updates rules associated with devices. - [Updates rules associations for devices](https://docs.here.com/tracking/reference/put_associations-v3-devices-batchupdate.md): Updates rules associated with devices. - [Associates a device to a geofence](https://docs.here.com/tracking/reference/put_associations-v3-trackingid-geofences-geofenceid-1.md): Associates the device with `trackingId` to the geofence with `geofenceId`. Whenever the device enters or exits the associated geofence, an event is generated. - [Associates a device to a geofence](https://docs.here.com/tracking/reference/put_associations-v3-trackingid-geofences-geofenceid.md): Associates the device with `trackingId` to the geofence with `geofenceId`. Whenever the device enters or exits the associated geofence, an event is generated. - [Associates a device to a rule](https://docs.here.com/tracking/reference/put_associations-v3-trackingid-rules-ruleid-1.md): Associates the device with `trackingId` to the rule with `ruleId`. Whenever the device behaviour triggers the rule, an event is generated. - [Associates a device to a rule](https://docs.here.com/tracking/reference/put_associations-v3-trackingid-rules-ruleid.md): Associates the device with `trackingId` to the rule with `ruleId`. Whenever the device behaviour triggers the rule, an event is generated. - [Associates a device with a sensor rule](https://docs.here.com/tracking/reference/put_associations-v3-trackingid-sensors-sensorruleid-1.md): Associates the device with `trackingId` to the sensor rule with `sensorRuleId`. A single device can only have one sensor rule per sensor type associated. The associated sensor rule settings will be automatically synchronised to the `system.sensorAlarmConfig` section of the device `desired shadow`. Every time the associated sensor rule gets triggered by the device ingestion, an event will be generated. - [Associates a device with a sensor rule](https://docs.here.com/tracking/reference/put_associations-v3-trackingid-sensors-sensorruleid.md): Associates the device with `trackingId` to the sensor rule with `sensorRuleId`. A single device can only have one sensor rule per sensor type associated. The associated sensor rule settings will be automatically synchronised to the `system.sensorAlarmConfig` section of the device `desired shadow`. Every time the associated sensor rule gets triggered by the device ingestion, an event will be generated. - [Gets event history](https://docs.here.com/tracking/reference/get_events-v3-1.md): Gets all events for all devices and shipments of the project. The results are listed in descending order based on the timestamp. An event is uniquely identified by `trackingId`-`ruleId`-`timestamp` key, with an exception of dwelling and stock rule events. Dwelling events also need `geofenceId` to be specified, whereas for stock events `trackingId` is not applicable. A time range can be defined with `before` and `after` timestamps. The response will contain an array of events that were recorded within the range. The default value for `before` parameter is the current time, and for the `after` parameter it is one day in the past from the current time. The `after` parameter value is not allowed to be earlier than two weeks in the past from the `before` timestamp, otherwise an error is returned. If the request is supplied with `eventSource` query parameter, the response will contain events generated by the defined source only. If the request is supplied with `eventType` query parameter, the response will contain events of the specified type only. If the request is supplied with `ruleId` query parameter, the response will only contain events for the specified rule ID. If the request is supplied with `initialState` query parameter, the response will contain events having the specified initial state. All the aforementioned query parameters can be combined together. - [Gets service health](https://docs.here.com/tracking/reference/get_events-v3-health-1.md) - [Gets service health](https://docs.here.com/tracking/reference/get_events-v3-health.md) - [Gets the event statuses](https://docs.here.com/tracking/reference/get_events-v3-statuses-1.md): Gets all events statuses for all devices and shipments of the project. An event status of a device is the most recent event of any rule or geofence the device is associated with. The same applies for shipments. The response contains a list of event status objects and each object has the following properties: * `trackingId` or `shipmentId`: a device ID or a shipment ID * `ruleId`: an associated rule or geofence ID * `eventSource`: the rule type * `eventType`: an event type of the latest event of the rule (same as the "event state") * `timestamp`: a time since when the device has been in this event state * `initialState`: initial state status for the event The array is sorted by the following fields in the following order: `trackingId`, `eventSource`, `timestamp`, `ruleId`, `geofenceId`. A time range can be defined with `before` and `after` timestamps. The response will contain event statuses that were recorded within the range. If the request is supplied with `eventSource` query parameter, the response results will be limited to the specified rule types only. If the request is supplied with `ruleId` query parameter, the response results will be limited to the specified rule IDs only. If the request is supplied with `trackingId` query parameter, the response results will be limited to the specified devices only. Also `shipmentId` can be used as a `trackingId`. If the request is supplied with `eventType` query parameter, the response results will be limited to the specified type only. If the request is supplied with `geofenceId` query parameter, it will only affect dwelling event statuses filtering, limiting the results to the specified geofence only. Other event types are not affected by this setting. Note that for the event statuses of geofence type, the `ruleId` is the `geofenceId`. If the request is supplied with `shipments` query parameter, the response results will be limited either to shipments (`shipments`=`true`) or devices (`shipments`=`false`) only. Otherwise, if `shipments` query parameter is not specified, response results will include both devices and shipments. If the request is supplied with `initialState` query parameter, the response will contain events having the specified initial state. All the aforementioned query parameters can be combined together. - [Gets the number of devices and shipments in each event state](https://docs.here.com/tracking/reference/get_events-v3-statuses-devicecounts-1.md): This API call counts the number of devices and shipments that are currently in the different event states per rule or per event source (that is per rule type). An event state of a device is the event type of the most recent device event. It indicates a state the device is currently in, in relation to a rule the device is associated with. For example, the event state can be either `INSIDE_GEOFENCE` or `OUTSIDE_GEOFENCE` in case the event source is `geofence`; or `BELOW_RANGE`, `IN_RANGE` or `ABOVE_RANGE` in case the event source is `battery` rule. A device can be in several different event states at the same time when it has more than one rule associated with it. For example, a device can be at the same time in `INSIDE_GEOFENCE` and `ABOVE_RANGE` event states. The same applies for shipments. The `groupBy` query parameter defines how the results are grouped. The default value for the `groupBy` parameter is `ruleId`. The response contains a list of objects, one per each rule, that are associated to at least one device or shipment of the project. Each object has the following properties: * `ruleId`: a rule ID * `eventSource`: the rule type * every distinct event state (applicable for the rule type) and the number of devices in this state * `total`: the total number of devices associated to the rule When the `groupBy` parameter value is `eventSource`, the response contains a list of objects, one per event source (that is per each rule type), that are associated to at least one device or shipment of the project. Each object has the following properties: * `eventSource`: a rule type * every distinct event state (applicable for the rule type) and the number of devices in this state. One device is counted only once per `eventType` state, but in case a single device is associated to multiple rules of the same type, it will be counted separately for each event state. * `total`: the total number of devices associated to the rule type. A single device is counted only once. For example, a device A is associated to 2 geofences and is inside one and outside the other. A device B is associated to 3 geofences and is outside all of them. With the request query parameter set as `groupBy`=`eventSource`, the response body will contain the following result item: ``` { "eventSource": "geofence", "INSIDE_GEOFENCE": 1, "OUTSIDE_GEOFENCE": 2, "total": 2 }. ``` If the request is supplied with `eventSource` query parameter, the response results will be limited to the specified rule types only. If the request is supplied with `ruleId` query parameter, the response results will be limited to the specified rule IDs only. If the request is supplied with `trackingId` query parameter, the response results will be limited to the specified devices only. Also `shipmentId` can be used as a `trackingId`. If the request is supplied with `geofenceId` query parameter, it will only affect dwelling event statuses filtering, limiting the results to the specified geofence only. Other event types are not affected by this setting. Note that for the event statuses of geofence type, the `ruleId` is the `geofenceId`. If the request is supplied with `shipments` query parameter, the response results will be limited either to shipments (`shipments`=`true`) or devices (`shipments`=`false`) only. Otherwise, if `shipments` query parameter is not specified, response results will include both devices and shipments. All the aforementioned query parameters can be combined together. - [Gets the number of devices and shipments in each event state](https://docs.here.com/tracking/reference/get_events-v3-statuses-devicecounts.md): This API call counts the number of devices and shipments that are currently in the different event states per rule or per event source (that is per rule type). An event state of a device is the event type of the most recent device event. It indicates a state the device is currently in, in relation to a rule the device is associated with. For example, the event state can be either `INSIDE_GEOFENCE` or `OUTSIDE_GEOFENCE` in case the event source is `geofence`; or `BELOW_RANGE`, `IN_RANGE` or `ABOVE_RANGE` in case the event source is `battery` rule. A device can be in several different event states at the same time when it has more than one rule associated with it. For example, a device can be at the same time in `INSIDE_GEOFENCE` and `ABOVE_RANGE` event states. The same applies for shipments. The `groupBy` query parameter defines how the results are grouped. The default value for the `groupBy` parameter is `ruleId`. The response contains a list of objects, one per each rule, that are associated to at least one device or shipment of the project. Each object has the following properties: * `ruleId`: a rule ID * `eventSource`: the rule type * every distinct event state (applicable for the rule type) and the number of devices in this state * `total`: the total number of devices associated to the rule When the `groupBy` parameter value is `eventSource`, the response contains a list of objects, one per event source (that is per each rule type), that are associated to at least one device or shipment of the project. Each object has the following properties: * `eventSource`: a rule type * every distinct event state (applicable for the rule type) and the number of devices in this state. One device is counted only once per `eventType` state, but in case a single device is associated to multiple rules of the same type, it will be counted separately for each event state. * `total`: the total number of devices associated to the rule type. A single device is counted only once. For example, a device A is associated to 2 geofences and is inside one and outside the other. A device B is associated to 3 geofences and is outside all of them. With the request query parameter set as `groupBy`=`eventSource`, the response body will contain the following result item: ``` { "eventSource": "geofence", "INSIDE_GEOFENCE": 1, "OUTSIDE_GEOFENCE": 2, "total": 2 }. ``` If the request is supplied with `eventSource` query parameter, the response results will be limited to the specified rule types only. If the request is supplied with `ruleId` query parameter, the response results will be limited to the specified rule IDs only. If the request is supplied with `trackingId` query parameter, the response results will be limited to the specified devices only. Also `shipmentId` can be used as a `trackingId`. If the request is supplied with `geofenceId` query parameter, it will only affect dwelling event statuses filtering, limiting the results to the specified geofence only. Other event types are not affected by this setting. Note that for the event statuses of geofence type, the `ruleId` is the `geofenceId`. If the request is supplied with `shipments` query parameter, the response results will be limited either to shipments (`shipments`=`true`) or devices (`shipments`=`false`) only. Otherwise, if `shipments` query parameter is not specified, response results will include both devices and shipments. All the aforementioned query parameters can be combined together. - [Gets the event statuses](https://docs.here.com/tracking/reference/get_events-v3-statuses.md): Gets all events statuses for all devices and shipments of the project. An event status of a device is the most recent event of any rule or geofence the device is associated with. The same applies for shipments. The response contains a list of event status objects and each object has the following properties: * `trackingId` or `shipmentId`: a device ID or a shipment ID * `ruleId`: an associated rule or geofence ID * `eventSource`: the rule type * `eventType`: an event type of the latest event of the rule (same as the "event state") * `timestamp`: a time since when the device has been in this event state * `initialState`: initial state status for the event The array is sorted by the following fields in the following order: `trackingId`, `eventSource`, `timestamp`, `ruleId`, `geofenceId`. A time range can be defined with `before` and `after` timestamps. The response will contain event statuses that were recorded within the range. If the request is supplied with `eventSource` query parameter, the response results will be limited to the specified rule types only. If the request is supplied with `ruleId` query parameter, the response results will be limited to the specified rule IDs only. If the request is supplied with `trackingId` query parameter, the response results will be limited to the specified devices only. Also `shipmentId` can be used as a `trackingId`. If the request is supplied with `eventType` query parameter, the response results will be limited to the specified type only. If the request is supplied with `geofenceId` query parameter, it will only affect dwelling event statuses filtering, limiting the results to the specified geofence only. Other event types are not affected by this setting. Note that for the event statuses of geofence type, the `ruleId` is the `geofenceId`. If the request is supplied with `shipments` query parameter, the response results will be limited either to shipments (`shipments`=`true`) or devices (`shipments`=`false`) only. Otherwise, if `shipments` query parameter is not specified, response results will include both devices and shipments. If the request is supplied with `initialState` query parameter, the response will contain events having the specified initial state. All the aforementioned query parameters can be combined together. - [Gets event history for a device or a shipment](https://docs.here.com/tracking/reference/get_events-v3-trackingid-1.md): Gets all events for a device or a shipment. A device is identified by the `trackingId`. For shipments, `shipmentId` can be used as a `trackingId`. The results are listed in descending order based on the timestamp. An event is uniquely identified by `trackingId`-`ruleId`-`timestamp` key, with an exception of dwelling and stock rule events. Dwelling events also need `geofenceId` to be specified, whereas for stock events `trackingId` is not applicable. A single event can be fetched using `ruleId`, `before` and `after` query parameters. A time range can be defined with `before` and `after` timestamps. The response will contain an array of events that were recorded within the range. The default value for `before` parameter is the current time, and for the `after` parameter it is one day in the past from the current time. The `after` parameter value is not allowed to be earlier than two weeks in the past from the `before` timestamp, otherwise an error is returned. If the request is supplied with `eventSource` query parameter, the response will contain events generated by the defined source only. If the request is supplied with `eventType` query parameter, the response will contain events of the specified type only. If the request is supplied with `ruleId` query parameter, the response will only contain events for the specified rule ID. If the request is supplied with `initialState` query parameter, the response will contain events having the specified initial state. All the aforementioned query parameters can be combined together. - [Gets event history for a device or a shipment](https://docs.here.com/tracking/reference/get_events-v3-trackingid.md): Gets all events for a device or a shipment. A device is identified by the `trackingId`. For shipments, `shipmentId` can be used as a `trackingId`. The results are listed in descending order based on the timestamp. An event is uniquely identified by `trackingId`-`ruleId`-`timestamp` key, with an exception of dwelling and stock rule events. Dwelling events also need `geofenceId` to be specified, whereas for stock events `trackingId` is not applicable. A single event can be fetched using `ruleId`, `before` and `after` query parameters. A time range can be defined with `before` and `after` timestamps. The response will contain an array of events that were recorded within the range. The default value for `before` parameter is the current time, and for the `after` parameter it is one day in the past from the current time. The `after` parameter value is not allowed to be earlier than two weeks in the past from the `before` timestamp, otherwise an error is returned. If the request is supplied with `eventSource` query parameter, the response will contain events generated by the defined source only. If the request is supplied with `eventType` query parameter, the response will contain events of the specified type only. If the request is supplied with `ruleId` query parameter, the response will only contain events for the specified rule ID. If the request is supplied with `initialState` query parameter, the response will contain events having the specified initial state. All the aforementioned query parameters can be combined together. - [Gets service version](https://docs.here.com/tracking/reference/get_events-v3-version-1.md) - [Gets service version](https://docs.here.com/tracking/reference/get_events-v3-version.md) - [Gets event history](https://docs.here.com/tracking/reference/get_events-v3.md): Gets all events for all devices and shipments of the project. The results are listed in descending order based on the timestamp. An event is uniquely identified by `trackingId`-`ruleId`-`timestamp` key, with an exception of dwelling and stock rule events. Dwelling events also need `geofenceId` to be specified, whereas for stock events `trackingId` is not applicable. A time range can be defined with `before` and `after` timestamps. The response will contain an array of events that were recorded within the range. The default value for `before` parameter is the current time, and for the `after` parameter it is one day in the past from the current time. The `after` parameter value is not allowed to be earlier than two weeks in the past from the `before` timestamp, otherwise an error is returned. If the request is supplied with `eventSource` query parameter, the response will contain events generated by the defined source only. If the request is supplied with `eventType` query parameter, the response will contain events of the specified type only. If the request is supplied with `ruleId` query parameter, the response will only contain events for the specified rule ID. If the request is supplied with `initialState` query parameter, the response will contain events having the specified initial state. All the aforementioned query parameters can be combined together. - [Deletes all geofences](https://docs.here.com/tracking/reference/delete_geofences-v2-1.md): Deletes all geofences of a project. If a geofence is associated with a stock rule, the rule will also be deleted. Note that one needs to supply an HTTP header `x-confirm` with the value `true` to force the deletion. If the header is not provided, the request will fail. - [Deletes a geofence](https://docs.here.com/tracking/reference/delete_geofences-v2-geofenceid-1.md): Deletes a single geofence identified by the `geofenceId`. - [Deletes a geofence](https://docs.here.com/tracking/reference/delete_geofences-v2-geofenceid.md): Deletes a single geofence identified by the `geofenceId`. - [Deletes all geofences](https://docs.here.com/tracking/reference/delete_geofences-v2.md): Deletes all geofences of a project. If a geofence is associated with a stock rule, the rule will also be deleted. Note that one needs to supply an HTTP header `x-confirm` with the value `true` to force the deletion. If the header is not provided, the request will fail. - [Gets all geofences](https://docs.here.com/tracking/reference/get_geofences-v2-1.md): Gets all geofences of a project. Results can be filtered by using the query parameters. Indoor geofences with the `floor` properties may be filtered by `floor[id]`, which specifies the ID of the venue associated with the geofence. - [Gets a single geofence](https://docs.here.com/tracking/reference/get_geofences-v2-geofenceid-1.md): Gets details of a single geofence identified by the `geofenceId`. - [Gets a single geofence](https://docs.here.com/tracking/reference/get_geofences-v2-geofenceid.md): Gets details of a single geofence identified by the `geofenceId`. - [Gets service health](https://docs.here.com/tracking/reference/get_geofences-v2-health-1.md) - [Gets service health](https://docs.here.com/tracking/reference/get_geofences-v2-health.md) - [Gets service version](https://docs.here.com/tracking/reference/get_geofences-v2-version-1.md) - [Gets service version](https://docs.here.com/tracking/reference/get_geofences-v2-version.md) - [Gets all geofences](https://docs.here.com/tracking/reference/get_geofences-v2.md): Gets all geofences of a project. Results can be filtered by using the query parameters. Indoor geofences with the `floor` properties may be filtered by `floor[id]`, which specifies the ID of the venue associated with the geofence. - [Creates a geofence](https://docs.here.com/tracking/reference/post_geofences-v2-1.md): One can specify a geofence as a circle, as a polygon or as POI (Point of Interest). One can also assign a name and a description to each geofence to help identify them. Circle --- Specify coordinates of the center point of the circle and a radius in meters. ```json { "name": "Home", "type": "circle", "definition": { "center": { "lat": 52.5308398, "lng": 13.38490035 }, "radius": 100 }, "description": "Small area around my house." } ``` Polygon --- Specify an array of points. A minimum of three points is required. *NOTE: If the array of points does not describe a closed polygon, the polygon is automatically closed between the last and first points.* ```json { "name": "Work", "type": "polygon", "definition": { "points": [{ "lat": 52.5308398, "lng": 13.38490035 }, { "lat": 52.530443, "lng": 13.38482003 }, { "lat": 52.5308298, "lng": 13.38492235 }] }, "description": "The area around work." } ``` Indoor geofence --- Circular and polygonal geofences can be both outdoors and indoors. To create a `circular` `indoor` geofence, add the `floor` property to the request body. ```json { "name": "Office indoor", "type": "circle", "definition": { "center": { "lat": 52.5308398, "lng": 13.38490035 }, "radius": 20, "floor": { "level": 2, "id": "DM_1234", "name": "Office floor 2" } }, "description": "Floor 2 of the office." } ``` POI geofence --- Specify location details of a POI geofence for its initial creation. After the POI geofence has been created, it will need to be trained. The POI geofence boundary is defined using radio measurements. The POI geofence is trained using a telemetry that a device has ingested while being at this desired point of interest. For a trained POI geofence, an associated device is considered to be inside the geofence when the radio measurements of the device-ingested telemetry and the training data match. ```json { "name": "POI room in the office", "type": "poi", "definition": { "location": { "room": ROOM_201, "address": Invalidenstrasse 116, "country": Germany, "position": { "lat": 52.5308398, "lng": 13.38490035 } }, "floor": { "level": 2, "id": "DM_1234", "name": "Office floor 2" } }, "description": "A room where goods should be delivered." } ``` Successful requests have the HTTP status 201 and the response body provides the ID of the created geofence. - [Trains a POI geofence](https://docs.here.com/tracking/reference/post_geofences-v2-geofenceid-poitraining-1.md): Trains the POI geofence `geofenceId` using a device telemetry. The POI geofence boundary is defined using radio measurements. The geofence is trained using a telemetry that the device with `trackingId` has ingested during the specified time range, while being at this point of interest. Only telemetries that have been ingested during the last 24 hours can be used in the training. Optionally, a WLAN scan be used for the training. - [Trains a POI geofence](https://docs.here.com/tracking/reference/post_geofences-v2-geofenceid-poitraining.md): Trains the POI geofence `geofenceId` using a device telemetry. The POI geofence boundary is defined using radio measurements. The geofence is trained using a telemetry that the device with `trackingId` has ingested during the specified time range, while being at this point of interest. Only telemetries that have been ingested during the last 24 hours can be used in the training. Optionally, a WLAN scan be used for the training. - [Checks if a POI geofence training is possible with the given parameters](https://docs.here.com/tracking/reference/post_geofences-v2-trainingtest-1.md): Checks if a POI geofence training is possible with the given request parameters. The request body contains a training data sample in form of either a device tracking ID along with a specific time range for the ingested device telemetry or a WLAN scan. - [Checks if a POI geofence training is possible with the given parameters](https://docs.here.com/tracking/reference/post_geofences-v2-trainingtest.md): Checks if a POI geofence training is possible with the given request parameters. The request body contains a training data sample in form of either a device tracking ID along with a specific time range for the ingested device telemetry or a WLAN scan. - [Creates a geofence](https://docs.here.com/tracking/reference/post_geofences-v2.md): One can specify a geofence as a circle, as a polygon or as POI (Point of Interest). One can also assign a name and a description to each geofence to help identify them. Circle --- Specify coordinates of the center point of the circle and a radius in meters. ```json { "name": "Home", "type": "circle", "definition": { "center": { "lat": 52.5308398, "lng": 13.38490035 }, "radius": 100 }, "description": "Small area around my house." } ``` Polygon --- Specify an array of points. A minimum of three points is required. *NOTE: If the array of points does not describe a closed polygon, the polygon is automatically closed between the last and first points.* ```json { "name": "Work", "type": "polygon", "definition": { "points": [{ "lat": 52.5308398, "lng": 13.38490035 }, { "lat": 52.530443, "lng": 13.38482003 }, { "lat": 52.5308298, "lng": 13.38492235 }] }, "description": "The area around work." } ``` Indoor geofence --- Circular and polygonal geofences can be both outdoors and indoors. To create a `circular` `indoor` geofence, add the `floor` property to the request body. ```json { "name": "Office indoor", "type": "circle", "definition": { "center": { "lat": 52.5308398, "lng": 13.38490035 }, "radius": 20, "floor": { "level": 2, "id": "DM_1234", "name": "Office floor 2" } }, "description": "Floor 2 of the office." } ``` POI geofence --- Specify location details of a POI geofence for its initial creation. After the POI geofence has been created, it will need to be trained. The POI geofence boundary is defined using radio measurements. The POI geofence is trained using a telemetry that a device has ingested while being at this desired point of interest. For a trained POI geofence, an associated device is considered to be inside the geofence when the radio measurements of the device-ingested telemetry and the training data match. ```json { "name": "POI room in the office", "type": "poi", "definition": { "location": { "room": ROOM_201, "address": Invalidenstrasse 116, "country": Germany, "position": { "lat": 52.5308398, "lng": 13.38490035 } }, "floor": { "level": 2, "id": "DM_1234", "name": "Office floor 2" } }, "description": "A room where goods should be delivered." } ``` Successful requests have the HTTP status 201 and the response body provides the ID of the created geofence. - [Updates a single geofence](https://docs.here.com/tracking/reference/put_geofences-v2-geofenceid-1.md): Updates the geofence `type`, `name`, `description`, `metadata` or `definition` property. The old geofence will be replaced by the new one, and hence the full set of the geofence properties must be provided in the request body. `POI` geofence type cannot be changed to `circle` or `polygon` and vice versa. If the update was successful, the response will contain the updated geofence details. - [Updates a single geofence](https://docs.here.com/tracking/reference/put_geofences-v2-geofenceid.md): Updates the geofence `type`, `name`, `description`, `metadata` or `definition` property. The old geofence will be replaced by the new one, and hence the full set of the geofence properties must be provided in the request body. `POI` geofence type cannot be changed to `circle` or `polygon` and vice versa. If the update was successful, the response will contain the updated geofence details. - [Gets service health](https://docs.here.com/tracking/reference/get_v2-health-1.md) - [Gets service health](https://docs.here.com/tracking/reference/get_v2-health.md) - [Gets the current timestamp](https://docs.here.com/tracking/reference/get_v2-timestamp-1.md): Returns the current server time in seconds since the UNIX epoch. The server time is used to check the validity of the OAuth 1.0 header of a device data ingestion request. Devices must synchronise with the server time to avoid a clock skew. > Note that in the data ingestion request the timestamp is specified in milliseconds. - [Gets the current timestamp](https://docs.here.com/tracking/reference/get_v2-timestamp.md): Returns the current server time in seconds since the UNIX epoch. The server time is used to check the validity of the OAuth 1.0 header of a device data ingestion request. Devices must synchronise with the server time to avoid a clock skew. > Note that in the data ingestion request the timestamp is specified in milliseconds. - [Gets service version](https://docs.here.com/tracking/reference/get_v2-version-1.md) - [Gets service version](https://docs.here.com/tracking/reference/get_v2-version.md) - [Gets service health](https://docs.here.com/tracking/reference/get_v3-health-1.md) - [Gets service health](https://docs.here.com/tracking/reference/get_v3-health.md) - [Gets service version](https://docs.here.com/tracking/reference/get_v3-version-1.md) - [Gets service version](https://docs.here.com/tracking/reference/get_v3-version.md) - [Ingests data and receives a shadow](https://docs.here.com/tracking/reference/post_v2-1.md): Devices can use this end point to ingest data into HERE Tracking, in the same way as via the `/v3` endpoint. A device uses its access token obtained via the the `/v2/token` endpoint to send telemetry – GPS position, sensor readings, WLAN or Bluetooth scans - to HERE Tracking. By default the request is synchronous and the response will be the device `desired` shadow. If the request is set to be asynchronous, the response will be empty. The device position gets resolved based on the `position` and `scan` objects provided in the request body (see the objects definitions for details). If only `position` is provided, it will be used as the device position. If only `scan` is provided, the position will be resolved asynchronously via the HERE Positioning API after returning a response. If both are provided, `scan` is resolved to a position via the HERE Positioning API, and the better of the two positions (provided vs. resolved) will be selected. If neither `position` nor `scan` is provided, or if the HERE Positioning API is not able to resolve the position, the device position will be left empty. The `reported` shadow will be updated with the device latest position information, sensor readings and settings ingested by the device. The reported shadow may also contain additional properties generated by HERE Tracking based on the device-ingested telemetry. Such properties are stored in the `system.computed` property of the shadow. The device shadow can be queried via the `shadows/v2/{trackingId}` endpoint. The data ingested by the device will be available as a device trace via the `traces/v2/{trackingId}` endpoint. - [Requests a token for a registered device](https://docs.here.com/tracking/reference/post_v2-token-1.md): Authenticates a device to HERE Tracking and requests a device access token. A device must provide a valid device access token when it sends telemetry to HERE Tracking. Tokens can be obtained upon a successful device authentication. The device token requests must be signed. The signature method uses the OAuth 1.0 standard. For more information on this standard, see the [OAuth Core 1.0](https://oauth.net/core/1.0/) specification. Tokens can be requested only by claimed devices. A claimed device license, that is ```deviceId``` and ```deviceSecret``` credential pair, is used for creating a signed token request. > See the Authentication section for details on how to generate a signed token request. > A new signature must be created for each device access token request. > Signatures can only be used once. - [Requests a token for a registered device](https://docs.here.com/tracking/reference/post_v2-token.md): Authenticates a device to HERE Tracking and requests a device access token. A device must provide a valid device access token when it sends telemetry to HERE Tracking. Tokens can be obtained upon a successful device authentication. The device token requests must be signed. The signature method uses the OAuth 1.0 standard. For more information on this standard, see the [OAuth Core 1.0](https://oauth.net/core/1.0/) specification. Tokens can be requested only by claimed devices. A claimed device license, that is ```deviceId``` and ```deviceSecret``` credential pair, is used for creating a signed token request. > See the Authentication section for details on how to generate a signed token request. > A new signature must be created for each device access token request. > Signatures can only be used once. - [Ingests data and receives a shadow](https://docs.here.com/tracking/reference/post_v2.md): Devices can use this end point to ingest data into HERE Tracking, in the same way as via the `/v3` endpoint. A device uses its access token obtained via the the `/v2/token` endpoint to send telemetry – GPS position, sensor readings, WLAN or Bluetooth scans - to HERE Tracking. By default the request is synchronous and the response will be the device `desired` shadow. If the request is set to be asynchronous, the response will be empty. The device position gets resolved based on the `position` and `scan` objects provided in the request body (see the objects definitions for details). If only `position` is provided, it will be used as the device position. If only `scan` is provided, the position will be resolved asynchronously via the HERE Positioning API after returning a response. If both are provided, `scan` is resolved to a position via the HERE Positioning API, and the better of the two positions (provided vs. resolved) will be selected. If neither `position` nor `scan` is provided, or if the HERE Positioning API is not able to resolve the position, the device position will be left empty. The `reported` shadow will be updated with the device latest position information, sensor readings and settings ingested by the device. The reported shadow may also contain additional properties generated by HERE Tracking based on the device-ingested telemetry. Such properties are stored in the `system.computed` property of the shadow. The device shadow can be queried via the `shadows/v2/{trackingId}` endpoint. The data ingested by the device will be available as a device trace via the `traces/v2/{trackingId}` endpoint. - [Ingests data for a device and receives a shadow](https://docs.here.com/tracking/reference/post_v3-1.md): Devices can use this end point to ingest data into HERE Tracking. A device uses its access token obtained via the the `/v2/token` endpoint to send telemetry – GPS position, sensor readings, WLAN or Bluetooth scans - to HERE Tracking. Also device owners use this end point to ingest data on behalf of a device. The device can be either a real or a virtual device. A real device is identified by a `trackingId` assigned to it when the device was claimed. A virtual device is identified by an external device ID and the owner's project `appId`. In case the ingestion is done by a device owner, the owner should first authenticate himself with HERE Tracking and obtain a user access token via the `/users/v2/login` endpoint. The user access token will then be used in this API call. By default the request is synchronous and the response will be the device `desired` shadow. If the request is set to be asynchronous, the response will be empty. The device position gets resolved based on the `position` and `scan` objects provided in the request body (see the objects definitions for details). If only `position` is provided, it will be used as the device position. If only `scan` is provided, the position will be resolved asynchronously via the HERE Positioning API after returning a response. If both are provided, `scan` is resolved to a position via the HERE Positioning API, and the better of the two positions (provided vs. resolved) will be selected. If neither `position` nor `scan` is provided, or if the HERE Positioning API is not able to resolve the position, the device position will be left empty. The `reported` shadow will be updated with the device latest position information, sensor readings and settings ingested by the device. The reported shadow may also contain additional properties generated by HERE Tracking based on the device-ingested telemetry. Such properties are stored in the `system.computed` property of the shadow. The device shadow can be queried via the `shadows/v2/{trackingId}` endpoint. The data ingested by the device will be available as a device trace via the `traces/v2/{trackingId}` endpoint. - [Ingests data for multiple devices](https://docs.here.com/tracking/reference/post_v3-batch-1.md): Device owner use this endpoint to ingest data to HERE Tracking on behalf of multiple devices. A single request can contain data for multiple devices. The devices can be either real or virtual. A real device is identified by a `trackingId` assigned to it when the device was claimed. A virtual device is identified by an external device ID and the owner's project `appId`. Prior to making the request, the device owner should first authenticate himself with HERE Tracking and obtain a user access token. The user access token will then be used in this API call. For more information on the device position resolution, and the device shadow and trace updates, see the `/v3` endpoint description. - [Ingests data for multiple devices](https://docs.here.com/tracking/reference/post_v3-batch.md): Device owner use this endpoint to ingest data to HERE Tracking on behalf of multiple devices. A single request can contain data for multiple devices. The devices can be either real or virtual. A real device is identified by a `trackingId` assigned to it when the device was claimed. A virtual device is identified by an external device ID and the owner's project `appId`. Prior to making the request, the device owner should first authenticate himself with HERE Tracking and obtain a user access token. The user access token will then be used in this API call. For more information on the device position resolution, and the device shadow and trace updates, see the `/v3` endpoint description. - [Ingests data for a device and receives a shadow](https://docs.here.com/tracking/reference/post_v3.md): Devices can use this end point to ingest data into HERE Tracking. A device uses its access token obtained via the the `/v2/token` endpoint to send telemetry – GPS position, sensor readings, WLAN or Bluetooth scans - to HERE Tracking. Also device owners use this end point to ingest data on behalf of a device. The device can be either a real or a virtual device. A real device is identified by a `trackingId` assigned to it when the device was claimed. A virtual device is identified by an external device ID and the owner's project `appId`. In case the ingestion is done by a device owner, the owner should first authenticate himself with HERE Tracking and obtain a user access token via the `/users/v2/login` endpoint. The user access token will then be used in this API call. By default the request is synchronous and the response will be the device `desired` shadow. If the request is set to be asynchronous, the response will be empty. The device position gets resolved based on the `position` and `scan` objects provided in the request body (see the objects definitions for details). If only `position` is provided, it will be used as the device position. If only `scan` is provided, the position will be resolved asynchronously via the HERE Positioning API after returning a response. If both are provided, `scan` is resolved to a position via the HERE Positioning API, and the better of the two positions (provided vs. resolved) will be selected. If neither `position` nor `scan` is provided, or if the HERE Positioning API is not able to resolve the position, the device position will be left empty. The `reported` shadow will be updated with the device latest position information, sensor readings and settings ingested by the device. The reported shadow may also contain additional properties generated by HERE Tracking based on the device-ingested telemetry. Such properties are stored in the `system.computed` property of the shadow. The device shadow can be queried via the `shadows/v2/{trackingId}` endpoint. The data ingested by the device will be available as a device trace via the `traces/v2/{trackingId}` endpoint. - [Deletes all labels of a resource](https://docs.here.com/tracking/reference/delete_labels-v4-resourcetype-resourceid-1.md): Deletes all labels of the resource `resourceId`. - [Deletes all labels of a resource by a label key](https://docs.here.com/tracking/reference/delete_labels-v4-resourcetype-resourceid-key-1.md): Deletes all the labels that have the key `key` of the resource `resourceId`. - [Deletes a label of a resource](https://docs.here.com/tracking/reference/delete_labels-v4-resourcetype-resourceid-key-value-1.md): Deletes the label `key`-`value` of the resource `resourceId`. - [Deletes a label of a resource](https://docs.here.com/tracking/reference/delete_labels-v4-resourcetype-resourceid-key-value.md): Deletes the label `key`-`value` of the resource `resourceId`. - [Deletes all labels of a resource by a label key](https://docs.here.com/tracking/reference/delete_labels-v4-resourcetype-resourceid-key.md): Deletes all the labels that have the key `key` of the resource `resourceId`. - [Deletes all labels of a resource](https://docs.here.com/tracking/reference/delete_labels-v4-resourcetype-resourceid.md): Deletes all labels of the resource `resourceId`. - [Gets service health](https://docs.here.com/tracking/reference/get_labels-v4-health-1.md) - [Gets service health](https://docs.here.com/tracking/reference/get_labels-v4-health.md) - [Gets all labels of a resource type](https://docs.here.com/tracking/reference/get_labels-v4-resourcetype-1.md): Gets all labels of the resource type `resourceType` within a project. The `fields` parameter specifies which fields should be added to the response body (for example, `resourceId`). The `labels` query parameter is specified as a label filter, and only the matching results will be returned: "?labels[priority]=high&labels[group]=group1&fields=resourceId,labels" "?labels[group]=*" - [Gets all label keys of a resource type](https://docs.here.com/tracking/reference/get_labels-v4-resourcetype-keys-1.md): Gets all label keys of the resource type `resourceType`. - [Gets all values of a label](https://docs.here.com/tracking/reference/get_labels-v4-resourcetype-keys-key-values-1.md): Gets all values of the label `key` for the resource type `resourceType`. - [Gets all values of a label](https://docs.here.com/tracking/reference/get_labels-v4-resourcetype-keys-key-values.md): Gets all values of the label `key` for the resource type `resourceType`. - [Gets all label keys of a resource type](https://docs.here.com/tracking/reference/get_labels-v4-resourcetype-keys.md): Gets all label keys of the resource type `resourceType`. - [Gets all labels of a resource](https://docs.here.com/tracking/reference/get_labels-v4-resourcetype-resourceid-1.md): Gets all labels of the resource `resourceId`. - [Gets all labels of a resource](https://docs.here.com/tracking/reference/get_labels-v4-resourcetype-resourceid.md): Gets all labels of the resource `resourceId`. - [Gets all labels of a resource type](https://docs.here.com/tracking/reference/get_labels-v4-resourcetype.md): Gets all labels of the resource type `resourceType` within a project. The `fields` parameter specifies which fields should be added to the response body (for example, `resourceId`). The `labels` query parameter is specified as a label filter, and only the matching results will be returned: "?labels[priority]=high&labels[group]=group1&fields=resourceId,labels" "?labels[group]=*" - [Gets service version](https://docs.here.com/tracking/reference/get_labels-v4-version-1.md) - [Gets service version](https://docs.here.com/tracking/reference/get_labels-v4-version.md) - [Creates a set of labels for a resource](https://docs.here.com/tracking/reference/put_labels-v4-resourcetype-resourceid-batch-1.md): Creates a set of labels for the resource `resourceId`. - [Creates a set of labels for a resource](https://docs.here.com/tracking/reference/put_labels-v4-resourcetype-resourceid-batch.md): Creates a set of labels for the resource `resourceId`. - [Creates a label for a resource](https://docs.here.com/tracking/reference/put_labels-v4-resourcetype-resourceid-key-value-1.md): Creates a label for the resource `resourceId`. - [Creates a label for a resource](https://docs.here.com/tracking/reference/put_labels-v4-resourcetype-resourceid-key-value.md): Creates a label for the resource `resourceId`. - [Deletes large data](https://docs.here.com/tracking/reference/delete_largedata-v4-dataid-1.md): Deletes large data object. - [Deletes large data](https://docs.here.com/tracking/reference/delete_largedata-v4-dataid.md): Deletes large data object. - [Gets large data object](https://docs.here.com/tracking/reference/get_largedata-v4-dataid-data-1.md): Downloads a part of large data. The data to be downloaded is identified with `dataId`. `offset` query paremeter specifies the first byte of the data, and `count` indicates how many bytes of the data is to be downloaded starting from and including the `offset`. The default value for `offset` is zero and the for `count` it is the total size of the data. The size of one downloaded data part must be between 1 byte and 10 MB. - [Gets large data object](https://docs.here.com/tracking/reference/get_largedata-v4-dataid-data.md): Downloads a part of large data. The data to be downloaded is identified with `dataId`. `offset` query paremeter specifies the first byte of the data, and `count` indicates how many bytes of the data is to be downloaded starting from and including the `offset`. The default value for `offset` is zero and the for `count` it is the total size of the data. The size of one downloaded data part must be between 1 byte and 10 MB. - [Gets metadata for a large data object](https://docs.here.com/tracking/reference/get_largedata-v4-dataid-metadata-1.md): Gets metadata for a large data object. - [Gets metadata for a large data object](https://docs.here.com/tracking/reference/get_largedata-v4-dataid-metadata.md): Gets metadata for a large data object. - [Gets parts information listing for a large data object](https://docs.here.com/tracking/reference/get_largedata-v4-dataid-parts-1.md): Gets information about uploaded parts for a large data object. - [Gets parts information listing for a large data object](https://docs.here.com/tracking/reference/get_largedata-v4-dataid-parts.md): Gets information about uploaded parts for a large data object. - [Gets metadata listing for all large data for a device](https://docs.here.com/tracking/reference/get_largedata-v4-devices-trackingid-metadata-1.md): Gets metadata listing for all large data objects for a given device. - [Gets metadata listing for all large data for a device](https://docs.here.com/tracking/reference/get_largedata-v4-devices-trackingid-metadata.md): Gets metadata listing for all large data objects for a given device. - [Gets service health](https://docs.here.com/tracking/reference/get_largedata-v4-health-1.md) - [Gets service health](https://docs.here.com/tracking/reference/get_largedata-v4-health.md) - [Gets service version](https://docs.here.com/tracking/reference/get_largedata-v4-version-1.md) - [Gets service version](https://docs.here.com/tracking/reference/get_largedata-v4-version.md) - [Creates a new data upload](https://docs.here.com/tracking/reference/post_largedata-v4-1.md): Creates a new multipart large data upload. Response contains `dataId`, which is the created large data object identifier. - [Completes data upload](https://docs.here.com/tracking/reference/post_largedata-v4-dataid-1.md): After all parts have been uploaded, this operation completes the upload. When the upload has been completed, it is no longer possible to upload new parts to it but the uploaded data can be downloaded. This request has an optional `abort` query parameter (the default value is `false`) for aborting the upload instead of successfully completing it. If the upload is aborted, all of its parts and data are removed from HERE Tracking. - [Completes data upload](https://docs.here.com/tracking/reference/post_largedata-v4-dataid.md): After all parts have been uploaded, this operation completes the upload. When the upload has been completed, it is no longer possible to upload new parts to it but the uploaded data can be downloaded. This request has an optional `abort` query parameter (the default value is `false`) for aborting the upload instead of successfully completing it. If the upload is aborted, all of its parts and data are removed from HERE Tracking. - [Creates a new data upload](https://docs.here.com/tracking/reference/post_largedata-v4.md): Creates a new multipart large data upload. Response contains `dataId`, which is the created large data object identifier. - [Uploads a part of a large data](https://docs.here.com/tracking/reference/put_largedata-v4-dataid-parts-partnumber-1.md): Uploads a part of large data. The part is identified with `dataId` and a part number. Part upload has the following limits: * The part numbers must start from 1, be no greater than 10000 and be consecutive. * The size of one uploaded data part must be between 1 byte and 1 MB. * Parts re-uploaded with the same `partNumber` are overridden. * Only `application/octet-stream` Content-Type is supported. Parts can be uploaded in any order, the `partNumber` determines their position in the total data. The optional `md5` query parameter can be used to provide the MD5 digest for the uploaded data part. If it is specified and does not match to the received data, HERE Tracking returns HTTP status 400. If the data upload is still in ***preparing*** state, HERE Tracking returns HTTP status 409. - [Uploads a part of a large data](https://docs.here.com/tracking/reference/put_largedata-v4-dataid-parts-partnumber.md): Uploads a part of large data. The part is identified with `dataId` and a part number. Part upload has the following limits: * The part numbers must start from 1, be no greater than 10000 and be consecutive. * The size of one uploaded data part must be between 1 byte and 1 MB. * Parts re-uploaded with the same `partNumber` are overridden. * Only `application/octet-stream` Content-Type is supported. Parts can be uploaded in any order, the `partNumber` determines their position in the total data. The optional `md5` query parameter can be used to provide the MD5 digest for the uploaded data part. If it is specified and does not match to the received data, HERE Tracking returns HTTP status 400. If the data upload is still in ***preparing*** state, HERE Tracking returns HTTP status 409. - [Deletes all locations](https://docs.here.com/tracking/reference/delete_locations-v4-1.md): Deletes all locations of the project. Note that one needs to supply an HTTP header `x-confirm` with the value `true` to force the deletion. If the header is not provided, the request will fail. - [Deletes a location](https://docs.here.com/tracking/reference/delete_locations-v4-locationid-1.md): Deletes the location `locationId`. ***NOTE***: A location can not be deleted if the location is referred by any shipment. - [Deletes a location](https://docs.here.com/tracking/reference/delete_locations-v4-locationid.md): Deletes the location `locationId`. ***NOTE***: A location can not be deleted if the location is referred by any shipment. - [Deletes all locations](https://docs.here.com/tracking/reference/delete_locations-v4.md): Deletes all locations of the project. Note that one needs to supply an HTTP header `x-confirm` with the value `true` to force the deletion. If the header is not provided, the request will fail. - [Gets all locations](https://docs.here.com/tracking/reference/get_locations-v4-1.md): Gets all locations of the project. - [Gets service health](https://docs.here.com/tracking/reference/get_locations-v4-health-1.md) - [Gets service health](https://docs.here.com/tracking/reference/get_locations-v4-health.md) - [Gets a location details](https://docs.here.com/tracking/reference/get_locations-v4-locationid-1.md): Gets details of the location `locationId`. - [Gets a location details](https://docs.here.com/tracking/reference/get_locations-v4-locationid.md): Gets details of the location `locationId`. - [Gets service version](https://docs.here.com/tracking/reference/get_locations-v4-version-1.md) - [Gets service version](https://docs.here.com/tracking/reference/get_locations-v4-version.md) - [Gets all locations](https://docs.here.com/tracking/reference/get_locations-v4.md): Gets all locations of the project. - [Creates a location](https://docs.here.com/tracking/reference/post_locations-v4-1.md): Creates a new location. A location consists of latitude/longitude coordinate pair and/or geofenceId. A name, description, and address of the location may be provided. - [Creates a location](https://docs.here.com/tracking/reference/post_locations-v4.md): Creates a new location. A location consists of latitude/longitude coordinate pair and/or geofenceId. A name, description, and address of the location may be provided. - [Updates a location details](https://docs.here.com/tracking/reference/put_locations-v4-locationid-1.md): Updates the location `locationId` details. A location consists of latitude/longitude coordinate pair and/or geofenceId. A name, description, and address of the location may be provided. The old location definition will be replaced, meaning that full location body should be provided. After a successful update, the response provides the updated location details. - [Updates a location details](https://docs.here.com/tracking/reference/put_locations-v4-locationid.md): Updates the location `locationId` details. A location consists of latitude/longitude coordinate pair and/or geofenceId. A name, description, and address of the location may be provided. The old location definition will be replaced, meaning that full location body should be provided. After a successful update, the response provides the updated location details. - [Deletes all metadata of a device or a shipment](https://docs.here.com/tracking/reference/delete_metadata-v2-devices-trackingid-1.md): Deletes all the metadata of the device or a shipment identified by the `trackingId` or the `shipmentId`. - [Deletes all metadata of a device or a shipment](https://docs.here.com/tracking/reference/delete_metadata-v2-devices-trackingid.md): Deletes all the metadata of the device or a shipment identified by the `trackingId` or the `shipmentId`. - [Deletes all metadata of a geofence](https://docs.here.com/tracking/reference/delete_metadata-v2-geofences-geofenceid-1.md): Deletes all the metadata of the geofence identified by the `geofenceId`. - [Deletes all metadata of a geofence](https://docs.here.com/tracking/reference/delete_metadata-v2-geofences-geofenceid.md): Deletes all the metadata of the geofence identified by the `geofenceId`. - [Deletes all metadata of a sensor rule](https://docs.here.com/tracking/reference/delete_metadata-v2-sensorrules-sensorruleid-1.md): Delete all the metadata of the sensor rule identified by the `sensorRuleId`. - [Deletes all metadata of a sensor rule](https://docs.here.com/tracking/reference/delete_metadata-v2-sensorrules-sensorruleid.md): Delete all the metadata of the sensor rule identified by the `sensorRuleId`. - [Gets metadata of a device or a shipment](https://docs.here.com/tracking/reference/get_metadata-v2-devices-trackingid-1.md): Gets metadata of a device or a shipment identified by the `trackingId` or the `shipmentId`. - [Gets metadata of a device or a shipment](https://docs.here.com/tracking/reference/get_metadata-v2-devices-trackingid.md): Gets metadata of a device or a shipment identified by the `trackingId` or the `shipmentId`. - [Gets metadata of a geofence](https://docs.here.com/tracking/reference/get_metadata-v2-geofences-geofenceid-1.md): Gets metadata of the geofence identified by the `geofenceId`. - [Gets metadata of a geofence](https://docs.here.com/tracking/reference/get_metadata-v2-geofences-geofenceid.md): Gets metadata of the geofence identified by the `geofenceId`. - [Gets service health](https://docs.here.com/tracking/reference/get_metadata-v2-health-1.md) - [Gets service health](https://docs.here.com/tracking/reference/get_metadata-v2-health.md) - [Gets metadata of a sensor rule](https://docs.here.com/tracking/reference/get_metadata-v2-sensorrules-sensorruleid-1.md): Gets metadata of the sensor rule identified by the `sensorRuleId`. - [Gets metadata of a sensor rule](https://docs.here.com/tracking/reference/get_metadata-v2-sensorrules-sensorruleid.md): Gets metadata of the sensor rule identified by the `sensorRuleId`. - [Gets service version](https://docs.here.com/tracking/reference/get_metadata-v2-version-1.md) - [Gets service version](https://docs.here.com/tracking/reference/get_metadata-v2-version.md) - [Gets a batch of metadata of multiple devices or shipments](https://docs.here.com/tracking/reference/post_metadata-v2-devices-batch-1.md): Gets a batch of metadata of multiple devices or shipments. The device or shipment IDs are specified in the request body. - [Gets a batch of metadata of multiple devices or shipments](https://docs.here.com/tracking/reference/post_metadata-v2-devices-batch.md): Gets a batch of metadata of multiple devices or shipments. The device or shipment IDs are specified in the request body. - [Gets a batch of metadata of multiple geofences](https://docs.here.com/tracking/reference/post_metadata-v2-geofences-batch-1.md): Gets a batch of metadata of multiple geofences. The geofences IDs are specified in the request body. - [Gets a batch of metadata of multiple geofences](https://docs.here.com/tracking/reference/post_metadata-v2-geofences-batch.md): Gets a batch of metadata of multiple geofences. The geofences IDs are specified in the request body. - [Gets a batch of metadata for multiple sensor rules](https://docs.here.com/tracking/reference/post_metadata-v2-sensorrules-batch-1.md): Gets a batch of metadata of multiple sensor rules. The sensor rules IDs are specified in the request body. - [Gets a batch of metadata for multiple sensor rules](https://docs.here.com/tracking/reference/post_metadata-v2-sensorrules-batch.md): Gets a batch of metadata of multiple sensor rules. The sensor rules IDs are specified in the request body. - [Creates or updates metadata of a device or a shipment](https://docs.here.com/tracking/reference/put_metadata-v2-devices-trackingid-1.md): Updates the metadata object of the device or a shipment identified by the `trackingId` or the `shipmentId`. The metadata specified in the request body is merged with the existing metadata object (or gets created if no metadata object exists); new keys are added, and the values of the existing keys are updated with the new data. Adding 'null' value for a key deletes it from the metadata object. Successful response body contains the updated metadata object. - [Creates or updates metadata of a device or a shipment](https://docs.here.com/tracking/reference/put_metadata-v2-devices-trackingid.md): Updates the metadata object of the device or a shipment identified by the `trackingId` or the `shipmentId`. The metadata specified in the request body is merged with the existing metadata object (or gets created if no metadata object exists); new keys are added, and the values of the existing keys are updated with the new data. Adding 'null' value for a key deletes it from the metadata object. Successful response body contains the updated metadata object. - [Creates or updates metadata of a geofence](https://docs.here.com/tracking/reference/put_metadata-v2-geofences-geofenceid-1.md): Updates the metadata object of the geofence identified by the `geofenceId`. The metadata specified in the request body is merged with the existing metadata object (or gets created if no metadata object exists); new keys are added, and the values of the existing keys are updated with the new data. Adding 'null' value for a key deletes it from the metadata object. Successful response body contains the updated metadata object. - [Creates or updates metadata of a geofence](https://docs.here.com/tracking/reference/put_metadata-v2-geofences-geofenceid.md): Updates the metadata object of the geofence identified by the `geofenceId`. The metadata specified in the request body is merged with the existing metadata object (or gets created if no metadata object exists); new keys are added, and the values of the existing keys are updated with the new data. Adding 'null' value for a key deletes it from the metadata object. Successful response body contains the updated metadata object. - [Creates or updates metadata of a sensor rule](https://docs.here.com/tracking/reference/put_metadata-v2-sensorrules-sensorruleid-1.md): Updates the metadata object of the sensor rule identified by the `sensorRuleId`. The metadata specified in the request body is merged with the existing metadata object (or gets created if no metadata object exists); new keys are added, and the values of the existing keys are updated with the new data. Adding 'null' value for a key deletes it from the metadata object. Successful response body contains the updated metadata object. - [Creates or updates metadata of a sensor rule](https://docs.here.com/tracking/reference/put_metadata-v2-sensorrules-sensorruleid.md): Updates the metadata object of the sensor rule identified by the `sensorRuleId`. The metadata specified in the request body is merged with the existing metadata object (or gets created if no metadata object exists); new keys are added, and the values of the existing keys are updated with the new data. Adding 'null' value for a key deletes it from the metadata object. Successful response body contains the updated metadata object. - [Deactivates a device.](https://docs.here.com/tracking/reference/delete_registry-v2-devices-deviceorexternalid-1.md): Deactivates a provisioned device. This operation will deactivate the device license (`deviceId` and `deviceSecret`). Deactivated devices cannot be claimed anymore. NOTE: The device must be unclaimed before it can be deactivated. - [Deactivates a device.](https://docs.here.com/tracking/reference/delete_registry-v2-devices-deviceorexternalid.md): Deactivates a provisioned device. This operation will deactivate the device license (`deviceId` and `deviceSecret`). Deactivated devices cannot be claimed anymore. NOTE: The device must be unclaimed before it can be deactivated. - [Unclaims a device](https://docs.here.com/tracking/reference/delete_registry-v2-trackingid-1.md): Unclaims a device removing the ownership association between the user and the device. The device data will no longer be accessible to the user. The device can then be reclaimed by a different or the same user. - [Unclaims a device](https://docs.here.com/tracking/reference/delete_registry-v2-trackingid.md): Unclaims a device removing the ownership association between the user and the device. The device data will no longer be accessible to the user. The device can then be reclaimed by a different or the same user. - [Lists all the devices provisioned by a user](https://docs.here.com/tracking/reference/get_registry-v2-appid-devices-1.md): Lists all the devices provisioned by a user project identified by the `appId`. - [Lists all the devices provisioned by a user](https://docs.here.com/tracking/reference/get_registry-v2-appid-devices.md): Lists all the devices provisioned by a user project identified by the `appId`. - [Gets a number of device licenses provisioned by a user](https://docs.here.com/tracking/reference/get_registry-v2-appid-licensecount-1.md): Gets a number of provisioned device licenses for a user project identified by the `appId`. - [Gets a number of device licenses provisioned by a user](https://docs.here.com/tracking/reference/get_registry-v2-appid-licensecount.md): Gets a number of provisioned device licenses for a user project identified by the `appId`. - [Gets the trackingId for a device](https://docs.here.com/tracking/reference/get_registry-v2-devices-deviceorexternalid-1.md): Gets the `trackingId` for a claimed device by its `deviceId`. - [Gets the trackingId for a device](https://docs.here.com/tracking/reference/get_registry-v2-devices-deviceorexternalid.md): Gets the `trackingId` for a claimed device by its `deviceId`. - [Gets the project features for a project](https://docs.here.com/tracking/reference/get_registry-v2-features-1.md): Gets features for a project identified by `projectId`. - [Gets the project features for a project](https://docs.here.com/tracking/reference/get_registry-v2-features.md): Gets features for a project identified by `projectId`. - [Gets service health](https://docs.here.com/tracking/reference/get_registry-v2-health-1.md) - [Gets service health](https://docs.here.com/tracking/reference/get_registry-v2-health.md) - [Gets the multiple device license request job results](https://docs.here.com/tracking/reference/get_registry-v2-jobid-results-1.md): Gets results of a previously created multiple device license request batch job upon its successful completion. - [Gets the multiple device license request job results](https://docs.here.com/tracking/reference/get_registry-v2-jobid-results.md): Gets results of a previously created multiple device license request batch job upon its successful completion. - [Gets the multiple device license request job status](https://docs.here.com/tracking/reference/get_registry-v2-jobid-status-1.md): Checks the progress of a previously created multiple device license request batch job. - [Gets the multiple device license request job status](https://docs.here.com/tracking/reference/get_registry-v2-jobid-status.md): Checks the progress of a previously created multiple device license request batch job. - [Gets a list of projects along with their license information](https://docs.here.com/tracking/reference/get_registry-v2-licenses-1.md): Gets a list of projects the user is a member of, along with the license information details for each project. - [Gets a list of projects along with their license information](https://docs.here.com/tracking/reference/get_registry-v2-licenses.md): Gets a list of projects the user is a member of, along with the license information details for each project. - [Gets the deviceId](https://docs.here.com/tracking/reference/get_registry-v2-trackingid-1.md): Gets the `deviceId` of a claimed device by its `trackingId`. - [Gets the deviceId](https://docs.here.com/tracking/reference/get_registry-v2-trackingid.md): Gets the `deviceId` of a claimed device by its `trackingId`. - [Gets service version](https://docs.here.com/tracking/reference/get_registry-v2-version-1.md) - [Gets service version](https://docs.here.com/tracking/reference/get_registry-v2-version.md) - [Updates the project features](https://docs.here.com/tracking/reference/patch_registry-v2-features-1.md): Updates features for a project identified by `projectId`. When configurations are updated, those configuration properties provided in the request will override existing properties while properties not provided in the request are left unchanged. Supported project features are: * `data.shipments.autoStartLimitBefore` and `data.shipments.autoStartLimitAfter`: Defines time range in minutes before and after of shipment's `providedEtd` when shipment is allowed to be auto-started. With the time range not defined, or both values set to `-1` the time window is disabled and auto-start is allowed at any time. * `data.shipments.enableStateChangeEvents`: If set to true, publishing shipment state change events to cold storage and output stream is enabled for all shipments in the project. * `data.shipments.ongoingRetentionPeriod`: In case a shipment does not complete within this period of time, it will be cancelled automatically. If this setting is not set, a default of 2 weeks is used as a shipment's ongoing retention period. The retention period is set in hours. Example: ``` "data": { "shipments": { "autoStartLimitAfter": 60, "autoStartLimitBefore": 60, "ongoingRetentionPeriod": 168 }, } ``` - [Updates the project features](https://docs.here.com/tracking/reference/patch_registry-v2-features.md): Updates features for a project identified by `projectId`. When configurations are updated, those configuration properties provided in the request will override existing properties while properties not provided in the request are left unchanged. Supported project features are: * `data.shipments.autoStartLimitBefore` and `data.shipments.autoStartLimitAfter`: Defines time range in minutes before and after of shipment's `providedEtd` when shipment is allowed to be auto-started. With the time range not defined, or both values set to `-1` the time window is disabled and auto-start is allowed at any time. * `data.shipments.enableStateChangeEvents`: If set to true, publishing shipment state change events to cold storage and output stream is enabled for all shipments in the project. * `data.shipments.ongoingRetentionPeriod`: In case a shipment does not complete within this period of time, it will be cancelled automatically. If this setting is not set, a default of 2 weeks is used as a shipment's ongoing retention period. The retention period is set in hours. Example: ``` "data": { "shipments": { "autoStartLimitAfter": 60, "autoStartLimitBefore": 60, "ongoingRetentionPeriod": 168 }, } ``` - [Creates licenses for multiple devices](https://docs.here.com/tracking/reference/post_registry-v2-appid-devices-1.md): Starts a batch job to create licenses for either physical devices or virtual devices. A physical device license is a `deviceId` and `deviceSecret` credential pair. The batch job creates a number of physical device licenses specified by the `count` parameter in the request body. The response contains an array of `deviceId` and `deviceSecret` pairs. Virtual devices are identified with an external device ID and the requestor's project `appId`. The virtual device external ID is application-specific and the user is free to allocate it as user finds suitable. The external IDs for the virtual devices to be created are specified in the `devices` array in request body. For virtual devices the response contains only an array of `deviceId`s, but no `deviceSecret`s. The `autoclaim` parameter can only be used when creating virtual devices. If `autoclaim`=`true`, the created virtual devices are immediately claimed by the requesting user account. In this case the response contains also tracking IDs for the claimed devices. NOTE: Physical devices are deprecated and they should no longer be created. - [Creates licenses for multiple devices](https://docs.here.com/tracking/reference/post_registry-v2-appid-devices.md): Starts a batch job to create licenses for either physical devices or virtual devices. A physical device license is a `deviceId` and `deviceSecret` credential pair. The batch job creates a number of physical device licenses specified by the `count` parameter in the request body. The response contains an array of `deviceId` and `deviceSecret` pairs. Virtual devices are identified with an external device ID and the requestor's project `appId`. The virtual device external ID is application-specific and the user is free to allocate it as user finds suitable. The external IDs for the virtual devices to be created are specified in the `devices` array in request body. For virtual devices the response contains only an array of `deviceId`s, but no `deviceSecret`s. The `autoclaim` parameter can only be used when creating virtual devices. If `autoclaim`=`true`, the created virtual devices are immediately claimed by the requesting user account. In this case the response contains also tracking IDs for the claimed devices. NOTE: Physical devices are deprecated and they should no longer be created. - [Creates a license for a single physical device](https://docs.here.com/tracking/reference/post_registry-v2-appid-one-device-1.md): Device license is a `deviceId` and `deviceSecret` credential pair. The created credentials will be returned in the response body. If `autoclaim` query parameter is set to `true`, the created device will also be claimed by the same user account. NOTE: Physical devices are deprecated and they should no longer be created. - [Creates a license for a single physical device](https://docs.here.com/tracking/reference/post_registry-v2-appid-one-device.md): Device license is a `deviceId` and `deviceSecret` credential pair. The created credentials will be returned in the response body. If `autoclaim` query parameter is set to `true`, the created device will also be claimed by the same user account. NOTE: Physical devices are deprecated and they should no longer be created. - [Gets all resources of a resource type](https://docs.here.com/tracking/reference/post_registry-v4-resources-resourcetype-find-1.md): Gets all resources of the resource type `resourceType`. - [Gets all resources of a resource type](https://docs.here.com/tracking/reference/post_registry-v4-resources-resourcetype-find.md): Gets all resources of the resource type `resourceType`. - [Claims a device](https://docs.here.com/tracking/reference/put_registry-v2-devices-deviceorexternalid-1.md): Claims a device, associating a device to a user account. The user who claimed a device is the device owner, which is different from the device vendor. Unclaimed devices cannot login or send any data to HERE Tracking. A claimed device data is stored in HERE Tracking and is available to the device owner's project, which the device has been claimed to. When a device is claimed, it gets assigned a `trackingId`. This is a unique ID associated with the device data in HERE Tracking. `trackingId` is different from the `deviceId`. The `deviceId` is permanently associated with the hardware, while the `trackingId` is associated with the device data. If the device is later sold or transferred, the `deviceId` remains the same but the `trackingId` changes in case the device is reclaimed. This way the new owner cannot access the old data. If the user is a member of multiple projects, the target project ID needs to be specified in the `projectId` query parameter (note that this is different from the `appId`). Only users with a valid HERE Tracking license are authorized to claim new devices. Claimed devices are associated with the owner application ID, and the total device count is kept up-to-date for billing purposes. - [Claims a device](https://docs.here.com/tracking/reference/put_registry-v2-devices-deviceorexternalid.md): Claims a device, associating a device to a user account. The user who claimed a device is the device owner, which is different from the device vendor. Unclaimed devices cannot login or send any data to HERE Tracking. A claimed device data is stored in HERE Tracking and is available to the device owner's project, which the device has been claimed to. When a device is claimed, it gets assigned a `trackingId`. This is a unique ID associated with the device data in HERE Tracking. `trackingId` is different from the `deviceId`. The `deviceId` is permanently associated with the hardware, while the `trackingId` is associated with the device data. If the device is later sold or transferred, the `deviceId` remains the same but the `trackingId` changes in case the device is reclaimed. This way the new owner cannot access the old data. If the user is a member of multiple projects, the target project ID needs to be specified in the `projectId` query parameter (note that this is different from the `appId`). Only users with a valid HERE Tracking license are authorized to claim new devices. Claimed devices are associated with the owner application ID, and the total device count is kept up-to-date for billing purposes. - [Deletes all rules](https://docs.here.com/tracking/reference/delete_rules-v4-1.md): Deletes all rules of the project. Note that one needs to supply an HTTP header `x-confirm` with the value `true` to force the deletion. If the header is not provided, the request will fail. - [Deletes a rule](https://docs.here.com/tracking/reference/delete_rules-v4-ruleid-1.md): Deletes a rule identified by the `ruleId`. - [Deletes a rule](https://docs.here.com/tracking/reference/delete_rules-v4-ruleid.md): Deletes a rule identified by the `ruleId`. - [Deletes all rules](https://docs.here.com/tracking/reference/delete_rules-v4.md): Deletes all rules of the project. Note that one needs to supply an HTTP header `x-confirm` with the value `true` to force the deletion. If the header is not provided, the request will fail. - [Gets all rules](https://docs.here.com/tracking/reference/get_rules-v4-1.md): Gets all rules definitions. - [Gets service health](https://docs.here.com/tracking/reference/get_rules-v4-health-1.md) - [Gets service health](https://docs.here.com/tracking/reference/get_rules-v4-health.md) - [Gets a single rule](https://docs.here.com/tracking/reference/get_rules-v4-ruleid-1.md): Gets details of a single rule identified by the `ruleId`. - [Gets a single rule](https://docs.here.com/tracking/reference/get_rules-v4-ruleid.md): Gets details of a single rule identified by the `ruleId`. - [Gets service version](https://docs.here.com/tracking/reference/get_rules-v4-version-1.md) - [Gets service version](https://docs.here.com/tracking/reference/get_rules-v4-version.md) - [Gets all rules](https://docs.here.com/tracking/reference/get_rules-v4.md): Gets all rules definitions. - [Creates a rule](https://docs.here.com/tracking/reference/post_rules-v4-1.md): Creates a rule of the specified rule `type` and with the defined `threshold`. After the rule has been created, it needs to be associated to a device to get activated. Detention rule --- For a rule of the `detention` type the threshold is defined as a duration in seconds. A `DETENTION_STARTED` event gets triggered when the device has remained stationary for longer than the threshold duration. A `DETENTION_ENDED` event will be generated when the device starts moving again. Utilization rule --- For a rule of the `utilization` type the threshold is defined as a duration in seconds. An `UNUTILIZED` event will be generated when the device has been stationary for longer than the threshold duration, and `UTILIZED` event gets triggered when the device starts moving again after having been stationary. Dwelling rule --- For a rule of the `dwelling` type the threshold is defined as a duration in seconds. A `DWELLING_STARTED` event gets triggered when a dwelling time of the device inside any device-associated geofence exceeds the threshold duration. When the device exits the geofence, a `DWELLING_ENDED` event will be generated. Online rule --- For a rule of the `online` type there is no threshold defined. A `TRUE_TO_FALSE` event gets triggered when the device is late for the planned ingestion schedule by more than 5 minutes. A `FALSE_TO_TRUE` event is generated when the device starts ingesting again after having been offline. The planned ingestion schedule needs to be configured in the device `desired shadow` (the `desired.system.powerSave.sendMs` or `desired.system.rate.sendMs` property). Stock rule --- For a rule of the `stock` type the threshold is defined as `minVolume` and/or `maxVolume` values. When creating a stock rule, also a geofence ID needs to be specified. When the number of devices inside the specified geofence exceeds `maxVolume`, an `OVERSTOCK` event will be generated. Similarly, when the number of devices inside the specified geofence gets below `minVolume`, an `UNDERSTOCK` event will be generated. When the number of devices inside the specified geofence is between `minVolume` and `maxVolume`, a `NORMAL_VOLUME` event will be generated. Note that the stock rule only gets triggered for devices that are associated to the specified geofence. There can be up to 10 stock rules in a tracking project. Shipment estimate change --- For a rule of the `shipmentEtaChange` type the threshold is defined as a ETD/ETA estimation deviation in seconds. A `SHIPMENT_ESTIMATE_CHANGED` event gets triggered when the new ETD/ETA estimates values differ from the previous estimates more than the defined threshold. If the `segmentEtaChange` property is set to `true`, then the event is triggered from segment level ETD/ETA estimate changes, not from shipment level ETD/ETA estimate changes. Shipment schedule rule --- For a rule of the `shipmentSchedule` type there are `before` and `after` deviation time thresholds from the planned shipment ETD/ETA. A `SHIPMENT_EARLY` event gets triggered when the shipment is ahead of schedule by the number of `before` seconds. A `SHIPMENT_DELAYED` event gets triggered when the shipment is behind schedule by the number of `after` seconds. A `SHIPMENT_ON_TIME` event gets triggered when the shipment is on time. When a rule has been successfully created, the response body will contain the created rule ID. - [Creates a rule](https://docs.here.com/tracking/reference/post_rules-v4.md): Creates a rule of the specified rule `type` and with the defined `threshold`. After the rule has been created, it needs to be associated to a device to get activated. Detention rule --- For a rule of the `detention` type the threshold is defined as a duration in seconds. A `DETENTION_STARTED` event gets triggered when the device has remained stationary for longer than the threshold duration. A `DETENTION_ENDED` event will be generated when the device starts moving again. Utilization rule --- For a rule of the `utilization` type the threshold is defined as a duration in seconds. An `UNUTILIZED` event will be generated when the device has been stationary for longer than the threshold duration, and `UTILIZED` event gets triggered when the device starts moving again after having been stationary. Dwelling rule --- For a rule of the `dwelling` type the threshold is defined as a duration in seconds. A `DWELLING_STARTED` event gets triggered when a dwelling time of the device inside any device-associated geofence exceeds the threshold duration. When the device exits the geofence, a `DWELLING_ENDED` event will be generated. Online rule --- For a rule of the `online` type there is no threshold defined. A `TRUE_TO_FALSE` event gets triggered when the device is late for the planned ingestion schedule by more than 5 minutes. A `FALSE_TO_TRUE` event is generated when the device starts ingesting again after having been offline. The planned ingestion schedule needs to be configured in the device `desired shadow` (the `desired.system.powerSave.sendMs` or `desired.system.rate.sendMs` property). Stock rule --- For a rule of the `stock` type the threshold is defined as `minVolume` and/or `maxVolume` values. When creating a stock rule, also a geofence ID needs to be specified. When the number of devices inside the specified geofence exceeds `maxVolume`, an `OVERSTOCK` event will be generated. Similarly, when the number of devices inside the specified geofence gets below `minVolume`, an `UNDERSTOCK` event will be generated. When the number of devices inside the specified geofence is between `minVolume` and `maxVolume`, a `NORMAL_VOLUME` event will be generated. Note that the stock rule only gets triggered for devices that are associated to the specified geofence. There can be up to 10 stock rules in a tracking project. Shipment estimate change --- For a rule of the `shipmentEtaChange` type the threshold is defined as a ETD/ETA estimation deviation in seconds. A `SHIPMENT_ESTIMATE_CHANGED` event gets triggered when the new ETD/ETA estimates values differ from the previous estimates more than the defined threshold. If the `segmentEtaChange` property is set to `true`, then the event is triggered from segment level ETD/ETA estimate changes, not from shipment level ETD/ETA estimate changes. Shipment schedule rule --- For a rule of the `shipmentSchedule` type there are `before` and `after` deviation time thresholds from the planned shipment ETD/ETA. A `SHIPMENT_EARLY` event gets triggered when the shipment is ahead of schedule by the number of `before` seconds. A `SHIPMENT_DELAYED` event gets triggered when the shipment is behind schedule by the number of `after` seconds. A `SHIPMENT_ON_TIME` event gets triggered when the shipment is on time. When a rule has been successfully created, the response body will contain the created rule ID. - [Updates a single rule](https://docs.here.com/tracking/reference/put_rules-v4-ruleid-1.md): Updates the name, description and threshold of the rule `ruleId`. The rule type cannot be updated. If some of the these properties are not provided in the request body, their values will be set to null. If the rule has been updated successfully, the response will contain the updated rule details. - [Updates a single rule](https://docs.here.com/tracking/reference/put_rules-v4-ruleid.md): Updates the name, description and threshold of the rule `ruleId`. The rule type cannot be updated. If some of the these properties are not provided in the request body, their values will be set to null. If the rule has been updated successfully, the response will contain the updated rule details. - [Deletes all sensor rules](https://docs.here.com/tracking/reference/delete_sensors-v3-1.md): Deletes all sensor rules of a project. Note that one needs to supply an HTTP header `x-confirm` with the value `true` to force the deletion. If the header is not provided, the request will fail. - [Deletes a sensor rule](https://docs.here.com/tracking/reference/delete_sensors-v3-sensorruleid-1.md): Deletes a sensor rule identified by the `sensorRuleId`. - [Deletes a sensor rule](https://docs.here.com/tracking/reference/delete_sensors-v3-sensorruleid.md): Deletes a sensor rule identified by the `sensorRuleId`. - [Deletes all sensor rules](https://docs.here.com/tracking/reference/delete_sensors-v3.md): Deletes all sensor rules of a project. Note that one needs to supply an HTTP header `x-confirm` with the value `true` to force the deletion. If the header is not provided, the request will fail. - [Gets all sensor rules](https://docs.here.com/tracking/reference/get_sensors-v3-1.md): Gets all sensor rules definitions. - [Gets service health](https://docs.here.com/tracking/reference/get_sensors-v3-health-1.md) - [Gets service health](https://docs.here.com/tracking/reference/get_sensors-v3-health.md) - [Gets a single sensor rule](https://docs.here.com/tracking/reference/get_sensors-v3-sensorruleid-1.md): Gets details of a single sensor rule identified by the `sensorRuleId`. - [Gets a single sensor rule](https://docs.here.com/tracking/reference/get_sensors-v3-sensorruleid.md): Gets details of a single sensor rule identified by the `sensorRuleId`. - [Gets service version](https://docs.here.com/tracking/reference/get_sensors-v3-version-1.md) - [Gets service version](https://docs.here.com/tracking/reference/get_sensors-v3-version.md) - [Gets all sensor rules](https://docs.here.com/tracking/reference/get_sensors-v3.md): Gets all sensor rules definitions. - [Creates a sensor rule](https://docs.here.com/tracking/reference/post_sensors-v3-1.md): Creates a sensor rule of the specified rule type. After the sensor rule has been created, it needs to be associated to a device to get activated. For a sensor rule of the battery, humidity, pressure and temperature type, a `range` parameter needs to be specified, defining both upper and lower thresholds for the sensor readings. When the device ingests data, the reported sensor reading is compared to the defined range and in case in or out of range transition has taken place, an event gets triggered. For a sensor rule of the acceleration type, a `threshold` parameter needs to be specified, defining the acceleration threshold value. Every time the device reports its accelerometer sensor reading being above the threshold, an event gets triggered. For a sensor rule of the attach and tamper types, no additional parameters need to be specified. The attach sensor detects whether the device is attached to some object (for example to an asset). The tamper sensor detects whether the device cover is open or closed. When the cover is open, the device is considered to be tampered with. Every time the device reports getting attached, detached, tampered with or left with the cover closed (that is, not tampered with), an event gets triggered. When a sensor rule has been successfully created, the response body will contain the created rule ID. - [Creates a sensor rule](https://docs.here.com/tracking/reference/post_sensors-v3.md): Creates a sensor rule of the specified rule type. After the sensor rule has been created, it needs to be associated to a device to get activated. For a sensor rule of the battery, humidity, pressure and temperature type, a `range` parameter needs to be specified, defining both upper and lower thresholds for the sensor readings. When the device ingests data, the reported sensor reading is compared to the defined range and in case in or out of range transition has taken place, an event gets triggered. For a sensor rule of the acceleration type, a `threshold` parameter needs to be specified, defining the acceleration threshold value. Every time the device reports its accelerometer sensor reading being above the threshold, an event gets triggered. For a sensor rule of the attach and tamper types, no additional parameters need to be specified. The attach sensor detects whether the device is attached to some object (for example to an asset). The tamper sensor detects whether the device cover is open or closed. When the cover is open, the device is considered to be tampered with. Every time the device reports getting attached, detached, tampered with or left with the cover closed (that is, not tampered with), an event gets triggered. When a sensor rule has been successfully created, the response body will contain the created rule ID. - [Updates a single sensor rule](https://docs.here.com/tracking/reference/put_sensors-v3-sensorruleid-1.md): Updates the sensor rule `sensorRuleId` name, description and range or threshold. The sensor rule type cannot be updated. If some of the these properties are not provided in the request body, their values will be set to null. If the sensor rule has been updated successfully, the response will contain the updated rule details. - [Updates a single sensor rule](https://docs.here.com/tracking/reference/put_sensors-v3-sensorruleid.md): Updates the sensor rule `sensorRuleId` name, description and range or threshold. The sensor rule type cannot be updated. If some of the these properties are not provided in the request body, their values will be set to null. If the sensor rule has been updated successfully, the response will contain the updated rule details. - [Clears a device shadow](https://docs.here.com/tracking/reference/delete_shadows-v2-trackingid-1.md): Deletes the device shadow of the `trackingId` device. By default, all the values of the `desired` and `reported` shadow objects will be cleared, leaving them empty. If either `desired` or `reported` query parameter is set to `false`, that part of the shadow remains as it is. - [Clears a device shadow](https://docs.here.com/tracking/reference/delete_shadows-v2-trackingid.md): Deletes the device shadow of the `trackingId` device. By default, all the values of the `desired` and `reported` shadow objects will be cleared, leaving them empty. If either `desired` or `reported` query parameter is set to `false`, that part of the shadow remains as it is. - [Gets service health](https://docs.here.com/tracking/reference/get_shadows-v2-health-1.md) - [Gets service health](https://docs.here.com/tracking/reference/get_shadows-v2-health.md) - [Gets a device shadow](https://docs.here.com/tracking/reference/get_shadows-v2-trackingid-1.md): Gets the `trackingId` device shadow that contains both `reported` and `desired` shadows. If a `shipmentId` is used instead of a `trackingId`, it will return a shadow of the device that was most recently active for the shipment. If the shipment is still pending or it has been cancelled or completed, an empty shadow will be returned. - [Gets reported or desired state object of a device](https://docs.here.com/tracking/reference/get_shadows-v2-trackingid-state-1.md): Gets the `reported` or `desired` state object of the device `trackingId`, that is the `reported` or `desired` device shadow. - [Gets a value of a shadow property](https://docs.here.com/tracking/reference/get_shadows-v2-trackingid-state-selector-1.md): Gets a value of a single property of either `desired` or `reported` state objects of a device. One can use JSON selectors to specify the target property or reference it by name. In case the property contains an object, the entire object will be returned in the response. The JSON selector can be nested like this: `payload/time/minutes` - [Gets a value of a shadow property](https://docs.here.com/tracking/reference/get_shadows-v2-trackingid-state-selector.md): Gets a value of a single property of either `desired` or `reported` state objects of a device. One can use JSON selectors to specify the target property or reference it by name. In case the property contains an object, the entire object will be returned in the response. The JSON selector can be nested like this: `payload/time/minutes` - [Gets reported or desired state object of a device](https://docs.here.com/tracking/reference/get_shadows-v2-trackingid-state.md): Gets the `reported` or `desired` state object of the device `trackingId`, that is the `reported` or `desired` device shadow. - [Gets a device shadow](https://docs.here.com/tracking/reference/get_shadows-v2-trackingid.md): Gets the `trackingId` device shadow that contains both `reported` and `desired` shadows. If a `shipmentId` is used instead of a `trackingId`, it will return a shadow of the device that was most recently active for the shipment. If the shipment is still pending or it has been cancelled or completed, an empty shadow will be returned. - [Gets service version](https://docs.here.com/tracking/reference/get_shadows-v2-version-1.md) - [Gets service version](https://docs.here.com/tracking/reference/get_shadows-v2-version.md) - [Gets all shadows](https://docs.here.com/tracking/reference/get_shadows-v4-1.md): Gets all device shadows of a project. - [Gets all shadows](https://docs.here.com/tracking/reference/get_shadows-v4.md): Gets all device shadows of a project. - [Gets a batch of device shadows](https://docs.here.com/tracking/reference/post_shadows-v2-batch-1.md): Gets device shadows for multiple devices. One can get shadows for a maximum of 100 devices per request. In case `after` parameter is provided, only the device shadows that were modified on or after the specified timestamp will be retrieved. - [Gets a batch of device shadows](https://docs.here.com/tracking/reference/post_shadows-v2-batch.md): Gets device shadows for multiple devices. One can get shadows for a maximum of 100 devices per request. In case `after` parameter is provided, only the device shadows that were modified on or after the specified timestamp will be retrieved. - [Updates a device shadow](https://docs.here.com/tracking/reference/put_shadows-v2-trackingid-1.md): Updates the `trackingId` device desired shadow. The device shadow consists of `reported` and `desired` shadows. Only the `desired` shadow can be updated via this endpoint. The `reported` shadow is updated automatically when the device sends telemetry to the ingestion endpoint. - [Updates a device shadow](https://docs.here.com/tracking/reference/put_shadows-v2-trackingid.md): Updates the `trackingId` device desired shadow. The device shadow consists of `reported` and `desired` shadows. Only the `desired` shadow can be updated via this endpoint. The `reported` shadow is updated automatically when the device sends telemetry to the ingestion endpoint. - [Deletes all shipments](https://docs.here.com/tracking/reference/delete_shipments-v4-1.md): Deletes all the shipments of the project. Note that one needs to supply an HTTP header `x-confirm` with the value `true` to force the deletion. If the header is not provided, the request will fail. If the project has many shipments, deleting them all can take a while. This operation returns 202 as long as the shipments deletion is in progress and 204 after all shipments have been deleted. - [Deletes a shipment](https://docs.here.com/tracking/reference/delete_shipments-v4-shipmentid-1.md): Deletes a shipment identified by the `shipmentId`. All the data related to the shipment (such as events, associations) will be removed. - [Deletes a shipment](https://docs.here.com/tracking/reference/delete_shipments-v4-shipmentid.md): Deletes a shipment identified by the `shipmentId`. All the data related to the shipment (such as events, associations) will be removed. - [Deletes all shipments](https://docs.here.com/tracking/reference/delete_shipments-v4.md): Deletes all the shipments of the project. Note that one needs to supply an HTTP header `x-confirm` with the value `true` to force the deletion. If the header is not provided, the request will fail. If the project has many shipments, deleting them all can take a while. This operation returns 202 as long as the shipments deletion is in progress and 204 after all shipments have been deleted. - [Gets all shipments](https://docs.here.com/tracking/reference/get_shipments-v4-1.md): Gets all shipments of the project. - [Gets service health](https://docs.here.com/tracking/reference/get_shipments-v4-health-1.md) - [Gets service health](https://docs.here.com/tracking/reference/get_shipments-v4-health.md) - [Gets a shipment details](https://docs.here.com/tracking/reference/get_shipments-v4-shipmentid-1.md): Gets details of a specific shipment identified by the `shipmentId`. - [Gets a segment details](https://docs.here.com/tracking/reference/get_shipments-v4-shipmentid-segmentid-1.md): Gets details of a segment identified by the `segmentId`. - [Gets a segment details](https://docs.here.com/tracking/reference/get_shipments-v4-shipmentid-segmentid.md): Gets details of a segment identified by the `segmentId`. - [Gets a shipment details](https://docs.here.com/tracking/reference/get_shipments-v4-shipmentid.md): Gets details of a specific shipment identified by the `shipmentId`. - [Gets segments assigned to a device](https://docs.here.com/tracking/reference/get_shipments-v4-trackingid-segments-1.md): Gets all segments that are assigned to the device with `trackingId` or `shipmentId`. - [Gets segments assigned to a device](https://docs.here.com/tracking/reference/get_shipments-v4-trackingid-segments.md): Gets all segments that are assigned to the device with `trackingId` or `shipmentId`. - [Gets service version](https://docs.here.com/tracking/reference/get_shipments-v4-version-1.md) - [Gets service version](https://docs.here.com/tracking/reference/get_shipments-v4-version.md) - [Gets all shipments](https://docs.here.com/tracking/reference/get_shipments-v4.md): Gets all shipments of the project. - [Updates a shipment details](https://docs.here.com/tracking/reference/patch_shipments-v4-shipmentid-1.md): Updates details of a shipment identified by the `shipmentId`. This is a partial update, meaning that only the provided fields will be updated, except when updating segments, the whole segments will be replaced fully. Changing the status of the shipment affects the statuses of the segments. The following status changes are allowed: * `pending` → `ongoing` * changes the status of the first segment to `ongoing` * `pending` → `cancelled` * changes the status of `ongoing` and all `pending` segments to `cancelled` * `ongoing` → `cancelled` * cancels the current `ongoing` segment and all the succeeding segments * `ongoing` → `completed` * completes the current `ongoing` segment and cancels all the succeeding segments ***Note***: `segments` and `autoStart` can be updated via this API call only if the shipment is in `pending` state. The "Tracker only" variant of the request updates the given tracking device to all `ongoing` and `pending` state segments of the shipment, so it allows to make tracker association both for `ongoing` and `pending` state shipments. - [Updates a segment details](https://docs.here.com/tracking/reference/patch_shipments-v4-shipmentid-segmentid-1.md): Updates details of a segment identified by the `segmentId`. This is a partial update, meaning that only the provided fields will be updated. Changing the status of a segment affects the statuses of other segments in the shipment. The following status changes are allowed: * `pending` → `ongoing` * changes previous `pending` segments to `cancelled` * changes previous `ongoing` segment to `completed` (only for the immediate predecessor of this segment) * changes previous `ongoing` segment to `cancelled` (for segments that are not immediate predecessors of this segment) * previous segments in `cancelled` or `completed` states are not affected * `pending` || `ongoing` → `cancelled` * no changes for other segments * `ongoing` → `completed` * next segment with status `pending` is changed to `ongoing` ***Note***: `trackingId` can be updated through this API call only if the segment is in `pending` state. - [Updates a segment details](https://docs.here.com/tracking/reference/patch_shipments-v4-shipmentid-segmentid.md): Updates details of a segment identified by the `segmentId`. This is a partial update, meaning that only the provided fields will be updated. Changing the status of a segment affects the statuses of other segments in the shipment. The following status changes are allowed: * `pending` → `ongoing` * changes previous `pending` segments to `cancelled` * changes previous `ongoing` segment to `completed` (only for the immediate predecessor of this segment) * changes previous `ongoing` segment to `cancelled` (for segments that are not immediate predecessors of this segment) * previous segments in `cancelled` or `completed` states are not affected * `pending` || `ongoing` → `cancelled` * no changes for other segments * `ongoing` → `completed` * next segment with status `pending` is changed to `ongoing` ***Note***: `trackingId` can be updated through this API call only if the segment is in `pending` state. - [Updates a shipment details](https://docs.here.com/tracking/reference/patch_shipments-v4-shipmentid.md): Updates details of a shipment identified by the `shipmentId`. This is a partial update, meaning that only the provided fields will be updated, except when updating segments, the whole segments will be replaced fully. Changing the status of the shipment affects the statuses of the segments. The following status changes are allowed: * `pending` → `ongoing` * changes the status of the first segment to `ongoing` * `pending` → `cancelled` * changes the status of `ongoing` and all `pending` segments to `cancelled` * `ongoing` → `cancelled` * cancels the current `ongoing` segment and all the succeeding segments * `ongoing` → `completed` * completes the current `ongoing` segment and cancels all the succeeding segments ***Note***: `segments` and `autoStart` can be updated via this API call only if the shipment is in `pending` state. The "Tracker only" variant of the request updates the given tracking device to all `ongoing` and `pending` state segments of the shipment, so it allows to make tracker association both for `ongoing` and `pending` state shipments. - [Creates a shipment](https://docs.here.com/tracking/reference/post_shipments-v4-1.md): Creates a new shipment. A shipment consists of segments each representing a part of the logistics journey. A segment spans from a location to another and each segment may be assigned a different tracking device. The segments of the shipment must form a continuous chain of locations, that is the origin of a segment must match the destination of a previous segment. - [Creates a shipment](https://docs.here.com/tracking/reference/post_shipments-v4.md): Creates a new shipment. A shipment consists of segments each representing a part of the logistics journey. A segment spans from a location to another and each segment may be assigned a different tracking device. The segments of the shipment must form a continuous chain of locations, that is the origin of a segment must match the destination of a previous segment. - [Deletes all the device traces and events](https://docs.here.com/tracking/reference/delete_traces-v2-trackingid-1.md): Deletes all the device `trackingId` traces. This will also trigger deletion of the entire event history of the device. - [Deletes all the device traces and events](https://docs.here.com/tracking/reference/delete_traces-v2-trackingid.md): Deletes all the device `trackingId` traces. This will also trigger deletion of the entire event history of the device. - [Gets service health](https://docs.here.com/tracking/reference/get_traces-v2-health-1.md) - [Gets service health](https://docs.here.com/tracking/reference/get_traces-v2-health.md) - [Gets traces within a specified time range](https://docs.here.com/tracking/reference/get_traces-v2-trackingid-1.md): Gets all traces of the device `trackingId` that were recorded within the specified time range. The range is defined with `before` and `after` parameters. The returned traces are sorted in descending order based on their timestamps. The default value for `before` parameter is the current time, and for the `after` parameter it is one day in the past from the current time. The `after` parameter value is not allowed to be earlier than 18 days in the past from the `before` timestamp, otherwise an error is returned. If the `trackingId` is substituted with a valid `shipmentId`, the response contains a composition of traces of each shipment segment. Traces are only fetched for those segments that are either in `ongoing` or `completed` state. The `outliers` parameter can be used to select only traces that have been marked as outliers (if the parameter value is `true`), or only traces that have not been marked as outliers (if the parameter value is `false`). If the `outliers` parameter is not present, all the traces will be returned. The `count` and `pageToken` parameters are used for pagination. - [Gets traces within a specified time range](https://docs.here.com/tracking/reference/get_traces-v2-trackingid.md): Gets all traces of the device `trackingId` that were recorded within the specified time range. The range is defined with `before` and `after` parameters. The returned traces are sorted in descending order based on their timestamps. The default value for `before` parameter is the current time, and for the `after` parameter it is one day in the past from the current time. The `after` parameter value is not allowed to be earlier than 18 days in the past from the `before` timestamp, otherwise an error is returned. If the `trackingId` is substituted with a valid `shipmentId`, the response contains a composition of traces of each shipment segment. Traces are only fetched for those segments that are either in `ongoing` or `completed` state. The `outliers` parameter can be used to select only traces that have been marked as outliers (if the parameter value is `true`), or only traces that have not been marked as outliers (if the parameter value is `false`). If the `outliers` parameter is not present, all the traces will be returned. The `count` and `pageToken` parameters are used for pagination. - [Gets service version](https://docs.here.com/tracking/reference/get_traces-v2-version-1.md) - [Gets service version](https://docs.here.com/tracking/reference/get_traces-v2-version.md) - [Gets all devices claimed by a project](https://docs.here.com/tracking/reference/get_users-v2-devices-1.md): Gets all devices claimed by a project. - [Gets all devices claimed by a project](https://docs.here.com/tracking/reference/get_users-v2-devices.md): Gets all devices claimed by a project. - [Gets service health](https://docs.here.com/tracking/reference/get_users-v2-health-1.md) - [Gets service health](https://docs.here.com/tracking/reference/get_users-v2-health.md) - [Gets service version](https://docs.here.com/tracking/reference/get_users-v2-version-1.md) - [Gets service version](https://docs.here.com/tracking/reference/get_users-v2-version.md) - [Gets a user access token](https://docs.here.com/tracking/reference/post_users-v2-login-1.md): Authenticates a user with an email and a password and gets a user access token upon the successful authentication. The user email must be registered with a valid [HERE Account](https://account.here.com). Optionally user can provide requested realm ID. - [Gets a user access token](https://docs.here.com/tracking/reference/post_users-v2-login.md): Authenticates a user with an email and a password and gets a user access token upon the successful authentication. The user email must be registered with a valid [HERE Account](https://account.here.com). Optionally user can provide requested realm ID. - [Gets a renewed user access token](https://docs.here.com/tracking/reference/post_users-v2-refresh-1.md): Gets a new valid user access token for a given previous access token and a refresh token. - [Gets a renewed user access token](https://docs.here.com/tracking/reference/post_users-v2-refresh.md): Gets a new valid user access token for a given previous access token and a refresh token. - [Gets a project-scoped user access token](https://docs.here.com/tracking/reference/post_users-v2-tokenexchange-1.md): Takes user access token, requested scope and returns project-scoped user access token. - [Gets a project-scoped user access token](https://docs.here.com/tracking/reference/post_users-v2-tokenexchange.md): Takes user access token, requested scope and returns project-scoped user access token. # Usage API Documentation ## Guides - [Cost Management concepts](https://docs.here.com/usage/docs/concepts.md) - [Introduction to Cost Management](https://docs.here.com/usage/docs/cost-management-dev-guide-readme.md) - [Cost Management Usage service](https://docs.here.com/usage/docs/cost-management-usage-service.md) - [How to add and use billing tags](https://docs.here.com/usage/docs/tutorial-billing-tags.md) - [How to retrieve usage by appId](https://docs.here.com/usage/docs/tutorial-get-usage-by-app-id.md) - [How to retrieve usage by featureId](https://docs.here.com/usage/docs/tutorial-get-usage-by-feature-id.md) - [How to retrieve usage by organization](https://docs.here.com/usage/docs/tutorial-get-usage-by-organization.md) - [How to retrieve usage by projectHrn](https://docs.here.com/usage/docs/tutorial-get-usage-by-project-hrn.md) - [How to retrieve usage csv by appId](https://docs.here.com/usage/docs/tutorial-get-usage-csv-by-app-id.md) - [How to retrieve usage csv by featureId](https://docs.here.com/usage/docs/tutorial-get-usage-csv-by-feature-id.md) - [How to retrieve usage csv by organization](https://docs.here.com/usage/docs/tutorial-get-usage-csv-by-organization.md) - [How to retrieve usage csv by projectHrn](https://docs.here.com/usage/docs/tutorial-get-usage-csv-by-project-hrn.md) - [Cost Management tutorials](https://docs.here.com/usage/docs/cost-management-tutorials.md) - [Get started with Cost Management](https://docs.here.com/usage/docs/get-started.md) - [HERE partner end-customer management](https://docs.here.com/usage/docs/here-partner-end-customer-management.md) - [How to create usage reports for partner subaccounts](https://docs.here.com/usage/docs/tutorial-partner-create-reports-for-subaccounts.md) - [How to download usage report by ID](https://docs.here.com/usage/docs/tutorial-partner-download-usage-report-by-id.md) - [How to retrieve status for all usage report requests](https://docs.here.com/usage/docs/tutorial-partner-get-usage-report-status-all-reports.md) - [How to retrieve status for a usage report request by ID](https://docs.here.com/usage/docs/tutorial-partner-get-usage-report-status-by-report-id.md) - [HERE partner billing](https://docs.here.com/usage/docs/partner-concepts.md) - [API Changes](https://docs.here.com/usage/docs/api-changes.md) - [Functional and Behavioral Changes](https://docs.here.com/usage/docs/functional-behavioral-changes.md) - [Changes](https://docs.here.com/usage/docs/changes.md) - [Known Issues](https://docs.here.com/usage/docs/known-issues.md) - [Limitations and Workarounds](https://docs.here.com/usage/docs/limitations-workarounds.md) - [New Features](https://docs.here.com/usage/docs/new-features.md) - [Resolved Issues](https://docs.here.com/usage/docs/resolved-issues.md) - [Highlights](https://docs.here.com/usage/docs/highlights.md) - [Overview](https://docs.here.com/usage/docs/landing.md) ## API Reference - [Retrieves API version information](https://docs.here.com/usage/reference/getapiversion.md) - [Tests basic health of the service](https://docs.here.com/usage/reference/gethealth.md) - [Create usage reports for partner subaccounts](https://docs.here.com/usage/reference/createusagereport.md): This is an Async API which generates usage reports for partner organizations or subaccounts. If the subaccounts aren't passed, then it only generates the partner organization usage report. If subaccounts pass to the request body, then the usage report consists of data for the subaccounts. * API response has the current status of the request and also a header containing the URL for the "get report status" request. * The API supports usage by app ID. - [Download a usage report](https://docs.here.com/usage/reference/fetchcreatedreport.md): This API downloads the created usage report. * The API responds with the usage report encoded in gzip format. * The API supports usage by app ID. - [Retrieve status for all usage report requests](https://docs.here.com/usage/reference/getallusagereportrequestsstatus.md): The Async API retrieves the status of all usage report requests. The response contains the status of the usage report and the download URL. * Sort API response records based on the created date in ascending or descending order, as the sort parameter in the API request. * The API supports usage by app ID. - [Retrieve usage by organization](https://docs.here.com/usage/reference/getusagebyrealm.md): This API retrieves the billable usage for your organization (realm). The realm ID is your organization ID. * Sort API response records alphabetically in ascending order by subscription ID, category, and charge item (name in the response), respectively. * The API supports usage by app ID. - [Retrieve usage CSV by organization](https://docs.here.com/usage/reference/getusagecsvbyrealm.md): This API retrieves the billable usage for your organization in CSV format. * Sort API response records alphabetically in ascending order by subscription ID, category, and the charge item (name in the response) respectively. * The API supports usage by app ID. - [Retrieve status for a usage report request by ID](https://docs.here.com/usage/reference/getusagereportrequeststatus.md): This API retrieves the status of a usage report request. The report creation Async API starts the report generation request and status, retrieving through this API. In the response of this API , You can identify the status of the usage report creation process and can download it when it has completed. The response contains the usage report download URL. * API response has a single record having the status of the report request. * The API supports usage by app ID. # what3words Documentation ## Guides - [How to use AutoSuggest](https://docs.here.com/what3words/docs/autosuggest.md) - [How to see available languages](https://docs.here.com/what3words/docs/available-languages.md) - [How to convert coordinates to a what3words address](https://docs.here.com/what3words/docs/convert-3-word-address.md) - [How to convert a what3words address to coordinates](https://docs.here.com/what3words/docs/convert-coordinates.md) - [How to handle errors in What 3 Words](https://docs.here.com/what3words/docs/error-handling.md) - [How to request a grid section with what3words](https://docs.here.com/what3words/docs/grid-section.md) - [Get started](https://docs.here.com/what3words/docs/get-started.md) - [How to search both standard and 3 word addresses](https://docs.here.com/what3words/docs/tutorial.md) - [Introduction to HERE what3words](https://docs.here.com/what3words/docs/what3words-intro.md) ## API Reference - [Suggest a list of valid 3 word addresses.](https://docs.here.com/what3words/reference/autosuggest-1.md): AutoSuggest can take a slightly incorrect 3 word address and suggest a list of valid 3 word addresses. It has powerful features that can, for example, optionally limit results to a country or area, and prioritise results that are near the user. It provides corrections for the following types of input error: * Typing errors * Spelling errors * Misremembered words (e.g. singular vs. plural) * Words in the wrong order - [Retrieves a list all available 3 word address languages.](https://docs.here.com/what3words/reference/available-languages-1.md): Retrieves a list all available 3 word address languages, including the ISO 3166-1 alpha-2 2 letter code, english name and native name.. - [Convert a latitude and longitude to a 3 word address.](https://docs.here.com/what3words/reference/convertto3wa.md): Convert a latitude and longitude to a 3 word address. It also returns country, the bounds of the grid square, a nearby place (such as a local town) and a link to W3W map site. - [Convert a latitude and longitude to a 3 word address.](https://docs.here.com/what3words/reference/converttocoordinates.md): Converts a 3 word address to a latitude and longitude. It also returns country, the bounds of the grid square, a nearest place (such as a local town) and a link to W3W map site. - [Returns a section of the 3m x 3m what3words grid for a bounding box.](https://docs.here.com/what3words/reference/gridsection.md): Returns a section of the 3m x 3m what3words grid for a bounding box. The bounding box is specified by lat,lng,lat,lng as south,west,north,east. You can request the grid in GeoJSON format, making it very simple to display on a map.. # Workspace Documentation ## Guides - [Introduction to OLP CLI command syntax](https://docs.here.com/workspace/docs/olp-cli-topics-command-syntax.md) - [Set up your credentials for OLP CLI](https://docs.here.com/workspace/docs/olp-cli-topics-configuration.md) - [Install the OLP CLI](https://docs.here.com/workspace/docs/olp-cli-topics-get-started.md) - [Configure OLP CLI HTTP proxy](https://docs.here.com/workspace/docs/olp-cli-topics-http-proxy-configuration.md) - [api](https://docs.here.com/workspace/docs/olp-cli-topics-api-commands.md) - [app](https://docs.here.com/workspace/docs/olp-cli-topics-app-app-commands.md) - [app domain](https://docs.here.com/workspace/docs/olp-cli-topics-app-app-domain-commands.md) - [app manager](https://docs.here.com/workspace/docs/olp-cli-topics-app-app-manager-commands.md) - [app scope](https://docs.here.com/workspace/docs/olp-cli-topics-app-app-scope-commands.md) - [app key access](https://docs.here.com/workspace/docs/olp-cli-topics-app-key-key-access-commands.md) - [app key api](https://docs.here.com/workspace/docs/olp-cli-topics-app-key-key-api-commands.md) - [credentials](https://docs.here.com/workspace/docs/olp-cli-topics-credentials-commands.md) - [catalog](https://docs.here.com/workspace/docs/olp-cli-topics-data-catalog-commands.md) - [catalog layer feature](https://docs.here.com/workspace/docs/olp-cli-topics-data-feature-commands.md) - [catalog layer](https://docs.here.com/workspace/docs/olp-cli-topics-data-layer-commands.md) - [catalog layer notification](https://docs.here.com/workspace/docs/olp-cli-topics-data-notification-commands.md) - [catalog layer object](https://docs.here.com/workspace/docs/olp-cli-topics-data-object-commands.md) - [catalog layer partition](https://docs.here.com/workspace/docs/olp-cli-topics-data-partition-commands.md) - [schema](https://docs.here.com/workspace/docs/olp-cli-topics-data-schema-commands.md) - [catalog layer stream](https://docs.here.com/workspace/docs/olp-cli-topics-data-stream-commands.md) - [catalog layer subscription](https://docs.here.com/workspace/docs/olp-cli-topics-data-subscription-commands.md) - [catalog subset](https://docs.here.com/workspace/docs/olp-cli-topics-data-subset-commands.md) - [device](https://docs.here.com/workspace/docs/olp-cli-topics-device-device-commands.md) - [group admin](https://docs.here.com/workspace/docs/olp-cli-topics-group-group-admin-commands.md) - [group](https://docs.here.com/workspace/docs/olp-cli-topics-group-group-commands.md) - [group member](https://docs.here.com/workspace/docs/olp-cli-topics-group-group-member-commands.md) - [identity provider](https://docs.here.com/workspace/docs/olp-cli-topics-idp-idp-commands.md) - [identity provider metadata](https://docs.here.com/workspace/docs/olp-cli-topics-idp-metadata-idp-metadata-commands.md) - [identity provider template](https://docs.here.com/workspace/docs/olp-cli-topics-idp-template-idp-template-commands.md) - [local catalog copy](https://docs.here.com/workspace/docs/olp-cli-topics-local-data-copy-commands.md) - [local catalog](https://docs.here.com/workspace/docs/olp-cli-topics-local-data-local-catalog-commands.md) - [local](https://docs.here.com/workspace/docs/olp-cli-topics-local-data-local-commands.md) - [local catalog layer](https://docs.here.com/workspace/docs/olp-cli-topics-local-data-local-layer-commands.md) - [local catalog layer partition](https://docs.here.com/workspace/docs/olp-cli-topics-local-data-local-partition-commands.md) - [local catalog layer stream](https://docs.here.com/workspace/docs/olp-cli-topics-local-data-local-stream-commands.md) - [org](https://docs.here.com/workspace/docs/olp-cli-topics-org-commands.md) - [org trust](https://docs.here.com/workspace/docs/olp-cli-topics-org-trust-commands.md) - [permission access](https://docs.here.com/workspace/docs/olp-cli-topics-permission-access-commands.md) - [permission access filter](https://docs.here.com/workspace/docs/olp-cli-topics-permission-access-filter-commands.md) - [permission](https://docs.here.com/workspace/docs/olp-cli-topics-permission-commands.md) - [pipeline environment](https://docs.here.com/workspace/docs/olp-cli-topics-pipeline-environment-commands.md) - [pipeline egress rule](https://docs.here.com/workspace/docs/olp-cli-topics-pipeline-ergess-rule-commands.md) - [pipeline version job](https://docs.here.com/workspace/docs/olp-cli-topics-pipeline-job-commands.md) - [pipeline version operation](https://docs.here.com/workspace/docs/olp-cli-topics-pipeline-operation-commands.md) - [pipeline](https://docs.here.com/workspace/docs/olp-cli-topics-pipeline-pipeline-commands.md) - [pipeline profile](https://docs.here.com/workspace/docs/olp-cli-topics-pipeline-profile-commands.md) - [pipeline snapshot](https://docs.here.com/workspace/docs/olp-cli-topics-pipeline-snapshot-commands.md) - [pipeline template](https://docs.here.com/workspace/docs/olp-cli-topics-pipeline-template-commands.md) - [pipeline version](https://docs.here.com/workspace/docs/olp-cli-topics-pipeline-version-commands.md) - [project access](https://docs.here.com/workspace/docs/olp-cli-topics-project-project-access-commands.md) - [project admin](https://docs.here.com/workspace/docs/olp-cli-topics-project-project-admin-commands.md) - [project](https://docs.here.com/workspace/docs/olp-cli-topics-project-project-commands.md) - [project resource](https://docs.here.com/workspace/docs/olp-cli-topics-project-project-link-commands.md) - [project policy](https://docs.here.com/workspace/docs/olp-cli-topics-project-project-policy-commands.md) - [project resource availability](https://docs.here.com/workspace/docs/olp-cli-topics-project-project-resource-availability-commands.md) - [proxy](https://docs.here.com/workspace/docs/olp-cli-topics-proxy-commands.md) - [ratelimit endpoint](https://docs.here.com/workspace/docs/olp-cli-topics-ratelimit-endpoint-ratelimit-endpoint-commands.md) - [ratelimit](https://docs.here.com/workspace/docs/olp-cli-topics-ratelimit-rule-ratelimit-identity-commands.md) - [resource project](https://docs.here.com/workspace/docs/olp-cli-topics-resource-project-relation-commands.md) - [resource action](https://docs.here.com/workspace/docs/olp-cli-topics-resource-resource-action-commands.md) - [resource link availability](https://docs.here.com/workspace/docs/olp-cli-topics-resource-resource-link-availability-commands.md) - [resource type](https://docs.here.com/workspace/docs/olp-cli-topics-resource-resource-type-commands.md) - [role assignment entity](https://docs.here.com/workspace/docs/olp-cli-topics-role-assignment-entity-role-assignment-entity-commands.md) - [role assignment](https://docs.here.com/workspace/docs/olp-cli-topics-role-assignment-role-assignment-commands.md) - [role](https://docs.here.com/workspace/docs/olp-cli-topics-role-role-commands.md) - [service](https://docs.here.com/workspace/docs/olp-cli-topics-service-service-commands.md) - [secret](https://docs.here.com/workspace/docs/olp-cli-topics-third-party-secrets-commands.md) - [version](https://docs.here.com/workspace/docs/olp-cli-topics-version-commands.md) - [Introduction to Open location Command Line Interface](https://docs.here.com/workspace/docs/olp-cli-readme.md) - [OLP CLI logging](https://docs.here.com/workspace/docs/olp-cli-topics-logging.md) - [OLP CLI scripting tips](https://docs.here.com/workspace/docs/olp-cli-topics-scripting-tips.md) - [API workflows](https://docs.here.com/workspace/docs/olp-cli-topics-api-workflows.md) - [App workflows](https://docs.here.com/workspace/docs/olp-cli-topics-app-workflows.md) - [Data workflows](https://docs.here.com/workspace/docs/olp-cli-topics-data-workflows.md) - [Group workflows](https://docs.here.com/workspace/docs/olp-cli-topics-group-workflows.md) - [Identity provider workflows](https://docs.here.com/workspace/docs/olp-cli-topics-idp-workflows.md) - [Local data workflows](https://docs.here.com/workspace/docs/olp-cli-topics-local-data-workflows.md) - [Pipeline workflows](https://docs.here.com/workspace/docs/olp-cli-topics-pipeline-workflows.md) - [Project workflows](https://docs.here.com/workspace/docs/olp-cli-topics-projects-workflows.md) - [Schema workflows](https://docs.here.com/workspace/docs/olp-cli-topics-schema-workflows.md) - [Archive stream data using HERE Workspace](https://docs.here.com/workspace/docs/dal-topics-indexing-data.md) - [Run the Data Archiving Library example](https://docs.here.com/workspace/docs/dal-topics-run-example.md) - [Get started with the Data Archiving Library](https://docs.here.com/workspace/docs/dal-readme.md) - [Data Archiving Library FAQ](https://docs.here.com/workspace/docs/dal-topics-troubleshooting.md) - [How to configure your application](https://docs.here.com/workspace/docs/dal-topics-configuration.md) - [How to configure error handling](https://docs.here.com/workspace/docs/dal-topics-error-handling.md) - [How to use Data Archiving Library metrics](https://docs.here.com/workspace/docs/dal-topics-flink-metrics.md) - [How to implement user defined functions](https://docs.here.com/workspace/docs/dal-topics-implement-user-defined-functions.md) - [How to run an archiving application locally](https://docs.here.com/workspace/docs/dal-topics-run-a-flink-job-locally.md) - [How to use validation rules for indexing attributes](https://docs.here.com/workspace/docs/dal-topics-validate-indexing-attributes.md) - [Build fat JARs including the Data Client Base Library](https://docs.here.com/workspace/docs/dcbl-client-building-fatjars.md) - [Data Client Base Library logging](https://docs.here.com/workspace/docs/dcbl-client-logging.md) - [BlobApi](https://docs.here.com/workspace/docs/dcbl-client-api-data-blob-v1.md) - [ByKeyApi](https://docs.here.com/workspace/docs/dcbl-client-api-data-blob-v2.md) - [Config APIs](https://docs.here.com/workspace/docs/dcbl-client-api-data-config-v1.md) - [IndexApi](https://docs.here.com/workspace/docs/dcbl-client-api-data-index-v1.md) - [Ingest APIs](https://docs.here.com/workspace/docs/dcbl-client-api-data-ingest-v1.md) - [Interactive Map APIs](https://docs.here.com/workspace/docs/dcbl-client-api-data-interactive-map-v1.md) - [MetadataApi](https://docs.here.com/workspace/docs/dcbl-client-api-data-metadata-v1.md) - [NotificationApi](https://docs.here.com/workspace/docs/dcbl-client-api-data-notification-v2.md) - [PublishApi](https://docs.here.com/workspace/docs/dcbl-client-api-data-publish-v2.md) - [QueryApi](https://docs.here.com/workspace/docs/dcbl-client-api-data-query-v1.md) - [StreamApi](https://docs.here.com/workspace/docs/dcbl-client-api-data-stream-v2.md) - [VolatileBlobApi](https://docs.here.com/workspace/docs/dcbl-client-api-data-volatile-blob-v1.md) - [Data Client Base Library data APIs](https://docs.here.com/workspace/docs/dcbl-client-data-apis.md) - [GeocodeApi](https://docs.here.com/workspace/docs/dcbl-client-api-ols-geocode-search-v7.md) - [PublicTransitApi](https://docs.here.com/workspace/docs/dcbl-client-api-ols-public-transit-v8.md) - [RevGeocodeApi](https://docs.here.com/workspace/docs/dcbl-client-api-ols-revgeocode-search-v1.md) - [RoutingApi](https://docs.here.com/workspace/docs/dcbl-client-api-ols-routing-v8.md) - [RealTimeTrafficAPI](https://docs.here.com/workspace/docs/dcbl-client-api-ols-traffic-v7.md) - [WeatherApi](https://docs.here.com/workspace/docs/dcbl-client-api-ols-weather-v3.md) - [Supported Data Client Base Library Open Location Services APIs](https://docs.here.com/workspace/docs/dcbl-client-ols-apis.md) - [ArtifactApi](https://docs.here.com/workspace/docs/dcbl-client-api-data-artifact-v1.md) - [ReferencesApi](https://docs.here.com/workspace/docs/dcbl-client-api-data-references-v1.md) - [SchemaApi](https://docs.here.com/workspace/docs/dcbl-client-api-data-schema-v1.md) - [Supported Data Client Base Library schema APIs](https://docs.here.com/workspace/docs/dcbl-client-schema-apis.md) - [Data Client Base Library security and privacy note](https://docs.here.com/workspace/docs/dcbl-client-security-privacy.md) - [Execution context](https://docs.here.com/workspace/docs/dcbl-client-context.md) - [Json Serialization/Deserialization Implicits](https://docs.here.com/workspace/docs/dcbl-client-json-support.md) - [Data Client Base Library metrics and counters](https://docs.here.com/workspace/docs/dcbl-client-metrics.md) - [Set Up a proxy](https://docs.here.com/workspace/docs/dcbl-client-proxy-setup.md) - [Data Client Base Library settings](https://docs.here.com/workspace/docs/dcbl-client-settings.md) - [Data Client Base Library request configuration](https://docs.here.com/workspace/docs/dcbl-client-with-config.md) - [Data Client Base Library Base Client](https://docs.here.com/workspace/docs/dcbl-client-base-client.md) - [Create an application using the Data Client Base Library](https://docs.here.com/workspace/docs/dcbl-client-create-an-application.md) - [Get your credentials](https://docs.here.com/workspace/docs/dcbl-client-credentials.md) - [Data Client Base Library versioning scheme](https://docs.here.com/workspace/docs/dcbl-client-versioning-scheme.md) - [Why use the Data Client Base Library](https://docs.here.com/workspace/docs/dcbl-client-why-use.md) - [Get Started with the Data Client Base Library](https://docs.here.com/workspace/docs/dcbl-readme.md) - [How to build a JAR File including the Data Client Library](https://docs.here.com/workspace/docs/dcl-client-building-fatjars.md) - [Data Client Library logging](https://docs.here.com/workspace/docs/dcl-client-logging.md) - [Flink 2.2.x migration guide](https://docs.here.com/workspace/docs/dcl-client-flink-connector-migration-guide-2.md) - [Flink 1.19.x migration guide](https://docs.here.com/workspace/docs/dcl-client-flink-connector-migration-guide.md) - [Flink connector](https://docs.here.com/workspace/docs/dcl-client-flink-connector-overview.md) - [Flink support](https://docs.here.com/workspace/docs/dcl-client-flink-support-overview.md) - [Stream processing](https://docs.here.com/workspace/docs/dcl-client-flink-support-vs-connector.md) - [Hadoop FileSystem support](https://docs.here.com/workspace/docs/dcl-client-hadoop-fs-support.md) - [Spark connector](https://docs.here.com/workspace/docs/dcl-client-spark-support-overview.md) - [Batch Processing](https://docs.here.com/workspace/docs/dcl-client-spark-support-vs-connector.md) - [Spark support](https://docs.here.com/workspace/docs/spark-support.md) - [HERE platform data processing pipelines](https://docs.here.com/workspace/docs/dcl-client-data-processing-pipelines.md) - [Data Client Library configuration](https://docs.here.com/workspace/docs/dcl-client-configuration.md) - [Create a HERE Platform data application](https://docs.here.com/workspace/docs/dcl-client-create-an-application.md) - [Get your credentials](https://docs.here.com/workspace/docs/dcl-client-credentials.md) - [Set up Proxy servers to the HERE platform](https://docs.here.com/workspace/docs/dcl-client-proxy-setup.md) - [RSQL](https://docs.here.com/workspace/docs/dcl-client-rsql.md) - [Data Client Library versioning scheme](https://docs.here.com/workspace/docs/dcl-client-versioning-scheme.md) - [Why Use the Data Client Library](https://docs.here.com/workspace/docs/dcl-client-why-use.md) - [Get started with the Data Client Library](https://docs.here.com/workspace/docs/dcl-readme.md) - [How to check data integrity](https://docs.here.com/workspace/docs/dcl-client-data-integrity.md) - [How to select a streaming connector - Kafka or HTTP](https://docs.here.com/workspace/docs/dcl-client-direct-kafka.md) - [How to get data from catalogs](https://docs.here.com/workspace/docs/dcl-client-get-data.md) - [How to use Kafka Metrics for connectivity status](https://docs.here.com/workspace/docs/dcl-client-kafka-connectivity.md) - [How to publish data](https://docs.here.com/workspace/docs/dcl-client-publish-data.md) - [How to get metadata about catalogs, layers, and partitions](https://docs.here.com/workspace/docs/dcl-client-get-metadata.md) - [How to set minimum version](https://docs.here.com/workspace/docs/dcl-client-set-minimum-version.md) - [Catalog notification](https://docs.here.com/workspace/docs/dcl-client-catalog-notification.md) - [How to create catalogs](https://docs.here.com/workspace/docs/dcl-client-create-catalogs.md) - [How to delete a catalog](https://docs.here.com/workspace/docs/dcl-client-delete-a-catalog.md) - [How to delete a layer](https://docs.here.com/workspace/docs/dcl-client-delete-a-layer.md) - [How to remove an automatic version deletion](https://docs.here.com/workspace/docs/dcl-client-remove-an-automatic-version-deletion.md) - [How to subscribe to interactive map layer changes](https://docs.here.com/workspace/docs/dcl-client-subscriptions.md) - [Area scheme and subsets](https://docs.here.com/workspace/docs/dcl-client-subsets.md) - [How to update layers](https://docs.here.com/workspace/docs/dcl-client-update-layer.md) - [How to work with GeoJSON data](https://docs.here.com/workspace/docs/dcl-client-working-with-geojson-data.md) - [Data Inspector best practices for developers](https://docs.here.com/workspace/docs/best-practices-1.md) - [Data Inspector base map](https://docs.here.com/workspace/docs/concepts-basemap.md) - [Data organization](https://docs.here.com/workspace/docs/concepts-data-organization.md) - [Preconditions for visualization](https://docs.here.com/workspace/docs/concepts-formats.md) - [Data sources](https://docs.here.com/workspace/docs/concepts-sources.md) - [Data Inspector themes](https://docs.here.com/workspace/docs/concepts-themes.md) - [Library modules overview](https://docs.here.com/workspace/docs/overview.md) - [External dependencies for Data Inspector Library components](https://docs.here.com/workspace/docs/packages.md) - [Get started with Data Inspector Library](https://docs.here.com/workspace/docs/get-started.md) - [How to distribute web apps](https://docs.here.com/workspace/docs/distribution.md) - [How to use a token from the server token provider](https://docs.here.com/workspace/docs/example-token-provider.md) - [How to run example apps](https://docs.here.com/workspace/docs/examples-explained.md) - [How to visualize 3D data](https://docs.here.com/workspace/docs/howto-3d-data.md) - [How to analyze data coverage](https://docs.here.com/workspace/docs/howto-analyze-data-coverage.md) - [How to inspect multiple layers](https://docs.here.com/workspace/docs/howto-inspect-multiple-layers.md) - [How to use map zoom controls](https://docs.here.com/workspace/docs/howto-map-zoom-controls.md) - [How to inspect interactive map layers](https://docs.here.com/workspace/docs/howto-view-iml.md) - [How to inspect object store layers](https://docs.here.com/workspace/docs/howto-view-objectstore.md) - [Map Configuration](https://docs.here.com/workspace/docs/map-tile-configuration.md) - [How to view a partitions list](https://docs.here.com/workspace/docs/howto-view-partitions.md) - [Coverage data](https://docs.here.com/workspace/docs/howto-coverage-data.md) - [Custom data](https://docs.here.com/workspace/docs/howto-custom-data.md) - [GeoJSON data](https://docs.here.com/workspace/docs/howto-geojson-data.md) - [HERE Map Content data](https://docs.here.com/workspace/docs/howto-map-content-data.md) - [SDII data](https://docs.here.com/workspace/docs/howto-sdii-data.md) - [HERE Real-Time Traffic data](https://docs.here.com/workspace/docs/howto-traffic-data.md) - [How to visualize data](https://docs.here.com/workspace/docs/howto-visualize-data.md) - [How to create rendering plugins](https://docs.here.com/workspace/docs/rendering-plugins.md) - [Plugin examples](https://docs.here.com/workspace/docs/plugin-examples.md) - [Best practices for rendering plugin creation](https://docs.here.com/workspace/docs/rendering-plugins-best-practices.md) - [Rendering functions](https://docs.here.com/workspace/docs/rendering-plugins-functions.md) - [Data Inspector development environment](https://docs.here.com/workspace/docs/rendering-plugins-online-editor.md) - [How to style GeoJSON visualization](https://docs.here.com/workspace/docs/style-geojson-visualization.md) - [How to inspect data with Leaflet](https://docs.here.com/workspace/docs/visualize-with-leaflet.md) - [Data Inspector entry points](https://docs.here.com/workspace/docs/entry-points.md) - [Introduction to Data Inspector Library](https://docs.here.com/workspace/docs/readme-30.md) - [How to embed Data Inspector into HTML](https://docs.here.com/workspace/docs/embed-js-bundle-in-html.md) - [How to install the Data Inspector Library](https://docs.here.com/workspace/docs/install.md) - [How to install example applications](https://docs.here.com/workspace/docs/install-examples.md) - [How to install Web App Generator for GeoJSON Files](https://docs.here.com/workspace/docs/install-generator.md) - [How to create a basic app](https://docs.here.com/workspace/docs/quickstart.md) - [How to generate base code](https://docs.here.com/workspace/docs/scaffolding.md) - [How to add tooltips and styles](https://docs.here.com/workspace/docs/tooltips.md) - [How to update a GeoJSON data source](https://docs.here.com/workspace/docs/update.md) - [Open-source software notices](https://docs.here.com/workspace/docs/dpl-legal-oss-notice.md) - [Get your credentials](https://docs.here.com/workspace/docs/dpl-topics-credentials.md) - [Data Processing Library Java bindings](https://docs.here.com/workspace/docs/dpl-topics-java-bindings.md) - [Data Processing Library modules](https://docs.here.com/workspace/docs/dpl-topics-modules.md) - [Pipelines and the Data Processing Library](https://docs.here.com/workspace/docs/dpl-topics-pipelines.md) - [How to build a batch pipeline with Maven archetypes (Java)](https://docs.here.com/workspace/docs/dpl-topics-quickstart-java.md) - [How to build a batch pipeline with Maven archetypes (Scala)](https://docs.here.com/workspace/docs/dpl-topics-quickstart-scala.md) - [Why use the Data Processing Library](https://docs.here.com/workspace/docs/dpl-topics-why-use.md) - [Get started with Data Processing Library](https://docs.here.com/workspace/docs/dpl-readme.md) - [Adaptive leveling](https://docs.here.com/workspace/docs/dpl-topics-adaptive-leveling.md) - [Architecture for batch pipelines](https://docs.here.com/workspace/docs/dpl-topics-architecture.md) - [Broadcast input layers to executor nodes](https://docs.here.com/workspace/docs/dpl-topics-broadcast-input-layers-to-nodes.md) - [How to configure the Data Processing Library components](https://docs.here.com/workspace/docs/dpl-topics-configuration.md) - [Data Processing Library logging](https://docs.here.com/workspace/docs/dpl-topics-context-logging.md) - [How to perform incremental data validation](https://docs.here.com/workspace/docs/dpl-topics-data-validation.md) - [How to compose an incremental processing pipeline with DeltaSets](https://docs.here.com/workspace/docs/dpl-topics-deltasets.md) - [How to filter input partitions](https://docs.here.com/workspace/docs/dpl-topics-filter-input-partitions.md) - [Data Processing Library incremental compilation](https://docs.here.com/workspace/docs/dpl-topics-incremental-compilation.md) - [Processing multiple versions of the same catalog](https://docs.here.com/workspace/docs/dpl-topics-multiple-versions.md) - [Partitioners and Spark additions](https://docs.here.com/workspace/docs/dpl-topics-partitioners-spark-additions.md) - [Chaining patterns together](https://docs.here.com/workspace/docs/dpl-topics-chaining-patterns-together.md) - [Functional patterns](https://docs.here.com/workspace/docs/dpl-topics-functional-patterns.md) - [Spark RDD-based patterns](https://docs.here.com/workspace/docs/dpl-topics-rdd-based-patterns.md) - [Data Processing Library compilation patterns](https://docs.here.com/workspace/docs/dpl-topics-patterns.md) - [Payloads](https://docs.here.com/workspace/docs/dpl-topics-payloads.md) - [Stateful data processing](https://docs.here.com/workspace/docs/dpl-topics-stateful-processing.md) - [Data Processing Library concepts](https://docs.here.com/workspace/docs/dpl-topics-concepts.md) - [Interface with the Data API via Spark](https://docs.here.com/workspace/docs/dpl-topics-data-api.md) - [Implementation guidelines for compilers](https://docs.here.com/workspace/docs/dpl-topics-implementation-guidelines.md) - [Packaging for deployment](https://docs.here.com/workspace/docs/dpl-topics-packaging.md) - [Performance tuning](https://docs.here.com/workspace/docs/dpl-topics-performance-tuning.md) - [Data Processing Library troubleshooting](https://docs.here.com/workspace/docs/dpl-topics-troubleshooting.md) - [Introduction to HERE Workspace for Java and Scala developers](https://docs.here.com/workspace/docs/tutorials-readme.md) - [HERE Workspace example use cases](https://docs.here.com/workspace/docs/tutorials-topics-example-use-cases.md) - [HERE Data SDK for Java & Scala](https://docs.here.com/workspace/docs/tutorials-topics-olp-sdk-java-scala.md) - [Other tools and resources useful for Java and Scala developers](https://docs.here.com/workspace/docs/tutorials-topics-other-tools-resources.md) - [How to Use the HERE Data SDK for Java & Scala](https://docs.here.com/workspace/docs/tutorials-topics-how-to-use-sdk.md) - [Pipeline environments](https://docs.here.com/workspace/docs/tutorials-pipeline-environments.md) - [SDK dependencies](https://docs.here.com/workspace/docs/tutorials-sdk-dependencies.md) - [SDK libraries](https://docs.here.com/workspace/docs/tutorials-sdk-libraries.md) - [SDK releases](https://docs.here.com/workspace/docs/tutorials-sdk-releases.md) - [How to configure your environment](https://docs.here.com/workspace/docs/tutorials-topics-configure-your-environment.md) - [How to include the SDK in your project](https://docs.here.com/workspace/docs/tutorials-topics-dependency-management.md) - [How to get your credentials](https://docs.here.com/workspace/docs/tutorials-topics-get-credentials.md) - [SDK migration guides](https://docs.here.com/workspace/docs/tutorials-topics-migration-guides.md) - [HERE data SDK for Java & Scala workflows](https://docs.here.com/workspace/docs/tutorials-topics-sdk-workflows.md) - [Archive stream data](https://docs.here.com/workspace/docs/tutorials-topics-archiving-pipeline.md) - [Batch pipeline](https://docs.here.com/workspace/docs/tutorials-topics-batch-pipeline.md) - [Schema](https://docs.here.com/workspace/docs/tutorials-topics-schema.md) - [Streaming pipeline](https://docs.here.com/workspace/docs/tutorials-topics-streaming-pipeline.md) - [Which tool to use in HERE Workspace?](https://docs.here.com/workspace/docs/tutorials-topics-which-tool-to-use.md) - [HERE Workspace for Java and Scala developers tutorials](https://docs.here.com/workspace/docs/tutorials-tutorials.md) - [How to path match the sensor data to GeoJSON in Spark](https://docs.here.com/workspace/docs/tutorials-batch-path-matching-readme.md) - [How to bring your data into HERE platform using an object store layer](https://docs.here.com/workspace/docs/tutorials-bring-your-data-readme.md) - [How to subscribe to catalog and layer-level changes](https://docs.here.com/workspace/docs/tutorials-catalog-notification-readme.md) - [How to copy a catalog using the Data Processing Library](https://docs.here.com/workspace/docs/tutorials-copy-geojson-readme.md) - [How to use Spark connector to migrate CSV data to protobuf](https://docs.here.com/workspace/docs/tutorials-csv-to-protobuf-readme.md) - [How to develop a Flink application](https://docs.here.com/workspace/docs/tutorials-develop-flink-application-readme.md) - [How to develop a Spark application](https://docs.here.com/workspace/docs/tutorials-develop-spark-application-readme.md) - [How to use Flink connector to read and write data](https://docs.here.com/workspace/docs/tutorials-flink-connector-readme.md) - [How to implement GeoJSON Renderer](https://docs.here.com/workspace/docs/tutorials-geojson-render-readme.md) - [How to read and write to Object store layer using Hadoop FS support in Spark](https://docs.here.com/workspace/docs/tutorials-hadoop-fs-support-spark-pipeline-readme.md) - [How to calculate partition tile IDs](https://docs.here.com/workspace/docs/tutorials-here-tile-resolver-readme.md) - [How to read and write to interactive map layers using the OLP CLI](https://docs.here.com/workspace/docs/tutorials-interactive-map-layer-readme.md) - [How to publish JSON schema to the platform](https://docs.here.com/workspace/docs/tutorials-json-schema-readme.md) - [How to develop locally and test with CLI and the Data Client Library](https://docs.here.com/workspace/docs/tutorials-local-development-workflow-readme.md) - [How to organize your work in projects](https://docs.here.com/workspace/docs/tutorials-organize-work-in-projects-readme.md) - [How to read from a catalog in a batch application](https://docs.here.com/workspace/docs/tutorials-plain-spark-pipeline-readme.md) - [How to publish protobuf schema to the platform](https://docs.here.com/workspace/docs/tutorials-proto-schema-readme.md) - [How to use HERE platform service](https://docs.here.com/workspace/docs/tutorials-real-time-traffic-tutorial-readme.md) - [How to correlate road attributes to segment geometry](https://docs.here.com/workspace/docs/tutorials-road-attr-walkthru-readme.md) - [How to run a Flink application on the platform](https://docs.here.com/workspace/docs/tutorials-run-flink-application-platform-readme.md) - [How to run a Spark application on the platform](https://docs.here.com/workspace/docs/tutorials-run-spark-application-platform-readme.md) - [How to use Spark connector to read and write data](https://docs.here.com/workspace/docs/tutorials-spark-connector-readme.md) - [How to verify your credentials and access a catalog](https://docs.here.com/workspace/docs/tutorials-verify-credentials-readme.md) - [How to verify Maven settings](https://docs.here.com/workspace/docs/tutorials-verify-m2-readme.md) - [Compact index layer](https://docs.here.com/workspace/docs/icl-topics-compact-index-layer.md) - [Index Compaction Library configuration](https://docs.here.com/workspace/docs/icl-topics-configuration.md) - [Get started with the Index Compaction Library](https://docs.here.com/workspace/docs/icl-readme.md) - [Index Compaction Library FAQ](https://docs.here.com/workspace/docs/icl-topics-troubleshooting.md) - [Location Library advanced modules usage (Scala only)](https://docs.here.com/workspace/docs/ll-docs-advanced-modules.md) - [How to use the batch processing module](https://docs.here.com/workspace/docs/ll-docs-batch-processing.md) - [How to use core, path matching customizations](https://docs.here.com/workspace/docs/ll-docs-core-path-matching.md) - [How to use in-memory tiles](https://docs.here.com/workspace/docs/ll-docs-inmemory.md) - [Location Library location referencing](https://docs.here.com/workspace/docs/ll-docs-location-referencing.md) - [How to work with TMC references](https://docs.here.com/workspace/docs/ll-docs-location-referencing-tmc.md) - [How to use the TPEG2 module](https://docs.here.com/workspace/docs/ll-docs-location-referencing-tpeg2.md) - [How to use the Optimized Map integration module](https://docs.here.com/workspace/docs/ll-docs-optimized-map.md) - [Location Library core module](https://docs.here.com/workspace/docs/ll-docs-core.md) - [Get started with Location Library](https://docs.here.com/workspace/docs/ll-docs-get-started.md) - [Location Library GeoJSON serialization](https://docs.here.com/workspace/docs/ll-docs-high-level-io.md) - [Location Library high-level API](https://docs.here.com/workspace/docs/ll-docs-high-level-v2.md) - [How to migrate to topology attributes](https://docs.here.com/workspace/docs/ll-docs-migration-to-topology-attributes.md) - [Read data from versioned catalogs other than Location Library](https://docs.here.com/workspace/docs/ll-docs-read-other-catalogs.md) - [Introduction to Location Library](https://docs.here.com/workspace/docs/ll-readme.md) - [How to use geospatial components](https://docs.here.com/workspace/docs/ll-docs-concept-geospatial-components.md) - [How to use graph properties](https://docs.here.com/workspace/docs/ll-docs-concept-graph-properties.md) - [How to use implicits (Scala only)](https://docs.here.com/workspace/docs/ll-docs-concept-implicits.md) - [How to use map matching components](https://docs.here.com/workspace/docs/ll-docs-concept-map-matching-components.md) - [How to use the routing graph](https://docs.here.com/workspace/docs/ll-docs-concept-routing-graph.md) - [How to monitor metrics with Grafana](https://docs.here.com/workspace/docs/monitor-metrics.md) - [Current Usage Metrics dashboard](https://docs.here.com/workspace/docs/current-usage-metrics.md) - [Data, Catalog, and Layer Metrics dashboard](https://docs.here.com/workspace/docs/data-catalog-layer-metrics.md) - [Ingestion Metrics dashboard](https://docs.here.com/workspace/docs/ingestion-metrics.md) - [Custom pipeline metrics](https://docs.here.com/workspace/docs/custom-metrics.md) - [Stream pipeline (Flink) Metrics](https://docs.here.com/workspace/docs/flink-metrics-monitor-pipelines.md) - [Flink Dashboard for stream pipelines](https://docs.here.com/workspace/docs/flink-ui.md) - [HERE platform Pipeline Status](https://docs.here.com/workspace/docs/pipeline-metrics.md) - [How to search application logs via Splunk](https://docs.here.com/workspace/docs/search-application-logs.md) - [Batch pipeline (Spark) Metrics](https://docs.here.com/workspace/docs/spark-metrics.md) - [Spark UI for batch pipelines](https://docs.here.com/workspace/docs/spark-ui.md) - [How to copy a Grafana Dashbaord from one Region to another](https://docs.here.com/workspace/docs/copy-dashboard.md) - [How to create and manage Grafana alerts](https://docs.here.com/workspace/docs/create-manage-alerts.md) - [How to duplicate a Grafana dashboard](https://docs.here.com/workspace/docs/duplicate-dashboard.md) - [Standard Grafana dashboards](https://docs.here.com/workspace/docs/standard-dashboards.md) - [Introduction to Logs, Monitoring, and Alerts](https://docs.here.com/workspace/docs/readme-summary-6.md) - [How to deploy a pipeline](https://docs.here.com/workspace/docs/deployment.md) - [How to deploy a pipeline via the web portal](https://docs.here.com/workspace/docs/portal-deployment.md) - [Configurations available for pipeline developers](https://docs.here.com/workspace/docs/configurations-for-pipeline-developers.md) - [How to develop pipelines](https://docs.here.com/workspace/docs/develop-pipelines.md) - [Get started with the Pipelines API](https://docs.here.com/workspace/docs/getting-started.md) - [Introduction to the Pipelines API](https://docs.here.com/workspace/docs/introduction.md) - [How to manage pipelines](https://docs.here.com/workspace/docs/managing-pipelines.md) - [Pipelines API pipeline components](https://docs.here.com/workspace/docs/pipeline-components.md) - [Pipelines API pipeline lifecycle](https://docs.here.com/workspace/docs/pipeline-lifecycle.md) - [Pipelines API pipeline patterns](https://docs.here.com/workspace/docs/pipeline-patterns.md) - [Pipelines API pipeline states](https://docs.here.com/workspace/docs/pipeline-states.md) - [Batch processing best practices](https://docs.here.com/workspace/docs/batch-processing.md) - [Best practices for high availability](https://docs.here.com/workspace/docs/highly-available-pipelines.md) - [Stream processing best practices](https://docs.here.com/workspace/docs/stream-processing.md) - [Troubleshooting Flink](https://docs.here.com/workspace/docs/troubleshooting-flink.md) - [Troubleshooting pipelines](https://docs.here.com/workspace/docs/troubleshooting-pipelines.md) - [Troubleshooting Spark](https://docs.here.com/workspace/docs/troubleshooting-spark.md) - [How to run pipelines](https://docs.here.com/workspace/docs/running-a-pipeline.md) - [How to log a pipeline](https://docs.here.com/workspace/docs/pipeline-logging.md) - [How to monitor a pipeline](https://docs.here.com/workspace/docs/pipeline-monitoring.md) - [Set up your team](https://docs.here.com/workspace/docs/set-up-your-team.md) - [Get started with the REST API](https://docs.here.com/workspace/docs/try-out-the-apis-rest.md) - [Get started with the HERE Data SDK for Java & Scala](https://docs.here.com/workspace/docs/try-out-the-apis-sdk.md) - [Explore data in the HERE portal](https://docs.here.com/workspace/docs/explore-data.md) - [HERE data privacy by design](https://docs.here.com/workspace/docs/here-data-privacy-hub.md) - [HERE Platform catalogs, layers & partitions](https://docs.here.com/workspace/docs/catalogs-layers-partitions.md) - [HERE Workspace core concepts](https://docs.here.com/workspace/docs/learn-core-concepts.md) - [HERE Workspace pipelines](https://docs.here.com/workspace/docs/pipelines-learn-core-concepts.md) - [Overview of capabilities of the HERE Data SDKs, tools, and REST APIs](https://docs.here.com/workspace/docs/sdk-comparison-alternative.md) - [Introduction to HERE Workspace](https://docs.here.com/workspace/docs/readme-summary-7.md) ## API Reference - [Create one or more egress rules atomically. If one or more rules supplied by the request already exist for the realm then request is declined. User should have OrgAdmin role within the realm to be able to access this endpoint.](https://docs.here.com/workspace/reference/createegressrules.md) - [Delete a specific egress rule. User should have OrgAdmin role within the realm to be able to access this endpoint.](https://docs.here.com/workspace/reference/deleteegressrule.md) - [Get a specific egress rule. Any user authenticated with realm can access this endpoint.](https://docs.here.com/workspace/reference/getegressrule.md) - [Retrieve a list of actions applied to EgressRules in a realm. User should have OrgAdmin role within the realm to be able to access this endpoint.](https://docs.here.com/workspace/reference/getegressrulesauditlog.md) - [List all egress rules in a realm. Any user authenticated with realm can access this endpoint.](https://docs.here.com/workspace/reference/listegressrules.md) - [Upload a new Package.](https://docs.here.com/workspace/reference/createpackage.md): A Package is the jar file that contains the Pipeline code that you want to run. This endpoint receives and stores the Package file and returns the information about the stored Package. The filename of the jar file has a 200 character limit and the Package file size has 500 MB limit. - [Create a new Pipeline.](https://docs.here.com/workspace/reference/createpipeline.md): A Pipeline is the top-level entity introduced to group the work of implementing an actual data processing pipeline, in the form of one or more related PipelineVersions. This endpoint creates a Pipeline with no initial PipelineVersion and returns its metadata, that includes the id assigned to it. - [Delete a Pipeline.](https://docs.here.com/workspace/reference/deletepipeline.md): This endpoint deletes a Pipeline and its set of Pipeline Versions and associated content. The API will return an error if one or more of its Pipeline Versions are either 'running' or 'paused'. - [Get a Pipeline.](https://docs.here.com/workspace/reference/getpipeline.md): This endpoint returns the details about the Pipeline identified by the pipelineId path parameter. - [Get a Pipeline HRN.](https://docs.here.com/workspace/reference/getpipelinehrn.md): This endpoint returns the HRN of the Pipeline identified by the pipelineId path parameter. - [Get the list of Pipelines.](https://docs.here.com/workspace/reference/listpipelines.md): This endpoint returns a list of all Pipelines currently defined. - [Update a Pipeline.](https://docs.here.com/workspace/reference/updatepipeline.md): Updates the metadata about a pipeline identified by pipelineId. The PUT body contains the updated data. Note that the group field in Pipeline cannot be updated. - [Create a new PipelineTemplate.](https://docs.here.com/workspace/reference/createpipelinetemplate.md): A PipelineTemplate is the top-level entity which holds the information to fully define and independently reuse a data processing Pipeline, including its implementation. This endpoint creates a PipelineTemplate and returns its metadata, that includes the id assigned to it. - [Delete a PipelineTemplate.](https://docs.here.com/workspace/reference/deletepipelinetemplate.md): This endpoint delete the PipelineTemplate identified by the templateId path parameter. The PipelineTemplate cannot be in use, meaning that there are PipelineVersions defined with the PipelineTemplate. - [Get a PipelineTemplate.](https://docs.here.com/workspace/reference/getpipelinetemplate.md): This endpoint returns the details about the PipelineTemplate identified by the templateId path parameter. - [Get a PipelineTemplate HRN.](https://docs.here.com/workspace/reference/getpipelinetemplatehrn.md): This endpoint returns the HRN of the PipelineTemplate identified by the templateId path parameter. - [Get the list of PipelineTemplates.](https://docs.here.com/workspace/reference/listpipelinetemplates.md): This endpoint returns a list of all PipelineTemplates defined. - [Cancel a PipelineVersion.](https://docs.here.com/workspace/reference/cancelpipelineversion.md): This endpoint cancels a running or paused PipelineVersion. The cancel operation does not save the state of the pipeline version. - [Create a new PipelineVersion.](https://docs.here.com/workspace/reference/createpipelineversion.md): Defines a new version for the given Pipeline. This includes all the information to run actual processing, including the Pipeline Template, actual input & output catalogs and configurations. This endpoint instantiates the PipelineVersion and returns its metadata, that includes the id assigned to it. - [Deactivate a PipelineVersion.](https://docs.here.com/workspace/reference/deactivatepipelineversion.md): This endpoint deactivates a scheduled PipelineVersion. - [Delete a PipelineVersion.](https://docs.here.com/workspace/reference/deletepipelineversion.md): This endpoint deletes a PipelineVersion. The API will throw an error if the Pipeline Version is in any state other than Ready, or if there are any pending operations. - [The logging configuration.](https://docs.here.com/workspace/reference/getloggingconfiguration.md): This endpoint returns the current logging configuration that is set for the PipelineVersion. - [Get a PipelineVersion.](https://docs.here.com/workspace/reference/getpipelineversion.md): This endpoint returns the details about the PipelineVersion identified by the versionId path parameter. - [Get an Operation of a PipelineVersion.](https://docs.here.com/workspace/reference/getpipelineversionoperation.md): This endpoint returns the Operation specified. - [The scheduler configuration.](https://docs.here.com/workspace/reference/getschedulerconfiguration.md): This endpoint returns the current scheduler configuration that is set for the PipelineVersion. - [List Operations of a PipelineVersion.](https://docs.here.com/workspace/reference/listoperations.md): This endpoint returns a list of all Operations completed or pending on a PipelineVersion. - [List Jobs of a PipelineVersion.](https://docs.here.com/workspace/reference/listpipelineversionjobs.md): This endpoint returns a list of the Jobs a PipelineVersion ran or is currently running. - [Get the list of PipelineVersions for a Pipeline.](https://docs.here.com/workspace/reference/listpipelineversions.md): This endpoint returns a list of all PipelinesVersions currently defined for a given Pipeline. - [Pause a running PipelineVersion.](https://docs.here.com/workspace/reference/pausepipelineversion.md): This endpoint pauses a running PipelineVersion. For a pipeline version using template created for Streaming runtime environment, the pause operation saves a snapshot of the current state of processing. When the pipeline is resumed or upgraded, the pipeline starts from the last saved state. For a pipeline version using template create for Batch runtime environment, the pause operation pauses the future scheduled runs. If a pipeline is currently running then that run will continue until it is successful or failed. For a non scheduled batch pipeline this will return an HTTP status code of 400 - [Resume a paused PipelineVersion.](https://docs.here.com/workspace/reference/resumepipeline.md): This endpoint resumes a paused PipelineVersion. For a PipelineVersion using template created for Streaming runtime environment, it restarts from the state previously saved when paused. For a pipeline version using template with created for Batch runtime environment, it activates the scheduled runs. For non scheduled batch pipelines this will return a HTTP status code of 400 - [Schedules a PipelineVersion.](https://docs.here.com/workspace/reference/schedulepipelineversion.md): This endpoint updates the state of a PipelineVersion to Scheduled. - [Update logging configuration for pipeline version.](https://docs.here.com/workspace/reference/updateloggingconfiguration.md): Updates the logging configuration for the pipeline version. If there is a job currently running, the logging configuration will be applied to that job, and will be applied to the future jobs. - [Update scheduler configuration for PipelineVersion.](https://docs.here.com/workspace/reference/updateschedulerconfiguration.md): Updates the scheduler configuration for the PipelineVersion. This can only be applied to PipelineVersions that are in the READY state. - [Upgrade a PipelineVersion.](https://docs.here.com/workspace/reference/upgradepipelineversion.md): This endpoint upgrades this PipelineVersion to a different pipeline version as provided in the request. For a pipeline version using template created for Streaming runtime environment, the framework saves the snapshot of the current state of processing and uses the saved state to run the new pipeline version. For pipeline version using template created for Batch runtime environment, the current running job for the version is not stopped, however, the future scheduled runs are canceled. The new pipeline version is scheduled. - [Get available resource profiles.](https://docs.here.com/workspace/reference/listresourceprofiles.md): This endpoint returns information about resource profiles currently enabled for the customer or their organization. - [Get runtime environments information.](https://docs.here.com/workspace/reference/listruntimeenvironments.md): This endpoint returns information about runtime environments currently enabled for the customer or their organization. - [Get a Snapshot.](https://docs.here.com/workspace/reference/getsnapshot.md): This endpoint returns the details about the Snapshot identified by the snapshotId path parameter. - [List Snapshots of a Pipeline.](https://docs.here.com/workspace/reference/listsnapshots.md): This endpoint returns a list of the Snapshots associated with a Pipeline, sorted in descending order of time created, limited to the last 7 days and a max of 350 snapshots. ## Changelog - [CLI](https://docs.here.com/workspace/changelog/olp-cli.md) - [Data SDK for Java & Scala](https://docs.here.com/workspace/changelog/java-scala-sdk.md) - [Pipeline environment for stream processing](https://docs.here.com/workspace/changelog/stream-pipelines.md) - [Pipeline environment for batch processing](https://docs.here.com/workspace/changelog/batch-pipelines.md)