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

Материал из ПланФикс
Перейти к: навигация, поиск
 
(не показано 18 промежуточных версий 3 участников)
Строка 1: Строка 1:
−
Функция получения информации о действии. Формат запроса:
+
{{#seo:
 +
|title=ПланФикс API action.get
 +
|titlemode=append
 +
|keywords=планфикс, комментарии, апи, api, action.get
 +
|description=ПланФикс API action.get
 +
}}
 +
Функция получения информации о комментарии. Формат запроса:
 
<source lang="xml">
 
<source lang="xml">
 
<?xml version="1.0" encoding="UTF-8"?>
 
<?xml version="1.0" encoding="UTF-8"?>
Строка 14: Строка 20:
 
!width="150"|Название !!width="200"| Тип !!width="50%"| Значение !! Примечание  
 
!width="150"|Название !!width="200"| Тип !!width="50%"| Значение !! Примечание  
 
|-
 
|-
−
|action.id ||int ||идентификатор действия ||
+
|action.id ||int ||идентификатор комментария ||
 
|-
 
|-
 
|signature ||string(32) ||подпись ||
 
|signature ||string(32) ||подпись ||
Строка 34: Строка 40:
 
     </statusChange>
 
     </statusChange>
 
     <isNotRead></isNotRead>
 
     <isNotRead></isNotRead>
 +
    <fromEmail></fromEmail>
 
     <dateTime></dateTime>
 
     <dateTime></dateTime>
−
    <timeTracker>
 
−
      <workDate></workDate>
 
−
      <beginTime></beginTime>
 
−
      <endTime></endTime>
 
−
      <workKind>
 
−
        <id></id>
 
−
        <name></name>
 
−
        <workType>
 
−
          <id></id>
 
−
          <name></name>
 
−
        </workType>
 
−
      </workKind>
 
−
    </timeTracker>
 
 
     <task>
 
     <task>
 
       <id></id>
 
       <id></id>
 
       <title></title>
 
       <title></title>
 
     </task>
 
     </task>
 +
    <contact>
 +
      <general></general>
 +
      <name></name>
 +
    </contact>
 
     <owner>
 
     <owner>
 
       <id></id>
 
       <id></id>
Строка 64: Строка 62:
 
       <newDate></newDate>
 
       <newDate></newDate>
 
     </taskExpectDateChanged>
 
     </taskExpectDateChanged>
 +
    <taskStartTimeChanged>
 +
      <oldDate></oldDate>
 +
      <newDate></newDate>
 +
    </taskStartTimeChanged>
 
     <files>
 
     <files>
 
       <file>
 
       <file>
Строка 86: Строка 88:
 
       <!-- ... -->
 
       <!-- ... -->
 
     </notifiedList>
 
     </notifiedList>
−
     <reminder>
+
     <analitics>
−
       <date></date>
+
       <analitic>
−
     </reminder>
+
        <id></id>
 +
        <key></key>
 +
        <name></name>
 +
      </analitic>
 +
      <analitic>
 +
        <id></id>
 +
        <key></key>
 +
        <name></name>
 +
      </analitic>
 +
      <!-- ... -->
 +
     </analitics>
 
   </action>
 
   </action>
 
</response>
 
</response>
Строка 95: Строка 107:
 
!width="150"|Название !!width="200"| Тип !!width="50%"| Значение !! Примечание  
 
!width="150"|Название !!width="200"| Тип !!width="50%"| Значение !! Примечание  
 
|-
 
|-
−
|id ||int ||идентификатор действия ||
+
|id ||int ||идентификатор комментария ||
 
|-
 
|-
−
|description ||string ||описание действия ||
+
|description ||string ||описание комментария ||
 
|-
 
|-
 
|type ||enum ||тип действия || список возможных значений смотри в разделе [[ПланФикс API:Список типов действий|типы действий]]
 
|type ||enum ||тип действия || список возможных значений смотри в разделе [[ПланФикс API:Список типов действий|типы действий]]
 
|-
 
|-
−
|statusChange || || наличие данного узла свидетельствует о том, что этим действием был изменен статус задачи  ||
+
|statusChange || || наличие данного узла свидетельствует о том, что этим комментарием был изменен статус задачи  ||
 
|-
 
|-
 
|statusChange.oldStatus ||enum || старый статус || список допустимых значений смотри [[ПланФикс API:Статусы задач|статусы задач]]
 
|statusChange.oldStatus ||enum || старый статус || список допустимых значений смотри [[ПланФикс API:Статусы задач|статусы задач]]
Строка 107: Строка 119:
 
|statusChange.newStatus ||enum || новый статус ||список допустимых значений смотри [[ПланФикс API:Статусы задач|статусы задач]]
 
|statusChange.newStatus ||enum || новый статус ||список допустимых значений смотри [[ПланФикс API:Статусы задач|статусы задач]]
 
|-
 
|-
−
|isNotRead ||bool || действие не помечено как прочитанное ||
+
|isNotRead ||bool || комментарий не помечен как прочитанный ||
 
|-
 
|-
−
|dateTime ||DateTime ||дата добавления действия ||
+
|fromEmail||bool || комментарий создан из письма по электронной почте ||
 
|-
 
|-
−
|timeTracker || ||Если узел есть, этим действием был заполнен там треккинг  ||
+
|dateTime ||DateTime ||дата добавления комментария ||
 
|-
 
