...
The full API consists of a base URL followed by the api , the api_key and the query parameters in that order.
...
| Code Block |
|---|
https://services.cancerimagingarchive.net/services/TCIA/TCIA/query/getSeries?api_key=a9312dfe-4465-4e0b-8b76-8eeab0b77ce5&collection=TCGA-GBM&patient_id=1.2.3&study_instance_uid=4.5.6
|
- The base URL is: https://services.cancerimagingarchive.net/services/TCIA/TCIA/query
- The API endpoint is getSeriesThe api_key is provided as follows: &api_key=a9312dfe-4235-4e0b-8b76-8fghqab0b77ce5
- And the three query parameters are provided as follows: &collection=TCGA-GBM&patient_id=1.2.3&study_instance_uid=4.5.6
...
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.
The api_key described above is listed as a Query Key in the table below for simplicity and completeness. It is a required part of the API for all queries. For 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 1 | Query Key 2 | Query Key 3 | Query Key 4 | Query Key 5 5 Query Key 6 |
|---|---|---|---|---|---|---|---|
getCollectionValues | Set of all collection names | api_key (R) CSV |
|
|
|
|
|
getPatientStudy | Set of patient/study objects filtered by query keys | api_key (R) CSV | collection (O) | patient_id (O) | study_instance_uid (O) |
| |
getSeries | Set of series objects filtered by query keys | api_key (R) CSV | collection (O) | patient_id (O) | study_instance_uid (O) | ||
getImage | Set of images in a zip file | api_key (R) ZIP | series_instance_uid (R) |
|
|
|
|
REST API Directory (Proposed for Near Future, Subject to Discussion)
Query Name | Return Values | Output Format | Query Key 1 | Query Key 2 2 | Query Key 3 | Query Key 4 | Query Key 5 | Query Key 6 6 Query Key 7 |
|---|---|---|---|---|---|---|---|---|
getCollectionValues | Set of all collection names | api_key (R) CSV | collection (O) | modality (O) | body_part (O) | manufacturer (O) |
|
|
getModalityValues | Set of all modality values (CT, MR, ...) filtered by query keys | CSV api_key (R) | collection (O) | modality (O) | body_part (O) | manufacturer (O) |
|
|
getBodyPartValues | Set of all body part names filtered by query keys | CSV api_key (R) | collection (O) | modality (O) | body_part (O) | manufacturer (O) |
|
|
getManufacturerValues | Set of all manufacturer names filtered by query keys | CSV api_key (R) | collection (O) | modality (O) | body_part (O) | manufacturer (O) |
|
|
getPatientStudy | Set of patient/study objects filtered by query keys | CSV api_key (R) | collection (O) | modality (O) | body_part (O) | manufacturer (O) | patient_id (O) | study_instance_uid (O) |
getSeries | Set of series objects filtered by query keys | CSV api_key (R) | collection (O) | modality (O) | body_part (O) | manufacturer (O) | patient_id (O) | study_instance_uid (O) |
getImages | Set of images in a zip file | api_key (R) ZIP | series_instance_uid (R) |
|
|
|
|
|
...