Tag

Tags are free key-value pair metadata which can be associated with media in order to categorise and perform lookups against integration API endpoints.

PreviousMedia NextImage

Last updated 1 year ago

Was this helpful?

Create (or update) Tag

Create or update a Tag on the requested Media

put

/api/tenant/{tenantId}/shoot/{shootId}/media/{mediaId}/tags

Authorizations

Path parameters

shootIdstringrequired

Unique shoot id

Example: 683606ee-9788-4d88-adb8-77119de4c6a2

tenantIdstringrequired

Unique tenant id

Example: f700d27e-64ed-4571-ae2e-8c948c1c296e

mediaIdstringrequired

Unique media id

Example: daea0774-275b-4e43-9d10-c2f9d5d4d5b6

Body

tagsarray

Tag key-pairs to be created/replaced for the specified media

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'https://api.orb360.tech/api/tenant/{tenantId}/shoot/{shootId}/media/{mediaId}/tags' \
  --header 'Content-Type: application/json' \
  --data '{"tags":[]}'

200

400

401

404

{
  "tags": {
    "ANY_ADDITIONAL_PROPERTY": [
      {
        "keyValue": "STYLENUMBER-COLOURNAME:12345$BLACK",
        "key": "StyleNumber-ColourName",
        "value": "12345$BLACK",
        "updatedBy": "auth0|dd5e21fb23efe45d1761ddce",
        "createdBy": "auth0|dd5e21fb23efe45d1761ddce",
        "dateCreated": 1574782604487,
        "dateUpdated": 1574782604487
      }
    ]
  }
}

success

Delete Tag

Delete a Tag from it's associated Media

delete