GET /api/filters
List all filters

Params

Param name Description
search
optional

filter results

Validations:

  • String

order
optional

sort results

Validations:

  • String

page
optional

paginate results

Validations:

  • String

per_page
optional

number of entries per request

Validations:

  • String


GET /api/filters/:id
Show a filter

Params

Param name Description
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
filter
required

Validations:

  • Hash

filter[role_id]
required

Validations:

  • String

filter[search]
optional , nil allowed

Validations:

  • String

filter[override]
optional , nil allowed

Validations:

  • boolean

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
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:

  • boolean

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
id
required

Validations:

  • String