Комментарии¶

Список всех комментариев по актуальным задачам и проектам
Загрузка одного комментария по идентификатору
Создание комментария
Список комментариев по задаче/проекту/клиенту/сделке/делу/переписке
Список комментариев по нескольким объектам
Отметить комментарий как прочитанный

Список всех комментариев по актуальным задачам и проектам¶

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

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

Параметр	Тип	Допустимые значения	Описание
OnlyActual	bool	true	Если true, то будут выводиться комментарии только незавершенных задач или проектов
TimeUpdated	string	Дата/время в одном из форматов ISO 8601	Возвращать только те объекты, которые были изменены после указанный даты
DroppedOnly	bool	true	Если true, то будут выводиться удаленные комментарии задач или проектов

Выходные данные (массив комментариев с полями)¶

Параметр	Тип	Описание
Id	integer	ID комментария
Text	string	Текст комментария
Work	integer	Кол-во потраченных минут, которое приплюсовано к комментируемому объекту (задаче или проекту)
WorkDate	date	Дата, на которую списаны потраченные часы
TimeCreat ed	datetime	Время создания
Author	object (Id, Name)	Автор комментария (сотрудник)
Avatar	string	Адрес аватара автора
Attaches	object (Name, Url)	Файлы, прикрепленные к комментарию
IsUnread	bool	Является ли комментарий непрочитанным
SubjectTy pe	string	Тип объекта, к которому привязан комментарий: задача (task) или проект (project)
SubjectId	integer	Код объекта, к которому привязан комментарий

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

{
  "status":
  {
    "code":"ok",
    "message":null
  },
  "params":
  {
    "SubjectType":"task",
    "SubjectId":12,
    "Order":"asc"
  },
  "data":
  {
    "comments":
    [
      {
        "Id":841,
        "Text":"Some comment text",
        "Work":10,
        "WorkDate":"2010-11-30",
        "Author":
        {
          "Id":2,
          "Name":"Director"
        },
        "TimeCreated":"2010-12-13 12:24:12",
        "Avatar":"\/z\/i\/preview\/s\/7\/i\/sample\/photo-small480_320.jpg",
        "IsUnread":1
        "SubjectType":"task",
        "SubjectId":1234
      },
      {
        "Id":842,
        "Text":"Some another comment text",
        "Author":
        {
          "Id":3,
          "Name":"Just employee"
        },
        "TimeCreated":"2010-12-25 16:10:00",
        "Avatar":"\/z\/i\/preview\/attach\/1\/836\/505\/41\/703480_320.jpg",
        "IsUnread":0,
        "SubjectType":"project",
        "SubjectId": 12343,
        "Attaches":
        [
          {
            "Name": "picture.jpg",
            "Url": "/attach/1000006/1000106/396/a97790f541915d2811d548addf1a33f5.jpg/picture.jpg"
          }
        ]
      }
    ]
  }
}

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

<?xml version="1.0" encoding="utf-8"?>
<response>
  <status>
    <code>ok</code>
    <message></message>
  </status>
  <params>
    <subject_type>task</subject_type>
    <subject_id>12</subject_id>
    <order>asc</order>
  </params>
  <data>
    <comments>
      <item>
        <id>841</id>
        <text>Some comment text</text>
        <work>10</work>
        <work_date>2010-11-30</work_date>
        <author>
          <id>2</id>
          <name>Director</name>
        </author>
        <time_created>2010-12-13 12:24:12</time_created>
        <avatar>/z/i/preview/s/7/i/sample/photo-small480_320.jpg</avatar>
        <is_unread>1</is_unread>
        <subject_type>task</subject_type>
        <subject_id>12333</subject_id>
      </item>
      <item>
        <id>842</id>
        <name>Some another comment text</name>
        <author>
          <id>3</id>
          <name>Just employee</name>
        </author>
        <time_created>2010-12-25 16:10:00</time_created>
        <avatar>/z/i/preview/attach/1/836/505/41/703480_320.jpg</avatar>
        <attaches>
          <item>
            <name>picture.jpg</name>
            <url>/attach/1000006/1000106/396/a97790f541915d2811d548addf1a33f5.jpg/picture.jpg</url>
          </item>
        </attaches>
        <is_unread>0</is_unread>
        <subject_type>project</subject_type>
        <subject_id>12333</subject_id>
      </item>
    </comments>
  </data>
</response>

Загрузка одного комментария по идентификатору¶

URI: /BumsCommonApiV01/Comment/commentById.api|xml

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

