GET /api/roles
Afficher tous les rôles

Paramètres

Nom du paramètre Description
search
optionel

filtrer les résultats

Validations:

  • Must be a String

order
optionel

trier les resultats

Validations:

  • Must be a String

page
optionel

paginer les résultats

Validations:

  • Must be a String

per_page
optionel

nombre d'entier par requête

Validations:

  • Must be a String


GET /api/roles/:id
Afficher un rôle

Paramètres

Nom du paramètre Description
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.

description
optionel

Validations:

  • Must be a String


POST /api/roles
Créer un rôle

Paramètres

Nom du paramètre Description
role
requis

Validations:

  • Must be a Hash

role[name]
requis

Validations:

  • Must be a String

role[description]
optionel , nil autorisé

Role description

Validations:

  • Must be a String

role[location_ids]
optionel , nil autorisé

REMPLACER les emplacements qui ont les ID suivant

Validations:

  • Must be an array of any type

role[organization_ids]
optionel , nil autorisé

REMPLACER les organisations qui ont les ID suivant

Validations:

  • Must be an array of any type


PUT /api/roles/:id
Mise à jour d'un rôle

Paramètres

Nom du paramètre Description
id
requis

Validations:

  • Must be a String

role
requis

Validations:

  • Must be a Hash

role[name]
optionel

Validations:

  • Must be a String

role[description]
optionel , nil autorisé

Role description

Validations:

  • Must be a String

role[location_ids]
optionel , nil autorisé

REMPLACER les emplacements qui ont les ID suivant

Validations:

  • Must be an array of any type

role[organization_ids]
optionel , nil autorisé

REMPLACER les organisations qui ont les ID suivant

Validations:

  • Must be an array of any type


DELETE /api/roles/:id
Supprimer un rôle

Paramètres

Nom du paramètre Description
id
requis

Validations:

  • Must be a String


POST /api/roles/:id/clone
Cloner un rôle

Paramètres

Nom du paramètre Description
id
requis

Validations:

  • Must be a String

role
requis

Validations:

  • Must be a Hash

role[name]
optionel

Validations:

  • Must be a String

role[description]
optionel , nil autorisé

Role description

Validations:

  • Must be a String

role[location_ids]
optionel , nil autorisé

REMPLACER les emplacements qui ont les ID suivant

Validations:

  • Must be an array of any type

role[organization_ids]
optionel , nil autorisé

REMPLACER les organisations qui ont les ID suivant

Validations:

  • Must be an array of any type