Регламент - API3 Объект — различия между версиями

Материал из razgovorov.ru
Перейти к: навигация, поиск
м (Власов Илья переименовал страницу !(Власов)Шаблон2 в Регламент - API3 Объект)
 
(не показано 10 промежуточных версий этого же участника)
Строка 1: Строка 1:
−
VII Страница для согласования доработок формата шаблона документа
+
===Объект===
 +
Тип: Справочник
  
−
* ИдИС - идентификатор документа в ИС
+
'''Структура'''
−
* ИдСБИС - идентификатор документа в СБИС
+
* ИдСБИС - Уникальный идентификатор регламента (строка)
−
* Номер* - номер документа (строка)
+
* Название - Название склада (строка)
−
* Дата* - дата документа (строка в формате "ДД.ММ.ГГГГ")
+
* ТипДокумента - Тип документа, которому принадлежит регламент
−
* Название - Название документа
+
* ПодТипДокумента - ПодТип документа, которому принадлежит регламент
−
* Сумма - число
+
* Фазы - Список возможных фаз по документу.
−
* НашаОрганизация* - объект [[НашаОрганизация_-_API3_Объект|НашаОрганизация]]
+
** ИдСБИС - Уникальный идентификатор фазы
−
* Основание - список объектов документы основания (массив)
+
** Название - Название фазы
−
** Документ - объект с типом Документ
+
** Описание - Описание фазы, указанное на регламенте
−
** ВидСвязи - вид связи документа основания
+
** Переходы - Список переходов по фазе
−
* Регламент - регламент документа или тема отношений
+
*** ИдСБИС - Уникальный идентификатор перехода по фазе
−
* ТекущийЭтап - текущий этап документа (строка)
+
*** Название - Название перехода по фазе
−
* Ответственный - лицо, ответственное за документ. Объект [[ЧастноеЛицо_-_API3_Объект|Частное лицо]]
+
*** Фазы - Список идентификаторов фаз, на которые перейдет документ при выборе данного перехода.
−
* Подразделение - подразделение ответственное за документ. Объект [[СтруктураПредприятия_-_API3_Объект|Структура предприятия]]
+
* ДопПоля - Список дополнительных полей на регламенте
−
* Комментарий - комментарий к документу (строка)
+
** ИдСБИС - Уникальный идентификатор дополнительного поля на регламенте
−
* Параметры - массив именованных параметров ключ / значение
+
** Название - Название поля в структуре объекта
−
** Название
+
** НазваниеПолное - Название поля на интерфейсе
−
** Значение
+
** ЗначениеПоУмолчанию - Значение поля по умолчанию
−
* Вложение - массив с данными файлов, прилагаемых к документу.
 
−
** Название - Название файла вложения с расширением
 
−
** Ссылка - Ссылка на файл
 
−
** СсылкаСбисДиск - Ссылка на файл на СБИС диске
 
−
** ИдСБИС - Идентификатор файла на СБИС диске
 
−
** ДвоичныеДанные - строка с двоичными данными (base64)
 
