...
The NBIA Advanced REST APIs, described in the NBIA Advanced REST API Guide, provide advanced features geared towards developers seeking to integrate searching and downloading TCIA data into their own web and desktop applications.
...
Note |
---|
- The order in which the query parameters are provided does not matter.
- NBIA Search REST APIs can only access public data. If you want to use these APIs to access restricted collections, see NBIA Search with Authentication REST API Guide.
|
Excerpt |
---|
Image Download APIsUse the APIs in the following table to download images from TCIA. Query Name | Return Values | Output Format | Query Parameters | Usage |
---|
getImage | An object that represents a set of images in a ZIP file based on SeriesInstanceUID. The naming scheme for the NewFileNames parameter changes from sequential numbers to acquisition number - instance number (in correct order). API example and return values for getImage | ZIP | SeriesInstanceUID (R) NewFileNames (O) - Accepted values are Yes and No. | Used for bulk transfer of all images in a series. | getImageWithMD5Hash | All images in the series and MD5 hash values API example and return values for getImageWithMD5Hash | ZIP | SeriesInstanceUID (R) | Used for bulk transfer of images with the ability to check MD5Hash. | getSingleImage | A single DICOM Object that is identified by its SeriesInstanceUID and SOPInstanceUID. This API will always be used following the getSOPInstanceUIDs. API example and return values for getSingleImage | Raw DICOM Object | SeriesInstanceUID (R) SOPInstanceUID (R) | Used to retrieve a single image. |
Use the APIs in the following table to explore the metadata of objects in the TCIA database. Queries return a file in one of these data formats: CSV, HTML, XML, and JSON.
|
...