...
Panel | |
---|---|
Contents
Related |
Get All Experiments In XNAT
This API call is essentially a search of one or more data types, and is formatted to return a table of results.
...
Code Block |
---|
{ "ResultSet": { "Result": [ { "date": "", "xsiType": "xnat:mrSessionData", "insert_date": "datetime", "project": "string {project-id}", "ID": "string {experiment-id}", "label": "string {experiment-label}", "URI": "path" }, ... ], "totalRecords": "integer", "title": "Matching experiments" } } |
Get All Experiments In A Project
This API call is essentially a search of one or more data types, and is formatted to return a table of results.
...
Code Block |
---|
{ "ResultSet": { "Result": [ { "date": "", "subject_label": "string", "insert_date": "datetime", "project": "string {project-id}", "ID": "string {experiment-id}", "label": "string {experiment-label}", "URI": "path" }, ... ], "totalRecords": "integer", "title": "Matching experiments" } } |
Get All Experiments For A Subject
This API call is essentially a search of one or more data types, and is formatted to return a table of results.
...
Code Block |
---|
{ "ResultSet": { "Result": [ { "date": "", "ID": "string {experiment-id}", "insert_date": "datetime", "label": "string {experiment-label}", "project": "string {project-id}", "URI": "path", "xnat:subjectassessordata/id": "string {experiment-id}", "xsiType": "string" }, ... ], "totalRecords": "integer", } } |
Get A Single Experiment Record
This API call returns a much more detailed experiment record, including child data that is owned by the experiment, including scans and assessors
...
Expand | ||
---|---|---|
| ||
|
Create A New Experiment
Use this call to create a new experiment record in a project, where the specified experiment label is not already in use.
...
On 201 - Success, the response is a simple string of the new experiment's accession ID. For example:
Code Block |
---|
XNAT_E00067 |
Modify An Experiment Record's Metadata
This is the same URI as in creating the experiment record. The only difference is that now the experiment label exists in this project and can be modified. You can set values for an existing subject record by appending XML path shortcuts as querystring parameters to the end of the PUT request
...
Include Page | ||||
---|---|---|---|---|
|
Delete (Or Unshare) An Experiment Record
Performing this call in a project that owns an experiment record will permanently delete the experiment data from your project and your XNAT archive.
...