Developer Documentation
RuleListResult
Paged Collection of Rules
Properties
| Required | Property Name | Type | Description |
|---|---|---|---|
| optional | _links | array of ResourceLink |
The server will populate this field when returing the resource. Ignored on PUT and POST. |
| optional | _schema | string |
Schema for this resource |
| optional | _self | SelfResourceLink |
Link to this resource |
| optional | cursor | string |
Opaque cursor to be used for getting next page of records (supplied by current result page) |
| optional | result_count | integer |
Count of results found (across all pages), set only on first page |
| optional | results | array of Rule |
Rule list results |
| optional | sort_ascending | boolean |
If true, results are sorted in ascending order |
| optional | sort_by | string |
Field by which records are sorted |
