Просмотр исходного текста страницы Общие методы API (Кинт)

<noinclude>[[Категория: API (Кинт)]]</noinclude>
{| align="right"
| __TOC__
|}
В данном разделе описаны методы, доступные в любой конфигурации. В скобках указано наименование кириллицей, если оно есть.

=== GetCatalog (СписокЭлементов) ===
* '''Тип HTTP-запроса''': GET
* '''Описание''': Возвращает перечень элементов по заданному отбору. Можно использовать для получения списка организаций, категорий номеров и прочего.

{| class="wikitable"
  |+Параметры
  !|Наименование
  !|Обязателен?
  !|Тип данных
  !|Описание
  !|Пример

  |-

  |<code>Вид</code> / <code>CatalogName</code>
  |Да
  |<code>Строка</code>
  |Имя объекта, из которого формируется выдача
  |<code>Организации</code>

  |-

  |<code>Отбор</code> / <code>Filter</code>
  |Нет
  |<code>Структура</code>
  |Структура, указывающая, по каким реквизитам и их значениям необходимо делать отбор
  |<code>{"ИНН": "1835012280"}</code>

  |-

  |<code>Тип</code> / <code>CatalogType</code>
  |Нет
  |<code>Строка</code>
  |Вид объекта, по умолчанию "Справочник".
  |<code>Справочник</code>

|}

* Пример вызова:
*; <pre>/GetData?Method=GetCatalog&CatalogName=Организации&Fields=Ссылка,ИНН,КПП</pre>
* Пример вызова для списка документов:
*; <pre>/GetData?Method=GetCatalog&CatalogName=ПоступлениеТоваровУслуг&CatalogType=Документ&Fields=Номер,Дата</pre>
* Пример вызова с отбором:
*; <pre>/GetData?Method=GetCatalog&CatalogName=Организации&Fields=Ссылка,ИНН,КПП&Filter={"ГоловнаяОрганизация":%20{"ID":"e1cib/data/Справочник.Организации?ref=ad5c5404a66e4a8911e37e83f3ef6892"}}</pre>
* Пример вызова с пагинацией:
*; <pre>GetData?Method=GetCatalog&CatalogName=яъФизическиеЛица&Fields=Наименование,Пол&PageNumber=24&CountOnPage=100&Filter={"Пол": "Перечисление.яъПол.Мужской"}</pre>
;Пример ответа:
<pre class="toccolours mw-collapsible mw-collapsed" style="width:600px; overflow:auto;">
{
    "Success": true,
    "Result":
    [
        {
            "Ссылка":
            {
                "Name": "ОАО санаторий \"Родные просторы\"",
                "ID": "e1cib/data/Справочник.Организации?ref=8e8150e54935bd5411e25bc6880bb616"
            },
            "ИНН": "1835012280",
            "КПП": "184101001"
        },
        {
            "Ссылка":
            {
                "Name": "ООО \"Италмас\"",
                "ID": "e1cib/data/Справочник.Организации?ref=b72f90e6baabdd1411e271b038722897"
            },
            "ИНН": "",
            "КПП": ""
        }
    ]
}
</pre>

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

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

;Пример ответа:
<pre class="toccolours mw-collapsible mw-collapsed" style="width:600px; overflow:auto;">
{
    "Success": true,
    "Result": {
        "ВерсияAPI": "1.1",
        "НомерРелиза": "21.11.01"
    }
}
</pre>

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

=== ОбъектПоНавигационнойСсылке ===
* '''Тип HTTP-запроса''': GET
* '''Описание''': 

{| class="wikitable"
  |+Параметры
  !|Наименование
  !|Обязателен?
  !|Тип данных
  !|Описание
  !|Пример

  |-

  |<code>НавигационнаяСсылка</code>
  |Да
  |<code>Строка</code>
  |Навигационная ссылка на объект в информационной базе
  |<code>e1cib/data/Справочник.яъФизическиеЛица?ref=9a6c5404a66e4a8911e5bb8e2aa0771f</code>
|}

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

