Retrieve searchable DAM asset context

Request

Retrieves the taxonomies, fields, data sources, relations, renditions, and usage-rights dimensions available for DAM asset search and response expansion, derived from the M.Asset definition, localized to the requested culture. This context covers asset members only.

The include parameter accepts the following parameters:

  • taxonomies
  • fields
  • dataSources
  • relations
  • renditions
  • usageRights

If the include parameter is omitted, the response contains taxonomy metadata and instance capabilities. Request additional sections explicitly, for example include=taxonomies,fields. To retrieve all sections, specify taxonomies,fields,dataSources,relations,renditions,usageRights. Request only the sections you need to limit response size. Before filtering assets by usage rights, check that capabilities.usageRights is true and request the usageRights section to discover supported dimensions.

Security
OAuth2
Query
culturestring

Culture/language code used to localize labels, for example en-US. Accepts a single culture code. Defaults to the caller's preferred culture, falling back to en-US.

Example:culture=en-US
includeArray of strings

Section names to return, sent as one comma-separated value, for example include=taxonomies,fields. Omitted or empty returns taxonomies only; name every section to receive all of them. An unknown name returns 400 UNKNOWN_INCLUDE with the offending value and the valid names in invalidParams.

Default:["taxonomies"]
Items Enum:"taxonomies""fields""dataSources""relations""renditions""usageRights"
Example:include=taxonomies&include=fields
curl -i -X GET \
  'https://your-server/api/v1/dam/assets/context?culture=en-US&include=taxonomies%2Cfields' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successful operation

Bodyapplication/json
includeArray of stringsrequired

Contains the effective section selection. Defaults to taxonomies when the request's include parameter is omitted.

Items Enum:"taxonomies""fields""dataSources""relations""renditions""usageRights"
culturestring

The culture used to localize the returned context, for example en-US.

taxonomiesArray of objects(DamAssetContextTaxonomy)

Taxonomies available for filtering or expanding assets. Absent when not selected by include.

fieldsArray of objects(DamAssetContextField)

Fields available for filtering or expanding assets. Absent when not selected by include.

dataSourcesArray of objects(DamAssetContextDataSource)

Data sources available for filtering or expanding assets. Absent when not selected by include.

relationsArray of objects(DamAssetContextRelation)

Relations available for filtering or expanding assets. Absent when not selected by include.

renditionsArray of objects(DamAssetContextRendition)

Renditions available for asset response expansion. Absent when not selected by include.

usageRightsobject(DamAssetContextUsageRights)

Usage-rights dimensions a scenario can constrain. Absent when not selected by include. Selected but unavailable returns an empty constraints array. Dimensions omitted from a scenario are not checked. When capabilities.usageRights is true, a scenario can filter by dates only even if no dimensions are advertised.

capabilitiesobject(DamAssetContextCapabilities)
Response
{ "culture": "string", "include": [ "taxonomies" ], "taxonomies": [ { … } ], "fields": [ { … } ], "dataSources": [ { … } ], "relations": [ { … } ], "renditions": [ { … } ], "usageRights": { "constraints": [ … ] }, "capabilities": { "visualSearch": true, "imageTagging": true, "usageRights": true } }