HERE Config API v1

{"openapi":"3.0.1","info":{"description":"The `config` service provides basic catalog management operations. It manages all platform resources needed for different kinds of catalogs and operations on them.","version":"1.3.4","title":"Config API v1","x-olp-service":{"name":"config","version":"v1"}},"externalDocs":{"description":"The developer guide and related API references are available here.","url":"https://www.here.com/docs/category/data-api"},"servers":[{"url":"https://use.apilookup.for.a.base.url/"}],"security":[{"Bearer":[]}],"tags":[{"name":"config","description":"Manages catalogs and layers."},{"name":"subscription","description":"Manages subscriptions."}],"paths":{"/catalogs":{"get":{"tags":["config"],"summary":"Gets a list of all catalogs","description":"Lists all catalogs that your account has access to. To get access to a catalog, your administrator must associate this catalog in your HERE platform account. By default, the list provides summary data for each catalog such as the title, the configuration URL, and the resource type.\n\nNote:\nIf you have access to tens of thousands of catalogs or more, and it takes the server more than 50 seconds to generate the result, a partial response may be returned. Our testing indicates that a user with permission to access 50000 catalogs takes roughly 50 seconds to generate the result.\n","operationId":"Config API v1 getCatalogs","parameters":[{"name":"verbose","in":"query","description":"Indicates if the response should contain fully expanded catalog configurations.","required":false,"schema":{"type":"boolean","default":false}},{"name":"q","in":"query","description":"Works only when the verbose flag is set to true. The result contains only those items which have the given string as a part of the value of one or more searchable fields (substring compare). It will search the following catalog details fields: id, name, summary, description, tags and layer details: id, name, summary, description, tags, schema-hrn","required":false,"schema":{"type":"string"}},{"name":"organisation","in":"query","description":"Works only when the verbose flag is set to true. Filters only catalogs (layers) that belong to a specified organisation. You can filter only by catalog (layer) owner organisation ID. If you do not specify an organisation, the search is unfiltered.","required":false,"schema":{"type":"string"}},{"name":"organisationType","in":"query","description":"Works only when the verbose flag is set to true. Filters only catalogs that belong to an organisation. If set to ''myOrganisation'', the search is for catalogs (layers) with the same owner organisation ID like the requester''s. If set to ''here'', the search is for catalogs (layers) with the same owner organisation ID is equal to the Here organisation. If set to ''other'', the search is for catalogs (layers) with an owner organisation ID not equal to the requester organisation and not equal to HERE organisation. If you do not specify an organisation, the search is unfiltered.","required":false,"schema":{"type":"array","format":"csv","example":"myOrganisation,here,other","items":{"type":"string","enum":["myOrganisation","here","other"]}},"style":"form"},{"name":"layerType","in":"query","description":"Works only when the verbose flag is set to true. Comma-separated list of layer types (with OR semantic) to look for in the layer type. Filters only catalogs that contain layers with layer type presented in a given list. If you do not specify a layer type, the search is unfiltered.","required":false,"schema":{"type":"array","format":"csv","example":"versioned","items":{"type":"string","enum":["versioned","stream","volatile","index","objectstore","interactivemap"]}},"style":"form"},{"name":"region","in":"query","description":"Works only when the verbose flag is set to true. Comma-separated list of regions (with OR semantic) to look for in the catalog replication configuration. Filters only catalogs that contain region presented in given list. If you do not specify a region, the search is unfiltered.","required":false,"schema":{"type":"array","format":"csv","example":"eu-ireland,us-oregon,ap-seoul","items":{"type":"string","enum":["eu-ireland","us-oregon","ap-seoul"]}},"style":"form"},{"name":"schemaHrn","in":"query","description":"Works only when the verbose flag is set to true. Filters only catalogs (layers) by the specified layer schema HRN. You can only filter by layer schema. If you do not specify a schema, the search is unfiltered.","required":false,"schema":{"type":"string"}},{"name":"resourceType","in":"query","description":"Works only when the verbose flag is set to true. Specifies other filters behavior. If set to 'catalog', this applies other filters to search catalogs (and layers inside). If set to 'layer', this applies other filters to search layers. The returned json structure is the same for both cases (list of catalogs with list of layers inside each catalog).","required":false,"schema":{"type":"string","enum":["catalog","layer"],"default":"catalog"}},{"name":"coverage","in":"query","description":"Works only when the verbose flag is set to true. Comma-separated list of countries (with OR semantic) to look for in the catalog (layer) coverage. Only catalogs (layers) covering specified countries will be returned. This filed is case-insensitive. If you do not specify coverage, the search includes all countries.","required":false,"schema":{"type":"array","format":"csv","items":{"type":"string"}},"style":"form"},{"name":"access","in":"query","description":"Works only when the verbose flag is set to true. Comma-separated list of access types (with OR semantic) to filter result. If set to 'default', the response includes catalogs the user has read or manage access to. If set to 'create', the response includes catalogs the user has created and which match the `owner.creator` field, if set to 'manage', the response includes catalogs the user has manage access to. If set to 'orgAdmin', the response includes catalogs the `OrgAdmin` user have access to.","required":false,"schema":{"type":"array","format":"csv","example":"default,create,manage,orgAdmin","items":{"type":"string","enum":["default","create","manage","orgAdmin"]}},"style":"form"},{"name":"marketplaceReady","in":"query","description":"Indicates if the response should contain only Marketplace-ready catalogs. If this flag is set to true, the service will return only catalogs with the `marketplaceReady` element set to true.","required":false,"schema":{"type":"boolean","default":false}},{"name":"limit","in":"query","description":"Works only when the verbose flag is set to true. When specified, result element count will be limited to this value. You will be provided with a `pageUrl` link to access other pages in the `next` or `previous` field in the response. For further accessing other pages, you should use `getCatalogsPage` operation i.e. catalogs context route  which `Gets a list of catalogs in the current page`.","required":false,"schema":{"type":"integer","minimum":1}},{"name":"sortBy","in":"query","description":"Works only when the verbose flag is set to true. Specifies sort field. If set to 'name', the response contains catalogs sorted by catalog name. If set to 'created', the the response contains catalogs sorted by catalog create time. Layers inside a catalog are always sorted by layer name. If you do not specify a `sortBy`, the response contains catalogs sorted by 'name'.","required":false,"schema":{"type":"string","enum":["name","created"],"default":"name"}},{"name":"sortOrder","in":"query","description":"Works only when the verbose flag is set to true. Specifies the sort order. If set to 'asc', the sort order is ascending. If set to 'desc', the sort order is descending. If you do not specify `sortOrder`, the sort order is ascending.","required":false,"schema":{"type":"string","enum":["asc","desc"],"default":"asc"}},{"$ref":"#/components/parameters/linkable"},{"$ref":"#/components/parameters/billingTag"}],"responses":{"200":{"x-baseType":"CatalogsResultBase","description":"OK","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/CatalogsListResult"},{"$ref":"#/components/schemas/CatalogsSummaryListResult"}]}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"x-olp-access-type":"service"},"post":{"tags":["config"],"summary":"Creates a catalog","description":"Creates a new catalog with the specified layers. The create catalog operation runs asynchronously. Once you've submitted the catalog for creation, you'll receive a randomly generated token that you can use to monitor the status of the operation.","operationId":"Config API v1 createCatalog","parameters":[{"$ref":"#/components/parameters/billingTag"}],"requestBody":{"description":"A catalog object that contains metadata and layer definitions.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCatalog"}}}},"responses":{"202":{"description":"Accepted - your request was received and is being processed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusLink"}}}},"400":{"description":"Bad Request - indicates that your request failed fast validation, such as syntax or some logical errors."},"401":{"description":"Unauthorized"},"402":{"description":"Payment required - indicates that your request failed because performing the catalog operation would exceed the resource limit."},"403":{"description":"Forbidden"},"409":{"description":"Conflict - indicates that a catalog with the same catalog ID already exists or is in the process of being created."}},"x-olp-access-type":"service"}},"/catalogs/context/{pageContext}":{"get":{"tags":["config"],"summary":"Gets a list of catalogs in the current page","description":"When the result of `Gets a list of all catalogs` i.e. `getCatalogs` operation is divided into multiple pages, you get a list of catalogs in the current page using this catalogs context route.","operationId":"Config API v1 getCatalogsPage","parameters":[{"name":"pageContext","in":"path","description":"`pageContext` is the encoded string you should extract from the `getCatalogs` or `getCatalogsPage` operation response. The value should be extracted from the pageUrl value of the fields `next` or `previous`.\n","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/billingTag"}],"responses":{"200":{"x-baseType":"CatalogsResultBase","description":"OK","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/CatalogsListResult"},{"$ref":"#/components/schemas/CatalogsSummaryListResult"}]}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"x-olp-access-type":"service"}},"/catalogs/{catalogHrn}":{"get":{"tags":["config"],"summary":"Gets the details of a catalog","description":"Gets the full catalog configuration for the requested catalog. The catalog configuration contains descriptive and structural information such as layer definitions and layer types.","operationId":"Config API v1 getCatalog","parameters":[{"name":"catalogHrn","in":"path","description":"The HERE Resource Name (HRN) of the catalog","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/billingTag"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Catalog"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden - A catalog with the specified HRN doesn't exist or access to this catalog is forbidden"}},"x-olp-access-type":"service"},"head":{"tags":["config"],"summary":"Checks the existence of a catalog","description":"Checks whether a catalog with the specified HRN exists.","operationId":"Config API v1 catalogExists","parameters":[{"name":"catalogHrn","in":"path","description":"The HERE Resource Name (HRN) of the catalog.","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/billingTag"}],"responses":{"200":{"description":"OK - catalog exists."},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found - catalog with the specified HRN doesn't exist."}},"x-olp-access-type":"service"},"put":{"tags":["config"],"summary":"Updates a catalog","description":"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.","operationId":"Config API v1 updateCatalog","parameters":[{"name":"catalogHrn","in":"path","description":"The HERE Resource Name (HRN) of the catalog","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/billingTag"}],"requestBody":{"description":"A catalog object that contains metadata and layer definitions.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCatalog"}}}},"responses":{"202":{"description":"Accepted - your request was received and is being processed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusLink"}}}},"400":{"description":"Bad Request - indicates that your request failed fast validation such as syntax or some logical errors."},"401":{"description":"Unauthorized"},"402":{"description":"Payment required - indicates that your request failed because performing the catalog operation would exceed the resource limit."},"403":{"description":"Forbidden - A catalog with the specified HRN doesn't exist or access to this catalog is forbidden."},"409":{"description":"Conflict - The catalog with the specified HRN is in the process of being updated."}},"x-olp-access-type":"service"},"patch":{"tags":["config"],"summary":"Modify a catalog","description":"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.","operationId":"Config API v1 patchCatalog","parameters":[{"name":"catalogHrn","in":"path","description":"The HERE Resource Name (HRN) of the catalog","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/billingTag"}],"requestBody":{"description":"A catalog object that contains modification of catalog configuration","required":true,"content":{"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/PatchCatalog"}}}},"responses":{"202":{"description":"Accepted - your request was received and is being processed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusLink"}}}},"400":{"description":"Bad Request - indicates that your request failed fast validation such as syntax or some logical errors."},"401":{"description":"Unauthorized"},"402":{"description":"Payment required - indicates that your request failed because performing the catalog operation would exceed the resource limit."},"403":{"description":"Forbidden - Access to this catalog is forbidden."},"404":{"description":"Not Found - A catalog with the specified HRN doesn't exist."},"409":{"description":"Conflict - The catalog with the specified HRN is in the process of being updated."}},"x-olp-access-type":"service"},"delete":{"tags":["config"],"summary":"Deletes a catalog","description":"Deletes a catalog and any layers within that catalog.","operationId":"Config API v1 deleteCatalog","parameters":[{"name":"catalogHrn","in":"path","description":"The HERE Resource Name (HRN) of the catalog","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/billingTag"}],"responses":{"202":{"description":"Accepted - your request was received and is being processed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusLink"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden - A catalog with the specified HRN doesn't exist or access to this catalog is forbidden."},"409":{"description":"Conflict - The catalog with the specified HRN is in the process of being deleted."}},"x-olp-access-type":"service"}},"/catalogs/{catalogHrn}/status":{"patch":{"tags":["config"],"summary":"Mark a catalog as disabled or re-enable catalog","description":"Allows to mark a catalog status as disabled or to re-enable it.","operationId":"Config API v1 changeCatalogState","parameters":[{"name":"catalogHrn","in":"path","required":true,"description":"The HERE Resource Name (HRN) of the catalog","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogStatusRequestBody"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogStatusResult"}}}},"400":{"description":"Bad Request - indicates that your request failed fast validation such as syntax or some logical errors."},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden - Access to this catalog is forbidden."},"404":{"description":"Not Found - A catalog with the specified HRN doesn't exist."},"409":{"description":"Conflict - The catalog with the specified HRN is in the process of being updated."}},"x-olp-access-type":"service"},"get":{"tags":["config"],"summary":"Gets catalog status information","description":"Query status, time of disablement or enablement by catalog and who changed the status from enabled to disabled and vice versa.","operationId":"Config API v1 getCatalogState","parameters":[{"name":"catalogHrn","in":"path","required":true,"description":"The HERE Resource Name (HRN) of the catalog","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogStatusResult"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden - A catalog with the specified HRN doesn't exist or access to this catalog is forbidden"},"404":{"description":"Not Found - A catalog with the specified HRN doesn't exist."}},"x-olp-access-type":"service"}},"/catalogs/{catalogHrn}/layers/{layerId}":{"patch":{"tags":["config"],"summary":"Modify a catalog layer","description":"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.","operationId":"Config API v1 patchLayer","parameters":[{"name":"catalogHrn","in":"path","description":"The HERE Resource Name (HRN) of the catalog","required":true,"schema":{"type":"string"}},{"name":"layerId","in":"path","description":"The layer ID","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/billingTag"}],"requestBody":{"description":"A layer object that contains modification of layer configuration","required":true,"content":{"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/PatchLayer"}}}},"responses":{"202":{"description":"Accepted - your request was received and is being processed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusLink"}}}},"400":{"description":"Bad Request - indicates that your request failed fast validation such as syntax or some logical errors."},"401":{"description":"Unauthorized"},"402":{"description":"Payment required - indicates that your request failed because performing the catalog operation would exceed the resource limit."},"403":{"description":"Forbidden - Access to this catalog or layer is forbidden."},"404":{"description":"Not Found - A catalog with the specified HRN doesn't exist."},"409":{"description":"Conflict - The catalog with the specified HRN is in the process of being updated."}},"x-olp-access-type":"service"},"delete":{"tags":["config"],"summary":"Delete a layer","description":"Deletes a layer of the catalog.","operationId":"Config API v1 deleteLayer","parameters":[{"name":"catalogHrn","in":"path","description":"The HERE Resource Name (HRN) of the catalog","required":true,"schema":{"type":"string"}},{"name":"layerId","in":"path","description":"The layer ID","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/billingTag"}],"responses":{"202":{"description":"Accepted - your request was received and is being processed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusLink"}}}},"400":{"description":"Bad Request - indicates that your request failed fast validation such as syntax or some logical errors."},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden - Access to this catalog or layer is forbidden."},"404":{"description":"Not Found - A catalog with the specified HRN doesn't exist."},"409":{"description":"Conflict - The catalog with the specified HRN is in the process of being updated."}},"x-olp-access-type":"service"}},"/catalogs/{catalogHrn}/subsets":{"get":{"tags":["config"],"deprecated":true,"summary":"Retrieves the details of all accessible subsets.","description":"This endpoint is deprecated. Use **/catalogs/{catalogHrn}/dataSubsets** instead. **BETA** Retrieves the details of all accessible subsets which contain the given areaId or areaIds.","operationId":"Config API v1 getSubsets","parameters":[{"name":"catalogHrn","in":"path","description":"HERE Resource Name (HRN) of the catalog.","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Determines pagination by limiting the number of requested items per page, as there can be thousands of subsets. The actual number of items may differ from the requested limit on the last page.","required":false,"schema":{"type":"integer","format":"int64","minimum":1,"default":100,"example":50}},{"name":"pageToken","in":"query","description":"Used for pagination requests when there are more pages than can be determined from the response of the request. The value is determined from the nextPageToken field in the response of the previous request, if it is not the last.","required":false,"schema":{"type":"string"},"example":"MS84"},{"name":"areas","in":"query","description":"Filters results to subsets which contain the given areaId or areaIds, if provided. Only the areaId from the Area Scheme assigned to the catalog can be used. This parameter is optional.","required":false,"style":"form","schema":{"type":"array","format":"csv","items":{"type":"string"},"example":"afg,bra,deu"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubsetsResponse"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden - A catalog with the specified HRN doesn't exist or access to this catalog is forbidden."}},"x-olp-access-type":"service","x-maturity":"beta"}},"/catalogs/{catalogHrn}/subsets/{subsetId}":{"get":{"tags":["config"],"deprecated":true,"summary":"Retrieve the details of a specific subset.","description":"This endpoint is deprecated. Use **/catalogs/{catalogHrn}/dataSubsets/{dataSubsetId}** instead. **BETA** Retrieve the details of a specific subset.","operationId":"Config API v1 getSubset","parameters":[{"name":"catalogHrn","in":"path","description":"HERE Resource Name (HRN) of the catalog.","required":true,"schema":{"type":"string"}},{"name":"subsetId","in":"path","description":"Immutable ID used to refer to the subset.","required":true,"schema":{"type":"string"},"example":"deu"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subset"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden - A catalog with the specified HRN doesn't exist or access to this catalog is forbidden."},"404":{"description":"Not Found - A Subset with the specified subsetId doesn't exist."}},"x-olp-access-type":"service","x-maturity":"beta"}},"/catalogs/{catalogHrn}/subsetsFingerprint":{"get":{"tags":["config"],"deprecated":true,"summary":"Get Subsets Fingerprint","description":"This endpoint is deprecated. Use **/catalogs/{catalogHrn}/dataSubsetsFingerprint** instead. **BETA** Retrieve a fingerprint that represents the accessible subset configuration of the calling user.","operationId":"Config API v1 getSubsetsFingerprint","parameters":[{"name":"catalogHrn","in":"path","description":"HERE Resource Name (HRN) of the catalog.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubsetsFingerprint"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden - A catalog with the specified HRN doesn't exist or access to this catalog is forbidden."}},"x-olp-access-type":"service","x-maturity":"beta"}},"/catalogs/{catalogHrn}/dataSubsets":{"get":{"tags":["config"],"summary":"Retrieves the details of all accessible data subsets.","description":"Retrieves the details of all accessible data subsets which could contain the given areaId, areaIds, layerId or layerIds.","operationId":"Config API v1 getDataSubsets","parameters":[{"name":"catalogHrn","in":"path","description":"HERE Resource Name (HRN) of the catalog.","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Determines pagination by limiting the number of requested items per page, as there can be thousands of data subsets. The actual number of items may differ from the requested limit on the last page.","required":false,"schema":{"type":"integer","format":"int64","minimum":1,"default":100,"example":50}},{"name":"pageToken","in":"query","description":"Used for pagination requests when there are more pages than can be determined from the response of the request. The value is determined from the nextPageToken field in the response of the previous request, if it is not the last.","required":false,"schema":{"type":"string"},"example":"MS84"},{"name":"areas","in":"query","description":"Filters results to data subsets which contain the given areaId or areaIds, if provided. Only the areaId from the Area Scheme assigned to the catalog can be used. This parameter is optional.","required":false,"style":"form","schema":{"type":"array","format":"csv","items":{"type":"string"},"example":"afg,bra,deu"}},{"name":"layers","in":"query","description":"Filters results to data subsets which contain the given layerId or layerIds, if provided. Only the layerId from the catalog can be used. This parameter is optional.","required":false,"style":"form","schema":{"type":"array","format":"csv","items":{"type":"string"},"example":"topology,roadnetwork"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataSubsetsResponse"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden - A catalog with the specified HRN doesn't exist or access to this catalog is forbidden."}},"x-olp-access-type":"service","x-maturity":"beta"},"post":{"tags":["config"],"summary":"Create data subsets","description":"Creates one or more data subsets for the given catalog.  \n- Maximum **1000** data subsets can be created in a single request.  \n- This is an **asynchronous** operation: the request returns a status link which can be used to check the operation result.\n","operationId":"Config API v1 createDataSubsets","parameters":[{"name":"catalogHrn","in":"path","description":"HERE Resource Name (HRN) of the catalog.","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"description":"Array of data subsets to create.\n","content":{"application/json":{"schema":{"type":"array","maxItems":1000,"items":{"$ref":"#/components/schemas/DataSubsetCreate"}}}}},"responses":{"202":{"description":"Accepted - your request was received and is being processed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusLink"}}}},"400":{"description":"Bad Request - indicates that your request failed fast validation, such as syntax or some logical errors."},"401":{"description":"Unauthorized"},"402":{"description":"Payment required - indicates that your request failed because performing the catalog operation would exceed the resource limit."},"403":{"description":"Forbidden"},"409":{"description":"Conflict - indicates that a data subset with the same ID already exists or is in the process of being created."}},"x-olp-access-type":"service","x-maturity":"beta"}},"/catalogs/{catalogHrn}/dataSubsets/{dataSubsetId}":{"get":{"tags":["config"],"summary":"Retrieve the details of a specific data subset.","description":"Retrieve the details of a specific data subset.","operationId":"Config API v1 getDataSubset","parameters":[{"name":"catalogHrn","in":"path","description":"HERE Resource Name (HRN) of the catalog.","required":true,"schema":{"type":"string"}},{"name":"dataSubsetId","in":"path","description":"Immutable ID used to refer to the subset.","required":true,"schema":{"type":"string"},"example":"deu"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataSubset"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden - A catalog with the specified HRN doesn't exist or access to this catalog is forbidden."},"404":{"description":"Not Found - A Subset with the specified subsetId doesn't exist."}},"x-olp-access-type":"service","x-maturity":"beta"},"delete":{"tags":["config"],"summary":"Delete a specific data subset","description":"Deletes a specific data subset identified by `dataSubsetId`.  \n- This is an **asynchronous** operation: the request returns a status link which can be used to check the deletion status.\n","operationId":"Config API v1 deleteDataSubset","parameters":[{"name":"catalogHrn","in":"path","description":"HERE Resource Name (HRN) of the catalog.","required":true,"schema":{"type":"string"}},{"name":"dataSubsetId","in":"path","description":"Immutable ID used to refer to the subset.","required":true,"schema":{"type":"string","example":"deu"}}],"responses":{"202":{"description":"Accepted - your request was received and is being processed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusLink"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden - A catalog with the specified HRN doesn't exist or access to this catalog is forbidden."},"409":{"description":"Conflict - The data subset with the specified ID is in the process of being deleted."}},"x-olp-access-type":"service","x-maturity":"beta"}},"/catalogs/{catalogHrn}/dataSubsetsFingerprint":{"get":{"tags":["config"],"summary":"Get Data Subsets Fingerprint","description":"Retrieve a fingerprint that represents the accessible data subset configuration of the calling user.","operationId":"Config API v1 getDataSubsetsFingerprint","parameters":[{"name":"catalogHrn","in":"path","description":"HERE Resource Name (HRN) of the catalog.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataSubsetsFingerprint"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden - A catalog with the specified HRN doesn't exist or access to this catalog is forbidden."}},"x-olp-access-type":"service","x-maturity":"beta"}},"/catalogs/{catalogHrn}/automaticVersionDeletion":{"delete":{"tags":["config"],"summary":"Disable automatic version deletion","description":"Disable automatic retired versions cleanup.","operationId":"Config API v1 disableAutomaticVersionDeletion","parameters":[{"name":"catalogHrn","in":"path","description":"The HERE Resource Name (HRN) of the catalog.","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/billingTag"}],"responses":{"202":{"description":"Accepted - your request was received and is being processed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusLink"}}}},"400":{"description":"Bad Request - indicates that your request failed fast validation such as syntax or some logical errors."},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden - Access to this catalog or layer is forbidden."},"404":{"description":"Not Found - A catalog with the specified HRN doesn't exist."},"409":{"description":"Conflict - The catalog with the specified HRN is in the process of being updated."}},"x-olp-access-type":"service"}},"/status/{token}":{"get":{"tags":["config"],"summary":"Gets the status of a create, update or delete catalog request.","description":"Takes the randomly generated t

# --- truncated at 32 KB (113 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/here/refs/heads/main/openapi/here-data-config-v1-openapi.yml