−
* Пометки - пометки по документу (Данный используется исключительно при экспорте документов из СБИС
 
−
** Важный - отметка Флажок на документе СБИС (булево)
 
−
** Плюс - отметка Плюс на документе СБИС (булево)
 
−
** Срочно - отметка Красный круг на документе СБИС (булево)
 
−
** НеТребуется - отметка Зеленый круг на документе СБИС (булево)
 
−
** Просмотрен - отметка Синий круг на документе СБИС (булево)
 
−
** Значительный - отметка Желтый круг на документе СБИС (булево)
 
−
** ЗакрытоОтИзменений - отметка серая галка на документе СБИС (булево)
 
−
** Проведён - Признак проведения документа (булево)
 
  
 +
'''Пример:'''
 +
<source lang="json">
 +
{
 +
  "ИдСБИС": "790687a3-85ac-45f0-a63e-43164b3b2a89",
 +
  "ИмяСБИС": "Регламент",
 +
  "Название": "Авансовый отчет",
 +
  "ТипДокумента": "АвансОтчет",
 +
  "ПодТипДокумента": null,
 +
  "Фазы": [
 +
    {
 +
      "ИдСБИС": "0a92ceec-f4f9-568b-8380-dcc7fe1af5ab",
 +
      "Название": "Начало",
 +
      "Описание": "С этого места начинается прохождение",
 +
      "Переходы": [
 +
        {
 +
          "ИдСБИС": "8f539dde-ee33-4bc4-a62e-166355f4dcab",
 +
          "Название": "На проверку",
 +
          "Фазы": [
 +
            "c13f743a-c096-466c-ac37-06daf0d50de0"
 +
          ]
 +
        }
 +
      ]
 +
    },
 +
    {
 +
      "ИдСБИС": "c13f743a-c096-466c-ac37-06daf0d50de0",
 +
      "Название": "Проверка бухгалтером",
 +
      "Переходы": [
 +
        {
 +
          "ИдСБИС": "23b21625-18e2-49c0-8487-74c8633461fa",
 +
          "Название": "Проверено",
 +
          "Фазы": [
 +
            "0ac1423b-c2f9-496e-8138-07792d9f04f6"
 +
          ]
 +
        },
 +
        {
 +
          "ИдСБИС": "673a01c5-e245-4b91-a656-0a0a184d4159",
 +
          "Название": "Уточнить",
 +
          "Фазы": [
 +
            "8d8f1c73-d96c-45cb-aa08-c75622d38c7b"
 +
          ]
 +
        }
 +
      ]
 +
    },
 +
    {
 +
      "ИдСБИС": "0ac1423b-c2f9-496e-8138-07792d9f04f6",
 +
      "Название": "Подписание бухгалтером",
 +
      "Переходы": [
 +
        {
 +
          "ИдСБИС": "727a3ac4-3dda-4476-8c45-2ea3a032e0b3",
 +
          "Название": "Подписано"
 +
        }
 +
      ]
 +
    },
 +
    {
 +
      "ИдСБИС": "8d8f1c73-d96c-45cb-aa08-c75622d38c7b",
 +
      "Название": "Уточнение по отчету",
 +
      "Переходы": [
 +
        {
 +
          "ИдСБИС": "c1b72e8d-546d-42c8-9357-c5d34154736d",
 +
          "Название": "Дополнено",
 +
          "Фазы": [
 +
            "c13f743a-c096-466c-ac37-06daf0d50de0"
 +
          ]
 +
        }
 +
      ]
 +
    }
 +
  ],
 +
  "ДопПоля": [
 +
    {
 +
      "ИдСБИС": "eb54546a-64db-4fef-9cad-3ac63e92eb55",
 +
      "Название": "ВидыБизнеса",
 +
      "НазваниеПолное": "Виды бизнеса"
 +
    },
 +
    {
 +
      "ИдСБИС": "598f6c7a-4cbc-4202-a519-2da3ac9f6ee8",
 +
      "Название": "Остаток",
 +
      "НазваниеПолное": "Остаток"
 +
    },
 +
    {
 +
      "ИдСБИС": "8a5a153d-c96a-4b16-9347-b0e91cadd98d",
 +
      "Название": "Перерасход",
 +
      "НазваниеПолное": "Перерасход"
 +
    }
 +
  ]
 +
}
 +
</source>
  
−
===Флаги действий по документу при загрузке в СБИС (UpdateSbisObject)===
+
===Естественные ключи===
−
Флаги перечислены в порядке, в котором связанные операции будут применяться к документу:
+
* Ключ1
−
* ПрерватьЭДО - Признак необходимости прерывания документооборота по документу перед обновлением в СБИС. Документооборот будет прерван и будет создана новая редакция документа при выполнении следующих условий:
+
** Ключ1_1 - Тип документа, использующего регламент
−
1) Значение узла "Истина", "True" или "Да" (регистронезависимо).
+
** Ключ1_2 - ПодТип документа, использующего регламент
−
2) Обновляемый документ имеется в СБИС и по нему запущен документооборот.
+
** Ключ1_3 - не используется
−
* Провести - Признак необходимости проведения документа после загрузки в СБИС. (Для некоторых документов проведение включено по умолчанию(Поступление, Реализация)). Документ будет проведен при выполнении следующего условия:
+
* Ключ2 - не используется
−
Значение узла "Истина", "True" или "Да" (регистронезависимо).
+
* Ключ3 - не используется
−
* ЗапуститьЭДО - Признак необходимости запуска документооборота по документу с выбором первого действия из списка возможных,  после загрузки в СБИ. Документооборот запускается при выполнении следующих условий:
+
* Название - Используется
−
1) Значение узла "Истина", "True" или "Да" (регистронезависимо).
 
−
2) В результате выполнения UpdateSbisObject создается новый документ.
 
−
3) Действие на этапе не требует выбора ответственного или подписания.
 
  
 +
===Зависит от объектов===
 +
 +
===Используемые методы БЛ===
 +
* Regulation.Read
 +
* Regulation.List
 +
* Regulation.find
  
 
[[Категория:SBIS API3 Объект]]
 
