Выполнить произвольный запрос

POST

https://business.tbank.ru/openapi/hs/knapApi/execute

Выполняет произвольный запрос (SELECT) к базе данных 1С. Позволяет передать параметризованный запрос и получить результат в виде массива объектов.

Авторизация

Security

Bearer API Token

RPS

Ограничение — 20 запросов в секунду

Scopes

Интеграция с КНАП → Методы для работы с документами в Бухгалтерии

Запрос

Header parameters

X-Request-Id

String<uuid>

Уникальный идентификатор для трассировки запроса. Не влияет на логику исполнения запроса.

Request body schema application/json

Required

Query

String

Requirements: <= 10000 characters

Текст запроса в формате языка запросов 1С.

Params

Array of objects ()

Requirements: <= 100 items

Список параметров запроса.

Required

Name

String

Requirements: <= 100 characters

Имя параметра (без &).

Required

Type

String

Requirements: [String, Number, Date, Boolean, GuidReference, Enum, Default, SimpleGuid]

Тип значения параметра.

Required

Value

Object

Значение параметра.

oneOf

MOD1
MOD2
MOD3

string

ManagerName

String

Requirements: <= 150 characters

Имя менеджера объекта.

Required

Select

Array of objects ()

Requirements: <= 500 items

Описание структуры результата запроса.

Required

Alias

String

Requirements: <= 150 characters

Имя поля в результате запроса (после КАК).

Required

ModelFieldName

String

Requirements: <= 150 characters

Имя поля в выходной структуре.

Required

Type

String

Requirements: [String, Number, Date, Boolean, GuidReference, Enum, OneCObject, Default, EntityId, SimpleGuid, Types]

Тип значения.

Ответ

200

Результат выполнения запроса.

400

Некорректный запрос

401

Ошибка аутентификации

403

Ошибка авторизации

422

Ошибка при обработке данных

429

Слишком много запросов

500

Ошибка сервера

Это полезный материал?

Обратиться в поддержку