ПланФикс API: Комментарии: различия между версиями

Материал из Planfix
Перейти к: навигация, поиск
Нет описания правки
м (DM переименовал страницу ПланФикс API:Действия в ПланФикс API:Комментарии)
 
(не показано 9 промежуточных версий 4 участников)
Строка 1: Строка 1:
Список функций для управления действиями:
{{#seo:
#[[ПланФикс API action.add|action.add / Добавить действие]]
|title=ПланФикс API: Комментарии
#[[ПланФикс API action.update|action.update / Обновить действие]]
|titlemode=append
#[[ПланФикс API action.get|action.get / Получить действие]]
|keywords=планфикс, ПланФикс API: комментарии, API
#[[ПланФикс API action.getList|action.getList / Получить список действий]]
|description=ПланФикс API: Комментарии
#[[ПланФикс API action.attachFile|action.attachFile / Прикрепить файл]]
}}
 
Список функций для управления комментариями:
 
#[[ПланФикс API action.add|action.add / Добавить комментарий]]
== action.add / Добавить действие ==
#[[ПланФикс API action.update|action.update / Обновить комментарий]]
Добавление действия. Можно добавить комментарий или тайм треккинг:
#[[ПланФикс API action.get|action.get / Получить комментарий]]
<source lang="xml">
#[[ПланФикс API action.getList|action.getList / Получить список комментариев]]
<?xml version="1.0" encoding="UTF-8"?>
#[[ПланФикс API action.getListByPeriod|action.getListByPeriod / Получить список комментариев за заданный период]]
<request method="action.add">
#[[ПланФикс API action.getListWithAnalitic|action.getListWithAnalitic / Получить список комментариев с указанной аналитикой]]
  <account><!-- имя аккаунта --></account>
#[[ПланФикс API action.delete|action.delete / Удалить комментарий]]
  <sid><!-- ключ сессии, полученный после аутентификации --></sid>
  <action>
    <description></description>
 
    <!-- Если узел есть, этим действием заполняем тайм треккинг -->
    <timeTracker>
      <workDate>дата тайм трекинга</workDate>
      <beginTime>время начала работ</beginTime>
      <endTime>время окончания действия</endTime>
      <!-- тип выполненных работ -->
      <workKind>
        <id></id>
        <name></name>
        <workType>
          <id></id>
          <name></name>
        </workType>
      </workKind>
    </timeTracker>
 
    <!-- в рамках какой задачи выполнялся -->
    <task>
      <id></id>
      <title></title>
    </task>
 
    <!-- список пользователей которых должны уведомить -->
    <notifiedList>
      <user>
        <id></id>
        <id></id>
        <!-- ... -->
      </user>
    </notifiedList>
    <!-- напоминание, не обязательный узел -->
    <Reminder>
      <date>Дата напонминания</date>
    </Reminder>
  </action>
</request>
</source>
 
Результат удачного выполнения запроса:
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
  <action>
    <id></id>
  </action>
</response>
</source>
 
== action.update / Обновить действие ==
Запрос на обновление данных:
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<request method="action.update">
  <account><!-- имя аккаунта --></account>
  <sid><!-- ключ сессии, полученный после аутентификации --></sid>
  <action>
    <id></id>
    <description></description>
 
    <!-- Если узел есть, этим действием заполняем тайм треккинг -->
    <timeTracker>
      <workDate>дата тайм трекинга</workDate>
      <beginTime>время начала работ</beginTime>
      <endTime>время окончания действия</endTime>
      <!-- тип выполненных работ -->
      <workKind>
        <id></id>
        <workType>
          <id></id>
        </workType>
      </workKind>
    </timeTracker>
 
    <!-- список пользователей которых должны уведомить -->
    <notifiedList>
      <user>
        <id></id>
        <id></id>
        <!-- ... -->
      </user>
    </notifiedList>
    <!-- напоминание, не обязательный узел -->
    <Reminder>
      <date>Дата напонминания</date>
    </Reminder>
  </action>
</request>
</source>
Помните, можно обновлять действия с типом '''ACTION''' и '''COMMENT'''. Остальные попытки будут вызывать ошибку.
 
Результат выполнения запроса:
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
  <action>
    <id></id>
  </action>
</response>
</source>
 
== action.get / Получить действие ==
Запрос:
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<request method="action.get">
  <account><!-- имя аккаунта --></account>
  <sid><!-- ключ сессии, полученный после аутентификации --></sid>
  <id></id>
</request>
</source>
 
