Skip to content

Get metadata

GET
/v2/metadata/{metadataId}

Get a metadata record by its ID.

metadataId
required
string format: uuid

The ID of the metadata

Example
82c4fce1-d2c7-48cb-a647-6993dbe37819

The metadata record details.

object
id
required

The query ID for the created metadata

string
82c4fce1-d2c7-48cb-a647-6993dbe37819
aggregateId
required

The aggregate ID for this metadata item

string format: uuid
82c4fce1-d2c7-48cb-a647-6993dbe37819
value
required

The value of the metadata

string
Sample value
key
required

The key of the metadata

string
82c4fce1-d2c7-48cb-a647-6993dbe37819
description
required

The description of the metadata

string
Sample description
displayName
required

The display name of the metadata

string
Sample display name

Bad Request

Unauthorized

Forbidden

Not Found

Internal Server Error