Присоединяйтесь!
  1. Saby
  2. База знаний
  3. Электронный документооборот
  4. API ЭДО
  5. Порядок работы
  6. Работа с документами
  7. Работа с дополнительными полями

Работа с дополнительными полями в Saby по API

Работа с дополнительными полями в Saby по API

С помощью дополнительных полей можно хранить в документе произвольную информацию, которую нельзя записать в стандартные поля. Например, номер заявки, срок исполнения, email заявителя, ссылку, сумму, комментарии, флаги, списки, даты.

Добавить дополнительное поле можно через редактор регламента в Saby. Каждое поле имеет уникальное имя — оно будет ключом в объекте «ДополнительныеПоля» при передаче через API. Все значения передаются в виде объекта-хэштаблицы в теле запроса.

Как записывать и получать значения дополнительных полей

Чтобы добавить или изменить значения дополнительных полей в документе, используйте метод «СБИС.ЗаписатьДокумент». В теле запроса объект «Документ» должен содержать поле «ДополнительныеПоля». Названия полей берите из редактора регламента.

Чтобы получить значения дополнительных полей регламента, вызовите метод «СБИС.ПрочитатьДокумент» и в параметре «ДопПоля» передайте «ДополнительныеПоля». Чтобы получить расширения документа, передайте параметр «Расширение». Если нужно получить и те, и другие данные, передайте оба значения через запятую, без пробела.

Имя параметра

Применимость

Комментарий

ДополнительныеПоля

СБИС.ЗаписатьДокумент, СБИС.ПрочитатьДокумент, СБИС.СписокДокументов, СБИС.СписокДокументовПоСобытиям

Выводит дополнительные поля, заданные в регламенте. Это могут быть произвольные поля, такие как текстовые значения, числа, даты, флаги, которые добавляются в объект ДополнительныеПоля

Расширение

СБИС.ЗаписатьДокумент, СБИС.ПрочитатьДокумент, СБИС.СписокДокументов, СБИС.СписокДокументовПоСобытиям

Выводит расширения, специфичные для конкретного типа документа. Эти данные включают дополнительные атрибуты или поля, которые не являются частью стандартной структуры документа

Примеры

Однострочный текст

Многострочный текст

Маска

Число

Дата

Время

Период

Список

Флаг

Группа флагов

Логическое

Выбор из справочника/Сотрудники

Выбор из справочника/Контрагенты

Группировка элементов

ФИО

Подразделение

Должность

График работы

Адрес

Банк

Нашли неточность? Выделите текст с ошибкой и нажмите ctrl + enter.