Create metadata
POST /v2/metadata
POST
/v2/metadata
Create new metadata records for aggregates.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Header 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
aggregates
required
Array of metadata aggregates to create
Array<object>
object
aggregateId
required
The aggregate ID for this metadata group
string format: uuid
0ebec69f-cde5-4abf-83eb-595f8f023c80 metadata
required
Array of metadata items for this aggregate
Array<object>
object
typeId
required
The type ID for this metadata item
string format: uuid
0ebec69f-cde5-4abf-83eb-595f8f023c80 value
required
The value of the metadata item (can be string, number, boolean, or array)
object
Sample metadata valueResponses
Section titled “ Responses ”Comma-separated list of created metadata IDs.
object
aggregates
required
Array of aggregates with their metadata
Array<object>
object
aggregateId
required
The aggregate ID
string format: uuid
0ebec69f-cde5-4abf-83eb-595f8f023c80 metadata
required
Array of metadata items for this aggregate
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[ { "aggregateId": "0ebec69f-cde5-4abf-83eb-595f8f023c80", "metadata": [ { "id": "987fcdeb-51a2-43d1-9f12-345678901234", "value": "Some value", "key": "user_preferences", "description": "Stores user preferences", "displayName": "User Preferences" } ] }]Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error