Filters

>>>

GET /api/filters
List all filters

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
search
optional

filter results

Validations:

  • String
order
optional

Sort field and order, eg. ‘id DESC’

Validations:

  • String
page
optional

Page number, starting at 1

Validations:

  • Must be a number.
per_page
optional

Number of results per page to return, ‘all’ to return all results

Validations:

  • Must match regular expression /\A([1-9]\d|all)\Z$/.

Search fields

Field name Type Possible values
limited true, false
location string
location_id integer
organization string
organization_id integer
override true, false
permission string
resource string
role string
role_id integer
search text
unlimited true, false
>>>

GET /api/filters/:id
Show a filter

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, ‘‘, ‘-’ with no leading or trailing space..
>>>

POST /api/filters
Create a filter

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
filter
required

Validations:

  • Hash
filter[role_id]
required

Validations:

  • String
filter[search]
optional , nil allowed

Validations:

  • String
filter[override]
optional , nil allowed

Validations:

  • Must be one of: true, false, 1, 0.
filter[permission_ids]
optional , nil allowed

Validations:

  • Must be an array of any type
filter[organization_ids]
optional , nil allowed

Validations:

  • Must be an array of any type
filter[location_ids]
optional , nil allowed

Validations:

  • Must be an array of any type
>>>

PUT /api/filters/:id
Update a filter

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
id
required

Validations:

  • String
filter
required

Validations:

  • Hash
filter[role_id]
optional

Validations:

  • String
filter[search]
optional , nil allowed

Validations:

  • String
filter[override]
optional , nil allowed

Validations:

  • Must be one of: true, false, 1, 0.
filter[permission_ids]
optional , nil allowed

Validations:

  • Must be an array of any type
filter[organization_ids]
optional , nil allowed

Validations:

  • Must be an array of any type
filter[location_ids]
optional , nil allowed

Validations:

  • Must be an array of any type
>>>

DELETE /api/filters/:id
Delete a filter

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
id
required

Validations:

  • String