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

Параметры

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

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

Validations:

  • Must be a String

order
необязательно

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

Validations:

  • Must be a String

page
необязательно

постраничный вывод

Validations:

  • Must be a String

per_page
необязательно

количество записей на запрос

Validations:

  • Must be a String


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

Параметры

Имя параметра Описание
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
Создать роль

Параметры

Имя параметра Описание
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
Изменить роль

Параметры

Имя параметра Описание
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
Удалить роль

Параметры

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

Validations:

  • Must be a String


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

Параметры

Имя параметра Описание
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