GET /api/filters
Listar todos os filtros

Parâmentros

Nome parâmetro Descrição
location_id
opcional

Escopo de localizações

Validations:

  • Must be a Integer

organization_id
opcional

Escopo de organização

Validations:

  • Must be a Integer

search
opcional

filtrar resultados

Validations:

  • Must be a String

order
opcional

Classificar campo e ordem, ex.: ‘id DESC’

Validations:

  • Must be a String

page
opcional

Número de página, iniciando em 1

Validations:

  • Must be a number.

per_page
opcional

Número de resultados por página para retornar

Validations:

  • Must be a number.

Pesquisar campos

Nome do campo Tipo Valores possíveis
limited true, false
location string
location_id integer
organization string
organization_id integer
override true, false
permission string
resource string
role string
role_id integer
search text
unlimited true, false

GET /api/filters/:id
Mostrar um filtro

Parâmentros

Nome parâmetro Descrição
location_id
opcional

Escopo de localizações

Validations:

  • Must be a Integer

organization_id
opcional

Escopo de organização

Validations:

  • Must be a Integer

id
requerido

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
Criar um filtro

Parâmentros

Nome parâmetro Descrição
location_id
opcional

Escopo de localizações

Validations:

  • Must be a Integer

organization_id
opcional

Escopo de organização

Validations:

  • Must be a Integer

filter
requerido

Validations:

  • Must be a Hash

filter[role_id]
requerido

Validations:

  • Must be a String

filter[search]
opcional , nulo permitido

Validations:

  • Must be a String

filter[override]
opcional , nulo permitido

Validations:

  • Must be one of: true, false, 1, 0.

filter[permission_ids]
opcional , nulo permitido

Validations:

  • Must be an array of any type

filter[organization_ids]
opcional , nulo permitido

Validations:

  • Must be an array of any type

filter[location_ids]
opcional , nulo permitido

Validations:

  • Must be an array of any type


PUT /api/filters/:id
Atualizar um filtro

Parâmentros

Nome parâmetro Descrição
location_id
opcional

Escopo de localizações

Validations:

  • Must be a Integer

organization_id
opcional

Escopo de organização

Validations:

  • Must be a Integer

id
requerido

Validations:

  • Must be a String

filter
requerido

Validations:

  • Must be a Hash

filter[role_id]
opcional

Validations:

  • Must be a String

filter[search]
opcional , nulo permitido

Validations:

  • Must be a String

filter[override]
opcional , nulo permitido

Validations:

  • Must be one of: true, false, 1, 0.

filter[permission_ids]
opcional , nulo permitido

Validations:

  • Must be an array of any type

filter[organization_ids]
opcional , nulo permitido

Validations:

  • Must be an array of any type

filter[location_ids]
opcional , nulo permitido

Validations:

  • Must be an array of any type


DELETE /api/filters/:id
Apagar um filtro

Parâmentros

Nome parâmetro Descrição
location_id
opcional

Escopo de localizações

Validations:

  • Must be a Integer

organization_id
opcional

Escopo de organização

Validations:

  • Must be a Integer

id
requerido

Validations:

  • Must be a String