Задачи¶
CRUD-операции¶
Список задач¶
URI: /BumsTaskApiV01/Task/list.api|xml
Входные параметры¶
Имя поля  | 
Тип  | 
Описание  | 
Примечание  | 
|---|---|---|---|
Folder  | 
string  | 
Папка  | 
Допустимые значения: 
 По умолчанию: all  | 
TimeUpdated  | 
string  | 
Возвращать только те объекты, которые были изменены после указанный даты  | 
Дата/время в одном из форматов ISO 8601  | 
Status  | 
string  | 
Статус  | 
Допустимые значения: 
 По умолчанию: any  | 
FavoritesOnly  | 
integer  | 
Только избранное  | 
Допустимые значения: 0, 1. По умолчанию: 0  | 
Search  | 
string  | 
Строка поиска показывать в списке задач все поля из карточки задачи  | 
Допустимые значения: true, false По умолчанию: false  | 
OnlyActual  | 
bool  | 
Если true, то будут выводиться только незавершенные задачи  | 
Допустимые значения: true, false По умолчанию: false  | 
FilterId  | 
string  | 
Код фильтра  | 
Допустимые значения: любая строка (может быть как числом, так и строковым идентификатором)  | 
Count  | 
bool  | 
Если передан этот параметр со значением true, то вместо списка будет выводиться только количество задач, удовлетворяющих условиям  | 
Допустимые значения: true, false По умолчанию: false  | 
EmployeeId  | 
integer  | 
Код сотрудника, для которого нужно загрузить задачи  | 
|
ProjectId  | 
integer  | 
Возвращает только задачи, входящие в проект ProjectId  | 
|
SuperTaskId  | 
integer  | 
Возвращает только задачи, входящие в надзадачу SuperTaskId  | 
|
SortBy  | 
string  | 
Сортировка результата  | 
Допустимые значения: 
  | 
SortOrder  | 
string  | 
Направление сортировки  | 
Допустимые значения: 
 По умолчанию: asc  | 
