Перейти к содержанию

Задачи

API методы для модуля tasks

Задачи

Получение по ID

GET /tasks/api/task/get

Позволяет получить информацию о задаче по ее ID.

curl 'https://{HOST}.platrum.ru/tasks/api/task/get' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}' \ 
    --data '{"id":123}'

{
    "status": "success",
    "data": {
        "can_edit": true,
        "can_change_status": true,
        "can_change_deadline": true,
        "is_finished": true,
        "is_favorite": true,
        "is_subordinate": true,
        "is_recurrent": true,
        "is_daily": true,
        "checklist_data": [
            {
                "done_count": 123,
                "total_count": 123
            }
        ],
        "comment_count": 123,
        "parent_data": [
            {
                "id": 123,
                "name": "some_string",
                "status_key": "some_string"
            }
        ],
        "last_plan_end_date": "2019-01-01 21:00:15",
        "id": 123,
        "name": "some_string",
        "description": "some_string",
        "owner_user_id": "some_string",
        "responsible_user_ids": [
            "some_string",
            "some_string"
        ],
        "auditors": [
            "some_string",
            "some_string"
        ],
        "watchers": [
            "some_string",
            "some_string"
        ],
        "block_id": 123,
        "category_key": "some_string",
        "product": "some_string",
        "time_plan": 123,
        "time_fact": 123,
        "status_key": "some_string",
        "is_planned": true,
        "board_panel_id": 123,
        "order": "map[string]int",
        "start_date": "2019-01-01 21:00:15",
        "finish_date": "2019-01-01 21:00:15",
        "creation_date": "2019-01-01 21:00:15",
        "integration_data": "map",
        "parent_id": 123,
        "path": "materialized_path",
        "file_ids": [
            "some_string",
            "some_string"
        ],
        "is_important": true,
        "favorite_user_ids": [
            "some_string",
            "some_string"
        ],
        "tag_keys": [
            "some_string",
            "some_string"
        ],
        "recurrence_data": "map",
        "relations": [
            {
                "id": 123,
                "type": "some_string",
                "target_task_id": 123,
                "creation_date": "2019-01-01 21:00:15",
                "author_id": "some_string"
            }
        ],
        "close_date": "2019-01-01 21:00:15"
    }
}
Параметр Описание Тип Значения
id* ID задачи int -
Параметр Описание Тип Значения
can_edit Возможность редактирования bool -
can_change_status Возможность смены статуса bool -
can_change_deadline Возможность смены сроков bool -
is_finished Статус выполнения bool -
is_favorite Добавлена ли в избарнное bool -
is_subordinate Является ли задачей подчинённого bool -
is_recurrent Является ли периодической bool -
is_daily Является ли ежедневной bool -
checklist_data Данные чеклистов checklist_data -
comment_count Количество комментариев int -
parent_data Данные родительской задачи parent_data -
last_plan_end_date Дата последнего плана date -
id ID int -
name Задача string -
description Описание string -
owner_user_id Постановщик string -
responsible_user_ids Исполнители array[string] -
auditors Id аудиторов array[string] -
watchers Id пользователей, отслеживающих задачу array[string] -
block_id Должность int -
category_key Категория string -
product Продукт string -
time_plan Планируемое время int -
time_fact Фактическое время int -
status_key Статус string -
is_planned Добавлена хотя бы в один план bool -
board_panel_id ID панели в досках int -
order Информация о сортировке в разных панелях map[string]int -
start_date Дата начала date -
finish_date Дата завершения date -
creation_date Дата создания date -
integration_data map -
parent_id Id родительской задачи int -
path Materialized path для получения деревьев materialized_path -
file_ids ID прикреплённых файлов array[string] -
is_important Является ли срочной bool -
favorite_user_ids ID пользователей, которые пометили задачу избранной array[string] -
tag_keys Тэги используемые в задаче array[string] -
recurrence_data map -
relations links array[tasks.relation] -
close_date Дата закрытия задачи date -

Получение списка

GET /tasks/api/task/list

Позволяет получить список задач по заданным фильтрам. Значения дат передаются в фильтре массивом из двух значений: начало и конец нужного периода.

curl 'https://{HOST}.platrum.ru/tasks/api/task/list' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}' \ 
    --data '{"search":"some_string","planned_end_date":["2019-01-01 21:00:15","2019-01-01 21:00:15"],"id":[123,123],"name":["some_string","some_string"],"description":["some_string","some_string"],"owner_user_id":["some_string","some_string"],"responsible_user_ids":["some_string","some_string"],"auditors":["some_string","some_string"],"watchers":["some_string","some_string"],"block_id":[123,123],"category_key":["some_string","some_string"],"product":["some_string","some_string"],"time_plan":[123,123],"time_fact":[123,123],"status_key":["some_string","some_string"],"is_planned":true,"board_panel_id":[123,123],"order":"map[string]int","start_date":["2019-01-01 21:00:15","2019-01-01 21:00:15"],"finish_date":["2019-01-01 21:00:15","2019-01-01 21:00:15"],"creation_date":["2019-01-01 21:00:15","2019-01-01 21:00:15"],"integration_data":"map","parent_id":[123,123],"path":"materialized_path","file_ids":["some_string","some_string"],"is_important":true,"favorite_user_ids":["some_string","some_string"],"tag_keys":["some_string","some_string"],"recurrence_data":"map","relations":[{"id":123,"type":"some_string","target_task_id":123,"creation_date":"2019-01-01 21:00:15","author_id":"some_string"}],"close_date":["2019-01-01 21:00:15","2019-01-01 21:00:15"]}'

