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

Материал из ПланФикс
Перейти к: навигация, поиск
 
(не показано 18 промежуточных версий 3 участников)
Строка 1: Строка 1:
−
Функция обновления данных в действии. Формат запроса:
+
{{#seo:
 +
|title=ПланФикс API action.update
 +
|titlemode=append
 +
|keywords=планфикс, действия, апи, api
 +
|description=ПланФикс API action.update
 +
}}
 +
Функция обновления данных в комментарии. Формат запроса:
 
<source lang="xml">
 
<source lang="xml">
 
<?xml version="1.0" encoding="UTF-8"?>
 
<?xml version="1.0" encoding="UTF-8"?>
Строка 8: Строка 14:
 
     <id></id>
 
     <id></id>
 
     <description></description>
 
     <description></description>
−
     <timeTracker>
+
     <taskNewStatus></taskNewStatus>
−
      <workDate></workDate>
 
−
      <beginTime></beginTime>
 
−
      <endTime></endTime>
 
−
      <workKind>
 
−
        <id></id>
 
−
        <workType>
 
−
          <id></id>
 
−
        </workType>
 
−
      </workKind>
 
−
    </timeTracker>
 
 
     <notifiedList>
 
     <notifiedList>
 
       <user>
 
       <user>
Строка 26: Строка 22:
 
       </user>
 
       </user>
 
     </notifiedList>
 
     </notifiedList>
−
     <reminder>
+
     <isHidden></isHidden>
−
       <date></date>
+
    <dateTime></dateTime>
−
     </reminder>
+
    <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>
 
   </action>
 
   <signature></signature>
 
   <signature></signature>
Строка 36: Строка 69:
 
!width="150"|Название !!width="200"| Тип !!width="50%"| Значение !! Примечание  
 
!width="150"|Название !!width="200"| Тип !!width="50%"| Значение !! Примечание  
 
|-
 
|-
−
|id||int||идентификатор действия||
+
|id||int||идентификатор комментария||
 +
|-
 +
|description ||string ||текст комментария ||
 
|-
 
|-
−
|description ||string ||текст с описанием действия, комментарий ||
+
|taskNewStatus  ||enum ||этим комментарием меняется статус задачи на указанный ||не обязательный параметр, перечень допустимых значений смотри в разделе [[ПланФикс API:Статусы задач|статусы задач]], попытка поменять на неправильный статус или поменять статус не последним комментарием приведет к ошибке
 
|-
 
|-
−
|timeTracker || ||таймтрекер ||  
+
|notifiedList || ||этим комментарием необходимо уведомить следующих пользователей ||
 
|-
 
|-
−
|timeTracker.workDate||DateTime ||дата действия ||
+
|notifiedList.user || || список пользователей, которые получат уведомление ||
 
|-
 
|-
−
|timeTracker.beginTime||Time ||час начала ||
+
|notifiedList.user.id ||int || идентификатор пользователя ||
 
|-
 
|-
−
|timeTracker.endTime||Time ||час окончания ||
+
|isHidden ||bool || является ли комментарий скрытым от всех пользователей, за исключением списка уведомленных пользователей || не обязательное поле, по умолчанию равно 0 (false)
 
|-
 
|-
−
|timeTracker.workKind|| ||тип работы ||
+
|dateTime || [[ПланФикс API:Тип данных DateTime | DateTime]] || дата/время создания - не обязательный, по умолчанию - не изменяется || может заполняться, только если авторизация была сделана под сотрудником с правами администратора
 
|-
 
|-
−
|timeTracker.workKind.id ||int ||идентификатор типа работы ||
+
|analitics  || || список обновляемых аналитик  || не обязательный параметр
 
|-
 
|-
−
|timeTracker.workKind.workType || ||вид выполненной работы ||
+
|analitics.analitic  || || узел, содержащий данные по аналитике ||
 
|-
 
|-
−
|timeTracker.workKind.workType.id ||int ||идентификатор выполненной работы ||
+
|analitic.id || int || идентификатор аналитики || список доступных аналитик можно получить при помощи функции [[ПланФикс API analitic.getList|analitic.getList]]
 
|-
 
|-
−
|task || ||задача, в рамках которой выполняется это действие ||
+
|analitic.analiticData  || || список строк аналитики ||
 
|-
 
|-
−
|task.id ||int ||идентификатор задачи ||
+
|analiticData.key || int || идентификатор строки аналитики, если в запросе этот атрибут присутствует - происходит изменения аналитики с этим идентификатором, если нет - добавление новой строки аналитики ||  
 
|-
 
|-
−
|notifiedList || ||этим действием необходимо уведомить следующих пользователей ||
+
|analiticData.itemData  || || значение поля аналитики ||
 
|-
 
|-
−
|notifiedList.user || || список пользователей которые получат уведомление ||
+
|itemData.fieldId  || int  || идентификатор поля аналитики || идентификаторы можно получить методом [[ПланФикс API analitic.getOptions|feild.id]]
 
|-
 
|-
−
|notifiedList.user.id ||int || идентификатор пользователя ||
+
|itemData.value  || string || значение поля аналитики ||
 
|-
 
|-
−
|reminder || || ||необязательный параметр
+
|deletedAnalitics  || || список удаленных аналитик ||
 
|-
 
|-
−
|reminder.date ||DateTime || дата когда необходимо уведомить ||
+
|deletedAnalitics.key  || int || ключ данных удаляемой аналитики ||данное поле становится доступным после выполнения [[ПланФикс API analitic.getData|функции analitic.getData]]
 
|-
 
|-
 
|signature ||string(32)|| подпись ||
 
|signature ||string(32)|| подпись ||
 
|-
 
|-
 
|}
 
|}
−
Помните, можно обновлять действия с типом '''ACTION''' и '''COMMENT'''. Остальные попытки будут вызывать ошибку.
+
Помните, можно обновлять комментарии с типом '''ACTION''' и '''COMMENT'''. Остальные попытки будут вызывать ошибку.
  
  
Строка 88: Строка 123:
 
!width="150"|Название !!width="200"| Тип !!width="50%"| Значение !! Примечание  
 
!width="150"|Название !!width="200"| Тип !!width="50%"| Значение !! Примечание  
 
|-
 
|-
−
|action.id ||int ||идентификатор обновляемого действия ||
+
|action.id ||int ||идентификатор обновляемого комментария ||
 
|-
 
|-
 
|}
 
|}
Строка 99: Строка 134:
 
</response>
 
</response>
 
</source>
 
</source>
−
{| class="wikitable" style="margin-top: 1em; width:100% "
 
−
!width="50"|Значение ''code'' !! Расшифровка
 
−
|-
 
−
|align="center"| 0000|| неизвестная ошибка
 
−
|-
 
−
|}
 
−
 
  
  
 
== Перейти ==
 
== Перейти ==
−
*[[ПланФикс API]]
+
*[[ПланФикс API:Комментарии]]
−
*[[ПланФикс API:Действия]]
+
*[[Коды ошибок]]
 +
*[[Список функций]]

Текущая версия на 08:06, 31 мая 2021

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

<?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>


Перейти

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