Create metadata

POST

/v2/metadata

• Staging
• Development

Create new metadata records for aggregates.

Authorizations

• X-API-Key
• X-API-Secret

Parameters

Header Parameters

X-API-Key

string

API Key

X-API-Secret

string

API Secret

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

e271bc5c-f870-44cd-8462-54280d0411f6

metadata

required

Array of metadata items for this aggregate

Array<object>

object

typeId

required

The type ID for this metadata item

string format: uuid

e271bc5c-f870-44cd-8462-54280d0411f6

value

required

The value of the metadata item (can be string, number, boolean, or array)

object

{
  "value": "Sample metadata value"
}

Responses

201

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

e271bc5c-f870-44cd-8462-54280d0411f6

metadata

required

Array of metadata items for this aggregate

Array<object>

object

id

required

The query ID for the created metadata

string

e271bc5c-f870-44cd-8462-54280d0411f6

aggregateId

required

The aggregate ID for this metadata item

string format: uuid

e271bc5c-f870-44cd-8462-54280d0411f6

value

required

The value of the metadata

string

Sample value

key

required

The key of the metadata

string

e271bc5c-f870-44cd-8462-54280d0411f6

description

required

The description of the metadata

string

Sample description

displayName

required

The display name of the metadata

string

Sample display name

[
  {
    "aggregateId": "e271bc5c-f870-44cd-8462-54280d0411f6",
    "metadata": [
      {
        "id": "987fcdeb-51a2-43d1-9f12-345678901234",
        "aggregateId": "e271bc5c-f870-44cd-8462-54280d0411f6",
        "value": "Some value",
        "key": "user_preferences",
        "description": "Stores user preferences",
        "displayName": "User Preferences"
      }
    ]
  }
]

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error