Skip to content
Getting Started
/
/
/
Get Controlled Vocabulary

API Endpoint Reference (1.5)

Tenovos has introduced version 1.5 to provide non-breaking improvements over previous versions.

Key Changes:

  • Authentication Standards now include OAuth2 code flow.
  • Client ID is no longer required to be passed when requesting an Authorization token using our Standard Auth from v1.4
  • New endpoints have been added and will continue to be added until v2 is generally available to all customers.
    • Adaptive Template endpoints
    • A new Get Asset endpoint with a simplified Response
    • A new Create Asset endpoint with simplified payloads for the Request and Response
    • A new Update Asset endpoint with simplified payloads for the Request and Response
    • Metadata Admin API endpoints for managing Attributes, Groups, and Templates
  • We've made some performance improvements to most endpoints
Find out more about Tenovos
Download OpenAPI description
v1.5.json
v1.5.yaml
Overview
E-mail
product@tenovos.com
License
Tenovos Active Story Management
Terms of Service
Languages
Servers
https://api.uat.tenovos.io/v1
https://api.tenovos.io/v1

ACTIONS

Invoke the Action API to retrieve information about invoked Actions.

Operations

ADAPTIVE TEMPLATES

Invoke the API to retrieve information about invoked Actions.

Operations

ASSETS

Invoke the Asset API to create, retrieve, manipulate, and share Assets. This API also provides operations to manage Asset relationships and download Asset content.

Operations

AUTHENTICATION

Invoke the Authentication API to generate, refresh, and revoke access tokens. An access token is required to perform any authorized API operation.

Operations

CDN (Coming Soon!)

Tenovos Content Delivery Network (CDN) - Coming Soon!

Tenovos CDN: Pull Zone Overview

Tenovos CDN provides global content acceleration and optimization through a pull zone architecture, ensuring that your assets are delivered to end users with maximum speed, reliability, and efficiency. A Content Delivery Network (CDN) works by caching static content—such as images, videos, and other media—on servers distributed across the globe. When an asset is requested, the CDN serves it from the nearest edge location, reducing load times and offloading traffic from the origin server, which in this case is Tenovos DAM.

A pull zone is the core mechanism that powers this system. It automatically fetches content from the origin the first time it is requested, then caches it at the edge. Subsequent requests are served directly from the CDN cache, improving response times and reducing bandwidth consumption.

Through the Tenovos CDN API, you can create, update, and manage pull zones programmatically. Pull zones support advanced features such as global edge caching, cache purging, bandwidth controls, and real-time performance statistics like cache hit rate and geographic request distribution. Optional optimization settings allow you to enhance performance further by enabling image compression, WebP and AVIF support, and content minification.

With just a few API calls, you can fully integrate high-performance content delivery into your Tenovos workflows—no complex infrastructure required.

Operations

COLLECTIONS

Invoke the Collection API to create, retrieve, edit, and delete Collections. Collections are used to group and catalog related Assets for quick access and consumption. Collections can be configured as:

  • private: Visible only to the user who created the Collection.
  • secured: Visible to users with.

When retrieving the Assets within a Collection, the requesting user will only see the Assets that the user has access to view. For example, a librarian may see all Assets within a Collection, but a general consumer user may only see a portion of those Assets, due to limited security access.

Operations

METADATA

Invoke the Metadata API to manage Metadata Attributes, Groups, and Templates. A Metadata Template defines a set of Metadata Attributes of varying types, including Text, Date, Controlled Vocabulary, Tabular, and Cascading Attributes. When a Metadata Template is assigned to a new Asset, the corresponding Metadata Attributes will be available for population on the Asset.

Admin Endpoints (NEW!): Create, read, update, and delete Metadata Attributes and Metadata Groups. These endpoints require the Metadata Management admin privilege.

Operations

Create Controlled Vocabulary

Request

Create a Controlled Vocabulary. User must have permission to create a controlled vocabulary.

Response will contain the object of the metadata definition attributes, such as id, name, type and search fields, etc.

Average Response Time: 585ms

Security
ApiKeyAuth or BasicAuth
Headers
X-API-Keystringrequired

Customer-specific API key required to invoke API.

Authorizationstringrequired

Provided by Authentication Token creation operation

Content-Typestringrequired
Value"application/json"
Bodyapplication/jsonrequired
namestring

Vocabulary Name

Example: "Color List"
valuesArray of strings

List of vocabulary values

