Skip to content

List metadata

POST
/v2/metadata/{metadataId}/list

List metadata records for an aggregate with pagination.

metadataId
required
string

The ID of the metadata

Example
88f39775-01f6-43ef-b553-08410c588116
X-API-Key
string

API Key

X-API-Secret
string

API Secret

object
number
required

Page number for pagination

number
1
size
required

Page size for pagination

number
10

List of metadata records with pagination.

object
metadata
required

Array of metadata items

Array<object>
object
id
required

The query ID for the created metadata

string
88f39775-01f6-43ef-b553-08410c588116
value
required

The value of the metadata

string
Sample value
key
required

The key of the metadata

string
88f39775-01f6-43ef-b553-08410c588116
description
required

The description of the metadata

string
Sample description
displayName
required

The display name of the metadata

string
Sample display name
page
required

Pagination information

object
number
required

The current page number.

number
1
size
required

The number of items per page.

number
10
totalPages
required

The total number of pages available.

number
100
totalCount
required

The total number of items available.

number
1000
hasNext
required

Indicates whether there is a next page available.

boolean
true
hasPrev
required

Indicates whether there is a previous page available.

boolean
true