Параметры:
* Объект (GUID, обязательный) - для кого получаем значение параметра
* ПечатнаяФорма (GUID, не обязательный только в случае получения значения параметра) - может использоваться для расширения списка параметров. Без печатной формы список параметров может быть ограничен.
* Формат (не обязательный только в случае получения значения параметра) - доступны значения: DOCX, HTML5, MXL, PDF, TXT, XLS
* ИмяПараметра (Строка, не обязательный) - если передан, то вернется не печатная форма, а значение переданного параметра. По умолчанию доступны параметры на вкладках «Основные» + «Доступные» + «Дополнительные» в форме настройки печатной формы.
* стрТипВыходныхДанных (Строка, не обязательный) - может использоваться тип данных Base64 или ДвоичныеДанные, в ином случае возвращает содержимое файла. Значение по умолчанию Base64.

;Пример вызова:
<pre>/GetData?Method=GetPrintForm&Объект={"GUID":%20"dc7970e4-e673-11e9-b48d-5404a66e4a89"}&ПечатнаяФорма={"GUID":%20"09c83fe6-f918-4388-a2ee-b0a3276941d4"}&Формат=PDF</pre>
;Пример ответа:
<pre class="toccolours mw-collapsible mw-collapsed" style="width:600px; overflow:auto;">
{
"Success": true,
"Result": "JVBERi0xLjcKJeLjz9MKMSAwIG9iago8PAovRmlsdGVyIC9GbGF0ZURlY29kZQovTGVuZ3RoIDIgMCBSCi9MZW5ndGgxIDU0Nzk2Ci9MZW5ndGgyIDAKL0 ... UlRU9GCg=="
}
</pre>
;Пример вызова для получения значения параметра:
<pre>/GetData?Method=GetPrintForm&Объект={"GUID":%20"dc7970e4-e673-11e9-b48d-5404a66e4a89"}&ПечатнаяФорма={"GUID":%20"09c83fe6-f918-4388-a2ee-b0a3276941d4"}&ИмяПараметра=ФизЛицо</pre>
;Пример ответа:
<pre class="toccolours mw-collapsible mw-collapsed" style="width:600px; overflow:auto;">
{
"Success": true,
"Result": {
"Наименование": "Иванов Иван Иванович",
"Код": "000000793 ",
"Идентификатор": "e1cib/data/Справочник.яъФизическиеЛица?ref=813b5404a66e4a8911e35761a7492167",
"ПометкаУдаления": false,
"ЭтоГруппа": false
}
}
</pre>

=== GetReport (РезультатУФО) ===
Позволяет получить результат отчета в переданном формате.

Параметры:
* Отчет (GUID, обязательный) - навигационная ссылка на отчет.
* ТипФайла - формат результата.
** JSON, CSV позволяют получить таблицу данных отчета
** XLSX, PDF, TXT, DOCX, MXL позволяют получить результат отчета в том же виде, в котором сохраняется табличный документ результата отчета в режиме «1С: Предприятие», данные закодированы в строку '''BASE64'''.

;Пример вызова:
<pre>/hs/KintAPI.hs/РезультатУФО?Отчет={"Идентификатор":%20"e1cib/data/Справочник.яъОтчеты?ref=9c415404a66e4a8911e4dcfb89878423"}&Формат=JSON</pre>
;Пример ответа:
<pre class="toccolours mw-collapsible mw-collapsed" style="width:600px; overflow:auto;">
{
"Success": true,
"Result": "[
{"Корпус": "Корпус 2","Заехало": 1,"ЗапланированЗаезд": 1},
{"Корпус": "Корпус 33","Заехало": 0,"ЗапланированЗаезд": 0}
]"
}
</pre>

=== GetDataSourceInfo (ОписаниеИсточникаДанных) ===
Позволяет получить описание источника данных в формате JSON.

