...
With the exception of the getImage query, all other queries return a comma separated value (CSV) file with results. The first line of the file contains the names of the columns in the response. Each subsequent line corresponds to one row from the TCIA database. The getImage query returns a zip of the images.
REST API Directory (Available as of 7-Jun-2013)
The query keys in the table below are the literal strings used as keys for key/value pairs to specify query parameters. After each key is an indication if the key is required for the query (R) or optional (O). Omitting optional keys will lead to responses that are more broad.
For this API, you will be assigned an api_key for your application. You must incude the api_key in a HTTP request header "api_key" when making API calls. Your request will be rejected if you fail to or provide incorrect api_key. You can find code samples using the TCIA API on Github.
...
Query Name
...
Return Values
...
Output Format
...
Query Key 1
...
Query Key 2
...
Query Key 3
...
Query Key 4
...
Query Key 5
...
getCollectionValues
...
Set of all collection names
...
CSV
...
...
...
...
...
...
getModalityValues
...
Set of modality values filtered by query keys
...
CSV
...
collection (O)
...
modality (O)
...
body_part_examined (O)
...
...
...
getBodyPartValues
...
Set of body parts examined filtered by query keys
...
CSV
...
collection (O)
...
modality (O)
...
body_part_examined (O)
...
...
...
getPatient
...
Set of patient objects filtered by query keys
...
CSV
...
collection (O)
...
...
...
...
...
getPatientStudy
...
Set of patient/study objects filtered by query keys
...
CSV
...
collection (O)
...
patient_id (O)
...
study_instance_uid (O)
...
...
...
getSeries
...
Set of series objects filtered by query keys
...
CSV
...
collection (O)
...
patient_id (O)
...
study_instance_uid (O)
...
modality (O)
...
...
getImage
...
Set of images in a zip file
...
ZIP
...
series_instance_uid (R)
...
...
...
REST API Directory
Query Name | Return Values | Output Format | Query Key 1 | Query Key 2 | Query Key 3 | Query Key 4 | Query Key 5 | Query Key 6 |
|---|---|---|---|---|---|---|---|---|
getCollectionValues | Set of all collection names | CSV |
|
|
|
|
|
|
getModalityValues | Set of all modality values (CT, MR, ...) filtered by query keys | CSV | Collection (O) | BodyPartExamined (O) | Modality (O) |
|
|
|
getBodyPartValues | Set of all body part names filtered by query keys | CSV | Collection (O) | BodyPartExamined (O) | Modality (O) |
|
|
|
getManufacturerValues | Set of all manufacturer names filtered by query keys | CSV | Collection (O) | BodyPartExamined (O) | Modality (O) |
|
|
|
| getPatient | Set of patient objects filtered by query keys | CSV | Collection (O) | |||||
getPatientStudy | Set of patient/study objects filtered by query keys | CSV | Collection (O) | PatientID (O) | StudyInstanceUID (O) |
|
|
|
getSeries | Set of series objects filtered by query keys | CSV | Collection (O) | PatientID (O) | StudyInstanceUID (O) | Modality (O) |
|
|
getImages | Set of images in a zip file | ZIP | SeriesInstanceUID (R) |
|
|
|
|
|
...