Page tree
Skip to end of metadata
Go to start of metadata

Some elements of the "Manage" tab in the Project report page have their settings set via these individual REST paths. Others, particularly those added via plugin or module, will store their settings in the Project Config Service. Expect a rationalization of these settings in a future XNAT release.


Contents



Get A Project's Accessibility Status

Returns the accessibility status as a string: 'Public', 'Protected' or 'Private'

GET - /data/projects/{id}/accessibility

Parameters:

ParameterDescriptionParameter TypeData Type
{id}Project ID (value of xnat:projectData/ID)pathstring

Response:

"string"


 

Set A Project's Accessibility Status

PUT - /data/projects/{id}/accessibility/{status}

Parameters:

ParameterDescriptionParameter TypeData Type
{id}Project IDpathstring
{status}Accessibility status: can be 'public', 'protected', or 'private'pathstring


Get A Project's Arc Setting (Deprecated)

This feature is no longer used in XNAT, but the REST endpoint still exists.

GET - /data/projects/{id}/current_arc

Parameters:

ParameterDescriptionParameter TypeData Type
{id}Project IDpathstring

Response: Returns the string "Arc001" by default


Get A Project's Prearchive Setting

GET - /data/projects/{id}/prearchive_code

Parameters:

ParameterDescriptionParameter TypeData Type
{id}Project IDpathstring

Response: Integer (0, 4, 5)

0Project is using the Prearchive. All incoming image data will be placed in a temporary location (prearchive) before being manually transferred into the permanent archive
4Project is not using the Prearchive; No overwrites allowed. All incoming image data will be placed into the archive automatically, but anything matching existing files will be rejected.
5Project is not using the Prearchive; Overwrites allowed. All incoming image data will be placed into the archive automatically and will overwrite existing files.


Set A Project's Prearchive Setting

PUT - /data/projects/{id}/prearchive_code/{code}

Parameters:

ParameterDescriptionParameter TypeData Type
{id}Project IDpathstring
{code}Valid Prearchive setting codes
  • 0: Project is using the Prearchive
  • 4: Project is not using the Prearchive; No overwrites allowed
  • 5: Project is not using the Prearchive; No overwrites allowed
pathinteger

Response: None


Get A Project's Quarantine Code

GET - /data/projects/{id}/quarantine_code

Parameters:

ParameterDescriptionParameter TypeData Type
{id}Project IDpathstring

Response: Integer (0,1)

0Project is not using the Quarantine. New and modified experiments will not be placed in Quarantine
1Project is using the Quarantine. All new experiments (and modified experiments) are placed into a quarantine state and must be specifically activated


Set A Project's Quarantine Code

PUT - /data/projects/{id}/quarantine_code/{code}

Parameters:

ParameterDescriptionParameter TypeData Type
{id}Project IDpathstring
{code}Valid Quarantine setting codes
  • 0: Project is not using the Quarantine
  • 4: Project is using the Quarantine
pathinteger

Response: None


Get A Project's Scan Types

Returns a list of known image scan types in your project, collecting multiple related scan labels and grouping them by common scan type. This can be helpful in Scan Type Cleanup operations.

This result set does not include any data that has been shared into your project

GET - /data/projects/{id}/scan_types

Parameters:

ParameterDescriptionParameter TypeData Type
{id}Project IDpath - requiredstring
table

Restrict the table of results to a specific data type:

  • mrScanData
  • petScanData
  • ctScanData
  • otherDicomScanData
querystring - optionalstring


Response:

{
  "ResultSet": {
    "Result": [
      {
        "series_descriptions": "AXIAL_T2_STAR,Axial T2-Star,Axial T2 Star,Axial T2-Star,Axial T2 Star,Axial T2 Star,Axial T2-Star,Axial T2 Star,Axial T2-Star,AXIAL_T2_STAR,AXIAL_T2_STAR,AXIAL_T2_STAR,",
        "type": "Axial T2 Star"
      },
      ...
    ],
    "totalRecords": "12",
    "title": "Scan Types"
  }
}




  • No labels