{
    "status": "success",
    "data": [
        {
            "can_edit": true,
            "can_change_status": true,
            "can_change_deadline": true,
            "is_finished": true,
            "is_favorite": true,
            "is_subordinate": true,
            "is_recurrent": true,
            "is_daily": true,
            "checklist_data": [
                {
                    "done_count": 123,
                    "total_count": 123
                }
            ],
            "comment_count": 123,
            "parent_data": [
                {
                    "id": 123,
                    "name": "some_string",
                    "status_key": "some_string"
                }
            ],
            "last_plan_end_date": "2019-01-01 21:00:15",
            "id": 123,
            "name": "some_string",
            "description": "some_string",
            "owner_user_id": "some_string",
            "responsible_user_ids": [
                "some_string",
                "some_string"
            ],
            "auditors": [
                "some_string",
                "some_string"
            ],
            "watchers": [
                "some_string",
                "some_string"
            ],
            "block_id": 123,
            "category_key": "some_string",
            "product": "some_string",
            "time_plan": 123,
            "time_fact": 123,
            "status_key": "some_string",
            "is_planned": true,
            "board_panel_id": 123,
            "order": "map[string]int",
            "start_date": "2019-01-01 21:00:15",
            "finish_date": "2019-01-01 21:00:15",
            "creation_date": "2019-01-01 21:00:15",
            "integration_data": "map",
            "parent_id": 123,
            "path": "materialized_path",
            "file_ids": [
                "some_string",
                "some_string"
            ],
            "is_important": true,
            "favorite_user_ids": [
                "some_string",
                "some_string"
            ],
            "tag_keys": [
                "some_string",
                "some_string"
            ],
            "recurrence_data": "map",
            "relations": [
                {
                    "id": 123,
                    "type": "some_string",
                    "target_task_id": 123,
                    "creation_date": "2019-01-01 21:00:15",
                    "author_id": "some_string"
                }
            ],
            "close_date": "2019-01-01 21:00:15"
        },
        {
            "can_edit": true,
            "can_change_status": true,
            "can_change_deadline": true,
            "is_finished": true,
            "is_favorite": true,
            "is_subordinate": true,
            "is_recurrent": true,
            "is_daily": true,
            "checklist_data": [
                {
                    "done_count": 123,
                    "total_count": 123
                }
            ],
            "comment_count": 123,
            "parent_data": [
                {
                    "id": 123,
                    "name": "some_string",
                    "status_key": "some_string"
                }
            ],
            "last_plan_end_date": "2019-01-01 21:00:15",
            "id": 123,
            "name": "some_string",
            "description": "some_string",
            "owner_user_id": "some_string",
            "responsible_user_ids": [
                "some_string",
                "some_string"
            ],
            "auditors": [
                "some_string",
                "some_string"
            ],
            "watchers": [
                "some_string",
                "some_string"
            ],
            "block_id": 123,
            "category_key": "some_string",
            "product": "some_string",
            "time_plan": 123,
            "time_fact": 123,
            "status_key": "some_string",
            "is_planned": true,
            "board_panel_id": 123,
            "order": "map[string]int",
            "start_date": "2019-01-01 21:00:15",
            "finish_date": "2019-01-01 21:00:15",
            "creation_date": "2019-01-01 21:00:15",
            "integration_data": "map",
            "parent_id": 123,
            "path": "materialized_path",
            "file_ids": [
                "some_string",
                "some_string"
            ],
            "is_important": true,
            "favorite_user_ids": [
                "some_string",
                "some_string"
            ],
            "tag_keys": [
                "some_string",
                "some_string"
            ],
            "recurrence_data": "map",
            "relations": [
                {
                    "id": 123,
                    "type": "some_string",
                    "target_task_id": 123,
                    "creation_date": "2019-01-01 21:00:15",
                    "author_id": "some_string"
                }
            ],
            "close_date": "2019-01-01 21:00:15"
        }
    ]
}
Параметр Описание Тип Значения
search Искомое значение. Ищет по задаче и продукту string -
planned_end_date Дата плана array[date] -
id ID array[int] -
name Задача array[string] -
description Описание array[string] -
owner_user_id Постановщик array[string] -
responsible_user_ids Исполнители array[string] -
auditors Id аудиторов array[string] -
watchers Id пользователей, отслеживающих задачу array[string] -
block_id Должность array[int] -
category_key Категория array[string] -
product Продукт array[string] -
time_plan Планируемое время array[int] -
time_fact Фактическое время array[int] -
status_key Статус array[string] -
is_planned Добавлена хотя бы в один план bool -
board_panel_id ID панели в досках array[int] -
order Информация о сортировке в разных панелях map[string]int -
start_date Дата начала array[date] -
finish_date Дата завершения array[date] -
creation_date Дата создания array[date] -
integration_data map -
parent_id Id родительской задачи array[int] -
path Materialized path для получения деревьев materialized_path -
file_ids ID прикреплённых файлов array[string] -
is_important Является ли срочной bool -
favorite_user_ids ID пользователей, которые пометили задачу избранной array[string] -
tag_keys Тэги используемые в задаче array[string] -
recurrence_data map -
relations links array[tasks.relation] -
close_date Дата закрытия задачи array[date] -
Параметр Описание Тип Значения
can_edit Возможность редактирования bool -
can_change_status Возможность смены статуса bool -
can_change_deadline Возможность смены сроков bool -
is_finished Статус выполнения bool -
is_favorite Добавлена ли в избарнное bool -
is_subordinate Является ли задачей подчинённого bool -
is_recurrent Является ли периодической bool -
is_daily Является ли ежедневной bool -
checklist_data Данные чеклистов checklist_data -
comment_count Количество комментариев int -
parent_data Данные родительской задачи parent_data -
last_plan_end_date Дата последнего плана date -
id ID int -
name Задача string -
description Описание string -
owner_user_id Постановщик string -
responsible_user_ids Исполнители array[string] -
auditors Id аудиторов array[string] -
watchers Id пользователей, отслеживающих задачу array[string] -
block_id Должность int -
category_key Категория string -
product Продукт string -
time_plan Планируемое время int -
time_fact Фактическое время int -
status_key Статус string -
is_planned Добавлена хотя бы в один план bool -
board_panel_id ID панели в досках int -
order Информация о сортировке в разных панелях map[string]int -
start_date Дата начала date -
finish_date Дата завершения date -
creation_date Дата создания date -
integration_data map -
parent_id Id родительской задачи int -
path Materialized path для получения деревьев materialized_path -
file_ids ID прикреплённых файлов array[string] -
is_important Является ли срочной bool -
favorite_user_ids ID пользователей, которые пометили задачу избранной array[string] -
tag_keys Тэги используемые в задаче array[string] -
recurrence_data map -
relations links array[tasks.relation] -
close_date Дата закрытия задачи date -

Создание

POST /tasks/api/task/create

Метод может быть использован для создания новой задачи. Задача передается в теле запроса. Если передан GET параметр planned_end_date, то добавляет задачу в соответствующий план.

curl 'https://{HOST}.platrum.ru/tasks/api/task/create?planned_end_date=2019-01-01 21:00:15' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}' \ 
    --data '{"id":123,"name":"some_string","description":"some_string","owner_user_id":"some_string","responsible_user_ids":["some_string","some_string"],"auditors":["some_string","some_string"],"watchers":["some_string","some_string"],"block_id":123,"category_key":"some_string","product":"some_string","time_plan":123,"time_fact":123,"status_key":"some_string","board_panel_id":123,"order":"map[string]int","start_date":"2019-01-01 21:00:15","finish_date":"2019-01-01 21:00:15","integration_data":"map","parent_id":123,"path":"materialized_path","file_ids":["some_string","some_string"],"favorite_user_ids":["some_string","some_string"],"tag_keys":["some_string","some_string"],"recurrence_data":"map","relations":[{"id":123,"type":"some_string","target_task_id":123,"creation_date":"2019-01-01 21:00:15","author_id":"some_string"}],"close_date":"2019-01-01 21:00:15"}'

