/data/services/archive

REST API Resources

/data/services/archive

HTTP Command

Request & Response format

GET: REQ

GET: RESP

PUT: REQ

PUT: RESP

POST: REQ

src
overwrite
quarantine
triggerPipelines
dest

POST: RESP

DELETE: REQ

DELETE: RESP

Details

Introduced with XNAT 1.5, the import service is a customizable implementation for transfering data from the prearchive to the archive space. XNAT comes with a preconfigured implementation for moving standard imaging session data from the prearchive to the archive space.

Services for archiving data that is currently in the prearchive.

Parameters:

src[] (REQUIRED): Only used when attempting to import a previously uploaded file

  • /prearchive/projects/PROJECT/timestamp/session

overwrite: defaults to none

  • none: Do not overwrite existing xml or files
  • append: Add content to existing xml & file system, but do not overwrite existing files
  • delete: Upload new data, and overwrite any existing files.

quarantine: defaults to false

  • false: follow project settings for whether new/modified archive content should go into quarantine
  • true: override project settings and place new/modified archive content in quarantine.

triggerPipelines: defaults to true

  • true: run the AutoRun pipeline for any archived sessions which are modified/created by this import
  • false: Do not run the AutoRun at this time

dest: Specifies intended destination. If it is empty, it will review the uploaded content and attempt to put it in the right place (or leave it in the prearchive Unassigned).

  • /archive/projects/PROJECT
  • /archive/projects/PROJECT/subjects/SUBJECT
  • /archive/projects/PROJECT/subjects/SUBJECT/experiments/LABEL
    • Importing to this url would allow you to merge content with previously archived data.

NOTE: If multiple src directories are referenced, then the archive operation will happen asynchronously from the request.

$label.name