guild/docs/api/task.md

Задачи

Методы

Метод	Описание
get-task-list	Возвращает список задач
get-task	Возвращает задачу
create-task	Создаёт задачу
update	Обновить задачу

Список задач

https://guild.craft-group.xyz/api/task/get-task-list?project_id=1

Параметры:

Параметры	Значение
project_id	Id проекта

Без передачи параметра возвращает массив объектов Задача . С параметром project_id, метод возвращает объекты Задача определённого проекта.

Возвращает массив объектов Задача.
Каждый объект Задача имеет такой вид:

[
  {
    "id": "6",
    "project_id": "74",
    "title": "Название задачи",
    "status": "1",
    "created_at": "2021-12-20 16:29:39",
    "updated_at": "2021-12-20 17:35:04",
    "description": "Описание задачи",
    "card_id_creator": "1",
    "card_id": "3"
  },
 '...'
]

Получить документ

https://guild.craft-group.xyz/api/task/get-task?task_id=15

Параметры:

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

Возвращает объект Задача.
Каждый объект Задача имеет такой вид:

{
  "id": 15,
  "project_id": 74,
  "title": "4324238888",
  "status": 1,
  "created_at": "2022-01-05 17:37:37",
  "updated_at": "2022-01-05 17:46:10",
  "description": "888",
  "card_id_creator": 1,
  "card_id": null
}

Пример ошибки:

{
  "name": "Not Found",
  "message": "The task does not exist",
  "code": 0,
  "status": 404,
  "type": "yii\\web\\NotFoundHttpException"
}

Создать документ

https://guild.craft-group.xyz/api/document/create-document

Параметры:

Параметры	Значение
title	Название задачи
project_id	Id проекта
status	статус задачи
card_id_creator	Id профиля создателя
card_id	Id профиля наблюдателя(не обязательный параметр)
description	Описание

Создаёт Задача. Требует передачи POST запроса с соответствующими параметрами

В случае указания не верных параметров буде возвращена соответствующая ошибка. Пример ошибки:

{
  "name": "Internal Server Error",
  "message": "{\"project_id\":[\"\П\р\о\е\к\т is invalid.\"]}",
  "code": 0,
  "status": 500,
  "type": "yii\\web\\ServerErrorHttpException"
}

Обновить документ

https://guild.craft-group.xyz/api/task/update

Параметры:

Параметры	Значение
title	Название задачи
project_id	Id проекта
status	статус задачи
card_id_creator	Id профиля создателя
card_id	Id профиля наблюдателя(не обязательный параметр)
description	Описание

Обновляет объект Задача. Требует передачи POST запроса с соответствующими параметрами

В случае указания не верных параметров буде возвращена соответствующая ошибка. Пример ошибки:

{
  "name": "Not Found",
  "message": "The task does not exist",
  "code": 0,
  "status": 404,
  "type": "yii\\web\\NotFoundHttpException"
}