Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The full API consists of a base URL followed by the api and the query parameters in that order. 

 

Set of all collection names

ResourceQueryEndpoint

Query Parameters

All query parameters are
optional unless stated otherwise
 

Format

Description
/TCIA 

 

  
 /query/getCollectionValues   /query/getModalityValues  NoneCSV/HTML/XML/JSONSet of all collection names /query/getBodyPartValues  
 /query/getManufacturerValues  
 /query/getPatient   
 /query//query/  
 /query/   
  /query/  
  /query/  
  /query/  
  /query/  
  /query/  
SharedList/SharedList/query/ContentsByName  

Query Name

Return Values

Output Format

Query Key 1

Query Key  2

Query Key  3

Query Key  4

getModalityValuesCollection / BodyPartExamined
CSV/HTML/XML/JSON

NA

NA

NA

NA

 

 

Set of all modality values (CT, MR, ...) filtered by query keys
 /query/getBodyPartValuesCollection / ModalityCSV/HTML/XML/JSON

Collection (O)

BodyPartExamined (O)

Modality (O)

NA

Set of all body part names filtered by query keys
 /query/getManufacturerValuesCollection / Modality /
BodyPartExamined
CSV/HTML/XML/JSON

Collection (O)

BodyPartExamined (O)

Modality (O)

NA

 
Set of all manufacturer names filtered by query keys
 /query/getPatientCollectionCSV/HTML/XML/JSON

Collection (O)

BodyPartExamined (O)

Modality (O)

NA

 
Set of patient objects filtered by query keys
 /query/getPatientStudyCollection / PatientID /
StudyInstanceUID
CSV/HTML/XML/JSON
Collection (O)NANA
Na

getPatientStudy

Set of patient/study objects filtered by query keys
 /query/getSeriesCollection / StudyInstanceUID /
PatientID / SeriesInstanceUID 
CSV/HTML/XML/JSON

Collection (O)

PatientID (O)

StudyInstanceUID (O)

NA

getSeries
Set of series objects filtered by query keys
 /query/getSeriesSizeSeriesInstanceUID (R)CSV/HTML/XML/JSON

Collection (O)

PatientID (O)

StudyInstanceUID (O)getSeriesSize

Modality (O)

Set of total byte size and object count filtered by query key
 
CSV
/
HTML
query/
XML/JSON
getImageSeriesInstanceUID (R)

NA

NA

NA

getImage

ZIPSet of images in a zip file

ZIP

/SharedList    
 /query/ContentsByNamename
SeriesInstanceUID
(R)

NA

NA

JSONGiven the name of a shared list return its contents.
NA

Return Values

Click here to see more details on the return values.

...