Stored Search API
Get List of Stored Searches
CODE
GET /data/search/savedParameters:
| Parameter | Description | Parameter Type | Data Type |
|---|---|---|---|
| format | Optional. Specify the data format to be returned. | Query string | String:
|
Response Formats: JSON (default), XML, CSV
Get A Specific Stored Search
This function will return the XML definition of a specified stored search.
CODE
GET /data/search/saved/{ID}Parameters:
| Parameter | Description | Parameter Type | Data Type |
|---|---|---|---|
| ID | The unique ID of the stored search. These will be returned in the list of stored searches | Path | string |
Response Formats: XML
Create A Stored Search
This function will allow you to create a new stored search by posting XML to the XNAT search API.
CODE
POST /data/search/savedParameters:
| Parameter | Description | Parameter Type | Data Type |
|---|---|---|---|
| model | The XML structure of the stored search you want to create. See https://flywheelio.atlassian.net/wiki/spaces/XNAT17/pages/2507548171 for notes on formatting. | Body | XML |
Update A Stored Search
This function will allow you to post an updated XML definition to an already-created stored search.
CODE
PUT /data/search/saved/{ID}Parameters:
| Parameter | Description | Parameter Type | Data Type |
|---|---|---|---|
| ID | The unique ID of the stored search. These will be returned in the list of stored searches | Path | string |
| model | The XML structure of the stored search you want to create. See https://flywheelio.atlassian.net/wiki/spaces/XNAT17/pages/2507548171 for notes on formatting. | body | XML |
Get Results From A Stored Search
CODE
GET /data/search/saved/{ID}/resultsParameters:
| Parameter | Description | Parameter Type | Data Type |
|---|---|---|---|
| ID | The unique ID of the stored search. These will be returned in the list of stored searches | Path | string |
| guiStyle | Optional. If this query parameter is set to true, the information returned will be run through the same formatting that information in the GUI is normally run through. This means that the results of the REST call will have the same columns and column headings as the table displayed in the GUI when the saved search is executed. | Query string | boolean |
| format | Optional. Specify the data format to be returned. | Query string | String:
|
Response Formats: XML (default), HTML, JSON, CSV