ShowActions  | 
bool  | 
Нужно ли показывать в списке возможные действия над задачей  | 
Допустимые значения: true, false По умолчанию: false  | 
Limit  | 
integer  | 
Сколько выбрать задач (LIMIT)  | 
Целочисленное значение в диапазоне [1,100] По умолчанию: 50  | 
Offset  | 
integer  | 
Начиная с какой выбирать задачи (OFFSET)  | 
|
Detailed  | 
bool  | 
Если true, то будут выводиться поля подробной информации о задаче  | 
К таким полям относятся: Statement, Executors, Auditors, AllAttaches, Start, PlannedWork, PlannedFinish, Finish, ActualWork, ActualWorkWithSubTasks  | 
Все параметры являются необязательными
Выходные данные (массив задач с полями)¶
Имя поля  | 
Тип  | 
Описание  | 
|---|---|---|
Id  | 
integer  | 
ID задачи  | 
Name  | 
string  | 
Название  | 
Status  | 
string  | 
Статус  | 
PlannedFinish  | 
datetime  | 
Дата запланированного финиша  | 
PlannedWork  | 
integer  | 
Количество запланированной работы в минутах  | 
ActualWork  | 
integer  | 
Отработанное время в минутах  | 
ActualWorkWithSubTasks  | 
integer  | 
Аналогично ActualWork, но с учетом отработанного времени во всех подзадачах  | 
Completed  | 
integer  | 
Процент завершения задачи  | 
Deadline  | 
datetime  | 
Дедлайн  | 
Owner  | 
object  | 
Постановщик (сотрудник)  | 
Owner.Id  | 
integer  | 
Идентификатор  | 
Owner.Name  | 
string  | 
Имя  | 
Responsible  | 
object  | 
Ответственный (сотрудник)  | 
Responsible.Id  | 
integer  | 
Идентификатор  | 
Responsible.Name  | 
string  | 
Имя  | 
Severity  | 
string  | 
Важность  | 
SuperTask  | 
object  | 
Надзадача  | 
SuperTask.Id  | 
integer  | 
Идентификатор  | 
SuperTask.Name  | 
string  | 
Название  | 
Project  | 
object  | 
Проект  | 
Project.Id  | 
integer  | 
Идентификатор  | 
Project.Name  | 
string  | 
Название  | 
Favorite  | 
integer  | 
В избранном  | 
TimeCreated  | 
datetime  | 
Время создания  | 
TimeUpdated  | 
datetime  | 
Время последней модификации  | 
Folders  | 
array  | 
Список папок, в которые попадает задача  | 
Tags  | 
object[]  | 
Тэги, привязанные к задаче  | 
Tags[].Id  | 
integer  | 
Идентификатор  | 
Tags[].Name  | 
string  | 
Имя тега  | 
Activity  | 
datetime  | 
Дата и время последней активности по задаче  | 
Actions  | 
array  | 
Список доступных действий над задачей  | 
IsOverdue  | 
bool  | 
Является ли задача просроченной  | 
СommentsUnread  | 
integer  | 
Количество непрочитанных комментариев  | 
Пример ответа в JSON-формате¶
{
  "status":
  {
    "code":"ok",
    "message":null
  },
  "params":
  {
    "Folder":"all",
    "Status":"any"
  },
  "data":
  {
    "tasks":
    [
      {
        "Id":841,
        "Name":"Test task",
        "Status":"accepted",
        "Deadline":"2010-12-30 16:00:00",
        "Owner":
        {
          "Id":2,
          "Name":"Director"
        },
        "Responsible":
        {
          "Id":651,
          "Name":"Ivanov Ivan"
        },
        "Favorite":"",
        "TimeCreated":"2007-12-13 12:24:12",
        "IsOverdue":true
      },
      {
        "Id":1394,
        "Name":"Another task",
        "Status":"accepted",
        "Deadline":"",
        "Owner":
        {
          "Id":3,
          "Name":"Medvedev Dima"
        },
        "Responsible":
        {
          "Id":651,
          "Name":"Ivanov Ivan"
        },
        "Severity":
        {
          "Id":1,
          "Name":"Hot"
        },
        "SuperTask":
        {
          "Id":1393,
          "Name":"Global task"
        },
        "Project":
        {
          "Id":30,
          "Name":"Megaplan API"
        },
        "Favorite":"1",
        "TimeCreated":"2009-08-17 13:27:28",
        "Folders":["incoming"]
        "IsOverdue":false
      }
    ]
  }
}
Пример ответа в XML-формате¶
<?xml version="1.0" encoding="utf-8"?>
<response>
  <status>
    <code>ok</code>
    <message></message>
  </status>
  <params>
    <folder>all</folder>
    <status>any</status>
  </params>
  <data>
    <tasks>
      <item>
        <id>841</id>
        <name>Test task</name>
        <status>accepted</status>
        <deadline>2010-12-30 16:00:00</deadline>
        <owner>
          <id>2</id>
          <name>Director</name>
        </owner>
        <responsible>
          <id>651</id>
          <name>Ivanov Ivan</name>
        </responsible>
        <time_created>2007-12-13 12:24:12</time_created>
        <folders>
          <item>incoming</item>
        </folders>
        <is_overdue>true</is_overdue>
      </item>
      <item>
        <id>1394</id>
        <name>Another task</name>
        <status>accepted</status>
        <deadline></deadline>
        <owner>
          <id>3</id>
          <name>Medvedev Dima</name>
        </owner>
        <responsible>
          <id>651</id>
          <name>Ivanov Ivan</name>
        </responsible>
        <severity>
          <id>1</id>
          <name>Hot</name>
        </severity>
        <super_task>
          <id>1393</id>
          <name>Global task</name>
        </super_task>
        <project>
          <id>30</id>
          <name>Megaplan API</name>
        </project>
        <favorite>1</favorite>
        <time_created>2009-08-17 13:27:28</time_created>
        <folders>
          <item>incoming</item>
        </folders>
        <is_overdue>true</is_overdue>
      </item>
    </tasks>
  </data>
