guild/docs/api/task-user.md
2022-03-21 16:11:56 +03:00

4.0 KiB
Raw Blame History

Исполнители задачи

Методы

Метод Описание
get-task-users Список исплнителей задачи
set-task-users Назначить исполнителя на задачу

Список исполнителей задачи

https://guild.craft-group.xyz/api/task-user/get-task-users

Для получения списка исполнителей необходимо отправить GET запрос на URL https://guild.craft-group.xyz/api/task-user/get-task-users

Требуемые параметры:

Параметры Значение
task_id ID задачи

Пример запроса:

https://guild.craft-group.xyz/api/task-user/get-task-users?task_id=10

Возвращает массив сотрудников проекта закреплённых за задачей.
Каждый ответ имеет такой вид:

[
  {
    "id": 5,
    "task_id": 10,
    "project_user_id": 1
  },
  {
    "id": 7,
    "task_id": 10,
    "project_user_id": 5
  }
]

Параметры объекта Исполнитель:

Параметры Значение
id ID исполнителя задачи(int)
task_id ID задачи(int)
project_user_id ID сотрудника на проекте(int)

Если задача не найдена будет отправлено следующее сообщение:

{
  "name": "Not Found",
  "message": "The task does not exist or there are no employees for it",
  "code": 0,
  "status": 404,
  "type": "yii\\web\\NotFoundHttpException"
}

Назначить сотрудника на задачу

https://guild.craft-group.xyz/api/task-user/set-task-users

Для назначения исполнителя необходимо отправить POST запрос на URL https://guild.craft-group.xyz/api/task-user/set-task-user

Требуемые параметры:

Параметры Значение
task_id ID задачи
project_user_id ID сотрудника на проекте

Пример запроса:

https://guild.craft-group.xyz/api/task-user/set-task-user

Возвращает объект Исполнителя задачи.
Каждый ответ имеет такой вид:

{
  "task_id": "10",
  "project_user_id": "5",
  "id": 8
}

Если задача не найдена будет отправлено следующее сообщение:

{
  "name": "Bad Request",
  "message": "{\"task_id\":[\"\З\а\д\а\ч\а is invalid.\"]}",
  "code": 0,
  "status": 400,
  "type": "yii\\web\\BadRequestHttpException"
}