Sign in

v1

latestOpenAPI 3.0.12026-07-24110189356.6 KB
config

Updates a catalog

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.

put/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.

Request body

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.

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[]

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

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

The version of the catalog configuration. Every change in this number indicates change in catalog configuration. Examples of changes in catalog configuration include changing catalog parameters and adding layers. Note that the catalog configuration version is not the same as the metadata/data version. Configuration and metadata versions are independent of each other and indicate different kinds of changes.

Example request

{
  "id": "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.",
  "tags": [
    "Traffic",
    "Flow",
    "Speed"
  ],
  "layers": [
    {
      "id": "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",
      "layerType": "versioned",
      "secureHandles": true,
      "subsetRestrictions": true,
      "versionedLayerProperties": {
        "encryptionType": "hereEncryption"
      }
    }
  ],
  "areaScheme": "hrn:here:areascheme::olp-here:default-countries",
  "subsetRestrictions": true,
  "version": 1,
  "automaticVersionDeletion": {
    "numberOfVersionsToKeep": 1,
    "ttlDays": 3
  }
}

Response

Accepted - your request was received and is being processed.

hrefstring

href of the created/update/delete catalog action

configTokenstring

token for getting the status of created/update/delete catalog action

titlestring

Title of the action

typestring

Type of the href

Example response

{
  "href": "https://config.data.api.platform.sit.here.com/config/v1/status/02bc9a8d-6dc4-4698-87a0-faf3372e81c1",
  "configToken": "02bc9a8d-6dc4-4698-87a0-faf3372e81c1",
  "title": "Catalog Creation, Catalog Deletion, Catalog Update",
  "type": "urn:olp-types:status"
}