If this content did not answer your questions, try searching or contacting our support team for further assistance.
acquia-dam-sdk / AcquiaDAM
new AcquiaDAM(
params?):AcquiaDAM
Create an instance of the Acquia DAM Module.
Provides access to all Acquia DAM API functions.
Information for creating the client
set accessToken(
token):void
Set the client's access token.
string
void
get analytics():
AnalyticsApi
Retrieve an instance of the AnalyticsApi class.
The Analytics endpoints provide information about asset usage from the Insights application. The API will return download, view, and share details for a single asset.
Events may take up to 24 hours before appearing in analytics API results.
Note: Three years of analytics data is available, starting from January 1, 2021 onward. The default date_range filter is from this date until today.
get assets():
AssetsApi
Retrieve an instance of the AssetsApi class.
Asset objects represent stored files in the DAM system. The API allows you to create, update, and delete Assets. You can search for assets, matching specific search criteria or load an individual asset by unique ID.
get attributes():
AttributesApi
Retrieve an instance of the AttributesApi class.
The Attributes API lists all product attributes that have been configured in Entries, and all controlled vocabulary values for any single-select or multi-select attribute.
get categories():
CategoriesApi
Retrieve an instance of the CategoriesApi class.
Provides information about Categories and the Assets contained in them.
get client():
ApiClient
Retrieve the ApiClient instance.
get collections():
CollectionsApi
Retrieve an instance of the CollectionsApi class.
Provides information about global, shared, and private Collections.
get metadata():
MetadataApi
Retrieve 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.
get orders():
OrdersApi
Retrieve an instance of the OrdersApi class.
Provides information about Orders and Conversions.
get products():
ProductsApi
Retrieve an instance of the ProductsApi class.
The Products API provides access to product information stored in Acquia Entries. The API allows you to create, retrieve, delete, and update products.
get searchConnector():
SearchConnectorApi
Retrieve an instance of the SearchConnectorApi class.
The Instant Search Connector allows external applications access to Acquia DAM Asset search, without having to implement a native search UI.
get usage():
UsageApi
Retrieve an instance of the UsageApi class.
Retrieve information about the monthly usage of the API.
get users():
UsersApi
Retrieve an instance of the UsersApi class.
Query for information about users.
get webhooks():
WebhooksApi
Retrieve an instance of the WebhooksApi class.
Create, list, read, ping, edit, and delete Acquia DAM webhook configurations. Create, List, and Delete Workflow Webhooks
get workflow():
WorkflowApi
Retrieve an instance of the WorkflowApi class.
Workflow objects represent projects and deliverables stored in the Acquia Workflow system. The API allows you to retrieve, create, delete, and close deliverables and projects.