...
For example, in the following URL:
| Code Block |
|---|
httphttps://services.cancerimagingarchive.net:9099/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: httphttps://services.cancerimagingarchive.net:9099/services/TCIA/TCIA/query
- The API endpoint is getSeries
- The 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 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 this collection, the defined value for the api_key is:
...
API, you will be assigned an api_key for your application.
Query Name | Return Values | Query Key 1 | Query Key 2 | Query Key 3 | Query Key 4 | Query Key 5 | Query Key 6 |
|---|---|---|---|---|---|---|---|
getCollectionValues | Set of all collection names | api_key (R) |
|
|
|
|
|
getPatientStudy | Set of patient/study objects filtered by query keys | api_key (R) | collection (O) | patient_id (O) | study_instance_uid (O) |
| |
getSeries | Set of series objects filtered by query keys | api_key (R) | collection (O) | patient_id (O) | study_instance_uid (O) | ||
getImage | Set of images in a zip file | api_key (R) | series_instance_uid (R) |
|
|
|
|
...