{
    "status": "success",
    "data": {
        "task_plan": [
            {
                "id": 123,
                "block_id": 123,
                "plan_user_id": "some_string",
                "planned_end_date": "2019-01-01 21:00:15",
                "is_finished": true,
                "creation_date": "2019-01-01 21:00:15",
                "approve_date": "2019-01-01 21:00:15",
                "approve_user_id": "some_string",
                "items": [
                    {
                        "id": 123,
                        "task_id": 123,
                        "add_date": "2019-01-01 21:00:15",
                        "is_finished": true,
                        "result": "some_string"
                    }
                ]
            }
        ],
        "added_to_plan_date": "2019-01-01 21:00:15",
        "status": [
            {
                "is_done_in_plan": true
            }
        ],
        "can_edit": true,
        "can_change_status": true,
        "can_change_deadline": true,
        "is_finished": true,
        "is_favorite": true,
        "is_subordinate": true,
        "is_recurrent": true,
        "is_daily": true,
        "checklist_data": [
            {
                "done_count": 123,
                "total_count": 123
            }
        ],
        "comment_count": 123,
        "parent_data": [
            {
                "id": 123,
                "name": "some_string",
                "status_key": "some_string"
            }
        ],
        "last_plan_end_date": "2019-01-01 21:00:15",
        "id": 123,
        "name": "some_string",
        "description": "some_string",
        "owner_user_id": "some_string",
        "responsible_user_ids": [
            "some_string",
            "some_string"
        ],
        "auditors": [
            "some_string",
            "some_string"
        ],
        "watchers": [
            "some_string",
            "some_string"
        ],
        "block_id": 123,
        "category_key": "some_string",
        "product": "some_string",
        "time_plan": 123,
        "time_fact": 123,
        "status_key": "some_string",
        "is_planned": true,
        "board_panel_id": 123,
        "order": "map[string]int",
        "start_date": "2019-01-01 21:00:15",
        "finish_date": "2019-01-01 21:00:15",
        "creation_date": "2019-01-01 21:00:15",
        "integration_data": "map",
        "parent_id": 123,
        "path": "materialized_path",
        "file_ids": [
            "some_string",
            "some_string"
        ],
        "is_important": true,
        "favorite_user_ids": [
            "some_string",
            "some_string"
        ],
        "tag_keys": [
            "some_string",
            "some_string"
        ],
        "recurrence_data": "map",
        "relations": [
            {
                "id": 123,
                "type": "some_string",
                "target_task_id": 123,
                "creation_date": "2019-01-01 21:00:15",
                "author_id": "some_string"
            }
        ],
        "close_date": "2019-01-01 21:00:15"
    }
}
Параметр Описание Тип Значения
planned_end_date Дата для добавления в план date -
id ID int -
name Задача string -
description Описание string -
owner_user_id Постановщик string -
responsible_user_ids Исполнители array[string] -
auditors Id аудиторов array[string] -
watchers Id пользователей, отслеживающих задачу array[string] -
block_id Должность int -
category_key Категория string -
product Продукт string -
time_plan Планируемое время int -
time_fact Фактическое время int -
status_key Статус string -
board_panel_id ID панели в досках int -
order Информация о сортировке в разных панелях map[string]int -
start_date Дата начала date -
finish_date Дата завершения date -
integration_data map -
parent_id Id родительской задачи int -
path Materialized path для получения деревьев materialized_path -
file_ids ID прикреплённых файлов array[string] -
favorite_user_ids ID пользователей, которые пометили задачу избранной array[string] -
tag_keys Тэги используемые в задаче array[string] -
recurrence_data map -
relations links array[tasks.relation] -
close_date Дата закрытия задачи date -
Параметр Описание Тип Значения
task_plan План task_plan -
added_to_plan_date Дата добавления в план date -
status Статус выполнения задачи task_status -
can_edit Возможность редактирования bool -
can_change_status Возможность смены статуса bool -
can_change_deadline Возможность смены сроков bool -
is_finished Статус выполнения bool -
is_favorite Добавлена ли в избарнное bool -
is_subordinate Является ли задачей подчинённого bool -
is_recurrent Является ли периодической bool -
is_daily Является ли ежедневной bool -
checklist_data Данные чеклистов checklist_data -
comment_count Количество комментариев int -
parent_data Данные родительской задачи parent_data -
last_plan_end_date Дата последнего плана date -
id ID int -
name Задача string -
description Описание string -
owner_user_id Постановщик string -
responsible_user_ids Исполнители array[string] -
auditors Id аудиторов array[string] -
watchers Id пользователей, отслеживающих задачу array[string] -
block_id Должность int -
category_key Категория string -
product Продукт string -
time_plan Планируемое время int -
time_fact Фактическое время int -
status_key Статус string -
is_planned Добавлена хотя бы в один план bool -
board_panel_id ID панели в досках int -
order Информация о сортировке в разных панелях map[string]int -
start_date Дата начала date -
finish_date Дата завершения date -
creation_date Дата создания date -
integration_data map -
parent_id Id родительской задачи int -
path Materialized path для получения деревьев materialized_path -
file_ids ID прикреплённых файлов array[string] -
is_important Является ли срочной bool -
favorite_user_ids ID пользователей, которые пометили задачу избранной array[string] -
tag_keys Тэги используемые в задаче array[string] -
recurrence_data map -
relations links array[tasks.relation] -
close_date Дата закрытия задачи date -

Обновление

POST /tasks/api/task/update

Метод может быть использован для обновления существующей задачи.

curl 'https://{HOST}.platrum.ru/tasks/api/task/update' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}' \ 
    --data '{"id":123,"fields":"array"}'

{
    "status": "success",
    "data": {
        "can_edit": true,
        "can_change_status": true,
        "can_change_deadline": true,
        "is_finished": true,
        "is_favorite": true,
        "is_subordinate": true,
        "is_recurrent": true,
        "is_daily": true,
        "checklist_data": [
            {
                "done_count": 123,
                "total_count": 123
            }
        ],
        "comment_count": 123,
        "parent_data": [
            {
                "id": 123,
                "name": "some_string",
                "status_key": "some_string"
            }
        ],
        "last_plan_end_date": "2019-01-01 21:00:15",
        "id": 123,
        "name": "some_string",
        "description": "some_string",
        "owner_user_id": "some_string",
        "responsible_user_ids": [
            "some_string",
            "some_string"
        ],
        "auditors": [
            "some_string",
            "some_string"
        ],
        "watchers": [
            "some_string",
            "some_string"
        ],
        "block_id": 123,
        "category_key": "some_string",
        "product": "some_string",
        "time_plan": 123,
        "time_fact": 123,
        "status_key": "some_string",
        "is_planned": true,
        "board_panel_id": 123,
        "order": "map[string]int",
        "start_date": "2019-01-01 21:00:15",
        "finish_date": "2019-01-01 21:00:15",
        "creation_date": "2019-01-01 21:00:15",
        "integration_data": "map",
        "parent_id": 123,
        "path": "materialized_path",
        "file_ids": [
            "some_string",
            "some_string"
        ],
        "is_important": true,
        "favorite_user_ids": [
            "some_string",
            "some_string"
        ],
        "tag_keys": [
            "some_string",
            "some_string"
        ],
        "recurrence_data": "map",
        "relations": [
            {
                "id": 123,
                "type": "some_string",
                "target_task_id": 123,
                "creation_date": "2019-01-01 21:00:15",
                "author_id": "some_string"
            }
        ],
        "close_date": "2019-01-01 21:00:15"
    }
}
Параметр Описание Тип Значения
id* ID задачи int -
fields Поля для обновления array -
Параметр Описание Тип Значения
can_edit Возможность редактирования bool -
can_change_status Возможность смены статуса bool -
can_change_deadline Возможность смены сроков bool -
is_finished Статус выполнения bool -
is_favorite Добавлена ли в избарнное bool -
is_subordinate Является ли задачей подчинённого bool -
is_recurrent Является ли периодической bool -
is_daily Является ли ежедневной bool -
checklist_data Данные чеклистов checklist_data -
comment_count Количество комментариев int -
parent_data Данные родительской задачи parent_data -
last_plan_end_date Дата последнего плана date -
id ID int -
name Задача string -
description Описание string -
owner_user_id Постановщик string -
responsible_user_ids Исполнители array[string] -
auditors Id аудиторов array[string] -
watchers Id пользователей, отслеживающих задачу array[string] -
block_id Должность int -
category_key Категория string -
product Продукт string -
time_plan Планируемое время int -
time_fact Фактическое время int -
status_key Статус string -
is_planned Добавлена хотя бы в один план bool -
board_panel_id ID панели в досках int -
order Информация о сортировке в разных панелях map[string]int -
start_date Дата начала date -
finish_date Дата завершения date -
creation_date Дата создания date -
integration_data map -
parent_id Id родительской задачи int -
path Materialized path для получения деревьев materialized_path -
file_ids ID прикреплённых файлов array[string] -
is_important Является ли срочной bool -
favorite_user_ids ID пользователей, которые пометили задачу избранной array[string] -
tag_keys Тэги используемые в задаче array[string] -
recurrence_data map -
relations links array[tasks.relation] -
close_date Дата закрытия задачи date -

