HERE Config API is one of 139 APIs that HERE publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Config. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes
22 operations
across 13 paths,
and defines 91 schemas.
It is described by OpenAPI 3.2.0, at version 1.3.4.
Requests are made against a single base URL, https://use.apilookup.for.a.base.url/.
The identity and technical contract details declared by the specification.
VolatileVolume
object
Describes a catalog volatile volume to be used for storing the layer's data content. Specifies volatile properties values if they are not provided.
2 properties
1 required
DataSubsets
object
Describes the accessible data subsets based on different areas or layers.
1 property
1 required
Notifications
object
When set to true, a notification is written to the notification stream each time the version of the catalog changes. This field is optional, but you can update…
1 property
Organisation
object
1 property
VersionedLayer
Describes the catalog versioned layer properties.
ContentEncoding
string
Identifies whether the data is compressed. Can be updated only for the stream layer.
IndexDefinition
object
4 properties
Ttl
integer
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…
LayerName
string
The display name for the layer.
AutomaticVersionDeletion
object
2 properties
CatalogPendingStatus
object
Describes the status of the catalog modification action.
1 property
IndexProperties
object
2 properties
InteractiveMapProperties
object
4 properties
Owner
object
2 properties
LayerId
string
The ID to use when referring to this layer programmatically.
VersionedLayerPropertiesInGet
object
2 properties
CreateObjectstoreLayer
Describes properties of a catalog object store layer.
EncryptionType
string
Defines type of encryption to apply for data at rest. 'hereEncryption' is default and ensures that encryption keys are managed by HERE, 'cloudEncryption' uses…
Partitioning
object
Describes the way in which data is partitioned within the layer.
2 properties
1 required
LayerHrn
string
The HERE Resource Name (HRN) of the layer.
VolatileProperties
object
Properties that define the scale of the volatile layer.
2 properties
1 required
CatalogOperationSuccessStatus
object
Describes the status of the successful catalog creation operation including its href.
2 properties
1 required
PatchObjectStoreProperties
object
1 property
PatchStreamProperties
object
Properties that define the scale of the required streaming layer. dataInThroughputKbps and dataOutThroughputKbps can only be values multiple of 100. For instan…
2 properties
Digest
string
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 v…
CatalogFailureStatus
object
Describes the detailed status of the failed catalog creation operation.
2 properties
InteractiveMapsLayer
Describes the catalog interactive maps layer properties.
SecureHandles
boolean
Indicates if the layer metadata and blob are in a mode that secure dataHandles support. It supports only heretile layer partitioning. The produced dataHandles…
PartitioningScheme
string
The name of the partitioning scheme for the layer
SubsetsResponse
object
BETA Response body for the get subsets API that is useful for pagination.
5 properties
4 required
CatalogSummary
object
Describes the main properties of the catalog.
4 properties
VolatileLayer
Describes the catalog volatile layer properties.
ContentType
string
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 a…
Replication
object
1 property
Coverage
object
The geographic area that this layer covers
1 property
LayerDescription
string
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.
ObjectstoreLayer
Describes the catalog objectstore layer properties.
LayerCreated
string
The layer creation timestamp in ISO 8601 format.
ObjectStoreProperties
object
2 properties
StreamProperties
object
Properties that define the scale of the required streaming layer. It is recommended to provide all 3 properties when creating a streaming layer. Either combina…
3 properties
CreateStreamLayer
Describes properties of a catalog stream layer.
CatalogsListResult
Contains a list of catalogs the user has access to.
CatalogLink
object
Describes the status and href of the create/update/delete resource such as a catalog.
4 properties
DataSubsetsFingerprint
object
DataSubsetFingerprint is a combination of fields that indicate if anything was changed in the set of data subsets or if area scheme version was increased
5 properties
2 required
StatusLink
object
Describes the status and href of the create/update/delete resource such as a catalog.
4 properties
CatalogSuccessStatus
object
Describes the status of the successful catalog creation operation including its href.
2 properties
CRC
string
The CRC algorithm used to calculate the checksum for the partitions in this layers
CatalogStatusRequestBody
object
1 property
1 required
SubsetRestrictions
boolean
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 no…
SubsetsFingerprint
object
BETA If subsetRestrictions is not enabled, the subsetsFingerprint, subsets, and areas will be empty.
4 properties
3 required
VersionedLayerPropertiesInPost
object
2 properties
DurableVolume
object
Describes a catalog durable volume to be used for storing the layer's data content.
1 property
1 required
PatchIndexProperties
object
1 property
Subset
object
Describes the specific subset based on the included areas.
5 properties
5 required
CreateVolatileLayer
Describes properties of a catalog volatile layer.
DeprecatedPartitioningScheme
string
The name of the partitioning scheme for the layer
CreateVersionedLayer
Describes properties of a catalog versioned layer.
DataSubsetBaseCreate
object
3 properties
3 required
TtlHours
integer
The expiry time in hours for data in this layer. Data is automatically removed after the specified time limit has elapsed.
CatalogsResultBase
object
Describes base class.
1 property
AreaSchemeFingerprint
object
2 properties
2 required
DataSubsetBase
object
4 properties
4 required
CreateIndexLayer
Describes properties of a catalog index layer.
CatalogsSummaryListResult
Contains a list of catalog summaries the user has access to.
DataSubsetsResponse
object
Response body for the get data subsets API that is useful for pagination.
5 properties
4 required
PatchCatalog
object
Describes the modification of the catalog configuration.
10 properties
Schema
object
Describes a HRN for the layer schema. Can be updated by the user for any kind of layer.
1 property
CreateInteractiveMapsLayer
Describes properties of a catalog interactive maps layer.
ReplicationRegion
object
2 properties
1 required
LayerSummary
string
A one-sentence summary of the layer. You can see this summary when you browse a list of layers on the platform portal.
IndexLayer
Describes the catalog index layer properties.
BillingTags
array
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 alpha…
Catalog
object
Describes the catalog properties.
18 properties
10 required
PatchLayer
object
Describes the modification of the layer configuration.
19 properties
Extends
object
Extension definition that allows a layer's content to be based on an existing layer. Entities in the extension layer override features with the same ID in the…
2 properties
2 required
CatalogsList
object
List of the catalog configurations.
3 properties
CatalogsSummaryList
object
List of the catalog summaries
3 properties
Creator
object
1 property
AreaScheme
string
This field is deprecated on the catalog level. Use /catalogs/{catalogHrn}/dataSubsets to set areaScheme in the dataSubset instead. HERE Resource Name (HRN) of…
CreateCatalog
object
Describes the configuration of the catalog including its layer definitions.
12 properties
4 required
CatalogStatusResult
object
3 properties
Subsets
object
BETA Describes the accessible subsets based on different areas. If subsetRestrictions is not enabled, the result will be empty.
1 property
1 required
Tags
array
Some keywords that help to find the layer when searching in the platform portal
StreamLayer
Describes the catalog stream layer properties.
The full machine-readable OpenAPI contract behind this narrative.
Other APIs HERE publishes across the network.