find()

Finds Actions which match the specified options.

Octave.Action.find(options)

Parameters

  • options: An optional object literal of query options:
  • filter: a filter string.
  • start: The start index of the search (default value is 0).
    * limit: The maximum response size (default value is 20).
  • sort: The string representation of the member key to sort the results over (default value is creation date).
  • order: Specifies the sort order. Can be set to ‘asc’ and ‘desc’ (default value is 'desc').
ParameterTypeRequiredDescription
optionsObjectYesAn object literal of query options.
options.filterStringNoA filter string.
options.startIntegerNoThe start index of the search (default value is 0).
options.limitIntegerNoThe maximum response size (default value is 20).
options.sortStringNoThe string representation of the member key to sort the results over (default value is creation date).
options.orderStringNoSpecifies the sort order. Can be set to asc and desc (default value is desc).

Returns

An array of JSON representations of the matching Actions.