live_help Notes

assignment This action requires one of theses roles: Advanced tutor
chrome_reader_mode This resource is paginated by 30 items

settings Params

Param name Description
project_session_id optional . Must be String

The project_session id

sort optional . Must be one of: id, rule_id, created_at, updated_at, required, position, project_session_id.

The sort field. Sorted by id desc by default.

Example:

To sort on project sessions rules on the fields position on a descending order and project_session_id on a ascending order:

...&sort=-position,project_session_id

filter optional . Must be one of: id, rule_id, created_at, updated_at, required, position, project_session_id.

Filtering on one or more fields

Example:

To filter on project sessions rules with the id field matching a_value or another_value:

...&filter[id]=a_value,another_value

Filterable fields:
  • id (standard field)
  • rule_id (standard field)
  • created_at (standard field)
  • updated_at (standard field)
  • required (standard field)
  • position (standard field)
  • project_session_id (standard field)
range optional . Must be one of: id, rule_id, created_at, updated_at, required, position, project_session_id.

Select on a particular range

Example:

To range on project sessions rules with the project_session_id field between min_value and max_value:

...&range[project_session_id]=min_value,max_value

Rangeable fields:
  • id
  • rule_id
  • created_at
  • updated_at
  • required
  • position
  • project_session_id
page optional . Must be a Hash

The pagination params, as a hash

page[number] optional . Must be Fixnum

The current page

page[size] optional . Must be Fixnum

The number of items per page, defaults to 30, maximum 100

comments powered by <span class='logo-disqus'>Disqus</span>