...
Note: incomplete/orientative properties, for more info check Vocabularies.
Optional parameters
...
Parameter |
|---|
...
Description | ||||||
|---|---|---|---|---|---|---|
topLevelOnly |
...
returns only top level communities |
...
idOnly |
...
if true return only the identifiers for the record |
...
immediateOnly |
...
return only direct parent community |
...
Sorting fields:
...
Parameter |
|---|
...
Description |
|---|
...
Ordering supported |
|---|
...
id |
...
sort results by entity id |
...
asc | ascending |
...
name |
...
sort results by entity name |
...
asc | ascending |
|
|
| Anchor | ||||
|---|---|---|---|---|
|
desc | descending
|
|
|
...
sort results by date of last item modification |
...
asc | |
...
ascending |
|
|
| Anchor | ||||
|---|---|---|---|---|
|
desc | descending
|
|
| Anchor | ||||
|---|---|---|---|---|
|
desc | descending
|
Controlling results
|| Parameter || Description || Default || Example ||
| _start | position of the first entity to return | 0 (first) | _start=5 to list 6th item and onwards |
| _page | page of data to display | 0 (first) | _page=2, to display second page with query results |
| _perpage | number of results to show on each page | 0 (all) | _perpage=10 to display 10 results per page |
| _limit | maximum number of entities to return | 0 (all) | _limit=50 |
| _sort | the sort order to return entities in
should be comma separated list of field names
suffix determines ordering
suffixes: _asc, _ascending, _desc, _descending | ascending default | _sort=name
_sort=name,email_desc,lastname_desc |
...