Skip to main content
English (US) Nederlands

Assets Server REST API - move / rename

Updated

GET/POST 

http://yourserver.com/services/move
    ?source=<source path>
    &target=<destination path>
    &folderReplacePolicy=<AUTO_RENAME | MERGE | THROW_EXCEPTION>
    &fileReplacePolicy=<AUTO_RENAME | OVERWRITE
    | OVERWRITE_IF_NEWER | REMOVE_SOURCE
    | THROW_EXCEPTION | DO_NOTHING>
    &filterQuery=<query>
    &flattenFolders=<true|false>

What does it do?

Move or rename a folder or a single asset.

You can combine a rename operation and a move operation. Just specify the new target path.

When you move or rename a folder, all assets contained in the folder will also be moved to the new location. The subfolder structure will be kept intact.

Log in requirement

Before being able to request information from Assets Server by using a GET request or make changes to the system through a POST request, a log in to Assets Server is required. For information about the available APIs for logging in, see Assets Server REST API - introduction.

POST requests only

This REST API only accepts POST requests, not GET requests. Also, the POST request needs to include a cross-site request forgery (csrf) token.

The csrf token is a unique code which, by including it in the request, also makes the POST request unique and therefore much more secure.

The csrf token is obtained by first logging in to Assets Server through a POST request. The response that is received will include the csrf token which can then be used in subsequent POST requests as a http header:

"X-CSRF-TOKEN: <some_csrf_token>"

For more information including examples, see Assets Server REST API - Performing a POST request with a csrf token.

Parameters

source

Either a folderPath or assetPath of the folder or asset to be moved or renamed.

Required
target

The folderPath or assetPath to which the folder or asset should be moved or renamed. If the parent folder is the same as in the source path, the asset will be renamed, otherwise it will be moved.

 

Required.

folderReplacePolicy

Policy used when destination folder already exists.

  • AUTO_RENAME - add '-1' number to destination path. The counter is incremented until a free alternative is found.
  • MERGE - merge source folder into destination using fileReplacePolicy.
  • THROW_EXCEPTION - abort the operation.

Optional. If omitted, AUTO_RENAME will be used.

Only applies when the source is a folderPath.

fileReplacePolicy

Policy used when destination asset already exists.

  • AUTO_RENAME - add '-1' number to destination path. The counter is incremented until a free alternative is found.
  • OVERWRITE - remove destination if it already exists.
  • OVERWRITE_IF_NEWER - only remove destination if source is newer. Otherwise remove source instead of moving it.
  • REMOVE_SOURCE - remove source if destination already exists.
  • THROW_EXCEPTION - abort the operation.
  • DO_NOTHING - skip move of the file.
  • Optional. If omitted, AUTO_RENAME will be used.
filterQuery

When specified, only source assets that match this query will be moved.

Optional. If omitted, all source assets will be moved.

Only applies when the source is a folderPath.
flattenFolders

When set to true will move all files from source subfolders to directly below the target folder. This will 'flatten' any subfolder structure.

Optional. If omitted, folders will not be flattened.

Only applies when the source is a folderPath.
async

When true, the process will run asynchronous in the background. The call will return immediate with the processId.

Optional. By default, the call waits for the process to finish and then returns the processedCount.

Return value

The operation returns a JSON object with the following properties:

processedCount Number of assets that were processed by the operation.
errorCount Number of errors that occurred.

If called with async=true, the operation returns a JSON object with the following properties:

processId Unique id of the process that was started.

If the operation fails, a JSON error object is returned.

Examples

Move single asset

The following moves an asset.

move 

http://demo.assets-server.com/services/move
    ?source=/Demo Zone/Images/Travel/Architecture/Louvre.jpg
    &target=/Demo Zone/Images/Travel/Cities/Louvre.jpg

It returns the following response.

{
  "processedCount" : 1
}

Rename single asset

The following renames an asset.

move 
http://demo.assets-server.com/services/move
    ?source=/Demo Zone/Images/Nature/Wildlife/Elephant Closeup.jpg
    &target=/Demo Zone/Images/Nature/Wildlife/African Elephant.jpg

Move folder

The following moves a folder and all the assets contained in it. The folder is also renamed.

move 
http://demo.assets-server.com/services/move
    ?source=/Demo Zone/Images
    &target=/Archive/2011/Demo Images

Moving files without moving the folder

Moving files in a folder but not the folder itself is achieved by adding a filterQuery that matches everything.

move 
http://demo.assets-server.com/services/move
   ?source=/Demo Zone/Images
   &target=/Archive/2011/Demo Images
   &filterQuery=*:*

Related articles

Comments

0 comments

Please sign in to leave a comment.