Параметры:
* ИсточникДанных (GUID, обязательный) - навигационная ссылка на источник данных.

;Пример вызова:
<pre>/hs/KintAPI.hs/ОписаниеИсточникаДанных?ИсточникДанных=e1cib/data/Справочник.яъИсточникиДанных?ref=bca1d85ed320709611ed397243b5eb7d</pre>
;Пример ответа:
<pre class="toccolours mw-collapsible mw-collapsed" style="width:600px; overflow:auto;">
{
"Success": true,
"Result": "{"Наименование": "Тестовый источник данных","яъКатегория": "Запрос","яъКомментарий": "Используется для примеров и тестирования API","яъАвтор": "Иванов Иван","Измерения": "НомерСтроки,Наименование,Идентификатор,Физлицо,УчетнаяЗапись","Ресурсы": "Количество","Параметры": "","HTTPЗапрос": "http://localhost/base_name/hs/KintAPI.hs/ТаблицаИсточникаДанных?ИсточникДанных=e1cib/data/Справочник.яъИсточникиДанных?ref=bca1d85ed320709611ed397243b5eb7d"n}",
"Messages": []
}
</pre>

=== GetDataSource (ТаблицаИсточникаДанных) ===
Позволяет получить таблицу источника данных в формате JSON.

Параметры:
* ИсточникДанных (GUID, обязательный) - навигационная ссылка на источник данных.

;Пример вызова:
<pre>/hs/KintAPI.hs/ТаблицаИсточникаДанных?ИсточникДанных=e1cib/data/Справочник.яъИсточникиДанных?ref=bc79d85ed320709611e346049adc3ab1</pre>
;Пример вызова с передачей параметров формирования результата:
<pre>/hs/KintAPI.hs/ТаблицаИсточникаДанных?ИсточникДанных=e1cib/data/Справочник.яъИсточникиДанных?ref=bc79d85ed320709611e346049adc3ab1&НачалоПериода=01.01.2022&КонецПериода=31.01.2022&ИНН=123456788900&Измерения=Контрагент,Договор&Ресурсы=Количество,Сумма
</pre>
;Пример ответа:
<pre class="toccolours mw-collapsible mw-collapsed" style="width:600px; overflow:auto;">
{
"Success": true,
"Result": "[{"Дело": "Разное","Количество": 7},{"Дело": "КП","Количество": 2},{"Дело": "К:БУ","Количество": 1}]"
}
</pre>

=== ЕстьПраваАдминистратора ===
* '''Тип HTTP-запроса''': GET
* '''Описание''': Возвращает признак наличия администраторских прав у указанного пользователя.

{| class="wikitable"
  |+Параметры
  !|Наименование
  !|Обязателен?
  !|Тип данных
  !|Описание
  !|Пример

  |-

  |<code>Пользователь</code>
  |Да
  |<code>СправочникСсылка.яъПользователи</code>
  |Ссылка на пользователя, для которого выполняется проверка наличия прав администратора
  |<syntaxhighlight lang="json">{
    "Идентификатор": "e1cib/data/Справочник.яъПользователи?ref=9b7996e6d857ebf811e3a8f3c11af005"
}</syntaxhighlight>
|}

;Пример вызова:
<pre>
/ЕстьПраваАдминистратора?Пользователь={"Идентификатор": "e1cib/data/Справочник.яъПользователи?ref=9b7996e6d857ebf811e3a8f3c11af005"}
</pre>

;Пример ответа:
<pre class="toccolours mw-collapsible mw-collapsed" style="width:600px; overflow:auto;">
{
    "Success": true,
    "Result": true
}
</pre>

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

Параметры:
* '''ID/Идентификатор''' - название требуемой константы или настройки / код требуемого свойства.

;Пример вызова:
<pre>/hs/KintAPI.hs/GetConstant?ID=ПроцентПредоплатыБрони</pre>

