Skip to content

Get metadata

GET
/v2/metadata/{metadataId}

Get a metadata record by its ID.

metadataId
required
string format: uuid
d24d70a9-e1e2-4e83-ac81-cf62c2cb4c09

The ID of the metadata

The metadata record details.

object
id
required

The query ID for the created metadata

string
d24d70a9-e1e2-4e83-ac81-cf62c2cb4c09
aggregateId
required

The aggregate ID for this metadata item

string format: uuid
d24d70a9-e1e2-4e83-ac81-cf62c2cb4c09
value
required

The value of the metadata

string
Sample value
key
required

The key of the metadata

string
d24d70a9-e1e2-4e83-ac81-cf62c2cb4c09
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