Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
GET - /data/projects/{project-id}/subjects/{subject-id | subject-label}/experiments/{experiment-id | experiment-label}/scans
GET - /data/experiments/{experiment-id}/scans

Parameters

{project-id}Required path parameter
{subject-id} or {subject-label}

Required path parameter

{experiment-id} or {experiment-label}

Required path parameter

formatOptional querystring parameter
  • json (default)
  • html
  • xml
  • csv

Response

Code Block
{
  "ResultSet": {
    "Result": [
      {
        "xsiType": "xnat:mrScanData",
        "xnat_imagescandata_id": "integer",
        "note": "string",
        "series_description": "string",
        "ID": "integer {scan-id}",
        "type": "integer",
        "URI": "path",
        "quality": "string"
      },
      ...
    ],
    "totalRecords": "integer"
  }
}

...

Code Block
GET - /data/projects/{project-id}/subjects/{subject-id | subject-label}/experiments/{experiment-id | experiment-label}/scans/{scan-id}
GET - /data/experiments/{experiment-id}/scans/{scan-id}

Parameters

{project-id}Required path parameter
{subject-id} or {subject-label}

Required path parameter

{experiment-id} or {experiment-label}

Required path parameter

{scan-id}Required path parameter
formatOptional querystring parameter
  • html (default)
  • json
  • xml
  • csv

Response

Each items[n].children object in the response object contains another itemsarray that contains resource details.

...

Code Block
PUT - /data/projects/{project-id}/subjects/{subject-id | subject-label}/experiments/{experiment-id | experiment-label}/scans/{scan-id}
PUT - /data/experiments/{experiment-id}/scans/{scan-id}

Parameters

{project-id}Required path parameter
{subject-id} or {subject-label}

Required path parameter

{experiment-id} or {experiment-label}Required path parameter
{scan-id}Required path parameter. Specify a scan ID that already exists in this session.
xsiType

Required querystring parameter. Example:

  • ?xsiType=xnat:mrScanData
{params}

Optional querystring parameters. You can add additional scan descriptors using Scan Data REST XML Path Shortcuts. Example:

  • ?xnat:mrScanData/type=T1



Delete Scan From Image Session

Code Block
DELETE - /data/projects/{project-id}/subjects/{subject-id | subject-label}/experiments/{experiment-id | experiment-label}/scans/{scan-id}
DELETE - /data/experiments/{experiment-id | experiment-label}/scans/{scan-id}

Params

{project-id}Required path parameter
{subject-id} or {subject-label}

Required path parameter

{experiment-id} or {experiment-label}Required path parameter
{scan-id}Required path parameter. Specify a new scan ID that does not already exist in this image session.
removeFilesOptional query param. Defaults to "FALSE", which will leave files in the file system after deleting the experiment record in Postgres. When this param is set to "TRUE", those files are permanently deleted.

Response Code

200Scan Deleted
403Permission Denied (User cannot delete data in this project)

Response Format: none