;Пример ответа:
<pre class="toccolours mw-collapsible mw-collapsed" style="width:600px; overflow:auto;">
{
"Success": true,
"Result": 50,
"Messages": []
}
</pre>

=== PostElement ===
Создание элемента справочника переданного вида.
Параметры:
* '''Вид''': имя справочника в дереве метаданных или имя предопределенного элемента справочника '''яъКатегории'''.

Необязательные параметры:
* '''ПоляПоиска''': структура имен реквизитов и их значений, по которым будет выполняться поиск существующих элементов.

;Пример запроса:
<pre>
/hs/KintAPI.hs/PostData?Method=PostElement&Вид=яъРейсы
</pre>

;Тело запроса (создание нового элемента):
<pre>
{
"Наименование": "Новый рейс",
"ПунктОтправления": {"Идентификатор": "e1cib/data/Справочник.яъПунктыНазначения?ref=98335404a66e4a8111e976225ef1ac20"}
"ПунктПрибытия": {"Идентификатор": "e1cib/data/Справочник.яъПунктыНазначения?ref=98435404a66e4a8111ea6a959c446ea8"}
"Работа":
[
{
"ВидРабот": {"Идентификатор": "e1cib/data/Справочник.Номенклатура?ref=977bf46d0477991a11ee8d010588b413"},
"Количество": 10,
"ЕдиницаИзмерения": {"Идентификатор": "e1cib/data/Справочник.КлассификаторЕдиницИзмерения?ref=9b8e002590d756f511e7eb0759c329d2"}
}
]
}
</pre>

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

</pre>
;Тело запроса (изменение существующего элемента):
<pre>
{
"Наименование": "Измененный рейс",
"ПоляПоиска":
{
"Код": "000000004"
}
}
</pre>

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

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

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

Необязательные параметры:
* '''Отбор''': структура с общим отбором реквизитов для всех получаемых объектов.
* '''ОтменитьРегистрацию''': отменять ли регистрацию объектов в узле после получения. По умолчанию - Истина.
* '''КоличествоЭлементов''': количество объектов в результате. Может быть задан для каждого объекта, так и для отдельного.
* '''НомерСтраницы''': Номер результата пагинации. Может быть задан для каждого объекта, так и для отдельного.

;Пример запроса:
<pre>
/hs/KintAPI.hs/GetData?Method=ПолучитьИзмененияПоУзлу&Объекты=[{"ИдОбъекта":"яъФизическиеЛица","стрРеквизиты":"Наименование,Код"},{"ИдОбъекта":"Контрагенты","Отбор":{"Наименование":"Юридические лица"}}]&Узел={"Идентификатор":"e1cib/data/ПланОбмена.ОбменКУСБухгалтерия20?ref=9a4a60a44c379a5b11e91efe3f9ca517"}&Отбор={"ЭтоГруппа":true}&ОтменитьРегистрацию=Ложь
</pre>

;Пример ответа:
<pre class="toccolours mw-collapsible mw-collapsed" style="width:600px; overflow:auto;">
[
{
"Справочник_яъФизическиеЛица": [
{
"Name": "Старше 70",
"Code": "t010003619"
}
]
},
{
"Справочник_Контрагенты": [
{
"Ссылка": {
"ПометкаУдаления": false,
"Предопределенный": false,
"ИмяПредопределенныхДанных": "",
"Наименование": "Юридические лица",
"Код": "Т000936  ",
"ЭтоГруппа": true,
"Идентификатор": "e1cib/data/Справочник.Контрагенты?ref=951ba85e4511756911eec66dccd475d9"
}
}
]
}
]
</pre>

;Пример запроса:
<pre>
/hs/KintAPI.hs/PostData?Method=ПолучитьИзмененияПоУзлуОбъекты=Документ.ЗаявкаГостя,Документ.Путевка&Узел={"Идентификатор":"e1cib/data/ПланОбмена.ОбменКУСБухгалтерия20?ref=9a4a60a44c379a5b11e91efe3f9ca517"}&Отбор={"Контрагент_ПометкаУдаления":true}
</pre>

