ПланФикс API action.get — различия между версиями

Версия 09:24, 19 февраля 2021

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

<?xml version="1.0" encoding="UTF-8"?>
<request method="action.get">
  <account></account>
  <sid></sid>
  <action>
    <id></id>
  </action>
  <signature></signature>
</request>

Название	Тип	Значение	Примечание
action.id	int	идентификатор комментария
signature	string(32)	подпись

Ответ:

<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
  <action>
    <id></id>
    <description></description>
    <type></type>
    <statusChange>
      <oldStatus></oldStatus>
      <newStatus></newStatus>
    </statusChange>
    <isNotRead></isNotRead>
    <fromEmail></fromEmail>
    <dateTime></dateTime>
    <task>
      <id></id>
      <title></title>
    </task>
    <contact>
      <general></general>
      <name></name>
    </contact>
    <owner>
      <id></id>
      <name></name>
    </owner>
    <project>
      <id></id>
      <title></title>
    </project>
    <taskExpectDateChanged>
      <oldDate></oldDate>
      <newDate></newDate>
    </taskExpectDateChanged>
    <taskStartTimeChanged>
      <oldDate></oldDate>
      <newDate></newDate>
    </taskStartTimeChanged>
    <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>
    <analitics>
      <analitic>
        <id></id>
        <key></key>
        <name></name>
      </analitic>
      <analitic>
        <id></id>
        <key></key>
        <name></name>
      </analitic>
      <!-- ... -->
    </analitics>
  </action>
</response>

Название	Тип	Значение	Примечание
id	int	идентификатор комментария
description	string	текст комментария
type	enum	тип действия	список возможных значений смотри в разделе типы действий
statusChange		наличие данного узла свидетельствует о том, что этим действием был изменен статус задачи
statusChange.oldStatus	enum	старый статус	список допустимых значений смотри статусы задач
statusChange.newStatus	enum	новый статус	список допустимых значений смотри статусы задач
isNotRead	bool	действие не помечено как прочитанное
fromEmail	bool	действие создано из письма по электронной почте
dateTime	DateTime	дата добавления действия
task		информация о задаче
task.id	int	идентификатор задачи
task.title	string	название задачи
contact		информация о контакте	присутствует, только если действие добавлено к контакту
contact.general	int	номер контакта
contact.name	string	имя контакта
owner		пользователь, который создал действие
owner.id	int	идентификатор пользователя
owner.name	string	имя пользователя
project		в рамках какого проекта был создано действие
project.id	int	идентификатор проекта
project.title	string	название проекта
taskExpectDateChanged		если задан данный узел, то этим действием было изменено время окончание задачи
taskExpectDateChanged.oldDate	DateTime	прежнее время
taskExpectDateChanged.newDate	DateTime	новое время
taskStartTimeChanged		если задан данный узел, то этим действием было изменено время начала задачи (приступить к работе)
taskStartTimeChanged.oldDate	DateTime	прежнее время
taskStartTimeChanged.newDate	DateTime	новое время
files		список файлов прикрепленных этим действием
files.file		узел, описывающий файл
files.file.id	int	идентификатор файла
files.file.name	string	имя файла
notifiedList		список пользователей которых должны уведомить о действии
notifiedList.user		пользователь
notifiedList.user.id	int	идентификатор пользователя
notifiedList.user.name	string	имя пользователя
analitics		список прикрепленных аналитик к действию
analitics.analitic		аналитика
analitics.analitic.id	int	идентификатор аналитики
analitics.analitic.key	int	идентификатор строки данных аналитики
analitics.analitic.name	string	название аналитики

В противном случае будет возвращен ответ с ошибкой:

<?xml version="1.0" encoding="UTF-8"?>
<response status="error">
  <code></code>
</response>

Перейти

@@ Строка 14: / Строка 14: @@
 !width="150"|Название !!width="200"| Тип !!width="50%"| Значение !! Примечание
 |-
-|action.id ||int ||идентификатор действия ||
+|action.id ||int ||идентификатор комментария ||
 |-
 |signature ||string(32) ||подпись ||
@@ Строка 101: / Строка 101: @@
 !width="150"|Название !!width="200"| Тип !!width="50%"| Значение !! Примечание
 |-
-|id ||int ||идентификатор действия ||
+|id ||int ||идентификатор комментария ||
 |-
-|description ||string ||описание действия ||
+|description ||string ||текст комментария ||
 |-
 |type ||enum ||тип действия || список возможных значений смотри в разделе [[ПланФикс API:Список типов действий|типы действий]]