List metadata
POST /v2/metadata/{metadataId}/list
POST
/v2/metadata/{metadataId}/list
List metadata records for an aggregate with pagination.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” metadataId
required
string format: uuid
The ID of the metadata
Example
77a0049c-7683-45ff-956f-656f257048f7Header Parameters
Section titled “Header Parameters ” X-API-Key
string
API Key
X-API-Secret
string
API Secret
Request Body required
Section titled “Request Body required ”object
number
required
Page number for pagination
number
1 size
required
Page size for pagination
number
10Responses
Section titled “ Responses ”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
77a0049c-7683-45ff-956f-656f257048f7 aggregateId
required
The aggregate ID for this metadata item
string format: uuid
77a0049c-7683-45ff-956f-656f257048f7 value
required
The value of the metadata
string
Sample value key
required
The key of the metadata
string
77a0049c-7683-45ff-956f-656f257048f7 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
Page number (starts at 1)
number
1 size
required
Items per page
number
10 totalPages
required
Total number of items
number
100 totalCount
required
Total number of pages
number
10 hasNext
required
Whether there is a next page
boolean
true hasPrev
required
Whether there is a previous page
boolean
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error