Skip to content
GitLab

Evidence Repository API · Changes

Page history
Update Evidence Repository API with new format for Node Summary API authored by Alejandro Zuniga's avatar Alejandro Zuniga
Hide whitespace changes
Inline Side-by-side
Evidence-Repository-API.md
View page @ e11dd0c4
......@@ -268,56 +268,127 @@ The table below lists the key fields returned in the API response.
#### <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
#### Rails API modifiers
#### Node Summary API modifiers
</div>
</div>
</div>
<table>
<thead>
<tr>
<th>Key Fields</th>
<th>Possible values</th>
<th>Description</th>
<th>Example</th>
</tr>
</thead>
<tbody>
<tr>
<td>columns</td>
<td>classification, gene, condition, caId, cvId</td>
<td>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></td>
</tr>
<tr>
<td>values</td>
<td>pathogenic,PTEN,CA21421,529341</td>
<td>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>https://erepo.clinicalgenome.org/evrepo/api/summary/classifications?columns=gene,classification,caId&amp;values=ACADVL,Benign,CA10360777&amp;matchTypes=exact,exact,contains&amp;pgSize=25&amp;pg=1&amp;matchMode=or</td>
</tr>
<tr>
<td>matchTypes</td>
<td>exact,contains</td>
<td>Comma separated values of matching logic for the respective columns and values</td>
<td>https://erepo.clinicalgenome.org/evrepo/ui/summary/classifications?columns=gene&amp;values=ACADVL&amp;matchTypes=exact<br>https://erepo.clinicalgenome.org/evrepo/ui/summary/classifications?columns=condition&amp;values=cardio&amp;matchTypes=contains<br></td>
</tr>
<tr>
<td>matchMode</td>
<td>"and" or "or"</td>
<td>Allows for inclusive or exclusvie searching based on different parameters</td>
<td>https://erepo.clinicalgenome.org/evrepo/ui/summary/classifications?columns=condition,cvId&amp;values=cardio,161326&amp;matchTypes=contains,exact&amp;pgSize=25&amp;pg=1&amp;matchMode=and</td>
</tr>
<tr>
<td>pgSize</td>
<td>Numeric values</td>
<td>The number of records a query obtains</td>
<td>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>pg</td>
<td>Numeric values</td>
<td>The page requesting, respective to the pgSize.</td>
<td>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&amp;pg=1</span><br><span style="font-weight:400;font-style:normal">https://erepo.clinicalgenome.org/evrepo/ui/summary/classifications?pgSize=25&amp;pg=100</span><br></td>
</tr>
</tbody>
<tr>
<td>
**Key Fields**
</td>
<td>
**Possible values**
</td>
<td>
**Description**
</td>
<td>
**Examples**
</td>
</tr>
<tr>
<td>
**<span dir="">columns</span>**
</td>
<td>
<span dir="">classification, gene, condition, caId, cvId</span>
</td>
<td>
<span dir="">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</span>
</td>
<td></td>
</tr>
<tr>
<td>
**<span dir="">values</span>**
</td>
<td>
<span dir="">pathogenic,
PTEN,
CA21421,
529341</span>
</td>
<td>
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>https://erepo.clinicalgenome.org/evrepo/api/summary/classifications?columns=gene,classification,caId&amp;values=ACADVL,Benign,CA10360777&amp;matchTypes=exact,exact,contains&amp;pgSize=25&amp;pg=1&amp;matchMode=or</td>
</tr>
<tr>
<td>
**<span dir="">matchTypes</span>**
</td>
<td>
<span dir="">exact,contains</span>
</td>
<td>
Comma separated values of matching logic for the respective columns and values
</td>
<td>https://erepo.clinicalgenome.org/evrepo/ui/summary/classifications?columns=gene&amp;values=ACADVL&amp;matchTypes=exact
https://erepo.clinicalgenome.org/evrepo/ui/summary/classifications?columns=condition&amp;values=cardio&amp;matchTypes=contain</td>
</tr>
<tr>
<td>
**<span dir="">matchMode</span>**
</td>
<td>
<span dir="">and" OR "or"</span>
</td>
<td>
Allows for inclusive or exclusvie searching based on different parameters
</td>
<td>https://erepo.clinicalgenome.org/evrepo/ui/summary/classifications?columns=condition,cvId&amp;values=cardio,161326&amp;matchTypes=contains,exact&amp;pgSize=25&amp;pg=1&amp;matchMode=and
</td>
</tr>
<tr>
<td>
**<span dir="">pgSize</span>**
</td>
<td>
<span dir="">Numeric values</span>
</td>
<td>
Number of records a query obtains
</td>
<td>https://erepo.clinicalgenome.org/evrepo/ui/summary/classifications?pgSize=25
https://erepo.clinicalgenome.org/evrepo/ui/summary/classifications?pgSize=1
https://erepo.clinicalgenome.org/evrepo/ui/summary/classifications?pgSize=500</td>
</tr>
<tr>
<td>
**<span dir="">pg</span>**
</td>
<td>
<span dir="">Numeric values</span>
</td>
<td>
The page requesting, respective to the pgSize
</td>
<td>https://erepo.clinicalgenome.org/evrepo/ui/summary/classifications?pg=100
https://erepo.clinicalgenome.org/evrepo/ui/summary/classifications?pgSize=1&pg=1
https://erepo.clinicalgenome.org/evrepo/ui/summary/classifications?pgSize=500&pg=10</td>
</tr>
<tr>
<td>
</tr>
<tr>
</tr>
</table>