Приклад get_task запиту
https://your—domain.com/api/admin/v2/?action=get_task&
page=/project/PROJECT_ID/TASK_ID/SUBTASK_ID/&hash=HASH
Повертає дані обраної відкритої або закритої задачі/підзадачі певного проекту
Обов'язкові параметри:
Необов'язкові параметри:
- extra — повертає додаткові дані по задачі/підзадачі (можна вказувати через кому, наприклад extra=text,subscribers):
text або html — опис у відповідно текстовому або html форматі
subscribers — список підписників
files — інформацію по прикріплених до опису файлах
relations — інформацію по зв'язках з іншими завданнями
Повертаються наступні дані по задачі/підзадачі:
- id — її унікальний номер
- name — назва задачі/підзадачі
- status — статус (active/done — відкрита/закрита)
- priority — пріоритет (діапазон значень: 0..10)
- user_from і user_to — інформація про автора і відповідального співробітника
- project — інформація про проект (його id, name і page)
- parent — масив даних по батьківській задачі (якщо в параметрі page вказана сторінка підзадачі)
- text — текст опису задачі/підзадачі в текстовому або html форматі (якщо в запиті вказано параметр extra)
- date_added — дата і час створення
- date_start — дата, коли задача/підзадача повинна стартувати (якщо зазначено)
- date_end — дата, коли задача/підзадача повинна бути закрита (якщо зазначено)
- date_closed — дата та час закриття
- time_end — час виконання задачі/підзадачі (якщо зазначено)
- max_time і max_money — планові фінансові витрати (якщо вказано)
- tags — масив у форматі id: name для статусів і міток задачі/підзадачі (якщо вказано)
- files — інформація по прикріплених до опису файлах (якщо в запиті вказано параметр extra):
id — унікальний номер файлу (можна використовувати в методі
download для завантаження з API)
size — розмір файлу (в байтах)
name — назва файлу з розширенням
page — частина посилання для завантаження напряму (для повного шляху перед отриманим значенням вкажіть адресу вашого акаунту, наприклад https://your-domain.worksection.com/download/123456)
- subscribers — список підписників з інформацією по них (якщо в запиті вказано параметр extra)
- relations — інформація по зв'язках з іншими завданнями (якщо в запиті вказано параметр extra):
from — масив даних по вхідних зв'язках:
type — тип зв'язку finish-to-start/start-to-start
task — коротка інформація по зв'язаному завданню
to — масив даних по вихідних зв'язках (аналогічно from)
Приклад JSON відповіді
Показаний для підзадачі/під-підзадачі (для задачі структура відповіді ідентична, тільки без масиву даних parent)
При успішному виконанні запиту, відповідь буде містити статус ok і наступні дані:
{
"status": "ok",
"data": {
"id": "SUBTASK_ID",
"name": "SUBTASK_NAME",
"page": "/project/PROJECT_ID/TASK_ID/SUBTASK_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/"
},
"parent": {
"id": "TASK_ID",
"name": "TASK_NAME",
"page": "/project/PROJECT_ID/TASK_ID/",
"status": "active",
"priority": "0..10",
},
"text": "SUBTASK_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": "SUBTASK_ID",
"name": "SUBTASK_NAME",
"page": "/project/PROJECT_ID/TASK_ID/SUBTASK_ID/",
"status": "active",
"priority": "0..10"
}
}
],
"from": [
{
"type": "start-to-start",
"task": {
"id": "SUBTASK_ID",
"name": "SUBTASK_NAME",
"page": "/project/PROJECT_ID/TASK_ID/SUBTASK_ID/",
"status": "done",
"priority": "0..10"
}
}
]
}
}
}