Breadcrumbs

Aemassetsconnector v1.0

Version 1.0

Connector Overview: This page documents all 24 actions for the Aemassetsconnector v1.0.

Default (2)

POST Complete Upload

/{path}

Completes a file upload session by providing the final upload token and file details.

Parameters

Parameter Name

Description

Content Type

The content type of the request payload sent to the API (e.g. application/json).

headers

Additional HTTP header name/value pairs to include in the request.

Path

The repository path where the uploaded file is stored.

Response Type

The response format expected from the API (e.g. application/json).
Options (3)

Option Name

Description

Uploadtoken

The token returned by the initialize upload action that identifies the upload session.

Filename

The final name to assign to the uploaded file.

Mimetype

The MIME type of the uploaded file.

POST Initialize Upload

/content/{path}

Starts a new file upload session by specifying the target path, file name, and file size.

Parameters

Parameter Name

Description

Content Type

The content type of the request payload sent to the API (e.g. application/json).

headers

Additional HTTP header name/value pairs to include in the request.

Path

The repository path under /content where the file will be uploaded.

Response Type

The response format expected from the API (e.g. application/json).
Options (2)

Option Name

Description

Filename

The name of the file to upload.

Filesize

The size of the file in bytes.

Download

GET Download Asset

x-oneteg-downloader-path-with-authorization

Downloads an asset from a given URL with configurable retry and timeout settings.

Parameters

Parameter Name

Description

HTTP Method

The HTTP method to use for the download request (e.g., GET).

Download Url

The URL from which to download the asset.

Asset Name

The name to assign to the downloaded asset.

Try Count

The number of download attempts before failing.

Read Timeout (seconds)

The maximum time in seconds to wait for data to be read.

Connection Timeout (seconds)

The maximum time in seconds to wait for the connection to be established.

Load File Content As Output

This toggle enables you to load file content as the step output. Supported formats include JSON, XML, YML/YAML, CSV, TXT, and other text-based file types. Note that images, PDF files, and other binary formats cannot be loaded. Additionally, there is a file size limit for this feature; please check the logs for details.

Follow Redirects

Enable or disable following URL redirects. If it is enabled, it will follow the URL redirects.

headers

Additional HTTP header name/value pairs to include in the request.

Misc (20)

POST Add a comment on an asset