<pre class="toccolours mw-collapsible mw-collapsed" style="width:600px; overflow:auto;">
[
{
"Документ_ЗаявкаГостя": [
{
"Ссылка": {
"Дата": "2023-11-27T16:58:25",
"Номер": "23/000000000039",
"Идентификатор": "e1cib/data/Документ.ЗаявкаГостя?ref=bca6d85ed320709611ee8d24a1e9d7c7"
}
}
],
},
{
"Документ_Путевка": [
{
"Ссылка": {
"Дата": "2020-02-26T17:20:59",
"Номер": "З-19/00046     ",
"Идентификатор": "e1cib/data/Документ.Путевка?ref=9a58f2e8cf1cc29211ea589ae325f1b1"
}
},
{
"Ссылка": {
"Дата": "2021-09-02T15:33:44",
"Номер": "21/00043       ",
"Идентификатор": "e1cib/data/Документ.Путевка?ref=9a6b60a44c379a5b11ec0be19fda8385"
}
},
{
"Ссылка": {
"Дата": "2017-03-20T12:15:07",
"Номер": "demАЛ-0654624  ",
"Идентификатор": "e1cib/data/Документ.Путевка?ref=845c60a44c379a5b11e70d4ddd07d0a4"
}
},
{
"Ссылка": {
"Дата": "2017-03-20T12:43:26",
"Номер": "demАЛ-0654625  ",
"Идентификатор": "e1cib/data/Документ.Путевка?ref=845c60a44c379a5b11e70d519dffcf81"
}
},
{
"Ссылка": {
"Дата": "2016-11-29T14:52:39",
"Номер": "demАЛ-0654581  ",
"Идентификатор": "e1cib/data/Документ.Путевка?ref=980360a44c379a5b11e6b62b1b6435e6"
}
}
]
}
]
</pre>

;Пример запроса с пагинацией:
<pre>
/hs/KintAPI.hs/GetData?Method=ПолучитьИзмененияПоУзлу&Узел={"Идентификатор": "e1cib/data/ПланОбмена.ОбменКУСБухгалтерия20?ref=bc74d85ed320709611ecbf16523724ef"}&Объекты=[{"ИдОбъекта": "Номенклатура", "стрРеквизиты": "Наименование"}, {"ИдОбъекта": "Контрагенты", "стрРеквизиты": "Наименование"}, {"ИдОбъекта": "яъФизическиеЛица", "стрРеквизиты": "Наименование", "КоличествоЭлементов": 20, "НомерСтраницы": 5}]&ОтменитьРегистрацию=Ложь&КоличествоЭлементов=10&НомерСтраницы=4
</pre>

=== КоличествоЭлементов ===
* '''Тип HTTP-запроса''': GET
* '''Описание''': Получение количества объектов

{| class="wikitable"
  |+Параметры
  !|Наименование
  !|Обязателен?
  !|Тип данных
  !|Описание
  !|Пример

  |-

  |<code>ВидыОбъектов</code> / <code>ВидОбъекта</code>
  |Да
  |<code>Строка</code>, <code>Массив</code>
  |Тип объекта (По умолчанию справочник), вид объекта
  |<code>Организации,Документ.Путевка</code>

  |-

  |<code>Отбор</code> / <code>Filter</code>
  |Нет
  |<code>Структура</code>
  |Структура, указывающая, по каким реквизитам и их значениям необходимо делать отбор
  |<code>{"ИНН": "1835012280"}</code>

  |-

  |<code>Узел</code>
  |Нет
  |<code>Ссылка на узел плана обмена</code>
  |В результате окажется количество изменений по узлу
  |<code>{"Идентификатор": "e1cib/data/ПланОбмена.ОбменКУСБухгалтерия20?ref=9a4a60a44c379a5b11e91efe3f9ca517"}</code>

  |-

|<code>КоличествоНаСтранице</code> / <code>CountOnPage</code>
  |Нет
  |<code>Число</code>
  |Количество элементов на странице, с указанным параметром будет выводится количество страниц
  |<code>100</code>

  |-

|}