Поле	Тип	Описание
Id	integer	Идентификатор комментария

Выходные данные (один комментарий)¶

Поле	Тип	Описание
Id	integer	ID комментария
Text	string	Текст комментария
Work	integer	Кол-во потраченных минут, которое приплюсовано к комментируемому объекту (задаче или проекту)
WorkDate	date	Дата, на которую списаны потраченные часы
TimeCreated	datetime	Время создания
Author

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

{
  "status":
  {
    "code":"ok",
    "message":null
  },
  "params":
  {
    "Id":1003843
  },
  "data":
  {
    "comment":
    {
      "Id":841,
      "Text":"Some comment text",
      "Work":10,
      "WorkDate":"2010-11-30",
      "Author":
      {
        "Id":2,
        "Name":"Director"
      },
      "TimeCreated":"2010-12-13 12:24:12",
      "Avatar":"\/z\/i\/preview\/s\/7\/i\/sample\/photo-small480_320.jpg",
      "IsUnread":1,
      "SubjectType": "task",
      "SubjectId": 100234
    }
  }
}

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

<?xml version="1.0" encoding="utf-8"?>
<response>
  <status>
    <code>ok</code>
    <message></message>
  </status>
  <params>
    <id>task</id>
  </params>
  <data>
    <comment>
      <id>1003843</id>
      <text>Some comment text</text>
      <work>10</work>
      <work_date>2010-11-30</work_date>
      <author>
        <id>2</id>
        <name>Director</name>
      </author>
      <time_created>2010-12-13 12:24:12</time_created>
      <avatar>/z/i/preview/s/7/i/sample/photo-small480_320.jpg</avatar>
      <is_unread>1</is_unread>
      <subject_type>task</subject_type>
      <subject_id>1003434</subject_id>
    </comment>
  </data>
</response>

Создание комментария¶

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

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

Поле	Тип	Допустимые значения	Описание
SubjectType	string	task (задача), project (проект), contractor (клиент), deal (сделка), discuss (обсуждение)	Тип комментируемого объекта
SubjectId	integer		ID комментируемого объекта
Model[Text]	string		Текст комментария
Model[Work]	integer

Выходные данные (поля комментария)¶

Поле	Тип Описание
Id	integer	ID комментария
Text	string	Текст комментария
Work	integer	Кол-во потраченных минут, которое приплюсуется к комментируемому объекту (задача или проект)
WorkDate	date	Дата, на которую списывать потраченные часы
TimeCreated	datetime	Время создания

Список комментариев по задаче/проекту/клиенту/сделке/делу/переписке¶

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

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

Поле	Тип	Допустимые значения	Описание
SubjectType	string	task (задача), project (проект), contractor (клиент), deal (сделка), item(дело), discuss(переписка)	Тип комментируемого объекта
SubjectId	integer		ID комментируемого объекта
TimeUpdated	string	Дата/время в одном из форматов ISO 8601	Возвращать только те объекты, которые были изменены после указанный даты
Order	string	asc (по возрастанию), desc (по убыванию)	Направление сортировки по дате (по умолчанию asc)
TextHtml	bool		Возвращать ли комментарий в Html формате (по умолчанию false)
UnreadOnly	bool		Возвращает только непрочитанные комментарии если true, по умолчанию false
Limit	integer		Сколько выбрать комментариев (LIMIT)
Offset	integer		Начиная с какого выбирать комментарии (OFFSET)
DroppedOnly	bool	true	Возвращать только удаленные комментарии

Выходные данные (массив комментариев с полями)¶

Поле	Тип	Описание
Id	integer	ID комментария
Text	string	Текст комментария
Work	integer	Кол-во потраченных минут, которое приплюсовано к комментируемому объекту (задаче или проекту)
WorkDate	date	Дата, на которую списаны потраченные часы
TimeCreated	datetime	Время создания
Author	object (Id, Name)	Автор комментария (сотрудник)
Avatar	string	Адрес аватара автора
IsFavorite	boolean	Отмечен ли комментарий как избранный
IsUnread	boolean	Является ли комментарий непрочитанным

Выходные данные (ID первого непрочитанного комментария)¶

Поле	Тип	Описание
FirstUnreadComment	integer	ID первого непрочитанного комментария

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

