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

Версия 11:27, 4 января 2014

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

<?xml version="1.0" encoding="UTF-8"?>
<request method="action.add">
  <account></account>
  <sid></sid>
  <action>
    <description></description>
    <task>
      <id></id>
    </task>
    <taskNewStatus></taskNewStatus>
    <notifiedList>
      <user>
        <id></id>
        <id></id>
        <!-- ... -->
      </user>
    </notifiedList>
    <isHidden></isHidden>
    <owner>
      <id></id>
    </owner>
    <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		задача, в рамках которой выполняется это действие
task.id	int	идентификатор задачи
taskNewStatus	enum	этим действием меняется статус задачи на указанный	не обязательный параметр, перечень допустимых значений смотри в разделе статусы задач
notifiedList		этим действием необходимо уведомить следующих пользователей	необязательный параметрполе
notifiedList.user		список пользователей которые получат уведомление
notifiedList.user.id	int	идентификатор пользователя
isHidden	bool	является ли действие(комментарий) скрытым от всех пользователей, за исключением списка уведомленных пользователей	не обязательное поле, по умолчанию равно 0 (false)
owner		автор действия	необязательное поле. Если не указано - берется пользователь от имени которого выполняется функция
owner.id	int	идентификатор автора действия
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>

Перейти

@@ Строка 1: / Строка 1: @@
-Добавление действия.  Неполная версия функции, будет доробатываться:
+Добавление действия.  Неполная версия функции, будет дорабатываться:
 <source lang="xml">
 <?xml version="1.0" encoding="UTF-8"?>