Endpoint Details
This page provides details on each of the IDC API endpoints.
Last updated
This page provides details on each of the IDC API endpoints.
Last updated
Get links to the IDC API Swagger UI and IDC documentation
API Description and link to SwaggerUI interface.
const response = await fetch('/about', {
method: 'GET',
headers: {},
});
const data = await response.json();
{
"message": "text",
"documentation": "text"
}
Returns a list of IDC data versions and activation dates
A list of IDC data versions and metadata
const response = await fetch('/versions', {
method: 'GET',
headers: {},
});
const data = await response.json();
{
"idc_data_versions": [
{
"idc_data_version": "text",
"date_active": "text",
"active": "text"
}
]
}
Return a list of the values accepted for a 'categorical filter'. A categorical filter is a filter having a data type of 'Categorical String' or 'Categorical Number'.
Categorical filter whose values are to be returned
A list of accepted values
const response = await fetch('/filters/values/{filter}', {
method: 'GET',
headers: {},
});
const data = await response.json();
{
"values": [
"text"
]
}
Delete a specified cohort. Authorization is required in order to access this endpoint.
ID of cohort to be deleted.
A list of the user's remaining cohorts.
const response = await fetch('/cohorts/{cohort_id}', {
method: 'DELETE',
headers: {},
});
const data = await response.json();
{
"cohorts": [
{
"result": "text"
}
]
}
Return a list of queryable manifest fields.
IDC data version whose data is to be returned. If the version is 'current', the fields of the current IDC version are returned.
A list of fields
const response = await fetch('/fields/{version}', {
method: 'GET',
headers: {},
});
const data = await response.json();
{
"idc_data_version": "text",
"data_sources": [
{
"data_source": "text",
"fields": [
"text"
]
}
]
}
Returns a list of the analysis results, and associated metadata, in the current IDC data version
A list of analysis results
const response = await fetch('/analysis_results', {
method: 'GET',
headers: {},
});
const data = await response.json();
{
"analysisResults": [
{
"analysis_result_id": "text",
"analysisArtifacts": "text",
"cancer_type": "text",
"collections": "text",
"date_updated": "text",
"description": "text",
"doi": "text",
"location": "text",
"title": "text"
}
]
}
Returns a list of collections, and associated metadata, in the current IDC data version.
A list of collections
const response = await fetch('/collections', {
method: 'GET',
headers: {},
});
const data = await response.json();
{
"collections": [
{
"collection_id": "text",
"cancer_type": "text",
"date_updated": "text",
"description": "text",
"source_doi": "text",
"source_url": "text",
"image_types": "text",
"location": "text",
"species": "text",
"supporting_data": "text"
}
]
}
Returns a list of 'filters', organized by data source (BQ table), for the current IDC data version. An IDC cohort is defined by a 'filterset', a set of (filter,[values]) pairs, and the IDC version against which the filterset is applied. The returned data is grouped by source (the BQ table that contains the corresponding filter values). For each filter, its data type and units, when available, are reported.
A list of filters
const response = await fetch('/filters', {
method: 'GET',
headers: {},
});
const data = await response.json();
{
"idc_data_version": "text",
"data_sources": [
{
"data_source": "text",
"filters": [
{
"name": "text",
"data_type": "CONTINUOUS_NUMERIC",
"units": "text"
}
]
}
]
}
Delete a list of the user's cohorts. Authorization is required in order to access this endpoint.
List of IDs of cohorts to be deleted.
Summary of cohort deletion.
const response = await fetch('/cohorts', {
method: 'DELETE',
headers: {
"Content-Type": "application/json"
},
body: JSON.stringify({}),
});
const data = await response.json();
{
"cohorts": [
{
"result": "text"
}
]
}
Returns the next page of a /cohorts/manifest request, when additional data is available. Authorization is required in order to access this endpoint.
manifest page
const response = await fetch('/cohorts/manifest/nextPage', {
method: 'GET',
headers: {},
});
const data = await response.json();
{
"manifest": {
"manifest_data": [
{
"analysis_results_id": "text",
"AnatomicRegionSequence": "text",
"Apparent_Diffusion_Coefficient": 0,
"aws_bucket": "text",
"aws_url": "text",
"bmi": 0,
"BodyPartExamined": "text",
"Calcification": "text",
"CancerType": "text",
"collection_id": "text",
"country": "text",
"crdc_instance_uuid": "text",
"crdc_series_uuid": "text",
"crdc_study_uuid": "text",
"Diameter": 0,
"disease_code": "text",
"ethnicity": "text",
"FrameOfReferenceUID": "text",
"gcs_bucket": "text",
"gcs_url": "text",
"gender": "text",
"histological_type": "text",
"illuminationType": "text",
"Internal_structure": "text",
"license_short_name": "text",
"Lobular_Pattern": "text",
"Malignancy": "text",
"Manufacturer": "text",
"ManufacturerModelName": "text",
"Margin": "text",
"min_PixelSpacing": 0,
"Modality": "text",
"pathologic_stage": "text",
"PatientID": "text",
"primaryAnatomicStructure": "text",
"Program": "text",
"project_name": "text",
"project_short_name": "text",
"race": "text",
"sample_type": "text",
"SegmentAlgorithmType": "text",
"SegmentedPropertyCategoryCodeSequence": "text",
"SegmentedPropertyTypeCodeSequence": "text",
"SeriesDescription": "text",
"SeriesInstanceUID": "text",
"SeriesNumber": "text",
"SliceThickness": 0,
"SOPClassUID": "text",
"SOPInstanceUID": "text",
"source_DOI": "text",
"Sphericity": "text",
"Sphericity_quant": 0,
"Spiculation": "text",
"StudyDate": "text",
"StudyDescription": "text",
"StudyInstanceUID": "text",
"Subtlety_score": "text",
"Surface_area_of_mesh": 0,
"tcia_species": "text",
"tcia_tumorLocation": "text",
"Texture": "text",
"tumor_tissue_site": "text",
"vital_status": "text",
"Volume": 0,
"Volume_of_Mesh": 0,
"instance_count": 0,
"series_count": 0,
"study_count": 0,
"patient_count": 0,
"collection_count": 0,
"group_size": 0
}
]
},
"next_page": "text"
}
Retrieve user's account information. Authorization is required in order to access this endpoint.
Current account information for the validated user.
const response = await fetch('/users/account_details', {
method: 'GET',
headers: {},
});
const data = await response.json();
{
"account_details": {
"date_joined": "text",
"email": "text",
"id": "text",
"last_login": "text",
"username": "text",
"extra_data": {
"id'": "text",
"email": "text",
"verified_email": "text",
"name'": "text",
"given_name": "text",
"family_name": "text",
"picture": "text",
"locale": "text",
"hd": "text"
},
"first_name": "text",
"last_name": "text"
}
}
Returns the next page of a /cohorts/manifest/preview request, when additional data is available.
Preview manifest page
const response = await fetch('/cohorts/manifest/preview/nextPage', {
method: 'GET',
headers: {},
});
const data = await response.json();
{
"manifest": {
"manifest_data": [
{
"analysis_results_id": "text",
"AnatomicRegionSequence": "text",
"Apparent_Diffusion_Coefficient": 0,
"aws_bucket": "text",
"aws_url": "text",
"bmi": 0,
"BodyPartExamined": "text",
"Calcification": "text",
"CancerType": "text",
"collection_id": "text",
"country": "text",
"crdc_instance_uuid": "text",
"crdc_series_uuid": "text",
"crdc_study_uuid": "text",
"Diameter": 0,
"disease_code": "text",
"ethnicity": "text",
"FrameOfReferenceUID": "text",
"gcs_bucket": "text",
"gcs_url": "text",
"gender": "text",
"histological_type": "text",
"illuminationType": "text",
"Internal_structure": "text",
"license_short_name": "text",
"Lobular_Pattern": "text",
"Malignancy": "text",
"Manufacturer": "text",
"ManufacturerModelName": "text",
"Margin": "text",
"min_PixelSpacing": 0,
"Modality": "text",
"pathologic_stage": "text",
"PatientID": "text",
"primaryAnatomicStructure": "text",
"Program": "text",
"project_name": "text",
"project_short_name": "text",
"race": "text",
"sample_type": "text",
"SegmentAlgorithmType": "text",
"SegmentedPropertyCategoryCodeSequence": "text",
"SegmentedPropertyTypeCodeSequence": "text",
"SeriesDescription": "text",
"SeriesInstanceUID": "text",
"SeriesNumber": "text",
"SliceThickness": 0,
"SOPClassUID": "text",
"SOPInstanceUID": "text",
"source_DOI": "text",
"Sphericity": "text",
"Sphericity_quant": 0,
"Spiculation": "text",
"StudyDate": "text",
"StudyDescription": "text",
"StudyInstanceUID": "text",
"Subtlety_score": "text",
"Surface_area_of_mesh": 0,
"tcia_species": "text",
"tcia_tumorLocation": "text",
"Texture": "text",
"tumor_tissue_site": "text",
"vital_status": "text",
"Volume": 0,
"Volume_of_Mesh": 0,
"instance_count": 0,
"series_count": 0,
"study_count": 0,
"patient_count": 0,
"collection_count": 0,
"group_size": 0
}
]
},
"next_page": "text"
}
Returns a manifest of a cohort that was previously saved under the user's IDC account. The metadata to be returned in the manifest is configurable. Authorization is required in order to access this endpoint.
IDC Cohort ID
List of fields to return.
If True, return counts of DICOM objects
If True, return size in bytes of instances in group
If True, return the BQ SQL for this query.
Maximum number of rows to return
Cohort spec and anifest
const response = await fetch('/cohorts/manifest/{cohort_id}', {
method: 'POST',
headers: {
"Content-Type": "application/json"
},
body: JSON.stringify({
"fields": [
"Age_At_Diagnosis",
"aws_bucket",
"crdc_series_uuid",
"Modality",
"SliceThickness"
],
"counts": true,
"group_size": true,
"sql": true,
"page_size": 1000
}),
});
const data = await response.json();
{
"cohort": {
"name": "text",
"description": "text",
"user_email": "text",
"filterSet": {
"idc_data_version": "text",
"filters": {
"project_short_name": [
"text"
],
"sample_type": [
"text"
],
"age_at_diagnosis_btw": [],
"age_at_diagnosis_ebtw": [],
"age_at_diagnosis_btwe": [],
"age_at_diagnosis_ebtwe": [],
"age_at_diagnosis_gte": [],
"age_at_diagnosis_lte": [],
"age_at_diagnosis_gt": [],
"age_at_diagnosis_lt": [],
"age_at_diagnosis_eq": [],
"bmi_btw": [
0
],
"bmi_ebtw": [
0
],
"bmi_btwe": [
0
],
"bmi_ebtwe": [
0
],
"bmi_gte": [
0
],
"bmi_lte": [
0
],
"bmi_gt": [
0
],
"bmi_lt": [
0
],
"bmi_eq": [
0
],
"country": [
"text"
],
"disease_code": [
"text"
],
"ethnicity": [
"text"
],
"gender": [
"text"
],
"histological_type": [
"text"
],
"pathologic_stage": [
"text"
],
"project_name": [
"text"
],
"race": [
"text"
],
"tumor_tissue_site": [
"text"
],
"vital_status": [
"text"
],
"analysis_results_id": [
"text"
],
"AnatomicRegionSequence": [
"text"
],
"Apparent_Diffusion_Coefficient_btw": [
0
],
"Apparent_Diffusion_Coefficient_ebtw": [
0
],
"Apparent_Diffusion_Coefficient_btwe": [
0
],
"Apparent_Diffusion_Coefficient_ebtwe": [
0
],
"Apparent_Diffusion_Coefficient_gte": [
0
],
"Apparent_Diffusion_Coefficient_lte": [
0
],
"Apparent_Diffusion_Coefficient_gt": [
0
],
"Apparent_Diffusion_Coefficient_lt": [
0
],
"Apparent_Diffusion_Coefficient_eq": [
0
],
"BodyPartExamined": [
"text"
],
"Calcification": [
"text"
],
"CancerType": [
"text"
],
"collection_id": [
"text"
],
"Diameter_btw": [
0
],
"Diameter_ebtw": [
0
],
"Diameter_btwe": [
0
],
"Diameter_ebtwe": [
0
],
"Diameter_gte": [
0
],
"Diameter_lte": [
0
],
"Diameter_gt": [
0
],
"Diameter_lt": [
0
],
"Diameter_eq": [
0
],
"illuminationType": [
"text"
],
"Internal_structure": [
"text"
],
"license_short_name": [
"text"
],
"Lobular_Pattern": [
"text"
],
"Malignancy": [
"text"
],
"Manufacturer": [
"text"
],
"ManufacturerModelName": [
"text"
],
"Margin": [
"text"
],
"max_TotalPixelMatrixColumns_btw": [],
"max_TotalPixelMatrixColumns_ebtw": [],
"max_TotalPixelMatrixColumns_btwe": [],
"max_TotalPixelMatrixColumns_ebtwe": [],
"max_TotalPixelMatrixColumns_gte": [],
"max_TotalPixelMatrixColumns_lte": [],
"max_TotalPixelMatrixColumns_gt": [],
"max_TotalPixelMatrixColumns_lt": [],
"max_TotalPixelMatrixColumns_eq": [],
"max_TotalPixelMatrixRows_btw": [],
"max_TotalPixelMatrixRows_ebtw": [],
"max_TotalPixelMatrixRows_btwe": [],
"max_TotalPixelMatrixRows_ebtwe": [],
"max_TotalPixelMatrixRows_gte": [],
"max_TotalPixelMatrixRows_lte": [],
"max_TotalPixelMatrixRows_gt": [],
"max_TotalPixelMatrixRows_lt": [],
"max_TotalPixelMatrixRows_eq": [],
"min_PixelSpacing_btw": [],
"min_PixelSpacing_ebtw": [],
"min_PixelSpacing_btwe": [],
"min_PixelSpacing_ebtwe": [],
"min_PixelSpacing_gte": [],
"min_PixelSpacing_lte": [],
"min_PixelSpacing_gt": [],
"min_PixelSpacing_lt": [],
"min_PixelSpacing_eq": [],
"Modality": [
"text"
],
"ObjectiveLensPower": [
0
],
"PatientID": [
"text"
],
"primaryAnatomicStructure": [
"text"
],
"SamplesPerPixel": [
"text"
],
"SegmentAlgorithmName": [
"text"
],
"SegmentAlgorithmType": [
"text"
],
"SegmentedPropertyCategoryCodeSequence": [
"text"
],
"SegmentedPropertyTypeCodeSequence": [
"text"
],
"SeriesDescription": [
"text"
],
"SeriesInstanceUID": [
"text"
],
"SeriesNumber": [
"text"
],
"SliceThickness_btw": [
0
],
"SliceThickness_ebtw": [
0
],
"SliceThickness_btwe": [
0
],
"SliceThickness_ebtwe": [
0
],
"SliceThickness_gte": [
0
],
"SliceThickness_lte": [
0
],
"SliceThickness_gt": [
0
],
"SliceThickness_lt": [
0
],
"SliceThickness_eq": [
0
],
"SOPClassUID": [
"text"
],
"SOPInstanceUID": [
"text"
],
"Sphericity": [
"text"
],
"Sphericity_quant_btw": [
0
],
"Sphericity_quant_ebtw": [
0
],
"Sphericity_quant_btwe": [
0
],
"Sphericity_quant_ebtwe": [
0
],
"Sphericity_quant_gte": [
0
],
"Sphericity_quant_lte": [
0
],
"Sphericity_quant_gt": [
0
],
"Sphericity_quant_lt": [
0
],
"Sphericity_quant_eq": [
0
],
"Spiculation": [
"text"
],
"StudyDate": [
"text"
],
"StudyDescription": [
"text"
],
"StudyInstanceUID": [
"text"
],
"Subtlety_score": [
"text"
],
"Surface_area_of_mesh_btw": [
0
],
"Surface_area_of_mesh_ebtw": [
0
],
"Surface_area_of_mesh_btwe": [
0
],
"Surface_area_of_mesh_ebtwe": [
0
],
"Surface_area_of_mesh_gte": [
0
],
"Surface_area_of_mesh_lte": [
0
],
"Surface_area_of_mesh_gt": [
0
],
"Surface_area_of_mesh_lt": [
0
],
"Surface_area_of_mesh_eq": [
0
],
"tcia_species": [
"text"
],
"tcia_tumorLocation": [
"text"
],
"Texture": [
"text"
],
"Volume_btw": [
0
],
"Volume_ebtw": [
0
],
"Volume_btwe": [
0
],
"Volume_ebtwe": [
0
],
"Volume_gte": [
0
],
"Volume_lte": [
0
],
"Volume_gt": [
0
],
"Volume_lt": [
0
],
"Volume_eq": [
0
],
"Volume_of_Mesh_btw": [
0
],
"Volume_of_Mesh_ebtw": [
0
],
"Volume_of_Mesh_btwe": [
0
],
"Volume_of_Mesh_ebtwe": [
0
],
"Volume_of_Mesh_gte": [
0
],
"Volume_of_Mesh_lte": [
0
],
"Volume_of_Mesh_gt": [
0
],
"Volume_of_Mesh_lt": [
0
],
"Volume_of_Mesh_eq": [
0
]
}
},
"sql": "text"
},
"manifest": {
"manifest_data": [
{
"analysis_results_id": "text",
"AnatomicRegionSequence": "text",
"Apparent_Diffusion_Coefficient": 0,
"aws_bucket": "text",
"aws_url": "text",
"bmi": 0,
"BodyPartExamined": "text",
"Calcification": "text",
"CancerType": "text",
"collection_id": "text",
"country": "text",
"crdc_instance_uuid": "text",
"crdc_series_uuid": "text",
"crdc_study_uuid": "text",
"Diameter": 0,
"disease_code": "text",
"ethnicity": "text",
"FrameOfReferenceUID": "text",
"gcs_bucket": "text",
"gcs_url": "text",
"gender": "text",
"histological_type": "text",
"illuminationType": "text",
"Internal_structure": "text",
"license_short_name": "text",
"Lobular_Pattern": "text",
"Malignancy": "text",
"Manufacturer": "text",
"ManufacturerModelName": "text",
"Margin": "text",
"min_PixelSpacing": 0,
"Modality": "text",
"pathologic_stage": "text",
"PatientID": "text",
"primaryAnatomicStructure": "text",
"Program": "text",
"project_name": "text",
"project_short_name": "text",
"race": "text",
"sample_type": "text",
"SegmentAlgorithmType": "text",
"SegmentedPropertyCategoryCodeSequence": "text",
"SegmentedPropertyTypeCodeSequence": "text",
"SeriesDescription": "text",
"SeriesInstanceUID": "text",
"SeriesNumber": "text",
"SliceThickness": 0,
"SOPClassUID": "text",
"SOPInstanceUID": "text",
"source_DOI": "text",
"Sphericity": "text",
"Sphericity_quant": 0,
"Spiculation": "text",
"StudyDate": "text",
"StudyDescription": "text",
"StudyInstanceUID": "text",
"Subtlety_score": "text",
"Surface_area_of_mesh": 0,
"tcia_species": "text",
"tcia_tumorLocation": "text",
"Texture": "text",
"tumor_tissue_site": "text",
"vital_status": "text",
"Volume": 0,
"Volume_of_Mesh": 0,
"instance_count": 0,
"series_count": 0,
"study_count": 0,
"patient_count": 0,
"collection_count": 0,
"group_size": 0
}
]
},
"next_page": "text"
}
Returns a manifest of a 'previewed cohort' as defined by a specified filterset. The filterset is always applied to the current IDC version. The metadata to be returned in the manifest is configurable. A previewed cohort is not saved in the user's IDC account.
Cohort definition and list of fields to query.
If True, return counts of DICOM objects
If True, return size in bytes of instances in group
If True, return the BQ SQL for this query.
Maximum number of rows to return
Preview cohort spec and manifest
const response = await fetch('/cohorts/manifest/preview', {
method: 'POST',
headers: {
"Content-Type": "application/json"
},
body: JSON.stringify({
"cohort_def": {
"name": "mycohort",
"description": "<p>Example description</p>",
"filters": {
"collection_id": [
"TCGA_luad",
"tcga_kirc"
],
"Modality": [
"CT",
"MR"
],
"Race": [
"WHITE"
],
"age_at_diagnosis_btw": [
65,
75
]
},
"__$markdownParsed": true
},
"fields": [
"Age_At_Diagnosis",
"aws_bucket",
"crdc_series_uuid",
"Modality",
"SliceThickness"
],
"counts": true,
"group_size": true,
"sql": true,
"page_size": 1000
}),
});
const data = await response.json();
{
"cohort": {
"name": "text",
"description": "text",
"filterSet": {
"idc_data_version": "text",
"filters": {
"project_short_name": [
"text"
],
"sample_type": [
"text"
],
"age_at_diagnosis_btw": [],
"age_at_diagnosis_ebtw": [],
"age_at_diagnosis_btwe": [],
"age_at_diagnosis_ebtwe": [],
"age_at_diagnosis_gte": [],
"age_at_diagnosis_lte": [],
"age_at_diagnosis_gt": [],
"age_at_diagnosis_lt": [],
"age_at_diagnosis_eq": [],
"bmi_btw": [
0
],
"bmi_ebtw": [
0
],
"bmi_btwe": [
0
],
"bmi_ebtwe": [
0
],
"bmi_gte": [
0
],
"bmi_lte": [
0
],
"bmi_gt": [
0
],
"bmi_lt": [
0
],
"bmi_eq": [
0
],
"country": [
"text"
],
"disease_code": [
"text"
],
"ethnicity": [
"text"
],
"gender": [
"text"
],
"histological_type": [
"text"
],
"pathologic_stage": [
"text"
],
"project_name": [
"text"
],
"race": [
"text"
],
"tumor_tissue_site": [
"text"
],
"vital_status": [
"text"
],
"analysis_results_id": [
"text"
],
"AnatomicRegionSequence": [
"text"
],
"Apparent_Diffusion_Coefficient_btw": [
0
],
"Apparent_Diffusion_Coefficient_ebtw": [
0
],
"Apparent_Diffusion_Coefficient_btwe": [
0
],
"Apparent_Diffusion_Coefficient_ebtwe": [
0
],
"Apparent_Diffusion_Coefficient_gte": [
0
],
"Apparent_Diffusion_Coefficient_lte": [
0
],
"Apparent_Diffusion_Coefficient_gt": [
0
],
"Apparent_Diffusion_Coefficient_lt": [
0
],
"Apparent_Diffusion_Coefficient_eq": [
0
],
"BodyPartExamined": [
"text"
],
"Calcification": [
"text"
],
"CancerType": [
"text"
],
"collection_id": [
"text"
],
"Diameter_btw": [
0
],
"Diameter_ebtw": [
0
],
"Diameter_btwe": [
0
],
"Diameter_ebtwe": [
0
],
"Diameter_gte": [
0
],
"Diameter_lte": [
0
],
"Diameter_gt": [
0
],
"Diameter_lt": [
0
],
"Diameter_eq": [
0
],
"illuminationType": [
"text"
],
"Internal_structure": [
"text"
],
"license_short_name": [
"text"
],
"Lobular_Pattern": [
"text"
],
"Malignancy": [
"text"
],
"Manufacturer": [
"text"
],
"ManufacturerModelName": [
"text"
],
"Margin": [
"text"
],
"max_TotalPixelMatrixColumns_btw": [],
"max_TotalPixelMatrixColumns_ebtw": [],
"max_TotalPixelMatrixColumns_btwe": [],
"max_TotalPixelMatrixColumns_ebtwe": [],
"max_TotalPixelMatrixColumns_gte": [],
"max_TotalPixelMatrixColumns_lte": [],
"max_TotalPixelMatrixColumns_gt": [],
"max_TotalPixelMatrixColumns_lt": [],
"max_TotalPixelMatrixColumns_eq": [],
"max_TotalPixelMatrixRows_btw": [],
"max_TotalPixelMatrixRows_ebtw": [],
"max_TotalPixelMatrixRows_btwe": [],
"max_TotalPixelMatrixRows_ebtwe": [],
"max_TotalPixelMatrixRows_gte": [],
"max_TotalPixelMatrixRows_lte": [],
"max_TotalPixelMatrixRows_gt": [],
"max_TotalPixelMatrixRows_lt": [],
"max_TotalPixelMatrixRows_eq": [],
"min_PixelSpacing_btw": [],
"min_PixelSpacing_ebtw": [],
"min_PixelSpacing_btwe": [],
"min_PixelSpacing_ebtwe": [],
"min_PixelSpacing_gte": [],
"min_PixelSpacing_lte": [],
"min_PixelSpacing_gt": [],
"min_PixelSpacing_lt": [],
"min_PixelSpacing_eq": [],
"Modality": [
"text"
],
"ObjectiveLensPower": [
0
],
"PatientID": [
"text"
],
"primaryAnatomicStructure": [
"text"
],
"SamplesPerPixel": [
"text"
],
"SegmentAlgorithmName": [
"text"
],
"SegmentAlgorithmType": [
"text"
],
"SegmentedPropertyCategoryCodeSequence": [
"text"
],
"SegmentedPropertyTypeCodeSequence": [
"text"
],
"SeriesDescription": [
"text"
],
"SeriesInstanceUID": [
"text"
],
"SeriesNumber": [
"text"
],
"SliceThickness_btw": [
0
],
"SliceThickness_ebtw": [
0
],
"SliceThickness_btwe": [
0
],
"SliceThickness_ebtwe": [
0
],
"SliceThickness_gte": [
0
],
"SliceThickness_lte": [
0
],
"SliceThickness_gt": [
0
],
"SliceThickness_lt": [
0
],
"SliceThickness_eq": [
0
],
"SOPClassUID": [
"text"
],
"SOPInstanceUID": [
"text"
],
"Sphericity": [
"text"
],
"Sphericity_quant_btw": [
0
],
"Sphericity_quant_ebtw": [
0
],
"Sphericity_quant_btwe": [
0
],
"Sphericity_quant_ebtwe": [
0
],
"Sphericity_quant_gte": [
0
],
"Sphericity_quant_lte": [
0
],
"Sphericity_quant_gt": [
0
],
"Sphericity_quant_lt": [
0
],
"Sphericity_quant_eq": [
0
],
"Spiculation": [
"text"
],
"StudyDate": [
"text"
],
"StudyDescription": [
"text"
],
"StudyInstanceUID": [
"text"
],
"Subtlety_score": [
"text"
],
"Surface_area_of_mesh_btw": [
0
],
"Surface_area_of_mesh_ebtw": [
0
],
"Surface_area_of_mesh_btwe": [
0
],
"Surface_area_of_mesh_ebtwe": [
0
],
"Surface_area_of_mesh_gte": [
0
],
"Surface_area_of_mesh_lte": [
0
],
"Surface_area_of_mesh_gt": [
0
],
"Surface_area_of_mesh_lt": [
0
],
"Surface_area_of_mesh_eq": [
0
],
"tcia_species": [
"text"
],
"tcia_tumorLocation": [
"text"
],
"Texture": [
"text"
],
"Volume_btw": [
0
],
"Volume_ebtw": [
0
],
"Volume_btwe": [
0
],
"Volume_ebtwe": [
0
],
"Volume_gte": [
0
],
"Volume_lte": [
0
],
"Volume_gt": [
0
],
"Volume_lt": [
0
],
"Volume_eq": [
0
],
"Volume_of_Mesh_btw": [
0
],
"Volume_of_Mesh_ebtw": [
0
],
"Volume_of_Mesh_btwe": [
0
],
"Volume_of_Mesh_ebtwe": [
0
],
"Volume_of_Mesh_gte": [
0
],
"Volume_of_Mesh_lte": [
0
],
"Volume_of_Mesh_gt": [
0
],
"Volume_of_Mesh_lt": [
0
],
"Volume_of_Mesh_eq": [
0
]
}
},
"sql": "text"
},
"manifest": {
"manifest_data": [
{
"analysis_results_id": "text",
"AnatomicRegionSequence": "text",
"Apparent_Diffusion_Coefficient": 0,
"aws_bucket": "text",
"aws_url": "text",
"bmi": 0,
"BodyPartExamined": "text",
"Calcification": "text",
"CancerType": "text",
"collection_id": "text",
"country": "text",
"crdc_instance_uuid": "text",
"crdc_series_uuid": "text",
"crdc_study_uuid": "text",
"Diameter": 0,
"disease_code": "text",
"ethnicity": "text",
"FrameOfReferenceUID": "text",
"gcs_bucket": "text",
"gcs_url": "text",
"gender": "text",
"histological_type": "text",
"illuminationType": "text",
"Internal_structure": "text",
"license_short_name": "text",
"Lobular_Pattern": "text",
"Malignancy": "text",
"Manufacturer": "text",
"ManufacturerModelName": "text",
"Margin": "text",
"min_PixelSpacing": 0,
"Modality": "text",
"pathologic_stage": "text",
"PatientID": "text",
"primaryAnatomicStructure": "text",
"Program": "text",
"project_name": "text",
"project_short_name": "text",
"race": "text",
"sample_type": "text",
"SegmentAlgorithmType": "text",
"SegmentedPropertyCategoryCodeSequence": "text",
"SegmentedPropertyTypeCodeSequence": "text",
"SeriesDescription": "text",
"SeriesInstanceUID": "text",
"SeriesNumber": "text",
"SliceThickness": 0,
"SOPClassUID": "text",
"SOPInstanceUID": "text",
"source_DOI": "text",
"Sphericity": "text",
"Sphericity_quant": 0,
"Spiculation": "text",
"StudyDate": "text",
"StudyDescription": "text",
"StudyInstanceUID": "text",
"Subtlety_score": "text",
"Surface_area_of_mesh": 0,
"tcia_species": "text",
"tcia_tumorLocation": "text",
"Texture": "text",
"tumor_tissue_site": "text",
"vital_status": "text",
"Volume": 0,
"Volume_of_Mesh": 0,
"instance_count": 0,
"series_count": 0,
"study_count": 0,
"patient_count": 0,
"collection_count": 0,
"group_size": 0
}
]
},
"next_page": "text"
}
Returns a list of the user's cohorts and associated metadata. Authorization is required in order to access this endpoint.
A list of the user's cohorts.
const response = await fetch('/cohorts', {
method: 'GET',
headers: {},
});
const data = await response.json();
{
"cohorts": [
{
"name": "text",
"description": "text",
"owner": "text",
"permission": "OWNER",
"filterSet": {
"idc_data_version": "text",
"filters": {
"project_short_name": [
"text"
],
"sample_type": [
"text"
],
"age_at_diagnosis_btw": [],
"age_at_diagnosis_ebtw": [],
"age_at_diagnosis_btwe": [],
"age_at_diagnosis_ebtwe": [],
"age_at_diagnosis_gte": [],
"age_at_diagnosis_lte": [],
"age_at_diagnosis_gt": [],
"age_at_diagnosis_lt": [],
"age_at_diagnosis_eq": [],
"bmi_btw": [
0
],
"bmi_ebtw": [
0
],
"bmi_btwe": [
0
],
"bmi_ebtwe": [
0
],
"bmi_gte": [
0
],
"bmi_lte": [
0
],
"bmi_gt": [
0
],
"bmi_lt": [
0
],
"bmi_eq": [
0
],
"country": [
"text"
],
"disease_code": [
"text"
],
"ethnicity": [
"text"
],
"gender": [
"text"
],
"histological_type": [
"text"
],
"pathologic_stage": [
"text"
],
"project_name": [
"text"
],
"race": [
"text"
],
"tumor_tissue_site": [
"text"
],
"vital_status": [
"text"
],
"analysis_results_id": [
"text"
],
"AnatomicRegionSequence": [
"text"
],
"Apparent_Diffusion_Coefficient_btw": [
0
],
"Apparent_Diffusion_Coefficient_ebtw": [
0
],
"Apparent_Diffusion_Coefficient_btwe": [
0
],
"Apparent_Diffusion_Coefficient_ebtwe": [
0
],
"Apparent_Diffusion_Coefficient_gte": [
0
],
"Apparent_Diffusion_Coefficient_lte": [
0
],
"Apparent_Diffusion_Coefficient_gt": [
0
],
"Apparent_Diffusion_Coefficient_lt": [
0
],
"Apparent_Diffusion_Coefficient_eq": [
0
],
"BodyPartExamined": [
"text"
],
"Calcification": [
"text"
],
"CancerType": [
"text"
],
"collection_id": [
"text"
],
"Diameter_btw": [
0
],
"Diameter_ebtw": [
0
],
"Diameter_btwe": [
0
],
"Diameter_ebtwe": [
0
],
"Diameter_gte": [
0
],
"Diameter_lte": [
0
],
"Diameter_gt": [
0
],
"Diameter_lt": [
0
],
"Diameter_eq": [
0
],
"illuminationType": [
"text"
],
"Internal_structure": [
"text"
],
"license_short_name": [
"text"
],
"Lobular_Pattern": [
"text"
],
"Malignancy": [
"text"
],
"Manufacturer": [
"text"
],
"ManufacturerModelName": [
"text"
],
"Margin": [
"text"
],
"max_TotalPixelMatrixColumns_btw": [],
"max_TotalPixelMatrixColumns_ebtw": [],
"max_TotalPixelMatrixColumns_btwe": [],
"max_TotalPixelMatrixColumns_ebtwe": [],
"max_TotalPixelMatrixColumns_gte": [],
"max_TotalPixelMatrixColumns_lte": [],
"max_TotalPixelMatrixColumns_gt": [],
"max_TotalPixelMatrixColumns_lt": [],
"max_TotalPixelMatrixColumns_eq": [],
"max_TotalPixelMatrixRows_btw": [],
"max_TotalPixelMatrixRows_ebtw": [],
"max_TotalPixelMatrixRows_btwe": [],
"max_TotalPixelMatrixRows_ebtwe": [],
"max_TotalPixelMatrixRows_gte": [],
"max_TotalPixelMatrixRows_lte": [],
"max_TotalPixelMatrixRows_gt": [],
"max_TotalPixelMatrixRows_lt": [],
"max_TotalPixelMatrixRows_eq": [],
"min_PixelSpacing_btw": [],
"min_PixelSpacing_ebtw": [],
"min_PixelSpacing_btwe": [],
"min_PixelSpacing_ebtwe": [],
"min_PixelSpacing_gte": [],
"min_PixelSpacing_lte": [],
"min_PixelSpacing_gt": [],
"min_PixelSpacing_lt": [],
"min_PixelSpacing_eq": [],
"Modality": [
"text"
],
"ObjectiveLensPower": [
0
],
"PatientID": [
"text"
],
"primaryAnatomicStructure": [
"text"
],
"SamplesPerPixel": [
"text"
],
"SegmentAlgorithmName": [
"text"
],
"SegmentAlgorithmType": [
"text"
],
"SegmentedPropertyCategoryCodeSequence": [
"text"
],
"SegmentedPropertyTypeCodeSequence": [
"text"
],
"SeriesDescription": [
"text"
],
"SeriesInstanceUID": [
"text"
],
"SeriesNumber": [
"text"
],
"SliceThickness_btw": [
0
],
"SliceThickness_ebtw": [
0
],
"SliceThickness_btwe": [
0
],
"SliceThickness_ebtwe": [
0
],
"SliceThickness_gte": [
0
],
"SliceThickness_lte": [
0
],
"SliceThickness_gt": [
0
],
"SliceThickness_lt": [
0
],
"SliceThickness_eq": [
0
],
"SOPClassUID": [
"text"
],
"SOPInstanceUID": [
"text"
],
"Sphericity": [
"text"
],
"Sphericity_quant_btw": [
0
],
"Sphericity_quant_ebtw": [
0
],
"Sphericity_quant_btwe": [
0
],
"Sphericity_quant_ebtwe": [
0
],
"Sphericity_quant_gte": [
0
],
"Sphericity_quant_lte": [
0
],
"Sphericity_quant_gt": [
0
],
"Sphericity_quant_lt": [
0
],
"Sphericity_quant_eq": [
0
],
"Spiculation": [
"text"
],
"StudyDate": [
"text"
],
"StudyDescription": [
"text"
],
"StudyInstanceUID": [
"text"
],
"Subtlety_score": [
"text"
],
"Surface_area_of_mesh_btw": [
0
],
"Surface_area_of_mesh_ebtw": [
0
],
"Surface_area_of_mesh_btwe": [
0
],
"Surface_area_of_mesh_ebtwe": [
0
],
"Surface_area_of_mesh_gte": [
0
],
"Surface_area_of_mesh_lte": [
0
],
"Surface_area_of_mesh_gt": [
0
],
"Surface_area_of_mesh_lt": [
0
],
"Surface_area_of_mesh_eq": [
0
],
"tcia_species": [
"text"
],
"tcia_tumorLocation": [
"text"
],
"Texture": [
"text"
],
"Volume_btw": [
0
],
"Volume_ebtw": [
0
],
"Volume_btwe": [
0
],
"Volume_ebtwe": [
0
],
"Volume_gte": [
0
],
"Volume_lte": [
0
],
"Volume_gt": [
0
],
"Volume_lt": [
0
],
"Volume_eq": [
0
],
"Volume_of_Mesh_btw": [
0
],
"Volume_of_Mesh_ebtw": [
0
],
"Volume_of_Mesh_btwe": [
0
],
"Volume_of_Mesh_ebtwe": [
0
],
"Volume_of_Mesh_gte": [
0
],
"Volume_of_Mesh_lte": [
0
],
"Volume_of_Mesh_gt": [
0
],
"Volume_of_Mesh_lt": [
0
],
"Volume_of_Mesh_eq": [
0
]
}
}
}
]
}
Create a cohort as defined by a specified 'filterset' and IDC version. Authorization is required in order to access this endpoint.
Filters, name, and description used to create this cohort.
Summary information about the cohort created.
const response = await fetch('/cohorts', {
method: 'POST',
headers: {
"Content-Type": "application/json"
},
body: JSON.stringify({
"name": "mycohort",
"description": "<p>Example description</p>",
"filters": {
"collection_id": [
"tcga_luad",
"tcga_kirc"
],
"Modality": [
"CT",
"MR"
],
"race": [
"WHITE"
],
"age_at_diagnosis_btw": [
65,
75
]
},
"__$markdownParsed": true
}),
});
const data = await response.json();
{
"cohort_properties": {
"cohort_id": "text",
"name": "text",
"description": "text",
"filter": {
"idc_data_version": "text",
"filters": {
"project_short_name": [
"text"
],
"sample_type": [
"text"
],
"age_at_diagnosis_btw": [],
"age_at_diagnosis_ebtw": [],
"age_at_diagnosis_btwe": [],
"age_at_diagnosis_ebtwe": [],
"age_at_diagnosis_gte": [],
"age_at_diagnosis_lte": [],
"age_at_diagnosis_gt": [],
"age_at_diagnosis_lt": [],
"age_at_diagnosis_eq": [],
"bmi_btw": [
0
],
"bmi_ebtw": [
0
],
"bmi_btwe": [
0
],
"bmi_ebtwe": [
0
],
"bmi_gte": [
0
],
"bmi_lte": [
0
],
"bmi_gt": [
0
],
"bmi_lt": [
0
],
"bmi_eq": [
0
],
"country": [
"text"
],
"disease_code": [
"text"
],
"ethnicity": [
"text"
],
"gender": [
"text"
],
"histological_type": [
"text"
],
"pathologic_stage": [
"text"
],
"project_name": [
"text"
],
"race": [
"text"
],
"tumor_tissue_site": [
"text"
],
"vital_status": [
"text"
],
"analysis_results_id": [
"text"
],
"AnatomicRegionSequence": [
"text"
],
"Apparent_Diffusion_Coefficient_btw": [
0
],
"Apparent_Diffusion_Coefficient_ebtw": [
0
],
"Apparent_Diffusion_Coefficient_btwe": [
0
],
"Apparent_Diffusion_Coefficient_ebtwe": [
0
],
"Apparent_Diffusion_Coefficient_gte": [
0
],
"Apparent_Diffusion_Coefficient_lte": [
0
],
"Apparent_Diffusion_Coefficient_gt": [
0
],
"Apparent_Diffusion_Coefficient_lt": [
0
],
"Apparent_Diffusion_Coefficient_eq": [
0
],
"BodyPartExamined": [
"text"
],
"Calcification": [
"text"
],
"CancerType": [
"text"
],
"collection_id": [
"text"
],
"Diameter_btw": [
0
],
"Diameter_ebtw": [
0
],
"Diameter_btwe": [
0
],
"Diameter_ebtwe": [
0
],
"Diameter_gte": [
0
],
"Diameter_lte": [
0
],
"Diameter_gt": [
0
],
"Diameter_lt": [
0
],
"Diameter_eq": [
0
],
"illuminationType": [
"text"
],
"Internal_structure": [
"text"
],
"license_short_name": [
"text"
],
"Lobular_Pattern": [
"text"
],
"Malignancy": [
"text"
],
"Manufacturer": [
"text"
],
"ManufacturerModelName": [
"text"
],
"Margin": [
"text"
],
"max_TotalPixelMatrixColumns_btw": [],
"max_TotalPixelMatrixColumns_ebtw": [],
"max_TotalPixelMatrixColumns_btwe": [],
"max_TotalPixelMatrixColumns_ebtwe": [],
"max_TotalPixelMatrixColumns_gte": [],
"max_TotalPixelMatrixColumns_lte": [],
"max_TotalPixelMatrixColumns_gt": [],
"max_TotalPixelMatrixColumns_lt": [],
"max_TotalPixelMatrixColumns_eq": [],
"max_TotalPixelMatrixRows_btw": [],
"max_TotalPixelMatrixRows_ebtw": [],
"max_TotalPixelMatrixRows_btwe": [],
"max_TotalPixelMatrixRows_ebtwe": [],
"max_TotalPixelMatrixRows_gte": [],
"max_TotalPixelMatrixRows_lte": [],
"max_TotalPixelMatrixRows_gt": [],
"max_TotalPixelMatrixRows_lt": [],
"max_TotalPixelMatrixRows_eq": [],
"min_PixelSpacing_btw": [],
"min_PixelSpacing_ebtw": [],
"min_PixelSpacing_btwe": [],
"min_PixelSpacing_ebtwe": [],
"min_PixelSpacing_gte": [],
"min_PixelSpacing_lte": [],
"min_PixelSpacing_gt": [],
"min_PixelSpacing_lt": [],
"min_PixelSpacing_eq": [],
"Modality": [
"text"
],
"ObjectiveLensPower": [
0
],
"PatientID": [
"text"
],
"primaryAnatomicStructure": [
"text"
],
"SamplesPerPixel": [
"text"
],
"SegmentAlgorithmName": [
"text"
],
"SegmentAlgorithmType": [
"text"
],
"SegmentedPropertyCategoryCodeSequence": [
"text"
],
"SegmentedPropertyTypeCodeSequence": [
"text"
],
"SeriesDescription": [
"text"
],
"SeriesInstanceUID": [
"text"
],
"SeriesNumber": [
"text"
],
"SliceThickness_btw": [
0
],
"SliceThickness_ebtw": [
0
],
"SliceThickness_btwe": [
0
],
"SliceThickness_ebtwe": [
0
],
"SliceThickness_gte": [
0
],
"SliceThickness_lte": [
0
],
"SliceThickness_gt": [
0
],
"SliceThickness_lt": [
0
],
"SliceThickness_eq": [
0
],
"SOPClassUID": [
"text"
],
"SOPInstanceUID": [
"text"
],
"Sphericity": [
"text"
],
"Sphericity_quant_btw": [
0
],
"Sphericity_quant_ebtw": [
0
],
"Sphericity_quant_btwe": [
0
],
"Sphericity_quant_ebtwe": [
0
],
"Sphericity_quant_gte": [
0
],
"Sphericity_quant_lte": [
0
],
"Sphericity_quant_gt": [
0
],
"Sphericity_quant_lt": [
0
],
"Sphericity_quant_eq": [
0
],
"Spiculation": [
"text"
],
"StudyDate": [
"text"
],
"StudyDescription": [
"text"
],
"StudyInstanceUID": [
"text"
],
"Subtlety_score": [
"text"
],
"Surface_area_of_mesh_btw": [
0
],
"Surface_area_of_mesh_ebtw": [
0
],
"Surface_area_of_mesh_btwe": [
0
],
"Surface_area_of_mesh_ebtwe": [
0
],
"Surface_area_of_mesh_gte": [
0
],
"Surface_area_of_mesh_lte": [
0
],
"Surface_area_of_mesh_gt": [
0
],
"Surface_area_of_mesh_lt": [
0
],
"Surface_area_of_mesh_eq": [
0
],
"tcia_species": [
"text"
],
"tcia_tumorLocation": [
"text"
],
"Texture": [
"text"
],
"Volume_btw": [
0
],
"Volume_ebtw": [
0
],
"Volume_btwe": [
0
],
"Volume_ebtwe": [
0
],
"Volume_gte": [
0
],
"Volume_lte": [
0
],
"Volume_gt": [
0
],
"Volume_lt": [
0
],
"Volume_eq": [
0
],
"Volume_of_Mesh_btw": [
0
],
"Volume_of_Mesh_ebtw": [
0
],
"Volume_of_Mesh_btwe": [
0
],
"Volume_of_Mesh_ebtwe": [
0
],
"Volume_of_Mesh_gte": [
0
],
"Volume_of_Mesh_lte": [
0
],
"Volume_of_Mesh_gt": [
0
],
"Volume_of_Mesh_lt": [
0
],
"Volume_of_Mesh_eq": [
0
]
}
}
}
}