Множественное обновление

POST /tasks/api/task/update/multi

Метод может быть использован для обновления нескольких задач одновременно.

curl 'https://{HOST}.platrum.ru/tasks/api/task/update/multi' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}' \ 
    --data '{"task_ids":[123,123],"fields":"array"}'

{
    "status": "success",
    "data": [
        {
            "can_edit": true,
            "can_change_status": true,
            "can_change_deadline": true,
            "is_finished": true,
            "is_favorite": true,
            "is_subordinate": true,
            "is_recurrent": true,
            "is_daily": true,
            "checklist_data": [
                {
                    "done_count": 123,
                    "total_count": 123
                }
            ],
            "comment_count": 123,
            "parent_data": [
                {
                    "id": 123,
                    "name": "some_string",
                    "status_key": "some_string"
                }
            ],
            "last_plan_end_date": "2019-01-01 21:00:15",
            "id": 123,
            "name": "some_string",
            "description": "some_string",
            "owner_user_id": "some_string",
            "responsible_user_ids": [
                "some_string",
                "some_string"
            ],
            "auditors": [
                "some_string",
                "some_string"
            ],
            "watchers": [
                "some_string",
                "some_string"
            ],
            "block_id": 123,
            "category_key": "some_string",
            "product": "some_string",
            "time_plan": 123,
            "time_fact": 123,
            "status_key": "some_string",
            "is_planned": true,
            "board_panel_id": 123,
            "order": "map[string]int",
            "start_date": "2019-01-01 21:00:15",
            "finish_date": "2019-01-01 21:00:15",
            "creation_date": "2019-01-01 21:00:15",
            "integration_data": "map",
            "parent_id": 123,
            "path": "materialized_path",
            "file_ids": [
                "some_string",
                "some_string"
            ],
            "is_important": true,
            "favorite_user_ids": [
                "some_string",
                "some_string"
            ],
            "tag_keys": [
                "some_string",
                "some_string"
            ],
            "recurrence_data": "map",
            "relations": [
                {
                    "id": 123,
                    "type": "some_string",
                    "target_task_id": 123,
                    "creation_date": "2019-01-01 21:00:15",
                    "author_id": "some_string"
                }
            ],
            "close_date": "2019-01-01 21:00:15"
        },
        {
            "can_edit": true,
            "can_change_status": true,
            "can_change_deadline": true,
            "is_finished": true,
            "is_favorite": true,
            "is_subordinate": true,
            "is_recurrent": true,
            "is_daily": true,
            "checklist_data": [
                {
                    "done_count": 123,
                    "total_count": 123
                }
            ],
            "comment_count": 123,
            "parent_data": [
                {
                    "id": 123,
                    "name": "some_string",
                    "status_key": "some_string"
                }
            ],
            "last_plan_end_date": "2019-01-01 21:00:15",
            "id": 123,
            "name": "some_string",
            "description": "some_string",
            "owner_user_id": "some_string",
            "responsible_user_ids": [
                "some_string",
                "some_string"
            ],
            "auditors": [
                "some_string",
                "some_string"
            ],
            "watchers": [
                "some_string",
                "some_string"
            ],
            "block_id": 123,
            "category_key": "some_string",
            "product": "some_string",
            "time_plan": 123,
            "time_fact": 123,
            "status_key": "some_string",
            "is_planned": true,
            "board_panel_id": 123,
            "order": "map[string]int",
            "start_date": "2019-01-01 21:00:15",
            "finish_date": "2019-01-01 21:00:15",
            "creation_date": "2019-01-01 21:00:15",
            "integration_data": "map",
            "parent_id": 123,
            "path": "materialized_path",
            "file_ids": [
                "some_string",
                "some_string"
            ],
            "is_important": true,
            "favorite_user_ids": [
                "some_string",
                "some_string"
            ],
            "tag_keys": [
                "some_string",
                "some_string"
            ],
            "recurrence_data": "map",
            "relations": [
                {
                    "id": 123,
                    "type": "some_string",
                    "target_task_id": 123,
                    "creation_date": "2019-01-01 21:00:15",
                    "author_id": "some_string"
                }
            ],
            "close_date": "2019-01-01 21:00:15"
        }
    ]
}
Параметр Описание Тип Значения
task_ids* ID обновляемых задач array[int] -
fields* Поля для обновления array -
Параметр Описание Тип Значения
can_edit Возможность редактирования bool -
can_change_status Возможность смены статуса bool -
can_change_deadline Возможность смены сроков bool -
is_finished Статус выполнения bool -
is_favorite Добавлена ли в избарнное bool -
is_subordinate Является ли задачей подчинённого bool -
is_recurrent Является ли периодической bool -
is_daily Является ли ежедневной bool -
checklist_data Данные чеклистов checklist_data -
comment_count Количество комментариев int -
parent_data Данные родительской задачи parent_data -
last_plan_end_date Дата последнего плана date -
id ID int -
name Задача string -
description Описание string -
owner_user_id Постановщик string -
responsible_user_ids Исполнители array[string] -
auditors Id аудиторов array[string] -
watchers Id пользователей, отслеживающих задачу array[string] -
block_id Должность int -
category_key Категория string -
product Продукт string -
time_plan Планируемое время int -
time_fact Фактическое время int -
status_key Статус string -
is_planned Добавлена хотя бы в один план bool -
board_panel_id ID панели в досках int -
order Информация о сортировке в разных панелях map[string]int -
start_date Дата начала date -
finish_date Дата завершения date -
creation_date Дата создания date -
integration_data map -
parent_id Id родительской задачи int -
path Materialized path для получения деревьев materialized_path -
file_ids ID прикреплённых файлов array[string] -
is_important Является ли срочной bool -
favorite_user_ids ID пользователей, которые пометили задачу избранной array[string] -
tag_keys Тэги используемые в задаче array[string] -
recurrence_data map -
relations links array[tasks.relation] -
close_date Дата закрытия задачи date -

Удаление

POST /tasks/api/task/remove

Метод удаляет задачу с указанным ID. В ответ возвращает статус операции.

curl 'https://{HOST}.platrum.ru/tasks/api/task/remove' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}' \ 
    --data '{"id":123,"is_edit_further":true}'

{
    "status": "success",
    "data": true
}
Параметр Описание Тип Значения
id* ID задачи int -
is_edit_further Удалить связанные периодические задачи bool -

bool

Множественное удаление

GET /tasks/api/task/remove/multi

Метод может быть использован для удаления нескольких задач.

curl 'https://{HOST}.platrum.ru/tasks/api/task/remove/multi' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}' \ 
    --data '{"ids":[123,123]}'

{
    "status": "success",
    "data": true
}
Параметр Описание Тип Значения
ids* Id удаляемых задач array[int] -

bool

Доски

Список досок

GET /tasks/api/board/list

Метод может быть использован для получения списка досок.

curl 'https://{HOST}.platrum.ru/tasks/api/board/list' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}' \ 
    --data '{"ids":[123,123]}'

