Sign in

v1

latestOpenAPI 3.0.12026-07-24110189356.6 KB
config

Gets the details of a catalog

Gets the full catalog configuration for the requested catalog. The catalog configuration contains descriptive and structural information such as layer definitions and layer types.

get/catalogs/{catalogHrn}

Path parameters

catalogHrnstring required

The HERE Resource Name (HRN) of the catalog

Query parameters

billingTagstring

The billingTag parameter is an optional free-form tag that you can use to group billing records together. If supplied, it must be between 4 - 16 characters, contain only alpha/numeric ASCII characters [A-Za-z0-9]. Grouping billing records by billing tag will be available in future releases.

Response

OK

idstring required

The ID to use when referring to this catalog programmatically. Catalog IDs must be unique across all catalogs in the Open Location Platform. Do not put private information in the catalog ID. The catalog ID forms a portion of the catalog's HERE Resource Name (HRN), and HRNs are visible to other users. Only lowercase alphanumeric characters (a-z), digits (0-9) and dash (-) are allowed in a catalog ID and the first and the last character must be a-z or 0-9.

hrnstring required

The HERE Resource Name (HRN) of the catalog

namestring required

The short name for the catalog

summarystring required

A one-sentence summary of the catalog. You can see this summary when you browse a list of catalogs on the platform portal.

descriptionstring required

A detailed description of the catalog and what it contains. This information appears on the 'Overview' tab when you open a catalog in the platform portal.

tagsstring[] required

Some keywords that help to find the catalog when searching in the platform portal

billingTagsstring[]

Aggregated list of all layersbilling tags. Note that this element is read-only and does not exist inCreateCatalog`. If posted during catalog creation, the value will be ignored.

createdstring required

Timestamp, in ISO 8601 format, when the catalog was initially created.

areaSchemestring

This field is deprecated on the catalog level. Use /catalogs/{catalogHrn}/dataSubsets to set areaScheme in the dataSubset instead. HERE Resource Name (HRN) of the Area Scheme used in the data subset. After deprecation setting areaScheme on the catalog level takes no effect. It will simply be ignored.

subsetRestrictionsboolean

This field is deprecated on the catalog level. Use subsetRestrictions on the layer level only. Indicates if the subsetRestrictions for a layer is enabled or not. Supported only for layers with heretile partitioning. After deprecation setting subsetRestrictions on the catalog level takes no effect. It will simply be ignored.

versioninteger required

The version of the catalog configuration. Every change in this number indicates a change in the catalog configuration. It is incremented every time you make changes, such as change catalog parameters or add layers. Note that this is not a metadata/data version as configuration and metadata versions are independent of each other and indicate different kind of changes.

marketplaceReadyboolean

Indicates whether the catalog is ready to be listed in the Marketplace. If the value is true, the catalog is ready to be listed in the Marketplace.

Example response

{
  "id": "olp-traffic",
  "hrn": "hrn:here:data:::olp-traffic",
  "name": "Traffic Data",
  "summary": "This catalog provides traffic flow and incidents information.",
  "description": "The catalog provides aggregated information about traffic incidents, including the type and location of each traffic incident, status, start and end time, and other relevant data. This data is useful to dynamically optimize route calculations. It also provides access to real-time traffic flow data in including information on speed and congestion for specific regions. The catalog also contains additional data such as the geometry of the road segments in relation to the flow.",
  "coverage": {
    "adminAreas": [
      "DE"
    ]
  },
  "owner": {
    "creator": {
      "id": "Mejk6DMxAq7kKI5lt2T2"
    },
    "organisation": {
      "id": "HERE"
    }
  },
  "tags": [
    "Traffic",
    "Flow",
    "Speed"
  ],
  "billingTags": [
    "Cost-Center_1",
    "Cost-Center_2"
  ],
  "created": "2017-08-04T17:19:03.853Z",
  "automaticVersionDeletion": {
    "numberOfVersionsToKeep": 1,
    "ttlDays": 3
  },
  "layers": [
    {
      "id": "traffic-incidents",
      "hrn": "hrn:here:data:::olp-traffic:traffic-incidents",
      "name": "Traffic Incidents",
      "summary": "This layer provides aggregated information about traffic incidents.",
      "description": "This layer provides aggregated information about traffic incidents, including the type and location of each traffic incident, status, start and end time, and other relevant data. This data is useful to dynamically optimize route calculations.",
      "coverage": {
        "adminAreas": [
          "DE"
        ]
      },
      "schema": {
        "hrn": "hrn:here:schema:::com.here.schema.rib:topology-geometry_v2:2.2.0"
      },
      "partitioningScheme": "heretile",
      "partitioning": {
        "scheme": "heretile",
        "tileLevels": [
          12
        ]
      },
      "contentType": "application/json",
      "contentEncoding": "gzip",
      "tags": [
        "Traffic",
        "Flow",
        "Speed",
        "Real-Time",
        "Current"
      ],
      "billingTags": [
        "Cost-Center_1",
        "Cost-Center_2"
      ],
      "digest": "SHA-1",
      "crc": "CRC-32C",
      "volume": {
        "volumeType": "durable"
      },
      "created": "2019-02-07T15:24:39.437810Z",
      "layerType": "versioned",
      "secureHandles": true,
      "subsetRestrictions": true,
      "versionedLayerProperties": {
        "encryptionType": "hereEncryption"
      }
    }
  ],
  "areaScheme": "hrn:here:areascheme::olp-here:default-countries",
  "subsetRestrictions": true,
  "version": 1
}