ПланФикс API handbook.updateRecord

Материал из ПланФикс
Версия от 12:37, 24 декабря 2018; Seva (обсуждение | вклад)
(разн.) ← Предыдущая | Текущая версия (разн.) | Следующая → (разн.)
Перейти к: навигация, поиск

Изменение записи справочника. Формат запроса:

<?xml version="1.0" encoding="UTF-8"?>
<request method="handbook.updateRecord">
  <account></account>
  <sid></sid>
  <handbook>
    <id></id>
  </handbook>
  <key></key>
  <parentKey></parentKey>
  <isGroup></isGroup>
  <name></name>
  <customData>
    <customValue>
      <id></id>
      <value></value>
      <files>
        <file>
          <name></name>
          <sourceType></sourceType>
          <otherFile>
            <url></url>
          </otherFile>
          <body></body>
          <description></description>
          <newversion></newversion>
        </file>
      </files>
    </customValue>
    <!-- ... -->
  </customData>
  <signature></signature>
</request>
Название Тип Значение Примечание
sid string(32) ключ сесии выдается в результате прохождения аутентификации
handbook.id int идентификатор справочника
key int идентификатор записи
parentKey int идентификатор группы записей необязательный параметр
isGroup bool является ли запись группой
name string название, если запись является группой
customData значения полей
customData.customValue.id идентификатор поля
customData.customValue.value значение поля (для полей типа набор задач, список сотрудников, набор записей справочника - идентификаторы через запятую в квадратных скобках)
files корневой элемент содержащий список сохраняемых файлов Для поля типа Файлы
file сохраняемый файл
file.name string имя сохраняемого файла
file.sourceType enum тип источника список допустимых значений смотри в типы источников файла, допустимые значения FILESYSTEM и INTERNET
file.otherFile Использовать уже существующий файл используется при sourceType: INTERNET
file.otherFile.url string URL фала в Интернет используется только при sourceType=INTERNET
file.body string тело файла закодированное base64 используется при sourceType=FILESYSTEM
file.description string краткое описание содержимого файла не обязательный параметр
file.newversion boolean если значение равно "1", при совпадении имени файла с ранее загруженным, не выдаётся ошибка, а файл загружается, как новая версия существующего не обязательный параметр

Ответ при успешном выполнении запроса:

<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
  <key></key>
</response>
Название Тип Значение Примечание
key int идентификатор записи

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

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


Примечание

Работая с полем типа файл customValue.value - содержит список идентификаторов файлов прикрепленных ранее через запятую. Все прикрепленные ранее файлы, идентификаторы которых будут отсутствовать - будут удалены.

Перейти