Input Options

There are several special options that can be used on input to limit the number of items that are returned and to set a start offset of the first item to return. They have corresponding values in the Output Data Format shown below.

The special input options are:

limit=nn

sets the limit to nn for the number of entries to return. For example: limit=10 will return a maximum of 10 items, but if there are not 10 items, it may return fewer. The default if not specified is 50.

offset=nn

sets the offset to the first item to be returned to nn. An offset=0 corresponds to the default and will returns items from the beginning. An offset=1 will return the second and subsequent items.

count

returns the total number of items that can be referenced, but it does not return any data. The returned value is returned in the limit field of the Output Data Structure (see below).

regex

applies the specified regex agains the name of the item (/cat/ or /res/).

Note, the exact implementation of the above input options depends on the category. For example for the category status, none of the above are implemented, while for the category cmd, only the limit is implemented.

Go back to Input Data Format chapter.

Go back to the REST API chapter.

Go back to the main Advanced Features Usage page.