Roles

>>>

GET /api/roles
Список всех ролей

Параметры

Имя параметра Описание
location_id
необязательно

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
необязательно

Set the current organization context for the request

Validations:

  • Must be a Integer
search
необязательно

отфильтровать результаты

Validations:

  • Must be a String
order
необязательно

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String
page
необязательно

Номер страницы, начиная с 1

Validations:

  • Must be a number.
per_page
необязательно

Число элементов на странице

Validations:

  • Must be a number.

Search fields

Field name Тип Possible values
builtin true, false
description
name
permission string
>>>

GET /api/roles/:id
Показать роль

Параметры

Имя параметра Описание
location_id
необязательно

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
необязательно

Set the current organization context for the request

Validations:

  • Must be a Integer
id
обязательно

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
необязательно

Validations:

  • Must be a String
>>>

POST /api/roles
Создать роль

Параметры

Имя параметра Описание
location_id
необязательно

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
необязательно

Set the current organization context for the request

Validations:

  • Must be a Integer
role
обязательно

Validations:

  • Must be a Hash
role[name]
обязательно

Validations:

  • Must be a String
role[description]
необязательно , nil разрешен

Role description

Validations:

  • Must be a String
role[location_ids]
необязательно , nil разрешен

ЗАМЕСТИТЬ местоположения с заданным кодом

Validations:

  • Must be an array of any type
role[organization_ids]
необязательно , nil разрешен

ЗАМЕСТИТЬ организации с заданным кодом

Validations:

  • Must be an array of any type
>>>

PUT /api/roles/:id
Изменить роль

Параметры

Имя параметра Описание
location_id
необязательно

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
необязательно

Set the current organization context for the request

Validations:

  • Must be a Integer
id
обязательно

Validations:

  • Must be a String
role
обязательно

Validations:

  • Must be a Hash
role[name]
необязательно

Validations:

  • Must be a String
role[description]
необязательно , nil разрешен

Role description

Validations:

  • Must be a String
role[location_ids]
необязательно , nil разрешен

ЗАМЕСТИТЬ местоположения с заданным кодом

Validations:

  • Must be an array of any type
role[organization_ids]
необязательно , nil разрешен

ЗАМЕСТИТЬ организации с заданным кодом

Validations:

  • Must be an array of any type
>>>

DELETE /api/roles/:id
Удалить роль

Параметры

Имя параметра Описание
location_id
необязательно

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
необязательно

Set the current organization context for the request

Validations:

  • Must be a Integer
id
обязательно

Validations:

  • Must be a String
>>>

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

Параметры

Имя параметра Описание
location_id
необязательно

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
необязательно

Set the current organization context for the request

Validations:

  • Must be a Integer
id
обязательно

Validations:

  • Must be a String
role
обязательно

Validations:

  • Must be a Hash
role[name]
необязательно

Validations:

  • Must be a String
role[description]
необязательно , nil разрешен

Role description

Validations:

  • Must be a String
role[location_ids]
необязательно , nil разрешен

ЗАМЕСТИТЬ местоположения с заданным кодом

Validations:

  • Must be an array of any type
role[organization_ids]
необязательно , nil разрешен

ЗАМЕСТИТЬ организации с заданным кодом

Validations:

  • Must be an array of any type