/data/archive/projects/{ID}/subjects/{ID | label}/experiments/{ID | label}/assessors/{ID}/{in | out}/resources

A number of the imaging session resource REST API calls support the in and out parameters. Unlike many REST URL parameters, in and out are not processing directives or attribute values, but instead operate as taxonomies to help distinguish the origins of your archived data. This allows for the segregation of resources by their provenance in the generation process:

  • The in specifier groups files that are used as processing inputs
  • The out specifier groups files that are generated and output by the processing

This is used often in pipeline processing. For example, when XNAT performs Freesurfer processing on a session, the processing inputs to Freesurfer are put in the in folder. These are usually a collection of files, some of which may not have existed in XNAT.  All of the files output by Freesurfer are then placed in the out section. When retrieving processing results, it is often necessary to have the exact files on which the processing was performed.

Placement of resources into the in and out folders can have practical effects other than clarification of provenance. For example, download operations usually ignore the content of the in folders, given that that data usually originates from the acquired data, meaning that the contents of the in folder are really duplicates of the acquired data. Data contained in out folders is included as a download option, since it's assumed that users would want the reconstructed or extrapolated data for further analysis.

HTTP CommandRequest & Response format
GET: REQ 
GET: RESPhtml
json
xml
csv
PUT: REQ 
PUT: RESP 
POST: REQxml
querystring
none
POST: RESP 
DELETE: REQ 
DELETE: RESP 

$label.name