{
    "status": "success",
    "data": [
        {
            "can_edit": true,
            "can_create_tasks": true,
            "is_admin": true,
            "is_favourite": true,
            "is_hidden": true,
            "panels": [
                {
                    "id": 123,
                    "board_id": 123,
                    "name": "some_string",
                    "color": "some_string",
                    "task_fields": [
                        "some_string",
                        "some_string"
                    ],
                    "is_visible": true,
                    "order": 123,
                    "settings": "map",
                    "creation_date": "2019-01-01 21:00:15",
                    "is_archived": true
                }
            ],
            "id": 123,
            "owner_user_id": "some_string",
            "name": "some_string",
            "access_blocks": [
                {
                    "id": 123,
                    "user_id": "some_string",
                    "access_item": "map",
                    "type": "some_string"
                }
            ],
            "access_users": [
                {
                    "id": 123,
                    "user_id": "some_string",
                    "access_item": "map",
                    "type": "some_string"
                }
            ],
            "favourite_states_user_ids": "array",
            "hidden_states_user_ids": "array",
            "color_background": "some_string",
            "color_text": "some_string",
            "hidden_panels_are_visible": true,
            "creation_date": "2019-01-01 21:00:15",
            "task_field_keys": [
                "some_string",
                "some_string"
            ]
        },
        {
            "can_edit": true,
            "can_create_tasks": true,
            "is_admin": true,
            "is_favourite": true,
            "is_hidden": true,
            "panels": [
                {
                    "id": 123,
                    "board_id": 123,
                    "name": "some_string",
                    "color": "some_string",
                    "task_fields": [
                        "some_string",
                        "some_string"
                    ],
                    "is_visible": true,
                    "order": 123,
                    "settings": "map",
                    "creation_date": "2019-01-01 21:00:15",
                    "is_archived": true
                }
            ],
            "id": 123,
            "owner_user_id": "some_string",
            "name": "some_string",
            "access_blocks": [
                {
                    "id": 123,
                    "user_id": "some_string",
                    "access_item": "map",
                    "type": "some_string"
                }
            ],
            "access_users": [
                {
                    "id": 123,
                    "user_id": "some_string",
                    "access_item": "map",
                    "type": "some_string"
                }
            ],
            "favourite_states_user_ids": "array",
            "hidden_states_user_ids": "array",
            "color_background": "some_string",
            "color_text": "some_string",
            "hidden_panels_are_visible": true,
            "creation_date": "2019-01-01 21:00:15",
            "task_field_keys": [
                "some_string",
                "some_string"
            ]
        }
    ]
}
Параметр Описание Тип Значения
ids* Id удаляемых задач array[int] -
Параметр Описание Тип Значения
can_edit Возможность редактирования bool -
can_create_tasks Возможность создавать задачи bool -
is_admin Является ли текущий пользователь администратором доски bool -
is_favourite Добавлена ли доска в избранное bool -
is_hidden Скрыта ли доска bool -
panels Панели доски array[board_panel] -
id ID int -
owner_user_id Владелец string -
name Название string -
access_blocks Должности с доступом array[tasks.access] -
access_users Юзеры с доступом array[tasks.access] -
favourite_states_user_ids array -
hidden_states_user_ids array -
color_background Цвет фона string -
color_text Цвет текста string -
hidden_panels_are_visible Показать скрытые панели bool -
creation_date Дата создания date -
task_field_keys Поля задач array[string] -

Список задач доски

GET /tasks/api/board/task/list

Метод может быть использован для получения списка задач доски.

curl 'https://{HOST}.platrum.ru/tasks/api/board/task/list' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}'

{
    "status": "success",
    "data": [
        {
            "can_edit": true,
            "can_change_status": true,
            "can_change_deadline": true,
            "is_finished": true,
            "is_favorite": true,
            "is_subordinate": true,
            "is_recurrent": true,
            "is_daily": true,
            "checklist_data": [
                {
                    "done_count": 123,
                    "total_count": 123
                }
            ],
            "comment_count": 123,
            "parent_data": [
                {
                    "id": 123,
                    "name": "some_string",
                    "status_key": "some_string"
                }
            ],
            "last_plan_end_date": "2019-01-01 21:00:15",
            "id": 123,
            "name": "some_string",
            "description": "some_string",
            "owner_user_id": "some_string",
            "responsible_user_ids": [
                "some_string",
                "some_string"
            ],
            "auditors": [
                "some_string",
                "some_string"
            ],
            "watchers": [
                "some_string",
                "some_string"
            ],
            "block_id": 123,
            "category_key": "some_string",
            "product": "some_string",
            "time_plan": 123,
            "time_fact": 123,
            "status_key": "some_string",
            "is_planned": true,
            "board_panel_id": 123,
            "order": "map[string]int",
            "start_date": "2019-01-01 21:00:15",
            "finish_date": "2019-01-01 21:00:15",
            "creation_date": "2019-01-01 21:00:15",
            "integration_data": "map",
            "parent_id": 123,
            "path": "materialized_path",
            "file_ids": [
                "some_string",
                "some_string"
            ],
            "is_important": true,
            "favorite_user_ids": [
                "some_string",
                "some_string"
            ],
            "tag_keys": [
                "some_string",
                "some_string"
            ],
            "recurrence_data": "map",
            "relations": [
                {
                    "id": 123,
                    "type": "some_string",
                    "target_task_id": 123,
                    "creation_date": "2019-01-01 21:00:15",
                    "author_id": "some_string"
                }
            ],
            "close_date": "2019-01-01 21:00:15"
        },
        {
            "can_edit": true,
            "can_change_status": true,
            "can_change_deadline": true,
            "is_finished": true,
            "is_favorite": true,
            "is_subordinate": true,
            "is_recurrent": true,
            "is_daily": true,
            "checklist_data": [
                {
                    "done_count": 123,
                    "total_count": 123
                }
            ],
            "comment_count": 123,
            "parent_data": [
                {
                    "id": 123,
                    "name": "some_string",
                    "status_key": "some_string"
                }
            ],
            "last_plan_end_date": "2019-01-01 21:00:15",
            "id": 123,
            "name": "some_string",
            "description": "some_string",
            "owner_user_id": "some_string",
            "responsible_user_ids": [
                "some_string",
                "some_string"
            ],
            "auditors": [
                "some_string",
                "some_string"
            ],
            "watchers": [
                "some_string",
                "some_string"
            ],
            "block_id": 123,
            "category_key": "some_string",
            "product": "some_string",
            "time_plan": 123,
            "time_fact": 123,
            "status_key": "some_string",
            "is_planned": true,
            "board_panel_id": 123,
            "order": "map[string]int",
            "start_date": "2019-01-01 21:00:15",
            "finish_date": "2019-01-01 21:00:15",
            "creation_date": "2019-01-01 21:00:15",
            "integration_data": "map",
            "parent_id": 123,
            "path": "materialized_path",
            "file_ids": [
                "some_string",
                "some_string"
            ],
            "is_important": true,
            "favorite_user_ids": [
                "some_string",
                "some_string"
            ],
            "tag_keys": [
                "some_string",
                "some_string"
            ],
            "recurrence_data": "map",
            "relations": [
                {
                    "id": 123,
                    "type": "some_string",
                    "target_task_id": 123,
                    "creation_date": "2019-01-01 21:00:15",
                    "author_id": "some_string"
                }
            ],
            "close_date": "2019-01-01 21:00:15"
        }
    ]
}

Без параметров.

