Path： /mutations
Method： GET
Description：
Query
| Parameter Name | NecessaryOrNot | Example | Remarks |
|---|---|---|---|
| page | Not | ||
| page_size | Not | ||
| sort | Not | ||
| order | Not | desc or asc | |
| gene | Necessary | EGFR | |
| mutation | Not | L858R |
| Name | Type | NecessaryOrNot | Defaults | Remarks | Others |
|---|---|---|---|---|---|
| data | object [] | Necessary | item Type: object | ||
| ├─ sample | string | Not | |||
| ├─ sampleID | integer | Not | |||
| ├─ study | string | Not | |||
| ├─ studyId | integer | Not | |||
| ├─ cancer | string | Not | |||
| ├─ gene | string | Not | |||
| ├─ mutation | string | Not | |||
| ├─ refCount | integer | Not | Maximum: 9999 Minimum: 1 | ||
| ├─ altCount | integer | Not | Maximum: 9999 Minimum: 1 | ||
| ├─ freq | number | Not | |||
| ├─ chr | string | Not | |||
| ├─ start | integer | Not | |||
| ├─ end | integer | Not | |||
| ├─ ref | string | Not | |||
| ├─ tumorAllele1 | string | Not | |||
| ├─ tumorAllele2 | string | Not | |||
| ├─ id | integer | Not | |||
| total | integer | Necessary | |||
| error | string | Necessary |
Path： /studies/:studyId
Method： GET
Description
Parameters
| Parameter Name | Example | Remarks |
|---|---|---|
| studyId |
| Name | Type | NecessaryOrNot | Defaults | Remarks | Others |
|---|---|---|---|---|---|
| data | object | Necessary | |||
| ├─ id | integer | Not | |||
| ├─ cancer_study_identifier | string | Not | |||
| ├─ type_of_cancer | string | Not | |||
| ├─ name | string | Not | |||
| ├─ description | string | Not | |||
| ├─ citation | string | Not | |||
| ├─ pmid | string | Not | |||
| ├─ short_name | string | Not | |||
| ├─ groups | string | Not | |||
| error | string | Necessary |
Path： /samples/:sampleId
Method： GET
Description
Parameters
| Parameter Name | Example | Remarks |
|---|---|---|
| sampleId |
| Name | Type | NecessaryOrNot | Defaults | Remarks | Others |
|---|---|---|---|---|---|
| data | object | Not | |||
| ├─ id | number | Not | |||
| ├─ cancer_study_identifier | string | Not | |||
| ├─ PATIENT_ID | string | Not | |||
| ├─ PATIENT_RELEVANT_SAMPLEIDS | number [] | Not | item Type: number | ||
| ├─ SAMPLE_ID | string | Not | |||
| ├─ SPECIMEN_PRESERVATION_TYPE | string | Not | |||
| ├─ SPECIMEN_TYPE | string | Not | |||
| ├─ DNA_INPUT | string | Not | |||
| ├─ SAMPLE_COVERAGE | string | Not | |||
| ├─ TUMOR_PURITY | string | Not | |||
| ├─ MATCHED_STATUS | string | Not | |||
| ├─ SAMPLE_TYPE | string | Not | |||
| ├─ PRIMARY_SITE | string | Not | |||
| ├─ METASTATIC_SITE | string | Not | |||
| ├─ SAMPLE_CLASS | string | Not | |||
| ├─ ONCOTREE_CODE | string | Not | |||
| ├─ CANCER_TYPE | string | Not | |||
| ├─ CANCER_TYPE_DETAILED | string | Not | |||
| ├─ TUMOR_TYPE | string | Not | |||
| ├─ GRADE | string | Not | |||
| error | null | Not |