Get List of Stored Searches
GET /data/search/saved
Parameters:
|
Parameter |
Description |
Data Type |
|---|---|---|
|
format |
Optional query parameter. Specify the data format to be returned. |
String:
|
Response Formats: JSON (default), XML, CSV
Get A Specific Stored Search
This function will return the XML definition of a specified stored search.
GET /data/search/saved/{ID}
Parameters:
|
Parameter |
Description |
Data Type |
|---|---|---|
|
ID |
Required path parameter: The unique ID of the stored search. These will be returned in the list of stored searches |
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.
POST /data/search/saved
Parameters:
|
Parameter |
Description |
Data Type |
|---|---|---|
|
model |
Required body parameter: The XML structure of the stored search you want to create. See Share Custom Data Tables as Stored Searches for Project Reporting for notes on formatting. |
XML |
Update A Stored Search
This function will allow you to post an updated XML definition to an already-created stored search.
PUT /data/search/saved/{ID}
Parameters:
|
Parameter |
Description |
Data Type |
|---|---|---|
|
ID |
Required path parameter: The unique ID of the stored search. These will be returned in the list of stored searches |
string |
|
model |
Required body parameter: The XML structure of the stored search you want to create. See Share Custom Data Tables as Stored Searches for Project Reporting for notes on formatting. |
XML |
Get Results From A Stored Search
GET /data/search/saved/{ID}/results
Parameters:
|
Parameter |
Description |
Data Type |
|---|---|---|
|
ID |
Required path parameter: The unique ID of the stored search. These will be returned in the list of stored searches |
string |
|
guiStyle |
Optional query parameter. 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. |
boolean |
|
format |
Optional query parameter. Specify the data format to be returned. The default is XML. |
String:
|
Response Formats: XML (default), HTML, JSON, CSV