{
  "status":
  {
    "code":"ok",
    "message":null
  },
  "params":
  {
    "SubjectType":"task",
    "SubjectId":12,
    "Order":"asc"
  },
  "data":
  {
    "FirstUnreadComment":24, //ID первого непрочитанного комментария
    "comments":
    [
      {
        "Id":841,
        "Text":"Some comment text",
        "Work":10,
        "WorkDate":"2010-11-30",
        "Author":
        {
          "Id":2,
          "Name":"Director"
        },
        "TimeCreated":"2010-12-13 12:24:12",
        "Avatar":"\/z\/i\/preview\/s\/7\/i\/sample\/photo-small480_320.jpg",
        "IsUnread":1
      },
      {
        "Id":842,
        "Text":"Some another comment text",
        "Author":
        {
          "Id":3,
          "Name":"Just employee"
        },
        "TimeCreated":"2010-12-25 16:10:00",
        "Avatar":"\/z\/i\/preview\/attach\/1\/836\/505\/41\/703480_320.jpg",
        "IsUnread":0,
        "Attaches":
        [
          {
            "Name": "picture.jpg",
            "Url": "/attach/1000006/1000106/396/a97790f541915d2811d548addf1a33f5.jpg/picture.jpg"
          }
        ]
      }
    ]
  }
}

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

<?xml version="1.0" encoding="utf-8"?>
<response>
  <status>
    <code>ok</code>
    <message></message>
  </status>
  <params>
    <subject_type>task</subject_type>
    <subject_id>12</subject_id>
    <order>asc</order>
  </params>
  <data>
    <first_unread_comment>24</first_unread_comment>
    <comments>
      <item>
        <id>841</id>
        <text>Some comment text</text>
        <work>10</work>
        <work_date>2010-11-30</work_date>
        <author>
          <id>2</id>
          <name>Director</name>
        </author>
        <time_created>2010-12-13 12:24:12</time_created>
        <avatar>/z/i/preview/s/7/i/sample/photo-small480_320.jpg</avatar>
        <is_unread>1</is_unread>
      </item>
      <item>
        <id>842</id>
        <name>Some another comment text</name>
        <author>
          <id>3</id>
          <name>Just employee</name>
        </author>
        <time_created>2010-12-25 16:10:00</time_created>
        <avatar>/z/i/preview/attach/1/836/505/41/703480_320.jpg</avatar>
        <attaches>
          <item>
            <name>picture.jpg</name>
            <url>/attach/1000006/1000106/396/a97790f541915d2811d548addf1a33f5.jpg/picture.jpg</url>
          </item>
        </attaches>
        <is_unread>0</is_unread>
      </item>
    </comments>
  </data>
</response>

Список комментариев по нескольким объектам¶

URI: /BumsCommonApiV01/Comment/listByMultiSubjects.api|xml

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

Поле	Тип	Допустимые значения	Описание
Subject	array		Массив, описывающий какие комментари и по каким объектам(сделки, дела…) Вы хотите получить. Подробнее - ниже.
Order	string	asc (по возрастанию), desc (по убыванию)	Направление сортировки по дате (по умолчанию asc)
TextHtml	bool		Возвращать ли комментарий в Html формате (по умолчанию false)
UnreadOnly	bool		Возвращает только непрочитанные комментарии если true, по умолчанию false
Limit	integer		Сколько выбрать комментариев (LIMIT)
Offset	integer		Начиная с какого выбирать комментарии (OFFSET)

Запрос с параметром Subject может иметь следующий вид:

/BumsCommonApiV01/Comment/listByMultiSubjects.api?Subjects[discuss][0]=3517&Subjects[discuss][1]=4211&Subjects[item][0]=1425125&Subjects[deal][0]=1156525&Subjects[deal][1]=1156526&Subjects[deal][2]=1156527

Subjects[deal] - говорит о том, что необходимо получить комментарии по типу «сделка». Доступные типы: task (задача), project (проект), contractor (клиент), deal (сделка), item (дело), discuss (переписка).

Subjects[deal][0]=1156525&Subjects[deal][1]=1156526&Subjects[deal][2]=1156527 - так, формируется вложенный массив с id сделок, по которым хотим получить комментарии.

Таким образом, данный запрос вернёт комментарии по обсуждениям с id равными 3517 и 4211, по делу под id равному 1425125 и сделкам с id 1156525, 1156526, 1156527.

Выходные данные (массив комментариев с полями)¶

