Gets metadata for the requested partitions

get

https://use.apilookup.for.a.base.url/layers/{layerId}/partitions

Gets metadata for specific partition ids. If the layer specified in the request does not exist, the request results in an error. If a partition specified in the request does not exist, the response does not include this partition. Maximum allowed number of partitions ids per call is 100.

Path Params

layerId

string

required

The ID of the layer specified in the request. The content of this parameter must refer to a valid layer already configured in the catalog configuration. You can specify multiple partitions by using this parameter multiple times.

Query Params

partition

array of strings

required

Partition ids to use for filtering. You can specify multiple partitions by using this parameter multiple times. Maximum allowed partitions ids per call is 100.

partition*

version

string

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

context

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:

Context	Description
default	The 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.
extension	The operation will be executed only in the extension and no operation will be performed in the extended layer.
super	The operation will be executed only in the layer being extended (super layer).

Allowed:

additionalFields

array of strings

Additional fields - dataSize, checksum, compressedDataSize, crc.

additionalFields

billingTag

string

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.

Responses

400

Required parameters are missing

401

Unauthorized

403

Forbidden

404

Catalog or layer does not exist

200OK - Your search for partitions is a valid request.