Skip to content
GitLab
Projects Groups Topics Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
  • Sign in
  • A Actionability
  • Project information
    • Project information
    • Activity
    • Members
  • Wiki
    • Wiki
  • Activity
Collapse sidebar
  • ClinGenClinGen
  • Actionability
  • Wiki
  • Actionabilty APIs

Actionabilty APIs · Changes

Page history
Update Actionabilty APIs authored Mar 28, 2023 by Neethu Shah's avatar Neethu Shah
Hide whitespace changes
Inline Side-by-side
Actionabilty-APIs.md
View page @ 6650cac3
......@@ -55,10 +55,65 @@ Summary of actionability APIs:
#### Variant Condition Framework Test Data
Summary of changes
* Nested\
For all the nested payloads a new attribute curationType is defined with the possible values - Gene-Condition or Variant Condition. Topics that are Variant-Condition oriented will have variants object instead of genes. Check an example from the API route /Adult/api/summ/oi
```
"variants": [
{
"id": "CA012732",
"descriptor": [
"NC_000014.9:g.23424840G>A"
],
"description": "Other test",
"variantType": "Other",
"diseases": [
{
"label": "GAUCHER DISEASE, TYPE I",
"omim": "230800",
"preferredMondo": "0016297"
}
]
}
]
```
Scoring group membership will also have variant attributes instead of gene attributes for a Variant-Condition topic.
```
"scoringGroups": [
{
"label": "GroupA",
"geneDiseaseMembers": [
{
"preferredMondo": "0016297",
"variantId": "CA012732",
"description": "Other test",
"vuuid": "8a5cf04f-a070-581e-a119-df60482bc690",
"disOmim": "230800",
"descriptor": [
"NC_000014.9:g.23424840G>A"
]
}
]
```
* Flat & format = json/tsv
There is a new column in all the api response payloads - curationType. Possible values for this column - Gene-Condition OR Variant Condition.
Note an example for the route - /Adult/api/summ/oi?flavor=flat
```
"columns": [ "docId", "iri", "curationType", "latestSearchDate", "lastUpdated", "context", "contextIri", "release", "releaseDate", "genes-scoringGroup", "disease", "status-overall", "status-stg1", "status-stg2", "status-scoring", "outcome", "intervention", "final-severity", "final-likelihood", "final-natureOfIntervention", "final-effectiveness", "final-overall" ]
```
* Flat & format = tsv
1. /api/summ/brief [brief_nested.json](uploads/3d99993dc253d7b10955a919e5dedf7f/brief_nested.json)
2. /api/summ/brief?flavor=flat [brief_flat.json](uploads/3292b2b69f63e2dc42dbda741b235dbc/brief_flat.json)
3. api/summ/brief?format=tsv [ACI-brief-TueMar2805000505002023.tsv](uploads/6d3061608a2751ddd014c660392fa6cb/ACI-brief-TueMar2805000505002023.tsv)
4. /Adult/api/summ/oi [oi_nested_adult.json](uploads/ca263999b9ad367bac79779ce684256f/oi_nested_adult.json)
3. /api/summ/brief?format=tsv [ACI-brief-TueMar2805000505002023.tsv](uploads/6d3061608a2751ddd014c660392fa6cb/ACI-brief-TueMar2805000505002023.tsv)
4. /Adult/api/summ/oi [oi_nested_adult.json](uploads/ca263999b9ad367bac79779ce684256f/oi_nested_adult.json)
5. /Pediatric/api/summ/oi
6. /Adult/api/summ/oi?flavor=flat
7. /Pediatric/api/summ/oi?flavor=flat
\ No newline at end of file
Clone repository
  • Actionabilty APIs
  • Chromosomal Abnormalities
  • Home