XNAT's resource survey function was developed to find and rectify issues arising from changes in XNAT's default file naming scheme. This could result in files named incorrectly but, more importantly, files in the same scan with different names but representing the same DICOM instance. The implications of these issues include:
Detecting and correcting these errors requires two steps:
Separating the survey and mitigation processes into two discrete steps provides the opportunity to run the survey operation, inspect the resulting survey reports before any file is moved, renamed, or deleted, and either proceed with the default mitigation process or use the survey report to mitigate issues manually so you'll know what files will be changed during mitigation.
Because this functionality touches critical data on the back-end, no files are actually deleted. Instead all mismatched or duplicated files are copied to a safe location in XNAT's cache folder before being restructured in the archive folder. The report generated during mitigation provides detailed information on which files were moved and where. See the section Queuing resource mitigation requests in the user guide for more information.
To prevent large sessions from causing performance issues, these tasks are done in the smallest increments possible at the resource level. However, you can create and queue resource survey requests at the project level. This is described in Creating and queuing resource survey requests.
This documentation consists of the following sections:
There is no REST API reference for this functionality. Instead you should open the Swagger page for your XNAT installation and find the section labeled resource-survey-api.