Общие методы API (Кинт)

Материал из КинтВики
Перейти к: навигация, поиск

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

GetCatalog (СписокЭлементов)

  • Тип HTTP-запроса: GET
  • Описание: Возвращает перечень элементов по заданному отбору. Можно использовать для получения списка организаций, категорий номеров и прочего.
Параметры
Наименование Обязателен? Тип данных Описание Пример
Вид / CatalogName Да Строка Имя объекта, из которого формируется выдача Организации
Отбор / Filter Нет Структура Структура, указывающая, по каким реквизитам и их значениям необходимо делать отбор {"ИНН": "1835012280"}
Тип / CatalogType Нет Строка Вид объекта, по умолчанию "Справочник". Справочник
  • Пример вызова:
    /GetData?Method=GetCatalog&CatalogName=Организации&Fields=Ссылка,ИНН,КПП
  • Пример вызова для списка документов:
    /GetData?Method=GetCatalog&CatalogName=ПоступлениеТоваровУслуг&CatalogType=Документ&Fields=Номер,Дата
  • Пример вызова с отбором:
    /GetData?Method=GetCatalog&CatalogName=Организации&Fields=Ссылка,ИНН,КПП&Filter={"ГоловнаяОрганизация":%20{"ID":"e1cib/data/Справочник.Организации?ref=ad5c5404a66e4a8911e37e83f3ef6892"}}
  • Пример вызова с пагинацией:
    GetData?Method=GetCatalog&CatalogName=яъФизическиеЛица&Fields=Наименование,Пол&PageNumber=24&CountOnPage=100&Filter={"Пол": "Перечисление.яъПол.Мужской"}
Пример ответа
развернуть

GetDBInfo (ДанныеИБ)

Возвращает информацию о версии информационной базы. Параметров нет. Можно использовать для проверки работоспособности API.

Пример вызова
/GetDBInfo
Проверка работоспособности API
https://<адрес_сервера>/<имя_публикации>/hs/KintAPI.hs/GetDBInfo
Пример ответа
развернуть

QRCode (КартинкаQR)

  • Тип HTTP-запроса: GET
  • Описание: Получает картинку QR-кода по навигационной ссылке переданного объекта в формате BASE64.

ОбъектПоНавигационнойСсылке

  • Тип HTTP-запроса: GET
  • Описание:
Параметры
Наименование Обязателен? Тип данных Описание Пример
НавигационнаяСсылка Да Строка Навигационная ссылка на объект в информационной базе e1cib/data/Справочник.яъФизическиеЛица?ref=9a6c5404a66e4a8911e5bb8e2aa0771f

GetPrintForm (ПолучитьПечатнуюФорму)

Позволяет получить сформированную печатную форму в выбранном формате.

Параметры:

  • Объект (GUID, обязательный) - для кого получаем значение параметра
  • ПечатнаяФорма (GUID, не обязательный только в случае получения значения параметра) - может использоваться для расширения списка параметров. Без печатной формы список параметров может быть ограничен.
  • Формат (не обязательный только в случае получения значения параметра) - доступны значения: DOCX, HTML5, MXL, PDF, TXT, XLS
  • ИмяПараметра (Строка, не обязательный) - если передан, то вернется не печатная форма, а значение переданного параметра. По умолчанию доступны параметры на вкладках «Основные» + «Доступные» + «Дополнительные» в форме настройки печатной формы.
  • стрТипВыходныхДанных (Строка, не обязательный) - может использоваться тип данных Base64 или ДвоичныеДанные, в ином случае возвращает содержимое файла. Значение по умолчанию Base64.
Пример вызова
/GetData?Method=GetPrintForm&Объект={"GUID":%20"dc7970e4-e673-11e9-b48d-5404a66e4a89"}&ПечатнаяФорма={"GUID":%20"09c83fe6-f918-4388-a2ee-b0a3276941d4"}&Формат=PDF
Пример ответа
развернуть
Пример вызова для получения значения параметра
/GetData?Method=GetPrintForm&Объект={"GUID":%20"dc7970e4-e673-11e9-b48d-5404a66e4a89"}&ПечатнаяФорма={"GUID":%20"09c83fe6-f918-4388-a2ee-b0a3276941d4"}&ИмяПараметра=ФизЛицо
Пример ответа
развернуть