Example: ["Red","Blue"]
curl -i -X POST \
  https://api.uat.tenovos.io/v1/metadata/vocabulary \
  -H 'Authorization: string' \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -d '{
    "name": "Color List",
    "values": [
      "Red",
      "Blue"
    ]
  }'

Responses

The Response Body is a JSON object.

Bodyapplication/json
createdEpochinteger

Create time in milliseconds

Example: 1613877219787
customerIdstring

Customer Id

Example: "157167185123342"
lastUpdatedEpochinteger

Update time in milliseconds

Example: 1613877219787
metadataDefinitionIdstring(uuid)

Field ID

Example: "6c921f5c-24c2-40b9-8718-3ad2d4a6be54"
metadataDefinitionNamestring

Field Name

Example: "Colors"
metadataDefinitionSearchFieldstring

Map search field for this metadata definition

Example: "colors"
metadataDefinitionTypestring
Example: "controlledVocabulary"
metadataDocumentobject(ControlledVocabulary_metadata)

Vocabulary metadata

Response
application/json
{
  "createdEpoch": 1613877219787,
  "customerId": "157167185123342",
  "lastUpdatedEpoch": 1613877219787,
  "metadataDefinitionId": "6c921f5c-24c2-40b9-8718-3ad2d4a6be54",
  "metadataDefinitionName": "Colors",
  "metadataDefinitionSearchField": "colors",
  "metadataDefinitionType": "controlledVocabulary",
  "metadataDocument": {
    "values": [ … ],
    "searchable": true
  }
}

Get Controlled Vocabulary

Request

Retrieve the Controlled Vocabulary and its attributes by Controlled Vocabulary Id

In response, it will contain the list of metadata key/value pair and metadata definition attributes like id, name, type and search fields etc.

Average Response Time: 472ms

Security
ApiKeyAuth or BasicAuth
Path
idstringrequired

Specify a Controlled Vocabulary ID.

Headers
X-API-Keystringrequired

Customer-specific API key required to invoke API.

Authorizationstringrequired

Provided by Authentication Token creation operation

curl -i -X GET \
  'https://api.uat.tenovos.io/v1/metadata/vocabulary/{id}' \
  -H 'Authorization: string' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

The Response Body will be a JSON object

Bodyapplication/json
createdEpochinteger

Create time in milliseconds

Example: 1613877219787
customerIdstring

Customer Id

Example: "157167185123342"
lastUpdatedEpochinteger

Update time in milliseconds

Example: 1613877219787
metadataDefinitionIdstring(uuid)

Field ID

Example: "6c921f5c-24c2-40b9-8718-3ad2d4a6be54"
metadataDefinitionNamestring

Field Name

Example: "Colors"
metadataDefinitionSearchFieldstring

Map search field for this metadata definition

Example: "colors"
metadataDefinitionTypestring
Example: "controlledVocabulary"
metadataDocumentobject(ControlledVocabulary_metadata)

Vocabulary metadata

Response
application/json
{
  "createdEpoch": 1613877219787,
  "customerId": "157167185123342",
  "lastUpdatedEpoch": 1613877219787,
  "metadataDefinitionId": "6c921f5c-24c2-40b9-8718-3ad2d4a6be54",
  "metadataDefinitionName": "Colors",
  "metadataDefinitionSearchField": "colors",
  "metadataDefinitionType": "controlledVocabulary",
  "metadataDocument": {
    "values": [ … ],
    "searchable": true
  }
}

Delete Controlled Vocabulary

Request

Delete a Controlled Vocabulary.

Average Response Time: 130ms

Security
ApiKeyAuth or BasicAuth
Path
idstringrequired

Specify a Controlled Vocabulary ID.

Headers
X-API-Keystringrequired

Customer-specific API key required to invoke API.

Authorizationstringrequired

Provided by Authentication Token creation operation

curl -i -X DELETE \
  'https://api.uat.tenovos.io/v1/metadata/vocabulary/{id}' \
  -H 'Authorization: string' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

Successful operation

Bodyapplication/json
statusstring
Example: "success"
messagestring
Example: "Detailed Message"
Response
application/json
{
  "status": "success",
  "message": "Metadata Definition delete operation succeeded"
}

REQUESTS

Invoke these API's to create new Requests and manage existing Requests.

Operations

SECURITY

Invoke the Metadata API to retrieve Security Template information to be applied to Assets during Asset creation or edit.

Operations

PEOPLE

Invoke the User API to retrieve User profile information.

Operations

WEBHOOKS

Tenovos Webhook Subscriptions

For more information about our Webhooks, see the Webhook section of our Developer Portal

Operations

PROOFING

Operations