|-
−
|timeTracker.workDate ||DateTime ||дата тайм трекинга ||
+
|task || ||информация о задаче ||
 
|-
 
|-
−
|timeTracker.beginTime ||Time ||время начала работ ||
+
|task.id ||int ||идентификатор задачи ||
 
|-
 
|-
−
|timeTracker.endTime ||Time ||время окончания действия ||
+
|task.title ||string || название задачи ||
−
|-
 
−
|timeTracker.workKind || ||тип выполненных работ ||
 
−
|-
 
−
|timeTracker.workKind.id ||int ||идентификатор типа работ ||
 
−
|-
 
−
|timeTracker.workKind.name ||string || название типа работ ||
 
 
|-
 
|-
−
|timeTracker.workKind.workType || ||вид выполненных работ ||
+
|contact || ||информация о контакте || присутствует, только если комментарий добавлен к контакту
 
|-
 
|-
−
|timeTracker.workKind.workType.id ||int ||идентификатор выполненных работ ||
+
|contact.general ||int ||номер контакта ||
 
|-
 
|-
−
|timeTracker.workKind.workType.name ||string || название выполненных работ||
+
|contact.name ||string || имя контакта ||
 
|-
 
|-
−
|task || ||в рамках какой задачи выполнялся ||
+
|owner || || пользователь, который создал комментарий ||
 
|-
 
|-
−
|task.id ||int ||идентификатор задачи ||
+
|owner.id ||int || идентификатор пользователя||
−
|-
 
−
|task.title ||string || название задачи ||
 
−
|-
 
−
|owner || || пользователь, который создал действие ||
 
−
|-
 
−
|owner.id ||int || идентификатор действия ||
 
 
|-
 
|-
 
|owner.name ||string || имя пользователя ||
 
|owner.name ||string || имя пользователя ||
 
|-
 
|-
−
|project || ||в рамках какого проекта был создано действие ||
+
|project || ||в рамках какого проекта был создан комментарий ||
 
|-
 
|-
 
|project.id || int|| идентификатор проекта||
 
|project.id || int|| идентификатор проекта||
Строка 149: Строка 149:
 
|project.title ||string || название проекта ||
 
|project.title ||string || название проекта ||
 
|-
 
|-
−
|taskExpectDateChanged || || если задан данный узел, то этим действием было изменено время окончание задачи ||
+
|taskExpectDateChanged || || если задан данный узел, то этим комментарием было изменено время окончания задачи ||
 
|-
 
|-
 
|taskExpectDateChanged.oldDate ||DateTime || прежнее время ||
 
|taskExpectDateChanged.oldDate ||DateTime || прежнее время ||
Строка 155: Строка 155:
 
|taskExpectDateChanged.newDate ||DateTime || новое время ||
 
|taskExpectDateChanged.newDate ||DateTime || новое время ||
 
|-
 
|-
−
|files || || список файлов прикрепленных этим действием||
+
|taskStartTimeChanged || || если задан данный узел, то этим комментарием было изменено время начала задачи (приступить к работе) ||
 +
|-
 +
|taskStartTimeChanged.oldDate ||DateTime || прежнее время ||
 +
|-
 +
|taskStartTimeChanged.newDate ||DateTime || новое время ||
 +
|-
 +
|files || || список файлов прикрепленных этим комментарием ||
 
|-
 
|-
 
|files.file || || узел, описывающий файл||
 
|files.file || || узел, описывающий файл||
Строка 163: Строка 169:
 
|files.file.name ||string ||имя файла ||
 
|files.file.name ||string ||имя файла ||
 
|-
 
|-
−
|notifiedList || ||список пользователей которых должны уведомить о действии ||
+
|notifiedList || ||список пользователей, которых должны уведомить о комментарии ||
 
|-
 
|-
 
|notifiedList.user || || пользователь ||
 
|notifiedList.user || || пользователь ||
Строка 171: Строка 177:
 
|notifiedList.user.name ||string || имя пользователя ||
 
|notifiedList.user.name ||string || имя пользователя ||
 
|-
 
|-
−
|reminder || || напомнить о действии ||
+
|analitics || || список прикрепленных аналитик к комментарию ||
 
|-
 
|-
−
|reminder.date ||DateTime || дата напоминания ||
+
|analitics.analitic || || аналитика ||
 +
|-
 +
|analitics.analitic.id || int || идентификатор аналитики ||
 +
|-
 +
|analitics.analitic.key ||int || идентификатор строки данных аналитики ||
 +
|-
 +
|analitics.analitic.name ||string || название аналитики ||
 
|-
 
|-
 
|}
 
|}
Строка 184: Строка 196:
 
</response>
 
</response>
 
</source>
 
</source>
−
{| class="wikitable" style="margin-top: 1em; width:100% "
 
−
!width="50"|Значение ''code'' !! Расшифровка
 
−
|-
 
−
|align="center"| 0000|| неизвестная ошибка
 
−
|-
 
−
|}
 
−
 
  
  
 
== Перейти ==
 
== Перейти ==
−
*[[ПланФикс API]]
+
*[[ПланФикс API:Комментарии]]
−
*[[ПланФикс API:Действия]]
+
*[[Коды ошибок]]
 +
*[[Список функций]]

Текущая версия на 08:16, 31 мая 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>


Перейти

Источник — «http://planfix.ru/wiki/index.php?title=ПланФикс_API_action.get&oldid=33198»