v1

latestOpenAPI 3.0.12026-07-24110189356.6 KB

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}

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

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