Filters

>>>

GET /api/filters
Alle Filter auflisten

Parameter

Parametername Beschreibung
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer
search
optional

Ergebnisse filtern

Validations:

  • Must be a String
order
optional

Feld und Reihenfolge sortieren, z.B. 'id DESC'

Validations:

  • Must be a String
page
optional

Seitennummer, beginnend bei 1

Validations:

  • Must be a number.
per_page
optional

Anzahl der angezeigten Ergebnisse pro Seite

Validations:

  • Must be a number.

Suchfelder

Feld Name Typ Mögliche Werte
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
Filter anzeigen

Parameter

Parametername Beschreibung
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer
id
verpflichtend

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
Erstelle einen Filter

Parameter

Parametername Beschreibung
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer
filter
verpflichtend

Validations:

  • Must be a Hash
filter[role_id]
verpflichtend

Validations:

  • Must be a String
filter[search]
optional , nil erlaubt

Validations:

  • Must be a String
filter[override]
optional , nil erlaubt

Validations:

  • Must be one of: true, false, 1, 0.
filter[permission_ids]
optional , nil erlaubt

Validations:

  • Must be an array of any type
filter[organization_ids]
optional , nil erlaubt

Validations:

  • Must be an array of any type
filter[location_ids]
optional , nil erlaubt

Validations:

  • Must be an array of any type
>>>

PUT /api/filters/:id
Filter Aktualisieren

Parameter

Parametername Beschreibung
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer
id
verpflichtend

Validations:

  • Must be a String
filter
verpflichtend

Validations:

  • Must be a Hash
filter[role_id]
optional

Validations:

  • Must be a String
filter[search]
optional , nil erlaubt

Validations:

  • Must be a String
filter[override]
optional , nil erlaubt

Validations:

  • Must be one of: true, false, 1, 0.
filter[permission_ids]
optional , nil erlaubt

Validations:

  • Must be an array of any type
filter[organization_ids]
optional , nil erlaubt

Validations:

  • Must be an array of any type
filter[location_ids]
optional , nil erlaubt

Validations:

  • Must be an array of any type
>>>

DELETE /api/filters/:id
Filter löschen

Parameter

Parametername Beschreibung
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer
id
verpflichtend

Validations:

  • Must be a String