GET /api/roles
Listar todos los roles

Parámetros

Nombre del parámetro Descripción
search
opcional

filtrar resultados

Validations:

  • Must be a String

order
opcional

organizar resultados

Validations:

  • Must be a String

page
opcional

paginar resultados

Validations:

  • Must be a String

per_page
opcional

número de entradas por solicitud

Validations:

  • Must be a String


GET /api/roles/:id
Mostrar un rol

Parámetros

Nombre del parámetro Descripción
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.

description
opcional

Validations:

  • Must be a String


POST /api/roles
Crear un rol

Parámetros

Nombre del parámetro Descripción
role
requerido

Validations:

  • Must be a Hash

role[name]
requerido

Validations:

  • Must be a String

role[description]
opcional , nil permitido

Descripción del rol

Validations:

  • Must be a String

role[location_ids]
opcional , nil permitido

REMPLAZAR ubicaciones con ID dadas

Validations:

  • Must be an array of any type

role[organization_ids]
opcional , nil permitido

REMPLAZAR organizaciones con ID dadas.

Validations:

  • Must be an array of any type


PUT /api/roles/:id
Actualizar un rol

Parámetros

Nombre del parámetro Descripción
id
requerido

Validations:

  • Must be a String

role
requerido

Validations:

  • Must be a Hash

role[name]
opcional

Validations:

  • Must be a String

role[description]
opcional , nil permitido

Descripción del rol

Validations:

  • Must be a String

role[location_ids]
opcional , nil permitido

REMPLAZAR ubicaciones con ID dadas

Validations:

  • Must be an array of any type

role[organization_ids]
opcional , nil permitido

REMPLAZAR organizaciones con ID dadas.

Validations:

  • Must be an array of any type


DELETE /api/roles/:id
Borrar un rol

Parámetros

Nombre del parámetro Descripción
id
requerido

Validations:

  • Must be a String


POST /api/roles/:id/clone
Clonar rol

Parámetros

Nombre del parámetro Descripción
id
requerido

Validations:

  • Must be a String

role
requerido

Validations:

  • Must be a Hash

role[name]
opcional

Validations:

  • Must be a String

role[description]
opcional , nil permitido

Descripción del rol

Validations:

  • Must be a String

role[location_ids]
opcional , nil permitido

REMPLAZAR ubicaciones con ID dadas

Validations:

  • Must be an array of any type

role[organization_ids]
opcional , nil permitido

REMPLAZAR organizaciones con ID dadas.

Validations:

  • Must be an array of any type