If this content did not answer your questions, try searching or contacting our support team for further assistance.
acquia-dam-sdk / Components / CategoriesApi
new CategoriesApi(
client):CategoriesApi
Create an instance of the CategoriesApi class
Provides information about Categories and the Assets contained in them
Provide an instance of ApiClient.
addOrRemoveAsets(
params):Promise<void>
Add or remove multiple assets from multiple categories
Information about the request
Promise<void>
Promise containing no information
https://widenv1.docs.apiary.io/#reference/categories/category-assets/adding/removing-assets
createCategory(
params):Promise<CreateEditCategoryResult>
Create a new category
Information about the request
Promise<CreateEditCategoryResult>
Promise containing information about the new category
https://widenv1.docs.apiary.io/#reference/categories/createedit-category/create-category
editCategory(
params):Promise<CreateEditCategoryResult>
Update a category's information
Information about the request
Promise<CreateEditCategoryResult>
Promise containing information about the modified category
https://widenv1.docs.apiary.io/#reference/categories/createedit-category/edit-category
encodeCategoryPath(
path):string
URL-encodes symbols in the path. Escaped slashes are treated as part of the category's name.
string
The category path
string
src/apis/categories/api.ts:135
getCategoryTree(
includeEmpty?):Promise<CategoryTreeResult>
Gets the category tree sctructure for the entire site
boolean
true if the response should include categories with no assets.
Promise<CategoryTreeResult>
Promise containing the category tree structure
https://widenv1.docs.apiary.io/#reference/categories/category-tree/category-tree
listCategories(
categoryPath?):Promise<ListCategoriesResult>
Retrieve a list of child categories.
string
Optional parent category path. Slashes in category names must be escaped with a backslash. If omitted, the top-level categories will be returned.
Promise<ListCategoriesResult>
Promise containing a list of asset categories
https://widenv2.docs.apiary.io/#reference/categories/asset-categories/list-asset-categories