Sign in

v1

latestOpenAPI 3.0.12026-07-24110189356.6 KB
metadata

Gets partitions

Gets the metadata for all partitions in a specific layer.

get/layers/{layerId}/partitions

Path parameters

layerIdstring required

Unique layer ID. Content of this parameter must refer to a valid layer ID.

Query parameters

versioninteger

If metadata is being gotten from a versioned layer, specify the version of the target layer. This parameter is required for versioned layers. If metadata is being gotten from another layer type, do not specify this parameter.

partstring

Available/Required for versioned layers only; indicates which part of the layer shall be queried.

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

Additional fields - dataSize, checksum, compressedDataSize, crc.

billingTagstring

Billing Tag is an optional free-form tag which is used for grouping billing records together. If supplied, it must be between 4 - 16 characters, contain only alpha/numeric ASCII characters [A-Za-z0-9]. Grouping billing records by billing tag will be available in future releases.

Headers

Rangestring

Use this parameter to resume download of a large response for versioned layers when there is a connection issue between the client and server. Specify a single byte range offset like this: Range: bytes=10-. This parameter is compliant with RFC 7233, but note that this parameter only supports a single byte range. The range parameter can also be specified as a query parameter, i.e. range=bytes=10-. For volatile layers use the pagination links returned in the response body.

Response

OK

nextstring uri

If the number of results exceeds the limit, then this uri will be present and will provide the path to the next batch of results.

Example response

{
  "partitions": [
    {
      "layer": "test-layer",
      "checksum": "291f66029c232400e3403cd6e9cfd36e",
      "compressedDataSize": 1024,
      "dataHandle": "1b2ca68f-d4a0-4379-8120-cd025640510c",
      "dataSize": 1024,
      "crc": "c3f276d7",
      "partition": "314010583",
      "version": 1
    }
  ],
  "next": "/uri/to/next/page"
}