Поле	Тип	Описание
Id	integer	ID комментария
Text	string	Текст комментария
Work	integer	Кол-во потраченных минут, которое приплюсовано к комментируемому объекту (задаче или проекту)
WorkDate	date	Дата, на которую списаны потраченные часы
TimeCreated	datetime	Время создания
Author	object (Id, Name)	Автор комментария (сотрудник)
Avatar	string	Адрес аватара автора
IsFavorite	boolean	Отмечен ли комментарий как избранный
IsUnread	boolean	Является ли комментарий непрочитанным
SubjectType	string	Тип комментируемого объекта
SubjectId	integer	ID комментируемого объекта

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

{
  "status":
  {
    "code":"ok",
    "message":null
  },
  "data":
  {
    "comments":
    [
      {
        "Id":841,
        "Text":"Some comment text",
        "Work":10,
        "WorkDate":"2010-11-30",
        "Author":
        {
          "Id":2,
          "Name":"Director"
        },
        "TimeCreated":"2010-12-13 12:24:12",
        "Avatar":"\/z\/i\/preview\/s\/7\/i\/sample\/photo-small480_320.jpg",
        "IsUnread":1,
        "SubjectType":"discuss",
        "SubjectId":3517
      },
      {
        "Id":842,
        "Text":"Some another comment text",
        "Author":
        {
          "Id":3,
          "Name":"Just employee"
        },
        "TimeCreated":"2010-12-25 16:10:00",
        "Avatar":"\/z\/i\/preview\/attach\/1\/836\/505\/41\/703480_320.jpg",
        "IsUnread":0,
        "SubjectType":"discuss",
        "SubjectId":3517,
        "Attaches":
        [
          {
            "Name": "picture.jpg",
            "Url": "/attach/1000006/1000106/396/a97790f541915d2811d548addf1a33f5.jpg/picture.jpg"
          }
        ]
      },
      {
        "Id":843,
        "Text":"One more comment text",
        "Author":
        {
          "Id":3,
          "Name":"Just employee"
        },
        "TimeCreated":"2010-12-31 21:14:00",
        "Avatar":"\/z\/i\/preview\/attach\/1\/836\/505\/41\/703480_320.jpg",
        "IsUnread":0,
        "SubjectType":"deal",
        "SubjectId":1235
        "Attaches":
        [
          {
            "Name": "picture.jpg",
            "Url": "/attach/1000006/1000106/396/a97790f541915d2811d548addf1a33f5.jpg/picture.jpg"
          }
        ]
      }
    ]
  }
}

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

<?xml version="1.0" encoding="utf-8"?>
<response>
  <status>
    <code>ok</code>
    <message></message>
  </status>
  <data>
    <comments>
      <item>
        <id>841</id>
        <text>Some comment text</text>
        <work>10</work>
        <work_date>2010-11-30</work_date>
        <author>
          <id>2</id>
          <name>Director</name>
        </author>
        <time_created>2010-12-13 12:24:12</time_created>
        <avatar>/z/i/preview/s/7/i/sample/photo-small480_320.jpg</avatar>
        <is_unread>1</is_unread>
        <subject_type>discuss</subject_type>
        <subject_id>3517</id>
      </item>
      <item>
        <id>842</id>
        <name>Some another comment text</name>
        <author>
          <id>3</id>
          <name>Just employee</name>
        </author>
        <time_created>2010-12-25 16:10:00</time_created>
        <avatar>/z/i/preview/attach/1/836/505/41/703480_320.jpg</avatar>
        <attaches>
          <item>
            <name>picture.jpg</name>
            <url>/attach/1000006/1000106/396/a97790f541915d2811d548addf1a33f5.jpg/picture.jpg</url>
          </item>
        </attaches>
        <is_unread>0</is_unread>
        <subject_type>discuss</subject_type>
        <subject_id>3517</id>
      </item>
      <item>
        <id>843</id>
        <name>One more comment text</name>
        <author>
          <id>3</id>
          <name>Just employee</name>
        </author>
        <time_created>2010-12-31 21:14:00</time_created>
        <avatar>/z/i/preview/attach/1/836/505/41/703480_320.jpg</avatar>
        <attaches>
          <item>
            <name>picture.jpg</name>
            <url>/attach/1000006/1000106/396/a97790f541915d2811d548addf1a33f5.jpg/picture.jpg</url>
          </item>
        </attaches>
        <is_unread>0</is_unread>
        <subject_type>deal</subject_type>
        <subject_id>1235</id>
      </item>
    </comments>
  </data>
</response>

Отметить комментарий как прочитанный¶

URI: /BumsCommonApiV01/Comment/markAsRead.api|xml

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

Поле	Тип	Описание
Id	integer	Код комментария
IdList	array	Список кодов комментариев

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

—