Sign in

v1

latestOpenAPI 3.0.12026-07-24110189356.6 KB
query

Gets index metadata of versioned

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

get/layers/{layerId}/versions/{version}/quadkeys/{quadKey}/depths/{depth}

Path parameters

layerIdstring 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.

versioninteger required

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

quadKeystring required

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

depthinteger 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 parameters

context'default' | 'extension' | 'super'

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).
additionalFieldsstring[]

Additional fields - dataSize, checksum, compressedDataSize, crc.

billingTagstring

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.

Response

OK

checksumstring byte

The checksum of the data being indexed by this index record.

crcstring byte

The cyclic redundancy check (CRC) of the data being indexed by this index record.

fieldsobject

The indexing attributes for the data being indexed by this index record. The attributes must match the indexing attributes defined for the index layer. To get or set the index attributes for an index layer, use the config API.

idstring [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

The unique identifier (UUID) of the data being indexed by this index record.

metadataobject

User-defined fields that can store extra metadata about this index record.

sizeinteger

The size of the data being indexed by this index record.

Example response

{
  "checksum": "checksum",
  "crc": "crc",
  "fields": {
    "hour": 0,
    "tile": 377782527,
    "containsProbe": true,
    "eventType": "vss"
  },
  "id": "7a320ce9-e4d0-4d74-9c7a-19810f99a3a1",
  "metadata": {
    "ingestionTime": "1532018660873"
  },
  "size": 100
}