Решения
worksection
beta
help
Получение отдельной задачи через API: get_task
Пример get_task запроса
?action=get_task&id_task=TASK_ID
Возвращает отдельное задание (открытое или закрытое)
*кроме заданий с отложенной публикацией
*для возвращения задачи вместе с ее подзадачами используйте параметр extra=subtasks
Обязательные параметры:
- id_task — ID задания
Необязательные параметры:
- extra — дополнительные данные по заданиям, возможные значения (можно указывать через запятую, например extra=text,files):
- filter=active — только открытые подзадачи (при использовании параметра extra=subscribers)
Фильтр только по закрытым не предусмотрен
text или html — описание в текстовом или html формате
files — информация о файлах, прикрепленных в описание задания
comments — пять последних комментариев
relations — информация о связях с другими заданиями
subtasks — информация о подзаданиях (в массиве child)
subscribers — список подписчиков
Возвращаемые данные:
- id — ID задания
- name — название задания
- page — ссылка на задание
- status — состояние (active/done — открытая/закрытая)
- priority — приоритет (диапазон значений: 0..10)
- user_from и user_to — автор и ответственный по заданию
- project — информация о проекте
- parent — родительская задача (если в запросе указан ID подзадания)
- text — описание задания в текстовом или html формате (если в запросе указан соответствующий параметр extra)
- date_added — дата и время создания
- date_start — дата старта (если указано)
- date_end — дата завершения (если указано)
- date_closed — дата и время закрытия
- time_end — время завершения (если указано)
- max_time и max_money — плановые временные и финансовые затраты (если указаны)
- tags — теги задания в формате id: name (если указаны)
- files — информация о прикрепленных файлах (если в запросе указан параметр extra=files):
- subscribers — список подписчиков (если в запросе указан параметр extra=subscribers)
- relations — информация о связях с другими заданиями (если в запросе указан параметр extra=relations):
- child — информация по подзаданиям (если в запросе указаны ID задачи и параметр extra=subtasks)
id — ID файла (можно использовать в методе download для скачивания по API)
size — размер файла (в байтах)
name — название файла с расширением
page — часть ссылки для скачивания напрямую (для полного пути перед полученным значением укажите адрес вашего аккаунта, например https://youraccount.worksection.com/download/123456)
from — входящие связи:
type — тип связи finish-to-start/start-to-start
task — информация о связанном задании
to — исходящие связи (аналогично from)
Пример JSON ответа
При успешном выполнении запроса, ответ будет содержать статус ok и следующие данные:
*для задачи
{
"status": "ok",
"data": {
"id": "TASK_ID",
"name": "TASK_NAME",
"page": "/project/PROJECT_ID/TASK_ID/",
"status": "active",
"priority": "0..10",
"user_from": {
"id": "USER_ID",
"email": "USER_EMAIL",
"name": "USER_NAME"
},
"user_to": {
"id": "USER_ID",
"email": "USER_EMAIL",
"name": "USER_NAME"
},
"project": {
"id": "PROJECT_ID",
"name": "PROJECT_NAME",
"page": "/project/PROJECT_ID/"
},
"text": "TASK_TEXT",
"date_added": "YYYY-MM-DD HH:II",
"date_start": "YYYY-MM-DD",
"date_end": "YYYY-MM-DD",
"date_closed": "YYYY-MM-DD HH:II",
"time_end": "HH:II",
"max_time": "25",
"max_money": "50",
"tags": {
"TAG_ID": "TAG_NAME_1",
"TAG_ID": "TAG_NAME_2"
},
"files": [
{
"id": "FILE_ID",
"size": "FILE_SIZE",
"name": "Example.docx",
"page": "/download/FILE_ID"
}
],
"subscribers": [
{
"id": "USER_ID",
"email": "USER_EMAIL",
"name": "USER_NAME_1"
},
{
"id": "USER_ID",
"email": "USER_EMAIL",
"name": "USER_NAME_2"
}
],
"relations": {
"to": [
{
"type": "finish-to-start",
"task": {
"id": "TASK_ID",
"name": "TASK_NAME",
"page": "/project/PROJECT_ID/TASK_ID/",
"status": "active",
"priority": "0..10"
}
}
],
"from": [
{
"type": "start-to-start",
"task": {
"id": "TASK_ID",
"name": "TASK_NAME",
"page": "/project/PROJECT_ID/TASK_ID/",
"status": "done",
"priority": "0..10"
}
}
]
},
"child": [
{
"id": "SUBTASK_ID",
"name": "SUBTASK_NAME_1",
"page": "/project/PROJECT_ID/TASK_ID/SUBTASK_ID/",
"status": "active",
"priority": "0..10",
"child": [
{
"id": "SUBTASK_ID",
"name": "SUBTASK_NAME_2",
"page": "/project/PROJECT_ID/TASK_ID/SUBTASK_ID/",
"status": "done",
"priority": "0..10"
}
]
}
]
}
}
*для подзадачи/под-подзадачи (идентичная структура ответа, только с дополнительным массивом данных parent и без массива child){
"status": "ok",
"data": {
"id": "SUB-SUBTASK_ID",
"name": "SUB-SUBTASK_NAME",
"page": "/project/PROJECT_ID/TASK_ID/SUB-SUBTASK_ID/",
... ... ...,
"project":
... ... ...
,
"parent": {
"id": "SUBTASK_ID",
"name": "SUBTASK_NAME",
"page": "/project/PROJECT_ID/SUBTASK_ID/",
"status": "active",
"priority": "0..10",
"parent": {
"id": "TASK_ID",
"name": "TASK_NAME",
"page": "/project/PROJECT_ID/TASK_ID/",
"status": "active",
"priority": "0..10",
}
},
"text": ...,
... ... ...
"relations":
... ... ...
}
}
Оставьте ваш отзыв
Помогла ли вам эта статья?
Рады, что смогли помочь! Что было полезным?
Извините, что это не помогло. Что пошло не так?
Предыдущая
Получение задач проекта через API: get_tasks
Следующая
Создание задачи через API: post_task