[[Категория:SBIS API3 Объект]]

Текущая версия на 15:27, 24 января 2022

Объект

Тип: Справочник

Структура

  • ИдСБИС - Уникальный идентификатор регламента (строка)
  • Название - Название склада (строка)
  • ТипДокумента - Тип документа, которому принадлежит регламент
  • ПодТипДокумента - ПодТип документа, которому принадлежит регламент
  • Фазы - Список возможных фаз по документу.
    • ИдСБИС - Уникальный идентификатор фазы
    • Название - Название фазы
    • Описание - Описание фазы, указанное на регламенте
    • Переходы - Список переходов по фазе
      • ИдСБИС - Уникальный идентификатор перехода по фазе
      • Название - Название перехода по фазе
      • Фазы - Список идентификаторов фаз, на которые перейдет документ при выборе данного перехода.
  • ДопПоля - Список дополнительных полей на регламенте
    • ИдСБИС - Уникальный идентификатор дополнительного поля на регламенте
    • Название - Название поля в структуре объекта
    • НазваниеПолное - Название поля на интерфейсе
    • ЗначениеПоУмолчанию - Значение поля по умолчанию

Пример: 

{
  "ИдСБИС": "790687a3-85ac-45f0-a63e-43164b3b2a89",
  "ИмяСБИС": "Регламент",
  "Название": "Авансовый отчет",
  "ТипДокумента": "АвансОтчет",
  "ПодТипДокумента": null,
  "Фазы": [
    {
      "ИдСБИС": "0a92ceec-f4f9-568b-8380-dcc7fe1af5ab",
      "Название": "Начало",
      "Описание": "С этого места начинается прохождение",
      "Переходы": [
        {
          "ИдСБИС": "8f539dde-ee33-4bc4-a62e-166355f4dcab",
          "Название": "На проверку",
          "Фазы": [
            "c13f743a-c096-466c-ac37-06daf0d50de0"
          ]
        }
      ]
    },
    {
      "ИдСБИС": "c13f743a-c096-466c-ac37-06daf0d50de0",
      "Название": "Проверка бухгалтером",
      "Переходы": [
        {
          "ИдСБИС": "23b21625-18e2-49c0-8487-74c8633461fa",
          "Название": "Проверено",
          "Фазы": [
            "0ac1423b-c2f9-496e-8138-07792d9f04f6"
          ]
        },
        {
          "ИдСБИС": "673a01c5-e245-4b91-a656-0a0a184d4159",
          "Название": "Уточнить",
          "Фазы": [
            "8d8f1c73-d96c-45cb-aa08-c75622d38c7b"
          ]
        }
      ]
    },
    {
      "ИдСБИС": "0ac1423b-c2f9-496e-8138-07792d9f04f6",
      "Название": "Подписание бухгалтером",
      "Переходы": [
        {
          "ИдСБИС": "727a3ac4-3dda-4476-8c45-2ea3a032e0b3",
          "Название": "Подписано"
        }
      ]
    },
    {
      "ИдСБИС": "8d8f1c73-d96c-45cb-aa08-c75622d38c7b",
      "Название": "Уточнение по отчету",
      "Переходы": [
        {
          "ИдСБИС": "c1b72e8d-546d-42c8-9357-c5d34154736d",
          "Название": "Дополнено",
          "Фазы": [
            "c13f743a-c096-466c-ac37-06daf0d50de0"
          ]
        }
      ]
    }
  ],
  "ДопПоля": [
    {
      "ИдСБИС": "eb54546a-64db-4fef-9cad-3ac63e92eb55",
      "Название": "ВидыБизнеса",
      "НазваниеПолное": "Виды бизнеса"
    },
    {
      "ИдСБИС": "598f6c7a-4cbc-4202-a519-2da3ac9f6ee8",
      "Название": "Остаток",
      "НазваниеПолное": "Остаток"
    },
    {
      "ИдСБИС": "8a5a153d-c96a-4b16-9347-b0e91cadd98d",
      "Название": "Перерасход",
      "НазваниеПолное": "Перерасход"
    }
  ]
}

Естественные ключи

  • Ключ1
    • Ключ1_1 - Тип документа, использующего регламент
    • Ключ1_2 - ПодТип документа, использующего регламент
    • Ключ1_3 - не используется
  • Ключ2 - не используется
  • Ключ3 - не используется
  • Название - Используется

Зависит от объектов

Используемые методы БЛ

  • Regulation.Read
  • Regulation.List
  • Regulation.find
Источник — «http://wiki.razgovorov.ru/index.php?title=Регламент_-_API3_Объект&oldid=5997»