Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Widen Metadata API

Manage metadata fields and controlled vocabulary values.

Widen Metadata API is one of 17 APIs that Widen publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Metadata. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 7 operations across 4 paths, and defines 4 schemas. It is described by OpenAPI 3.0.3, at version 2.0.

Requests are made against 2 base URLs: https://api.widencollective.com/v2, https://api.widencollective.com/v1.

7 operations 4 paths 4 schemas 1 DELETE4 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
2.0
Base URL
https://api.widencollective.com/v2
Authentication
HTTP Bearer
License
Proprietary
Resource Areas
1

Authentication & Security 1

Widen Metadata API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — OAuth2 Bearer token obtained from Acquia DAM.

Paths & Operations 7

Across 4 paths, the API surfaces 7 operations — 1 DELETE, 4 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Metadata 7

Manage metadata fields and controlled vocabulary values.

GET
/metadata/fields/viewable
List viewable metadata fields
listMetadataFields 4 params → 200
GET
/metadata/{displayKey}/vocabulary
List controlled vocabulary values for a metadata field
listControlledVocabularyValues 1 param → 200
POST
/metadata/{displayKey}/vocabulary
Add a controlled vocabulary value
addControlledVocabularyValue 1 param body → 204
GET
/metadata/{displayKey}/vocabulary/{value}
Get a controlled vocabulary value
getControlledVocabularyValue 2 params → 200
PUT
/metadata/{displayKey}/vocabulary/{value}
Update a controlled vocabulary value
updateControlledVocabularyValue 2 params body → 204
DELETE
/metadata/{displayKey}/vocabulary/{value}
Delete a controlled vocabulary value
deleteControlledVocabularyValue 2 params → 204
GET
/metadata/types
List all metadata types (v1)
getMetadataTypes → 200

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are MetadataFieldValue (3 properties), ListFieldValuesResult (2 properties), ListMetadataTypesResult (1 property), ListViewableMetadataFieldsResult (1 property). Each schema is shown below with its type and property counts.

ListViewableMetadataFieldsResult
object
1 property
MetadataFieldValue
object
3 properties
ListMetadataTypesResult
object
1 property
ListFieldValuesResult
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

widen-metadata-api-openapi.yml Raw ↑

Other APIs Widen publishes across the network.

Widen Acquia-DAM-Webhooks API
Widen Analytics API
Widen Assets API
Widen Attributes API
Widen Categories API
Widen Channels API
Widen Collections API
Widen File-Formats API
Widen Integration-Links API
Widen Orders API
Widen Products API
Widen Search-Connector API