GuidesAPI Reference
API Reference

Gets index metadata of versioned

Gets metadata for the requested index. Only available for versioned layers where the partitioning scheme is heretile.

Path Params
string
required

The ID of the layer specified in the request. Content of this parameter must refer to a valid layer already configured in the catalog configuration. Exactly one layer ID must be provided.

int64
required

The version of the catalog against which to run the query. Must be a valid catalog version.

string
required

The geometric area specified by an index in the request, represented as a HERE tile

int32
required

The recursion depth of the response. If set to 0, the response includes only data for the quadKey specified in the request. In this way, depth describes the maximum length of the subQuadKeys in the response. The maximum allowed value for the depth parameter is 4.

Query Params
string
enum
Defaults to default

The context where the operation will be performed on a composite layers. Only available for versioned layers.

Available context are:

ContextDescription
defaultThe default value if none is given. For composite layers the operation is executed for both layers current and the layer it extends. For normal layers this is the only valid context.
extensionThe operation will be executed only in the extension and no operation will be performed in the extended layer.
superThe operation will be executed only in the layer being extended (super layer).
Allowed:
additionalFields
array of strings

Additional fields - dataSize, checksum, compressedDataSize, crc.

additionalFields
string

Billing Tag is an optional free-form tag used to group billing records together. If supplied, it must be between 4 - 16 characters and contain only alphanumeric ASCII characters [A-Za-z0-9]. Grouping billing records by billing tag will be available in a future release.

Responses

400

Required parameters are missing

401

Unauthorized

403

Forbidden

404

Not Found

Language
Credentials
Bearer
JWT
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json