Roles

>>>

GET /api/roles
Alle Rollen 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
builtin true, false
description
name
permission string
>>>

GET /api/roles/:id
Rolle 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.
description
optional

Validations:

  • Must be a String
>>>

POST /api/roles
Rolle erstellen

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
role
verpflichtend

Validations:

  • Must be a Hash
role[name]
verpflichtend

Validations:

  • Must be a String
role[description]
optional , nil erlaubt

Beschreibung der Rolle

Validations:

  • Must be a String
role[location_ids]
optional , nil erlaubt

Standorte durch angegebene Kennungen ERSETZEN

Validations:

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

Organisationen durch angegebene Kennungen ERSETZEN

Validations:

  • Must be an array of any type
>>>

PUT /api/roles/:id
Rolle 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
role
verpflichtend

Validations:

  • Must be a Hash
role[name]
optional

Validations:

  • Must be a String
role[description]
optional , nil erlaubt

Beschreibung der Rolle

Validations:

  • Must be a String
role[location_ids]
optional , nil erlaubt

Standorte durch angegebene Kennungen ERSETZEN

Validations:

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

Organisationen durch angegebene Kennungen ERSETZEN

Validations:

  • Must be an array of any type
>>>

DELETE /api/roles/:id
Rolle 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
>>>

POST /api/roles/:id/clone
Rolle klonen

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
role
verpflichtend

Validations:

  • Must be a Hash
role[name]
optional

Validations:

  • Must be a String
role[description]
optional , nil erlaubt

Beschreibung der Rolle

Validations:

  • Must be a String
role[location_ids]
optional , nil erlaubt

Standorte durch angegebene Kennungen ERSETZEN

Validations:

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

Organisationen durch angegebene Kennungen ERSETZEN

Validations:

  • Must be an array of any type