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

Задачи

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": {
        "id": 123,
        "name": "some_string",
        "description": "some_string",
        "owner_user_id": "some_string",
        "responsible_user_id": "some_string",
        "responsible_user_ids": [
            "some_string",
            "some_string"
        ],
        "auditors": [
            "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,
        "file_ids": [
            "some_string",
            "some_string"
        ],
        "is_important": true,
        "favorite_user_ids": [
            "some_string",
            "some_string"
        ]
    }
}
Параметр Описание Тип Значения
id* ID задачи int -
Параметр Описание Тип Значения
id ID int -
name Задача string -
description Описание string -
owner_user_id Постановщик string -
responsible_user_id Исполнитель string -
responsible_user_ids Исполнители array[string] -
auditors 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 -
file_ids ID прикреплённых файлов array[string] -
is_important Является ли важной bool -
favorite_user_ids ID пользователей, которые пометили задачу избранной array[string] -

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

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 '{"id":[123,123],"search":"some_string","planned_end_date":["2019-01-01 21:00:15","2019-01-01 21:00:15"],"name":["some_string","some_string"],"description":["some_string","some_string"],"owner_user_id":["some_string","some_string"],"responsible_user_id":["some_string","some_string"],"responsible_user_ids":["some_string","some_string"],"auditors":["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],"file_ids":["some_string","some_string"],"is_important":true,"favorite_user_ids":["some_string","some_string"]}'

{
    "status": "success",
    "data": [
        {
            "id": 123,
            "name": "some_string",
            "description": "some_string",
            "owner_user_id": "some_string",
            "responsible_user_id": "some_string",
            "responsible_user_ids": [
                "some_string",
                "some_string"
            ],
            "auditors": [
                "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,
            "file_ids": [
                "some_string",
                "some_string"
            ],
            "is_important": true,
            "favorite_user_ids": [
                "some_string",
                "some_string"
            ]
        },
        {
            "id": 123,
            "name": "some_string",
            "description": "some_string",
            "owner_user_id": "some_string",
            "responsible_user_id": "some_string",
            "responsible_user_ids": [
                "some_string",
                "some_string"
            ],
            "auditors": [
                "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,
            "file_ids": [
                "some_string",
                "some_string"
            ],
            "is_important": true,
            "favorite_user_ids": [
                "some_string",
                "some_string"
            ]
        }
    ]
}
Параметр Описание Тип Значения
id ID array[int] -
search Искомое значение. Ищет по задаче и продукту string -
planned_end_date Дата плана array[date] -
name Задача array[string] -
description Описание array[string] -
owner_user_id Постановщик array[string] -
responsible_user_id Исполнитель array[string] -
responsible_user_ids Исполнители array[string] -
auditors 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] -
file_ids ID прикреплённых файлов array[string] -
is_important Является ли важной bool -
favorite_user_ids ID пользователей, которые пометили задачу избранной array[string] -
Параметр Описание Тип Значения
id ID int -
name Задача string -
description Описание string -
owner_user_id Постановщик string -
responsible_user_id Исполнитель string -
responsible_user_ids Исполнители array[string] -
auditors 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 -
file_ids ID прикреплённых файлов array[string] -
is_important Является ли важной bool -
favorite_user_ids ID пользователей, которые пометили задачу избранной array[string] -

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

POST /tasks/api/task/store

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

curl 'https://{HOST}.platrum.ru/tasks/api/task/store?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_id":"some_string","responsible_user_ids":["some_string","some_string"],"auditors":["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,"file_ids":["some_string","some_string"],"favorite_user_ids":["some_string","some_string"]}'

{
    "status": "success",
    "data": {
        "id": 123,
        "name": "some_string",
        "description": "some_string",
        "owner_user_id": "some_string",
        "responsible_user_id": "some_string",
        "responsible_user_ids": [
            "some_string",
            "some_string"
        ],
        "auditors": [
            "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,
        "file_ids": [
            "some_string",
            "some_string"
        ],
        "is_important": true,
        "favorite_user_ids": [
            "some_string",
            "some_string"
        ]
    }
}
Параметр Описание Тип Значения
planned_end_date Дата для добавления в план date -
id ID int -
name Задача string -
description Описание string -
owner_user_id Постановщик string -
responsible_user_id Исполнитель string -
responsible_user_ids Исполнители array[string] -
auditors 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 -
file_ids ID прикреплённых файлов array[string] -
favorite_user_ids ID пользователей, которые пометили задачу избранной array[string] -
Параметр Описание Тип Значения
id ID int -
name Задача string -
description Описание string -
owner_user_id Постановщик string -
responsible_user_id Исполнитель string -
responsible_user_ids Исполнители array[string] -
auditors 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 -
file_ids ID прикреплённых файлов array[string] -
is_important Является ли важной bool -
favorite_user_ids ID пользователей, которые пометили задачу избранной array[string] -

Удаление

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}'

{
    "status": "success",
    "data": true
}
Параметр Описание Тип Значения
id* ID задачи int -

bool