Ответ:
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
  <action>
    <id></id>
    <description></description>
    <type></type>
    <!-- узел присутствует если действие изменило статус -->
    <statusChange>
      <oldStatus>с какого</oldStatus>
      <newStatus>на какой</newStatus>
    </statusChange>
    <isNotRead>{true|false}</isNotRead><!-- действие не помеченно как прочитанное -->
    <dateTime>дата добавления действия</dateTime>
 
    <!-- Если узел есть, этим действием был заполнен там треккинг -->
    <timeTracker>
      <workDate>дата тайм трекинга</workDate>
      <beginTime>время начала работ</beginTime>
      <endTime>время окончания действия</endTime>
      <!-- тип выполненных работ -->
      <workKind>
        <id></id>
        <name></name>
        <workType>
          <id></id>
          <name></name>
        </workType>
      </workKind>
    </timeTracker>
 
    <!-- в рамках какой задачи выполнялся -->
    <task>
      <id></id>
      <title></title>
    </task>
    <!-- владелец действия, кто его оставил -->
    <owner>
      <id></id>
      <name></name>
    </owner>
    <!-- в рамках какого проекта был создано действие -->
    <project>
      <id></id>
      <title></title>
    </project>
 
    <!-- Этим действием было изменено время окончание задачи -->
    <taskExpectDateChanged>
      <oldDate></oldDate>
      <newDate></newDate>
    </taskExpectDateChanged>
 
    <!-- список файлов прикрепленных этим действием -->
    <files>
      <file>
        <id></id>
        <name></name>
      </file>
      <file>
        <id></id>
        <name></name>
      </file>
      <!-- ... -->
    </files>
    <!-- список пользователей которых должны уведомить -->
    <notifiedList>
      <user>
        <id></id>
        <name></name>
      </user>
      <user>
        <id></id>
        <name></name>
      </user>
      <!-- ... -->
    </notifiedList>
    <!-- напоминание, не обязательный узел -->
    <Reminder>
      <date>Дата напонминания</date>
    </Reminder>
  </action>
</response>
</source>
Значение поля '''type''' смотри в разделе константы [[#Типы действий|Типы действий]]
 
== action.getList / Получить список действий ==
Получение списка действий в задаче:
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<request method="action.getList">
  <account><!-- имя аккаунта --></account>
  <sid><!-- ключ сессии, полученный после аутентификации --></sid>
  <task>
    <id></id>
  </task>
  <pageCurrent></pageCurrent>
  <pageSize></pageSize>
</request>
</source>
 
 
Ответ:
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
  <actions count="количество узлов">
    <action><!-- описание полностью соответствует в разделе action.get --></action>
    <action><!-- описание полностью соответствует в разделе action.get --></action>
    <!-- ... -->
  </actions>
</response>
</source>
 
== action.attachFile / Прикрепить файл ==
Запрос на добавление файлов:
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<request method="action.attachFile">
  <account><!-- имя аккаунта --></account>
  <sid><!-- ключ сессии, полученный после аутентификации --></sid>
  <files>
    <file>
      <name>имя сохраняемого файла</name>
      <sourceType>тип источника</sourceType>
      <!-- в рамках какой задачи сохраняется файл, исключает наличие project -->
      <task>
        <id></id>
      </task>
      <!-- в рамках какого проекта сохраняется, используется, если не задан task -->
      <project>
        <id></id>
      </project>
      <!-- Использовать уже существующий файл,
      используется при sourceType: INTERNET, PROJECT  -->
      <otherFile>
        <!-- используется при ссылке на файл из проекта
        sourceType=PROJECT -->
        <id></id>
        <!-- используется только при sourceType=INTERNET -->
        <url></url>
      </otherFile>
      <!-- тело файла закодированное base64, используется при sourceType=FILESYSTEM -->
      <body></body>
      <description></description>
    </file>
  </files>
<!-- список пользователей которых должны уведомить -->
    <notifiedList>
      <users>
        <id></id>
        <id></id>
        <!-- ... -->
      </users>
    </notifiedList>
</request>
</source>
 
== Константы ==
=== Типы действий ===
*'''ACTION''' - Действие
*'''COMMENT''' - Комментарий
*'''FILE''' - Файл
*'''TASKCREATED''' - Задача создана
*'''STATUSCHANGED''' - Статус изменен
*'''TASKOVERDUED''' - Задача просрочена
*'''TASKNOTACCEPTEDINTIME''' - Задача не принята вовремя
*'''TASKREJECTED''' - Задача отклонена
*'''TASKACCEPTED''' - Задача принята
*'''WORKEREMPLOYED''' -  К работе подключен сотрудник
*'''TASKCLOSETODEADLINE''' - Задача близка к завершению
*'''REMINDER''' - Напоминание
*'''WORKERUNEMPLOYED''' - Сотрудник отстранен от работы
*'''TASKEXPECTDATECHANGED''' - Изменена дата завершения задачи
*'''CHANGEDATEREQUEST''' - Запрос на изменение даты завершения задачи
*'''CHANGEDATEREQUESTRESULT''' - Результат запроса на изменение даты завершения задачи
*'''TASKCHANGED''' - Данные задачи изменены
=== Типы источников файла ===
*'''FILESYSTEM''' - загружаемый файл
*'''INTERNET''' - файл - ссылка на файл
*'''PROJECT''' - файл проекта
 
== Ошибки ==


== Перейти ==
== Перейти ==
[[ПланФикс API]]
[[Список функций]]

Текущая версия от 06:43, 13 февраля 2021

Список функций для управления комментариями:

  1. action.add / Добавить комментарий
  2. action.update / Обновить комментарий
  3. action.get / Получить комментарий
  4. action.getList / Получить список комментариев
  5. action.getListByPeriod / Получить список комментариев за заданный период
  6. action.getListWithAnalitic / Получить список комментариев с указанной аналитикой
  7. action.delete / Удалить комментарий

Перейти

Список функций

Источник — http://planfix.com/ru/help/index.php?title=ПланФикс_API:Комментарии&oldid=30454