API documentation

>>>

GET /api/filters
List all filters

Params

Param name	Description
search optional	filter results Validations: Must be String
order optional	sort results Validations: Must be String
page optional	paginate results Validations: Must be String
per_page optional	number of entries per request Validations: Must be String

>>>

GET /api/filters/:id
Show a filter

Params

Param name

Description

id
required

Validations:

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	Validations: Must be a Hash
filter[role_id] required	Validations: Must be String
filter[search] optional , nil allowed	Validations: Must be String
filter[override] optional , nil allowed	Validations: Must be 'true' or 'false' or '1' or '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
id required	Validations: Must be String
filter required	Validations: Must be a Hash
filter[role_id] optional	Validations: Must be String
filter[search] optional , nil allowed	Validations: Must be String
filter[override] optional , nil allowed	Validations: Must be 'true' or 'false' or '1' or '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

id
required

Validations:

Must be String