</response>
Создание задачи¶
URI: /BumsTaskApiV01/Task/create.api|xml
Входные параметры¶
Имя поля  | 
Тип  | 
Описание  | 
Примечание  | 
|---|---|---|---|
Model[Name]  | 
string  | 
Название  | 
Обязательное поле  | 
Model[Deadline]  | 
datetime  | 
Дедлайн (дата со временем)  | 
|
Model[DeadlineDate]  | 
date  | 
Дедлайн (только дата)  | 
|
Model[DeadlineType]  | 
string  | 
Тип дедлайна  | 
|
Model[Responsible]  | 
integer  | 
Код ответственного  | 
Обязательное поле для не массовой задачи  | 
Model[Executors]  | 
integer[]  | 
Коды соисполнителей  | 
Обязательное поле для массовой задачи  | 
Model[Auditors]  | 
integer[]  | 
Коды аудиторов  | 
|
Model[Severity]  | 
integer  | 
Код важности  | 
|
Model[SuperTask]  | 
string  | 
Код надзадачи (если число) или код проекта (если строка в формате „pКод_проекта“)  | 
|
Model[Customer]  | 
integer  | 
Код заказчика  | 
|
Model[IsGroup]  | 
integer  | 
Массовая задача (каждому соисполнителю будет создана своя задача)  | 
Допустимые значения: 0 или 1  | 
Model[Statement]  | 
string  | 
Суть задачи  | 
|
Model[Attaches][Add]  | 
array  | 
Массив приложенных файлов  | 
Должен передаваться POST-запросом  | 
Model[Attaches][Add][0…n][Content]  | 
string  | 
Данные (контент) файла, закодированные с использованием MIME base64  | 
В устаревших версиях Мегаплана может действовать имя параметра Model[Attaches][Add][][Context]  | 
Model[Attaches][Add][0…n][Name]  | 
string  | 
Имя файла  | 
Будет фигурировать при выводе задачи  | 
Model[Start]  | 
datetime  | 
Планирование: старт  | 
Дата со временем  | 
Model[PlannedFinish]  | 
date  | 
Планирование: финиш  | 
Только дата. При указанном Model[PlannedTime] расчитывается автоматически  | 
Model[PlannedTime]  | 
integer  | 
Планирование: длительность (в днях)  | 
При указанном Model[PlannedFinish] расчитывается автоматически  | 
Model[PlannedWork]  | 
integer  | 
Планирование: плановые трудозатраты (в минутах)  | 
Выходные данные (поля созданной задачи)¶
Имя поля  | 
Тип  | 
Описание  | 
Примечание  | 
|---|---|---|---|
Id  | 
integer  | 
ID задачи  | 
При постановке массовой задачи это будет ID родительской надзадачи  | 
Name  | 
string  | 
Название задачи  | 
Редактирование задачи¶
URI: /BumsTaskApiV01/Task/edit.api|xml
Входные параметры¶
Имя поля  | 
Тип  | 
Описание  | 
Примечание  | 
|---|---|---|---|
Id  | 
integer  | 
ID задачи  | 
Обязательный параметр  | 
Model[Name]  | 
string  | 
Название  | 
|
Model[Deadline]  | 
datetime  | 
Дедлайн (дата со временем)  | 
|
Model[DeadlineDate]  | 
date  | 
Дедлайн (только дата)  | 
|
Model[DeadlineType]  | 
string  | 
Тип дедлайна  | 
|
Model[Owner]  | 
integer  | 
Код постановщика  | 
|
Model[Responsible]  | 
integer  | 
Код ответственного  | 
|
Model[Executors]  | 
integer[]  | 
Коды соисполнителей  | 
|
Model[Auditors]  | 
integer[]  | 
Коды аудиторов  | 
|
Model[Severity]  | 
integer  | 
Код важности  | 
С версии 2011.3 допустимо отсутствие параметра важности или важность с MasterType=high  | 
Model[SuperTask]  | 
string  | 
Код надзадачи (если число) или код проекта (если строка в формате „pКод_проекта“)  | 
|
Model[Customer]  | 
integer  | 
Код заказчика  | 
|
Model[Statement]  | 
string  | 
Суть задачи  | 
|
Model[Attaches][Add]  | 
array  | 
Массив приложенных файлов  | 
Должен передаваться POST-запросом  | 
Model[Attaches][Add][0…n][Content]  | 
string  | 
Данные (контент) файла, закодированные с использованием MIME base64  | 
В устаревших версиях Мегаплана может действовать имя параметра Model[Attaches][Add][][Context]  | 
Model[Attaches][Add][0…n][Name]  | 
string  | 
Имя файла  | 
Будет фигурировать при выводе задачи  | 
Model[Start]  | 
datetime  | 
Планирование: старт  | 
Дата со временем  | 
Model[PlannedFinish]  | 
date  | 
Планирование: финиш  | 
Только дата. При указанном Model[PlannedTime] расчитывается автоматически  | 
Model[PlannedTime]  | 
integer  | 
Планирование: длительность (в днях)  | 
При указанном Model[PlannedFinish] расчитывается автоматически  | 
Model[PlannedWork]  | 
integer  | 
Планирование: плановые трудозатраты (в минутах)  | 
Выходные данные¶
–
Редактирование Аудиторов¶
URI: /BumsTaskApiV01/Task/saveAuditors.api|xml
Входные параметры¶
Имя поля  | 
Тип  | 
Описание  | 
Примечание  | 
|---|---|---|---|
Id  | 
integer  | 
ID задачи  | 
Обязательный параметр  | 
Auditors  | 
integer[]  | 
Идентификаторы аудиторов  | 
При пустом параметре аудиторы будут сброшены  | 
Редактирование Соисполнителей¶
URI: /BumsTaskApiV01/Task/saveExecutors.api|xml
Входные параметры¶
Имя поля  | 
Тип  | 
Описание  | 
Примечание  | 
|---|---|---|---|
Id  | 
integer  | 
ID задачи  | 
Обязательный параметр  | 
Executors  | 
integer[]  | 
Идентификаторы соисполнителей  | 
При пустом параметре соисполнители будут сброшены  | 
Карточка задачи¶
URI: /BumsTaskApiV01/Task/card.api|xml
Входные параметры¶
Имя поля  | 
Тип  | 
Описание  | 
|---|---|---|
Id  | 
integer  | 
ID задачи (обязательный параметр)  | 
RequestedFields  | 
array  | 
Запрашиваемые поля (меняет набор полей по умолчанию). Могут содержать расширенные поля.  | 
ExtraFields  | 
array  | 
Дополнительные поля (дополняют набор полей по умолчанию). Могут содержать расширенные поля.  | 
Выходные данные (поля задачи)¶
Имя поля  | 
Тип  | 
Описание  | 
|---|---|---|
Id  | 
integer  | 
ID задачи  | 
Name  | 
string  | 
Название  | 
Statement  | 
string  | 
Суть задачи  | 
Status  | 
string  | 
Статус Возможные статусы задачи: 
  | 