* Пример вызова 1:
*; <pre>/GetData?Method=КоличествоЭлементов&КоличествоНаСтранице=100&ВидОбъекта=яъФизическиеЛица</pre>
Пример ответа:
<pre class="toccolours mw-collapsible mw-collapsed" style="width:600px; overflow:auto;">
    [
        {
            "ВидОбъекта": "Справочник.яъФизическиеЛица",
            "КоличествоОбъектов": 6733,
            "КоличествоСтраниц": 68
        }
    ]
</pre>
* Пример вызова 2 (Получение количества для нескольких объектов):
*; <pre>/GetData?Method=КоличествоЭлементов&ВидыОбъектов=яъФизическиеЛица,Документ.КартаГостя,РегистрСведений.КурсыВалют</pre>
Пример ответа:
<pre class="toccolours mw-collapsible mw-collapsed" style="width:600px; overflow:auto;">
    [
        {
            "ВидОбъекта": "Справочник.яъФизическиеЛица",
            "КоличествоОбъектов": 6764
        },
        {
            "ВидОбъекта": "Документ.КартаГостя",
            "КоличествоОбъектов": 3000
        },
        {
            "ВидОбъекта": "РегистрСведений.КурсыВалют",
            "КоличествоОбъектов": 3
        }
    ]
</pre>
* Пример вызова 3 (Получение количества с общим отбором):
*; <pre>/GetData?Method=КоличествоЭлементов&ВидыОбъектов=яъФизическиеЛица,Контрагенты,Сотрудники&Отбор={"Код": "000000001"}</pre>
Пример ответа:
<pre class="toccolours mw-collapsible mw-collapsed" style="width:600px; overflow:auto;">
    [
        {
            "ВидОбъекта": "Справочник.яъФизическиеЛица",
            "КоличествоОбъектов": 1
        },
        {
            "ВидОбъекта": "Справочник.Контрагенты",
            "КоличествоОбъектов": 1
        },
        {
            "ВидОбъекта": "Справочник.Сотрудники",
            "КоличествоОбъектов": 0
        }
    ]
</pre>
* Пример вызова 4 (Получение количества с общим отбором, дополнительным отбором по физ. лицам, отключенным отбором по коду для сотрудников):
*; <pre>/GetData?Method=КоличествоЭлементов&ВидыОбъектов=[{ "ВидОбъекта":"яъФизическиеЛица", "Отбор": {"Наименование": "Макадзару"} },{ "ВидОбъекта":"Контрагенты" },{ "ВидОбъекта":"Сотрудники", "Отбор": {"Код": ""} }]&Отбор={"Код": "000000001"}</pre>
Пример ответа:
<pre class="toccolours mw-collapsible mw-collapsed" style="width:600px; overflow:auto;">
    [
        {
            "ВидОбъекта": "Справочник.яъФизическиеЛица",
            "КоличествоОбъектов": 0
        },
        {
            "ВидОбъекта": "Справочник.Контрагенты",
            "КоличествоОбъектов": 1
        },
        {
            "ВидОбъекта": "Справочник.Сотрудники",
            "КоличествоОбъектов": 124
        }
    ]
</pre>

