CSpec-Registry-API.md

@@ -134,3 +134,150 @@ The Criteria Specifiication Registry provides RESTful-APIs to browse and search
 </tr>
 </table>
 
+<table>
+<tr>
+<td>
+
+**Modifiers**
+</td>
+<td>
+
+**Possible values**
+</td>
+<td>
+
+**Description**
+</td>
+<td>
+
+**Example**
+</td>
+</tr>
+<tr>
+<td>
+
+**<span dir="">ids</span>**
+</td>
+<td>
+
+<span dir="">Comma separated list of identifiers</span>
+</td>
+<td>
+
+<span dir="">Allows batch search of a list of identifiers</span>
+</td>
+<td>
+
+[<span dir="">https://cspec.genome.network/cspec/SequenceVariantInterpretation/id?ids=GN014,GN016,GN015</span>](https://cspec.genome.network/cspec/SequenceVariantInterpretation/id?ids=GN014,GN016,GN015)<span dir=""> </span>
+</td>
+</tr>
+<tr>
+<td>
+
+**<span dir="">types</span>**
+</td>
+<td>
+
+<span dir="">Comma separated list of entity types</span>
+</td>
+<td>
+
+<span dir="">Allows filtering the results to show certain entity types only</span>
+</td>
+<td>
+
+[<span dir="">https://cspec.genome.network/cspec/SequenceVariantInterpretation/id/GN016?types=Gene,RuleSet</span>](https://cspec.genome.network/cspec/SequenceVariantInterpretation/id/GN016?types=Gene,RuleSet)<span dir=""> </span>
+</td>
+</tr>
+<tr>
+<td>
+
+**<span dir="">detail</span>**
+</td>
+<td>
+
+<span dir="">low, med, high</span>
+</td>
+<td>
+
+**low**<span dir=""> - Only identifier level info for the entity. The ld and ldFor just show the </span>**counts**<span dir=""> for 1+ such linked entity.</span>
+
+**med**<span dir=""> - (default) - The ld and ldFor show identifier level info.</span>
+
+**high**<span dir=""> - All details are shown.</span>
+</td>
+<td>
+
+[<span dir="">https://cspec.genome.network/cspec/SequenceVariantInterpretation/id?detail=low</span>](https://cspec.genome.network/cspec/SequenceVariantInterpretation/id?detail=low)
+
+[<span dir="">https://cspec.genome.network/cspec/SequenceVariantInterpretation/id?detail=med</span>](https://cspec.genome.network/cspec/SequenceVariantInterpretation/id?detail=med)
+
+[<span dir="">https://cspec.genome.network/cspec/SequenceVariantInterpretation/id?detail=high</span>](https://cspec.genome.network/cspec/SequenceVariantInterpretation/id?detail=high)
+</td>
+</tr>
+<tr>
+<td>
+
+**<span dir="">fields</span>**
+</td>
+<td>
+
+<span dir="">_Coming soon_ (Full list of fields will be added in a separate section.)</span>
+</td>
+<td>
+
+<span dir="">Comma separated list of fields to get in the API response</span>
+</td>
+<td>
+
+[<span dir="">https://cspec.genome.network/cspec/SequenceVariantInterpretation/id?detail=low&fields=entId,ldhId</span>](https://cspec.genome.network/cspec/SequenceVariantInterpretation/id?detail=low&fields=entId,ldhId)
+
+[<span dir="">https://cspec.genome.network/cspec/CriteriaCode/id?detail=high&fields=entId,ldhId,entContent.label,entContent.strengthDescriptor</span>](https://cspec.genome.network/cspec/CriteriaCode/id?detail=high&fields=entId,ldhId,entContent.label,entContent.strengthDescriptor)
+</td>
+</tr>
+<tr>
+<td>
+
+**<span dir="">pg</span>**
+</td>
+<td>
+
+<span dir="">Integer</span>
+
+<span dir="">Default: 1</span>
+
+<span dir="">Min:1</span>
+</td>
+<td>
+
+<span dir="">Page number to be retrieved</span>
+</td>
+<td>
+
+[<span dir="">https://cspec.genome.network/cspec/SequenceVariantInterpretation/id?pg=1&pgSize=250&detail=low&fields=entId,ldhId</span>](https://cspec.genome.network/cspec/SequenceVariantInterpretation/id?pg=1&pgSize=250&detail=low&fields=entId,ldhId)<span dir=""> </span>
+</td>
+</tr>
+<tr>
+<td>
+
+**<span dir="">pgSize</span>**
+</td>
+<td>
+
+<span dir="">Integer</span>
+
+<span dir="">Default: 250</span>
+
+<span dir="">Min 1; Max: 250</span>
+</td>
+<td>
+
+<span dir="">Number of results in each page</span>
+</td>
+<td>
+
+[<span dir="">https://cspec.genome.network/cspec/SequenceVariantInterpretation/id?pg=6&pgSize=250&detail=low&fields=entId</span>](https://cspec.genome.network/cspec/SequenceVariantInterpretation/id?pg=6&pgSize=250&detail=low&fields=entId)<span dir=""> </span>
+</td>
+</tr>
+</table>
+