Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Emory University tcga API

tcga resource

Emory University tcga API is one of 25 APIs that Emory University publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 2 JSON Schema definitions.

Tagged areas include tcga. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 2 JSON Schemas.

This API exposes 35 operations across 20 paths, and defines 1 schema. It is described by OpenAPI 3.0.3, at version 3.2.14.

Requests are made against a single base URL, https://computablebrain.emory.edu/api/v1.

35 operations 20 paths 1 schemas 7 DELETE18 GET9 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
3.2.14
Base URL
https://computablebrain.emory.edu/api/v1
Authentication
API Key
License
Resource Areas
1

Authentication & Security 1

Emory University tcga API declares 1 security scheme for authenticating requests. An API key is passed in the header as Girder-Token (Girder-Token).

Paths & Operations 35

Across 20 paths, the API surfaces 35 operations — 7 DELETE, 18 GET, 9 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

tcga 35

tcga resource

DELETE
/tcga
Remove the TCGA collection
tcga_deleteCollection_delete_tcga → 200400
GET
/tcga
Get the TCGA collection
tcga_getCollection_tcga → 200400
POST
/tcga
Set the TCGA collection
tcga_setCollection_post_tcga 1 param → 200400
POST
/tcga/aperio
Import an item as an Aperio annotation
tcga_importTCGADocument_post_aperio 3 params → 200400
GET
/tcga/case
List cases in the TCGA dataset
tcga_findCase_case 5 params → 200400
POST
/tcga/case
Import a folder as a TCGA case
tcga_importCase_post_case 1 param → 200400
GET
/tcga/case/label/{label}
Get a case document from a label
tcga_getCaseByLabel_case_label_label 1 param → 200400
GET
/tcga/case/search
Search for cases by clinical data
tcga_searchCase_case_search 8 params → 200400
DELETE
/tcga/case/{id}
Remove a case document
tcga_deleteCase_delete_case_id 1 param → 200400
GET
/tcga/case/{id}
Get a case document from an id
tcga_getCase_case_id 1 param → 200400
GET
/tcga/case/{id}/images
List images under a case
tcga_listCaseImages_case_id_images 5 params → 200400
GET
/tcga/case/{id}/metadata/tables
List tables present inside case metadata
tcga_listCaseTables_case_id_metadata_tables 1 param → 200400
DELETE
/tcga/case/{id}/metadata/{table}
Delete case metadata
tcga_deleteCaseMetadata_delete_case_id_metadata_table 2 params → 200400
GET
/tcga/case/{id}/metadata/{table}
Get case metadata
tcga_getCaseMetadata_case_id_metadata_table 2 params → 200400
POST
/tcga/case/{id}/metadata/{table}
Create or replace case metadata
tcga_setCaseMetadata_post_case_id_metadata_table 2 params body → 200400
PUT
/tcga/case/{id}/metadata/{table}
Update case metadata
tcga_updateCaseMetadata_put_case_id_metadata_table 2 params body → 200400
GET
/tcga/cohort
List cohorts in the TCGA dataset
tcga_findCohort_cohort 4 params → 200400
POST
/tcga/cohort
Import a folder as a TCGA cohort type
tcga_importCohort_post_cohort 1 param → 200400
DELETE
/tcga/cohort/{id}
Remove a cohort type
tcga_deleteCohort_delete_cohort_id 1 param → 200400
GET
/tcga/cohort/{id}
Get a cohort document from an id
tcga_getCohort_cohort_id 1 param → 200400
GET
/tcga/cohort/{id}/images
List slide images in a cohort
tcga_cohortListImages_cohort_id_images 5 params → 200400
GET
/tcga/cohort/{id}/slides
List slides in a cohort
tcga_cohortListSlides_cohort_id_slides 5 params → 200400
GET
/tcga/image
Find images
tcga_findImage_image 6 params → 200400
POST
/tcga/image
Import an item as a TCGA slide image
tcga_importImage_post_image 1 param → 200400
DELETE
/tcga/image/{id}
Remove an image
tcga_deleteImage_delete_image_id 1 param → 200400
GET
/tcga/image/{id}
Get an image document by id
tcga_getImage_image_id 1 param → 200400
POST
/tcga/import
Recursively import the TCGA collection
tcga_importCollection_post_import → 200400
GET
/tcga/pathology
Find pathologies for a case
tcga_findPathology_pathology 5 params → 200400
POST
/tcga/pathology
Import an item as a TCGA pathology
tcga_importPathology_post_pathology 2 params → 200400
DELETE
/tcga/pathology/{id}
Remove a pathology
tcga_deletePathology_delete_pathology_id 1 param → 200400
GET
/tcga/pathology/{id}
Get a pathology document by id
tcga_getPathology_pathology_id 1 param → 200400
GET
/tcga/slide
Find slides for a case
tcga_findSlide_slide 5 params → 200400
POST
/tcga/slide
Import a folder as a TCGA slide
tcga_importSlide_post_slide 1 param → 200400
DELETE
/tcga/slide/{id}
Remove a slide
tcga_deleteSlide_delete_slide_id 1 param → 200400
GET
/tcga/slide/{id}
Get a slide document by id
tcga_getSlide_slide_id 1 param → 200400

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. Each schema is shown below with its type and property counts.

string
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

emory-tcga-api-openapi.yml Raw ↑

Other APIs Emory University publishes across the network.

Emory Canvas LMS REST API
Emory Identity (Shibboleth / SAML)
Emory Libraries Digital Repository Software
Emory University annotation API
Emory University api_key API
Emory University assetstore API
Emory University collection API
Emory University dicomweb_assetstore API
Emory University file API
Emory University files API
Emory University folder API
Emory University group API