Параметр Описание Тип Значения
can_edit Возможность редактирования bool -
can_change_status Возможность смены статуса bool -
can_change_deadline Возможность смены сроков bool -
is_finished Статус выполнения bool -
is_favorite Добавлена ли в избарнное bool -
is_subordinate Является ли задачей подчинённого bool -
is_recurrent Является ли периодической bool -
is_daily Является ли ежедневной bool -
checklist_data Данные чеклистов checklist_data -
comment_count Количество комментариев int -
parent_data Данные родительской задачи parent_data -
last_plan_end_date Дата последнего плана date -
id ID int -
name Задача string -
description Описание string -
owner_user_id Постановщик string -
responsible_user_ids Исполнители array[string] -
auditors Id аудиторов array[string] -
watchers Id пользователей, отслеживающих задачу array[string] -
block_id Должность int -
category_key Категория string -
product Продукт string -
time_plan Планируемое время int -
time_fact Фактическое время int -
status_key Статус string -
is_planned Добавлена хотя бы в один план bool -
board_panel_id ID панели в досках int -
order Информация о сортировке в разных панелях map[string]int -
start_date Дата начала date -
finish_date Дата завершения date -
creation_date Дата создания date -
integration_data map -
parent_id Id родительской задачи int -
path Materialized path для получения деревьев materialized_path -
file_ids ID прикреплённых файлов array[string] -
is_important Является ли срочной bool -
favorite_user_ids ID пользователей, которые пометили задачу избранной array[string] -
tag_keys Тэги используемые в задаче array[string] -
recurrence_data map -
relations links array[tasks.relation] -
close_date Дата закрытия задачи date -

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

GET /api/board/panel/list

Метод может быть использован для получения списка панелей доступных досок. Чтобы получить список панелей конкретной доски, необходимо передать её Id.

curl 'https://{HOST}.platrum.ru/api/board/panel/list' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}'

{
    "status": "success",
    "data": [
        {
            "id": 123,
            "board_id": 123,
            "name": "some_string",
            "color": "some_string",
            "task_fields": [
                "some_string",
                "some_string"
            ],
            "is_visible": true,
            "order": 123,
            "settings": "map",
            "creation_date": "2019-01-01 21:00:15",
            "is_archived": true
        },
        {
            "id": 123,
            "board_id": 123,
            "name": "some_string",
            "color": "some_string",
            "task_fields": [
                "some_string",
                "some_string"
            ],
            "is_visible": true,
            "order": 123,
            "settings": "map",
            "creation_date": "2019-01-01 21:00:15",
            "is_archived": true
        }
    ]
}

Без параметров.

Параметр Описание Тип Значения
id ID int -
board_id ID доски int -
name Название string -
color Цвет string -
task_fields Поля задачи array[string] -
is_visible Видимость bool -
order Сортировка int -
settings Настройки map -
creation_date Дата создания date -
is_archived Статус архивации bool -

Создание и обновление панели доски

POST /api/board/panel/store

Метод может быть использован как для создания новой панели, так и для обновления существующей. Если передан пустой id, то создается новая панель.

curl 'https://{HOST}.platrum.ru/api/board/panel/store' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}' \ 
    --data '{"id":123,"board_id":123,"name":"some_string","color":"some_string","task_fields":["some_string","some_string"],"order":123,"settings":"map","is_archived":true}'

{
    "status": "success",
    "data": {
        "id": 123,
        "board_id": 123,
        "name": "some_string",
        "color": "some_string",
        "task_fields": [
            "some_string",
            "some_string"
        ],
        "is_visible": true,
        "order": 123,
        "settings": "map",
        "creation_date": "2019-01-01 21:00:15",
        "is_archived": true
    }
}
Параметр Описание Тип Значения
id ID int -
board_id ID доски int -
name Название string -
color Цвет string -
task_fields Поля задачи array[string] -
order Сортировка int -
settings Настройки map -
is_archived Статус архивации bool -
Параметр Описание Тип Значения
id ID int -
board_id ID доски int -
name Название string -
color Цвет string -
task_fields Поля задачи array[string] -
is_visible Видимость bool -
order Сортировка int -
settings Настройки map -
creation_date Дата создания date -
is_archived Статус архивации bool -

Удаление панели доски

POST /api/board/panel/delete

Метод может быть использован для удаления панели.

curl 'https://{HOST}.platrum.ru/api/board/panel/delete' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}' \ 
    --data '{"panel_id":123}'

{
    "status": "success",
    "data": true
}
Параметр Описание Тип Значения
panel_id* Id удаляемой панели int -

bool

Создание и обновление

POST /tasks/api/board/store

Метод может быть использован как для создания новой доски, так и для обновления существующей. Если передан пустой id, то создается новая доска.

curl 'https://{HOST}.platrum.ru/tasks/api/board/store' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}' \ 
    --data '{"id":123,"owner_user_id":"some_string","name":"some_string","access_blocks":[{"id":123,"user_id":"some_string","access_item":"map","type":"some_string"}],"access_users":[{"id":123,"user_id":"some_string","access_item":"map","type":"some_string"}],"favourite_states_user_ids":"array","hidden_states_user_ids":"array","color_background":"some_string","color_text":"some_string","hidden_panels_are_visible":true,"task_field_keys":["some_string","some_string"]}'

{
    "status": "success",
    "data": {
        "can_edit": true,
        "can_create_tasks": true,
        "is_admin": true,
        "is_favourite": true,
        "is_hidden": true,
        "panels": [
            {
                "id": 123,
                "board_id": 123,
                "name": "some_string",
                "color": "some_string",
                "task_fields": [
                    "some_string",
                    "some_string"
                ],
                "is_visible": true,
                "order": 123,
                "settings": "map",
                "creation_date": "2019-01-01 21:00:15",
                "is_archived": true
            }
        ],
        "id": 123,
        "owner_user_id": "some_string",
        "name": "some_string",
        "access_blocks": [
            {
                "id": 123,
                "user_id": "some_string",
                "access_item": "map",
                "type": "some_string"
            }
        ],
        "access_users": [
            {
                "id": 123,
                "user_id": "some_string",
                "access_item": "map",
                "type": "some_string"
            }
        ],
        "favourite_states_user_ids": "array",
        "hidden_states_user_ids": "array",
        "color_background": "some_string",
        "color_text": "some_string",
        "hidden_panels_are_visible": true,
        "creation_date": "2019-01-01 21:00:15",
        "task_field_keys": [
            "some_string",
            "some_string"
        ]
    }
}
Параметр Описание Тип Значения
id ID int -
owner_user_id Владелец string -
name Название string -
access_blocks Должности с доступом array[tasks.access] -
access_users Юзеры с доступом array[tasks.access] -
favourite_states_user_ids array -
hidden_states_user_ids array -
color_background Цвет фона string -
color_text Цвет текста string -
hidden_panels_are_visible Показать скрытые панели bool -
task_field_keys Поля задач array[string] -
Параметр Описание Тип Значения
can_edit Возможность редактирования bool -
can_create_tasks Возможность создавать задачи bool -
is_admin Является ли текущий пользователь администратором доски bool -
is_favourite Добавлена ли доска в избранное bool -
is_hidden Скрыта ли доска bool -
panels Панели доски array[board_panel] -
id ID int -
owner_user_id Владелец string -
name Название string -
access_blocks Должности с доступом array[tasks.access] -
access_users Юзеры с доступом array[tasks.access] -
favourite_states_user_ids array -
hidden_states_user_ids array -
color_background Цвет фона string -
color_text Цвет текста string -
hidden_panels_are_visible Показать скрытые панели bool -
creation_date Дата создания date -
task_field_keys Поля задач array[string] -

Удаление.

POST /tasks/api/board/delete

Метод может быть использован для удаления доски.

curl 'https://{HOST}.platrum.ru/tasks/api/board/delete' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}' \ 
    --data '{"board":123}'

{
    "status": "success",
    "data": true
}
Параметр Описание Тип Значения
board* Id удаляемой доски int -

bool

Комментарии

Создание и обновление

GET /tasks/api/tasks/comment/save

