Роли
Облачный Pyrus
Безоблачный Pyrus
Роль похожа на обычного пользователя. Вы можете ставить на неё задачи и включать её в маршрутизацию. Каждый участник роли увидит задачу у себя во Входящих, а когда хотя бы один из них утвердит или отклонит задачу, она перейдёт на следующий этап.
Подробнее о ролях можно прочитать в справке.
Методы
- GET/rolesПолучение всех ролей организации
- GET/roles/{id}Получение информации о роли по ID
- POST/rolesСоздание роли
- PUT/roles/{role-id}Изменение роли
- DELETE/roles/{role-id}Удаление роли
GET /roles
Метод возвращает список всех ролей в организации.
GET https://api.pyrus.com/v4 /roles
Тело ответа
{
"roles": [
{
"id": 32568,
"name": "Accountant",
"banned": false,
"member_ids": [
1233,
1731,
2384
]
},
{
"id": 13355,
"name": "Managers",
"banned": false,
"member_ids": [
2384,
1346,
4444,
3460
]
}
]
}
curl
curl -X GET \ 'https://api.pyrus.com/v4/roles' \ -H 'Authorization: Bearer <YOUR_ACCESS_TOKEN>' \ -H 'Content-Type: application/json'
GET /roles/{id}
Получение информации о роли по ID.
GET https://api.pyrus.com/v4 /roles /{id}
Тело ответа
{
"id": 32568,
"name": "Accountant",
"banned": false,
"member_ids": [
1233,
1731,
2384
]
}
curl
curl -X GET \ 'https://api.pyrus.com/v4/roles/<ROLE_ID>' \ -H 'Authorization: Bearer <YOUR_ACCESS_TOKEN>' \ -H 'Content-Type: application/json'
POST /roles
Метод создает роль в организации пользователя.
POST https://api.pyrus.com/v4 /roles
Тело запроса
{
"name": "TechSupport",
"member_add": [
1732,
4487
]
}
Тело ответа
{
"id": 9364,
"name": "TechSupport",
"banned": "false",
"member_ids": [
1732,
4487
]
}
curl
curl -X POST \
https://api.pyrus.com/v4/roles \
-H 'Authorization: Bearer <YOUR_ACCESS_TOKEN>' \
-H 'Content-Type: application/json' \
-d '{
"name": "TechSupport",
"member_ids": [
1732,
4487
]
}'
Параметры
| name | Имя роли. |
| member_add | Участники роли. Массив идентификаторов пользователей. |
PUT /roles/{role-id}
Метод изменяет роль.
PUT https://api.pyrus.com/v4 /roles /9364
Тело запроса
{
"name": "InternalTechSupport",
"member_add": [
3796
],
"member_remove": [
1732
]
}
Тело ответа
{
"id": 9364,
"name": "InternalTechSupport",
"member_ids": [
3796,
4487
]
}
curl
curl -X PUT \
https://api.pyrus.com/v4/roles/9364 \
-H 'Authorization: Bearer <YOUR_ACCESS_TOKEN>' \
-H 'Content-Type: application/json' \
-d '{
"name": "InternalTechSupport",
"member_add": [
3796
],
"member_remove": [
1732
]
}'
Параметры
| name | Имя роли. |
| member_add | Новые участники роли. Массив идентификаторов пользователей. |
| member_remove | Удаленные из роли участники. Массив идентификаторов пользователей. |
DELETE /roles/{role-id}
Метод удаляет роль из организации пользователя.
DELETE https://api.pyrus.com/v4 /roles /199829
Тело запроса
{
"task_receiver_id": 12711
}
Тело ответа
{
"id": 199829,
"name": "MyRole",
"banned": false,
"fired": true
}
curl
curl -X DELETE \
https://api.pyrus.com/v4/roles/199829\
-H 'Authorization: Bearer <YOUR_ACCESS_TOKEN>' \
-H 'Content-Type: application/json' \
-d '{
"task_receiver_id": 12711
}'
Параметры
task_receiver_id — пользователь, который будет добавлен в задачу об удалении роли.