HEhere
Manage Data References

Get a Data Reference

Changed on

Gets a single Data Reference

get/references/{referenceId}

Request

  • Base URL
    /hub (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /hub/references/{referenceId}
  • Auth
    • API key in query parameter access_token
    • or HTTP bearer

Path parameters

referenceIdstring uuid required

The unique identifier of the Data Reference.

Response

A Data Reference

idstring uuid

Unique identifier. If not provided, it will be generated automatically.

entityIdstring required

HERE entity identifier (HRN format)

isPatchboolean required

Indicates whether this reference represents a patch dataset

startVersioninteger

Starting version of data (optional)

endVersioninteger required

Ending version of data

objectTypestring required

Type of stored objects

contentTypestring required

MIME type of stored content

locationstring required

Storage location URI

sourceSystemstring required

Source system name

targetSystemstring required

Target system name

Example response

{
  "id": "308a8ebd-de83-42ac-a5ce-e83bf5c60def",
  "entityId": "hrn:here:data::olp-here:CATALOG_ID:LAYER_ID",
  "isPatch": true,
  "startVersion": 123,
  "endVersion": 134,
  "objectType": "features",
  "contentType": "application/geo+json-seq",
  "location": "s3://bucket/prefix/to/files",
  "sourceSystem": "IML",
  "targetSystem": "S3"
}

Changes