Метод может быть использован как для создания нового комментария, так и для обновления существующего. Если передан пустой id, то создается новый комментарий.

curl 'https://{HOST}.platrum.ru/tasks/api/tasks/comment/save' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}' \ 
    --data '{"task_id":123,"id":123,"text":"some_string","file_ids":["some_string","some_string"],"reply_user_id":"some_string","mentioned_user_ids":["some_string","some_string"]}'

{
    "status": "success",
    "data": {
        "comment": [
            {
                "id": 123,
                "task_id": 123,
                "author_id": "some_string",
                "mentioned_user_id": "some_string",
                "reply_user_id": "some_string",
                "mentioned_user_ids": [
                    "some_string",
                    "some_string"
                ],
                "text": "some_string",
                "file_ids": [
                    "some_string",
                    "some_string"
                ],
                "creation_date": "2019-01-01 21:00:15",
                "modification_date": "2019-01-01 21:00:15",
                "logged_working_time": 123
            }
        ],
        "task": [
            {
                "id": 123,
                "name": "some_string",
                "description": "some_string",
                "owner_user_id": "some_string",
                "responsible_user_ids": [
                    "some_string",
                    "some_string"
                ],
                "auditors": [
                    "some_string",
                    "some_string"
                ],
                "watchers": [
                    "some_string",
                    "some_string"
                ],
                "block_id": 123,
                "category_key": "some_string",
                "product": "some_string",
                "time_plan": 123,
                "time_fact": 123,
                "status_key": "some_string",
                "is_planned": true,
                "board_panel_id": 123,
                "order": "map[string]int",
                "start_date": "2019-01-01 21:00:15",
                "finish_date": "2019-01-01 21:00:15",
                "creation_date": "2019-01-01 21:00:15",
                "integration_data": "map",
                "parent_id": 123,
                "path": "materialized_path",
                "file_ids": [
                    "some_string",
                    "some_string"
                ],
                "is_important": true,
                "favorite_user_ids": [
                    "some_string",
                    "some_string"
                ],
                "tag_keys": [
                    "some_string",
                    "some_string"
                ],
                "recurrence_data": "map",
                "relations": [
                    {
                        "id": 123,
                        "type": "some_string",
                        "target_task_id": 123,
                        "creation_date": "2019-01-01 21:00:15",
                        "author_id": "some_string"
                    }
                ],
                "close_date": "2019-01-01 21:00:15"
            }
        ]
    }
}
Параметр Описание Тип Значения
task_id* Id задачи к которой прикреплён комментарий int -
id ID комментария int -
text* Текст комментария string -
file_ids Id прикреплённых файлов array[string] -
reply_user_id Id получателя ответного комментария string -
mentioned_user_ids Id указанных пользователей array[string] -
Параметр Описание Тип Значения
comment Созданный или обновлённый комментарий comment -
task Задача к которой прикреплён комментарий task -

Удаление

GET /tasks/api/tasks/comment/delete

Метод может быть использован для удаления комментария.

curl 'https://{HOST}.platrum.ru/tasks/api/tasks/comment/delete' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}' \ 
    --data '{"comment_id":123}'

{
    "status": "success",
    "data": true
}
Параметр Описание Тип Значения
comment_id* Id удаляемого комментария int -

bool

Чеклисты

Получение

GET /tasks/api/tasks/checklist/get

Метод может быть использован для получения чеклистов конкретной задачи.

curl 'https://{HOST}.platrum.ru/tasks/api/tasks/checklist/get' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}' \ 
    --data '{"task_id":123}'

{
    "status": "success",
    "data": {
        "linked_task": [
            {
                "id": 123,
                "name": "some_string",
                "description": "some_string",
                "owner_user_id": "some_string",
                "responsible_user_ids": [
                    "some_string",
                    "some_string"
                ],
                "auditors": [
                    "some_string",
                    "some_string"
                ],
                "watchers": [
                    "some_string",
                    "some_string"
                ],
                "block_id": 123,
                "category_key": "some_string",
                "product": "some_string",
                "time_plan": 123,
                "time_fact": 123,
                "status_key": "some_string",
                "is_planned": true,
                "board_panel_id": 123,
                "order": "map[string]int",
                "start_date": "2019-01-01 21:00:15",
                "finish_date": "2019-01-01 21:00:15",
                "creation_date": "2019-01-01 21:00:15",
                "integration_data": "map",
                "parent_id": 123,
                "path": "materialized_path",
                "file_ids": [
                    "some_string",
                    "some_string"
                ],
                "is_important": true,
                "favorite_user_ids": [
                    "some_string",
                    "some_string"
                ],
                "tag_keys": [
                    "some_string",
                    "some_string"
                ],
                "recurrence_data": "map",
                "relations": [
                    {
                        "id": 123,
                        "type": "some_string",
                        "target_task_id": 123,
                        "creation_date": "2019-01-01 21:00:15",
                        "author_id": "some_string"
                    }
                ],
                "close_date": "2019-01-01 21:00:15"
            }
        ],
        "children": [
            {
                "id": 123,
                "task_id": 123,
                "linked_task_id": 123,
                "creation_date": "2019-01-01 21:00:15",
                "modification_date": "2019-01-01 21:00:15",
                "closing_date": "2019-01-01 21:00:15",
                "author_id": "some_string",
                "text": "some_string",
                "parent_id": 123,
                "order": 123
            }
        ],
        "id": 123,
        "task_id": 123,
        "linked_task_id": 123,
        "creation_date": "2019-01-01 21:00:15",
        "modification_date": "2019-01-01 21:00:15",
        "closing_date": "2019-01-01 21:00:15",
        "author_id": "some_string",
        "text": "some_string",
        "parent_id": 123,
        "order": 123
    }
}
Параметр Описание Тип Значения
task_id* Id задачи int -
Параметр Описание Тип Значения
linked_task Связанная задача task -
children Вложенные чеклисты array[checklist_item] -
id ID int -
task_id Id задачи, к которой привязан элемент чеклиста int -
linked_task_id Id связанной задачи int -
creation_date Дата создания date -
modification_date Дата обновления date -
closing_date Дата закрытия date -
author_id Id автора string -
text Текст элемента чеклиста string -
parent_id Id родительского элемента чеклиста int -
order Порядок чеклиста int -

Создание и обновление

GET /tasks/api/tasks/checklist/save

Метод может быть использован как для создания нового пункта чеклиста, так и для обновления существующего. Если передан пустой id, то создается новый пункт чеклист.

curl 'https://{HOST}.platrum.ru/tasks/api/tasks/checklist/save' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}' \ 
    --data '{"id":123,"task_id":123,"linked_task_id":123,"creation_date":"2019-01-01 21:00:15","modification_date":"2019-01-01 21:00:15","closing_date":"2019-01-01 21:00:15","author_id":"some_string","text":"some_string","parent_id":123,"order":123}'