Start  | 
datetime  | 
Старт задачи  | 
Completed  | 
integer  | 
Процент завершения задачи  | 
Finish  | 
datetime  | 
Время фактического завершения задачи  | 
PlannedFinish  | 
datetime  | 
Дата запланированного финиша  | 
PlannedWork  | 
integer  | 
Количество запланированной работы в минутах  | 
ActualWork  | 
integer  | 
Отработанное время в минутах  | 
ActualWorkWithSubTasks  | 
integer  | 
Аналогично ActualWork, но с учетом отработанного времени во всех подзадачах  | 
Completed  | 
integer  | 
Процент завершения задачи  | 
Deadline  | 
datetime  | 
Дедлайн  | 
Owner  | 
object  | 
Постановщик (сотрудник)  | 
Owner.Id  | 
integer  | 
Идентификатор  | 
Owner.Name  | 
string  | 
Имя  | 
Responsible  | 
object  | 
Ответственный (сотрудник)  | 
Responsible.Id  | 
integer  | 
Идентификатор  | 
Responsible.Name  | 
string  | 
Имя  | 
Executors  | 
object[]  | 
Соисполнители (сотрудники)  | 
Executors[].Id  | 
integer  | 
Идентификатор  | 
Executors[].Name  | 
string  | 
Имя  | 
Auditors  | 
object[]  | 
Аудиторы (сотрудники)  | 
Auditors[].Id  | 
integer  | 
Идентификатор  | 
Auditors[].Name  | 
string  | 
Имя  | 
Severity  | 
string  | 
Важность  | 
SuperTask  | 
object  | 
Надзадача  | 
SuperTask.Id  | 
integer  | 
Идентификатор  | 
SuperTask.Name  | 
string  | 
Название  | 
Project  | 
object  | 
Проект  | 
Project.Id  | 
integer  | 
Идентификатор  | 
Project.Name  | 
string  | 
Название  | 
Favorite  | 
integer  | 
В избранном  | 
TimeCreated  | 
datetime  | 
Время создания  | 
TimeUpdated  | 
datetime  | 
Время последней модификации  | 
Customer  | 
object  | 
Заказчик  | 
Customer.Id  | 
integer  | 
Идентификатор  | 
Customer.Name  | 
string  | 
Название  | 
Customer.Status  | 
array  | 
Cтатус  | 
Customer.Status.Id  | 
integer  | 
Идентификатор  | 
Customer.Status.Name  | 
string  | 
Название  | 
Customer.Type  | 
array  | 
Тип  | 
Customer.Type.Id  | 
integer  | 
Идентификатор  | 
Customer.Type.Name  | 
string  | 
Название типа  | 
DeadlineChange  | 
object  | 
Неотвеченный запрос на перенос дедлайна  | 
DeadlineChange.Id  | 
integer  | 
Идентификатор запроса  | 
DeadlineChange.Request  | 
string  | 
Объяснение запроса  | 
DeadlineChange.Deadline  | 
datetime  | 
Дата-время нового дедлайна  | 
Folders  | 
array  | 
Список папок, в которые попадает задача  | 
Tags  | 
object[]  | 
Тэги, привязанные к задаче  | 
Tags[].Id  | 
integer  | 
Идентификатор  | 
Tags[].Name  | 
string  | 
Название  | 
Activity  | 
datetime  | 
Дата и время последней активности по задаче  | 
IsOverdue  | 
bool  | 
Является ли задача просроченной  | 
Attaches  | 
object[]  | 
Прикрепленные к задаче файлы  | 
Attaches[].Name  | 
string  | 
Пользовательское имя файла  | 
Attaches[].Url  | 
string  | 
Ссылка для скачивания файла (без домена)  | 
Attaches[].FileName  | 
string  | 
Физическое имя файла  | 
Attaches[].TimeCreated  | 
datetime  | 
Дата-время добавления аттача  | 
Attaches[].Size  | 
integer  | 
Размер файла в байтах  | 
Пример ответа в JSON-формате¶
{
  "status":
  {
    "code":"ok",
    "message":null
  },
  "params":
  {
    "Id":841
  },
  "data":
  {
    "task":
    {
      "Id":841,
      "Folders":["incoming"],
      "Name":"Test task",
      "Statement":"Task statement",
      "Status":"accepted",
      "Deadline":"2010-12-30 16:00:00",
      "DeadlineType":"medium",
      "Owner":
      {
        "Id":2,
        "Name":"Director"
      },
      "Responsible":
      {
        "Id":651,
        "Name":"Ivanov Ivan"
      },
      "Executors":
      [
        {
          "Id":44,
          "Name":"Sidorov Sidor"
        },
        {
          "Id":45,
          "Name":"VV"
        }
      ],
      "Favorite":"1",
      "TimeCreated":"2007-12-13 12:24:12",
      "DeadlineChange":
      {
        "Id":621,
        "Request":"Не успеваю",
        "Deadline":"2012-02-04"
      },
      "IsOverdue":true
    }
  }
}
Пример ответа в XML-формате¶
<?xml version="1.0" encoding="utf-8"?>
<response>
  <status>
    <code>ok</code>
    <message></message>
  </status>
  <params>
    <id>841</id>
  </params>
  <data>
    <task>
      <id>841</id>
      <name>Test task</name>
      <statement>Some task statement with "html special chars"</statement>
      <status>accepted</status>
      <deadline>2010-12-30 16:00:00</deadline>
      <deadline_type>medium</deadline_type>
      <folders>
        <item>incoming</item>
      </folders>
      <owner>
        <id>2</id>
        <name>Director</name>
      </owner>
      <responsible>
        <id>651</id>
        <name>Ivanov Ivan</name>
      </responsible>
      <executors>
        <item>
          <id>44</id>
          <name>Sidorov Sidor</name>
        </item>
        <item>
          <id>45</id>
          <name>VV</name>
        </item>
      </executors>
      <favorite>1</favorite>
      <time_created>2007-12-13 12:24:12</time_created>
      <deadline_change>
        <id>621</id>
        <request>Не успеваю</request>
        <deadline>2012-02-04</deadline>
      </deadline_change>
      <is_overdue>true</is_overdue>
    </task>
  </data>