* Пример вызова 5 (Получение количества изменений по общему узлу и получение количества физ. лиц по другому узлу):
*; <pre>/GetData?Method=КоличествоЭлементов&ВидыОбъектов=[{ "ВидОбъекта":"яъФизическиеЛица" },{ "ВидОбъекта":"Контрагенты" },{ "ВидОбъекта":"Сотрудники"},{ "ВидОбъекта": "яъФизическиеЛица", "Узел": {"Идентификатор": "e1cib/data/ПланОбмена.ОбменКУСБухгалтерия20?ref=bc74d85ed320709611ecbf16523724ef"} }]&Узел={"Идентификатор": "e1cib/data/ПланОбмена.ОбменКУСБухгалтерия20?ref=9a4a60a44c379a5b11e91efe3f9ca517"}</pre>
Пример ответа:
<pre class="toccolours mw-collapsible mw-collapsed" style="width:600px; overflow:auto;">
    [
        {
            "ВидОбъекта": "Справочник.яъФизическиеЛица",
            "КоличествоОбъектов": 6733
        },
        {
            "ВидОбъекта": "Справочник.Контрагенты",
            "КоличествоОбъектов": 3050
        },
        {
            "ВидОбъекта": "Справочник.Сотрудники",
            "КоличествоОбъектов": 124
        },
        {
            "ВидОбъекта": "Справочник.яъФизическиеЛица",
            "КоличествоОбъектов": 622
        }
    ]
</pre>

=== ЗаписатьПриложения ===
* '''Тип HTTP-запроса''': GET/POST
* '''Описание''': Запись приложений (например, картинок) к объекту. Можно отправлять как массив, так и структуру. Возвращает список индексов созданных приложений.

{| class="wikitable"
  |+Параметры
  !|Наименование
  !|Обязателен?
  !|Тип данных
  !|Описание
  !|Пример

  |-

  |<code>Владелец</code>
  |Да
  |<code>Ссылка на объект</code>
  |Владелец приложения
  |<code>{"id": "e1cib/data/Справочник.яъКультуры?ref=96d5708bcda2156111eef01513b24eef"}</code>

  |-

  |<code>Индекс</code>
  |Нет
  |<code>Число</code>
  |С указанным параметром перезаписывает старое приложение
  |<code>1</code>

  |-

  |<code>Файл</code>
  |Да
  |<code>Строка</code>
  |Данные файла в Base64-строке
  |<code>"/9j/4AAQSkZJRgABAQAAAQABAAD/2wCEAAkGBxMTEhUTExMV..."</code>

  |-

  |<code>Представление</code>
  |Да
  |<code>Строка</code>
  |Имя файла с расширением
  |<code>Арбуз.png</code>

  |-

  |<code>яъКомментарий</code>
  |Нет
  |<code>Строка</code>
  |Комментарий приложения
  |<code>Создан из приложения «Кинт: Мобильный ТСД»</code>
|}

* Пример вызова
*; <pre>/GetData?Method=ЗаписатьПриложения&Владелец={"id": "e1cib/data/Справочник.яъКультуры?ref=96d5708bcda2156111eef01513b24eef"}&Файл="/9j/4AAQSkZJRgABAQAAAQABAAD/2wCEAAkGBxMTEhUTExMV..."&Представление=Арбуз.png</pre>
Пример ответа:
<pre class="toccolours mw-collapsible mw-collapsed" style="width:600px; overflow:auto;">
    [
        {
            "Индекс": 11
        }
    ]
</pre>

=== УдалитьПриложение ===
* '''Тип HTTP-запроса''': GET
* '''Описание''': Удаление приложения

{| class="wikitable"
  |+Параметры
  !|Наименование
  !|Обязателен?
  !|Тип данных
  !|Описание
  !|Пример

  |-

  |<code>Владелец</code>
  |Да
  |<code>Ссылка на объект</code>
  |Владелец приложения
  |<code>{"id": "e1cib/data/Справочник.яъКультуры?ref=96d5708bcda2156111eef01513b24eef"}</code>

  |-

  |<code>Индекс</code>
  |Да
  |<code>Число</code>
  |Номер удаляемого приложения
  |<code>11</code>
|}

