config

Modify a catalog

Modify some fields of the catalog. The existing HTTP PUT method only allows a complete replacement of a catalog configuration, HTTP PATCH method is used to modify some fields of existing catalog 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}

Request

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

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

namestring

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

summarystring

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

descriptionstring

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. Field is optional, Specify a value to modify catalog description. This field is not removable, null value is not allowed.

tagsstring[]

Some keywords that help to find the catalog 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.

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.

deleteProtectedboolean

This property can be set to true if the resource needs to be protected from deletion. It can be set to false if the resource does not need to be protected from deletion. By default, catalogs are not protected.

Example request

{
  "name": "Modified catalog name",
  "summary": "Modified catalog summary",
  "description": "Modified catalog description",
  "tags": [
    "Traffic",
    "Speed"
  ],
  "areaScheme": "hrn:here:areascheme::olp-here:default-countries",
  "subsetRestrictions": true,
  "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"
}

Changes

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