</response>
Список полей задачи¶
URI: /BumsTaskApiV01/Task/listFields.api|xml
Выходные параметры (массив полей задачи с типом и переводом поля)¶
Поле  | 
Тип  | 
Описание  | 
|---|---|---|
Fields  | 
array<object (Name, Translation, Type)>  | 
Массив объектов, где каждый объект является определением поля, содержащим его имя тип и перевод.  | 
Другие действия¶
Совершение действия над задачей¶
URI: /BumsTaskApiV01/Task/action.api|xml
Входные параметры¶
Имя поля  | 
Тип  | 
Описание  | 
|---|---|---|
Id  | 
integer  | 
ID задачи  | 
Action  | 
string  | 
Действие над задачей  | 
Выходные данные¶
–
Может ли пользователь делегировать задачу¶
URI: /BumsTaskApiV01/Task/checkDelegate.api|xml
Входные параметры¶
Имя поля  | 
Тип  | 
Описание  | 
Примечание  | 
|---|---|---|---|
Id  | 
integer  | 
ID задачи, которую нужно делегировать  | 
Обязательный параметр  | 
ResponsibleId  | 
integer  | 
Идентификатор сотрудника, которому нужно делегировать задачу  | 
Обязательный параметр  | 
Выходные данные¶
Имя поля  | 
Тип  | 
Описание  | 
Примечание  | 
|---|---|---|---|
CanDelegate  | 
bool  | 
Может ли текущий пользователь делегировать задачу  | 
Пример ответа в JSON-формате¶
{
  "status":
  {
    "code":"ok",
    "message":null
  },
  "data":
  {
    "CanDelegate": 1
  }
}
Пример ответа в XML-формате¶
<?xml version="1.0" encoding="utf-8"?>
<response>
  <status>
    <code>ok</code>
    <message></message>
  </status>
  <data>
    <can_delegate>1</can_delegate>
  </data>
