GET /api/filters
List all filters

Params

Param name Description
search
optional

filter results


Value: Must be String
order
optional

sort results


Value: Must be String
page
optional

paginate results


Value: Must be String
per_page
optional

number of entries per request


Value: Must be String

GET /api/filters/:id
Show a filter

Params

Param name Description
id
required

Value: Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

POST /api/filters
Create a filter

Params

Param name Description
filter
required

Value: Must be a Hash
filter[role_id]
required

Value: Must be String
filter[search]
optional , nil allowed

Value: Must be String
filter[permission_ids]
optional , nil allowed

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

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

Value: Must be an array of any type

PUT /api/filters/:id
Update a filter

Params

Param name Description
id
required

Value: Must be String
filter
required

Value: Must be a Hash
filter[role_id]
optional

Value: Must be String
filter[search]
optional , nil allowed

Value: Must be String
filter[permission_ids]
optional , nil allowed

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

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

Value: Must be an array of any type

DELETE /api/filters/:id
Delete a filter

Params

Param name Description
id
required

Value: Must be String