If this content did not answer your questions, try searching or contacting our support team for further assistance.
acquia-dam-sdk / Components / MetadataApi
new MetadataApi(
client):MetadataApi
Create an instance of the MetadataApi class.
These endpoints allow you to retrieve or modify information about existing metadata fields. If you want to retrieve or modify metadata applied to a specific asset, use the AssetsApi
Provide an instance of ApiClient.
addValue(
params):Promise<void>
Add a value to a controlled metadata field's vocabulary
Information about the request
Promise<void>
Promise containing no data
https://widenv2.docs.apiary.io/#reference/metadata/controlled-vocabulary/add-value
deleteValue(
displayKey,value):Promise<void>
Remove a value from a controlled metadata field's vocabulary
string
Display key of the controlled vocabulary metadata field
string
The controlled vocabulary value you wish to remove
Promise<void>
Promise containing no data
https://widenv2.docs.apiary.io/#reference/metadata/controlled-vocabulary/delete-value
getValue(
displayKey,value):Promise<GetMetadataFieldValueResult>
Get details for a single controlled vocabulary value
string
Display key of the controlled vocabulary metadata field
string
The controlled vocabulary value
Promise<GetMetadataFieldValueResult>
Promise containing information for the metadata field value
https://widenv2.docs.apiary.io/#reference/metadata/controlled-vocabulary/retrieve-single-value
listFieldValues(
displayKey):Promise<ListFieldValuesResult>
Retrieve a list of controlled vocabulary metadata values
string
Display key of the controlled vocabulary metadata field
Promise<ListFieldValuesResult>
Promise containing the vocabulary for the given field
https://widenv2.docs.apiary.io/#reference/metadata/controlled-vocabulary/list-values
listMetadataTypes():
Promise<ListMetadataTypesResult>
Retrieves the list of all MetadataTypes in the system. In addition to the Type's name and use, a listing of all that Type's MetadataFields is provided. For MetadataFields with a controlled list of options, each value is also provided.
Promise<ListMetadataTypesResult>
Promise containing a list of metadata types
https://widenv1.docs.apiary.io/#reference/metadata/metadata-types-list/metadata-types-list
listViewableFields(
params?):Promise<ListViewableMetadataFieldsResult>
Query for a list of metadata fields that you have permission to see
ListViewableMetadataFieldsParams
Information about the request
Promise<ListViewableMetadataFieldsResult>
Promise containing information for the desired metadata fields
https://widenv2.docs.apiary.io/#reference/metadata/fields/viewable
updateValue(
params):Promise<void>
Update the display value or the index (or both) of a controlled metadata field value
UpdateMetadataFieldValueParams
Information about the request
Promise<void>
Promise containing no information
https://widenv2.docs.apiary.io/#reference/metadata/controlled-vocabulary/update-value