If this content did not answer your questions, try searching or contacting our support team for further assistance.
acquia-dam-sdk / Components / AssetsApi
new AssetsApi(
client):AssetsApi
Create 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.
Provide an instance of ApiClient.
addAssetToCategories(
params):Promise<void>
Add an asset to one or more categories. For bulk handling of assets, use the CategoriesApi.
Information about the request
Promise<void>
Promise containing no data
https://widenv1.docs.apiary.io/#reference/categories/category-assets/adding/removing-assets
addAssetToCollections(
params):Promise<void>
Add an asset to one or more collections. For bulk handling of assets, use the CollectionsApi.
Information about the request
Promise<void>
Promise containing no data
https://widenv1.docs.apiary.io/#reference/collections/collection-assets/adding/removing-assets
completeChunkedUpload(
params):Promise<CompleteChunkedUploadResult>
Call this after all file chunks have uploaded to signal the completion of a chunked upload session.
After calling this endpoint, provide the file_id to the create function to create a new asset.
Information about the request
Promise<CompleteChunkedUploadResult>
Promise containing the file_id
https://widenv2.docs.apiary.io/#reference/assets/upload-files-in-chunks/complete-chunked-upload
createAsset(
params):Promise<CreateAssetResult>
Create a new asset using a URL, file data, or a file_id provided by a chunked upload.
For larger files, use a chunked upload.
Information about the request
Promise<CreateAssetResult>
Promise containing the asset's id
https://widenv2.docs.apiary.io/#reference/assets/creating-new-assets/upload-a-file
deleteAlternatePreview(
params):Promise<void>
Remove an alternate preview from an asset.
Information about the request
Promise<void>
Promise containing no information
https://widenv2.docs.apiary.io/#reference/assets/alternate-preview/delete-alternate-preview
deleteAsset(
params):Promise<void>
Send an asset to the Pending Delete queue.
Information about the request
Promise<void>
Promise containing no information
https://widenv2.docs.apiary.io/#reference/assets/assets/delete
findAssetId(
params):Promise<string>
Find an asset's UUID by searching via filename or embed ID (external ID).
Information about the request
Promise<string>
Promise containing the asset's id
getAsset(
params):Promise<GetAssetResult>
Retrieve information about an individual asset.
Information about the request
Promise<GetAssetResult>
Promise containing the asset data
getMetadata(
params):Promise<GetMetadataResult>
Metadata subresource simply returns the metadata property of the asset.
The object structure returned by search endpoint and this method are identical.
All assigned fields for the asset will be included. Empty fields are repesented with an empty array.
Information about the request
Promise<GetMetadataResult>
Promise containing the asset's metadata only
https://widenv2.docs.apiary.io/#reference/assets/asset-metadata/retrieve-asset-metadata
getSecurity(
params):Promise<GetSecurityResult>
Security subresource simply returns the security property of the asset.
The object structure returned by search endpoint and this method are identical.
Information about the request
Promise<GetSecurityResult>
Promise containing the asset's security only
https://widenv2.docs.apiary.io/#reference/assets/asset-security/retrieve-asset-security
listAssetGroups():
Promise<ListAssetGroupsResult>
Get a list of Asset Groups that the calling User has permission to view.
Promise<ListAssetGroupsResult>
Promise containing a list of security groups
https://widenv2.docs.apiary.io/#reference/assets/asset-group-list/get-asset-groups
listCategories(
categoryPath?):Promise<ListCategoriesResult>
Retrieve a list of child categories.
string
Optional parent category name. 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
listCollections(
params):Promise<ListCollectionsResult>
Retrieve a list of collections.
Information about the request
Promise<ListCollectionsResult>
Promise containing a list of collections
https://widenv2.docs.apiary.io/#reference/collections/collections/list-collections
listFileFormats():
Promise<ListFileFormatsResult>
Retrieve a list of recognized file formats.
Promise<ListFileFormatsResult>
a Promise containing a list of file formats
https://widenv1.docs.apiary.io/#reference/file-formats/file-format-list/file-format-list
listIntegrationLinks():
Promise<ListIntegrationLinksResult>
Retrieve a list of integration links
Promise<ListIntegrationLinksResult>
a Promise containing a list of integration links
https://widenv1.docs.apiary.io/#reference/integration-links/integration-links/list-integration-links
listUploadProfiles():
Promise<ListUploadProfilesResult>
Retrieve a list of upload profiles.
Promise<ListUploadProfilesResult>
a Promise containing a list of Upload Profiles
https://widenv2.docs.apiary.io/#reference/assets/creating-new-assets/list-all-upload-profiles
listVersions(
params):Promise<ListVersionsResult>
Retrieve a list of asset versions.
Information about the request
Promise<ListVersionsResult>
Promise containing a list of asset versions
https://widenv1.docs.apiary.io/#reference/assets/asset-version-list/asset-version-list
registerIntegrationLink(
params):Promise<RegisterIntegrationLinkResult>
Register a new Integration Link.
Information about the request
Promise<RegisterIntegrationLinkResult>
a Promise containing information about the created Integration Link
removeAssetFromCatgories(
params):Promise<void>
Remove an asset from one or more categories. For bulk handling of assets, use the CategoriesApi.
Information about the request
Promise<void>
Promise containing no information
https://widenv1.docs.apiary.io/#reference/categories/category-assets/adding/removing-assets
removeAssetFromCollections(
params):Promise<void>
Remove an asset from one or more collections. For bulk handling of assets, use the CollectionsApi.
Information about the request
Promise<void>
Promise containing no information
https://widenv1.docs.apiary.io/#reference/collections/collection-assets/adding/removing-assets
removeIntegrationLink(
uuid):Promise<void>
Remove an integration link.
string
The Integration Link UUID
Promise<void>
a Promise containing no information
renameAsset(
params):Promise<void>
Change an asset's filename
Information about the request
Promise<void>
Promise containing no information
https://widenv2.docs.apiary.io/#reference/assets/assets/rename
searchAssets(
params?):Promise<SearchAssetsResult>
Search for a list of assets via a query
Information about the request
Promise<SearchAssetsResult>
Promise containing a list of assets that meet the search criteria
https://widenv2.docs.apiary.io/#reference/assets/assets/list-by-search-query
startChunkedUpload():
Promise<StartChunkedUploadResult>
Begins a chunked uploading session. The session_id in the response must be used for subsequent upload chunk and complete chunk calls. This session_id is good for 7 days.
Promise<StartChunkedUploadResult>
Promise containing the session_id
https://widenv2.docs.apiary.io/#reference/assets/upload-files-in-chunks/start-chunked-upload
updateMetadata(
params):Promise<void>
Update an asset's metadata fields
Information about the request
Promise<void>
Promise containing no information
https://widenv2.docs.apiary.io/#reference/assets/asset-metadata/update-metadata
updateMetadataType(
params):Promise<void>
Change an asset's metadata type
Information about the request
Promise<void>
Promise containing no information
https://widenv1.docs.apiary.io/#reference/assets/metadata-type/update-metadata-type
updateSecurity(
params):Promise<void>
Update an asset's security fields
Information about the request
Promise<void>
Promise containing no information
https://widenv2.docs.apiary.io/#reference/assets/asset-security/update-security
uploadAlternatePreview(
params):Promise<void>
Upload a new file as an alternate preview to an Asset
Information about the request
Promise<void>
Promise containing no information
https://widenv2.docs.apiary.io/#reference/assets/alternate-preview/upload-alternate-preview
uploadChunk(
params):Promise<UploadChunkResult>
Upload each piece of the file. The tag in each Upload Chunk response must be used in the Complete Chunked Upload call
Information about the request
Promise<UploadChunkResult>
Promise containing the tag for the chunk
https://widenv2.docs.apiary.io/#reference/assets/upload-files-in-chunks/upload-chunk