Endpoint Details

This page provides details on each of the IDC API endpoints.

Get links to the IDC API Swagger UI and IDC documentation

GET/about

Response

200500

API Description and link to SwaggerUI interface.

Body

application/json

messagestring

documentationstring

codeinteger

Request

JavaScriptCurlPython

const response = await fetch('/about', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200500

{
  "message": "text",
  "documentation": "text",
  "code": 0
}

Returns a list of IDC data versions and activation dates

GET/versions

Response

200500

A list of IDC data versions and metadata

Body

application/json

idc_data_versionsarray of object

codeinteger

Request

JavaScriptCurlPython

const response = await fetch('/versions', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200500

{
  "idc_data_versions": [
    {
      "idc_data_version": "text",
      "date_active": "text",
      "active": "text"
    }
  ],
  "code": 0
}

Returns a list of collections, and associated metadata, in the current IDC data version.

GET/collections

Response

200500

A list of collections

Body

application/json

collectionsarray of collectionMetadata (object)

codeinteger

Request

JavaScriptCurlPython

const response = await fetch('/collections', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200500

{
  "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",
      "subject_count": 0,
      "supporting_data": "text"
    }
  ],
  "code": 0
}

Returns a list of the analysis results, and associated metadata, in the current IDC data version

GET/analysis_results

Response

200500

A list of analysis results

Body

application/json

analysisResultsarray of analysisResultsMetadata (object)

codeinteger

Request

JavaScriptCurlPython

const response = await fetch('/analysis_results', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200500

{
  "analysisResults": [
    {
      "analysis_result_id": "text",
      "analysisArtifacts": "text",
      "cancer_type": "text",
      "collections": "text",
      "date_updated": "text",
      "description": "text",
      "doi": "text",
      "location": "text",
      "subjects": 0,
      "title": "text"
    }
  ],
  "code": 0
}

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.

GET/filters

Response

200500

A list of filters

Body

application/json

idc_data_versionstring

data_sourcesarray of data_source_filters (object)

codeinteger

Request

JavaScriptCurlPython

const response = await fetch('/filters', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200500

{
  "idc_data_version": "text",
  "data_sources": [
    {
      "data_source": "text",
      "filters": [
        {
          "name": "text",
          "data_type": "CONTINUOUS_NUMERIC",
          "units": "text"
        }
      ]
    }
  ],
  "code": 0
}

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'.

GET/filters/values/{filter}

Path parameters

filter*string

Categorical filter whose values are to be returned

Response

200500

A list of accepted values

Body

application/json

valuesarray of string

Request

JavaScriptCurlPython

const response = await fetch('/filters/values/{filter}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200500

{
  "values": [
    "text"
  ]
}

Return a list of queryable manifest fields.

GET/fields/{version}

Path parameters

version*string

IDC data version whose data is to be returned. If the version is 'current', the fields of the current IDC version are returned.

Response

200500

A list of fields

Body

application/json

idc_data_versionstring

data_sourcesarray of data_source_fields (object)

codeinteger

Request

JavaScriptCurlPython

const response = await fetch('/fields/{version}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200500

{
  "idc_data_version": "text",
  "data_sources": [
    {
      "data_source": "text",
      "fields": [
        "text"
      ]
    }
  ],
  "code": 0
}

Returns a list of the user's cohorts and associated metadata. Authorization is required in order to access this endpoint.

GET/cohorts

Response

200500

A list of the user's cohorts.

Body

application/json

cohortsarray of cohortMetadata (object)

Request

JavaScriptCurlPython

const response = await fetch('/cohorts', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200500

{
  "cohorts": [
    {
      "cohort_id": 0,
      "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": [
            0
          ],
          "age_at_diagnosis_ebtw": [
            0
          ],
          "age_at_diagnosis_btwe": [
            0
          ],
          "age_at_diagnosis_ebtwe": [
            0
          ],
          "age_at_diagnosis_gte": [
            0
          ],
          "age_at_diagnosis_lte": [
            0
          ],
          "age_at_diagnosis_gt": [
            0
          ],
          "age_at_diagnosis_lt": [
            0
          ],
          "age_at_diagnosis_eq": [
            0
          ],
          "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": [
            0
          ],
          "max_TotalPixelMatrixColumns_ebtw": [
            0
          ],
          "max_TotalPixelMatrixColumns_btwe": [
            0
          ],
          "max_TotalPixelMatrixColumns_ebtwe": [
            0
          ],
          "max_TotalPixelMatrixColumns_gte": [
            0
          ],
          "max_TotalPixelMatrixColumns_lte": [
            0
          ],
          "max_TotalPixelMatrixColumns_gt": [
            0
          ],
          "max_TotalPixelMatrixColumns_lt": [
            0
          ],
          "max_TotalPixelMatrixColumns_eq": [
            0
          ],
          "max_TotalPixelMatrixRows_btw": [
            0
          ],
          "max_TotalPixelMatrixRows_ebtw": [
            0
          ],
          "max_TotalPixelMatrixRows_btwe": [
            0
          ],
          "max_TotalPixelMatrixRows_ebtwe": [
            0
          ],
          "max_TotalPixelMatrixRows_gte": [
            0
          ],
          "max_TotalPixelMatrixRows_lte": [
            0
          ],
          "max_TotalPixelMatrixRows_gt": [
            0
          ],
          "max_TotalPixelMatrixRows_lt": [
            0
          ],
          "max_TotalPixelMatrixRows_eq": [
            0
          ],
          "min_PixelSpacing_btw": [
            0
          ],
          "min_PixelSpacing_ebtw": [
            0
          ],
          "min_PixelSpacing_btwe": [
            0
          ],
          "min_PixelSpacing_ebtwe": [
            0
          ],
          "min_PixelSpacing_gte": [
            0
          ],
          "min_PixelSpacing_lte": [
            0
          ],
          "min_PixelSpacing_gt": [
            0
          ],
          "min_PixelSpacing_lt": [
            0
          ],
          "min_PixelSpacing_eq": [
            0
          ],
          "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.

POST/cohorts

Body

application/json

Filters, name, and description used to create this cohort.

namestring

descriptionstring

filters*filters (object)

Response

200400500

Summary information about the cohort created.

Body

application/json

cohort_propertiesobject

codeinteger

Request

JavaScriptCurlPython

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();

Response

200400500

{
  "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": [
          0
        ],
        "age_at_diagnosis_ebtw": [
          0
        ],
        "age_at_diagnosis_btwe": [
          0
        ],
        "age_at_diagnosis_ebtwe": [
          0
        ],
        "age_at_diagnosis_gte": [
          0
        ],
        "age_at_diagnosis_lte": [
          0
        ],
        "age_at_diagnosis_gt": [
          0
        ],
        "age_at_diagnosis_lt": [
          0
        ],
        "age_at_diagnosis_eq": [
          0
        ],
        "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": [
          0
        ],
        "max_TotalPixelMatrixColumns_ebtw": [
          0
        ],
        "max_TotalPixelMatrixColumns_btwe": [
          0
        ],
        "max_TotalPixelMatrixColumns_ebtwe": [
          0
        ],
        "max_TotalPixelMatrixColumns_gte": [
          0
        ],
        "max_TotalPixelMatrixColumns_lte": [
          0
        ],
        "max_TotalPixelMatrixColumns_gt": [
          0
        ],
        "max_TotalPixelMatrixColumns_lt": [
          0
        ],
        "max_TotalPixelMatrixColumns_eq": [
          0
        ],
        "max_TotalPixelMatrixRows_btw": [
          0
        ],
        "max_TotalPixelMatrixRows_ebtw": [
          0
        ],
        "max_TotalPixelMatrixRows_btwe": [
          0
        ],
        "max_TotalPixelMatrixRows_ebtwe": [
          0
        ],
        "max_TotalPixelMatrixRows_gte": [
          0
        ],
        "max_TotalPixelMatrixRows_lte": [
          0
        ],
        "max_TotalPixelMatrixRows_gt": [
          0
        ],
        "max_TotalPixelMatrixRows_lt": [
          0
        ],
        "max_TotalPixelMatrixRows_eq": [
          0
        ],
        "min_PixelSpacing_btw": [
          0
        ],
        "min_PixelSpacing_ebtw": [
          0
        ],
        "min_PixelSpacing_btwe": [
          0
        ],
        "min_PixelSpacing_ebtwe": [
          0
        ],
        "min_PixelSpacing_gte": [
          0
        ],
        "min_PixelSpacing_lte": [
          0
        ],
        "min_PixelSpacing_gt": [
          0
        ],
        "min_PixelSpacing_lt": [
          0
        ],
        "min_PixelSpacing_eq": [
          0
        ],
        "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
        ]
      }
    }
  },
  "code": 0
}

Delete a list of the user's cohorts. Authorization is required in order to access this endpoint.

DELETE/cohorts

Body

application/json

List of IDs of cohorts to be deleted.

cohortsarray of integer

Response

200500

Summary of cohort deletion.

Body

application/json

cohortsarray of object

Request

JavaScriptCurlPython

const response = await fetch('/cohorts', {
    method: 'DELETE',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200500

{
  "cohorts": [
    {
      "cohort_id": 0,
      "result": "text"
    }
  ]
}

Delete a specified cohort. Authorization is required in order to access this endpoint.

DELETE/cohorts/{cohort_id}

Path parameters

cohort_id*integer

ID of cohort to be deleted.

Response

200500

A list of the user's remaining cohorts.

Body

application/json

cohortsarray of object

Request

JavaScriptCurlPython

const response = await fetch('/cohorts/{cohort_id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

200500

{
  "cohorts": [
    {
      "cohort_id": 0,
      "result": "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.

POST/cohorts/manifest/preview

Body

application/json

Cohort definition and list of fields to query.

cohort_def*cohortSpec (object)

fields*fields (array of enum)

countsstring

If True, return counts of DICOM objects

group_sizestring

If True, return size in bytes of instances in group

sqlstring

If True, return the BQ SQL for this query.

page_sizeinteger

Maximum number of rows to return

Response

200202500

Preview cohort spec and manifest

Body

application/json

cohortobject

manifestobject

next_pagestring

codeinteger

Request

JavaScriptCurlPython

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();

Response

200202500

{
  "cohort": {
    "name": "text",
    "description": "text",
    "filterSet": {
      "idc_data_version": "text",
      "filters": {
        "project_short_name": [
          "text"
        ],
        "sample_type": [
          "text"
        ],
        "age_at_diagnosis_btw": [
          0
        ],
        "age_at_diagnosis_ebtw": [
          0
        ],
        "age_at_diagnosis_btwe": [
          0
        ],
        "age_at_diagnosis_ebtwe": [
          0
        ],
        "age_at_diagnosis_gte": [
          0
        ],
        "age_at_diagnosis_lte": [
          0
        ],
        "age_at_diagnosis_gt": [
          0
        ],
        "age_at_diagnosis_lt": [
          0
        ],
        "age_at_diagnosis_eq": [
          0
        ],
        "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": [
          0
        ],
        "max_TotalPixelMatrixColumns_ebtw": [
          0
        ],
        "max_TotalPixelMatrixColumns_btwe": [
          0
        ],
        "max_TotalPixelMatrixColumns_ebtwe": [
          0
        ],
        "max_TotalPixelMatrixColumns_gte": [
          0
        ],
        "max_TotalPixelMatrixColumns_lte": [
          0
        ],
        "max_TotalPixelMatrixColumns_gt": [
          0
        ],
        "max_TotalPixelMatrixColumns_lt": [
          0
        ],
        "max_TotalPixelMatrixColumns_eq": [
          0
        ],
        "max_TotalPixelMatrixRows_btw": [
          0
        ],
        "max_TotalPixelMatrixRows_ebtw": [
          0
        ],
        "max_TotalPixelMatrixRows_btwe": [
          0
        ],
        "max_TotalPixelMatrixRows_ebtwe": [
          0
        ],
        "max_TotalPixelMatrixRows_gte": [
          0
        ],
        "max_TotalPixelMatrixRows_lte": [
          0
        ],
        "max_TotalPixelMatrixRows_gt": [
          0
        ],
        "max_TotalPixelMatrixRows_lt": [
          0
        ],
        "max_TotalPixelMatrixRows_eq": [
          0
        ],
        "min_PixelSpacing_btw": [
          0
        ],
        "min_PixelSpacing_ebtw": [
          0
        ],
        "min_PixelSpacing_btwe": [
          0
        ],
        "min_PixelSpacing_ebtwe": [
          0
        ],
        "min_PixelSpacing_gte": [
          0
        ],
        "min_PixelSpacing_lte": [
          0
        ],
        "min_PixelSpacing_gt": [
          0
        ],
        "min_PixelSpacing_lt": [
          0
        ],
        "min_PixelSpacing_eq": [
          0
        ],
        "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": [
      {
        "age_at_diagnosis": 0,
        "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",
        "instance_size": 0,
        "Internal_structure": "text",
        "license_short_name": "text",
        "Lobular_Pattern": "text",
        "Malignancy": "text",
        "Manufacturer": "text",
        "ManufacturerModelName": "text",
        "Margin": "text",
        "max_TotalPixelMatrixColumns": 0,
        "max_TotalPixelMatrixRows": 0,
        "min_PixelSpacing": 0,
        "Modality": "text",
        "ObjectiveLensPower": 0,
        "pathologic_stage": "text",
        "PatientID": "text",
        "primaryAnatomicStructure": "text",
        "Program": "text",
        "project_name": "text",
        "project_short_name": "text",
        "race": "text",
        "sample_type": "text",
        "SamplesPerPixel": 0,
        "SegmentAlgorithmType": "text",
        "SegmentedPropertyCategoryCodeSequence": "text",
        "SegmentedPropertyTypeCodeSequence": "text",
        "SegmentNumber": 0,
        "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
      }
    ],
    "totalFound": 0,
    "rowsReturned": 0
  },
  "next_page": "text",
  "code": 0
}

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.

POST/cohorts/manifest/{cohort_id}

Path parameters

cohort_id*integer

IDC Cohort ID

Body

application/json

List of fields to return.

fields*fields (array of enum)

countsstring

If True, return counts of DICOM objects

group_sizestring

If True, return size in bytes of instances in group

sqlstring

If True, return the BQ SQL for this query.

page_sizeinteger

Maximum number of rows to return

Response

200202500

Cohort spec and anifest

Body

application/json

cohortobject

manifestobject

next_pagestring

codeinteger

Request

JavaScriptCurlPython

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();

Response

200202500

{
  "cohort": {
    "cohort_id": 0,
    "name": "text",
    "description": "text",
    "user_email": "text",
    "filterSet": {
      "idc_data_version": "text",
      "filters": {
        "project_short_name": [
          "text"
        ],
        "sample_type": [
          "text"
        ],
        "age_at_diagnosis_btw": [
          0
        ],
        "age_at_diagnosis_ebtw": [
          0
        ],
        "age_at_diagnosis_btwe": [
          0
        ],
        "age_at_diagnosis_ebtwe": [
          0
        ],
        "age_at_diagnosis_gte": [
          0
        ],
        "age_at_diagnosis_lte": [
          0
        ],
        "age_at_diagnosis_gt": [
          0
        ],
        "age_at_diagnosis_lt": [
          0
        ],
        "age_at_diagnosis_eq": [
          0
        ],
        "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": [
          0
        ],
        "max_TotalPixelMatrixColumns_ebtw": [
          0
        ],
        "max_TotalPixelMatrixColumns_btwe": [
          0
        ],
        "max_TotalPixelMatrixColumns_ebtwe": [
          0
        ],
        "max_TotalPixelMatrixColumns_gte": [
          0
        ],
        "max_TotalPixelMatrixColumns_lte": [
          0
        ],
        "max_TotalPixelMatrixColumns_gt": [
          0
        ],
        "max_TotalPixelMatrixColumns_lt": [
          0
        ],
        "max_TotalPixelMatrixColumns_eq": [
          0
        ],
        "max_TotalPixelMatrixRows_btw": [
          0
        ],
        "max_TotalPixelMatrixRows_ebtw": [
          0
        ],
        "max_TotalPixelMatrixRows_btwe": [
          0
        ],
        "max_TotalPixelMatrixRows_ebtwe": [
          0
        ],
        "max_TotalPixelMatrixRows_gte": [
          0
        ],
        "max_TotalPixelMatrixRows_lte": [
          0
        ],
        "max_TotalPixelMatrixRows_gt": [
          0
        ],
        "max_TotalPixelMatrixRows_lt": [
          0
        ],
        "max_TotalPixelMatrixRows_eq": [
          0
        ],
        "min_PixelSpacing_btw": [
          0
        ],
        "min_PixelSpacing_ebtw": [
          0
        ],
        "min_PixelSpacing_btwe": [
          0
        ],
        "min_PixelSpacing_ebtwe": [
          0
        ],
        "min_PixelSpacing_gte": [
          0
        ],
        "min_PixelSpacing_lte": [
          0
        ],
        "min_PixelSpacing_gt": [
          0
        ],
        "min_PixelSpacing_lt": [
          0
        ],
        "min_PixelSpacing_eq": [
          0
        ],
        "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": [
      {
        "age_at_diagnosis": 0,
        "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",
        "instance_size": 0,
        "Internal_structure": "text",
        "license_short_name": "text",
        "Lobular_Pattern": "text",
        "Malignancy": "text",
        "Manufacturer": "text",
        "ManufacturerModelName": "text",
        "Margin": "text",
        "max_TotalPixelMatrixColumns": 0,
        "max_TotalPixelMatrixRows": 0,
        "min_PixelSpacing": 0,
        "Modality": "text",
        "ObjectiveLensPower": 0,
        "pathologic_stage": "text",
        "PatientID": "text",
        "primaryAnatomicStructure": "text",
        "Program": "text",
        "project_name": "text",
        "project_short_name": "text",
        "race": "text",
        "sample_type": "text",
        "SamplesPerPixel": 0,
        "SegmentAlgorithmType": "text",
        "SegmentedPropertyCategoryCodeSequence": "text",
        "SegmentedPropertyTypeCodeSequence": "text",
        "SegmentNumber": 0,
        "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
      }
    ],
    "totalFound": 0,
    "rowsReturned": 0
  },
  "next_page": "text",
  "code": 0
}

Returns the next page of a /cohorts/manifest/preview request, when additional data is available.

GET/cohorts/manifest/preview/nextPage

Query parameters

Response

200202500

Preview manifest page

Body

application/json

manifestobject

next_pagestring

codeinteger

Request

JavaScriptCurlPython

const response = await fetch('/cohorts/manifest/preview/nextPage?next_page=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200202500

{
  "manifest": {
    "manifest_data": [
      {
        "age_at_diagnosis": 0,
        "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",
        "instance_size": 0,
        "Internal_structure": "text",
        "license_short_name": "text",
        "Lobular_Pattern": "text",
        "Malignancy": "text",
        "Manufacturer": "text",
        "ManufacturerModelName": "text",
        "Margin": "text",
        "max_TotalPixelMatrixColumns": 0,
        "max_TotalPixelMatrixRows": 0,
        "min_PixelSpacing": 0,
        "Modality": "text",
        "ObjectiveLensPower": 0,
        "pathologic_stage": "text",
        "PatientID": "text",
        "primaryAnatomicStructure": "text",
        "Program": "text",
        "project_name": "text",
        "project_short_name": "text",
        "race": "text",
        "sample_type": "text",
        "SamplesPerPixel": 0,
        "SegmentAlgorithmType": "text",
        "SegmentedPropertyCategoryCodeSequence": "text",
        "SegmentedPropertyTypeCodeSequence": "text",
        "SegmentNumber": 0,
        "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
      }
    ],
    "totalFound": 0,
    "rowsReturned": 0
  },
  "next_page": "text",
  "code": 0
}

Returns the next page of a /cohorts/manifest request, when additional data is available. Authorization is required in order to access this endpoint.

GET/cohorts/manifest/nextPage

Query parameters

Response

200202500

manifest page

Body

application/json

manifestobject

next_pagestring

codeinteger

Request

JavaScriptCurlPython

const response = await fetch('/cohorts/manifest/nextPage?next_page=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200202500

{
  "manifest": {
    "manifest_data": [
      {
        "age_at_diagnosis": 0,
        "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",
        "instance_size": 0,
        "Internal_structure": "text",
        "license_short_name": "text",
        "Lobular_Pattern": "text",
        "Malignancy": "text",
        "Manufacturer": "text",
        "ManufacturerModelName": "text",
        "Margin": "text",
        "max_TotalPixelMatrixColumns": 0,
        "max_TotalPixelMatrixRows": 0,
        "min_PixelSpacing": 0,
        "Modality": "text",
        "ObjectiveLensPower": 0,
        "pathologic_stage": "text",
        "PatientID": "text",
        "primaryAnatomicStructure": "text",
        "Program": "text",
        "project_name": "text",
        "project_short_name": "text",
        "race": "text",
        "sample_type": "text",
        "SamplesPerPixel": 0,
        "SegmentAlgorithmType": "text",
        "SegmentedPropertyCategoryCodeSequence": "text",
        "SegmentedPropertyTypeCodeSequence": "text",
        "SegmentNumber": 0,
        "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
      }
    ],
    "totalFound": 0,
    "rowsReturned": 0
  },
  "next_page": "text",
  "code": 0
}

Retrieve user's account information. Authorization is required in order to access this endpoint.

GET/users/account_details

Response

200400403500

Current account information for the validated user.

Body

application/json

account_detailsobject

codeinteger

Request

JavaScriptCurlPython

const response = await fetch('/users/account_details', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400403500

{
  "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"
  },
  "code": 0
}