HEhere
config

Modify a catalog layer

Modify some fields of the catalog layer. HTTP PATCH method is used to modify some fields of existing layer configuration. All fields are optional. Specify field value to modify it, not specified fields are ignored. To remove the field value use the null value. For more information see RFC 7396 - JSON Merge Patch.

patch/catalogs/{catalogHrn}/layers/{layerId}

Request

  • Base URL
    https://use.apilookup.for.a.base.url
  • URL
    https://use.apilookup.for.a.base.url/catalogs/{catalogHrn}/layers/{layerId}
  • Auth
    HTTP bearer

Path parameters

catalogHrnstring required

The HERE Resource Name (HRN) of the catalog

layerIdstring required

The layer ID

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

namestring

The short name for the layer. Field is optional, Specify a value to modify layer name. This field is not removable, null value is not allowed.

summarystring

A one-sentence summary of the layer. You can see this summary when you browse a list of layers on the platform portal. Field is optional, Specify a value to modify layer summary. This field is not removable, null value is not allowed.

descriptionstring

A detailed description of the layer and what it contains. This information appears on the 'Overview' tab when you open a layer in the platform portal. Field is optional, Specify a value to modify layer description. This field is not removable, null value is not allowed.

secureHandlesboolean

Indicates if the layer metadata and blob are in a mode that secure dataHandles support. It supports only heretile layer partitioning. The produced dataHandles contain a reference partitionId and a secure signature, for example '24235893475945c961-e74d-478f-8afe-da53cf4189e3EAAQuWgWdiwktzMKEeweZA-6HteHy38hXR_NY-qpeSamlJc'."

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.

tagsstring[]

Some keywords that help to find the layer when searching in the platform portal. Field is optional, Specify a value to replace all list of tags. This field is not removable, null value is not allowed.

billingTagsstring[]

List of billing tags a free-form tag which is used for grouping billing records together. If supplied, it must be between 4 - 16 characters, contain only alphanumeric ASCII characters [A-Za-z0-9] and the following special characters: - _ (except first and last character). Field is optional, Specify a value to replace all list of billing tags. This field is not removable, null value is not allowed.

crc'CRC-32C'

The CRC algorithm used to calculate the checksum for the partitions in this layers

digest'MD5' | 'SHA-1' | 'SHA-256'

The digest algorithm used to calculate the checksum for the partitions in this layer. If specified, you can assume that all partitions in the layer, at every version, were calculated using this algorithm. Note that it is the responsibility of the data publisher to use this algorithm to calculate partition checksums. The HERE platform services do not verify that the specified algorithm was actually used.

ttlinteger

The expiry time in milliseconds for data in this layer. Data is automatically removed after the specified time limit has elapsed. For volatile layers, the TTL value must be between 60000 (1 minute) and 604800000 (7 days). For stream layers the TTL value must be between 600000 (10 minutes) and 259200000 (72 hours). Can be updated for stream and index layers.

contentTypestring

The MIME type of the data is stored in this layer. Cannot be updated for objectstore and interactivemap layers. The default value for interactivemap layer is application/geo+json because the data is stored and retrieved in GeoJSON format compatible with RFC-7946 (https://www.rfc-editor.org/rfc/rfc7946).

contentEncoding'gzip'

Identifies whether the data is compressed. Can be updated only for the stream layer.

Example request

{
  "name": "Modified layer name",
  "summary": "Modified layer summary",
  "description": "Modified layer description",
  "coverage": {
    "adminAreas": [
      "DE"
    ]
  },
  "schema": {
    "hrn": "hrn:here:schema:::com.here.schema.rib:topology-geometry_v2:2.2.0"
  },
  "partitioning": {
    "scheme": "heretile",
    "tileLevels": [
      12
    ]
  },
  "indexProperties": {
    "ttl": "1.year"
  },
  "objectStoreProperties": {
    "ttl": "1.year"
  },
  "streamProperties": {
    "dataInThroughputKbps": 300,
    "dataOutThroughputKbps": 36500
  },
  "interactiveMapProperties": {
    "searchableProperties": [
      "incidentType"
    ],
    "versionsToKeep": 2,
    "readOnly": true
  },
  "secureHandles": true,
  "subsetRestrictions": true,
  "tags": [
    "Traffic",
    "Speed"
  ],
  "billingTags": [
    "Cost-Center_1",
    "Cost-Center_2"
  ],
  "crc": "CRC-32C",
  "digest": "SHA-1",
  "ttl": 3600000,
  "contentType": "application/json",
  "contentEncoding": "gzip"
}

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

Changes

No recorded changes to this operation across all 1 revision of this API.