v1

latestOpenAPI 3.0.22026-07-174950145.6 KB
Manage Data References

Create a Data Reference

Creates a Data Reference

post/references

Request body

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 request

{
  "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"
}

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"
}