ORB360 DAM DOCS
HomeLogin
  • 🚀Getting Started
  • EMBED
    • Single 360 - Hosted
    • Multiple 360 - Hosted
    • Advanced 360 - Hosted
    • 360 Player - Custom
  • API REFERENCE
    • Introduction
    • Specification
    • Authentication
  • ENDPOINTS
    • Integration
    • Integration - JOOR
    • Tenant
    • Shoot
    • Media
    • Tag
    • Image
Powered by GitBook
On this page

Was this helpful?

  1. ENDPOINTS

Tag

PreviousMediaNextImage

Last updated 1 year ago

Was this helpful?

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

  • PUTCreate (or update) Tag
  • DELETEDelete Tag

Create (or update) Tag

put

Create or update a Tag on the requested Media

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
tagsall ofOptional

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

Responses
200
success
application/json
400
bad request
application/json
401
unauthorized
application/json
404
not found
application/json
put
PUT /api/tenant/{tenantId}/shoot/{shootId}/media/{mediaId}/tags HTTP/1.1
Host: api.orb360.tech
Content-Type: application/json
Accept: */*
Content-Length: 11

{
  "tags": []
}
{
  "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
      }
    ]
  }
}

Delete Tag

delete

Delete a Tag from it's associated Media

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
tagsall ofOptional

Tag key-pairs to be removed from the specified media

Responses
200
success
application/json
400
bad request
application/json
401
unauthorized
application/json
404
not found
application/json
delete
DELETE /api/tenant/{tenantId}/shoot/{shootId}/media/{mediaId}/tags HTTP/1.1
Host: api.orb360.tech
Content-Type: application/json
Accept: */*
Content-Length: 11

{
  "tags": []
}
{
  "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
      }
    ]
  }
}