Skip to main content

Get metadata from a unit card

Service endpoint are subject to change

Method Description#

Get metadata for a given unit card.

note

This route allows to filter the response by.

  • Specific key
  • Organization
  • metaType flag

For more information, Metadata model

HTTP Request#

GET https://api.olyn.com/v1/unit-cards/<unit_card_id>/metadata/

URL Parameters#

unit_card_id required#

String

The id of the unit card to be retrieved. This must be in string format compliant with ObjectId format.

note

An ObjectId is a 12-byte unique identifier consisting of:

A 4-byte value representing the seconds since the Unix epoch, a 5-byte random value, a 3-byte counter, starting with a random value.


key optional#

String

Metadata key to retrieve from unit card.

This key is unique per unit card and organization, can be multiple metadata with the same key from different organizations.


createdBy optional#

String

Organization that creates the metadata resource in the unit card.


metaType optional#

String

Flag to search for within all metadata resources from the same unit card.


Body Parameters#

None

Sample Code#

url = "https://api.olyn.com/v1/unit-cards/617d65b93d30a7b2263fc50f/metadata/?metaType=PRICE"
response = requests.request("GET", url, headers=headers)
print(response.text)

Returns#

Returns an array of Metadata objects.