GetReport (РезультатУФО)

Позволяет получить результат отчета в переданном формате.

Параметры:

  • Отчет (GUID, обязательный) - навигационная ссылка на отчет.
  • ТипФайла - формат результата.
    • JSON, CSV позволяют получить таблицу данных отчета
    • XLSX, PDF, TXT, DOCX, MXL позволяют получить результат отчета в том же виде, в котором сохраняется табличный документ результата отчета в режиме «1С: Предприятие», данные закодированы в строку BASE64.
Пример вызова
/hs/KintAPI.hs/РезультатУФО?Отчет={"Идентификатор":%20"e1cib/data/Справочник.яъОтчеты?ref=9c415404a66e4a8911e4dcfb89878423"}&Формат=JSON
Пример ответа
развернуть

GetDataSourceInfo (ОписаниеИсточникаДанных)

Позволяет получить описание источника данных в формате JSON.

Параметры:

  • ИсточникДанных (GUID, обязательный) - навигационная ссылка на источник данных.
Пример вызова
/hs/KintAPI.hs/ОписаниеИсточникаДанных?ИсточникДанных=e1cib/data/Справочник.яъИсточникиДанных?ref=bca1d85ed320709611ed397243b5eb7d
Пример ответа
развернуть

GetDataSource (ТаблицаИсточникаДанных)

Позволяет получить таблицу источника данных в формате JSON.

Параметры:

  • ИсточникДанных (GUID, обязательный) - навигационная ссылка на источник данных.
Пример вызова
/hs/KintAPI.hs/ТаблицаИсточникаДанных?ИсточникДанных=e1cib/data/Справочник.яъИсточникиДанных?ref=bc79d85ed320709611e346049adc3ab1
Пример вызова с передачей параметров формирования результата
/hs/KintAPI.hs/ТаблицаИсточникаДанных?ИсточникДанных=e1cib/data/Справочник.яъИсточникиДанных?ref=bc79d85ed320709611e346049adc3ab1&НачалоПериода=01.01.2022&КонецПериода=31.01.2022&ИНН=123456788900&Измерения=Контрагент,Договор&Ресурсы=Количество,Сумма
Пример ответа
развернуть

ЕстьПраваАдминистратора

  • Тип HTTP-запроса: GET
  • Описание: Возвращает признак наличия администраторских прав у указанного пользователя.
Параметры
Наименование Обязателен? Тип данных Описание Пример
Пользователь Да СправочникСсылка.яъПользователи Ссылка на пользователя, для которого выполняется проверка наличия прав администратора
{
    "Идентификатор": "e1cib/data/Справочник.яъПользователи?ref=9b7996e6d857ebf811e3a8f3c11af005"
}
Пример вызова
/ЕстьПраваАдминистратора?Пользователь={"Идентификатор": "e1cib/data/Справочник.яъПользователи?ref=9b7996e6d857ebf811e3a8f3c11af005"}
Пример ответа
развернуть

GetConstant

  • Тип HTTP-запроса: GET
  • Описание: Возвращает значение константы, свойства или настройки.

Параметры:

  • ID/Идентификатор - название требуемой константы или настройки / код требуемого свойства.
Пример вызова
/hs/KintAPI.hs/GetConstant?ID=ПроцентПредоплатыБрони
Пример ответа
развернуть

PostElement

Создание элемента справочника переданного вида. Параметры:

  • Вид: имя справочника в дереве метаданных или имя предопределенного элемента справочника яъКатегории.

Необязательные параметры:

  • ПоляПоиска: структура имен реквизитов и их значений, по которым будет выполняться поиск существующих элементов.
