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

Материал из ПланФикс
Перейти к: навигация, поиск
 
(не показана 21 промежуточная версия 5 участников)
Строка 1: Строка 1:
−
Добавление действия.  Неполная версия функции, будет доробатываться:
+
{{#seo:
 +
|title=ПланФикс API action.add
 +
|titlemode=append
 +
|keywords=планфикс, действия, апи, api, action.add
 +
|description=ПланФикс API action.add
 +
}}
 +
Добавление комментария.  Неполная версия функции, будет дорабатываться:
 
<source lang="xml">
 
<source lang="xml">
 
<?xml version="1.0" encoding="UTF-8"?>
 
<?xml version="1.0" encoding="UTF-8"?>
Строка 9: Строка 15:
 
     <task>
 
     <task>
 
       <id></id>
 
       <id></id>
 +
      <general></general>
 
     </task>
 
     </task>
 +
    <contact>
 +
      <general></general>
 +
    </contact>
 
     <taskNewStatus></taskNewStatus>
 
     <taskNewStatus></taskNewStatus>
 
     <notifiedList>
 
     <notifiedList>
Строка 19: Строка 29:
 
     </notifiedList>
 
     </notifiedList>
 
     <isHidden></isHidden>
 
     <isHidden></isHidden>
 +
    <owner>
 +
      <id></id>
 +
    </owner>
 +
    <dateTime></dateTime>
 
     <analitics>
 
     <analitics>
 
       <analitic>
 
       <analitic>
Строка 51: Строка 65:
 
     </analitics>
 
     </analitics>
 
   </action>
 
   </action>
−
   <sirnature></sirnature>
+
   <signature></signature>
 
</request>
 
</request>
 
</source>
 
</source>
Строка 57: Строка 71:
 
!width="150"|Название !!width="200"| Тип !!width="50%"| Значение !! Примечание  
 
!width="150"|Название !!width="200"| Тип !!width="50%"| Значение !! Примечание  
 
|-
 
|-
−
|description ||string ||текст с описанием действия, комментарий ||
+
|description ||string ||описание комментария ||
 +
|-
 +
|task (contact) || ||задача/контакт, к которым добавляется комментарий — должен присутствовать только один узел (или task или contact) ||
 +
|-
 +
|task.id ||int ||идентификатор задачи ||
 
|-
 
|-
−
|task || ||задача, в рамках которой выполняется это действие ||
+
|task.general||int ||номер задачи (если задан, используется вместо id)||
 
|-
 
|-
−
|task.id  ||int ||идентификатор задачи ||
+
|contact.general||int ||номер контакта ||
 
|-
 
|-
−
|taskNewStatus  ||enum ||этим действием меняется статус задачи на указанный ||не обязательный параметр, перечень допустимых значений смотри в разделе [[ПланФикс API:Статусы задач|статусы задач]]
+
|taskNewStatus  ||enum ||этим комментарием меняется статус задачи на указанный ||не обязательный параметр, перечень допустимых значений смотри в разделе [[ПланФикс API:Статусы задач|статусы задач]]
 
|-
 
|-
−
|notifiedList || ||этим действием необходимо уведомить следующих пользователей ||необязательный параметрполе
+
|notifiedList || ||этим комментарием необходимо уведомить следующих пользователей ||необязательный параметр поле
 
|-
 
|-
−
|notifiedList.user || || список пользователей которые получат уведомление ||
+
|notifiedList.user || || список пользователей, которые получат уведомление ||
 
|-
 
|-
 
|notifiedList.user.id ||int || идентификатор пользователя ||
 
|notifiedList.user.id ||int || идентификатор пользователя ||
 
|-
 
|-
−
|isHidden ||bool || является ли действие(комментарий) скрытым от всех пользователей, за исключением списка уведомленных пользователей || не обязательное поле, по умолчанию равно 0 (false)
+
|isHidden ||bool || является ли комментарий скрытым от всех пользователей, за исключением списка уведомленных пользователей || не обязательное поле, по умолчанию равно 0 (false)
 +
|-
 +
|owner || || автор комментария||необязательное поле. Если не указано — берется пользователь, от имени которого выполняется функция
 +
|-
 +
|owner.id ||int ||идентификатор автора комментария || если это контакт - нужно использовать userid из ответа [[ПланФикс API contact.get|contact.get]]
 +
|-
 +
|dateTime || [[ПланФикс API:Тип данных DateTime | DateTime]] || дата/время создания — не обязательный, по умолчанию текущие || может заполняться, только если авторизация была сделана под сотрудником с правами администратора
 
