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 , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

Value: Must be String
filter[permission_ids]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

Value: Must be an array of any type
filter[organization_ids]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

Value: Must be an array of any type
filter[location_ids]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

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 , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

Value: Must be String
filter[permission_ids]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

Value: Must be an array of any type
filter[organization_ids]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

Value: Must be an array of any type
filter[location_ids]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

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