Roles

>>>

GET /api/roles
Listar todas as regras

Parâmentros

Nome parâmetro Descrição
location_id
opcional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
opcional

Set the current organization context for the request

Validations:

  • Must be a Integer
search
opcional

filtrar resultados

Validations:

  • Must be a String
order
opcional

Classificar campo e ordem, ex.: ‘id DESC’

Validations:

  • Must be a String
page
opcional

Número de página, iniciando em 1

Validations:

  • Must be a number.
per_page
opcional

Número de resultados por página para retornar

Validations:

  • Must be a number.

Pesquisar campos

Nome do campo Tipo Valores possíveis
builtin true, false
description
name
permission string
>>>

GET /api/roles/:id
Mostrar um perfil

Parâmentros

Nome parâmetro Descrição
location_id
opcional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
opcional

Set the current organization context for the request

Validations:

  • Must be a Integer
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
location_id
opcional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
opcional

Set the current organization context for the request

Validations:

  • Must be a Integer
role
requerido

Validations:

  • Must be a Hash
role[name]
requerido

Validations:

  • Must be a String
role[description]
opcional , nulo permitido

Descrição da função

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
location_id
opcional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
opcional

Set the current organization context for the request

Validations:

  • Must be a Integer
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

Descrição da função

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
location_id
opcional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
opcional

Set the current organization context for the request

Validations:

  • Must be a Integer
id
requerido

Validations:

  • Must be a String
>>>

POST /api/roles/:id/clone
Clonar uma função

Parâmentros

Nome parâmetro Descrição
location_id
opcional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
opcional

Set the current organization context for the request

Validations:

  • Must be a Integer
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

Descrição da função

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