{
    "status": "success",
    "data": {
        "linked_task": [
            {
                "id": 123,
                "name": "some_string",
                "description": "some_string",
                "owner_user_id": "some_string",
                "responsible_user_ids": [
                    "some_string",
                    "some_string"
                ],
                "auditors": [
                    "some_string",
                    "some_string"
                ],
                "watchers": [
                    "some_string",
                    "some_string"
                ],
                "block_id": 123,
                "category_key": "some_string",
                "product": "some_string",
                "time_plan": 123,
                "time_fact": 123,
                "status_key": "some_string",
                "is_planned": true,
                "board_panel_id": 123,
                "order": "map[string]int",
                "start_date": "2019-01-01 21:00:15",
                "finish_date": "2019-01-01 21:00:15",
                "creation_date": "2019-01-01 21:00:15",
                "integration_data": "map",
                "parent_id": 123,
                "path": "materialized_path",
                "file_ids": [
                    "some_string",
                    "some_string"
                ],
                "is_important": true,
                "favorite_user_ids": [
                    "some_string",
                    "some_string"
                ],
                "tag_keys": [
                    "some_string",
                    "some_string"
                ],
                "recurrence_data": "map",
                "relations": [
                    {
                        "id": 123,
                        "type": "some_string",
                        "target_task_id": 123,
                        "creation_date": "2019-01-01 21:00:15",
                        "author_id": "some_string"
                    }
                ],
                "close_date": "2019-01-01 21:00:15"
            }
        ],
        "children": [
            {
                "id": 123,
                "task_id": 123,
                "linked_task_id": 123,
                "creation_date": "2019-01-01 21:00:15",
                "modification_date": "2019-01-01 21:00:15",
                "closing_date": "2019-01-01 21:00:15",
                "author_id": "some_string",
                "text": "some_string",
                "parent_id": 123,
                "order": 123
            }
        ],
        "id": 123,
        "task_id": 123,
        "linked_task_id": 123,
        "creation_date": "2019-01-01 21:00:15",
        "modification_date": "2019-01-01 21:00:15",
        "closing_date": "2019-01-01 21:00:15",
        "author_id": "some_string",
        "text": "some_string",
        "parent_id": 123,
        "order": 123
    }
}
Параметр Описание Тип Значения
id ID int -
task_id Id задачи, к которой привязан элемент чеклиста int -
linked_task_id Id связанной задачи int -
creation_date Дата создания date -
modification_date Дата обновления date -
closing_date Дата закрытия date -
author_id Id автора string -
text Текст элемента чеклиста string -
parent_id Id родительского элемента чеклиста int -
order Порядок чеклиста int -
Параметр Описание Тип Значения
linked_task Связанная задача task -
children Вложенные чеклисты array[checklist_item] -
id ID int -
task_id Id задачи, к которой привязан элемент чеклиста int -
linked_task_id Id связанной задачи int -
creation_date Дата создания date -
modification_date Дата обновления date -
closing_date Дата закрытия date -
author_id Id автора string -
text Текст элемента чеклиста string -
parent_id Id родительского элемента чеклиста int -
order Порядок чеклиста int -

Удаление

GET /tasks/api/tasks/checklist/delete

Метод может быть использован для удаления пункта чеклиста.

curl 'https://{HOST}.platrum.ru/tasks/api/tasks/checklist/delete' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}' \ 
    --data '{"item_id":123}'

{
    "status": "success",
    "data": true
}
Параметр Описание Тип Значения
item_id* Id пункта чеклиста int -

bool

Пользовательские поля

Получение списка

GET /tasks/api/task/field/list

Метод может быть использован для получения списка пользовательских полей задачи.

curl 'https://{HOST}.platrum.ru/tasks/api/task/field/list' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}'

{
    "status": "success",
    "data": [
        {
            "id": 123,
            "board_id": 123,
            "is_required": true,
            "is_hidden": true,
            "data_type": "some_string",
            "type": "some_string",
            "default": "some_string",
            "is_inherit_from_parent": true,
            "variants": [
                "some_string",
                "some_string"
            ],
            "key": "some_string",
            "name": "some_string",
            "order": 123,
            "is_archived": true,
            "is_system": true,
            "is_default": true,
            "author_id": "some_string",
            "last_editor_id": "some_string",
            "creation_date": "2019-01-01 21:00:15",
            "update_date": "2019-01-01 21:00:15"
        },
        {
            "id": 123,
            "board_id": 123,
            "is_required": true,
            "is_hidden": true,
            "data_type": "some_string",
            "type": "some_string",
            "default": "some_string",
            "is_inherit_from_parent": true,
            "variants": [
                "some_string",
                "some_string"
            ],
            "key": "some_string",
            "name": "some_string",
            "order": 123,
            "is_archived": true,
            "is_system": true,
            "is_default": true,
            "author_id": "some_string",
            "last_editor_id": "some_string",
            "creation_date": "2019-01-01 21:00:15",
            "update_date": "2019-01-01 21:00:15"
        }
    ]
}

Без параметров.

Параметр Описание Тип Значения
id int -
board_id int -
is_required bool -
is_hidden bool -
data_type string int/string
type string -
default string -
is_inherit_from_parent bool -
variants array[string] -
key Ключ string -
name Название string -
order Порядок сортировки int -
is_archived Статус архивации bool -
is_system Является ли элемент системным bool -
is_default Является ли элементом по-умолчанию bool -
author_id ID автора string -
last_editor_id ID последнего редактора string -
creation_date Дата создания date -
update_date Дата редактирования date -

Создание и обновление

GET /tasks/api/task/field/store

Метод может быть использован как для создания нового поля, так и для обновления существующего. Если передан пустой id, то создается новое поле.

curl 'https://{HOST}.platrum.ru/tasks/api/task/field/store' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}' \ 
    --data '{"board_id":123,"id":123,"is_required":true,"is_hidden":true,"data_type":"some_string","type":"some_string","default":"some_string","is_inherit_from_parent":true,"variants":["some_string","some_string"],"key":"some_string","name":"some_string","order":123,"is_archived":true,"is_system":true,"is_default":true,"author_id":"some_string","last_editor_id":"some_string","creation_date":"2019-01-01 21:00:15","update_date":"2019-01-01 21:00:15"}'

{
    "status": "success",
    "data": {
        "id": 123,
        "board_id": 123,
        "is_required": true,
        "is_hidden": true,
        "data_type": "some_string",
        "type": "some_string",
        "default": "some_string",
        "is_inherit_from_parent": true,
        "variants": [
            "some_string",
            "some_string"
        ],
        "key": "some_string",
        "name": "some_string",
        "order": 123,
        "is_archived": true,
        "is_system": true,
        "is_default": true,
        "author_id": "some_string",
        "last_editor_id": "some_string",
        "creation_date": "2019-01-01 21:00:15",
        "update_date": "2019-01-01 21:00:15"
    }
}
Параметр Описание Тип Значения
board_id int -
id int -
is_required bool -
is_hidden bool -
data_type string int/string
type string -
default string -
is_inherit_from_parent bool -
variants array[string] -
key Ключ string -
name Название string -
order Порядок сортировки int -
is_archived Статус архивации bool -
is_system Является ли элемент системным bool -
is_default Является ли элементом по-умолчанию bool -
author_id ID автора string -
last_editor_id ID последнего редактора string -
creation_date Дата создания date -
update_date Дата редактирования date -
Параметр Описание Тип Значения
id int -
board_id int -
is_required bool -
is_hidden bool -
data_type string int/string
type string -
default string -
is_inherit_from_parent bool -
variants array[string] -
key Ключ string -
name Название string -
order Порядок сортировки int -
is_archived Статус архивации bool -
is_system Является ли элемент системным bool -
is_default Является ли элементом по-умолчанию bool -
author_id ID автора string -
last_editor_id ID последнего редактора string -
creation_date Дата создания date -
update_date Дата редактирования date -

Удаление

GET /tasks/api/task/field/delete

Метод может быть использован для удаления пользовательского поля.

curl 'https://{HOST}.platrum.ru/tasks/api/task/field/delete' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}' \ 
    --data '{"board_id":123,"key":"some_string"}'

{
    "status": "success",
    "data": true
}
Параметр Описание Тип Значения
board_id* Id доски int -
key* Ключ поля string -

bool