Filters

>>>

GET /api/filters
Afficher tous les filtres

Paramètres

Nom du paramètre Description
location_id
optionel

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optionel

Set the current organization context for the request

Validations:

  • Must be a Integer
search
optionel

filtrer les résultats

Validations:

  • Must be a String
order
optionel

Champ et sens de tri, ex: 'id DESC'

Validations:

  • Must be a String
page
optionel

Numéro de la page, commençant par 1

Validations:

  • Must be a number.
per_page
optionel

Nombre de résultats par page à renvoyer

Validations:

  • Must be a number.

Rechercher les champs

Nom du champ Type Valeurs possibles
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
Afficher un filtre

Paramètres

Nom du paramètre Description
location_id
optionel

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optionel

Set the current organization context for the request

Validations:

  • Must be a Integer
id
requis

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
Créer un filtre

Paramètres

Nom du paramètre Description
location_id
optionel

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optionel

Set the current organization context for the request

Validations:

  • Must be a Integer
filter
requis

Validations:

  • Must be a Hash
filter[role_id]
requis

Validations:

  • Must be a String
filter[search]
optionel , nil autorisé

Validations:

  • Must be a String
filter[override]
optionel , nil autorisé

Validations:

  • Must be one of: true, false, 1, 0.
filter[permission_ids]
optionel , nil autorisé

Validations:

  • Must be an array of any type
filter[organization_ids]
optionel , nil autorisé

Validations:

  • Must be an array of any type
filter[location_ids]
optionel , nil autorisé

Validations:

  • Must be an array of any type
>>>

PUT /api/filters/:id
Mise à jour d'un filtre

Paramètres

Nom du paramètre Description
location_id
optionel

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optionel

Set the current organization context for the request

Validations:

  • Must be a Integer
id
requis

Validations:

  • Must be a String
filter
requis

Validations:

  • Must be a Hash
filter[role_id]
optionel

Validations:

  • Must be a String
filter[search]
optionel , nil autorisé

Validations:

  • Must be a String
filter[override]
optionel , nil autorisé

Validations:

  • Must be one of: true, false, 1, 0.
filter[permission_ids]
optionel , nil autorisé

Validations:

  • Must be an array of any type
filter[organization_ids]
optionel , nil autorisé

Validations:

  • Must be an array of any type
filter[location_ids]
optionel , nil autorisé

Validations:

  • Must be an array of any type
>>>

DELETE /api/filters/:id
Supprimer un filtre

Paramètres

Nom du paramètre Description
location_id
optionel

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optionel

Set the current organization context for the request

Validations:

  • Must be a Integer
id
requis

Validations:

  • Must be a String