CBSNexora/cbsnexora-backend
4
0
Fork 0
Code Issues Pull Requests Actions 47 Packages Projects Releases Wiki Activity

Merge pull request #1372 from chandrikamohith/apiDoc

Browse Source 
MIFOSX-2028 Updating API docs for List client/list groups.
This commit is contained in:
Vishwas Babu A J
2015-05-11 21:58:21 -07:00
parent a4dfa7e8c4 570870bfef
commit e47cee6cd9
1 changed files with 10 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
api-docs/apiLive.htm
+10
View File
@@ -4227,6 +4227,11 @@ GET https://DomainName/api/v1/clients/{clientId}
String <span>optional</span> String <span>optional</span>
</dd> </dd>
<dd>Use an sql fragment valid for the underlying client schema to filter results. e.g. display_name like %K%</dd> <dd>Use an sql fragment valid for the underlying client schema to filter results. e.g. display_name like %K%</dd>
<dt>orphansOnly</dt>
<dd>
Boolean <span>optional</span>, defaults to false
</dd>
<dd>Use orphansOnly as true to list clients which are not associated to any group/parent.</dd>
</dl> </dl>
<p>Example Requests:</p> <p>Example Requests:</p>
<div class=apiClick>clients</div> <div class=apiClick>clients</div>
@@ -7191,6 +7196,11 @@ DELETE groups/2
String <span>optional</span> String <span>optional</span>
</dd> </dd>
<dd>Use an sql fragment valid for the underlying group schema to filter results. e.g. display_name like %K%</dd> <dd>Use an sql fragment valid for the underlying group schema to filter results. e.g. display_name like %K%</dd>
<dt>orphansOnly</dt>
<dd>
Boolean <span>optional</span>, defaults to false
</dd>
<dd>Use orphansOnly as true to list groups which are not associated to any center/parent.</dd>
</dl> </dl>
<p>Example Requests:</p> <p>Example Requests:</p>
<div class=apiClick>groups</div> <div class=apiClick>groups</div>