</response>
Конвертация задачу в проект¶
URI: /BumsTaskApiV01/Task/convert.api|xml
Входные параметры¶
Имя поля  | 
Тип  | 
Описание  | 
Примечание  | 
|---|---|---|---|
Id  | 
integer  | 
ID задачи  | 
Обязательный параметр  | 
Выходные данные (поля проекта)¶
Имя поля  | 
Тип  | 
Описание  | 
|---|---|---|
Id  | 
integer  | 
ID проекта  | 
Запрос на перенос дедлайна¶
URI: /BumsTaskApiV01/Task/deadlineChange.api|xml
Входные параметры¶
Имя поля  | 
Тип  | 
Описание  | 
Примечание  | 
|---|---|---|---|
SubjectId  | 
integer  | 
ID задачи или проекта  | 
Обязательный параметр  | 
SubjectType  | 
string  | 
Тип объекта  | 
Допустимые значения: 
 Обязательный параметр  | 
Deadline  | 
datetime  | 
Новая дата дедлайна  | 
|
Request  | 
string  | 
Комментарий к запросу  | 
Выходные данные¶
Имя поля  | 
Тип  | 
Описание  | 
Примечание  | 
|---|---|---|---|
createdDeadlineChangeId  | 
integer  | 
ID запроса на смену дедлайна  | 
Принять или отклонить запрос на изменение дедлайна¶
URI: /BumsTaskApiV01/Task/deadlineAction.api|xml
Входные параметры¶
Имя поля  | 
Тип  | 
Описание  | 
Примечание  | 
|---|---|---|---|
Id  | 
integer  | 
ID запроса  | 
Идентификатор запроса. Выводится в карточке задачи, к которой привязан запрос. Обязательный параметр  | 
Action  | 
string  | 
Действие над запросом  | 
Допустимые значения: принять (  | 
Делегирование задачи¶
URI: /BumsTaskApiV01/Task/delegate.api|xml
Входные параметры¶
Имя поля  | 
Тип  | 
Описание  | 
Примечание  | 
|---|---|---|---|
Id  | 
integer  | 
ID задачи, которую нужно делегировать  | 
Обязательный параметр  | 
ResponsibleId  | 
integer  | 
Идентификатор сотрудника, которому нужно делегировать задачу  | 
Обязательный параметр  | 
Делегировать можно:
Задачи в статусе «назначена» и «принята», в которых постановщик или ответственный является вашим подчиненным.
Задачи в статусе «назначена» и «принята», принадлежащие проекту, в котором вы являетесь менеджером.
Добавить задачу в избранное¶
URI: /BumsTaskApiV01/Task/markAsFavorite.api|xml
Для добавления и удаления из избранного предпочтительно пользоваться командами `Добавить в избранное <API_favorite_add>`__ и `Удалить из избранного <API_favorite_remove>`__
Входные параметры¶
Имя поля  | 
Тип  | 
Описание  | 
Примечание  | 
|---|---|---|---|
Id  | 
integer  | 
ID задачи  | 
Обязательный параметр  | 
Value  | 
integer  | 
Действие  | 
Допустимые значения: 
  | 
Метаинформация¶
Список возможных действий над задачей¶
Название  | 
Описание  | 
|---|---|
act_accept_task  | 
принять задачу  | 
act_reject_task  | 
отклонить задачу  | 
act_accept_work  | 
принять работу  | 
act_reject_work  | 
отклонить работу  | 
act_done  | 
завершить задачу  | 
act_pause  | 
поставить на паузу  | 
act_resume  | 
возобновить задачу  | 
act_cancel  | 
снять задачу  | 
act_expire  | 
провалить задачу  | 
act_renew  | 
возобновить задачу  | 
act_delete  | 
удалить задачу  | 
act_edit  | 
редактировать задачу  | 
act_convert  | 
преобразовать задачу в проект  | 
act_subtask  | 
создать подзадачу  | 
act_delegate  | 
делегировать задачу  | 
act_edit_executors  | 
изменение соисполнителей и аудиторов  | 
Список действий для задачи¶
URI: /BumsTaskApiV01/Task/availableActions.api|xml
Входные параметры¶
Имя поля  | 
Тип  | 
Описание  | 
Примечание  | 
|---|---|---|---|
Id  | 
integer  | 
ID задачи  | 
Обязательный параметр  | 
Выходные данные¶
Имя поля  | 
Тип  | 
Описание  | 
|---|---|---|
actions  | 
string[]  | 
Массив с названиями допустимых действий  | 
Пример ответа в JSON-формате¶
{
    "status": {
        "code":"ok",
        "message":null
    },
    "actions":["act_delete","act_edit","act_accept_work","act_cancel"]
}
Пример ответа в XML-формате¶
<?xml version="1.0" encoding="utf-8"?>
<response>
    <status>
        <code>ok</code>
        <message></message>
    </status>
    <actions>
        <item>act_delete</item>
        <item>act_edit</item>
        <item>act_accept_work</item>
        <item>act_cancel</item>
    </actions>
</response>
Список действий для нескольких задач¶
URI: /BumsTaskApiV01/Task/availableActionsForList.api|xml
Входные параметры¶
Имя поля  | 
Тип  | 
Описание  | 
Примечание  | 
|---|---|---|---|
Ids  | 
array  | 
Массив идентификаторов, для которых нужно загрузить список действий  | 
Выходные данные¶
Имя поля  | 
Тип  | 
Описание  | 
|---|---|---|
actions  | 
object[]  | 
Массив с ID задач и допустимых действий для них  | 
actions[].Id  | 
integer  | 
Идентификатор задачи  | 
actions[].Actions  | 
string[]  | 
Массив с названиями допустимых действий  | 
Пример ответа в JSON-формате¶
{
  "status":
  {
    "code":"ok",
    "message":null
  },
   "actions":
  [
    {
      "Id": 540,
      "Actions":
      [
        "act_edit",
        "act_done"
      ]
    },
    {
      "Id": 541,
      "Actions":
      [
        "act_expire",
        "act_delete"
      ]
    }
  ]
}
Пример ответа в XML-формате¶
<?xml version="1.0" encoding="utf-8"?>
<response>
  <status>
    <code>ok</code>
    <message></message>
  </status>
  <actions>
    <item>
      <id>540</id>
      <actions>
        <item>act_edit</item>
        <item>act_done</item>
      </actions>
    </item>
    <item>
      <id>541</id>
      <actions>
        <item>act_expire</item>
        <item>act_delete</item>
      </actions>
    </item>
  </actions>
</response>
</response>
Список проектов, которые можно указывать в качестве надпроектов¶
URI: /BumsTaskApiV01/Task/superProjects.api|xml
Выходные данные (список проектов)¶
Имя поля  | 
Тип  | 
Описание  | 
|---|---|---|
Id  | 
integer  | 
ID проекта  | 
Name  | 
string  | 
Название  | 
Пример ответа в JSON-формате¶
{
  "status":
  {
    "code":"ok",
    "message":null
  },
  "params":
  {
  },
  "data":
  {
    "projects":
    [
      {
        "Id":841,
        "Name":"Test task"
      },
      {
        "Id":1394,
        "Name":"Another task"
      }
    ]
  }
}
Пример ответа в XML-формате¶
<?xml version="1.0" encoding="utf-8"?>
<response>
  <status>
    <code>ok</code>
    <message></message>
  </status>
  <params>
  </params>
  <data>
    <projects>
      <item>
        <id>841</id>
        <name>Test project</name>
      </item>
      <item>
        <id>1394</id>
        <name>Another project</name>
      </item>
    </projects>
  </data>
</response>
Список задач и проектов, которые можно указывать в качестве родителя¶
URI: /BumsTaskApiV01/Task/superTasks.api|xml
Входные параметры¶
–
Выходные данные (список задач)¶
Имя поля  | 
Тип  | 
Описание  | 
|---|---|---|
Id  | 
integer  | 
ID задачи  | 
Name  | 
string  | 
Название  | 
Пример ответа в JSON-формате¶
{
  "status":
  {
    "code":"ok",
    "message":null
  },
  "params":
  {
  },
  "data":
  {
    "tasks":
    [
      {
        "Id":841,
        "Name":"Test task"
      },
      {
        "Id":1394,
        "Name":"Another task"
      }
    ],
    "projects":
    [
      {
        "Id":45,
        "Name":"Test project"
      },
      {
        "Id":63,
        "Name":"Another project"
      }
    ]
  }
}
Пример ответа в XML-формате¶
<?xml version="1.0" encoding="utf-8"?>
<response>
  <status>
    <code>ok</code>
    <message></message>
  </status>
  <params>
  </params>
  <data>
    <tasks>
      <item>
        <id>841</id>
        <name>Test task</name>
      </item>
      <item>
        <id>1394</id>
        <name>Another task</name>
      </item>
    </tasks>
    <projects>
      <item>
        <id>45</id>
        <name>Test project</name>
      </item>
      <item>
        <id>63</id>
        <name>Another project</name>
      </item>
    </projects>
  </data>
</response>
Список сотрудников, которым можно делегировать задачу¶
URI: /BumsTaskApiV01/Task/employeesToDelegate.api|xml
Входные параметры¶
Имя поля  | 
Тип  | 
Описание  | 
Примечание  | 
|---|---|---|---|
Id  | 
integer  | 
ID задачи, которую нужно делегировать  | 
Обязательный параметр  | 
Выходные данные¶
Имя поля  | 
Тип  | 
Описание  | 
Примечание  | 
|---|---|---|---|
employees  | 
object[]  | 
Список сотрудников которым можно делегировать задачу  | 
|
employees[].Id  | 
integer  | 
ID сотрудника  | 
|
employees[].Name  | 
string  | 
Полное имя  | 
Пример ответа в JSON-формате¶
{
  "status":
  {
    "code":"ok",
    "message":null
  },
  "params":
  {
    "Id":100234
  },
  "data":
  {
    "employees":
    [
      {
        "Id":1087,
        "Name":"Denisov Ivan"
      }
    ]
  }
}
Пример ответа в XML-формате¶
<?xml version="1.0" encoding="utf-8"?>
<response>
  <status>
    <code>ok</code>
    <message></message>
  </status>
  <params>
  <id>100234</id>
  </params>
  <data>
    <employees>
      <item>
        <id>1087</id>
        <name>Denisov Ivan</name>
      </item>
    </employees>
  </data>
 </response>