/api/assets/{folder_name}/{asset_name}/comments/*

Creates a new asset comment.

Parameters: The parameters are message for the message body of the comment and annotationData for the Annotation data in JSON format.

Request: POST /api/assets/myfolder/myasset.png/comments/\\* -F"message=Hello World." -F"annotationData={}"

Response codes: The response codes are:

  • 201 - CREATED - if Comment has been created successfully.

  • 404 - NOT FOUND - if Asset could not be found or accessed at the provided URI.

  • 412 - PRECONDITION FAILED - if root collection cannot be found or accessed.

  • 500 - INTERNAL SERVER ERROR - if something else goes wrong.

Parameters

Parameter Name

Description

Content Type

The content type of the request payload sent to the API (e.g. application/json).

headers

Additional HTTP header name/value pairs to include in the request.

Folder Name

The name of the folder containing the asset.

Asset Name

The name of the asset to comment on.

Content-type

The Content-Type header value for the request body.

Response Type

The response format expected from the API (e.g. application/json).
Options (1)

Option Name

Description

Message

The text of the comment to add.

POST Create Relative Folders

/content/dam/{path}

Creates a folder hierarchy under /content/dam along the specified path.

Parameters

Parameter Name

Description

Content Type

The content type of the request payload sent to the API (e.g. application/json).

headers

Additional HTTP header name/value pairs to include in the request.

Path

The relative path under /content/dam where folders should be created.

Response Type

The response format expected from the API (e.g. application/json).
Options (1)

Option Name

Description

Jcr:primarytype

The JCR primary node type for the created folder, typically 'sling:Folder'.

POST Create a folder

/api/{path}/*

Creates a new sling: OrderedFolder at the given path. If a \\* is provided instead of a node name, the servlet uses the parameter name as node name. Accepted as request data is either a Siren representation of the new folder or a set of name-value pairs, encoded as application/www-form-urlencoded or multipart/ form\- data, useful for creating a folder directly from an HTML form. Additionally, properties of the folder can be specified as URL query parameters.

An API call fails with a 500 response code if the parent node of the provided path does not exist. A call returns a response code 409 if the folder already exists.

Parameters: name is the folder name.

Request

  • POST /api/assets/myFolder -H"Content-Type: application/json" -d '{"class":"assetFolder","properties":{"jcr:title":"My Folder"}}'

  • POST /api/assets/\\* -F"name=myfolder" -F"jcr:title=My Folder"

Response codes: The response codes are:

  • 201 - CREATED - on successful creation.

  • 409 - CONFLICT - if folder already exist.

  • 412 - PRECONDITION FAILED - if root collection cannot be found or accessed.

  • 500 - INTERNAL SERVER ERROR - if something else goes wrong.

Parameters

Parameter Name

Description

Content Type

The content type of the request payload sent to the API (e.g. application/json).

headers

Additional HTTP header name/value pairs to include in the request.

Path

The parent path under /api where the folder will be created.

Response Type

The response format expected from the API (e.g. application/json).
Options (2)

Option Name

Description

Name

The name of the folder to create.

Jcr:title

The display title for the folder.

POST Create an Asset Rendition

/api/assets/{folder_name}/{asset_name}/renditions/{rendition_name}

Create a new asset rendition for an asset. If request parameter name is not provided, the file name is used as rendition name.

Parameters: The parameters are name for name of the rendition and file as a file reference.

Request

  • POST /api/assets/myfolder/myasset.png/renditions/web-rendition -H"Content-Type: image/png" --data-binary "@myRendition.png"

  • POST /api/assets/myfolder/myasset.png/renditions/\* -F"name=web-rendition" -F"file=@myRendition.png"

Response codes: The response codes are:

  • 201 - CREATED - if Rendition has been created successfully.

  • 404 - NOT FOUND - if Asset could not be found or accessed at the provided URI.

  • 412 - PRECONDITION FAILED - if root collection cannot be found or accessed.

  • 500 - INTERNAL SERVER ERROR - if something else goes wrong.

Parameters

Parameter Name

Description

Content Type

The content type of the request payload sent to the API (e.g. application/json).

headers

Additional HTTP header name/value pairs to include in the request.

Folder Name

The name of the folder containing the asset.

Asset Name

The name of the asset.

Rendition Name

The name of the rendition to create.

Response Type

The response format expected from the API (e.g. application/json).
Options (1)

Option Name

Description

File

The file data to use as the rendition content.

POST Create an asset

/api/assets/{folder_name}/{asset_name}

Place the provided file at the provided path to create an asset in the DAM repository. If a \\* is provided instead of a node name, the servlet uses the parameter name or the file name as node name.

Parameters: The parameters are name for the asset name and file for the file reference.

Request

  • POST /api/assets/myFolder/myAsset.png -H"Content-Type: image/png" --data-binary "@myPicture.png"

  • POST /api/assets/myFolder/\\* -F"name=myAsset.png" -F"file=@myPicture.png"

Response codes: The response codes are:

  • 201 - CREATED - if Asset has been created successfully.

  • 409 - CONFLICT - if Asset already exist.

  • 412 - PRECONDITION FAILED - if root collection cannot be found or accessed.

  • 500 - INTERNAL SERVER ERROR - if something else goes wrong.

Parameters

Parameter Name

Description

Content Type

The content type of the request payload sent to the API (e.g. application/json).

headers

Additional HTTP header name/value pairs to include in the request.

Folder Name

The name of the folder where the asset will be created.

Asset Name

The name to assign to the new asset.

Response Type

The response format expected from the API (e.g. application/json).
Options (1)

Option Name

Description

File

The file data to upload as the asset content.

DELETE Delete Asset

/api/assets/{asset_path}

Deletes a resource (-tree) at the provided path.

Request

  • DELETE /api/assets/myFolder

  • DELETE /api/assets/myFolder/myAsset.png

  • DELETE /api/assets/myFolder/myAsset.png/renditions/original

Response codes: The response codes are:

  • 200 - OK - if folder has been deleted successfully.

  • 412 - PRECONDITION FAILED - if root collection cannot be found or accessed.

  • 500 - INTERNAL SERVER ERROR - if something else goes wrong.

Parameters

Parameter Name

Description

headers

Additional HTTP header name/value pairs to include in the request.

Asset Path

The full path of the asset to delete, starting from /api/assets.

Response Type

The response format expected from the API (e.g. application/json).

DELETE Delete Asset Rendition

/api/assets/{folder_name}/{asset_name}/renditions/{rendition_name}

Deletes a resource (-tree) at the provided path.

Request

  • DELETE /api/assets/myFolder

  • DELETE /api/assets/myFolder/myAsset.png

  • DELETE /api/assets/myFolder/myAsset.png/renditions/original

Response codes: The response codes are:

  • 200 - OK - if folder has been deleted successfully.

  • 412 - PRECONDITION FAILED - if root collection cannot be found or accessed.

  • 500 - INTERNAL SERVER ERROR - if something else goes wrong.

Parameters

Parameter Name

Description

headers

Additional HTTP header name/value pairs to include in the request.

Folder Name

The name of the folder containing the asset.

Asset Name

The name of the asset.

Rendition Name

The name of the rendition to delete.

Response Type

The response format expected from the API (e.g. application/json).

DELETE Delete Folder

/api/{folder_path}

Deletes a resource (-tree) at the provided path.

Request

  • DELETE /api/assets/myFolder

  • DELETE /api/assets/myFolder/myAsset.png

  • DELETE /api/assets/myFolder/myAsset.png/renditions/original

Response codes: The response codes are:

  • 200 - OK - if folder has been deleted successfully.

  • 412 - PRECONDITION FAILED - if root collection cannot be found or accessed.

  • 500 - INTERNAL SERVER ERROR - if something else goes wrong.

Parameters

Parameter Name

Description

headers

Additional HTTP header name/value pairs to include in the request.

Folder Path

The full path of the folder to delete, starting from /api.

Response Type

The response format expected from the API (e.g. application/json).

GET Query Builder - LastModified

/{bin}/querybuilder.json

Queries assets using the AEM Query Builder with a last-modified date range filter.

Parameters

Parameter Name

Description

headers

Additional HTTP header name/value pairs to include in the request.

Type

The type of asset to search for.

1 Group.p.and

Boolean flag to AND the first group's predicates.

1 Group.1 Group.p.and

Boolean flag to AND the first subgroup's predicates.

1 Group.1 Group.relativedaterange.property

The property name for the relative date range, typically 'jcr:lastModified'.

1 Group.1 Group.relativedaterange.upperbound

The upper bound of the relative date range (e.g., '0' for today).

1 Group.1 Group.relativedaterange.lowerbound

The lower bound of the relative date range (e.g., '-30' for last 30 days).

Bin

The servlet path segment to use, typically 'bin'.

Response Type

The response format expected from the API (e.g. application/json).

GET Query Builder - Property Predicate

/bin/querybuilder.json

Queries assets using the AEM Query Builder with property-based predicates. No additional parameters are needed for this action.

Parameters

Parameter Name

Description

headers

Additional HTTP header name/value pairs to include in the request.

Path

Path to search within DAM.

Type

Type of asset to query.

Property

Metadata property to filter by.

Property.value

Value of the metadata property.

Relativedaterange.property

Property for date range filtering.

Relativedaterange.lowerbound

Lower bound for date range (e.g., last 50 days).

P.limit

Limit on the number of results returned.

Response Type

The response format expected from the API (e.g. application/json).

POST Reprocess Asset

/bin/asynccommand

Start asynchronous reprocessing of an asset to apply processing profiles or other operations.

Parameters

Parameter Name

Description

Content Type

The content type of the request payload sent to the API (e.g. application/json).

headers

Additional HTTP header name/value pairs to include in the request.

Response Type

The response format expected from the API (e.g. application/json).
Options (4)

Option Name

Description

Processtype

The type of processing to apply, such as reprocessing or rendering.

Operation

The specific operation to perform during reprocessing.

Asset

The path to the asset that should be reprocessed.

Profilecategory

The category of processing profile to use for the reprocessing.

GET Retrieve Asset using Path

/api/assets/{asset_path}

Retrieve an asset from AEM by specifying its full path, using the provided authorization header.

Parameters

Parameter Name

Description

headers

Additional HTTP header name/value pairs to include in the request.

Asset Path

The full path of the asset to delete, starting from /api/assets.

Authorization

The authorization token or credentials required to access the asset.

Response Type

The response format expected from the API (e.g. application/json).

GET Retrieve Folder Metadata

/content/dam/{folder_path}/jcr:content/metadata.json

Retrieve the metadata of a folder in JSON format by providing the folder's path.

Parameters

Parameter Name

Description

headers

Additional HTTP header name/value pairs to include in the request.

Folder Path

The full path of the folder to delete, starting from /api.

Response Type

The response format expected from the API (e.g. application/json).

GET Retrieve a Folder

/api/{folder_path}

Retrieve a folder's properties and contents from the AEM assets API using its path.

Parameters

Parameter Name

Description

headers

Additional HTTP header name/value pairs to include in the request.

Folder Path

The full path of the folder to delete, starting from /api.

Response Type

The response format expected from the API (e.g. application/json).

GET Retrieve a folder listing

/api/assets.json

Retrieve a folder listing

Retrieves a Siren representation of an existing folder and of its child entities (subfolders or assets).

Request: GET /api/assets/myFolder.json

Response codes: The response codes are:

  • 200 - OK - success.

  • 404 - NOT FOUND - folder does not exist or is not accessible.

  • 500 - INTERNAL SERVER ERROR - if something else goes wrong.

Response: The class of the entity returned is an asset or a folder. The properties of contained entities are a subset of the full set of properties of each entity. In order to obtain a full representation of the entity, clients should retrieve the contents of the URL pointed to by the link with a rel of self.

Parameters

Parameter Name

Description

headers

Additional HTTP header name/value pairs to include in the request.

Authorization

The authorization token or credentials needed to view the folder listing.

Response Type

The response format expected from the API (e.g. application/json).

GET Retrieve an Asset

/api/assets/{folder_name}/{asset_name}

Retrieve a specific asset by providing its folder name and asset name through the assets API.

Parameters

Parameter Name

Description

headers

Additional HTTP header name/value pairs to include in the request.

Folder Name

The name of the folder containing the asset.

Asset Name

The name of the asset.

Response Type

The response format expected from the API (e.g. application/json).

GET Retrieve an Asset Renditions

/{asset_path}/renditions.json

Retrieve all renditions of an asset as a JSON list by specifying the asset's path.

Parameters

Parameter Name

Description

headers

Additional HTTP header name/value pairs to include in the request.

Asset Path

The full path of the asset to delete, starting from /api/assets.

Response Type

The response format expected from the API (e.g. application/json).

PUT Update Asset Metadata

/api/assets/{folder_name}/{asset_name}

Updates the asset metadata properties. If you update any property in the dc: namespace, the API updates the same property in the jcr namespace. The API does not sync the properties under the two namespaces.

Request: PUT /api/assets/myfolder/myAsset.png -H"Content-Type: application/json" -d '{"class":"asset", "properties":{"jcr:title":"My Asset"}}'

Response codes: The response codes are:

  • 200 - OK - if Asset has been updated successfully.

  • 404 - NOT FOUND - if Asset could not be found or accessed at the provided URI.

  • 412 - PRECONDITION FAILED - if root collection cannot be found or accessed.

  • 500 - INTERNAL SERVER ERROR - if something else goes wrong.

Parameters

Parameter Name

Description

Content Type

The content type of the request payload sent to the API (e.g. application/json).

headers

Additional HTTP header name/value pairs to include in the request.

Folder Name

The name of the folder containing the asset.

Asset Name

The name of the asset.

Response Type

The response format expected from the API (e.g. application/json).

POST Update Folder Metadata

/content/dam/{folder_path}/jcr:content/metadata.json

Update the metadata of a folder by posting new values, such as product SKU, to the metadata endpoint.

Parameters

Parameter Name

Description

Content Type

The content type of the request payload sent to the API (e.g. application/json).

headers

Additional HTTP header name/value pairs to include in the request.

Folder Path

The full path of the folder to delete, starting from /api.

Response Type

The response format expected from the API (e.g. application/json).
Options (1)

Option Name

Description

Productsku

The product SKU integer value to set in the folder's metadata.

PUT Update a folder

/api/{folder_path}

Creates a new sling: OrderedFolder at the given path. If a \\* is provided instead of a node name, the servlet uses the parameter name as node name. Accepted as request data is either a Siren representation of the new folder or a set of name-value pairs, encoded as application/www-form-urlencoded or multipart/ form\- data, useful for creating a folder directly from an HTML form. Additionally, properties of the folder can be specified as URL query parameters.

An API call fails with a 500 response code if the parent node of the provided path does not exist. A call returns a response code 409 if the folder already exists.

Parameters: name is the folder name.

Request

  • POST /api/assets/myFolder -H"Content-Type: application/json" -d '{"class":"assetFolder","properties":{"jcr:title":"My Folder"}}'

  • POST /api/assets/\\* -F"name=myfolder" -F"jcr:title=My Folder"

Response codes: The response codes are:

  • 201 - CREATED - on successful creation.

  • 409 - CONFLICT - if folder already exist.

  • 412 - PRECONDITION FAILED - if root collection cannot be found or accessed.

  • 500 - INTERNAL SERVER ERROR - if something else goes wrong.

Parameters

Parameter Name

Description

Content Type

The content type of the request payload sent to the API (e.g. application/json).

headers

Additional HTTP header name/value pairs to include in the request.

Folder Path

The full path of the folder to delete, starting from /api.

Response Type

The response format expected from the API (e.g. application/json).

General

GET Retrieve an Asset or its Metadata

/{path}

Retrieve an asset or its metadata by providing the full path to the resource.

Parameters

Parameter Name

Description

headers

Additional HTTP header name/value pairs to include in the request.

Path

The parent path under /api where the folder will be created.

Response Type

The response format expected from the API (e.g. application/json).