Project Attributes API
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.
Get A Project's Accessibility Status
Returns the accessibility status as a string: 'Public', 'Protected' or 'Private'
GET - /data/projects/{id}/accessibility
Parameters:
Parameter | Description | Data Type |
---|---|---|
{id} | Required path parameter: Project ID (value of | string |
Response:
"string"
Set A Project's Accessibility Status
PUT - /data/projects/{id}/accessibility/{status}
Parameters:
Parameter | Description | Data Type |
---|---|---|
{id} | Required path parameter: Project ID | string |
{status} | Required path parameter: Accessibility status: can be 'public', 'protected', or 'private' | string |
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:
Parameter | Description | Data Type |
---|---|---|
{id} | Required path parameter: Project ID | string |
Response: Returns the string "Arc001" by default
Get A Project's Prearchive Setting
GET - /data/projects/{id}/prearchive_code
Parameters:
Parameter | Description | Data Type |
---|---|---|
{id} | Required path parameter: Project ID | string |
Response: Integer (0, 4, 5)
0 | Project is using the Prearchive. All incoming image data will be placed in a temporary location (prearchive) before being manually transferred into the permanent archive |
---|---|
4 | Project 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. |
5 | Project 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:
Parameter | Description | Data Type |
---|---|---|
{id} | Required path parameter: Project ID | string |
{code} | Required path parameter: Valid Prearchive setting codes
| integer |
Response: None
Get A Project's Quarantine Code
GET - /data/projects/{id}/quarantine_code
Parameters:
Parameter | Description | Data Type |
---|---|---|
{id} | Required path parameter: Project ID | string |
Response: Integer (0,1)
0 | Project is not using the Quarantine. New and modified experiments will not be placed in Quarantine |
---|---|
1 | Project 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:
Parameter | Description | Data Type |
---|---|---|
{id} | Required path parameter: Project ID | string |
{code} | Required path parameter: Valid Quarantine setting codes
| integer |
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:
Parameter | Description | Data Type |
---|---|---|
{id} | Required path parameter: Project ID | string |
table | Optional querystring parameter: Restrict the table of results to a specific data type:
| string |
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"
}
}