Skip to content

Find metadata

POST
/v2/metadata/find

Find metadata by aggregate ID and type ID with pagination.

X-API-Key
string

API Key

X-API-Secret
string

API Secret

object
aggregateId
required

The aggregate ID to search for

string format: uuid
0ebec69f-cde5-4abf-83eb-595f8f023c80
typeId
required

The key of the metadata

string format: uuid
0ebec69f-cde5-4abf-83eb-595f8f023c80
number
required

Page number for pagination

number
1
size
required

Page size for pagination

number
10

List of metadata items with pagination.

object
items
required

Metadata items

Array<object>
object
id
required

The query ID for the created metadata

string
0ebec69f-cde5-4abf-83eb-595f8f023c80
aggregateId
required

The aggregate ID for this metadata item

string format: uuid
0ebec69f-cde5-4abf-83eb-595f8f023c80
value
required

The value of the metadata

string
Sample value
key
required

The key of the metadata

string
0ebec69f-cde5-4abf-83eb-595f8f023c80
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