Sign in

v1

latestOpenAPI 3.0.12026-07-24110189356.6 KB
config

Retrieves the details of all accessible data subsets.

Retrieves the details of all accessible data subsets which could contain the given areaId, areaIds, layerId or layerIds.

get/catalogs/{catalogHrn}/dataSubsets

Path parameters

catalogHrnstring required

HERE Resource Name (HRN) of the catalog.

Query parameters

limitinteger
Example:50

Determines pagination by limiting the number of requested items per page, as there can be thousands of data subsets. The actual number of items may differ from the requested limit on the last page.

pageTokenstring

Used for pagination requests when there are more pages than can be determined from the response of the request. The value is determined from the nextPageToken field in the response of the previous request, if it is not the last.

areasstring[]

Filters results to data subsets which contain the given areaId or areaIds, if provided. Only the areaId from the Area Scheme assigned to the catalog can be used. This parameter is optional.

layersstring[]

Filters results to data subsets which contain the given layerId or layerIds, if provided. Only the layerId from the catalog can be used. This parameter is optional.

Response

OK

totalinteger required

Total number of accessible data subsets.

limitinteger required

Requested or default limit of data subsets on a page.

countinteger required

Number of data subsets present on the current page.

nextPageTokenstring

An optional field which is present when there is another page with more data subsets that should be queried. The string value should be used in the query parameter of the new request to query the next page.

Example response

{
  "total": 2,
  "limit": 1,
  "count": 1,
  "items": [
    {
      "items": [
        {
          "id": "deu",
          "name": "Germany",
          "created": "2021-12-16T18:20:18.950358Z",
          "areaScheme": "hrn:here:areascheme::olp-here:default-countries",
          "areas": [
            "afg",
            "bra",
            "deu"
          ]
        }
      ]
    }
  ],
  "nextPageToken": "MS84"
}