Skip to main content
Skip table of contents

File Mover Service API

Move files from one location on the server to another location on the server. (Example: Move files to a user's cache space directory)

Move Specified File From Source Path To A New Destination Path

CODE
POST - /data/services/move-files

Parameters

src

Required body parameter. Specifies the source file path relative to your XNAT application, including the file name. Example:

  • /cache/USERS/{User ID}/{resource_name}/{file_name}

dest

Required body parameter. Specifies the intended destination file path relative to your XNAT application, including the file name. Example:

  • /archive/projects/{project_id}/resources/{resource_name}/{file_name}

overwrite

Optional body parameter.

  • false: (Default) Do not overwrite any files at the destination path

  • true: Allow file move to overwrite files at the destination path

Response

XML-formatted catalog entry of the updated file.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.