Page tree

Versions Compared

Key

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

...

Panel

Contents

Table of Contents

Related


Image Assessor Resource Organization (IN | OUT)

Info

Image Assessor resource REST API calls support the in and out parameters (see below). 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 extrapolated data for further analysis.


Get A Listing Of All Resource Collections Stored With An Image Assessor

Code Block
GET - /data/experiments/{session-id}/assessors/{assessor-id}/resources
GET - /data/projects/{project-id}/subjects/{subject-label}/experiments/{session-label}/assessors/{assessor-label}/resources

Parameters

{project-id}Path parameter
{subject-id} or {subject-label}Path parameter. Subject label is a project-specific field, and can only be used if a project is specified.
{session-id} or {session-label}Path parameter. Session label is a project-specific field, and can only be used if a project is specified.
{assessor-id} or {assessor-label}Path parameter. Assessor label is a project-specific field, and can only be used if a project is specified.
format

Optional querystring parameter. Specify the format of the returned response.

  • json (default)
  • html
  • xml
  • csv

Response

This call returns an array of resource descriptors, where the key values are "xnat_abstractresource_id" and "label", which can be used as a path parameter to return individual resource collections.

Code Block
{
  "ResultSet": {
    "Result": [
      {
        "cat_desc": "string",
        "cat_id": "string",
        "category": "assessors",
        "content": "string",
        "element_name": "xnat:resourceCatalog",
        "file_count": "integer",
        "file_size": "integer (bytes)",
        "format": "string",
        "label": "string {resource-label}",
        "tags": "string",
        "xnat_abstractresource_id": "integer {resource-id}"
      }
    ],
    "totalRecords": "integer",
    "title": "Resources"
  }
}


Get A Listing Of All Resource Files Stored With An Assessor

Code Block
GET - /data/experiments/{session-id}/assessors/{assessor-id}/files
GET - /data/projects/{project-id}/subjects/{subject-label}/experiments/{session-label}/assessors/{assessor-label}/files

Parameters

{project-id}Path parameter
{subject-id} or {subject-label}Path parameter. Subject label is a project-specific field, and can only be used if a project is specified.
{session-id} or {session-label}Path parameter. Session label is a project-specific field, and can only be used if a project is specified.
{assessor-id} or {assessor-label}Path parameter. Assessor label is a project-specific field, and can only be used if a project is specified.
format

Optional querystring parameter. Specify the format of the returned response.

  • json (default)
  • html
  • xml
  • csv

Response

This call returns an array of file listings, where each has a unique URI path to the resource file.

Code Block
{
  "ResultSet": {
    "Columns": [
      {
        "key": "URI",
        "serverRoot": ""
      }
    ],
    "Result": [
      {
        "cat_ID": "integer {resource-id}",
        "collection": "string {resource-label}",
        "file_content": "string",
        "file_format": "string",
        "file_tags": "string",
        "digest": "hash",
        "Name": "string {filename}",
        "Size": "integer",
        "URI": "/data/experiments/{experiment-id}/resources/{resource-id}/files/{filename}"
      },
      ...
    ],
    "title": "Files"
  }
}


Get The Contents Of An Image Assessor Resource File

Note

This URI returns the raw contents of a resource file. If your client cannot parse this file,


Code Block
GET - /data/projects/{project-id}/subjects/{subject-id | subject-label}/experiments/{experiment-id | experiment-label}/resources/{resource-id | resource-label}/files/{filename}
GET - /data/experiments/{experiment-id}/resources/{resource-id}/files/{filename}