* Пример вызова
*; <pre>/GetData?Method=УдалитьПриложение&Владелец={"id": "e1cib/data/Справочник.яъКультуры?ref=96d5708bcda2156111eef01513b24eef"}&Индекс=11</pre>
Пример ответа:
<pre class="toccolours mw-collapsible mw-collapsed" style="width:600px; overflow:auto;">
    true
</pre>

=== СписокПриложений ===
* '''Тип HTTP-запроса''': GET
* '''Описание''': Получение списка приложений объекта

{| class="wikitable"
  |+Параметры
  !|Наименование
  !|Обязателен?
  !|Тип данных
  !|Описание
  !|Пример

  |-

  |<code>Владелец</code>
  |Да
  |<code>Ссылка на объект</code>
  |Владелец приложений, которые хотим получить
  |<code>{"id": "e1cib/data/Справочник.яъФизическиеЛица?ref=96d5708bcda2156111eef01513b24eef"}</code>
  
  |-

  |<code>СФайлами</code>
  |Нет
  |<code>Булево</code>
  |Нужно ли получить файл в Base64-строке
  |<code>Истина</code>

  |-

  |<code>Колонки</code>
  |Нет
  |<code>Строка</code>
  |Список колонок, который необходимо получить в результате
  |<code>Представление,Индекс,яъКомментарий,ИндексТипаПриложения,Файл</code>
|}

* '''Описание колонок в результате'''
** Представление - представление приложения
** Индекс - индекс приложения в пределах владельца
** Автор - пользователь, добавивший приложение
** Дата - дата добавления приложения
** фВнешнее - приложение является ссылкой на файл
** ВидПриложения - не используется
** ПутьКДанным - полное имя файла, где хранится приложение
** СостояниеПриложения - 1 (захвачено для редактирования), 0 (никем не редактируется)
** яъКомментарий - комментарий приложения
** ИндексТипаПриложения - 1 (картинка), 2 (каталог), 3 (URL-ссылка), 0 (всё остальное)?
** Файл - файл в Base64-строке
** Расширение - расширение файла

* Пример вызова
*; <pre>/GetData?Method=СписокПриложений&Владелец={"id": "e1cib/data/Справочник.яъКультуры?ref=96d5708bcda2156111eef01513b24eef"}&Колонки=Представление,Индекс,Дата,яъКомментарий,Файл&СФайлами=Истина</pre>
Пример ответа:
<pre class="toccolours mw-collapsible mw-collapsed" style="width:600px; overflow:auto;">
    [
        {
            "Представление": "images.jpeg",
            "Индекс": 1,
            "Дата": "2024-09-17T18:33:57",
            "яъКомментарий": "",
            "Файл": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wCEAAkGBxMTEhUTExMV..."
        }
    ]
</pre>

=== СоздатьЗадачу (PostTask)  ===
* '''Тип HTTP-запроса''': POST
* '''Описание''': Создание документа «Задача».


=== ПолучитьСписокЗадач (GetTaskList)  ===
* '''Тип HTTP-запроса''': GET
* '''Описание''': Список документов с отбором.


=== ПолучитьСодержаниеЗадачи (GetTaskContent)  ===
* '''Тип HTTP-запроса''': GET
* '''Описание''': Получает все комментарии по документу в формате HTML.


=== ПервыйКомментарий (GetFirstMessage)  ===
* '''Тип HTTP-запроса''': GET
* '''Описание''': Получает первый комментарий  по документу. Первый комментарий считается "Содержанием" документа.


=== ПоследнийКомментарий (GetLastMessage)  ===
* '''Тип HTTP-запроса''': GET
* '''Описание''': Получает последний комментарий по документу.


=== ИзменитьЭтапПроцесса (ChangeProcessStage)  ===
* '''Тип HTTP-запроса''': GET
* '''Описание''': Изменение этапа процесса документа.


=== ДобавитьКомментарий (PostMessage) ===
* '''Тип HTTP-запроса''': POST
* '''Описание''': Добавление комментария к документу.