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

Версия 08:55, 20 ноября 2020

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

<?xml version="1.0" encoding="UTF-8"?>
<request method="action.update">
  <account></account>
  <sid></sid>
  <action>
    <id></id>
    <description></description>
    <taskNewStatus></taskNewStatus>
    <notifiedList>
      <user>
        <id></id>
        <id></id>
        <!-- ... -->
      </user>
    </notifiedList>
    <isHidden></isHidden>
    <dateTime></dateTime>
    <analitics>
      <analitic>
        <id></id>
        <analiticData>
          <key></key>
          <itemData>
            <fieldId></fieldId>
            <value></value>
          </itemData>
          <itemData>
            <fieldId></fieldId>
            <value></value>
          </itemData>
          <!-- ... -->
        </analiticData>
      </analitic>
      <!-- ... -->
      <analitic>
        <id></id>
        <analiticData>
          <itemData>
            <fieldId></fieldId>
            <value></value>
          </itemData>
          <itemData>
            <fieldId></fieldId>
            <value></value>
          </itemData>
          <!-- ... -->
        </analiticData>
      </analitic>
      <!-- ... -->
    </analitics>
    <deletedAnalitics>
      <key></key>
      <key></key>
      <!-- ... -->
    </deletedAnalitics>
  </action>
  <signature></signature>
</request>

Название	Тип	Значение	Примечание
id	int	идентификатор действия
description	string	текст с описанием действия, комментарий
taskNewStatus	enum	этим действием меняется статус задачи на указанный	не обязательный параметр, перечень допустимых значений смотри в разделе статусы задач, попытка поменять на неправильный статус или поменять статус не последним действием приведет к ошибке
notifiedList		этим действием необходимо уведомить следующих пользователей
notifiedList.user		список пользователей которые получат уведомление
notifiedList.user.id	int	идентификатор пользователя
isHidden	bool	является ли действие(комментарий) скрытым от всех пользователей, за исключением списка уведомленных пользователей	не обязательное поле, по умолчанию равно 0 (false)
dateTime	DateTime	дата/время создания - не обязательный, по-умолчанию - не изменяется	может заполняться, только если авторизация была сделана под сотрудником с правами администратора
analitics		список обновляемых аналитик	не обязательный параметр
analitics.analitic		узел, содержащий данные по аналитике
analitic.id	int	идентификатор аналитики	список доступных аналитик можно получить при помощи функции analitic.getList
analitic.analiticData		список строк аналитики
analiticData.key	int	идентификатор строки аналитики, если в запрос этот аттрибут присутствует - происходит изменения аналитики с этим идентификатором, если нет - добавление новой строки аналитики
analiticData.itemData		значение поля аналитики
itemData.fieldId	int	идентификатор поля аналитики	идентификаторы можно получить меодом feild.id
itemData.value	string	значение поля аналитики
deletedAnalitics		список удаленной аналитики
deletedAnalitics.key	int	ключ данных удаляемой аналитики	данное поле становится доступным после выполнения функции analitic.getData
signature	string(32)	подпись

Помните, можно обновлять действия с типом ACTION и COMMENT. Остальные попытки будут вызывать ошибку.

Результат удачного выполнения запроса:

<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
  <action>
    <id></id>
  </action>
</response>

Название	Тип	Значение	Примечание
action.id	int	идентификатор обновляемого действия

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

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

Перейти

@@ Строка 87: / Строка 87: @@
 |analitic.analiticData  ||  || список строк аналитики ||
 |-
-|analiticData.key  || int  || идентификатор строки аналитики, если в запрос этот аттрибут присутствует - происходит изменения аналитики с этим идентификатором, если нет - добавление новой строки аналитики || данное поле становится доступным после выполнения [[ПланФикс API analitic.getData|функции analitic.getData]]
+|analiticData.key  || int  || идентификатор строки аналитики, если в запрос этот аттрибут присутствует - происходит изменения аналитики с этим идентификатором, если нет - добавление новой строки аналитики ||
 |-
-|analiticData.itemData  ||  || значение одного из параметров ||
+|analiticData.itemData  ||  || значение поля аналитики ||
 |-
-|itemData.fieldId  || int  || идентификатор параметра || идентификатор параметра равен [[ПланФикс API analitic.getOptions|feild.id]]
+|itemData.fieldId  || int  || идентификатор поля аналитики || идентификаторы можно получить меодом [[ПланФикс API analitic.getOptions|feild.id]]
 |-
-|itemData.value  || string || значение ||
+|itemData.value  || string || значение поля аналитики ||
 |-
 |deletedAnalitics  || || список удаленной аналитики ||