Пример запроса
/hs/KintAPI.hs/PostData?Method=PostElement&Вид=яъРейсы
Тело запроса (создание нового элемента)
{
"Наименование": "Новый рейс",
"ПунктОтправления": {"Идентификатор": "e1cib/data/Справочник.яъПунктыНазначения?ref=98335404a66e4a8111e976225ef1ac20"}
"ПунктПрибытия": {"Идентификатор": "e1cib/data/Справочник.яъПунктыНазначения?ref=98435404a66e4a8111ea6a959c446ea8"}
"Работа":
[
{
"ВидРабот": {"Идентификатор": "e1cib/data/Справочник.Номенклатура?ref=977bf46d0477991a11ee8d010588b413"},
"Количество": 10,
"ЕдиницаИзмерения": {"Идентификатор": "e1cib/data/Справочник.КлассификаторЕдиницИзмерения?ref=9b8e002590d756f511e7eb0759c329d2"}
}
]
}
Пример ответа
{
"Success": true,
"Result": {
"ПометкаУдаления": false,
"Предопределенный": false,
"ИмяПредопределенныхДанных": "",
"Наименование": "Новый рейс",
"Код": "000000004",
"ЭтоГруппа": false,
"Идентификатор": "e1cib/data/Справочник.яъРейсы?ref=977bf46d0477991a11ee929ce65408df"
}

Тело запроса (изменение существующего элемента)
{
"Наименование": "Измененный рейс",
"ПоляПоиска":
{
"Код": "000000004"
}
}
Пример ответа
{
"Success": true,
"Result": {
"ПометкаУдаления": false,
"Предопределенный": false,
"ИмяПредопределенныхДанных": "",
"Наименование": "Измененный рейс",
"Код": "000000004",
"ЭтоГруппа": false,
"Идентификатор": "e1cib/data/Справочник.яъРейсы?ref=977bf46d0477991a11ee929ce65408df"
}

ПолучитьИзмененияПоУзлу

Получение данных объектов, зарегистрированных в узле плана обмена.

Параметры:

  • Объекты: структура с параметрами для получения объектов или идентификаторы через «,».
    • ИдОбъекта: строка формата <Тип объекта>.<Вид объекта> - идентификатор объекта в конфигурации, перечень элементов которых нужно получить, например: «Справочник.Контрагенты», «Документ.ЗаявкаПокупателя», «ПланСчетов.МедицинскиеПоказатели». Для справочников доступно игнорирование указания типа.
    • Отбор: структура с отбором реквизитов для определенного объекта.
    • стрРеквизиты: реквизиты через «,» для получения.
  • Узел: узел плана обмена, по которому необходимо получить зарегистрированные объекты.

Необязательные параметры:

  • Отбор: структура с общим отбором реквизитов для всех получаемых объектов.
  • ОтменитьРегистрацию: отменять ли регистрацию объектов в узле после получения. По умолчанию - Истина.
  • КоличествоЭлементов: количество объектов в результате. Может быть задан для каждого объекта, так и для отдельного.
  • НомерСтраницы: Номер результата пагинации. Может быть задан для каждого объекта, так и для отдельного.
Пример запроса
/hs/KintAPI.hs/GetData?Method=ПолучитьИзмененияПоУзлу&Объекты=[{"ИдОбъекта":"яъФизическиеЛица","стрРеквизиты":"Наименование,Код"},{"ИдОбъекта":"Контрагенты","Отбор":{"Наименование":"Юридические лица"}}]&Узел={"Идентификатор":"e1cib/data/ПланОбмена.ОбменКУСБухгалтерия20?ref=9a4a60a44c379a5b11e91efe3f9ca517"}&Отбор={"ЭтоГруппа":true}&ОтменитьРегистрацию=Ложь
Пример ответа
развернуть
Пример запроса
/hs/KintAPI.hs/PostData?Method=ПолучитьИзмененияПоУзлуОбъекты=Документ.ЗаявкаГостя,Документ.Путевка&Узел={"Идентификатор":"e1cib/data/ПланОбмена.ОбменКУСБухгалтерия20?ref=9a4a60a44c379a5b11e91efe3f9ca517"}&Отбор={"Контрагент_ПометкаУдаления":true}
развернуть
Пример запроса с пагинацией
/hs/KintAPI.hs/GetData?Method=ПолучитьИзмененияПоУзлу&Узел={"Идентификатор": "e1cib/data/ПланОбмена.ОбменКУСБухгалтерия20?ref=bc74d85ed320709611ecbf16523724ef"}&Объекты=[{"ИдОбъекта": "Номенклатура", "стрРеквизиты": "Наименование"}, {"ИдОбъекта": "Контрагенты", "стрРеквизиты": "Наименование"}, {"ИдОбъекта": "яъФизическиеЛица", "стрРеквизиты": "Наименование", "КоличествоЭлементов": 20, "НомерСтраницы": 5}]&ОтменитьРегистрацию=Ложь&КоличествоЭлементов=10&НомерСтраницы=4

RelatedDocuments (СвязанныеДокументы)

  • Тип HTTP-запроса: GET
  • Описание: Получение массива подчиненных документов
Параметры
Наименование Обязателен? Тип данных Описание Пример
Документ Да ДокументСсылка Ссылка на документ для которого будут получены связанные документы {"id": "e1cib/data/Документ.яъЗаказ?ref=96d5708bcda2156111eef01513b24eef"}
ВидДокумента Нет Строка Имя вида документа для отбора подчиненных. Должно совпадать с именем документа в дереве метаданных конфигурации. Допустимо передавать массив из нескольких видов документов. 11
  • Пример вызова
    /GetData?Method=ПодчиненныеДокументы&ВидДокумента=СчетНаОплатуПокупателю

Пример ответа:

развернуть

КоличествоЭлементов

  • Тип HTTP-запроса: GET
  • Описание: Получение количества объектов
Параметры
Наименование Обязателен? Тип данных Описание Пример
ВидыОбъектов / ВидОбъекта Да Строка, Массив Тип объекта (По умолчанию справочник), вид объекта Организации,Документ.Путевка
Отбор / Filter Нет Структура Структура, указывающая, по каким реквизитам и их значениям необходимо делать отбор {"ИНН": "1835012280"}
Узел Нет Ссылка на узел плана обмена В результате окажется количество изменений по узлу {"Идентификатор": "e1cib/data/ПланОбмена.ОбменКУСБухгалтерия20?ref=9a4a60a44c379a5b11e91efe3f9ca517"}
КоличествоНаСтранице / CountOnPage Нет Число Количество элементов на странице, с указанным параметром будет выводится количество страниц 100
  • Пример вызова 1:
    /GetData?Method=КоличествоЭлементов&КоличествоНаСтранице=100&ВидОбъекта=яъФизическиеЛица

Пример ответа:

развернуть
  • Пример вызова 2 (Получение количества для нескольких объектов):
    /GetData?Method=КоличествоЭлементов&ВидыОбъектов=яъФизическиеЛица,Документ.КартаГостя,РегистрСведений.КурсыВалют

Пример ответа:

развернуть
  • Пример вызова 3 (Получение количества с общим отбором):
    /GetData?Method=КоличествоЭлементов&ВидыОбъектов=яъФизическиеЛица,Контрагенты,Сотрудники&Отбор={"Код": "000000001"}

Пример ответа:

развернуть
  • Пример вызова 4 (Получение количества с общим отбором, дополнительным отбором по физ. лицам, отключенным отбором по коду для сотрудников):
    /GetData?Method=КоличествоЭлементов&ВидыОбъектов=[{ "ВидОбъекта":"яъФизическиеЛица", "Отбор": {"Наименование": "Макадзару"} },{ "ВидОбъекта":"Контрагенты" },{ "ВидОбъекта":"Сотрудники", "Отбор": {"Код": ""} }]&Отбор={"Код": "000000001"}

Пример ответа:

развернуть
  • Пример вызова 5 (Получение количества изменений по общему узлу и получение количества физ. лиц по другому узлу):
    /GetData?Method=КоличествоЭлементов&ВидыОбъектов=[{ "ВидОбъекта":"яъФизическиеЛица" },{ "ВидОбъекта":"Контрагенты" },{ "ВидОбъекта":"Сотрудники"},{ "ВидОбъекта": "яъФизическиеЛица", "Узел": {"Идентификатор": "e1cib/data/ПланОбмена.ОбменКУСБухгалтерия20?ref=bc74d85ed320709611ecbf16523724ef"} }]&Узел={"Идентификатор": "e1cib/data/ПланОбмена.ОбменКУСБухгалтерия20?ref=9a4a60a44c379a5b11e91efe3f9ca517"}

Пример ответа:

развернуть

ЗаписатьПриложения

  • Тип HTTP-запроса: GET/POST
  • Описание: Запись приложений (например, картинок) к объекту. Можно отправлять как массив, так и структуру. Возвращает список индексов созданных приложений.
Параметры
Наименование Обязателен? Тип данных Описание Пример
Владелец Да Ссылка на объект Владелец приложения {"id": "e1cib/data/Справочник.яъКультуры?ref=96d5708bcda2156111eef01513b24eef"}
Индекс Нет Число С указанным параметром перезаписывает старое приложение 1
Файл Да Строка Данные файла в Base64-строке "/9j/4AAQSkZJRgABAQAAAQABAAD/2wCEAAkGBxMTEhUTExMV..."
Представление Да Строка Имя файла с расширением Арбуз.png
яъКомментарий Нет Строка Комментарий приложения Создан из приложения «Кинт: Мобильный ТСД»
  • Пример вызова
    /GetData?Method=ЗаписатьПриложения&Владелец={"id": "e1cib/data/Справочник.яъКультуры?ref=96d5708bcda2156111eef01513b24eef"}&Файл="/9j/4AAQSkZJRgABAQAAAQABAAD/2wCEAAkGBxMTEhUTExMV..."&Представление=Арбуз.png

Пример ответа:

развернуть

УдалитьПриложение

  • Тип HTTP-запроса: GET
  • Описание: Удаление приложения
Параметры
Наименование Обязателен? Тип данных Описание Пример
Владелец Да Ссылка на объект Владелец приложения {"id": "e1cib/data/Справочник.яъКультуры?ref=96d5708bcda2156111eef01513b24eef"}
Индекс Да Число Номер удаляемого приложения 11
  • Пример вызова
    /GetData?Method=УдалитьПриложение&Владелец={"id": "e1cib/data/Справочник.яъКультуры?ref=96d5708bcda2156111eef01513b24eef"}&Индекс=11

Пример ответа:

развернуть

СписокПриложений

  • Тип HTTP-запроса: GET
  • Описание: Получение списка приложений объекта
Параметры
Наименование Обязателен? Тип данных Описание Пример
Владелец Да Ссылка на объект Владелец приложений, которые хотим получить {"id": "e1cib/data/Справочник.яъФизическиеЛица?ref=96d5708bcda2156111eef01513b24eef"}
СФайлами Нет Булево Нужно ли получить файл в Base64-строке Истина
Колонки Нет Строка Список колонок, который необходимо получить в результате Представление,Индекс,яъКомментарий,ИндексТипаПриложения,Файл
  • Описание колонок в результате
    • Представление - представление приложения
    • Индекс - индекс приложения в пределах владельца
    • Автор - пользователь, добавивший приложение
    • Дата - дата добавления приложения
    • фВнешнее - приложение является ссылкой на файл
    • ВидПриложения - не используется
    • ПутьКДанным - полное имя файла, где хранится приложение
    • СостояниеПриложения - 1 (захвачено для редактирования), 0 (никем не редактируется)
    • яъКомментарий - комментарий приложения
    • ИндексТипаПриложения - 1 (картинка), 2 (каталог), 3 (URL-ссылка), 0 (всё остальное)?
    • Файл - файл в Base64-строке
    • Расширение - расширение файла
  • Пример вызова
    /GetData?Method=СписокПриложений&Владелец={"id": "e1cib/data/Справочник.яъКультуры?ref=96d5708bcda2156111eef01513b24eef"}&Колонки=Представление,Индекс,Дата,яъКомментарий,Файл&СФайлами=Истина

Пример ответа:

развернуть

СоздатьЗадачу (PostTask)

  • Тип HTTP-запроса: POST
  • Описание: Создание документа «Задача».


ПолучитьСписокЗадач (GetTaskList)

  • Тип HTTP-запроса: GET
  • Описание: Список документов с отбором.


ПолучитьСодержаниеЗадачи (GetTaskContent)

  • Тип HTTP-запроса: GET
  • Описание: Получает все комментарии по документу в формате HTML.


ПервыйКомментарий (GetFirstMessage)

  • Тип HTTP-запроса: GET
  • Описание: Получает первый комментарий по документу. Первый комментарий считается "Содержанием" документа.


ПоследнийКомментарий (GetLastMessage)

  • Тип HTTP-запроса: GET
  • Описание: Получает последний комментарий по документу.


ИзменитьЭтапПроцесса (ChangeProcessStage)

  • Тип HTTP-запроса: GET
  • Описание: Изменение этапа процесса документа.


ДобавитьКомментарий (PostMessage)

  • Тип HTTP-запроса: POST
  • Описание: Добавление комментария к документу.