Задать вопрос

Чек-листы

Список чек-листов по задачам, проектам или сделкам

Все чек-листы, привязанные ко всем задачам, проектам или сделкам.

URI: /BumsCommonApiV01/Checklist/all.api|xml

Входные параметры

Поле Тип Описание
OnlyActual bool Нужно ли показывать чек-листы только по актуальным (не завершенным) задачам, проектам и сделкам

Выходные данные

Поле Тип Описание
Id integer Код пункта
Name string Название пункта
IsDone bool Является ли пункт выполненным
OrderPos integer Порядковый номер пункта
TimeCreated datetime Дата и время создания
TimeUpdated datetime Дата и время обновления
SubjectType string Тип объекта, к которому привязан чек-лист. Задача (task), проект (project) или сделка (deal)
SubjectId integer Код объекта, к которому привязан чек-лист

Пример ответа в JSON-формате

{
  "status":
  {
    "code":"ok",
    "message":null
  },
  "data":
  {
    "items":
    [
      {
        "Id":1001128,
        "Name":"Первый пункт",
        "OrderPos":1,
        "IsDone":1,
        "TimeCreated":"2011-05-17 19:26:23",
        "TimeUpdated":"2011-05-17 19:23:32"
      },
      {
        "Id":1001129,
        "Name":"Второй пункт",
        "OrderPos":2,
        "IsDone":0,
        "TimeCreated":"2011-05-17 19:26:23",
        "TimeUpdated":"2011-05-17 19:23:32"
      }
    ]
  }
}

Пример ответа в XML-формате

<?xml version="1.0" encoding="utf-8"?>
<response>
  <status>
    <code>ok</code>
    <message></message>
  </status>
  <data>
    <items>
      <item>
        <id>1001128</id>
        <name>Первый пункт</name>
        <is_done>1</id_done>
        <order_pos>1</order_pos>
        <time_created>2011-05-17 19:26:23</time_created>
        <time_updated>2011-05-17 19:26:23</time_updated>
      </item>
      <item>
        <id>1001129</id>
        <name>Второй пункт</name>
        <is_done>0</id_done>
        <order_pos>2</order_pos>
        <time_created>2011-05-17 19:26:23</time_created>
        <time_updated>2011-05-17 19:26:23</time_updated>
      </item>
    </items>
  </data>
</response>

Чек-лист задачи, проекта или сделки

Пункты чек-листов, привязанных к конкретному задаче, проекту или сделке.

URI: /BumsCommonApiV01/Checklist/list.api|xml

Входные параметры

Поле Тип Допустимые значения Описание
SubjectType string task (задача), project (проект), сделка (deal) Тип объекта
TimeUpdated string Дата/время в одном из форматов ISO 8601 Возвращать только те объекты, которые были изменены после указанный даты
SubjectId integer   Код объекта

Выходные данные

Поле Тип Описание
Id integer Код пункта
Name string Название пункта
IsDone bool Является ли пункт выполненным
OrderPos integer Порядковый номер пункта
TimeCreated datetime Дата и время создания
TimeUpdated datetime Дата и время обновления

Пример ответа в JSON-формате

{
  "status":
  {
    "code":"ok",
    "message":null
  },
  "data":
  {
    "items":
    [
      {
        "Id":1001128,
        "Name":"Первый пункт",
        "OrderPos":1,
        "IsDone":1,
        "TimeCreated":"2011-05-17 19:26:23",
        "TimeUpdated":"2011-05-17 19:23:32"
      },
      {
        "Id":1001129,
        "Name":"Второй пункт",
        "OrderPos":2,
        "IsDone":0,
        "TimeCreated":"2011-05-17 19:26:23",
        "TimeUpdated":"2011-05-17 19:23:32"
      }
    ]
  }
}

Пример ответа в XML-формате

<?xml version="1.0" encoding="utf-8"?>
<response>
  <status>
    <code>ok</code>
    <message></message>
  </status>
  <data>
    <items>
      <item>
        <id>1001128</id>
        <name>Первый пункт</name>
        <is_done>1</id_done>
        <order_pos>1</order_pos>
        <time_created>2011-05-17 19:26:23</time_created>
        <time_updated>2011-05-17 19:26:23</time_updated>
      </item>
      <item>
        <id>1001129</id>
        <name>Второй пункт</name>
        <is_done>0</id_done>
        <order_pos>2</order_pos>
        <time_created>2011-05-17 19:26:23</time_created>
        <time_updated>2011-05-17 19:26:23</time_updated>
      </item>
    </items>
  </data>
</response>

Создание нового пункта чек-листа

URI: /BumsCommonApiV01/Checklist/create.api|xml

Входные параметры

Поле Тип Допустимые значения | Описание
SubjectType string task (задача), project (проект), сделка (deal) | Тип объекта, к которому привязан чек-лист
SubjectId integer   Код объекта, к которому привязан чек-лист
Model[Title] string   Название нового пункта
Model[Done] bool   Является ли пункт завершенным
Model[OrderPos] integer   Порядковый номер пункта в чек-листе

Выходные данные

Обновление пункта чек-листа

URI: /BumsCommonApiV01/Checklist/update.api|xml

Входные параметры

Поле Тип Описание
Id integer Код существующего пункта
Model[Title] string Название пункта
Model[Done] bool Является ли пункт завершенным
Model[OrderPos] integer Порядковый номер пункта в чек-листе

Выходные данные

Переключение пункта чек-листа

Переключение состояние (сделан/не сделан) пункта чек-листа.

URI: /BumsCommonApiV01/Checklist/toggle.api|xml

Входные параметры

Поле Тип Описание
Id integer Код пункта

Состояние пункта определяется автоматически. Если пункт был отмечен как сделанный, то он станет несделанным и наоборот.

Выходные данные

Удаление пункта чек-листа

URI: /BumsCommonApiV01/Checklist/delete.api|xml

Входные параметры

Поле Тип Описание
Id integer Код пункта

Выходные данные