ConfigApi | @here/olp-sdk-ts
Namespace ConfigApi
Index
Interfaces
- Automatic
Version Deletion - Catalog
- Catalog
Failure Status - Catalog
Link - Catalog
Operation Success Status - Catalog
Pending Status - Catalog
Success Status - Catalog
Summary - Catalogs
List - Catalogs
List Result - Catalogs
Result Base - Catalogs
Summary List - Catalogs
Summary List Result - Coverage
- Create
Base Layer - Create
Catalog - Create
Index Layer - Create
Interactive Maps Layer - Create
Objectstore Layer - Create
Stream Layer - Create
Versioned Layer - Create
Volatile Layer - Creator
- Durable
Volume - Get
Base Layer - Index
Definition - Index
Layer - Index
Properties - Interactive
Maps Layer - Interactive
Maps Properties - Notifications
- Objectstore
Layer - Organisation
- Owner
- Partitioning
- Patch
Catalog - Patch
Index Properties - Patch
Interactive Maps Properties - Patch
Layer - Patch
Stream Properties - Replication
- Replication
Region - Schema
- Status
Link - Stream
Layer - Stream
Properties - Versioned
Layer - Volatile
Layer - Volatile
Properties - Volatile
Volume
Type Aliases
- Billing
Tags - CRC
- Content
Encoding - Content
Type - Data
Redundancy Enum - Deprecated
Partitioning Scheme - Digest
- Id
Enum - Index
Layer Type - Interactive
Maps Layer Type - Layer
Created - Layer
Description - Layer
Hrn - Layer
Id - Layer
Name - Layer
Summary - Max
Memory Policy Enum - Objectstore
Layer Type - Partitioning
Scheme - Role
Enum - Stream
Layer Type - Tags
- Ttl
- Ttl
Enum - Ttl
Hours - Type
Enum - Versioned
Layer Type - Volatile
Layer Type - Zoom
Level Enum
Functions
Type Aliases
Billing
CRC
The CRC algorithm used to calculate the checksum for the partitions in this layers
Content
Identifies whether the data is compressed.
Content
The MIME type of the data is stored in this layer.
Data
Deprecated
The name of the partitioning scheme for the layer.
Digest
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 does not verify that the specified algorithm was actually used.
Id
Index
The type of data availability that this layer provides.
Interactive
The type of data availability that this layer provides
Layer
The layer creation timestamp.
Layer
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.
Layer
The HERE Resource Name (HRN) of the layer.
Layer
The ID to use when referring to this layer programmatically.
Layer
The display name for the layer.
Layer
A one-sentence summary of the layer. You can see this summary when you browse a list of layers on the platform portal.
Max
Objectstore
The type of data availability that this layer provides
Partitioning
The name of the partitioning scheme for the layer.
Role
Stream
The type of data availability that this layer provides.
Tags
Some keywords that help to find the layer when searching in the platform portal.
Ttl
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).
Ttl
Ttl
The expiry time in hours for data in this layer. Data is automatically removed after the specified time limit has elapsed.
Type
Versioned
The type of data availability that this layer provides.
Volatile
The type of data availability that this layer provides.
Zoom
Functions
catalog
Checks whether a catalog with the specified HRN exists.
Parameters
builder: RequestBuilder
params: { billingTag?: string; catalogHrn: string }
Optional billing
Tag?: string catalog
Hrn: string
Returns Promise<Response>
create
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.
Parameters
builder: RequestBuilder
params: { billingTag?: string; body: CreateCatalog }
Optional billing
Tag?: string body: CreateCatalog
Returns Promise<StatusLink>
delete
Deletes a catalog and any layers within that catalog.
Parameters
builder: RequestBuilder
params: { billingTag?: string; catalogHrn: string }
Optional billing
Tag?: string catalog
Hrn: string
Returns Promise<StatusLink>
delete
Deletes a layer of the catalog if it's of layerType 'index', 'volatile', or 'stream'. Other
layerTypesare currently not supported.Parameters
builder: RequestBuilder
params: { catalogHrn: string; layerId: string }
catalog
Hrn: string layer
Id: string
Returns Promise<StatusLink>
disable
Disable automatic retired versions cleanup.
Parameters
builder: RequestBuilder
params: { catalogHrn: string }
catalog
Hrn: string
Returns Promise<StatusLink>
get
Gets the full catalog configuration for the requested catalog. The catalog configuration contains descriptive and structural information such as layer definitions and layer types.
Parameters
builder: RequestBuilder
params: { billingTag?: string; catalogHrn: string }
Optional billing
Tag?: string catalog
Hrn: string
Returns Promise<Catalog>
get
Takes the randomly generated token that you receive when you submit a catalog for creation. You can use it to monitor the status of your request.
Parameters
builder: RequestBuilder
params: { billingTag?: string; token: string }
Optional billing
Tag?: string token: string
Returns Promise<CatalogSuccessStatus>
get
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.
Parameters
builder: RequestBuilder
params: { access?: string[]; billingTag?: string; coverage?: string[]; layerType?: string[]; limit?: number; linkable?: boolean; marketplaceReady?: boolean; organisation?: string; organisationType?: string[]; q?: string; region?: string[]; resourceType?: string; schemaHrn?: string; sortBy?: string; sortOrder?: string; verbose?: string }
Optional access?: string[]
Optional billing
Tag?: string Optional coverage?: string[]
Optional layer
Type?: string[] Optional limit?: number
Optional linkable?: boolean
Optional marketplace
Ready?: boolean Optional organisation?: string
Optional organisation
Type?: string[] Optional q?: string
Optional region?: string[]
Optional resource
Type?: string Optional schema
Hrn?: string Optional sort
By?: string Optional sort
Order?: string Optional verbose?: string
Returns Promise<CatalogsListResult>
patch
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.
Parameters
builder: RequestBuilder
params: { body: PatchCatalog; catalogHrn: string }
body: PatchCatalog
catalog
Hrn: string
Returns Promise<StatusLink>
patch
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.
Parameters
builder: RequestBuilder
params: { body: PatchLayer; catalogHrn: string; layerId: string }
body: PatchLayer
catalog
Hrn: string layer
Id: string
Returns Promise<StatusLink>
update
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.
Parameters
builder: RequestBuilder
params: { billingTag?: string; body: CreateCatalog; catalogHrn: string }
Optional billing
Tag?: string body: CreateCatalog
catalog
Hrn: string
Returns Promise<StatusLink>
Generated using TypeDoc
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].