|-
 
|-
 
|analitics  ||  || задается (прикрепляется) список аналитики  || не обязательный параметр
 
|analitics  ||  || задается (прикрепляется) список аналитики  || не обязательный параметр
Строка 87: Строка 111:
 
|itemData.value  || string || значение ||
 
|itemData.value  || string || значение ||
 
|-
 
|-
−
| ||colspan="3" | формат значения для разных типов аналитики ||
+
| ||colspan="3" | формат значения для разных типов аналитики:
 +
|-
 +
| || DATE || colspan="2"| дд-мм-гггг
 +
|-
 +
| || TIME || colspan="2"| чч:мм
 +
|-
 +
| || TIMEPERIOD || colspan="2"| <begin>чч:мм</begin><end>чч:мм</end>
 +
|-
 +
| || HANDBOOK || colspan="2"| int - key записи справочника
 +
|-
 +
| || USER || colspan="2"| int - идентификатор сотрудника
 +
|-
 +
| || CLIENT || colspan="2"| int - идентификатор контрагента
 +
|-
 +
| || LOGINLIST || colspan="2"| <id></id>...<id></id> - где каждый из узлов (узел может быть один) содержит идентификатор сотрудника, к которому относится аналитика.
 
|-
 
|-
 
|}
 
|}
Строка 115: Строка 153:
 
</response>
 
</response>
 
</source>
 
</source>
−
 
  
  
 
== Перейти ==
 
== Перейти ==
−
*[[ПланФикс API:Действия]]
+
*[[ПланФикс API:Комментарии]]
 
*[[Коды ошибок]]
 
*[[Коды ошибок]]
 
*[[Список функций]]
 
*[[Список функций]]

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

Добавление комментария. Неполная версия функции, будет дорабатываться: 

<?xml version="1.0" encoding="UTF-8"?>
<request method="action.add">
  <account></account>
  <sid></sid>
  <action>
    <description></description>
    <task>
      <id></id>
      <general></general>
    </task>
    <contact>
      <general></general>
    </contact>
    <taskNewStatus></taskNewStatus>
    <notifiedList>
      <user>
        <id></id>
        <id></id>
        <!-- ... -->
      </user>
    </notifiedList>
    <isHidden></isHidden>
    <owner>
      <id></id>
    </owner>
    <dateTime></dateTime>
    <analitics>
      <analitic>
        <id></id>
        <analiticData>
          <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>
  </action>
  <signature></signature>
</request>
Название Тип Значение Примечание
description string описание комментария
task (contact) задача/контакт, к которым добавляется комментарий — должен присутствовать только один узел (или task или contact)
task.id int идентификатор задачи
task.general int номер задачи (если задан, используется вместо id)
contact.general int номер контакта
taskNewStatus enum этим комментарием меняется статус задачи на указанный не обязательный параметр, перечень допустимых значений смотри в разделе статусы задач
notifiedList этим комментарием необходимо уведомить следующих пользователей необязательный параметр поле
notifiedList.user список пользователей, которые получат уведомление
notifiedList.user.id int идентификатор пользователя
isHidden bool является ли комментарий скрытым от всех пользователей, за исключением списка уведомленных пользователей не обязательное поле, по умолчанию равно 0 (false)
owner автор комментария необязательное поле. Если не указано — берется пользователь, от имени которого выполняется функция
owner.id int идентификатор автора комментария если это контакт - нужно использовать userid из ответа contact.get
dateTime DateTime дата/время создания — не обязательный, по умолчанию текущие может заполняться, только если авторизация была сделана под сотрудником с правами администратора
analitics задается (прикрепляется) список аналитики не обязательный параметр
analitics.analitic узел, содержащий данные по прикрепляемой аналитике
analitic.id int идентификатор аналитики список доступных аналитик можно получить при помощи функции analitic.getList
analitic.analiticData список значений полей
analiticData.itemData значение одного из параметров
itemData.fieldId int идентификатор параметра идентификатор параметра равен field.id
itemData.value string значение
формат значения для разных типов аналитики:
DATE дд-мм-гггг
TIME чч:мм
TIMEPERIOD <begin>чч:мм</begin><end>чч:мм</end>
HANDBOOK int - key записи справочника
USER int - идентификатор сотрудника
CLIENT int - идентификатор контрагента
LOGINLIST <id></id>...<id></id> - где каждый из узлов (узел может быть один) содержит идентификатор сотрудника, к которому относится аналитика.


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

<?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.add&oldid=33192»