Filters

>>>

GET /api/filters
Список всех фильтров

Параметры

Имя параметра Описание
location_id
необязательно

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
необязательно

Set the current organization context for the request

Validations:

  • Must be a Integer
search
необязательно

отфильтровать результаты

Validations:

  • Must be a String
order
необязательно

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String
page
необязательно

Номер страницы, начиная с 1

Validations:

  • Must be a number.
per_page
необязательно

Число элементов на странице

Validations:

  • Must be a number.

Search fields

Field name Тип Possible values
limited true, false
location
location_id
organization
organization_id
override true, false
permission
resource
role
role_id
search
unlimited true, false
>>>

GET /api/filters/:id
Показать фильтр

Параметры

Имя параметра Описание
location_id
необязательно

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
необязательно

Set the current organization context for the request

Validations:

  • Must be a Integer
id
обязательно

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
Создать фильтр

Параметры

Имя параметра Описание
location_id
необязательно

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
необязательно

Set the current organization context for the request

Validations:

  • Must be a Integer
filter
обязательно

Validations:

  • Must be a Hash
filter[role_id]
обязательно

Validations:

  • Must be a String
filter[search]
необязательно , nil разрешен

Validations:

  • Must be a String
filter[override]
необязательно , nil разрешен

Validations:

  • Must be one of: true, false, 1, 0.
filter[permission_ids]
необязательно , nil разрешен

Validations:

  • Must be an array of any type
filter[organization_ids]
необязательно , nil разрешен

Validations:

  • Must be an array of any type
filter[location_ids]
необязательно , nil разрешен

Validations:

  • Must be an array of any type
>>>

PUT /api/filters/:id
Изменить фильтр

Параметры

Имя параметра Описание
location_id
необязательно

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
необязательно

Set the current organization context for the request

Validations:

  • Must be a Integer
id
обязательно

Validations:

  • Must be a String
filter
обязательно

Validations:

  • Must be a Hash
filter[role_id]
необязательно

Validations:

  • Must be a String
filter[search]
необязательно , nil разрешен

Validations:

  • Must be a String
filter[override]
необязательно , nil разрешен

Validations:

  • Must be one of: true, false, 1, 0.
filter[permission_ids]
необязательно , nil разрешен

Validations:

  • Must be an array of any type
filter[organization_ids]
необязательно , nil разрешен

Validations:

  • Must be an array of any type
filter[location_ids]
необязательно , nil разрешен

Validations:

  • Must be an array of any type
>>>

DELETE /api/filters/:id
Удалить фильтр

Параметры

Имя параметра Описание
location_id
необязательно

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
необязательно

Set the current organization context for the request

Validations:

  • Must be a Integer
id
обязательно

Validations:

  • Must be a String