Skip to main content
Server path: /adobe-experience-manager-assets | Type: Application | PCID required: Yes

Tools

ToolDescription
adobe_experience_manager_assets_create_asset_relationsCreate new asset relations for an asset
adobe_experience_manager_assets_delete_assetDelete asset
adobe_experience_manager_assets_delete_asset_relationDelete an asset relation for an asset
adobe_experience_manager_assets_delete_asset_relations_for_relation_typeDelete all asset relations of the given relation type for an asset
adobe_experience_manager_assets_get_assetGet an asset
adobe_experience_manager_assets_get_asset_job_statusGet the status of an async job
adobe_experience_manager_assets_get_asset_metadataDelivers the specified asset’s metadata
adobe_experience_manager_assets_get_asset_originalReturns the originally uploaded binary for the asset
adobe_experience_manager_assets_get_asset_relation_typesGet the relation types for an asset
adobe_experience_manager_assets_get_asset_relationsGet the asset relations for an asset
adobe_experience_manager_assets_get_asset_relations_for_relation_typeGet the asset relations for an asset filtered by relation type
adobe_experience_manager_assets_get_asset_renditionReturns a pre-generated (on AEM Assets authoring environment) rendition of the asset
adobe_experience_manager_assets_get_asset_renditionsReturns a list of static renditions of an asset
adobe_experience_manager_assets_get_import_job_resultGet Import Job Result
adobe_experience_manager_assets_get_import_job_statusGet Import Job Status
adobe_experience_manager_assets_import_from_urlImport From Url
adobe_experience_manager_assets_patch_asset_metadataUpdates the asset’s assetMetadata properties

adobe_experience_manager_assets_create_asset_relations

Create new asset relations for an asset Parameters:
ParameterTypeRequiredDefaultDescription
assetIdstringYesID of the asset to access
itemsany[]YesRelated assets to be added to the asset

adobe_experience_manager_assets_delete_asset

Delete asset Parameters:
ParameterTypeRequiredDefaultDescription
assetIdstringYesID of the asset
forcebooleanNoIf true, delete the asset even if it is referenced

adobe_experience_manager_assets_delete_asset_relation

Delete an asset relation for an asset Parameters:
ParameterTypeRequiredDefaultDescription
assetIdstringYesID of the asset to access
relationTypestringYesName of relation type for asset relation to be deleted.
relatedAssetIdstringYesID of the related asset to be deleted.

adobe_experience_manager_assets_delete_asset_relations_for_relation_type

Delete all asset relations of the given relation type for an asset Parameters:
ParameterTypeRequiredDefaultDescription
assetIdstringYesID of the asset to access
relationTypestringYesName of relation type

adobe_experience_manager_assets_get_asset

Get an asset Parameters:
ParameterTypeRequiredDefaultDescription
assetIdstringYesID of the asset

adobe_experience_manager_assets_get_asset_job_status

Get the status of an async job Parameters:
ParameterTypeRequiredDefaultDescription
jobIdstringYesID of an asynchronous job

adobe_experience_manager_assets_get_asset_metadata

Delivers the specified asset’s metadata Parameters:
ParameterTypeRequiredDefaultDescription
assetIdstringYesID of the asset to access

adobe_experience_manager_assets_get_asset_original

Returns the originally uploaded binary for the asset Parameters:
ParameterTypeRequiredDefaultDescription
assetIdstringYesID of the asset
seoNamestringYesany url-encoded or alphanumeric, non-whitespace set of characters. may contain hyphens and dots

adobe_experience_manager_assets_get_asset_relation_types

Get the relation types for an asset Parameters:
ParameterTypeRequiredDefaultDescription
assetIdstringYesID of the asset to access
limitintegerNoFor a paginated request, this parameter defines the maximum number of items to retrieve.
cursorstringNoWhen the number of results for a request exceeds the allowed limit, the response will include a cursor. That value can then be sent via this parameter on a subsequent request to retrieve the next set of items.

adobe_experience_manager_assets_get_asset_relations

Get the asset relations for an asset Parameters:
ParameterTypeRequiredDefaultDescription
assetIdstringYesID of the asset to access
limitintegerNoFor a paginated request, this parameter defines the maximum number of items to retrieve.
cursorstringNoWhen the number of results for a request exceeds the allowed limit, the response will include a cursor. That value can then be sent via this parameter on a subsequent request to retrieve the next set of items.
relationTypesany[]NoComma-delimited list of relation types to filter the asset relations to include only the specified types.

adobe_experience_manager_assets_get_asset_relations_for_relation_type

Get the asset relations for an asset filtered by relation type Parameters:
ParameterTypeRequiredDefaultDescription
assetIdstringYesID of the asset to access
relationTypestringYesName of relation type
limitintegerNoFor a paginated request, this parameter defines the maximum number of items to retrieve.
cursorstringNoWhen the number of results for a request exceeds the allowed limit, the response will include a cursor. That value can then be sent via this parameter on a subsequent request to retrieve the next set of items.

adobe_experience_manager_assets_get_asset_rendition

Returns a pre-generated (on AEM Assets authoring environment) rendition of the asset Parameters:
ParameterTypeRequiredDefaultDescription
assetIdstringYesID of the asset
renditionNamestringYesany url-encoded or alphanumeric, non-whitespace set of characters that need to match one of the renditions uploaded/created for the specified asset. may contain hyphens and dots
seoNamestringYesany url-encoded or alphanumeric, non-whitespace set of characters. may contain hyphens and dots
attachmentstringNoSetting this parameter to true forces “download” prompt in browser by adapting the Content-Disposition appropriately. Default is false.

adobe_experience_manager_assets_get_asset_renditions

Returns a list of static renditions of an asset Parameters:
ParameterTypeRequiredDefaultDescription
assetIdstringYesID of the asset

adobe_experience_manager_assets_get_import_job_result

Get Import Job Result Parameters:
ParameterTypeRequiredDefaultDescription
importJobIdstringYesThe identifier for an import job
limitintegerNoFor a paginated request, this parameter defines the maximum number of items to retrieve.
cursorstringNoWhen the number of results for a request exceeds the allowed limit, the response will include a cursor. That value can then be sent via this parameter on a subsequent request to retrieve the next set of items.

adobe_experience_manager_assets_get_import_job_status

Get Import Job Status Parameters:
ParameterTypeRequiredDefaultDescription
importJobIdstringYesThe identifier for an import job

adobe_experience_manager_assets_import_from_url

Import From Url Parameters:
ParameterTypeRequiredDefaultDescription
assetMetadataobjectNoMetadata properties and values that should be applied to assets that are part of the import. Client should use the assetMetadata properties as exposed by the metadata API endpoints.
filesany[]Yesfiles
folderstringYesThe ID or path for the folder into which to import the assets in AEM.
sourceNamestringNoA user-friendly display name for the source of the assets

adobe_experience_manager_assets_patch_asset_metadata

Updates the asset’s assetMetadata properties Parameters:
ParameterTypeRequiredDefaultDescription
assetIdstringYesID of the asset to access
bodyany[]NoJSON Patch defines a JSON document structure for expressing a sequence of operations to apply to a JavaScript Object Notation (JSON) document; it is suitable for use with the HTTP PATCH method. The application/json-patch+json media type is used to identify such patch documents. For more details check RFC 6902.