/data/archive/config/{TOOL_NAME}

HTTP CommandRequest & Response format
GET: REQ 
GET: RESP

html
json
xml
csv

Description

GET: Retrieves a list of configurations or an empty set. This list includes all Configurations for the tool at all paths. It includes the contents, meta-data, and history

This URI returns a static set of columns (they cannot be customized by the client).

toolThe name of a tool that has a configuration file.
 path

column namedescription
toolThe name of a tool that has configuration files
paththe path to the configuration file
userThe user who created the configuration
create_dateThe date/time the configuration was created
reasonThe user provided reason for uploading the configuration
contentsThe actual contents of the configuration file
versionversion number of the configuration contents
statusenabled/disabled status

Parameters

   
formatoptionalUser can specify the format of the returned data set, by adding the ?format= parameter at the end of the URI. Options are HTML, JSON, XML, or CSV.

Examples

The following REST URL on XNAT Central ...

https://central.xnat.org/REST/config/anon

... will produce this table of results, which is formatted as HTML by default.

toolpathprojectusercreate_datereasoncontentsversionstatus
anonscript admin2012-06-20 09:35:58.234 (0008,1030) := project (0010,0010) := subject (0010,0020) := session11enabled

Other Formats

You can retrieve a result set in XML, CSV, or JSON format as well by appending a tag on the end of the URL. For example, this REST URL on XNAT Central ...

https://central.xnat.org/REST/config/anon?format=json

... will produce a JSON-formatted result string.

{"ResultSet":{"Result":[{"project":"","create_date":"2012-06-20 09:35:59.546","status":"enabled","contents":"(0008,1030) := project\n(0010,0010) := subject\n(0010,0020) := session\n","reason":"","tool":"anon","path":"script","user":"admin","version":"1"}]}}

$label.name