|
|
|
### Introduction to API Services
|
|
|
|
|
|
|
|
[[_TOC_]]
|
|
|
|
|
|
|
|
<div>
|
|
|
|
|
|
|
|
<div>
|
|
|
|
|
|
|
|
<div>
|
|
|
|
|
|
|
|
The Evidence Repository provides RESTful-APIs to browse and search classifications. It's code architecture is split between its original Rails implementation and the Node micro-services currently used for fast lookup. Responses are returned in JSON format.
|
|
|
|
|
|
|
|
#### <span dir="">Rails Service URL:</span> https://erepo.genome.network/evrepo
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<table>
|
|
|
|
<tr>
|
|
|
|
<td>
|
|
|
|
|
|
|
|
**Endpoints**
|
|
|
|
</td>
|
|
|
|
<td>
|
|
|
|
|
|
|
|
**Description**
|
|
|
|
</td>
|
|
|
|
<td>
|
|
|
|
|
|
|
|
**Example**
|
|
|
|
</td>
|
|
|
|
</tr>
|
|
|
|
<tr>
|
|
|
|
<td>
|
|
|
|
|
|
|
|
**/api/interpretations**
|
|
|
|
</td>
|
|
|
|
<td>
|
|
|
|
|
|
|
|
<span dir="">Lists classifications in SEPIO format</span>
|
|
|
|
</td>
|
|
|
|
<td>
|
|
|
|
|
|
|
|
<span dir="">https://erepo.genome.network/evrepo/api/interpretations</span><span dir=""> </span>
|
|
|
|
</td>
|
|
|
|
</tr>
|
|
|
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
#### API modifiers
|
|
|
|
|
|
|
|
Response from the Rails API endpoints can be filtered or restricted using the following modifiers
|
|
|
|
|
|
|
|
<table>
|
|
|
|
<tr>
|
|
|
|
<td>
|
|
|
|
|
|
|
|
**Modifiers**
|
|
|
|
</td>
|
|
|
|
<td>
|
|
|
|
|
|
|
|
**Possible values**
|
|
|
|
</td>
|
|
|
|
<td>
|
|
|
|
|
|
|
|
**Description**
|
|
|
|
</td>
|
|
|
|
<td>
|
|
|
|
|
|
|
|
**Example**
|
|
|
|
</td>
|
|
|
|
</tr>
|
|
|
|
<tr>
|
|
|
|
<td>
|
|
|
|
|
|
|
|
**<span dir="">matchLogic</span>**
|
|
|
|
</td>
|
|
|
|
<td>
|
|
|
|
|
|
|
|
<span dir="">"and" or "or" ONLY</span>
|
|
|
|
</td>
|
|
|
|
<td>
|
|
|
|
|
|
|
|
<span dir="">Allows for inclusive or exclusvie searching based on different parameters</span>
|
|
|
|
</td>
|
|
|
|
<td>
|
|
|
|
|
|
|
|
<span dir="">https://erepo.genome.network/evrepo/api/interpretations?matchLogic=and</span><span dir=""> </span>
|
|
|
|
<span dir="">https://erepo.genome.network/evrepo/api/interpretations?matchLogic=or</span><span dir=""> </span>
|
|
|
|
</td>
|
|
|
|
</tr>
|
|
|
|
<tr>
|
|
|
|
<td>
|
|
|
|
|
|
|
|
**<span dir="">matchLimit</span>**
|
|
|
|
</td>
|
|
|
|
<td>
|
|
|
|
|
|
|
|
<span dir="">Number value</span>
|
|
|
|
</td>
|
|
|
|
<td>
|
|
|
|
|
|
|
|
<span dir="">Number of documents retrieved from the /api/interpretations endpoint</span>
|
|
|
|
</td>
|
|
|
|
<td>
|
|
|
|
|
|
|
|
https://erepo.genome.network/evrepo/api/interpretations?matchLimit=25
|
|
|
|
</td>
|
|
|
|
</tr>
|
|
|
|
<tr>
|
|
|
|
<td>
|
|
|
|
|
|
|
|
**<span dir="">skip</span>**
|
|
|
|
</td>
|
|
|
|
<td>
|
|
|
|
|
|
|
|
<span dir="">Number value</span>
|
|
|
|
</td>
|
|
|
|
<td>
|
|
|
|
|
|
|
|
<span dir="">Number of documents skipped from the /api/interpretations endpoint. Combined with matchLimit, they provide a paging mechanism</span>
|
|
|
|
</td>
|
|
|
|
<td>
|
|
|
|
|
|
|
|
<span dir="">https://erepo.genome.network/evrepo/api/interpretations?matchLimit=25&skip=0</span>
|
|
|
|
|
|
|
|
<span dir="">https://erepo.genome.network/evrepo/api/interpretations?matchLimit=25&skip=25</span>
|
|
|
|
|
|
|
|
<span dir="">https://erepo.genome.network/evrepo/api/interpretations?matchLimit=25&skip=50</span>
|
|
|
|
</td>
|
|
|
|
</tr>
|
|
|
|
<tr>
|
|
|
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
#### Key Fields in API Response
|
|
|
|
|
|
|
|
The table below lists the key fields returned in the API response.
|
|
|
|
|
|
|
|
<table>
|
|
|
|
<tr>
|
|
|
|
<td>
|
|
|
|
|
|
|
|
**Key Fields**
|
|
|
|
</td>
|
|
|
|
<td>
|
|
|
|
|
|
|
|
**Description**
|
|
|
|
</td>
|
|
|
|
<td>
|
|
|
|
|
|
|
|
**Example**
|
|
|
|
</td>
|
|
|
|
</tr>
|
|
|
|
<tr>
|
|
|
|
<td>
|
|
|
|
|
|
|
|
**<span dir="">ld</span>**
|
|
|
|
</td>
|
|
|
|
<td>
|
|
|
|
|
|
|
|
<span dir="">This entity is a linked data object for these entities</span>
|
|
|
|
</td>
|
|
|
|
<td>
|
|
|
|
|
|
|
|
<span dir="">`"ld": \\\[ { "CriteriaCode": \\\[ … \\\] }, {"RuleSet": \\\[ … \\\] }, { "Gene": \\\[ … \\\] } \\\],`</span>
|
|
|
|
|
|
|
|
<span dir="">Here, "CriteriaCode", "RuleSet" and "Gene" are the linked data entities for the variant "CA000176"</span>
|
|
|
|
</td>
|
|
|
|
</tr>
|
|
|
|
<tr>
|
|
|
|
<td>
|
|
|
|
|
|
|
|
**<span dir="">ldFor</span>**
|
|
|
|
</td>
|
|
|
|
<td>
|
|
|
|
|
|
|
|
<span dir="">This entity is linked data FOR these other entities</span>
|
|
|
|
</td>
|
|
|
|
<td>
|
|
|
|
|
|
|
|
<span dir="">`"ldFor": \\\[ { "Gene": \\\[ … \\\] } \\\]`</span>
|
|
|
|
|
|
|
|
<span dir="">SequenceVariantInterpretation “CA000176” is linked data FOR the Gene “TP53”</span>
|
|
|
|
</td>
|
|
|
|
</tr>
|
|
|
|
<tr>
|
|
|
|
<td>
|
|
|
|
|
|
|
|
**<span dir="">entId</span>**
|
|
|
|
</td>
|
|
|
|
<td>
|
|
|
|
|
|
|
|
<span dir="">Identifier of entity in the external data source</span>
|
|
|
|
</td>
|
|
|
|
<td>
|
|
|
|
|
|
|
|
<span dir="">`"entId": "GN016"`</span>
|
|
|
|
|
|
|
|
<span dir="">where "GN016" - ClinGen Allele Registry identifier for “SequenceVariantInterpretation”</span>
|
|
|
|
</td>
|
|
|
|
</tr>
|
|
|
|
<tr>
|
|
|
|
<td>
|
|
|
|
|
|
|
|
**<span dir="">entIri</span>**
|
|
|
|
</td>
|
|
|
|
<td>
|
|
|
|
|
|
|
|
<span dir="">IRI of entity in the external data source</span>
|
|
|
|
</td>
|
|
|
|
<td>
|
|
|
|
|
|
|
|
<span dir="">`"entIri": "https://www.genenames.org/data/gene-symbol-report/#!/hgnc_id/HGNC:1097"`,</span>
|
|
|
|
|
|
|
|
<span dir="">where the IRI is the “link” to this entity in the external data source</span>
|
|
|
|
</td>
|
|
|
|
</tr>
|
|
|
|
<tr>
|
|
|
|
</tr>
|
|
|
|
</table>
|
|
|
|
|
|
|
|
#### <span dir="">Node Service URL:</span> https://erepo.genome.network/evrepo/api/summary
|
|
|
|
##### NOTE: This API is a mirror of its UI counter-part. Thus any of the following modifiers work with the UI endpoint https://erepo.genome.network/evrepo/api/summary
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<table class="tg">
|
|
|
|
<thead>
|
|
|
|
<tr>
|
|
|
|
<th class="tg-0lax">Key Fields</th>
|
|
|
|
<th class="tg-0lax">Possible values</th>
|
|
|
|
<th class="tg-0lax">Description</th>
|
|
|
|
<th class="tg-0lax">Example</th>
|
|
|
|
</tr>
|
|
|
|
</thead>
|
|
|
|
<tbody>
|
|
|
|
<tr>
|
|
|
|
<td class="tg-0lax">columns</td>
|
|
|
|
<td class="tg-0lax">classification, gene, condition, caId, cvId</td>
|
|
|
|
<td class="tg-0lax">Comma separated values of the columns you're specifically searching for. NOTE: Needs to be combined with values field to search for particular classification records</td>
|
|
|
|
<td class="tg-0lax"></td>
|
|
|
|
</tr>
|
|
|
|
<tr>
|
|
|
|
<td class="tg-0lax">values</td>
|
|
|
|
<td class="tg-0lax">pathogenic,PTEN,CA21421,529341</td>
|
|
|
|
<td class="tg-0lax">Comma separated values of the actual values you're searching for. NOTE: These have to be in the same order as the column values above. Meaning if you're first column is a gene, then the fist values in the list is for the gene</td>
|
|
|
|
<td class="tg-0lax">https://erepo.clinicalgenome.org/evrepo/api/summary/classifications?columns=gene,classification,caId&values=ACADVL,Benign,CA10360777&matchTypes=exact,exact,contains&pgSize=25&pg=1&matchMode=or</td>
|
|
|
|
</tr>
|
|
|
|
<tr>
|
|
|
|
<td class="tg-0lax">matchTypes</td>
|
|
|
|
<td class="tg-0lax">exact,contains</td>
|
|
|
|
<td class="tg-0lax">Comma separated values of matching logic for the respective columns and values</td>
|
|
|
|
<td class="tg-0lax">https://erepo.clinicalgenome.org/evrepo/ui/summary/classifications?columns=gene&values=ACADVL&matchTypes=exact<br>https://erepo.clinicalgenome.org/evrepo/ui/summary/classifications?columns=condition&values=cardio&matchTypes=contains<br></td>
|
|
|
|
</tr>
|
|
|
|
<tr>
|
|
|
|
<td class="tg-0lax">matchMode</td>
|
|
|
|
<td class="tg-0lax">"and" or "or"</td>
|
|
|
|
<td class="tg-0lax">Allows for inclusive or exclusvie searching based on different parameters</td>
|
|
|
|
<td class="tg-0lax">https://erepo.clinicalgenome.org/evrepo/ui/summary/classifications?columns=condition,cvId&values=cardio,161326&matchTypes=contains,exact&pgSize=25&pg=1&matchMode=and</td>
|
|
|
|
</tr>
|
|
|
|
<tr>
|
|
|
|
<td class="tg-0lax">pgSize</td>
|
|
|
|
<td class="tg-0lax">Numeric values</td>
|
|
|
|
<td class="tg-0lax">The number of records a query obtains</td>
|
|
|
|
<td class="tg-0lax">https://erepo.clinicalgenome.org/evrepo/ui/summary/classifications?pgSize=25<br>https://erepo.clinicalgenome.org/evrepo/ui/summary/classifications?pgSize=1https://erepo.clinicalgenome.org/evrepo/ui/summary/classifications?pgSize=500<br></td>
|
|
|
|
</tr>
|
|
|
|
<tr>
|
|
|
|
<td class="tg-0lax">pg</td>
|
|
|
|
<td class="tg-0lax">Numeric values</td>
|
|
|
|
<td class="tg-0lax">The page requesting, respective to the pgSize.</td>
|
|
|
|
<td class="tg-0lax">https://erepo.clinicalgenome.org/evrepo/ui/summary/classifications?pg=25<span style="font-weight:400;font-style:normal">https://erepo.clinicalgenome.org/evrepo/ui/summary/classifications?pgSize=25&pg=1</span><br><span style="font-weight:400;font-style:normal">https://erepo.clinicalgenome.org/evrepo/ui/summary/classifications?pgSize=25&pg=100</span><br></td>
|
|
|
|
</tr>
|
|
|
|
</tbody>
|
|
|
|
</table> |
