GET /api/roles
Listar todas as regras

Parâmentros

Nome parâmetro Descrição
search
opcional

filtrar resultados

Validations:

  • Must be a String

order
opcional

ordenar resultados

Validations:

  • Must be a String

page
opcional

paginar resultados

Validations:

  • Must be a String

per_page
opcional

número de entradas por requisições

Validations:

  • Must be a String


GET /api/roles/:id
Mostrar um perfil

Parâmentros

Nome parâmetro Descrição
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
Criar um perfil

Parâmentros

Nome parâmetro Descrição
role
requerido

Validations:

  • Must be a Hash

role[name]
requerido

Validations:

  • Must be a String

role[description]
opcional , nulo permitido

Role description

Validations:

  • Must be a String

role[location_ids]
opcional , nulo permitido

SUBSTITUIR localizações dadas com ids

Validations:

  • Must be an array of any type

role[organization_ids]
opcional , nulo permitido

SUBSTITUIR organizações dadas com ids

Validations:

  • Must be an array of any type


PUT /api/roles/:id
Atualizar uma função

Parâmentros

Nome parâmetro Descrição
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 , nulo permitido

Role description

Validations:

  • Must be a String

role[location_ids]
opcional , nulo permitido

SUBSTITUIR localizações dadas com ids

Validations:

  • Must be an array of any type

role[organization_ids]
opcional , nulo permitido

SUBSTITUIR organizações dadas com ids

Validations:

  • Must be an array of any type


DELETE /api/roles/:id
Apagar uma role

Parâmentros

Nome parâmetro Descrição
id
requerido

Validations:

  • Must be a String


POST /api/roles/:id/clone
Clone a role

Parâmentros

Nome parâmetro Descrição
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 , nulo permitido

Role description

Validations:

  • Must be a String

role[location_ids]
opcional , nulo permitido

SUBSTITUIR localizações dadas com ids

Validations:

  • Must be an array of any type

role[organization_ids]
opcional , nulo permitido

SUBSTITUIR organizações dadas com ids

Validations:

  • Must be an array of any type