{ "openapi": "3.0.2", "info": { "title": "Quick Resto Back Office API", "description": "Quick Resto Back Office представляет собой сервер, клиенты которого передают на сервер запросы в формате JSON по протоколу HTTPS, используя методы GET и POST.", "contact": { "name": "Support", "email": "support@quickresto.ru" }, "license": { "name": "Лицензионное соглашение", "url": "https://quickresto.ru/licenseAgreement/" }, "version": "2.92", "x-logo": { "url": "/upload/api/logo.png", "backgroundColor": "#FFFFFF", "altText": "Example logo", "href": "https://quickresto.ru" } }, "servers": [ { "url": "https://{layer_name}.quickresto.ru/platform/online", "description": "базовый URL сервера", "variables": { "layer_name": { "default": "demo", "description": "Имя облака" } } } ], "security": [ { "basicAuth": [] } ], "tags": [ { "name": "Справочник", "description": "" }, { "name": "Настройки", "description": "" }, { "name": "Организации", "description": "" }, { "name": "Единицы измерения", "description": "" }, { "name": "Причины списания", "description": "" }, { "name": "Фасовки", "description": "" }, { "name": "Типы оплат", "description": "" }, { "name": "Тэги", "description": "" }, { "name": "НДС", "description": "" }, { "name": "Типы бонусных счетов", "description": "" }, { "name": "Клиенты", "description": "" }, { "name": "Группы клиентов", "description": "" }, { "name": "Бонусные программы", "description": "" }, { "name": "Фиксированные скидки", "description": "" }, { "name": "Фиксированные надбавки", "description": "" }, { "name": "Надбавки по расписанию", "description": "" }, { "name": "Акции", "description": "" }, { "name": "Скидки по расписанию", "description": "" }, { "name": "Доставка", "description": "" }, { "name": "Счета", "description": "" }, { "name": "Отмены", "description": "" }, { "name": "Внесения/инкассации", "description": "" }, { "name": "Чеки", "description": "" }, { "name": "Пречеки", "description": "" }, { "name": "Заведения", "description": "" }, { "name": "Терминалы", "description": "" }, { "name": "Фискальные регистраторы", "description": "" }, { "name": "Банковские терминалы", "description": "" }, { "name": "СБП", "description": "" }, { "name": "Принтеры", "description": "" }, { "name": "Кассовые смены", "description": "" }, { "name": "Сотрудники", "description": "" }, { "name": "Должности", "description": "" }, { "name": "Акты приготовления", "description": "" }, { "name": "Акты разбора", "description": "" }, { "name": "Заявки", "description": "" }, { "name": "Акты списания", "description": "" }, { "name": "Внутренние перемещения", "description": "" }, { "name": "Приходные накладные", "description": "" }, { "name": "Расходные накладные", "description": "" }, { "name": "Акты переработки", "description": "" }, { "name": "Акты инвентаризации", "description": "" }, { "name": "Места приготовления", "description": "" }, { "name": "Блюда", "description": "" }, { "name": "Модификаторы", "description": "" }, { "name": "Места реализации", "description": "" }, { "name": "Полуфабрикаты", "description": "" }, { "name": "Ингредиенты", "description": "" }, { "name": "Контрагенты", "description": "" }, { "name": "Склады", "description": "" } ], "x-tagGroups": [ { "name": "Продажи", "tags": [ "Чеки", "Пречеки", "Отмены", "Внесения/инкассации", "Кассовые смены", "Предзаказы", "Открытые заказы" ] }, { "name": "Номенклатура", "tags": [ "Блюда", "Модификаторы", "Ингредиенты", "Полуфабрикаты", "Меню" ] }, { "name": "Складские документы", "tags": [ "Приходные накладные", "Расходные накладные", "Внутренние перемещения", "Акты списания", "Акты приготовления", "Акты разбора", "Акты переработки", "Акты инвентаризации", "Заявки" ] }, { "name": "CRM", "tags": [ "Клиенты", "Группы клиентов", "Фиксированные скидки", "Скидки по расписанию", "Фиксированные надбавки", "Надбавки по расписанию", "Типы бонусных счетов", "Бонусные программы", "Акции" ] }, { "name": "Алкоголь", "tags": [ "Справочник", "Отчет" ] }, { "name": "Финансы", "tags": [ "Статьи", "Счета", "Транзакции", "Финансовый отчет", "Движение по счетам" ] }, { "name": "Персонал", "tags": [ "Сотрудники", "Должности" ] }, { "name": "Справочники", "tags": [ "Единицы измерения", "Тэги", "Контрагенты", "Причины списания", "Типы оплат", "Фасовки", "НДС", "Условия рассылки", "Отметки заказов" ] }, { "name": "Предприятие", "tags": [ "Настройки", "Организации", "Уведомления", "Склады", "Места приготовления", "Места реализации", "Заведения", "Доставка" ] }, { "name": "Терминалы и устройства", "tags": [ "Терминалы", "Фискальные регистраторы", "Банковские терминалы", "Принтеры", "Процессинг", "СБП" ] } ], "components": { "securitySchemes": { "basicAuth": { "type": "http", "scheme": "basic" } }, "responses": {}, "parameters": { "contentType": { "in": "header", "name": "Content-Type", "required": true, "schema": { "type": "string", "enum": [ "application/json" ] } }, "connection": { "in": "header", "name": "Connection", "required": true, "schema": { "type": "string", "enum": [ "keep-alive" ] } } }, "schemas": {} }, "paths": { "/bonuses/filterCustomers": { "post": { "description": "Получить список клиентов CRM по фильтру", "summary": "Клиенты: поиск", "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/crmios.filterCustomers.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "search": { "type": "string", "example": "Пехтерев" }, "typeList": { "type": "array", "items": { "type": "string", "enum": [ "customer" ], "description": "Должно быть только 'customer'." }, "minItems": 1, "maxItems": 1, "example": [ "customer" ] }, "limit": { "type": "integer", "example": 150 }, "offset": { "type": "integer", "example": 0 } }, "required": [ "search" ] } } } }, "operationId": "filterCustomers", "tags": [ "Клиенты" ] } }, "/bonuses/putCustomer": { "post": { "description": "Редактировать данные клиента", "summary": "Клиент: редактировать", "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/crmios.putCustomer.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "customerGuid": { "type:": "string", "description": "Уникальный идентификатор клиента", "example": "customer_put-180725100130889x" }, "version": { "type": "integer", "description": "Версия объекта для отслеживания изменений", "example": 5 }, "firstName": { "type": "string", "description": "Имя", "example": "Виталий", "nullable": true }, "middleName": { "type": "string", "description": "Отчество", "example": "Павлович", "nullable": true }, "lastName": { "type": "string", "description": "Фамилия", "example": "Пехтерев", "nullable": true }, "sex": { "type": "string", "description": "Пол", "enum": [ "male", "female" ], "example": "male" }, "dateOfBirth": { "type": "string", "format": "date-time", "description": "Дата рождения в формате dateTime", "example": "2009-05-07T18:00:00.000Z", "nullable": true }, "comment": { "type": "string", "description": "Комментарий", "example": "Частый гость", "nullable": true }, "contactMethods": { "type": "array", "description": "Контактная информация клиента", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "Тип контакта", "enum": [ "phoneNumber", "eMail" ], "example": "eMail" }, "value": { "type": "string", "description": "Значение контакта", "example": "v.pehterev@gmail.com" } } } }, "tokens": { "type": "array", "description": "Список токенов", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "Тип токена", "enum": [ "card", "qrGuest", "phone" ], "example": "card" }, "entry": { "type": "string", "description": "Метод ввода токена", "enum": [ "trackCode", "barCode", "qrCode", "manual" ], "example": "trackCode" }, "key": { "type": "string", "description": "Ключ токена", "example": "111" } } } }, "addresses": { "type": "array", "description": "Список адресов клиента", "nullable": true, "items": { "type": "object", "properties": { "type": { "type": "string", "description": "Тип адреса\n\n `locationSummary` - адрес одной строкой\n `fullAddress` - адрес разделенный на объекты с возможным объектом геолокации", "enum": [ "locationSummary", "fullAddress" ], "example": "locationSummary" }, "locationSummary": { "type": "string", "description": "Адрес одной строкой\n\nНе `null`, если тип адреса `locationSummary`", "example": "г. Москва, Охотный Ряд, 2, кв. 45", "nullable": true }, "fullAddress": { "type": "string", "description": "Адрес, разделенный на объекты с возможным объектом геолокации\n\nНе `null`, если тип адреса `fullAddress`", "example": "г. Москва, Охотный Ряд, 2", "nullable": true }, "office": { "type": "string", "description": "Квартира или номер офиса", "example": "45а", "nullable": true }, "floor": { "type": "string", "description": "Этаж", "example": "2", "nullable": true }, "doorcode": { "type": "string", "description": "Домофон", "example": "317", "nullable": true }, "entrance": { "type": "string", "description": "Подъезд", "example": "3", "nullable": true }, "comment": { "type": "string", "description": "Комментарий к адресу", "example": "Вход со двора", "nullable": true }, "geocoding": { "type": "object", "description": "Объект геокодирования", "properties": { "datasource": { "type": "string", "description": "Источник данных для геокодирования", "enum": [ "osm", "yandex" ], "example": "osm" }, "longitude": { "type": "number", "format": "float", "description": "Долгота", "example": 123.1432344 }, "latitude": { "type": "number", "format": "float", "description": "Широта", "example": -123.1432344 }, "country": { "type": "string", "description": "Страна", "example": "Россия" }, "countrycode": { "type": "string", "description": "Код страны в формате ISO 3166 Country Codes", "example": "RU" }, "city": { "type": "string", "description": "Город", "example": "Магнитогорск" }, "street": { "type": "string", "description": "Улица", "example": "Советская улица" }, "house": { "type": "string", "description": "Номер дома (включая дробь и корпус)", "example": "5/1 кп. 3" }, "date": { "type": "string", "format": "date-time", "description": "Дата получения данных из сервиса геокодинга", "example": "2014-05-27T17:41:40Z" } } } } } }, "createTerminalSalePlaceDocId": { "type": "string", "description": "Место реализации", "example": "sale_place-180725100130889x" } }, "required": [] } } } }, "operationId": "putCustomer", "tags": [ "Клиенты" ] } }, "/bonuses/getCustomer": { "post": { "description": "Получить информацию о клиенте", "summary": "Клиент: информация", "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/crmios.getCustomer.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "customerGuid": { "type": "string", "example": "customer_put-180725100130889x" } }, "required": [ "customerGuid" ] } } } }, "operationId": "getCustomer", "tags": [ "Клиенты" ] } }, "/bonuses/authorizeCustomer": { "post": { "description": "Авторизация клиента по токену", "summary": "Клиенты: авторизация", "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/crmios.authorizeCustomer.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "typeList": { "type": "array", "items": { "type": "string", "enum": [ "customer", "promocode", null ] }, "description": "Список типов клиента.\n * `customer` - клиент\n * `promocode` - промокод\n * `null` - тип неизвестен " }, "customerToken": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "card", "qrGuest", "phone", "guid" ], "description": "Тип токена" }, "entry": { "type": "string", "enum": [ "trackCode", "barCode", "qrCode", "manual", "guid" ], "description": "Способ ввода" }, "key": { "type": "string", "nullable": false, "description": "Значение" } }, "required": [ "key", "entry", "type" ], "description": "Токен авторизации клиента" } }, "required": [ "customerToken" ] } } } }, "operationId": "authorizeCustomer", "tags": [ "Клиенты" ] } }, "/bonuses/balance": { "post": { "description": "Получить баланс бонусного счета клиента", "summary": "Клиент: запрос баланса", "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" } ], "responses": { "200": { "$ref": "./components/responses/200.json" }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "customerToken": { "type": "object", "description": "Токен клиента", "properties": { "type": { "type": "string", "enum": [ "card", "qrGuest", "pin", "phone" ], "description": "Тип токена\n * `card` - карта\n * `qrGuest` - приложение “QR Guest”\n * `pin` - PIN-код\n * `phone` - номер телефона" }, "entry": { "type": "string", "description": "Режим ввода токена\n * `trackCode` - ввод магнитной полосы карты\n * `barCode` - ввод штрих-кода карты\n * `qrCode` - ввод QR-кода с приложения “QR Guest”\n * `manual` - ручной ввод PIN-кода или номера телефона", "enum": [ "trackCode", "barCode", "qrCode", "manual" ] }, "key": { "type": "string", "description": "Значение токена" } }, "required": [ "type", "entry", "key" ] }, "accountType": { "type": "object", "description": "Тип бонусного счета", "properties": { "accountGuid": { "type": "string", "description": "Идентификатор типа бонусного счета" } }, "required": [ "accountGuid" ] } }, "required": [ "customerToken", "accountType" ] } } } }, "operationId": "ClientBalance", "tags": [ "Клиенты" ] } }, "/bonuses/operationHistory": { "post": { "description": "Получить историю операций по бонусному счету клиента", "summary": "Клиент: история операций по бонусному счету", "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" } ], "responses": { "200": { "$ref": "./components/responses/200.json" }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "customerToken": { "type": "object", "description": "Токен клиента", "properties": { "type": { "type": "string", "enum": [ "card", "qrGuest", "pin", "phone" ], "description": "Тип токена\n * `card` - карта\n * `qrGuest` - приложение “QR Guest”\n * `pin` - PIN-код\n * `phone` - номер телефона" }, "entry": { "type": "string", "description": "Режим ввода токена\n * `trackCode` - ввод магнитной полосы карты\n * `barCode` - ввод штрих-кода карты\n * `qrCode` - ввод QR-кода с приложения “QR Guest”\n * `manual` - ручной ввод PIN-кода или номера телефона", "enum": [ "trackCode", "barCode", "qrCode", "manual" ] }, "key": { "type": "string", "description": "Значение токена" } }, "required": [ "type", "entry", "key" ] }, "accountType": { "type": "object", "description": "Тип бонусного счета", "properties": { "accountGuid": { "type": "string", "description": "Идентификатор типа бонусного счета" } }, "required": [ "accountGuid" ] } }, "required": [ "customerToken", "accountType" ] } } } }, "operationId": "operationHistory", "tags": [ "Клиенты" ] } }, "/bonuses/debitHold": { "post": { "description": "Зарезервировать средства на бонусном счете клиента для последующего списания", "summary": "Клиент: зарезервировать средства на бонусном счете для списания", "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" } ], "responses": { "200": { "$ref": "./components/responses/200.json" }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "customerToken": { "type": "object", "description": "Токен клиента", "properties": { "type": { "type": "string", "enum": [ "card", "qrGuest", "pin", "phone" ], "description": "Тип токена\n * `card` - карта\n * `qrGuest` - приложение “QR Guest”\n * `pin` - PIN-код\n * `phone` - номер телефона" }, "entry": { "type": "string", "description": "Режим ввода токена\n * `trackCode` - ввод магнитной полосы карты\n * `barCode` - ввод штрих-кода карты\n * `qrCode` - ввод QR-кода с приложения “QR Guest”\n * `manual` - ручной ввод PIN-кода или номера телефона", "enum": [ "trackCode", "barCode", "qrCode", "manual" ] }, "key": { "type": "string", "description": "Значение токена" } }, "required": [ "type", "entry", "key" ] }, "accountType": { "type": "object", "description": "Тип бонусного счета", "properties": { "accountGuid": { "type": "string", "description": "Идентификатор типа бонусного счета" } }, "required": [ "accountGuid" ] }, "date": { "description": "Дата резервирования", "type": "string", "format": "date-time" }, "precheck": { "description": "Идентификатор пречека", "type": "string" }, "amount": { "description": "Сумма резервирования", "type": "number" } }, "required": [ "customerToken", "accountType", "amount" ] } } } }, "operationId": "debitHold", "tags": [ "Клиенты" ] } }, "/bonuses/creditHold": { "post": { "description": "Зарезервировать средства на бонусном счете клиента для последующего зачисления", "summary": "Клиент: зарезервировать средства на бонусном счете для зачисления", "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" } ], "responses": { "200": { "$ref": "./components/responses/200.json" }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "customerToken": { "type": "object", "description": "Токен клиента", "properties": { "type": { "type": "string", "enum": [ "card", "qrGuest", "pin", "phone" ], "description": "Тип токена\n * `card` - карта\n * `qrGuest` - приложение “QR Guest”\n * `pin` - PIN-код\n * `phone` - номер телефона" }, "entry": { "type": "string", "description": "Режим ввода токена\n * `trackCode` - ввод магнитной полосы карты\n * `barCode` - ввод штрих-кода карты\n * `qrCode` - ввод QR-кода с приложения “QR Guest”\n * `manual` - ручной ввод PIN-кода или номера телефона", "enum": [ "trackCode", "barCode", "qrCode", "manual" ] }, "key": { "type": "string", "description": "Значение токена" } }, "required": [ "type", "entry", "key" ] }, "accountType": { "type": "object", "description": "Тип бонусного счета", "properties": { "accountGuid": { "type": "string", "description": "Идентификатор типа бонусного счета" } }, "required": [ "accountGuid" ] }, "date": { "description": "Дата резервирования", "type": "string", "format": "date-time" }, "precheck": { "description": "Идентификатор пречека", "type": "string" }, "amount": { "description": "Сумма резервирования", "type": "number" } }, "required": [ "customerToken", "accountType", "amount" ] } } } }, "operationId": "creditHold", "tags": [ "Клиенты" ] } }, "/bonuses/reverse": { "post": { "description": "Отменить неподтвержденное резервирование средств на бонусном счете клиента", "summary": "Клиент: отменить резервирование средств на бонусном счете", "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" } ], "responses": { "200": { "$ref": "./components/responses/200.json" }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "customerToken": { "type": "object", "description": "Токен клиента", "properties": { "type": { "type": "string", "enum": [ "card", "qrGuest", "pin", "phone" ], "description": "Тип токена\n * `card` - карта\n * `qrGuest` - приложение “QR Guest”\n * `pin` - PIN-код\n * `phone` - номер телефона" }, "entry": { "type": "string", "description": "Режим ввода токена\n * `trackCode` - ввод магнитной полосы карты\n * `barCode` - ввод штрих-кода карты\n * `qrCode` - ввод QR-кода с приложения “QR Guest”\n * `manual` - ручной ввод PIN-кода или номера телефона", "enum": [ "trackCode", "barCode", "qrCode", "manual" ] }, "key": { "type": "string", "description": "Значение токена" } }, "required": [ "type", "entry", "key" ] }, "accountType": { "type": "object", "description": "Тип бонусного счета", "properties": { "accountGuid": { "type": "string", "description": "Идентификатор типа бонусного счета" } }, "required": [ "accountGuid" ] }, "date": { "description": "Дата резервирования", "type": "string", "format": "date-time" }, "precheck": { "description": "Идентификатор пречека", "type": "string" }, "amount": { "description": "Сумма резервирования", "type": "number" }, "bonusTransactionId": { "description": "идентификатор оригинальной операции", "type": "integer" } }, "required": [ "customerToken", "accountType", "amount", "bonusTransactionId" ] } } } }, "operationId": "reverse", "tags": [ "Клиенты" ] } }, "/api/read?moduleName=alcohol.dictionary&className=ru.edgex.quickresto.modules.alcohol.dictionary.AlcoholDictionary": { "get": { "description": "Запросить объект с подобъектами в классе `ru.edgex.quickresto.modules.alcohol.dictionary.AlcoholDictionary` модуля `alcohol.dictionary`", "summary": "Элемент справочника алкогольной продукции: запросить", "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "objectId", "in": "query", "description": "Идентификатор объекта", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.alcohol.dictionary.AlcoholDictionary.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "0f39f475b3df19e920753bc94f7bf78f", "tags": [ "Справочник" ] } }, "/api/list?moduleName=alcohol.dictionary&className=ru.edgex.quickresto.modules.alcohol.dictionary.AlcoholDictionary": { "get": { "description": "Запросить список объектов в классе `ru.edgex.quickresto.modules.alcohol.dictionary.AlcoholDictionary` модуля `alcohol.dictionary`", "summary": "Элемент справочника алкогольной продукции: список", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "description": "Указывает максимальное количество записей, которое должно быть возвращено в одном запросе.", "type": "integer" }, "offset": { "description": "Указывает начальную позицию в наборе данных, с которой будут возвращены записи.\n\nИспользуется вместе с параметром **limit**.", "type": "integer" } } } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "sortFields", "in": "query", "description": "Поля сортировки\n\nИспользуется вместе с параметром **sortOrders**.\n\nНекоторые поля не поддерживают сортировку.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sortOrders", "in": "query", "description": "Порядок сортировки полей\n\nИспользуется вместе с параметром **sortFields**.\n\nКоличество элементов параметра **sortOrders** должно соответствовать количеству элементов, указанных в параметре **sortFields**.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "asc", "desc" ] } } }, { "name": "filters", "in": "query", "description": "Фильтрация элементов\n\nНекоторые поля не поддерживают фильтрацию.", "schema": { "type": "array", "items": { "type": "object", "required": [ "field", "operation", "value" ], "properties": { "field": { "type": "string", "description": "Поле фильтрации", "required": true }, "operation": { "type": "string", "enum": [ "eq", "neq", "gte", "lte", "gt", "lt", "like", "contains", "range" ], "description": "Операция фильтрации для поля, указанного в параметре **field**." }, "value": { "type": [ "string", "object" ], "description": "Значение фильтрации.\n\n При значении `range` параметра **operation** используется объект с параметрами **since** и **till**.", "properties": { "since": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **till**." }, "till": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **since**." } } } } } } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.alcohol.dictionary.AlcoholDictionary.json" } } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "91a836f0256ec9282fe788154c6dc65a", "tags": [ "Справочник" ] } }, "/api/read?moduleName=core.company&className=ru.edgex.quickresto.modules.core.company.CompanyInfo": { "get": { "description": "Запросить объект с подобъектами в классе `ru.edgex.quickresto.modules.core.company.CompanyInfo` модуля `core.company`", "summary": "Настройки предприятия: запросить", "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "objectId", "in": "query", "description": "Идентификатор объекта", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.core.company.CompanyInfo.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "3ac2bc7038a2eb4f561542ba27e643a1", "tags": [ "Настройки" ] } }, "/api/list?moduleName=core.company&className=ru.edgex.quickresto.modules.core.company.CompanyInfo": { "get": { "description": "Запросить список объектов в классе `ru.edgex.quickresto.modules.core.company.CompanyInfo` модуля `core.company`", "summary": "Настройки предприятия: список", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "description": "Указывает максимальное количество записей, которое должно быть возвращено в одном запросе.", "type": "integer" }, "offset": { "description": "Указывает начальную позицию в наборе данных, с которой будут возвращены записи.\n\nИспользуется вместе с параметром **limit**.", "type": "integer" } } } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "sortFields", "in": "query", "description": "Поля сортировки\n\nИспользуется вместе с параметром **sortOrders**.\n\nНекоторые поля не поддерживают сортировку.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sortOrders", "in": "query", "description": "Порядок сортировки полей\n\nИспользуется вместе с параметром **sortFields**.\n\nКоличество элементов параметра **sortOrders** должно соответствовать количеству элементов, указанных в параметре **sortFields**.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "asc", "desc" ] } } }, { "name": "filters", "in": "query", "description": "Фильтрация элементов\n\nНекоторые поля не поддерживают фильтрацию.", "schema": { "type": "array", "items": { "type": "object", "required": [ "field", "operation", "value" ], "properties": { "field": { "type": "string", "description": "Поле фильтрации", "required": true }, "operation": { "type": "string", "enum": [ "eq", "neq", "gte", "lte", "gt", "lt", "like", "contains", "range" ], "description": "Операция фильтрации для поля, указанного в параметре **field**." }, "value": { "type": [ "string", "object" ], "description": "Значение фильтрации.\n\n При значении `range` параметра **operation** используется объект с параметрами **since** и **till**.", "properties": { "since": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **till**." }, "till": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **since**." } } } } } } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.core.company.CompanyInfo.json" } } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "b0e69c6f1359b72c43a6a4dd0b260497", "tags": [ "Настройки" ] } }, "/api/update?moduleName=core.company&className=ru.edgex.quickresto.modules.core.company.CompanyInfo": { "post": { "description": "Модифицировать объект в классе `ru.edgex.quickresto.modules.core.company.CompanyInfo` модуля `core.company`", "summary": "Настройки предприятия: редактировать", "requestBody": { "content": { "application/json": { "schema": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.core.company.CompanyInfo.json" } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.core.company.CompanyInfo.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "147335d90ac1dba63a962bc0537231c7", "tags": [ "Настройки" ] } }, "/api/read?moduleName=core.company.businesses&className=ru.edgex.quickresto.modules.core.company.businesses.Business": { "get": { "description": "Запросить объект с подобъектами в классе `ru.edgex.quickresto.modules.core.company.businesses.Business` модуля `core.company.businesses`", "summary": "Организация: запросить", "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "objectId", "in": "query", "description": "Идентификатор объекта", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.core.company.businesses.Business.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "2c82946f13bdfce23f8145be7600197e", "tags": [ "Организации" ] } }, "/api/list?moduleName=core.company.businesses&className=ru.edgex.quickresto.modules.core.company.businesses.Business": { "get": { "description": "Запросить список объектов в классе `ru.edgex.quickresto.modules.core.company.businesses.Business` модуля `core.company.businesses`", "summary": "Организация: список", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "description": "Указывает максимальное количество записей, которое должно быть возвращено в одном запросе.", "type": "integer" }, "offset": { "description": "Указывает начальную позицию в наборе данных, с которой будут возвращены записи.\n\nИспользуется вместе с параметром **limit**.", "type": "integer" } } } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "sortFields", "in": "query", "description": "Поля сортировки\n\nИспользуется вместе с параметром **sortOrders**.\n\nНекоторые поля не поддерживают сортировку.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sortOrders", "in": "query", "description": "Порядок сортировки полей\n\nИспользуется вместе с параметром **sortFields**.\n\nКоличество элементов параметра **sortOrders** должно соответствовать количеству элементов, указанных в параметре **sortFields**.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "asc", "desc" ] } } }, { "name": "filters", "in": "query", "description": "Фильтрация элементов\n\nНекоторые поля не поддерживают фильтрацию.", "schema": { "type": "array", "items": { "type": "object", "required": [ "field", "operation", "value" ], "properties": { "field": { "type": "string", "description": "Поле фильтрации", "required": true }, "operation": { "type": "string", "enum": [ "eq", "neq", "gte", "lte", "gt", "lt", "like", "contains", "range" ], "description": "Операция фильтрации для поля, указанного в параметре **field**." }, "value": { "type": [ "string", "object" ], "description": "Значение фильтрации.\n\n При значении `range` параметра **operation** используется объект с параметрами **since** и **till**.", "properties": { "since": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **till**." }, "till": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **since**." } } } } } } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.core.company.businesses.Business.json" } } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "4669a5afd36ae80728c4b96eebebe044", "tags": [ "Организации" ] } }, "/api/update?moduleName=core.company.businesses&className=ru.edgex.quickresto.modules.core.company.businesses.Business": { "post": { "description": "Модифицировать объект в классе `ru.edgex.quickresto.modules.core.company.businesses.Business` модуля `core.company.businesses`", "summary": "Организация: редактировать", "requestBody": { "content": { "application/json": { "schema": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.core.company.businesses.Business.json" } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.core.company.businesses.Business.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "8c50ee825dee5ad4baf1218952f8e0d0", "tags": [ "Организации" ] } }, "/api/remove?moduleName=core.company.businesses&className=ru.edgex.quickresto.modules.core.company.businesses.Business": { "post": { "description": "Удалить объект в классе `ru.edgex.quickresto.modules.core.company.businesses.Business` модуля `core.company.businesses`", "summary": "Организация: удалить", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "description": "Идентификатор объекта", "type": "integer" } }, "required": [ "id" ] } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.core.company.businesses.Business.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "4745eeb0017a1994bc25a95c4674f042", "tags": [ "Организации" ] } }, "/api/read?moduleName=core.company.businesses.litebusiness&className=ru.edgex.quickresto.modules.core.company.businesses.litebusiness.LiteBusiness": { "get": { "description": "Запросить объект с подобъектами в классе `ru.edgex.quickresto.modules.core.company.businesses.litebusiness.LiteBusiness` модуля `core.company.businesses.litebusiness`", "summary": "Реквизиты организации: запросить", "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "objectId", "in": "query", "description": "Идентификатор объекта", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.core.company.businesses.litebusiness.LiteBusiness.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "8cd286a82c7a71357232302dfd5704da", "tags": [ "Организации" ] } }, "/api/list?moduleName=core.company.businesses.litebusiness&className=ru.edgex.quickresto.modules.core.company.businesses.litebusiness.LiteBusiness": { "get": { "description": "Запросить список объектов в классе `ru.edgex.quickresto.modules.core.company.businesses.litebusiness.LiteBusiness` модуля `core.company.businesses.litebusiness`", "summary": "Реквизиты организации: список", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "description": "Указывает максимальное количество записей, которое должно быть возвращено в одном запросе.", "type": "integer" }, "offset": { "description": "Указывает начальную позицию в наборе данных, с которой будут возвращены записи.\n\nИспользуется вместе с параметром **limit**.", "type": "integer" } } } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "sortFields", "in": "query", "description": "Поля сортировки\n\nИспользуется вместе с параметром **sortOrders**.\n\nНекоторые поля не поддерживают сортировку.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sortOrders", "in": "query", "description": "Порядок сортировки полей\n\nИспользуется вместе с параметром **sortFields**.\n\nКоличество элементов параметра **sortOrders** должно соответствовать количеству элементов, указанных в параметре **sortFields**.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "asc", "desc" ] } } }, { "name": "filters", "in": "query", "description": "Фильтрация элементов\n\nНекоторые поля не поддерживают фильтрацию.", "schema": { "type": "array", "items": { "type": "object", "required": [ "field", "operation", "value" ], "properties": { "field": { "type": "string", "description": "Поле фильтрации", "required": true }, "operation": { "type": "string", "enum": [ "eq", "neq", "gte", "lte", "gt", "lt", "like", "contains", "range" ], "description": "Операция фильтрации для поля, указанного в параметре **field**." }, "value": { "type": [ "string", "object" ], "description": "Значение фильтрации.\n\n При значении `range` параметра **operation** используется объект с параметрами **since** и **till**.", "properties": { "since": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **till**." }, "till": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **since**." } } } } } } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.core.company.businesses.litebusiness.LiteBusiness.json" } } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "58368d92b782d1b1992bc5042583a8a9", "tags": [ "Организации" ] } }, "/api/read?moduleName=core.dictionaries.measureunits&className=ru.edgex.quickresto.modules.core.dictionaries.measureunits.MeasureUnit": { "get": { "description": "Запросить объект с подобъектами в классе `ru.edgex.quickresto.modules.core.dictionaries.measureunits.MeasureUnit` модуля `core.dictionaries.measureunits`", "summary": "Единица измерения: запросить", "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "objectId", "in": "query", "description": "Идентификатор объекта", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.core.dictionaries.measureunits.MeasureUnit.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "89ba17d77bcf424e6f3da48b43632fc2", "tags": [ "Единицы измерения" ] } }, "/api/list?moduleName=core.dictionaries.measureunits&className=ru.edgex.quickresto.modules.core.dictionaries.measureunits.MeasureUnit": { "get": { "description": "Запросить список объектов в классе `ru.edgex.quickresto.modules.core.dictionaries.measureunits.MeasureUnit` модуля `core.dictionaries.measureunits`", "summary": "Единица измерения: список", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "description": "Указывает максимальное количество записей, которое должно быть возвращено в одном запросе.", "type": "integer" }, "offset": { "description": "Указывает начальную позицию в наборе данных, с которой будут возвращены записи.\n\nИспользуется вместе с параметром **limit**.", "type": "integer" } } } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "sortFields", "in": "query", "description": "Поля сортировки\n\nИспользуется вместе с параметром **sortOrders**.\n\nНекоторые поля не поддерживают сортировку.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sortOrders", "in": "query", "description": "Порядок сортировки полей\n\nИспользуется вместе с параметром **sortFields**.\n\nКоличество элементов параметра **sortOrders** должно соответствовать количеству элементов, указанных в параметре **sortFields**.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "asc", "desc" ] } } }, { "name": "filters", "in": "query", "description": "Фильтрация элементов\n\nНекоторые поля не поддерживают фильтрацию.", "schema": { "type": "array", "items": { "type": "object", "required": [ "field", "operation", "value" ], "properties": { "field": { "type": "string", "description": "Поле фильтрации", "required": true }, "operation": { "type": "string", "enum": [ "eq", "neq", "gte", "lte", "gt", "lt", "like", "contains", "range" ], "description": "Операция фильтрации для поля, указанного в параметре **field**." }, "value": { "type": [ "string", "object" ], "description": "Значение фильтрации.\n\n При значении `range` параметра **operation** используется объект с параметрами **since** и **till**.", "properties": { "since": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **till**." }, "till": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **since**." } } } } } } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.core.dictionaries.measureunits.MeasureUnit.json" } } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "38f9dde66df867427a3b3e1ae3c4b327", "tags": [ "Единицы измерения" ] } }, "/api/create?moduleName=core.dictionaries.measureunits&className=ru.edgex.quickresto.modules.core.dictionaries.measureunits.MeasureUnit": { "post": { "description": "Создать объект в классе `ru.edgex.quickresto.modules.core.dictionaries.measureunits.MeasureUnit` модуля `core.dictionaries.measureunits`", "summary": "Единица измерения: создать", "requestBody": { "content": { "application/json": { "schema": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.core.dictionaries.measureunits.MeasureUnit.json" } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.core.dictionaries.measureunits.MeasureUnit.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "ad20b984483c9c40b8e2b5d2c3c98c9a", "tags": [ "Единицы измерения" ] } }, "/api/update?moduleName=core.dictionaries.measureunits&className=ru.edgex.quickresto.modules.core.dictionaries.measureunits.MeasureUnit": { "post": { "description": "Модифицировать объект в классе `ru.edgex.quickresto.modules.core.dictionaries.measureunits.MeasureUnit` модуля `core.dictionaries.measureunits`", "summary": "Единица измерения: редактировать", "requestBody": { "content": { "application/json": { "schema": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.core.dictionaries.measureunits.MeasureUnit.json" } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.core.dictionaries.measureunits.MeasureUnit.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "b58f29ed55a6952ec2e16d474f68663e", "tags": [ "Единицы измерения" ] } }, "/api/remove?moduleName=core.dictionaries.measureunits&className=ru.edgex.quickresto.modules.core.dictionaries.measureunits.MeasureUnit": { "post": { "description": "Удалить объект в классе `ru.edgex.quickresto.modules.core.dictionaries.measureunits.MeasureUnit` модуля `core.dictionaries.measureunits`", "summary": "Единица измерения: удалить", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "description": "Идентификатор объекта", "type": "integer" } }, "required": [ "id" ] } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.core.dictionaries.measureunits.MeasureUnit.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "3b4b0d8a5aa66f9150e634e294651234", "tags": [ "Единицы измерения" ] } }, "/api/read?moduleName=core.dictionaries.measureunits&className=ru.edgex.quickresto.modules.core.dictionaries.measureunits.AbstractMeasureUnit": { "get": { "description": "Запросить объект с подобъектами в классе `ru.edgex.quickresto.modules.core.dictionaries.measureunits.AbstractMeasureUnit` модуля `core.dictionaries.measureunits`", "summary": "Единица измерения: запросить", "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "objectId", "in": "query", "description": "Идентификатор объекта", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.core.dictionaries.measureunits.AbstractMeasureUnit.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "43c5cf1b1c86fb61c95d45826e0b4a1b", "tags": [ "Единицы измерения" ] } }, "/api/list?moduleName=core.dictionaries.measureunits&className=ru.edgex.quickresto.modules.core.dictionaries.measureunits.AbstractMeasureUnit": { "get": { "description": "Запросить список объектов в классе `ru.edgex.quickresto.modules.core.dictionaries.measureunits.AbstractMeasureUnit` модуля `core.dictionaries.measureunits`", "summary": "Единица измерения: список", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "description": "Указывает максимальное количество записей, которое должно быть возвращено в одном запросе.", "type": "integer" }, "offset": { "description": "Указывает начальную позицию в наборе данных, с которой будут возвращены записи.\n\nИспользуется вместе с параметром **limit**.", "type": "integer" } } } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "sortFields", "in": "query", "description": "Поля сортировки\n\nИспользуется вместе с параметром **sortOrders**.\n\nНекоторые поля не поддерживают сортировку.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sortOrders", "in": "query", "description": "Порядок сортировки полей\n\nИспользуется вместе с параметром **sortFields**.\n\nКоличество элементов параметра **sortOrders** должно соответствовать количеству элементов, указанных в параметре **sortFields**.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "asc", "desc" ] } } }, { "name": "filters", "in": "query", "description": "Фильтрация элементов\n\nНекоторые поля не поддерживают фильтрацию.", "schema": { "type": "array", "items": { "type": "object", "required": [ "field", "operation", "value" ], "properties": { "field": { "type": "string", "description": "Поле фильтрации", "required": true }, "operation": { "type": "string", "enum": [ "eq", "neq", "gte", "lte", "gt", "lt", "like", "contains", "range" ], "description": "Операция фильтрации для поля, указанного в параметре **field**." }, "value": { "type": [ "string", "object" ], "description": "Значение фильтрации.\n\n При значении `range` параметра **operation** используется объект с параметрами **since** и **till**.", "properties": { "since": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **till**." }, "till": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **since**." } } } } } } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.core.dictionaries.measureunits.AbstractMeasureUnit.json" } } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "39c2094e3b41ad68569fcf4242a34b61", "tags": [ "Единицы измерения" ] } }, "/api/read?moduleName=core.dictionaries.orderdiscardreasons&className=ru.edgex.quickresto.modules.core.dictionaries.orderdiscardreasons.OrderDiscardReason": { "get": { "description": "Запросить объект с подобъектами в классе `ru.edgex.quickresto.modules.core.dictionaries.orderdiscardreasons.OrderDiscardReason` модуля `core.dictionaries.orderdiscardreasons`", "summary": "Причина списания: запросить", "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "objectId", "in": "query", "description": "Идентификатор объекта", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.core.dictionaries.orderdiscardreasons.OrderDiscardReason.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "cf6baa89119d9eb5dff3228cdd04a6ef", "tags": [ "Причины списания" ] } }, "/api/list?moduleName=core.dictionaries.orderdiscardreasons&className=ru.edgex.quickresto.modules.core.dictionaries.orderdiscardreasons.OrderDiscardReason": { "get": { "description": "Запросить список объектов в классе `ru.edgex.quickresto.modules.core.dictionaries.orderdiscardreasons.OrderDiscardReason` модуля `core.dictionaries.orderdiscardreasons`", "summary": "Причина списания: список", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "description": "Указывает максимальное количество записей, которое должно быть возвращено в одном запросе.", "type": "integer" }, "offset": { "description": "Указывает начальную позицию в наборе данных, с которой будут возвращены записи.\n\nИспользуется вместе с параметром **limit**.", "type": "integer" } } } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "sortFields", "in": "query", "description": "Поля сортировки\n\nИспользуется вместе с параметром **sortOrders**.\n\nНекоторые поля не поддерживают сортировку.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sortOrders", "in": "query", "description": "Порядок сортировки полей\n\nИспользуется вместе с параметром **sortFields**.\n\nКоличество элементов параметра **sortOrders** должно соответствовать количеству элементов, указанных в параметре **sortFields**.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "asc", "desc" ] } } }, { "name": "filters", "in": "query", "description": "Фильтрация элементов\n\nНекоторые поля не поддерживают фильтрацию.", "schema": { "type": "array", "items": { "type": "object", "required": [ "field", "operation", "value" ], "properties": { "field": { "type": "string", "description": "Поле фильтрации", "required": true }, "operation": { "type": "string", "enum": [ "eq", "neq", "gte", "lte", "gt", "lt", "like", "contains", "range" ], "description": "Операция фильтрации для поля, указанного в параметре **field**." }, "value": { "type": [ "string", "object" ], "description": "Значение фильтрации.\n\n При значении `range` параметра **operation** используется объект с параметрами **since** и **till**.", "properties": { "since": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **till**." }, "till": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **since**." } } } } } } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.core.dictionaries.orderdiscardreasons.OrderDiscardReason.json" } } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "7c8bb44eb533ed8a5eba0d68f9e46861", "tags": [ "Причины списания" ] } }, "/api/remove?moduleName=core.dictionaries.orderdiscardreasons&className=ru.edgex.quickresto.modules.core.dictionaries.orderdiscardreasons.OrderDiscardReason": { "post": { "description": "Удалить объект в классе `ru.edgex.quickresto.modules.core.dictionaries.orderdiscardreasons.OrderDiscardReason` модуля `core.dictionaries.orderdiscardreasons`", "summary": "Причина списания: удалить", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "description": "Идентификатор объекта", "type": "integer" } }, "required": [ "id" ] } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.core.dictionaries.orderdiscardreasons.OrderDiscardReason.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "1ee5908fe94cfe39fee2f226ebcfbcee", "tags": [ "Причины списания" ] } }, "/api/read?moduleName=core.dictionaries.packingunits&className=ru.edgex.quickresto.modules.core.dictionaries.packingunits.PackingUnit": { "get": { "description": "Запросить объект с подобъектами в классе `ru.edgex.quickresto.modules.core.dictionaries.packingunits.PackingUnit` модуля `core.dictionaries.packingunits`", "summary": "Фасоввка: запросить", "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "objectId", "in": "query", "description": "Идентификатор объекта", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.core.dictionaries.packingunits.PackingUnit.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "92e118143e7568a40f223e4d1cb2f07c", "tags": [ "Фасовки" ] } }, "/api/list?moduleName=core.dictionaries.packingunits&className=ru.edgex.quickresto.modules.core.dictionaries.packingunits.PackingUnit": { "get": { "description": "Запросить список объектов в классе `ru.edgex.quickresto.modules.core.dictionaries.packingunits.PackingUnit` модуля `core.dictionaries.packingunits`", "summary": "Фасоввка: список", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "description": "Указывает максимальное количество записей, которое должно быть возвращено в одном запросе.", "type": "integer" }, "offset": { "description": "Указывает начальную позицию в наборе данных, с которой будут возвращены записи.\n\nИспользуется вместе с параметром **limit**.", "type": "integer" } } } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "sortFields", "in": "query", "description": "Поля сортировки\n\nИспользуется вместе с параметром **sortOrders**.\n\nНекоторые поля не поддерживают сортировку.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sortOrders", "in": "query", "description": "Порядок сортировки полей\n\nИспользуется вместе с параметром **sortFields**.\n\nКоличество элементов параметра **sortOrders** должно соответствовать количеству элементов, указанных в параметре **sortFields**.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "asc", "desc" ] } } }, { "name": "filters", "in": "query", "description": "Фильтрация элементов\n\nНекоторые поля не поддерживают фильтрацию.", "schema": { "type": "array", "items": { "type": "object", "required": [ "field", "operation", "value" ], "properties": { "field": { "type": "string", "description": "Поле фильтрации", "required": true }, "operation": { "type": "string", "enum": [ "eq", "neq", "gte", "lte", "gt", "lt", "like", "contains", "range" ], "description": "Операция фильтрации для поля, указанного в параметре **field**." }, "value": { "type": [ "string", "object" ], "description": "Значение фильтрации.\n\n При значении `range` параметра **operation** используется объект с параметрами **since** и **till**.", "properties": { "since": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **till**." }, "till": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **since**." } } } } } } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.core.dictionaries.packingunits.PackingUnit.json" } } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "f8b82733bbed945a8276d27325065497", "tags": [ "Фасовки" ] } }, "/api/remove?moduleName=core.dictionaries.packingunits&className=ru.edgex.quickresto.modules.core.dictionaries.packingunits.PackingUnit": { "post": { "description": "Удалить объект в классе `ru.edgex.quickresto.modules.core.dictionaries.packingunits.PackingUnit` модуля `core.dictionaries.packingunits`", "summary": "Фасоввка: удалить", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "description": "Идентификатор объекта", "type": "integer" } }, "required": [ "id" ] } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.core.dictionaries.packingunits.PackingUnit.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "ae1fb3a60474b063e57affeffdf158ce", "tags": [ "Фасовки" ] } }, "/api/read?moduleName=core.dictionaries.paymenttypes&className=ru.edgex.quickresto.modules.core.dictionaries.paymenttypes.PaymentType": { "get": { "description": "Запросить объект с подобъектами в классе `ru.edgex.quickresto.modules.core.dictionaries.paymenttypes.PaymentType` модуля `core.dictionaries.paymenttypes`", "summary": "Тип оплаты: запросить", "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "objectId", "in": "query", "description": "Идентификатор объекта", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.core.dictionaries.paymenttypes.PaymentType.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "dff88e60e07a8f7f35a1081379fcc759", "tags": [ "Типы оплат" ] } }, "/api/list?moduleName=core.dictionaries.paymenttypes&className=ru.edgex.quickresto.modules.core.dictionaries.paymenttypes.PaymentType": { "get": { "description": "Запросить список объектов в классе `ru.edgex.quickresto.modules.core.dictionaries.paymenttypes.PaymentType` модуля `core.dictionaries.paymenttypes`", "summary": "Тип оплаты: список", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "description": "Указывает максимальное количество записей, которое должно быть возвращено в одном запросе.", "type": "integer" }, "offset": { "description": "Указывает начальную позицию в наборе данных, с которой будут возвращены записи.\n\nИспользуется вместе с параметром **limit**.", "type": "integer" } } } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "sortFields", "in": "query", "description": "Поля сортировки\n\nИспользуется вместе с параметром **sortOrders**.\n\nНекоторые поля не поддерживают сортировку.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sortOrders", "in": "query", "description": "Порядок сортировки полей\n\nИспользуется вместе с параметром **sortFields**.\n\nКоличество элементов параметра **sortOrders** должно соответствовать количеству элементов, указанных в параметре **sortFields**.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "asc", "desc" ] } } }, { "name": "filters", "in": "query", "description": "Фильтрация элементов\n\nНекоторые поля не поддерживают фильтрацию.", "schema": { "type": "array", "items": { "type": "object", "required": [ "field", "operation", "value" ], "properties": { "field": { "type": "string", "description": "Поле фильтрации", "required": true }, "operation": { "type": "string", "enum": [ "eq", "neq", "gte", "lte", "gt", "lt", "like", "contains", "range" ], "description": "Операция фильтрации для поля, указанного в параметре **field**." }, "value": { "type": [ "string", "object" ], "description": "Значение фильтрации.\n\n При значении `range` параметра **operation** используется объект с параметрами **since** и **till**.", "properties": { "since": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **till**." }, "till": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **since**." } } } } } } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.core.dictionaries.paymenttypes.PaymentType.json" } } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "b1855ab8ff470d49385c277043a213ef", "tags": [ "Типы оплат" ] } }, "/api/create?moduleName=core.dictionaries.paymenttypes&className=ru.edgex.quickresto.modules.core.dictionaries.paymenttypes.PaymentType": { "post": { "description": "Создать объект в классе `ru.edgex.quickresto.modules.core.dictionaries.paymenttypes.PaymentType` модуля `core.dictionaries.paymenttypes`", "summary": "Тип оплаты: создать", "requestBody": { "content": { "application/json": { "schema": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.core.dictionaries.paymenttypes.PaymentType.json" } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.core.dictionaries.paymenttypes.PaymentType.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "d63f856d693688b2b53f446dfca9c062", "tags": [ "Типы оплат" ] } }, "/api/update?moduleName=core.dictionaries.paymenttypes&className=ru.edgex.quickresto.modules.core.dictionaries.paymenttypes.PaymentType": { "post": { "description": "Модифицировать объект в классе `ru.edgex.quickresto.modules.core.dictionaries.paymenttypes.PaymentType` модуля `core.dictionaries.paymenttypes`", "summary": "Тип оплаты: редактировать", "requestBody": { "content": { "application/json": { "schema": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.core.dictionaries.paymenttypes.PaymentType.json" } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.core.dictionaries.paymenttypes.PaymentType.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "bd74a19d541f6fa83d93472a0520237b", "tags": [ "Типы оплат" ] } }, "/api/remove?moduleName=core.dictionaries.paymenttypes&className=ru.edgex.quickresto.modules.core.dictionaries.paymenttypes.PaymentType": { "post": { "description": "Удалить объект в классе `ru.edgex.quickresto.modules.core.dictionaries.paymenttypes.PaymentType` модуля `core.dictionaries.paymenttypes`", "summary": "Тип оплаты: удалить", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "description": "Идентификатор объекта", "type": "integer" } }, "required": [ "id" ] } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.core.dictionaries.paymenttypes.PaymentType.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "f164507ead4848428cb4127169d5ad36", "tags": [ "Типы оплат" ] } }, "/api/read?moduleName=core.dictionaries.storeitemtag&className=ru.edgex.quickresto.modules.core.dictionaries.storeitemtag.StoreItemTag": { "get": { "description": "Запросить объект с подобъектами в классе `ru.edgex.quickresto.modules.core.dictionaries.storeitemtag.StoreItemTag` модуля `core.dictionaries.storeitemtag`", "summary": "Тэг: запросить", "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "objectId", "in": "query", "description": "Идентификатор объекта", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.core.dictionaries.storeitemtag.StoreItemTag.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "deab82e4f2c8c5bc0b694391b46aafc1", "tags": [ "Тэги" ] } }, "/api/list?moduleName=core.dictionaries.storeitemtag&className=ru.edgex.quickresto.modules.core.dictionaries.storeitemtag.StoreItemTag": { "get": { "description": "Запросить список объектов в классе `ru.edgex.quickresto.modules.core.dictionaries.storeitemtag.StoreItemTag` модуля `core.dictionaries.storeitemtag`", "summary": "Тэг: список", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "description": "Указывает максимальное количество записей, которое должно быть возвращено в одном запросе.", "type": "integer" }, "offset": { "description": "Указывает начальную позицию в наборе данных, с которой будут возвращены записи.\n\nИспользуется вместе с параметром **limit**.", "type": "integer" } } } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "sortFields", "in": "query", "description": "Поля сортировки\n\nИспользуется вместе с параметром **sortOrders**.\n\nНекоторые поля не поддерживают сортировку.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sortOrders", "in": "query", "description": "Порядок сортировки полей\n\nИспользуется вместе с параметром **sortFields**.\n\nКоличество элементов параметра **sortOrders** должно соответствовать количеству элементов, указанных в параметре **sortFields**.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "asc", "desc" ] } } }, { "name": "filters", "in": "query", "description": "Фильтрация элементов\n\nНекоторые поля не поддерживают фильтрацию.", "schema": { "type": "array", "items": { "type": "object", "required": [ "field", "operation", "value" ], "properties": { "field": { "type": "string", "description": "Поле фильтрации", "required": true }, "operation": { "type": "string", "enum": [ "eq", "neq", "gte", "lte", "gt", "lt", "like", "contains", "range" ], "description": "Операция фильтрации для поля, указанного в параметре **field**." }, "value": { "type": [ "string", "object" ], "description": "Значение фильтрации.\n\n При значении `range` параметра **operation** используется объект с параметрами **since** и **till**.", "properties": { "since": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **till**." }, "till": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **since**." } } } } } } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.core.dictionaries.storeitemtag.StoreItemTag.json" } } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "1ab14f3e23f58adb3722ad5f0b6f8324", "tags": [ "Тэги" ] } }, "/api/create?moduleName=core.dictionaries.storeitemtag&className=ru.edgex.quickresto.modules.core.dictionaries.storeitemtag.StoreItemTag": { "post": { "description": "Создать объект в классе `ru.edgex.quickresto.modules.core.dictionaries.storeitemtag.StoreItemTag` модуля `core.dictionaries.storeitemtag`", "summary": "Тэг: создать", "requestBody": { "content": { "application/json": { "schema": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.core.dictionaries.storeitemtag.StoreItemTag.json" } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.core.dictionaries.storeitemtag.StoreItemTag.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "892d12b493c9b16530278a99d6e302d3", "tags": [ "Тэги" ] } }, "/api/update?moduleName=core.dictionaries.storeitemtag&className=ru.edgex.quickresto.modules.core.dictionaries.storeitemtag.StoreItemTag": { "post": { "description": "Модифицировать объект в классе `ru.edgex.quickresto.modules.core.dictionaries.storeitemtag.StoreItemTag` модуля `core.dictionaries.storeitemtag`", "summary": "Тэг: редактировать", "requestBody": { "content": { "application/json": { "schema": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.core.dictionaries.storeitemtag.StoreItemTag.json" } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.core.dictionaries.storeitemtag.StoreItemTag.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "b778b4cf5489a9a6066ef4c922d275d0", "tags": [ "Тэги" ] } }, "/api/remove?moduleName=core.dictionaries.storeitemtag&className=ru.edgex.quickresto.modules.core.dictionaries.storeitemtag.StoreItemTag": { "post": { "description": "Удалить объект в классе `ru.edgex.quickresto.modules.core.dictionaries.storeitemtag.StoreItemTag` модуля `core.dictionaries.storeitemtag`", "summary": "Тэг: удалить", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "description": "Идентификатор объекта", "type": "integer" } }, "required": [ "id" ] } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.core.dictionaries.storeitemtag.StoreItemTag.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "59f63f8fcc27260da5e40821302d2de5", "tags": [ "Тэги" ] } }, "/api/read?moduleName=core.dictionaries.vat&className=ru.edgex.quickresto.modules.core.dictionaries.vat.Vat": { "get": { "description": "Запросить объект с подобъектами в классе `ru.edgex.quickresto.modules.core.dictionaries.vat.Vat` модуля `core.dictionaries.vat`", "summary": "НДС: запросить", "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "objectId", "in": "query", "description": "Идентификатор объекта", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.core.dictionaries.vat.Vat.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "4fada0a7ff3c7fb0c24be2d9c576df09", "tags": [ "НДС" ] } }, "/api/list?moduleName=core.dictionaries.vat&className=ru.edgex.quickresto.modules.core.dictionaries.vat.Vat": { "get": { "description": "Запросить список объектов в классе `ru.edgex.quickresto.modules.core.dictionaries.vat.Vat` модуля `core.dictionaries.vat`", "summary": "НДС: список", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "description": "Указывает максимальное количество записей, которое должно быть возвращено в одном запросе.", "type": "integer" }, "offset": { "description": "Указывает начальную позицию в наборе данных, с которой будут возвращены записи.\n\nИспользуется вместе с параметром **limit**.", "type": "integer" } } } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "sortFields", "in": "query", "description": "Поля сортировки\n\nИспользуется вместе с параметром **sortOrders**.\n\nНекоторые поля не поддерживают сортировку.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sortOrders", "in": "query", "description": "Порядок сортировки полей\n\nИспользуется вместе с параметром **sortFields**.\n\nКоличество элементов параметра **sortOrders** должно соответствовать количеству элементов, указанных в параметре **sortFields**.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "asc", "desc" ] } } }, { "name": "filters", "in": "query", "description": "Фильтрация элементов\n\nНекоторые поля не поддерживают фильтрацию.", "schema": { "type": "array", "items": { "type": "object", "required": [ "field", "operation", "value" ], "properties": { "field": { "type": "string", "description": "Поле фильтрации", "required": true }, "operation": { "type": "string", "enum": [ "eq", "neq", "gte", "lte", "gt", "lt", "like", "contains", "range" ], "description": "Операция фильтрации для поля, указанного в параметре **field**." }, "value": { "type": [ "string", "object" ], "description": "Значение фильтрации.\n\n При значении `range` параметра **operation** используется объект с параметрами **since** и **till**.", "properties": { "since": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **till**." }, "till": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **since**." } } } } } } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.core.dictionaries.vat.Vat.json" } } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "187ce9f2bbafadda6e3eee0728a6e25f", "tags": [ "НДС" ] } }, "/api/read?moduleName=crm.accounting.account.type&className=ru.edgex.quickresto.modules.crm.accounting.account.type.CustomerAccountType": { "get": { "description": "Запросить объект с подобъектами в классе `ru.edgex.quickresto.modules.crm.accounting.account.type.CustomerAccountType` модуля `crm.accounting.account.type`", "summary": "Тип бонусного счета клиента: запросить", "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "objectId", "in": "query", "description": "Идентификатор объекта", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.crm.accounting.account.type.CustomerAccountType.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "c52dba6c643ba1ec63f5e53c2a207ca9", "tags": [ "Типы бонусных счетов" ] } }, "/api/list?moduleName=crm.accounting.account.type&className=ru.edgex.quickresto.modules.crm.accounting.account.type.CustomerAccountType": { "get": { "description": "Запросить список объектов в классе `ru.edgex.quickresto.modules.crm.accounting.account.type.CustomerAccountType` модуля `crm.accounting.account.type`", "summary": "Тип бонусного счета клиента: список", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "description": "Указывает максимальное количество записей, которое должно быть возвращено в одном запросе.", "type": "integer" }, "offset": { "description": "Указывает начальную позицию в наборе данных, с которой будут возвращены записи.\n\nИспользуется вместе с параметром **limit**.", "type": "integer" } } } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "sortFields", "in": "query", "description": "Поля сортировки\n\nИспользуется вместе с параметром **sortOrders**.\n\nНекоторые поля не поддерживают сортировку.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sortOrders", "in": "query", "description": "Порядок сортировки полей\n\nИспользуется вместе с параметром **sortFields**.\n\nКоличество элементов параметра **sortOrders** должно соответствовать количеству элементов, указанных в параметре **sortFields**.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "asc", "desc" ] } } }, { "name": "filters", "in": "query", "description": "Фильтрация элементов\n\nНекоторые поля не поддерживают фильтрацию.", "schema": { "type": "array", "items": { "type": "object", "required": [ "field", "operation", "value" ], "properties": { "field": { "type": "string", "description": "Поле фильтрации", "required": true }, "operation": { "type": "string", "enum": [ "eq", "neq", "gte", "lte", "gt", "lt", "like", "contains", "range" ], "description": "Операция фильтрации для поля, указанного в параметре **field**." }, "value": { "type": [ "string", "object" ], "description": "Значение фильтрации.\n\n При значении `range` параметра **operation** используется объект с параметрами **since** и **till**.", "properties": { "since": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **till**." }, "till": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **since**." } } } } } } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.crm.accounting.account.type.CustomerAccountType.json" } } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "6b453cce8339b1dbb09de331506f2f10", "tags": [ "Типы бонусных счетов" ] } }, "/api/remove?moduleName=crm.accounting.account.type&className=ru.edgex.quickresto.modules.crm.accounting.account.type.CustomerAccountType": { "post": { "description": "Удалить объект в классе `ru.edgex.quickresto.modules.crm.accounting.account.type.CustomerAccountType` модуля `crm.accounting.account.type`", "summary": "Тип бонусного счета клиента: удалить", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "description": "Идентификатор объекта", "type": "integer" } }, "required": [ "id" ] } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.crm.accounting.account.type.CustomerAccountType.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "bebee42538204528504f84df73f4ada7", "tags": [ "Типы бонусных счетов" ] } }, "/api/read?moduleName=crm.customer&className=ru.edgex.quickresto.modules.crm.customer.CrmCustomer": { "get": { "description": "Запросить объект с подобъектами в классе `ru.edgex.quickresto.modules.crm.customer.CrmCustomer` модуля `crm.customer`", "summary": "Клиент: запросить", "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "objectId", "in": "query", "description": "Идентификатор объекта", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.crm.customer.CrmCustomer.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "95364cf70f8c9319b22a514688d1155b", "tags": [ "Клиенты" ] } }, "/api/list?moduleName=crm.customer&className=ru.edgex.quickresto.modules.crm.customer.CrmCustomer": { "get": { "description": "Запросить список объектов в классе `ru.edgex.quickresto.modules.crm.customer.CrmCustomer` модуля `crm.customer`", "summary": "Клиент: список", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "description": "Указывает максимальное количество записей, которое должно быть возвращено в одном запросе.", "type": "integer" }, "offset": { "description": "Указывает начальную позицию в наборе данных, с которой будут возвращены записи.\n\nИспользуется вместе с параметром **limit**.", "type": "integer" } } } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "sortFields", "in": "query", "description": "Поля сортировки\n\nИспользуется вместе с параметром **sortOrders**.\n\nНекоторые поля не поддерживают сортировку.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sortOrders", "in": "query", "description": "Порядок сортировки полей\n\nИспользуется вместе с параметром **sortFields**.\n\nКоличество элементов параметра **sortOrders** должно соответствовать количеству элементов, указанных в параметре **sortFields**.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "asc", "desc" ] } } }, { "name": "filters", "in": "query", "description": "Фильтрация элементов\n\nНекоторые поля не поддерживают фильтрацию.", "schema": { "type": "array", "items": { "type": "object", "required": [ "field", "operation", "value" ], "properties": { "field": { "type": "string", "description": "Поле фильтрации", "required": true }, "operation": { "type": "string", "enum": [ "eq", "neq", "gte", "lte", "gt", "lt", "like", "contains", "range" ], "description": "Операция фильтрации для поля, указанного в параметре **field**." }, "value": { "type": [ "string", "object" ], "description": "Значение фильтрации.\n\n При значении `range` параметра **operation** используется объект с параметрами **since** и **till**.", "properties": { "since": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **till**." }, "till": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **since**." } } } } } } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.crm.customer.CrmCustomer.json" } } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "7e0ad28c3dac6c7b4499ee0db29ca545", "tags": [ "Клиенты" ] } }, "/api/create?moduleName=crm.customer&className=ru.edgex.quickresto.modules.crm.customer.CrmCustomer": { "post": { "description": "Создать объект в классе `ru.edgex.quickresto.modules.crm.customer.CrmCustomer` модуля `crm.customer`", "summary": "Клиент: создать", "requestBody": { "content": { "application/json": { "schema": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.crm.customer.CrmCustomer.json" } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.crm.customer.CrmCustomer.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "b8367032a51acc785888084fb5efa31e", "tags": [ "Клиенты" ] } }, "/api/update?moduleName=crm.customer&className=ru.edgex.quickresto.modules.crm.customer.CrmCustomer": { "post": { "description": "Модифицировать объект в классе `ru.edgex.quickresto.modules.crm.customer.CrmCustomer` модуля `crm.customer`", "summary": "Клиент: редактировать", "requestBody": { "content": { "application/json": { "schema": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.crm.customer.CrmCustomer.json" } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.crm.customer.CrmCustomer.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "9648f439a4771428195153a68a9f82c1", "tags": [ "Клиенты" ] } }, "/api/remove?moduleName=crm.customer&className=ru.edgex.quickresto.modules.crm.customer.CrmCustomer": { "post": { "description": "Удалить объект в классе `ru.edgex.quickresto.modules.crm.customer.CrmCustomer` модуля `crm.customer`", "summary": "Клиент: удалить", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "description": "Идентификатор объекта", "type": "integer" } }, "required": [ "id" ] } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.crm.customer.CrmCustomer.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "f4fcfcb2f1516c1bf4b695719802b4fc", "tags": [ "Клиенты" ] } }, "/api/read?moduleName=crm.customer.group&className=ru.edgex.quickresto.modules.crm.customer.group.CrmCustomerGroup": { "get": { "description": "Запросить объект с подобъектами в классе `ru.edgex.quickresto.modules.crm.customer.group.CrmCustomerGroup` модуля `crm.customer.group`", "summary": "Группа клиентов: запросить", "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "objectId", "in": "query", "description": "Идентификатор объекта", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.crm.customer.group.CrmCustomerGroup.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "4ed71ad8e7f4537e4a92a0411ccb8dd0", "tags": [ "Группы клиентов" ] } }, "/api/list?moduleName=crm.customer.group&className=ru.edgex.quickresto.modules.crm.customer.group.CrmCustomerGroup": { "get": { "description": "Запросить список объектов в классе `ru.edgex.quickresto.modules.crm.customer.group.CrmCustomerGroup` модуля `crm.customer.group`", "summary": "Группа клиентов: список", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "description": "Указывает максимальное количество записей, которое должно быть возвращено в одном запросе.", "type": "integer" }, "offset": { "description": "Указывает начальную позицию в наборе данных, с которой будут возвращены записи.\n\nИспользуется вместе с параметром **limit**.", "type": "integer" } } } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "sortFields", "in": "query", "description": "Поля сортировки\n\nИспользуется вместе с параметром **sortOrders**.\n\nНекоторые поля не поддерживают сортировку.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sortOrders", "in": "query", "description": "Порядок сортировки полей\n\nИспользуется вместе с параметром **sortFields**.\n\nКоличество элементов параметра **sortOrders** должно соответствовать количеству элементов, указанных в параметре **sortFields**.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "asc", "desc" ] } } }, { "name": "filters", "in": "query", "description": "Фильтрация элементов\n\nНекоторые поля не поддерживают фильтрацию.", "schema": { "type": "array", "items": { "type": "object", "required": [ "field", "operation", "value" ], "properties": { "field": { "type": "string", "description": "Поле фильтрации", "required": true }, "operation": { "type": "string", "enum": [ "eq", "neq", "gte", "lte", "gt", "lt", "like", "contains", "range" ], "description": "Операция фильтрации для поля, указанного в параметре **field**." }, "value": { "type": [ "string", "object" ], "description": "Значение фильтрации.\n\n При значении `range` параметра **operation** используется объект с параметрами **since** и **till**.", "properties": { "since": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **till**." }, "till": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **since**." } } } } } } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.crm.customer.group.CrmCustomerGroup.json" } } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "65a86076674747f236a3a313a669ba24", "tags": [ "Группы клиентов" ] } }, "/api/update?moduleName=crm.customer.group&className=ru.edgex.quickresto.modules.crm.customer.group.CrmCustomerGroup": { "post": { "description": "Модифицировать объект в классе `ru.edgex.quickresto.modules.crm.customer.group.CrmCustomerGroup` модуля `crm.customer.group`", "summary": "Группа клиентов: редактировать", "requestBody": { "content": { "application/json": { "schema": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.crm.customer.group.CrmCustomerGroup.json" } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.crm.customer.group.CrmCustomerGroup.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "f4be25609f015fc168cff7a304ed211b", "tags": [ "Группы клиентов" ] } }, "/api/remove?moduleName=crm.customer.group&className=ru.edgex.quickresto.modules.crm.customer.group.CrmCustomerGroup": { "post": { "description": "Удалить объект в классе `ru.edgex.quickresto.modules.crm.customer.group.CrmCustomerGroup` модуля `crm.customer.group`", "summary": "Группа клиентов: удалить", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "description": "Идентификатор объекта", "type": "integer" } }, "required": [ "id" ] } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.crm.customer.group.CrmCustomerGroup.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "574ed0165b2760ec7d55123807b1e702", "tags": [ "Группы клиентов" ] } }, "/api/read?moduleName=crm.settings.bonus&className=ru.edgex.quickresto.modules.crm.settings.bonus.BonusProgram": { "get": { "description": "Запросить объект с подобъектами в классе `ru.edgex.quickresto.modules.crm.settings.bonus.BonusProgram` модуля `crm.settings.bonus`", "summary": "Бонусная программа: запросить", "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "objectId", "in": "query", "description": "Идентификатор объекта", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.crm.settings.bonus.BonusProgram.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "985e958f028f544626ed7f0534459a6d", "tags": [ "Бонусные программы" ] } }, "/api/list?moduleName=crm.settings.bonus&className=ru.edgex.quickresto.modules.crm.settings.bonus.BonusProgram": { "get": { "description": "Запросить список объектов в классе `ru.edgex.quickresto.modules.crm.settings.bonus.BonusProgram` модуля `crm.settings.bonus`", "summary": "Бонусная программа: список", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "description": "Указывает максимальное количество записей, которое должно быть возвращено в одном запросе.", "type": "integer" }, "offset": { "description": "Указывает начальную позицию в наборе данных, с которой будут возвращены записи.\n\nИспользуется вместе с параметром **limit**.", "type": "integer" } } } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "sortFields", "in": "query", "description": "Поля сортировки\n\nИспользуется вместе с параметром **sortOrders**.\n\nНекоторые поля не поддерживают сортировку.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sortOrders", "in": "query", "description": "Порядок сортировки полей\n\nИспользуется вместе с параметром **sortFields**.\n\nКоличество элементов параметра **sortOrders** должно соответствовать количеству элементов, указанных в параметре **sortFields**.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "asc", "desc" ] } } }, { "name": "filters", "in": "query", "description": "Фильтрация элементов\n\nНекоторые поля не поддерживают фильтрацию.", "schema": { "type": "array", "items": { "type": "object", "required": [ "field", "operation", "value" ], "properties": { "field": { "type": "string", "description": "Поле фильтрации", "required": true }, "operation": { "type": "string", "enum": [ "eq", "neq", "gte", "lte", "gt", "lt", "like", "contains", "range" ], "description": "Операция фильтрации для поля, указанного в параметре **field**." }, "value": { "type": [ "string", "object" ], "description": "Значение фильтрации.\n\n При значении `range` параметра **operation** используется объект с параметрами **since** и **till**.", "properties": { "since": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **till**." }, "till": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **since**." } } } } } } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.crm.settings.bonus.BonusProgram.json" } } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "0353285721629645ecab225398b95edf", "tags": [ "Бонусные программы" ] } }, "/api/remove?moduleName=crm.settings.bonus&className=ru.edgex.quickresto.modules.crm.settings.bonus.BonusProgram": { "post": { "description": "Удалить объект в классе `ru.edgex.quickresto.modules.crm.settings.bonus.BonusProgram` модуля `crm.settings.bonus`", "summary": "Бонусная программа: удалить", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "description": "Идентификатор объекта", "type": "integer" } }, "required": [ "id" ] } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.crm.settings.bonus.BonusProgram.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "d47111b7be6275239afa11291134dc2a", "tags": [ "Бонусные программы" ] } }, "/api/read?moduleName=crm.settings.fixed&className=ru.edgex.quickresto.modules.crm.settings.fixed.FixedDiscount": { "get": { "description": "Запросить объект с подобъектами в классе `ru.edgex.quickresto.modules.crm.settings.fixed.FixedDiscount` модуля `crm.settings.fixed`", "summary": "Фиксированная скидка: запросить", "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "objectId", "in": "query", "description": "Идентификатор объекта", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.crm.settings.fixed.FixedDiscount.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "4f237c906ff7868b5e6c2eaf2ca39233", "tags": [ "Фиксированные скидки" ] } }, "/api/list?moduleName=crm.settings.fixed&className=ru.edgex.quickresto.modules.crm.settings.fixed.FixedDiscount": { "get": { "description": "Запросить список объектов в классе `ru.edgex.quickresto.modules.crm.settings.fixed.FixedDiscount` модуля `crm.settings.fixed`", "summary": "Фиксированная скидка: список", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "description": "Указывает максимальное количество записей, которое должно быть возвращено в одном запросе.", "type": "integer" }, "offset": { "description": "Указывает начальную позицию в наборе данных, с которой будут возвращены записи.\n\nИспользуется вместе с параметром **limit**.", "type": "integer" } } } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "sortFields", "in": "query", "description": "Поля сортировки\n\nИспользуется вместе с параметром **sortOrders**.\n\nНекоторые поля не поддерживают сортировку.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sortOrders", "in": "query", "description": "Порядок сортировки полей\n\nИспользуется вместе с параметром **sortFields**.\n\nКоличество элементов параметра **sortOrders** должно соответствовать количеству элементов, указанных в параметре **sortFields**.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "asc", "desc" ] } } }, { "name": "filters", "in": "query", "description": "Фильтрация элементов\n\nНекоторые поля не поддерживают фильтрацию.", "schema": { "type": "array", "items": { "type": "object", "required": [ "field", "operation", "value" ], "properties": { "field": { "type": "string", "description": "Поле фильтрации", "required": true }, "operation": { "type": "string", "enum": [ "eq", "neq", "gte", "lte", "gt", "lt", "like", "contains", "range" ], "description": "Операция фильтрации для поля, указанного в параметре **field**." }, "value": { "type": [ "string", "object" ], "description": "Значение фильтрации.\n\n При значении `range` параметра **operation** используется объект с параметрами **since** и **till**.", "properties": { "since": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **till**." }, "till": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **since**." } } } } } } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.crm.settings.fixed.FixedDiscount.json" } } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "6347c77ad738b58bc41a8e43bedc77f7", "tags": [ "Фиксированные скидки" ] } }, "/api/read?moduleName=crm.settings.fixedmarkup&className=ru.edgex.quickresto.modules.crm.settings.fixedmarkup.FixedMarkup": { "get": { "description": "Запросить объект с подобъектами в классе `ru.edgex.quickresto.modules.crm.settings.fixedmarkup.FixedMarkup` модуля `crm.settings.fixedmarkup`", "summary": "Фиксированная надбавка: запросить", "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "objectId", "in": "query", "description": "Идентификатор объекта", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.crm.settings.fixedmarkup.FixedMarkup.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "8c626f10a83d1e77e307ab485cf28301", "tags": [ "Фиксированные надбавки" ] } }, "/api/list?moduleName=crm.settings.fixedmarkup&className=ru.edgex.quickresto.modules.crm.settings.fixedmarkup.FixedMarkup": { "get": { "description": "Запросить список объектов в классе `ru.edgex.quickresto.modules.crm.settings.fixedmarkup.FixedMarkup` модуля `crm.settings.fixedmarkup`", "summary": "Фиксированная надбавка: список", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "description": "Указывает максимальное количество записей, которое должно быть возвращено в одном запросе.", "type": "integer" }, "offset": { "description": "Указывает начальную позицию в наборе данных, с которой будут возвращены записи.\n\nИспользуется вместе с параметром **limit**.", "type": "integer" } } } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "sortFields", "in": "query", "description": "Поля сортировки\n\nИспользуется вместе с параметром **sortOrders**.\n\nНекоторые поля не поддерживают сортировку.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sortOrders", "in": "query", "description": "Порядок сортировки полей\n\nИспользуется вместе с параметром **sortFields**.\n\nКоличество элементов параметра **sortOrders** должно соответствовать количеству элементов, указанных в параметре **sortFields**.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "asc", "desc" ] } } }, { "name": "filters", "in": "query", "description": "Фильтрация элементов\n\nНекоторые поля не поддерживают фильтрацию.", "schema": { "type": "array", "items": { "type": "object", "required": [ "field", "operation", "value" ], "properties": { "field": { "type": "string", "description": "Поле фильтрации", "required": true }, "operation": { "type": "string", "enum": [ "eq", "neq", "gte", "lte", "gt", "lt", "like", "contains", "range" ], "description": "Операция фильтрации для поля, указанного в параметре **field**." }, "value": { "type": [ "string", "object" ], "description": "Значение фильтрации.\n\n При значении `range` параметра **operation** используется объект с параметрами **since** и **till**.", "properties": { "since": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **till**." }, "till": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **since**." } } } } } } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.crm.settings.fixedmarkup.FixedMarkup.json" } } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "cb4d59e441eb0d1a5cfbc133e3f9d582", "tags": [ "Фиксированные надбавки" ] } }, "/api/read?moduleName=crm.settings.markup&className=ru.edgex.quickresto.modules.crm.settings.markup.Markup": { "get": { "description": "Запросить объект с подобъектами в классе `ru.edgex.quickresto.modules.crm.settings.markup.Markup` модуля `crm.settings.markup`", "summary": "Надбавка по расписанию: запросить", "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "objectId", "in": "query", "description": "Идентификатор объекта", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.crm.settings.markup.Markup.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "4a06757c8070ac1830223be12aae8fdd", "tags": [ "Надбавки по расписанию" ] } }, "/api/list?moduleName=crm.settings.markup&className=ru.edgex.quickresto.modules.crm.settings.markup.Markup": { "get": { "description": "Запросить список объектов в классе `ru.edgex.quickresto.modules.crm.settings.markup.Markup` модуля `crm.settings.markup`", "summary": "Надбавка по расписанию: список", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "description": "Указывает максимальное количество записей, которое должно быть возвращено в одном запросе.", "type": "integer" }, "offset": { "description": "Указывает начальную позицию в наборе данных, с которой будут возвращены записи.\n\nИспользуется вместе с параметром **limit**.", "type": "integer" } } } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "sortFields", "in": "query", "description": "Поля сортировки\n\nИспользуется вместе с параметром **sortOrders**.\n\nНекоторые поля не поддерживают сортировку.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sortOrders", "in": "query", "description": "Порядок сортировки полей\n\nИспользуется вместе с параметром **sortFields**.\n\nКоличество элементов параметра **sortOrders** должно соответствовать количеству элементов, указанных в параметре **sortFields**.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "asc", "desc" ] } } }, { "name": "filters", "in": "query", "description": "Фильтрация элементов\n\nНекоторые поля не поддерживают фильтрацию.", "schema": { "type": "array", "items": { "type": "object", "required": [ "field", "operation", "value" ], "properties": { "field": { "type": "string", "description": "Поле фильтрации", "required": true }, "operation": { "type": "string", "enum": [ "eq", "neq", "gte", "lte", "gt", "lt", "like", "contains", "range" ], "description": "Операция фильтрации для поля, указанного в параметре **field**." }, "value": { "type": [ "string", "object" ], "description": "Значение фильтрации.\n\n При значении `range` параметра **operation** используется объект с параметрами **since** и **till**.", "properties": { "since": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **till**." }, "till": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **since**." } } } } } } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.crm.settings.markup.Markup.json" } } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "ea00981e5dd0db58be579bf78667efbd", "tags": [ "Надбавки по расписанию" ] } }, "/api/read?moduleName=crm.settings.offers&className=ru.edgex.quickresto.modules.crm.settings.offers.SpecialOffer": { "get": { "description": "Запросить объект с подобъектами в классе `ru.edgex.quickresto.modules.crm.settings.offers.SpecialOffer` модуля `crm.settings.offers`", "summary": "Акция: запросить", "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "objectId", "in": "query", "description": "Идентификатор объекта", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.crm.settings.offers.SpecialOffer.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "b14c17fe4b27090140886d9df63ca3cf", "tags": [ "Акции" ] } }, "/api/list?moduleName=crm.settings.offers&className=ru.edgex.quickresto.modules.crm.settings.offers.SpecialOffer": { "get": { "description": "Запросить список объектов в классе `ru.edgex.quickresto.modules.crm.settings.offers.SpecialOffer` модуля `crm.settings.offers`", "summary": "Акция: список", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "description": "Указывает максимальное количество записей, которое должно быть возвращено в одном запросе.", "type": "integer" }, "offset": { "description": "Указывает начальную позицию в наборе данных, с которой будут возвращены записи.\n\nИспользуется вместе с параметром **limit**.", "type": "integer" } } } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "sortFields", "in": "query", "description": "Поля сортировки\n\nИспользуется вместе с параметром **sortOrders**.\n\nНекоторые поля не поддерживают сортировку.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sortOrders", "in": "query", "description": "Порядок сортировки полей\n\nИспользуется вместе с параметром **sortFields**.\n\nКоличество элементов параметра **sortOrders** должно соответствовать количеству элементов, указанных в параметре **sortFields**.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "asc", "desc" ] } } }, { "name": "filters", "in": "query", "description": "Фильтрация элементов\n\nНекоторые поля не поддерживают фильтрацию.", "schema": { "type": "array", "items": { "type": "object", "required": [ "field", "operation", "value" ], "properties": { "field": { "type": "string", "description": "Поле фильтрации", "required": true }, "operation": { "type": "string", "enum": [ "eq", "neq", "gte", "lte", "gt", "lt", "like", "contains", "range" ], "description": "Операция фильтрации для поля, указанного в параметре **field**." }, "value": { "type": [ "string", "object" ], "description": "Значение фильтрации.\n\n При значении `range` параметра **operation** используется объект с параметрами **since** и **till**.", "properties": { "since": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **till**." }, "till": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **since**." } } } } } } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.crm.settings.offers.SpecialOffer.json" } } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "6f48ad6b9f3d0910826aecb56906a723", "tags": [ "Акции" ] } }, "/api/read?moduleName=crm.settings.scheduled&className=ru.edgex.quickresto.modules.crm.settings.scheduled.ScheduledDiscount": { "get": { "description": "Запросить объект с подобъектами в классе `ru.edgex.quickresto.modules.crm.settings.scheduled.ScheduledDiscount` модуля `crm.settings.scheduled`", "summary": "Скидка по расписанию: запросить", "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "objectId", "in": "query", "description": "Идентификатор объекта", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.crm.settings.scheduled.ScheduledDiscount.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "579c9bec163590a9bf3d01368ab7797b", "tags": [ "Скидки по расписанию" ] } }, "/api/list?moduleName=crm.settings.scheduled&className=ru.edgex.quickresto.modules.crm.settings.scheduled.ScheduledDiscount": { "get": { "description": "Запросить список объектов в классе `ru.edgex.quickresto.modules.crm.settings.scheduled.ScheduledDiscount` модуля `crm.settings.scheduled`", "summary": "Скидка по расписанию: список", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "description": "Указывает максимальное количество записей, которое должно быть возвращено в одном запросе.", "type": "integer" }, "offset": { "description": "Указывает начальную позицию в наборе данных, с которой будут возвращены записи.\n\nИспользуется вместе с параметром **limit**.", "type": "integer" } } } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "sortFields", "in": "query", "description": "Поля сортировки\n\nИспользуется вместе с параметром **sortOrders**.\n\nНекоторые поля не поддерживают сортировку.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sortOrders", "in": "query", "description": "Порядок сортировки полей\n\nИспользуется вместе с параметром **sortFields**.\n\nКоличество элементов параметра **sortOrders** должно соответствовать количеству элементов, указанных в параметре **sortFields**.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "asc", "desc" ] } } }, { "name": "filters", "in": "query", "description": "Фильтрация элементов\n\nНекоторые поля не поддерживают фильтрацию.", "schema": { "type": "array", "items": { "type": "object", "required": [ "field", "operation", "value" ], "properties": { "field": { "type": "string", "description": "Поле фильтрации", "required": true }, "operation": { "type": "string", "enum": [ "eq", "neq", "gte", "lte", "gt", "lt", "like", "contains", "range" ], "description": "Операция фильтрации для поля, указанного в параметре **field**." }, "value": { "type": [ "string", "object" ], "description": "Значение фильтрации.\n\n При значении `range` параметра **operation** используется объект с параметрами **since** и **till**.", "properties": { "since": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **till**." }, "till": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **since**." } } } } } } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.crm.settings.scheduled.ScheduledDiscount.json" } } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "b245c2b94d06215afa75d9c3b7dd725b", "tags": [ "Скидки по расписанию" ] } }, "/api/read?moduleName=delivery.settings&className=ru.edgex.quickresto.modules.delivery.settings.DeliverySetting": { "get": { "description": "Запросить объект с подобъектами в классе `ru.edgex.quickresto.modules.delivery.settings.DeliverySetting` модуля `delivery.settings`", "summary": "Настройки доставки: запросить", "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "objectId", "in": "query", "description": "Идентификатор объекта", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.delivery.settings.DeliverySetting.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "c294b730101f8fdbb41259e1a840a642", "tags": [ "Доставка" ] } }, "/api/list?moduleName=delivery.settings&className=ru.edgex.quickresto.modules.delivery.settings.DeliverySetting": { "get": { "description": "Запросить список объектов в классе `ru.edgex.quickresto.modules.delivery.settings.DeliverySetting` модуля `delivery.settings`", "summary": "Настройки доставки: список", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "description": "Указывает максимальное количество записей, которое должно быть возвращено в одном запросе.", "type": "integer" }, "offset": { "description": "Указывает начальную позицию в наборе данных, с которой будут возвращены записи.\n\nИспользуется вместе с параметром **limit**.", "type": "integer" } } } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "sortFields", "in": "query", "description": "Поля сортировки\n\nИспользуется вместе с параметром **sortOrders**.\n\nНекоторые поля не поддерживают сортировку.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sortOrders", "in": "query", "description": "Порядок сортировки полей\n\nИспользуется вместе с параметром **sortFields**.\n\nКоличество элементов параметра **sortOrders** должно соответствовать количеству элементов, указанных в параметре **sortFields**.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "asc", "desc" ] } } }, { "name": "filters", "in": "query", "description": "Фильтрация элементов\n\nНекоторые поля не поддерживают фильтрацию.", "schema": { "type": "array", "items": { "type": "object", "required": [ "field", "operation", "value" ], "properties": { "field": { "type": "string", "description": "Поле фильтрации", "required": true }, "operation": { "type": "string", "enum": [ "eq", "neq", "gte", "lte", "gt", "lt", "like", "contains", "range" ], "description": "Операция фильтрации для поля, указанного в параметре **field**." }, "value": { "type": [ "string", "object" ], "description": "Значение фильтрации.\n\n При значении `range` параметра **operation** используется объект с параметрами **since** и **till**.", "properties": { "since": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **till**." }, "till": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **since**." } } } } } } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.delivery.settings.DeliverySetting.json" } } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "2a44c2d5325f94e6d3b88625327f1bdb", "tags": [ "Доставка" ] } }, "/api/update?moduleName=delivery.settings&className=ru.edgex.quickresto.modules.delivery.settings.DeliverySetting": { "post": { "description": "Модифицировать объект в классе `ru.edgex.quickresto.modules.delivery.settings.DeliverySetting` модуля `delivery.settings`", "summary": "Настройки доставки: редактировать", "requestBody": { "content": { "application/json": { "schema": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.delivery.settings.DeliverySetting.json" } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.delivery.settings.DeliverySetting.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "ba6ffa88b608eb1d72b18ad896d2956a", "tags": [ "Доставка" ] } }, "/api/remove?moduleName=delivery.settings&className=ru.edgex.quickresto.modules.delivery.settings.DeliverySetting": { "post": { "description": "Удалить объект в классе `ru.edgex.quickresto.modules.delivery.settings.DeliverySetting` модуля `delivery.settings`", "summary": "Настройки доставки: удалить", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "description": "Идентификатор объекта", "type": "integer" } }, "required": [ "id" ] } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.delivery.settings.DeliverySetting.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "8437b3575833f6bfce3b17a9e2105b87", "tags": [ "Доставка" ] } }, "/api/read?moduleName=delivery.settings&className=ru.edgex.quickresto.modules.delivery.settings.DeliveryGradePrice": { "get": { "description": "Запросить объект с подобъектами в классе `ru.edgex.quickresto.modules.delivery.settings.DeliveryGradePrice` модуля `delivery.settings`", "summary": "Диапазон стоимости доставки: запросить", "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "objectId", "in": "query", "description": "Идентификатор объекта", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.delivery.settings.DeliveryGradePrice.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "1e34dad278ff02f1997b261964d845f1", "tags": [ "Доставка" ] } }, "/api/list?moduleName=delivery.settings&className=ru.edgex.quickresto.modules.delivery.settings.DeliveryGradePrice": { "get": { "description": "Запросить список объектов в классе `ru.edgex.quickresto.modules.delivery.settings.DeliveryGradePrice` модуля `delivery.settings`", "summary": "Диапазон стоимости доставки: список", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "description": "Указывает максимальное количество записей, которое должно быть возвращено в одном запросе.", "type": "integer" }, "offset": { "description": "Указывает начальную позицию в наборе данных, с которой будут возвращены записи.\n\nИспользуется вместе с параметром **limit**.", "type": "integer" } } } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "sortFields", "in": "query", "description": "Поля сортировки\n\nИспользуется вместе с параметром **sortOrders**.\n\nНекоторые поля не поддерживают сортировку.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sortOrders", "in": "query", "description": "Порядок сортировки полей\n\nИспользуется вместе с параметром **sortFields**.\n\nКоличество элементов параметра **sortOrders** должно соответствовать количеству элементов, указанных в параметре **sortFields**.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "asc", "desc" ] } } }, { "name": "filters", "in": "query", "description": "Фильтрация элементов\n\nНекоторые поля не поддерживают фильтрацию.", "schema": { "type": "array", "items": { "type": "object", "required": [ "field", "operation", "value" ], "properties": { "field": { "type": "string", "description": "Поле фильтрации", "required": true }, "operation": { "type": "string", "enum": [ "eq", "neq", "gte", "lte", "gt", "lt", "like", "contains", "range" ], "description": "Операция фильтрации для поля, указанного в параметре **field**." }, "value": { "type": [ "string", "object" ], "description": "Значение фильтрации.\n\n При значении `range` параметра **operation** используется объект с параметрами **since** и **till**.", "properties": { "since": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **till**." }, "till": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **since**." } } } } } } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.delivery.settings.DeliveryGradePrice.json" } } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "5b9f67b3446453c457588659a00af005", "tags": [ "Доставка" ] } }, "/api/update?moduleName=delivery.settings&className=ru.edgex.quickresto.modules.delivery.settings.DeliveryGradePrice": { "post": { "description": "Модифицировать объект в классе `ru.edgex.quickresto.modules.delivery.settings.DeliveryGradePrice` модуля `delivery.settings`", "summary": "Диапазон стоимости доставки: редактировать", "requestBody": { "content": { "application/json": { "schema": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.delivery.settings.DeliveryGradePrice.json" } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.delivery.settings.DeliveryGradePrice.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "eae3984468a9c433d7081af84014e33b", "tags": [ "Доставка" ] } }, "/api/remove?moduleName=delivery.settings&className=ru.edgex.quickresto.modules.delivery.settings.DeliveryGradePrice": { "post": { "description": "Удалить объект в классе `ru.edgex.quickresto.modules.delivery.settings.DeliveryGradePrice` модуля `delivery.settings`", "summary": "Диапазон стоимости доставки: удалить", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "description": "Идентификатор объекта", "type": "integer" } }, "required": [ "id" ] } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.delivery.settings.DeliveryGradePrice.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "f5eb1c0c8b20e8686587f0145d5fd2ff", "tags": [ "Доставка" ] } }, "/api/read?moduleName=finances.tranaccounts&className=ru.edgex.quickresto.modules.finances.tranaccounts.TranAccount": { "get": { "description": "Запросить объект с подобъектами в классе `ru.edgex.quickresto.modules.finances.tranaccounts.TranAccount` модуля `finances.tranaccounts`", "summary": "Финансовый счет: запросить", "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "objectId", "in": "query", "description": "Идентификатор объекта", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.finances.tranaccounts.TranAccount.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "b31d6fd8875a455ded262aceb6b99b41", "tags": [ "Счета" ] } }, "/api/list?moduleName=finances.tranaccounts&className=ru.edgex.quickresto.modules.finances.tranaccounts.TranAccount": { "get": { "description": "Запросить список объектов в классе `ru.edgex.quickresto.modules.finances.tranaccounts.TranAccount` модуля `finances.tranaccounts`", "summary": "Финансовый счет: список", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "description": "Указывает максимальное количество записей, которое должно быть возвращено в одном запросе.", "type": "integer" }, "offset": { "description": "Указывает начальную позицию в наборе данных, с которой будут возвращены записи.\n\nИспользуется вместе с параметром **limit**.", "type": "integer" } } } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "sortFields", "in": "query", "description": "Поля сортировки\n\nИспользуется вместе с параметром **sortOrders**.\n\nНекоторые поля не поддерживают сортировку.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sortOrders", "in": "query", "description": "Порядок сортировки полей\n\nИспользуется вместе с параметром **sortFields**.\n\nКоличество элементов параметра **sortOrders** должно соответствовать количеству элементов, указанных в параметре **sortFields**.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "asc", "desc" ] } } }, { "name": "filters", "in": "query", "description": "Фильтрация элементов\n\nНекоторые поля не поддерживают фильтрацию.", "schema": { "type": "array", "items": { "type": "object", "required": [ "field", "operation", "value" ], "properties": { "field": { "type": "string", "description": "Поле фильтрации", "required": true }, "operation": { "type": "string", "enum": [ "eq", "neq", "gte", "lte", "gt", "lt", "like", "contains", "range" ], "description": "Операция фильтрации для поля, указанного в параметре **field**." }, "value": { "type": [ "string", "object" ], "description": "Значение фильтрации.\n\n При значении `range` параметра **operation** используется объект с параметрами **since** и **till**.", "properties": { "since": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **till**." }, "till": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **since**." } } } } } } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.finances.tranaccounts.TranAccount.json" } } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "8daeee6eaf8761b31dd9eea5b87f8907", "tags": [ "Счета" ] } }, "/api/read?moduleName=front.cancellations&className=ru.edgex.quickresto.modules.front.cancellations.Cancellation": { "get": { "description": "Запросить объект с подобъектами в классе `ru.edgex.quickresto.modules.front.cancellations.Cancellation` модуля `front.cancellations`", "summary": "Отмена: запросить", "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "objectId", "in": "query", "description": "Идентификатор объекта", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.front.cancellations.Cancellation.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "cd489f8ac4d5e9c39680742440f1fc64", "tags": [ "Отмены" ] } }, "/api/list?moduleName=front.cancellations&className=ru.edgex.quickresto.modules.front.cancellations.Cancellation": { "get": { "description": "Запросить список объектов в классе `ru.edgex.quickresto.modules.front.cancellations.Cancellation` модуля `front.cancellations`", "summary": "Отмена: список", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "description": "Указывает максимальное количество записей, которое должно быть возвращено в одном запросе.", "type": "integer" }, "offset": { "description": "Указывает начальную позицию в наборе данных, с которой будут возвращены записи.\n\nИспользуется вместе с параметром **limit**.", "type": "integer" } } } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "sortFields", "in": "query", "description": "Поля сортировки\n\nИспользуется вместе с параметром **sortOrders**.\n\nНекоторые поля не поддерживают сортировку.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sortOrders", "in": "query", "description": "Порядок сортировки полей\n\nИспользуется вместе с параметром **sortFields**.\n\nКоличество элементов параметра **sortOrders** должно соответствовать количеству элементов, указанных в параметре **sortFields**.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "asc", "desc" ] } } }, { "name": "filters", "in": "query", "description": "Фильтрация элементов\n\nНекоторые поля не поддерживают фильтрацию.", "schema": { "type": "array", "items": { "type": "object", "required": [ "field", "operation", "value" ], "properties": { "field": { "type": "string", "description": "Поле фильтрации", "required": true }, "operation": { "type": "string", "enum": [ "eq", "neq", "gte", "lte", "gt", "lt", "like", "contains", "range" ], "description": "Операция фильтрации для поля, указанного в параметре **field**." }, "value": { "type": [ "string", "object" ], "description": "Значение фильтрации.\n\n При значении `range` параметра **operation** используется объект с параметрами **since** и **till**.", "properties": { "since": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **till**." }, "till": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **since**." } } } } } } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.front.cancellations.Cancellation.json" } } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "5ce9809b45d2ba90cb2885b1f02f8011", "tags": [ "Отмены" ] } }, "/api/read?moduleName=front.encashment&className=ru.edgex.quickresto.modules.front.encashment.Encashment": { "get": { "description": "Запросить объект с подобъектами в классе `ru.edgex.quickresto.modules.front.encashment.Encashment` модуля `front.encashment`", "summary": "Внесение/инкассация: запросить", "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "objectId", "in": "query", "description": "Идентификатор объекта", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.front.encashment.Encashment.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "75f478439e7fe600f9104f9b9770562a", "tags": [ "Внесения/инкассации" ] } }, "/api/list?moduleName=front.encashment&className=ru.edgex.quickresto.modules.front.encashment.Encashment": { "get": { "description": "Запросить список объектов в классе `ru.edgex.quickresto.modules.front.encashment.Encashment` модуля `front.encashment`", "summary": "Внесение/инкассация: список", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "description": "Указывает максимальное количество записей, которое должно быть возвращено в одном запросе.", "type": "integer" }, "offset": { "description": "Указывает начальную позицию в наборе данных, с которой будут возвращены записи.\n\nИспользуется вместе с параметром **limit**.", "type": "integer" } } } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "sortFields", "in": "query", "description": "Поля сортировки\n\nИспользуется вместе с параметром **sortOrders**.\n\nНекоторые поля не поддерживают сортировку.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sortOrders", "in": "query", "description": "Порядок сортировки полей\n\nИспользуется вместе с параметром **sortFields**.\n\nКоличество элементов параметра **sortOrders** должно соответствовать количеству элементов, указанных в параметре **sortFields**.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "asc", "desc" ] } } }, { "name": "filters", "in": "query", "description": "Фильтрация элементов\n\nНекоторые поля не поддерживают фильтрацию.", "schema": { "type": "array", "items": { "type": "object", "required": [ "field", "operation", "value" ], "properties": { "field": { "type": "string", "description": "Поле фильтрации", "required": true }, "operation": { "type": "string", "enum": [ "eq", "neq", "gte", "lte", "gt", "lt", "like", "contains", "range" ], "description": "Операция фильтрации для поля, указанного в параметре **field**." }, "value": { "type": [ "string", "object" ], "description": "Значение фильтрации.\n\n При значении `range` параметра **operation** используется объект с параметрами **since** и **till**.", "properties": { "since": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **till**." }, "till": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **since**." } } } } } } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.front.encashment.Encashment.json" } } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "f066c8cc37114aa0d4eda0a6e4e505a9", "tags": [ "Внесения/инкассации" ] } }, "/api/read?moduleName=front.orders&className=ru.edgex.quickresto.modules.front.orders.OrderInfo": { "get": { "description": "Запросить объект с подобъектами в классе `ru.edgex.quickresto.modules.front.orders.OrderInfo` модуля `front.orders`", "summary": "Чек: запросить", "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "objectId", "in": "query", "description": "Идентификатор объекта", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.front.orders.OrderInfo.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "11400973f59d5b616c318840fecc110d", "tags": [ "Чеки" ] } }, "/api/list?moduleName=front.orders&className=ru.edgex.quickresto.modules.front.orders.OrderInfo": { "get": { "description": "Запросить список объектов в классе `ru.edgex.quickresto.modules.front.orders.OrderInfo` модуля `front.orders`", "summary": "Чек: список", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "description": "Указывает максимальное количество записей, которое должно быть возвращено в одном запросе.", "type": "integer" }, "offset": { "description": "Указывает начальную позицию в наборе данных, с которой будут возвращены записи.\n\nИспользуется вместе с параметром **limit**.", "type": "integer" } } } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "sortFields", "in": "query", "description": "Поля сортировки\n\nИспользуется вместе с параметром **sortOrders**.\n\nНекоторые поля не поддерживают сортировку.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sortOrders", "in": "query", "description": "Порядок сортировки полей\n\nИспользуется вместе с параметром **sortFields**.\n\nКоличество элементов параметра **sortOrders** должно соответствовать количеству элементов, указанных в параметре **sortFields**.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "asc", "desc" ] } } }, { "name": "filters", "in": "query", "description": "Фильтрация элементов\n\nНекоторые поля не поддерживают фильтрацию.", "schema": { "type": "array", "items": { "type": "object", "required": [ "field", "operation", "value" ], "properties": { "field": { "type": "string", "description": "Поле фильтрации", "required": true }, "operation": { "type": "string", "enum": [ "eq", "neq", "gte", "lte", "gt", "lt", "like", "contains", "range" ], "description": "Операция фильтрации для поля, указанного в параметре **field**." }, "value": { "type": [ "string", "object" ], "description": "Значение фильтрации.\n\n При значении `range` параметра **operation** используется объект с параметрами **since** и **till**.", "properties": { "since": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **till**." }, "till": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **since**." } } } } } } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.front.orders.OrderInfo.json" } } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "4fdbacb46bd5b3e65e0066d99b4b673a", "tags": [ "Чеки" ] } }, "/api/read?moduleName=front.preorders&className=ru.edgex.quickresto.modules.front.preorders.PreorderInfo": { "get": { "description": "Запросить объект с подобъектами в классе `ru.edgex.quickresto.modules.front.preorders.PreorderInfo` модуля `front.preorders`", "summary": "Пречек: запросить", "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "objectId", "in": "query", "description": "Идентификатор объекта", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.front.preorders.PreorderInfo.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "c34d26469ede56f4694985cf2f7de173", "tags": [ "Пречеки" ] } }, "/api/list?moduleName=front.preorders&className=ru.edgex.quickresto.modules.front.preorders.PreorderInfo": { "get": { "description": "Запросить список объектов в классе `ru.edgex.quickresto.modules.front.preorders.PreorderInfo` модуля `front.preorders`", "summary": "Пречек: список", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "description": "Указывает максимальное количество записей, которое должно быть возвращено в одном запросе.", "type": "integer" }, "offset": { "description": "Указывает начальную позицию в наборе данных, с которой будут возвращены записи.\n\nИспользуется вместе с параметром **limit**.", "type": "integer" } } } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "sortFields", "in": "query", "description": "Поля сортировки\n\nИспользуется вместе с параметром **sortOrders**.\n\nНекоторые поля не поддерживают сортировку.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sortOrders", "in": "query", "description": "Порядок сортировки полей\n\nИспользуется вместе с параметром **sortFields**.\n\nКоличество элементов параметра **sortOrders** должно соответствовать количеству элементов, указанных в параметре **sortFields**.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "asc", "desc" ] } } }, { "name": "filters", "in": "query", "description": "Фильтрация элементов\n\nНекоторые поля не поддерживают фильтрацию.", "schema": { "type": "array", "items": { "type": "object", "required": [ "field", "operation", "value" ], "properties": { "field": { "type": "string", "description": "Поле фильтрации", "required": true }, "operation": { "type": "string", "enum": [ "eq", "neq", "gte", "lte", "gt", "lt", "like", "contains", "range" ], "description": "Операция фильтрации для поля, указанного в параметре **field**." }, "value": { "type": [ "string", "object" ], "description": "Значение фильтрации.\n\n При значении `range` параметра **operation** используется объект с параметрами **since** и **till**.", "properties": { "since": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **till**." }, "till": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **since**." } } } } } } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.front.preorders.PreorderInfo.json" } } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "e5ef39f72a0bb2013d745c84695c3ae2", "tags": [ "Пречеки" ] } }, "/api/read?moduleName=front.tablemanagement&className=ru.edgex.quickresto.modules.front.tablemanagement.TableScheme": { "get": { "description": "Запросить объект с подобъектами в классе `ru.edgex.quickresto.modules.front.tablemanagement.TableScheme` модуля `front.tablemanagement`", "summary": "Заведение: запросить", "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "objectId", "in": "query", "description": "Идентификатор объекта", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.front.tablemanagement.TableScheme.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "ab79a1c1b843aaa8bbd53234f8d5a6f3", "tags": [ "Заведения" ] } }, "/api/list?moduleName=front.tablemanagement&className=ru.edgex.quickresto.modules.front.tablemanagement.TableScheme": { "get": { "description": "Запросить список объектов в классе `ru.edgex.quickresto.modules.front.tablemanagement.TableScheme` модуля `front.tablemanagement`", "summary": "Заведение: список", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "description": "Указывает максимальное количество записей, которое должно быть возвращено в одном запросе.", "type": "integer" }, "offset": { "description": "Указывает начальную позицию в наборе данных, с которой будут возвращены записи.\n\nИспользуется вместе с параметром **limit**.", "type": "integer" } } } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "sortFields", "in": "query", "description": "Поля сортировки\n\nИспользуется вместе с параметром **sortOrders**.\n\nНекоторые поля не поддерживают сортировку.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sortOrders", "in": "query", "description": "Порядок сортировки полей\n\nИспользуется вместе с параметром **sortFields**.\n\nКоличество элементов параметра **sortOrders** должно соответствовать количеству элементов, указанных в параметре **sortFields**.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "asc", "desc" ] } } }, { "name": "filters", "in": "query", "description": "Фильтрация элементов\n\nНекоторые поля не поддерживают фильтрацию.", "schema": { "type": "array", "items": { "type": "object", "required": [ "field", "operation", "value" ], "properties": { "field": { "type": "string", "description": "Поле фильтрации", "required": true }, "operation": { "type": "string", "enum": [ "eq", "neq", "gte", "lte", "gt", "lt", "like", "contains", "range" ], "description": "Операция фильтрации для поля, указанного в параметре **field**." }, "value": { "type": [ "string", "object" ], "description": "Значение фильтрации.\n\n При значении `range` параметра **operation** используется объект с параметрами **since** и **till**.", "properties": { "since": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **till**." }, "till": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **since**." } } } } } } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.front.tablemanagement.TableScheme.json" } } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "e72bc4d95bd413b58531f4cc3901c9a7", "tags": [ "Заведения" ] } }, "/api/create?moduleName=front.tablemanagement&className=ru.edgex.quickresto.modules.front.tablemanagement.TableScheme": { "post": { "description": "Создать объект в классе `ru.edgex.quickresto.modules.front.tablemanagement.TableScheme` модуля `front.tablemanagement`", "summary": "Заведение: создать", "requestBody": { "content": { "application/json": { "schema": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.front.tablemanagement.TableScheme.json" } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.front.tablemanagement.TableScheme.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "567badd1dc21b4579ecdce974daade47", "tags": [ "Заведения" ] } }, "/api/update?moduleName=front.tablemanagement&className=ru.edgex.quickresto.modules.front.tablemanagement.TableScheme": { "post": { "description": "Модифицировать объект в классе `ru.edgex.quickresto.modules.front.tablemanagement.TableScheme` модуля `front.tablemanagement`", "summary": "Заведение: редактировать", "requestBody": { "content": { "application/json": { "schema": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.front.tablemanagement.TableScheme.json" } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.front.tablemanagement.TableScheme.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "5ae2bc28e92c00bb70e75c14f22a1b13", "tags": [ "Заведения" ] } }, "/api/remove?moduleName=front.tablemanagement&className=ru.edgex.quickresto.modules.front.tablemanagement.TableScheme": { "post": { "description": "Удалить объект в классе `ru.edgex.quickresto.modules.front.tablemanagement.TableScheme` модуля `front.tablemanagement`", "summary": "Заведение: удалить", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "description": "Идентификатор объекта", "type": "integer" } }, "required": [ "id" ] } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.front.tablemanagement.TableScheme.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "1ac06599bb4a849e29ca9461cec429cd", "tags": [ "Заведения" ] } }, "/api/read?moduleName=front.terminals.ipad&className=ru.edgex.quickresto.modules.front.terminals.ipad.Terminal": { "get": { "description": "Запросить объект с подобъектами в классе `ru.edgex.quickresto.modules.front.terminals.ipad.Terminal` модуля `front.terminals.ipad`", "summary": "Терминал: запросить", "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "objectId", "in": "query", "description": "Идентификатор объекта", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.front.terminals.ipad.Terminal.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "7acb13bb0f7dd3ef84c6c311a53c799f", "tags": [ "Терминалы" ] } }, "/api/list?moduleName=front.terminals.ipad&className=ru.edgex.quickresto.modules.front.terminals.ipad.Terminal": { "get": { "description": "Запросить список объектов в классе `ru.edgex.quickresto.modules.front.terminals.ipad.Terminal` модуля `front.terminals.ipad`", "summary": "Терминал: список", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "description": "Указывает максимальное количество записей, которое должно быть возвращено в одном запросе.", "type": "integer" }, "offset": { "description": "Указывает начальную позицию в наборе данных, с которой будут возвращены записи.\n\nИспользуется вместе с параметром **limit**.", "type": "integer" } } } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "sortFields", "in": "query", "description": "Поля сортировки\n\nИспользуется вместе с параметром **sortOrders**.\n\nНекоторые поля не поддерживают сортировку.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sortOrders", "in": "query", "description": "Порядок сортировки полей\n\nИспользуется вместе с параметром **sortFields**.\n\nКоличество элементов параметра **sortOrders** должно соответствовать количеству элементов, указанных в параметре **sortFields**.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "asc", "desc" ] } } }, { "name": "filters", "in": "query", "description": "Фильтрация элементов\n\nНекоторые поля не поддерживают фильтрацию.", "schema": { "type": "array", "items": { "type": "object", "required": [ "field", "operation", "value" ], "properties": { "field": { "type": "string", "description": "Поле фильтрации", "required": true }, "operation": { "type": "string", "enum": [ "eq", "neq", "gte", "lte", "gt", "lt", "like", "contains", "range" ], "description": "Операция фильтрации для поля, указанного в параметре **field**." }, "value": { "type": [ "string", "object" ], "description": "Значение фильтрации.\n\n При значении `range` параметра **operation** используется объект с параметрами **since** и **till**.", "properties": { "since": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **till**." }, "till": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **since**." } } } } } } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.front.terminals.ipad.Terminal.json" } } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "6c80dd7d96ef77a4fe5d709135b4a28d", "tags": [ "Терминалы" ] } }, "/api/read?moduleName=front.terminals.ipad&className=ru.edgex.quickresto.modules.front.terminals.ipad.TerminalCommand": { "get": { "description": "Запросить объект с подобъектами в классе `ru.edgex.quickresto.modules.front.terminals.ipad.TerminalCommand` модуля `front.terminals.ipad`", "summary": "Целевое состояние терминала: запросить", "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "objectId", "in": "query", "description": "Идентификатор объекта", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.front.terminals.ipad.TerminalCommand.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "ef72122a7fa190c7b209b7c3f53595e1", "tags": [ "Терминалы" ] } }, "/api/list?moduleName=front.terminals.ipad&className=ru.edgex.quickresto.modules.front.terminals.ipad.TerminalCommand": { "get": { "description": "Запросить список объектов в классе `ru.edgex.quickresto.modules.front.terminals.ipad.TerminalCommand` модуля `front.terminals.ipad`", "summary": "Целевое состояние терминала: список", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "description": "Указывает максимальное количество записей, которое должно быть возвращено в одном запросе.", "type": "integer" }, "offset": { "description": "Указывает начальную позицию в наборе данных, с которой будут возвращены записи.\n\nИспользуется вместе с параметром **limit**.", "type": "integer" } } } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "sortFields", "in": "query", "description": "Поля сортировки\n\nИспользуется вместе с параметром **sortOrders**.\n\nНекоторые поля не поддерживают сортировку.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sortOrders", "in": "query", "description": "Порядок сортировки полей\n\nИспользуется вместе с параметром **sortFields**.\n\nКоличество элементов параметра **sortOrders** должно соответствовать количеству элементов, указанных в параметре **sortFields**.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "asc", "desc" ] } } }, { "name": "filters", "in": "query", "description": "Фильтрация элементов\n\nНекоторые поля не поддерживают фильтрацию.", "schema": { "type": "array", "items": { "type": "object", "required": [ "field", "operation", "value" ], "properties": { "field": { "type": "string", "description": "Поле фильтрации", "required": true }, "operation": { "type": "string", "enum": [ "eq", "neq", "gte", "lte", "gt", "lt", "like", "contains", "range" ], "description": "Операция фильтрации для поля, указанного в параметре **field**." }, "value": { "type": [ "string", "object" ], "description": "Значение фильтрации.\n\n При значении `range` параметра **operation** используется объект с параметрами **since** и **till**.", "properties": { "since": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **till**." }, "till": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **since**." } } } } } } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.front.terminals.ipad.TerminalCommand.json" } } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "9d01e71a5001d7db2f75b855ca001e65", "tags": [ "Терминалы" ] } }, "/api/read?moduleName=front.terminals.kkm&className=ru.edgex.quickresto.modules.front.terminals.kkm.KkmTerminal": { "get": { "description": "Запросить объект с подобъектами в классе `ru.edgex.quickresto.modules.front.terminals.kkm.KkmTerminal` модуля `front.terminals.kkm`", "summary": "Фискальный регистратор: запросить", "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "objectId", "in": "query", "description": "Идентификатор объекта", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.front.terminals.kkm.KkmTerminal.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "d089568026822330f9bb0fcbc4dc39e3", "tags": [ "Фискальные регистраторы" ] } }, "/api/list?moduleName=front.terminals.kkm&className=ru.edgex.quickresto.modules.front.terminals.kkm.KkmTerminal": { "get": { "description": "Запросить список объектов в классе `ru.edgex.quickresto.modules.front.terminals.kkm.KkmTerminal` модуля `front.terminals.kkm`", "summary": "Фискальный регистратор: список", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "description": "Указывает максимальное количество записей, которое должно быть возвращено в одном запросе.", "type": "integer" }, "offset": { "description": "Указывает начальную позицию в наборе данных, с которой будут возвращены записи.\n\nИспользуется вместе с параметром **limit**.", "type": "integer" } } } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "sortFields", "in": "query", "description": "Поля сортировки\n\nИспользуется вместе с параметром **sortOrders**.\n\nНекоторые поля не поддерживают сортировку.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sortOrders", "in": "query", "description": "Порядок сортировки полей\n\nИспользуется вместе с параметром **sortFields**.\n\nКоличество элементов параметра **sortOrders** должно соответствовать количеству элементов, указанных в параметре **sortFields**.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "asc", "desc" ] } } }, { "name": "filters", "in": "query", "description": "Фильтрация элементов\n\nНекоторые поля не поддерживают фильтрацию.", "schema": { "type": "array", "items": { "type": "object", "required": [ "field", "operation", "value" ], "properties": { "field": { "type": "string", "description": "Поле фильтрации", "required": true }, "operation": { "type": "string", "enum": [ "eq", "neq", "gte", "lte", "gt", "lt", "like", "contains", "range" ], "description": "Операция фильтрации для поля, указанного в параметре **field**." }, "value": { "type": [ "string", "object" ], "description": "Значение фильтрации.\n\n При значении `range` параметра **operation** используется объект с параметрами **since** и **till**.", "properties": { "since": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **till**." }, "till": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **since**." } } } } } } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.front.terminals.kkm.KkmTerminal.json" } } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "5deadfb6fc472bfe89c4c5927018c607", "tags": [ "Фискальные регистраторы" ] } }, "/api/read?moduleName=front.terminals.pos&className=ru.edgex.quickresto.modules.front.terminals.pos.PosTerminal": { "get": { "description": "Запросить объект с подобъектами в классе `ru.edgex.quickresto.modules.front.terminals.pos.PosTerminal` модуля `front.terminals.pos`", "summary": "Банковский терминал: запросить", "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "objectId", "in": "query", "description": "Идентификатор объекта", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.front.terminals.pos.PosTerminal.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "363a0cef638165183f02df57db76f7c1", "tags": [ "Банковские терминалы" ] } }, "/api/list?moduleName=front.terminals.pos&className=ru.edgex.quickresto.modules.front.terminals.pos.PosTerminal": { "get": { "description": "Запросить список объектов в классе `ru.edgex.quickresto.modules.front.terminals.pos.PosTerminal` модуля `front.terminals.pos`", "summary": "Банковский терминал: список", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "description": "Указывает максимальное количество записей, которое должно быть возвращено в одном запросе.", "type": "integer" }, "offset": { "description": "Указывает начальную позицию в наборе данных, с которой будут возвращены записи.\n\nИспользуется вместе с параметром **limit**.", "type": "integer" } } } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "sortFields", "in": "query", "description": "Поля сортировки\n\nИспользуется вместе с параметром **sortOrders**.\n\nНекоторые поля не поддерживают сортировку.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sortOrders", "in": "query", "description": "Порядок сортировки полей\n\nИспользуется вместе с параметром **sortFields**.\n\nКоличество элементов параметра **sortOrders** должно соответствовать количеству элементов, указанных в параметре **sortFields**.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "asc", "desc" ] } } }, { "name": "filters", "in": "query", "description": "Фильтрация элементов\n\nНекоторые поля не поддерживают фильтрацию.", "schema": { "type": "array", "items": { "type": "object", "required": [ "field", "operation", "value" ], "properties": { "field": { "type": "string", "description": "Поле фильтрации", "required": true }, "operation": { "type": "string", "enum": [ "eq", "neq", "gte", "lte", "gt", "lt", "like", "contains", "range" ], "description": "Операция фильтрации для поля, указанного в параметре **field**." }, "value": { "type": [ "string", "object" ], "description": "Значение фильтрации.\n\n При значении `range` параметра **operation** используется объект с параметрами **since** и **till**.", "properties": { "since": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **till**." }, "till": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **since**." } } } } } } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.front.terminals.pos.PosTerminal.json" } } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "ade1e6f9d7ac264355f1bcb2b5575eee", "tags": [ "Банковские терминалы" ] } }, "/api/read?moduleName=front.terminals.sbp&className=ru.edgex.quickresto.modules.front.terminals.sbp.SbpTerminal": { "get": { "description": "Запросить объект с подобъектами в классе `ru.edgex.quickresto.modules.front.terminals.sbp.SbpTerminal` модуля `front.terminals.sbp`", "summary": "СБП: запросить", "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "objectId", "in": "query", "description": "Идентификатор объекта", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.front.terminals.sbp.SbpTerminal.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "4139775642aca2819ee8b79d9c2c35fa", "tags": [ "СБП" ] } }, "/api/list?moduleName=front.terminals.sbp&className=ru.edgex.quickresto.modules.front.terminals.sbp.SbpTerminal": { "get": { "description": "Запросить список объектов в классе `ru.edgex.quickresto.modules.front.terminals.sbp.SbpTerminal` модуля `front.terminals.sbp`", "summary": "СБП: список", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "description": "Указывает максимальное количество записей, которое должно быть возвращено в одном запросе.", "type": "integer" }, "offset": { "description": "Указывает начальную позицию в наборе данных, с которой будут возвращены записи.\n\nИспользуется вместе с параметром **limit**.", "type": "integer" } } } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "sortFields", "in": "query", "description": "Поля сортировки\n\nИспользуется вместе с параметром **sortOrders**.\n\nНекоторые поля не поддерживают сортировку.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sortOrders", "in": "query", "description": "Порядок сортировки полей\n\nИспользуется вместе с параметром **sortFields**.\n\nКоличество элементов параметра **sortOrders** должно соответствовать количеству элементов, указанных в параметре **sortFields**.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "asc", "desc" ] } } }, { "name": "filters", "in": "query", "description": "Фильтрация элементов\n\nНекоторые поля не поддерживают фильтрацию.", "schema": { "type": "array", "items": { "type": "object", "required": [ "field", "operation", "value" ], "properties": { "field": { "type": "string", "description": "Поле фильтрации", "required": true }, "operation": { "type": "string", "enum": [ "eq", "neq", "gte", "lte", "gt", "lt", "like", "contains", "range" ], "description": "Операция фильтрации для поля, указанного в параметре **field**." }, "value": { "type": [ "string", "object" ], "description": "Значение фильтрации.\n\n При значении `range` параметра **operation** используется объект с параметрами **since** и **till**.", "properties": { "since": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **till**." }, "till": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **since**." } } } } } } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.front.terminals.sbp.SbpTerminal.json" } } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "97c49e27ad5475cfaffdf4542e720598", "tags": [ "СБП" ] } }, "/api/create?moduleName=front.terminals.sbp&className=ru.edgex.quickresto.modules.front.terminals.sbp.SbpTerminal": { "post": { "description": "Создать объект в классе `ru.edgex.quickresto.modules.front.terminals.sbp.SbpTerminal` модуля `front.terminals.sbp`", "summary": "СБП: создать", "requestBody": { "content": { "application/json": { "schema": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.front.terminals.sbp.SbpTerminal.json" } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.front.terminals.sbp.SbpTerminal.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "2dfc03b686fd12aba5dda1466d27480a", "tags": [ "СБП" ] } }, "/api/update?moduleName=front.terminals.sbp&className=ru.edgex.quickresto.modules.front.terminals.sbp.SbpTerminal": { "post": { "description": "Модифицировать объект в классе `ru.edgex.quickresto.modules.front.terminals.sbp.SbpTerminal` модуля `front.terminals.sbp`", "summary": "СБП: редактировать", "requestBody": { "content": { "application/json": { "schema": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.front.terminals.sbp.SbpTerminal.json" } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.front.terminals.sbp.SbpTerminal.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "f0844ac7cb25dd0d14efb5d333bcf020", "tags": [ "СБП" ] } }, "/api/remove?moduleName=front.terminals.sbp&className=ru.edgex.quickresto.modules.front.terminals.sbp.SbpTerminal": { "post": { "description": "Удалить объект в классе `ru.edgex.quickresto.modules.front.terminals.sbp.SbpTerminal` модуля `front.terminals.sbp`", "summary": "СБП: удалить", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "description": "Идентификатор объекта", "type": "integer" } }, "required": [ "id" ] } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.front.terminals.sbp.SbpTerminal.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "55831a27225d4135326575c3201df4db", "tags": [ "СБП" ] } }, "/api/read?moduleName=front.terminals.ticketdevices&className=ru.edgex.quickresto.modules.front.terminals.ticketdevices.TicketDevice": { "get": { "description": "Запросить объект с подобъектами в классе `ru.edgex.quickresto.modules.front.terminals.ticketdevices.TicketDevice` модуля `front.terminals.ticketdevices`", "summary": "Принтер: запросить", "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "objectId", "in": "query", "description": "Идентификатор объекта", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.front.terminals.ticketdevices.TicketDevice.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "f0a4e8b67d4b1f392a058acd5867fc89", "tags": [ "Принтеры" ] } }, "/api/list?moduleName=front.terminals.ticketdevices&className=ru.edgex.quickresto.modules.front.terminals.ticketdevices.TicketDevice": { "get": { "description": "Запросить список объектов в классе `ru.edgex.quickresto.modules.front.terminals.ticketdevices.TicketDevice` модуля `front.terminals.ticketdevices`", "summary": "Принтер: список", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "description": "Указывает максимальное количество записей, которое должно быть возвращено в одном запросе.", "type": "integer" }, "offset": { "description": "Указывает начальную позицию в наборе данных, с которой будут возвращены записи.\n\nИспользуется вместе с параметром **limit**.", "type": "integer" } } } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "sortFields", "in": "query", "description": "Поля сортировки\n\nИспользуется вместе с параметром **sortOrders**.\n\nНекоторые поля не поддерживают сортировку.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sortOrders", "in": "query", "description": "Порядок сортировки полей\n\nИспользуется вместе с параметром **sortFields**.\n\nКоличество элементов параметра **sortOrders** должно соответствовать количеству элементов, указанных в параметре **sortFields**.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "asc", "desc" ] } } }, { "name": "filters", "in": "query", "description": "Фильтрация элементов\n\nНекоторые поля не поддерживают фильтрацию.", "schema": { "type": "array", "items": { "type": "object", "required": [ "field", "operation", "value" ], "properties": { "field": { "type": "string", "description": "Поле фильтрации", "required": true }, "operation": { "type": "string", "enum": [ "eq", "neq", "gte", "lte", "gt", "lt", "like", "contains", "range" ], "description": "Операция фильтрации для поля, указанного в параметре **field**." }, "value": { "type": [ "string", "object" ], "description": "Значение фильтрации.\n\n При значении `range` параметра **operation** используется объект с параметрами **since** и **till**.", "properties": { "since": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **till**." }, "till": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **since**." } } } } } } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.front.terminals.ticketdevices.TicketDevice.json" } } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "49f920fb7159c11efe27254bafd5ea2e", "tags": [ "Принтеры" ] } }, "/api/read?moduleName=front.zreport&className=ru.edgex.quickresto.modules.front.zreport.Shift": { "get": { "description": "Запросить объект с подобъектами в классе `ru.edgex.quickresto.modules.front.zreport.Shift` модуля `front.zreport`", "summary": "Кассовая смена: запросить", "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "objectId", "in": "query", "description": "Идентификатор объекта", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.front.zreport.Shift.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "936268cfd994b474fbccff425bc8cbf4", "tags": [ "Кассовые смены" ] } }, "/api/list?moduleName=front.zreport&className=ru.edgex.quickresto.modules.front.zreport.Shift": { "get": { "description": "Запросить список объектов в классе `ru.edgex.quickresto.modules.front.zreport.Shift` модуля `front.zreport`", "summary": "Кассовая смена: список", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "description": "Указывает максимальное количество записей, которое должно быть возвращено в одном запросе.", "type": "integer" }, "offset": { "description": "Указывает начальную позицию в наборе данных, с которой будут возвращены записи.\n\nИспользуется вместе с параметром **limit**.", "type": "integer" } } } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "sortFields", "in": "query", "description": "Поля сортировки\n\nИспользуется вместе с параметром **sortOrders**.\n\nНекоторые поля не поддерживают сортировку.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sortOrders", "in": "query", "description": "Порядок сортировки полей\n\nИспользуется вместе с параметром **sortFields**.\n\nКоличество элементов параметра **sortOrders** должно соответствовать количеству элементов, указанных в параметре **sortFields**.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "asc", "desc" ] } } }, { "name": "filters", "in": "query", "description": "Фильтрация элементов\n\nНекоторые поля не поддерживают фильтрацию.", "schema": { "type": "array", "items": { "type": "object", "required": [ "field", "operation", "value" ], "properties": { "field": { "type": "string", "description": "Поле фильтрации", "required": true }, "operation": { "type": "string", "enum": [ "eq", "neq", "gte", "lte", "gt", "lt", "like", "contains", "range" ], "description": "Операция фильтрации для поля, указанного в параметре **field**." }, "value": { "type": [ "string", "object" ], "description": "Значение фильтрации.\n\n При значении `range` параметра **operation** используется объект с параметрами **since** и **till**.", "properties": { "since": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **till**." }, "till": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **since**." } } } } } } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.front.zreport.Shift.json" } } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "3edb43c02c6675023a8bb79ae56a1f08", "tags": [ "Кассовые смены" ] } }, "/api/read?moduleName=personnel.employee&className=ru.edgex.quickresto.modules.personnel.employee.Employee": { "get": { "description": "Запросить объект с подобъектами в классе `ru.edgex.quickresto.modules.personnel.employee.Employee` модуля `personnel.employee`", "summary": "Сотрудник: запросить", "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "objectId", "in": "query", "description": "Идентификатор объекта", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.personnel.employee.Employee.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "ed6a4eb95a86daef07d2cb4510ed04d5", "tags": [ "Сотрудники" ] } }, "/api/list?moduleName=personnel.employee&className=ru.edgex.quickresto.modules.personnel.employee.Employee": { "get": { "description": "Запросить список объектов в классе `ru.edgex.quickresto.modules.personnel.employee.Employee` модуля `personnel.employee`", "summary": "Сотрудник: список", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "description": "Указывает максимальное количество записей, которое должно быть возвращено в одном запросе.", "type": "integer" }, "offset": { "description": "Указывает начальную позицию в наборе данных, с которой будут возвращены записи.\n\nИспользуется вместе с параметром **limit**.", "type": "integer" } } } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "sortFields", "in": "query", "description": "Поля сортировки\n\nИспользуется вместе с параметром **sortOrders**.\n\nНекоторые поля не поддерживают сортировку.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sortOrders", "in": "query", "description": "Порядок сортировки полей\n\nИспользуется вместе с параметром **sortFields**.\n\nКоличество элементов параметра **sortOrders** должно соответствовать количеству элементов, указанных в параметре **sortFields**.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "asc", "desc" ] } } }, { "name": "filters", "in": "query", "description": "Фильтрация элементов\n\nНекоторые поля не поддерживают фильтрацию.", "schema": { "type": "array", "items": { "type": "object", "required": [ "field", "operation", "value" ], "properties": { "field": { "type": "string", "description": "Поле фильтрации", "required": true }, "operation": { "type": "string", "enum": [ "eq", "neq", "gte", "lte", "gt", "lt", "like", "contains", "range" ], "description": "Операция фильтрации для поля, указанного в параметре **field**." }, "value": { "type": [ "string", "object" ], "description": "Значение фильтрации.\n\n При значении `range` параметра **operation** используется объект с параметрами **since** и **till**.", "properties": { "since": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **till**." }, "till": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **since**." } } } } } } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.personnel.employee.Employee.json" } } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "20dae5907fc6d317955e847e2b1dc3d1", "tags": [ "Сотрудники" ] } }, "/api/remove?moduleName=personnel.employee&className=ru.edgex.quickresto.modules.personnel.employee.Employee": { "post": { "description": "Удалить объект в классе `ru.edgex.quickresto.modules.personnel.employee.Employee` модуля `personnel.employee`", "summary": "Сотрудник: удалить", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "description": "Идентификатор объекта", "type": "integer" } }, "required": [ "id" ] } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.personnel.employee.Employee.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "ad22c55794f6f690ea056c0698ef10e8", "tags": [ "Сотрудники" ] } }, "/api/read?moduleName=users.role&className=ru.edgex.platform.service.user.Role": { "get": { "description": "Запросить объект с подобъектами в классе `ru.edgex.platform.service.user.Role` модуля `users.role`", "summary": "Должность: запросить", "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "objectId", "in": "query", "description": "Идентификатор объекта", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.platform.service.user.Role.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "5f935f3801bcd67f1ccbd635ad800dcf", "tags": [ "Должности" ] } }, "/api/list?moduleName=users.role&className=ru.edgex.platform.service.user.Role": { "get": { "description": "Запросить список объектов в классе `ru.edgex.platform.service.user.Role` модуля `users.role`", "summary": "Должность: список", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "description": "Указывает максимальное количество записей, которое должно быть возвращено в одном запросе.", "type": "integer" }, "offset": { "description": "Указывает начальную позицию в наборе данных, с которой будут возвращены записи.\n\nИспользуется вместе с параметром **limit**.", "type": "integer" } } } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "sortFields", "in": "query", "description": "Поля сортировки\n\nИспользуется вместе с параметром **sortOrders**.\n\nНекоторые поля не поддерживают сортировку.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sortOrders", "in": "query", "description": "Порядок сортировки полей\n\nИспользуется вместе с параметром **sortFields**.\n\nКоличество элементов параметра **sortOrders** должно соответствовать количеству элементов, указанных в параметре **sortFields**.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "asc", "desc" ] } } }, { "name": "filters", "in": "query", "description": "Фильтрация элементов\n\nНекоторые поля не поддерживают фильтрацию.", "schema": { "type": "array", "items": { "type": "object", "required": [ "field", "operation", "value" ], "properties": { "field": { "type": "string", "description": "Поле фильтрации", "required": true }, "operation": { "type": "string", "enum": [ "eq", "neq", "gte", "lte", "gt", "lt", "like", "contains", "range" ], "description": "Операция фильтрации для поля, указанного в параметре **field**." }, "value": { "type": [ "string", "object" ], "description": "Значение фильтрации.\n\n При значении `range` параметра **operation** используется объект с параметрами **since** и **till**.", "properties": { "since": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **till**." }, "till": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **since**." } } } } } } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "./components/schemas/ru.edgex.platform.service.user.Role.json" } } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "e3f61e6df1c25758df4b29f4253ec20a", "tags": [ "Должности" ] } }, "/api/create?moduleName=users.role&className=ru.edgex.platform.service.user.Role": { "post": { "description": "Создать объект в классе `ru.edgex.platform.service.user.Role` модуля `users.role`", "summary": "Должность: создать", "requestBody": { "content": { "application/json": { "schema": { "$ref": "./components/schemas/ru.edgex.platform.service.user.Role.json" } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.platform.service.user.Role.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "13550c0b9ed6654c5c06d3fe30d654f1", "tags": [ "Должности" ] } }, "/api/update?moduleName=users.role&className=ru.edgex.platform.service.user.Role": { "post": { "description": "Модифицировать объект в классе `ru.edgex.platform.service.user.Role` модуля `users.role`", "summary": "Должность: редактировать", "requestBody": { "content": { "application/json": { "schema": { "$ref": "./components/schemas/ru.edgex.platform.service.user.Role.json" } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.platform.service.user.Role.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "9b702ffd741bf8c1675bfd1b3079a4d6", "tags": [ "Должности" ] } }, "/api/remove?moduleName=users.role&className=ru.edgex.platform.service.user.Role": { "post": { "description": "Удалить объект в классе `ru.edgex.platform.service.user.Role` модуля `users.role`", "summary": "Должность: удалить", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "description": "Идентификатор объекта", "type": "integer" } }, "required": [ "id" ] } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.platform.service.user.Role.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "a3bf6f353bf0c96208ecf4bc0f433448", "tags": [ "Должности" ] } }, "/api/read?moduleName=warehouse.documents.cooking&className=ru.edgex.quickresto.modules.warehouse.documents.cooking.CookingInvoice": { "get": { "description": "Запросить объект с подобъектами в классе `ru.edgex.quickresto.modules.warehouse.documents.cooking.CookingInvoice` модуля `warehouse.documents.cooking`", "summary": "Акт приготовления: запросить", "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "objectId", "in": "query", "description": "Идентификатор объекта", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.documents.cooking.CookingInvoice.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "6b289030d1f237a8ee86f6eb971dfe30", "tags": [ "Акты приготовления" ] } }, "/api/list?moduleName=warehouse.documents.cooking&className=ru.edgex.quickresto.modules.warehouse.documents.cooking.CookingInvoice": { "get": { "description": "Запросить список объектов в классе `ru.edgex.quickresto.modules.warehouse.documents.cooking.CookingInvoice` модуля `warehouse.documents.cooking`", "summary": "Акт приготовления: список", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "description": "Указывает максимальное количество записей, которое должно быть возвращено в одном запросе.", "type": "integer" }, "offset": { "description": "Указывает начальную позицию в наборе данных, с которой будут возвращены записи.\n\nИспользуется вместе с параметром **limit**.", "type": "integer" } } } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "sortFields", "in": "query", "description": "Поля сортировки\n\nИспользуется вместе с параметром **sortOrders**.\n\nНекоторые поля не поддерживают сортировку.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sortOrders", "in": "query", "description": "Порядок сортировки полей\n\nИспользуется вместе с параметром **sortFields**.\n\nКоличество элементов параметра **sortOrders** должно соответствовать количеству элементов, указанных в параметре **sortFields**.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "asc", "desc" ] } } }, { "name": "filters", "in": "query", "description": "Фильтрация элементов\n\nНекоторые поля не поддерживают фильтрацию.", "schema": { "type": "array", "items": { "type": "object", "required": [ "field", "operation", "value" ], "properties": { "field": { "type": "string", "description": "Поле фильтрации", "required": true }, "operation": { "type": "string", "enum": [ "eq", "neq", "gte", "lte", "gt", "lt", "like", "contains", "range" ], "description": "Операция фильтрации для поля, указанного в параметре **field**." }, "value": { "type": [ "string", "object" ], "description": "Значение фильтрации.\n\n При значении `range` параметра **operation** используется объект с параметрами **since** и **till**.", "properties": { "since": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **till**." }, "till": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **since**." } } } } } } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.documents.cooking.CookingInvoice.json" } } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "55d573a3f40301be1790d5664597a748", "tags": [ "Акты приготовления" ] } }, "/api/read?moduleName=warehouse.documents.decomposition&className=ru.edgex.quickresto.modules.warehouse.documents.decomposition.DecompositionInvoice": { "get": { "description": "Запросить объект с подобъектами в классе `ru.edgex.quickresto.modules.warehouse.documents.decomposition.DecompositionInvoice` модуля `warehouse.documents.decomposition`", "summary": "Акт разбора: запросить", "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "objectId", "in": "query", "description": "Идентификатор объекта", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.documents.decomposition.DecompositionInvoice.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "cbe5f78fc2bd12e66062ae3cc0347768", "tags": [ "Акты разбора" ] } }, "/api/list?moduleName=warehouse.documents.decomposition&className=ru.edgex.quickresto.modules.warehouse.documents.decomposition.DecompositionInvoice": { "get": { "description": "Запросить список объектов в классе `ru.edgex.quickresto.modules.warehouse.documents.decomposition.DecompositionInvoice` модуля `warehouse.documents.decomposition`", "summary": "Акт разбора: список", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "description": "Указывает максимальное количество записей, которое должно быть возвращено в одном запросе.", "type": "integer" }, "offset": { "description": "Указывает начальную позицию в наборе данных, с которой будут возвращены записи.\n\nИспользуется вместе с параметром **limit**.", "type": "integer" } } } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "sortFields", "in": "query", "description": "Поля сортировки\n\nИспользуется вместе с параметром **sortOrders**.\n\nНекоторые поля не поддерживают сортировку.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sortOrders", "in": "query", "description": "Порядок сортировки полей\n\nИспользуется вместе с параметром **sortFields**.\n\nКоличество элементов параметра **sortOrders** должно соответствовать количеству элементов, указанных в параметре **sortFields**.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "asc", "desc" ] } } }, { "name": "filters", "in": "query", "description": "Фильтрация элементов\n\nНекоторые поля не поддерживают фильтрацию.", "schema": { "type": "array", "items": { "type": "object", "required": [ "field", "operation", "value" ], "properties": { "field": { "type": "string", "description": "Поле фильтрации", "required": true }, "operation": { "type": "string", "enum": [ "eq", "neq", "gte", "lte", "gt", "lt", "like", "contains", "range" ], "description": "Операция фильтрации для поля, указанного в параметре **field**." }, "value": { "type": [ "string", "object" ], "description": "Значение фильтрации.\n\n При значении `range` параметра **operation** используется объект с параметрами **since** и **till**.", "properties": { "since": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **till**." }, "till": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **since**." } } } } } } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.documents.decomposition.DecompositionInvoice.json" } } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "3406b4ba7598d3500d4a109901ed64c7", "tags": [ "Акты разбора" ] } }, "/api/read?moduleName=warehouse.documents.demand&className=ru.edgex.quickresto.modules.warehouse.documents.demand.Demand": { "get": { "description": "Запросить объект с подобъектами в классе `ru.edgex.quickresto.modules.warehouse.documents.demand.Demand` модуля `warehouse.documents.demand`", "summary": "Заявка: запросить", "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "objectId", "in": "query", "description": "Идентификатор объекта", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.documents.demand.Demand.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "653e15554c92d430092adf89c910db63", "tags": [ "Заявки" ] } }, "/api/list?moduleName=warehouse.documents.demand&className=ru.edgex.quickresto.modules.warehouse.documents.demand.Demand": { "get": { "description": "Запросить список объектов в классе `ru.edgex.quickresto.modules.warehouse.documents.demand.Demand` модуля `warehouse.documents.demand`", "summary": "Заявка: список", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "description": "Указывает максимальное количество записей, которое должно быть возвращено в одном запросе.", "type": "integer" }, "offset": { "description": "Указывает начальную позицию в наборе данных, с которой будут возвращены записи.\n\nИспользуется вместе с параметром **limit**.", "type": "integer" } } } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "sortFields", "in": "query", "description": "Поля сортировки\n\nИспользуется вместе с параметром **sortOrders**.\n\nНекоторые поля не поддерживают сортировку.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sortOrders", "in": "query", "description": "Порядок сортировки полей\n\nИспользуется вместе с параметром **sortFields**.\n\nКоличество элементов параметра **sortOrders** должно соответствовать количеству элементов, указанных в параметре **sortFields**.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "asc", "desc" ] } } }, { "name": "filters", "in": "query", "description": "Фильтрация элементов\n\nНекоторые поля не поддерживают фильтрацию.", "schema": { "type": "array", "items": { "type": "object", "required": [ "field", "operation", "value" ], "properties": { "field": { "type": "string", "description": "Поле фильтрации", "required": true }, "operation": { "type": "string", "enum": [ "eq", "neq", "gte", "lte", "gt", "lt", "like", "contains", "range" ], "description": "Операция фильтрации для поля, указанного в параметре **field**." }, "value": { "type": [ "string", "object" ], "description": "Значение фильтрации.\n\n При значении `range` параметра **operation** используется объект с параметрами **since** и **till**.", "properties": { "since": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **till**." }, "till": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **since**." } } } } } } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.documents.demand.Demand.json" } } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "f57e41a158ba6a453bf8f830bd33c5c4", "tags": [ "Заявки" ] } }, "/api/read?moduleName=warehouse.documents.discard&className=ru.edgex.quickresto.modules.warehouse.documents.discard.DiscardInvoice": { "get": { "description": "Запросить объект с подобъектами в классе `ru.edgex.quickresto.modules.warehouse.documents.discard.DiscardInvoice` модуля `warehouse.documents.discard`", "summary": "Акт списания: запросить", "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "objectId", "in": "query", "description": "Идентификатор объекта", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.documents.discard.DiscardInvoice.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "a06d5995bc1f64f5ce3a44aac8bda2ff", "tags": [ "Акты списания" ] } }, "/api/list?moduleName=warehouse.documents.discard&className=ru.edgex.quickresto.modules.warehouse.documents.discard.DiscardInvoice": { "get": { "description": "Запросить список объектов в классе `ru.edgex.quickresto.modules.warehouse.documents.discard.DiscardInvoice` модуля `warehouse.documents.discard`", "summary": "Акт списания: список", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "description": "Указывает максимальное количество записей, которое должно быть возвращено в одном запросе.", "type": "integer" }, "offset": { "description": "Указывает начальную позицию в наборе данных, с которой будут возвращены записи.\n\nИспользуется вместе с параметром **limit**.", "type": "integer" } } } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "sortFields", "in": "query", "description": "Поля сортировки\n\nИспользуется вместе с параметром **sortOrders**.\n\nНекоторые поля не поддерживают сортировку.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sortOrders", "in": "query", "description": "Порядок сортировки полей\n\nИспользуется вместе с параметром **sortFields**.\n\nКоличество элементов параметра **sortOrders** должно соответствовать количеству элементов, указанных в параметре **sortFields**.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "asc", "desc" ] } } }, { "name": "filters", "in": "query", "description": "Фильтрация элементов\n\nНекоторые поля не поддерживают фильтрацию.", "schema": { "type": "array", "items": { "type": "object", "required": [ "field", "operation", "value" ], "properties": { "field": { "type": "string", "description": "Поле фильтрации", "required": true }, "operation": { "type": "string", "enum": [ "eq", "neq", "gte", "lte", "gt", "lt", "like", "contains", "range" ], "description": "Операция фильтрации для поля, указанного в параметре **field**." }, "value": { "type": [ "string", "object" ], "description": "Значение фильтрации.\n\n При значении `range` параметра **operation** используется объект с параметрами **since** и **till**.", "properties": { "since": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **till**." }, "till": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **since**." } } } } } } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.documents.discard.DiscardInvoice.json" } } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "bfa48edd768084c8bff8c2e9d70aa904", "tags": [ "Акты списания" ] } }, "/api/update?moduleName=warehouse.documents.discard&className=ru.edgex.quickresto.modules.warehouse.documents.discard.DiscardInvoice": { "post": { "description": "Модифицировать объект в классе `ru.edgex.quickresto.modules.warehouse.documents.discard.DiscardInvoice` модуля `warehouse.documents.discard`", "summary": "Акт списания: редактировать", "requestBody": { "content": { "application/json": { "schema": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.documents.discard.DiscardInvoice.json" } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.documents.discard.DiscardInvoice.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "c4ae20917b9c3b3c58598c6ba6159be3", "tags": [ "Акты списания" ] } }, "/api/read?moduleName=warehouse.documents.exchange&className=ru.edgex.quickresto.modules.warehouse.documents.exchange.ExchangeInvoice": { "get": { "description": "Запросить объект с подобъектами в классе `ru.edgex.quickresto.modules.warehouse.documents.exchange.ExchangeInvoice` модуля `warehouse.documents.exchange`", "summary": "Внутреннее перемещение: запросить", "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "objectId", "in": "query", "description": "Идентификатор объекта", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.documents.exchange.ExchangeInvoice.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "de4f375b5b34e0fe573a4f823dc7fb1d", "tags": [ "Внутренние перемещения" ] } }, "/api/list?moduleName=warehouse.documents.exchange&className=ru.edgex.quickresto.modules.warehouse.documents.exchange.ExchangeInvoice": { "get": { "description": "Запросить список объектов в классе `ru.edgex.quickresto.modules.warehouse.documents.exchange.ExchangeInvoice` модуля `warehouse.documents.exchange`", "summary": "Внутреннее перемещение: список", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "description": "Указывает максимальное количество записей, которое должно быть возвращено в одном запросе.", "type": "integer" }, "offset": { "description": "Указывает начальную позицию в наборе данных, с которой будут возвращены записи.\n\nИспользуется вместе с параметром **limit**.", "type": "integer" } } } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "sortFields", "in": "query", "description": "Поля сортировки\n\nИспользуется вместе с параметром **sortOrders**.\n\nНекоторые поля не поддерживают сортировку.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sortOrders", "in": "query", "description": "Порядок сортировки полей\n\nИспользуется вместе с параметром **sortFields**.\n\nКоличество элементов параметра **sortOrders** должно соответствовать количеству элементов, указанных в параметре **sortFields**.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "asc", "desc" ] } } }, { "name": "filters", "in": "query", "description": "Фильтрация элементов\n\nНекоторые поля не поддерживают фильтрацию.", "schema": { "type": "array", "items": { "type": "object", "required": [ "field", "operation", "value" ], "properties": { "field": { "type": "string", "description": "Поле фильтрации", "required": true }, "operation": { "type": "string", "enum": [ "eq", "neq", "gte", "lte", "gt", "lt", "like", "contains", "range" ], "description": "Операция фильтрации для поля, указанного в параметре **field**." }, "value": { "type": [ "string", "object" ], "description": "Значение фильтрации.\n\n При значении `range` параметра **operation** используется объект с параметрами **since** и **till**.", "properties": { "since": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **till**." }, "till": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **since**." } } } } } } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.documents.exchange.ExchangeInvoice.json" } } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "cf9f3918cc111d891d44adfe3b1cfadb", "tags": [ "Внутренние перемещения" ] } }, "/api/create?moduleName=warehouse.documents.exchange&className=ru.edgex.quickresto.modules.warehouse.documents.exchange.ExchangeInvoice": { "post": { "description": "Создать объект в классе `ru.edgex.quickresto.modules.warehouse.documents.exchange.ExchangeInvoice` модуля `warehouse.documents.exchange`", "summary": "Внутреннее перемещение: создать", "requestBody": { "content": { "application/json": { "schema": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.documents.exchange.ExchangeInvoice.json" } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.documents.exchange.ExchangeInvoice.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "638a398b78e4dc003ed42e4cf90c3874", "tags": [ "Внутренние перемещения" ] } }, "/api/update?moduleName=warehouse.documents.exchange&className=ru.edgex.quickresto.modules.warehouse.documents.exchange.ExchangeInvoice": { "post": { "description": "Модифицировать объект в классе `ru.edgex.quickresto.modules.warehouse.documents.exchange.ExchangeInvoice` модуля `warehouse.documents.exchange`", "summary": "Внутреннее перемещение: редактировать", "requestBody": { "content": { "application/json": { "schema": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.documents.exchange.ExchangeInvoice.json" } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.documents.exchange.ExchangeInvoice.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "cd86e23d1a865a6d7c35b7c4b370b601", "tags": [ "Внутренние перемещения" ] } }, "/api/read?moduleName=warehouse.documents.incoming&className=ru.edgex.quickresto.modules.warehouse.documents.incoming.IncomingInvoice": { "get": { "description": "Запросить объект с подобъектами в классе `ru.edgex.quickresto.modules.warehouse.documents.incoming.IncomingInvoice` модуля `warehouse.documents.incoming`", "summary": "Приходная накладная: запросить", "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "objectId", "in": "query", "description": "Идентификатор объекта", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.documents.incoming.IncomingInvoice.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "4ead7ab9af9011013b9c8eba989861c7", "tags": [ "Приходные накладные" ] } }, "/api/list?moduleName=warehouse.documents.incoming&className=ru.edgex.quickresto.modules.warehouse.documents.incoming.IncomingInvoice": { "get": { "description": "Запросить список объектов в классе `ru.edgex.quickresto.modules.warehouse.documents.incoming.IncomingInvoice` модуля `warehouse.documents.incoming`", "summary": "Приходная накладная: список", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "description": "Указывает максимальное количество записей, которое должно быть возвращено в одном запросе.", "type": "integer" }, "offset": { "description": "Указывает начальную позицию в наборе данных, с которой будут возвращены записи.\n\nИспользуется вместе с параметром **limit**.", "type": "integer" } } } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "sortFields", "in": "query", "description": "Поля сортировки\n\nИспользуется вместе с параметром **sortOrders**.\n\nНекоторые поля не поддерживают сортировку.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sortOrders", "in": "query", "description": "Порядок сортировки полей\n\nИспользуется вместе с параметром **sortFields**.\n\nКоличество элементов параметра **sortOrders** должно соответствовать количеству элементов, указанных в параметре **sortFields**.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "asc", "desc" ] } } }, { "name": "filters", "in": "query", "description": "Фильтрация элементов\n\nНекоторые поля не поддерживают фильтрацию.", "schema": { "type": "array", "items": { "type": "object", "required": [ "field", "operation", "value" ], "properties": { "field": { "type": "string", "description": "Поле фильтрации", "required": true }, "operation": { "type": "string", "enum": [ "eq", "neq", "gte", "lte", "gt", "lt", "like", "contains", "range" ], "description": "Операция фильтрации для поля, указанного в параметре **field**." }, "value": { "type": [ "string", "object" ], "description": "Значение фильтрации.\n\n При значении `range` параметра **operation** используется объект с параметрами **since** и **till**.", "properties": { "since": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **till**." }, "till": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **since**." } } } } } } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.documents.incoming.IncomingInvoice.json" } } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "a55f2c1d31fa0367b48c0103caf24912", "tags": [ "Приходные накладные" ] } }, "/api/update?moduleName=warehouse.documents.incoming&className=ru.edgex.quickresto.modules.warehouse.documents.incoming.IncomingInvoice": { "post": { "description": "Модифицировать объект в классе `ru.edgex.quickresto.modules.warehouse.documents.incoming.IncomingInvoice` модуля `warehouse.documents.incoming`", "summary": "Приходная накладная: редактировать", "requestBody": { "content": { "application/json": { "schema": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.documents.incoming.IncomingInvoice.json" } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.documents.incoming.IncomingInvoice.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "1620d75a16026769b225be85789a07d4", "tags": [ "Приходные накладные" ] } }, "/api/remove?moduleName=warehouse.documents.incoming&className=ru.edgex.quickresto.modules.warehouse.documents.incoming.IncomingInvoice": { "post": { "description": "Удалить объект в классе `ru.edgex.quickresto.modules.warehouse.documents.incoming.IncomingInvoice` модуля `warehouse.documents.incoming`", "summary": "Приходная накладная: удалить", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "description": "Идентификатор объекта", "type": "integer" } }, "required": [ "id" ] } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.documents.incoming.IncomingInvoice.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "e960f9e8a63bdb6c93041aced6bdcc37", "tags": [ "Приходные накладные" ] } }, "/api/read?moduleName=warehouse.documents.outgoing&className=ru.edgex.quickresto.modules.warehouse.documents.outgoing.OutgoingInvoice": { "get": { "description": "Запросить объект с подобъектами в классе `ru.edgex.quickresto.modules.warehouse.documents.outgoing.OutgoingInvoice` модуля `warehouse.documents.outgoing`", "summary": "Расходная накладная: запросить", "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "objectId", "in": "query", "description": "Идентификатор объекта", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.documents.outgoing.OutgoingInvoice.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "73f132b4f3944c049ca530555e95f68a", "tags": [ "Расходные накладные" ] } }, "/api/list?moduleName=warehouse.documents.outgoing&className=ru.edgex.quickresto.modules.warehouse.documents.outgoing.OutgoingInvoice": { "get": { "description": "Запросить список объектов в классе `ru.edgex.quickresto.modules.warehouse.documents.outgoing.OutgoingInvoice` модуля `warehouse.documents.outgoing`", "summary": "Расходная накладная: список", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "description": "Указывает максимальное количество записей, которое должно быть возвращено в одном запросе.", "type": "integer" }, "offset": { "description": "Указывает начальную позицию в наборе данных, с которой будут возвращены записи.\n\nИспользуется вместе с параметром **limit**.", "type": "integer" } } } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "sortFields", "in": "query", "description": "Поля сортировки\n\nИспользуется вместе с параметром **sortOrders**.\n\nНекоторые поля не поддерживают сортировку.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sortOrders", "in": "query", "description": "Порядок сортировки полей\n\nИспользуется вместе с параметром **sortFields**.\n\nКоличество элементов параметра **sortOrders** должно соответствовать количеству элементов, указанных в параметре **sortFields**.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "asc", "desc" ] } } }, { "name": "filters", "in": "query", "description": "Фильтрация элементов\n\nНекоторые поля не поддерживают фильтрацию.", "schema": { "type": "array", "items": { "type": "object", "required": [ "field", "operation", "value" ], "properties": { "field": { "type": "string", "description": "Поле фильтрации", "required": true }, "operation": { "type": "string", "enum": [ "eq", "neq", "gte", "lte", "gt", "lt", "like", "contains", "range" ], "description": "Операция фильтрации для поля, указанного в параметре **field**." }, "value": { "type": [ "string", "object" ], "description": "Значение фильтрации.\n\n При значении `range` параметра **operation** используется объект с параметрами **since** и **till**.", "properties": { "since": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **till**." }, "till": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **since**." } } } } } } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.documents.outgoing.OutgoingInvoice.json" } } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "65fb9bb7832ff516b5a2ebce1ce4a81f", "tags": [ "Расходные накладные" ] } }, "/api/update?moduleName=warehouse.documents.outgoing&className=ru.edgex.quickresto.modules.warehouse.documents.outgoing.OutgoingInvoice": { "post": { "description": "Модифицировать объект в классе `ru.edgex.quickresto.modules.warehouse.documents.outgoing.OutgoingInvoice` модуля `warehouse.documents.outgoing`", "summary": "Расходная накладная: редактировать", "requestBody": { "content": { "application/json": { "schema": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.documents.outgoing.OutgoingInvoice.json" } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.documents.outgoing.OutgoingInvoice.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "1f9f304317c4ca45267b8aeeff8c986c", "tags": [ "Расходные накладные" ] } }, "/api/remove?moduleName=warehouse.documents.outgoing&className=ru.edgex.quickresto.modules.warehouse.documents.outgoing.OutgoingInvoice": { "post": { "description": "Удалить объект в классе `ru.edgex.quickresto.modules.warehouse.documents.outgoing.OutgoingInvoice` модуля `warehouse.documents.outgoing`", "summary": "Расходная накладная: удалить", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "description": "Идентификатор объекта", "type": "integer" } }, "required": [ "id" ] } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.documents.outgoing.OutgoingInvoice.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "99e533c8ea8980c1dd46c37235e3e03e", "tags": [ "Расходные накладные" ] } }, "/api/read?moduleName=warehouse.documents.processing&className=ru.edgex.quickresto.modules.warehouse.documents.processing.ProcessingInvoice": { "get": { "description": "Запросить объект с подобъектами в классе `ru.edgex.quickresto.modules.warehouse.documents.processing.ProcessingInvoice` модуля `warehouse.documents.processing`", "summary": "Акт переработки: запросить", "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "objectId", "in": "query", "description": "Идентификатор объекта", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.documents.processing.ProcessingInvoice.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "c1ea8d476f4880507f6c07290b226cc3", "tags": [ "Акты переработки" ] } }, "/api/list?moduleName=warehouse.documents.processing&className=ru.edgex.quickresto.modules.warehouse.documents.processing.ProcessingInvoice": { "get": { "description": "Запросить список объектов в классе `ru.edgex.quickresto.modules.warehouse.documents.processing.ProcessingInvoice` модуля `warehouse.documents.processing`", "summary": "Акт переработки: список", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "description": "Указывает максимальное количество записей, которое должно быть возвращено в одном запросе.", "type": "integer" }, "offset": { "description": "Указывает начальную позицию в наборе данных, с которой будут возвращены записи.\n\nИспользуется вместе с параметром **limit**.", "type": "integer" } } } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "sortFields", "in": "query", "description": "Поля сортировки\n\nИспользуется вместе с параметром **sortOrders**.\n\nНекоторые поля не поддерживают сортировку.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sortOrders", "in": "query", "description": "Порядок сортировки полей\n\nИспользуется вместе с параметром **sortFields**.\n\nКоличество элементов параметра **sortOrders** должно соответствовать количеству элементов, указанных в параметре **sortFields**.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "asc", "desc" ] } } }, { "name": "filters", "in": "query", "description": "Фильтрация элементов\n\nНекоторые поля не поддерживают фильтрацию.", "schema": { "type": "array", "items": { "type": "object", "required": [ "field", "operation", "value" ], "properties": { "field": { "type": "string", "description": "Поле фильтрации", "required": true }, "operation": { "type": "string", "enum": [ "eq", "neq", "gte", "lte", "gt", "lt", "like", "contains", "range" ], "description": "Операция фильтрации для поля, указанного в параметре **field**." }, "value": { "type": [ "string", "object" ], "description": "Значение фильтрации.\n\n При значении `range` параметра **operation** используется объект с параметрами **since** и **till**.", "properties": { "since": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **till**." }, "till": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **since**." } } } } } } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.documents.processing.ProcessingInvoice.json" } } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "c2e85bf2622a658bd2e6887473456c48", "tags": [ "Акты переработки" ] } }, "/api/read?moduleName=warehouse.inventory.document.v2&className=ru.edgex.quickresto.modules.warehouse.inventory.document.InventoryDocument2": { "get": { "description": "Запросить объект с подобъектами в классе `ru.edgex.quickresto.modules.warehouse.inventory.document.InventoryDocument2` модуля `warehouse.inventory.document.v2`", "summary": "Акт инвентаризации: запросить", "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "objectId", "in": "query", "description": "Идентификатор объекта", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.inventory.document.InventoryDocument2.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "dfc26fa98d950ae977978eb69f8b4652", "tags": [ "Акты инвентаризации" ] } }, "/api/list?moduleName=warehouse.inventory.document.v2&className=ru.edgex.quickresto.modules.warehouse.inventory.document.InventoryDocument2": { "get": { "description": "Запросить список объектов в классе `ru.edgex.quickresto.modules.warehouse.inventory.document.InventoryDocument2` модуля `warehouse.inventory.document.v2`", "summary": "Акт инвентаризации: список", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "description": "Указывает максимальное количество записей, которое должно быть возвращено в одном запросе.", "type": "integer" }, "offset": { "description": "Указывает начальную позицию в наборе данных, с которой будут возвращены записи.\n\nИспользуется вместе с параметром **limit**.", "type": "integer" } } } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "sortFields", "in": "query", "description": "Поля сортировки\n\nИспользуется вместе с параметром **sortOrders**.\n\nНекоторые поля не поддерживают сортировку.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sortOrders", "in": "query", "description": "Порядок сортировки полей\n\nИспользуется вместе с параметром **sortFields**.\n\nКоличество элементов параметра **sortOrders** должно соответствовать количеству элементов, указанных в параметре **sortFields**.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "asc", "desc" ] } } }, { "name": "filters", "in": "query", "description": "Фильтрация элементов\n\nНекоторые поля не поддерживают фильтрацию.", "schema": { "type": "array", "items": { "type": "object", "required": [ "field", "operation", "value" ], "properties": { "field": { "type": "string", "description": "Поле фильтрации", "required": true }, "operation": { "type": "string", "enum": [ "eq", "neq", "gte", "lte", "gt", "lt", "like", "contains", "range" ], "description": "Операция фильтрации для поля, указанного в параметре **field**." }, "value": { "type": [ "string", "object" ], "description": "Значение фильтрации.\n\n При значении `range` параметра **operation** используется объект с параметрами **since** и **till**.", "properties": { "since": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **till**." }, "till": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **since**." } } } } } } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.inventory.document.InventoryDocument2.json" } } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "4275df9e2f45c7073bbff63a18327c83", "tags": [ "Акты инвентаризации" ] } }, "/api/update?moduleName=warehouse.inventory.document.v2&className=ru.edgex.quickresto.modules.warehouse.inventory.document.InventoryDocument2": { "post": { "description": "Модифицировать объект в классе `ru.edgex.quickresto.modules.warehouse.inventory.document.InventoryDocument2` модуля `warehouse.inventory.document.v2`", "summary": "Акт инвентаризации: редактировать", "requestBody": { "content": { "application/json": { "schema": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.inventory.document.InventoryDocument2.json" } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.inventory.document.InventoryDocument2.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "59799630afb4be0cc6f853eb2a1c2bd6", "tags": [ "Акты инвентаризации" ] } }, "/api/read?moduleName=warehouse.nomenclature.cooking_place&className=ru.edgex.quickresto.modules.warehouse.nomenclature.cooking_place.CookingPlace": { "get": { "description": "Запросить объект с подобъектами в классе `ru.edgex.quickresto.modules.warehouse.nomenclature.cooking_place.CookingPlace` модуля `warehouse.nomenclature.cooking_place`", "summary": "Место приготовления: запросить", "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "objectId", "in": "query", "description": "Идентификатор объекта", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.nomenclature.cooking_place.CookingPlace.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "75a96a5cdfebeaa78641a3e6a1f0fa7a", "tags": [ "Места приготовления" ] } }, "/api/list?moduleName=warehouse.nomenclature.cooking_place&className=ru.edgex.quickresto.modules.warehouse.nomenclature.cooking_place.CookingPlace": { "get": { "description": "Запросить список объектов в классе `ru.edgex.quickresto.modules.warehouse.nomenclature.cooking_place.CookingPlace` модуля `warehouse.nomenclature.cooking_place`", "summary": "Место приготовления: список", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "description": "Указывает максимальное количество записей, которое должно быть возвращено в одном запросе.", "type": "integer" }, "offset": { "description": "Указывает начальную позицию в наборе данных, с которой будут возвращены записи.\n\nИспользуется вместе с параметром **limit**.", "type": "integer" } } } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "sortFields", "in": "query", "description": "Поля сортировки\n\nИспользуется вместе с параметром **sortOrders**.\n\nНекоторые поля не поддерживают сортировку.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sortOrders", "in": "query", "description": "Порядок сортировки полей\n\nИспользуется вместе с параметром **sortFields**.\n\nКоличество элементов параметра **sortOrders** должно соответствовать количеству элементов, указанных в параметре **sortFields**.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "asc", "desc" ] } } }, { "name": "filters", "in": "query", "description": "Фильтрация элементов\n\nНекоторые поля не поддерживают фильтрацию.", "schema": { "type": "array", "items": { "type": "object", "required": [ "field", "operation", "value" ], "properties": { "field": { "type": "string", "description": "Поле фильтрации", "required": true }, "operation": { "type": "string", "enum": [ "eq", "neq", "gte", "lte", "gt", "lt", "like", "contains", "range" ], "description": "Операция фильтрации для поля, указанного в параметре **field**." }, "value": { "type": [ "string", "object" ], "description": "Значение фильтрации.\n\n При значении `range` параметра **operation** используется объект с параметрами **since** и **till**.", "properties": { "since": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **till**." }, "till": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **since**." } } } } } } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.nomenclature.cooking_place.CookingPlace.json" } } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "14dbfa8ac008542af0757d904ad30897", "tags": [ "Места приготовления" ] } }, "/api/remove?moduleName=warehouse.nomenclature.cooking_place&className=ru.edgex.quickresto.modules.warehouse.nomenclature.cooking_place.CookingPlace": { "post": { "description": "Удалить объект в классе `ru.edgex.quickresto.modules.warehouse.nomenclature.cooking_place.CookingPlace` модуля `warehouse.nomenclature.cooking_place`", "summary": "Место приготовления: удалить", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "description": "Идентификатор объекта", "type": "integer" } }, "required": [ "id" ] } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.nomenclature.cooking_place.CookingPlace.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "2dd7adcca557a78ccb47b6b575b1650c", "tags": [ "Места приготовления" ] } }, "/api/read?moduleName=warehouse.nomenclature.dish&className=ru.edgex.quickresto.modules.warehouse.nomenclature.dish.Dish": { "get": { "description": "Запросить объект с подобъектами в классе `ru.edgex.quickresto.modules.warehouse.nomenclature.dish.Dish` модуля `warehouse.nomenclature.dish`", "summary": "Блюдо: запросить", "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "objectId", "in": "query", "description": "Идентификатор объекта", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.nomenclature.dish.Dish.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "4b47563ca8b1082d779b76d00aea4155", "tags": [ "Блюда" ] } }, "/api/list?moduleName=warehouse.nomenclature.dish&className=ru.edgex.quickresto.modules.warehouse.nomenclature.dish.Dish": { "get": { "description": "Запросить список объектов в классе `ru.edgex.quickresto.modules.warehouse.nomenclature.dish.Dish` модуля `warehouse.nomenclature.dish`", "summary": "Блюдо: список", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "description": "Указывает максимальное количество записей, которое должно быть возвращено в одном запросе.", "type": "integer" }, "offset": { "description": "Указывает начальную позицию в наборе данных, с которой будут возвращены записи.\n\nИспользуется вместе с параметром **limit**.", "type": "integer" } } } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "sortFields", "in": "query", "description": "Поля сортировки\n\nИспользуется вместе с параметром **sortOrders**.\n\nНекоторые поля не поддерживают сортировку.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sortOrders", "in": "query", "description": "Порядок сортировки полей\n\nИспользуется вместе с параметром **sortFields**.\n\nКоличество элементов параметра **sortOrders** должно соответствовать количеству элементов, указанных в параметре **sortFields**.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "asc", "desc" ] } } }, { "name": "filters", "in": "query", "description": "Фильтрация элементов\n\nНекоторые поля не поддерживают фильтрацию.", "schema": { "type": "array", "items": { "type": "object", "required": [ "field", "operation", "value" ], "properties": { "field": { "type": "string", "description": "Поле фильтрации", "required": true }, "operation": { "type": "string", "enum": [ "eq", "neq", "gte", "lte", "gt", "lt", "like", "contains", "range" ], "description": "Операция фильтрации для поля, указанного в параметре **field**." }, "value": { "type": [ "string", "object" ], "description": "Значение фильтрации.\n\n При значении `range` параметра **operation** используется объект с параметрами **since** и **till**.", "properties": { "since": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **till**." }, "till": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **since**." } } } } } } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.nomenclature.dish.Dish.json" } } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "6862988652844f0a6d1568c99ec40042", "tags": [ "Блюда" ] } }, "/api/create?moduleName=warehouse.nomenclature.dish&className=ru.edgex.quickresto.modules.warehouse.nomenclature.dish.Dish": { "post": { "description": "Создать объект в классе `ru.edgex.quickresto.modules.warehouse.nomenclature.dish.Dish` модуля `warehouse.nomenclature.dish`", "summary": "Блюдо: создать", "requestBody": { "content": { "application/json": { "schema": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.nomenclature.dish.Dish.json" } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.nomenclature.dish.Dish.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "776ee38605a06e45e3661a7275c7fca9", "tags": [ "Блюда" ] } }, "/api/update?moduleName=warehouse.nomenclature.dish&className=ru.edgex.quickresto.modules.warehouse.nomenclature.dish.Dish": { "post": { "description": "Модифицировать объект в классе `ru.edgex.quickresto.modules.warehouse.nomenclature.dish.Dish` модуля `warehouse.nomenclature.dish`", "summary": "Блюдо: редактировать", "requestBody": { "content": { "application/json": { "schema": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.nomenclature.dish.Dish.json" } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.nomenclature.dish.Dish.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "18cb484cd96cae857a2c43736be333a4", "tags": [ "Блюда" ] } }, "/api/remove?moduleName=warehouse.nomenclature.dish&className=ru.edgex.quickresto.modules.warehouse.nomenclature.dish.Dish": { "post": { "description": "Удалить объект в классе `ru.edgex.quickresto.modules.warehouse.nomenclature.dish.Dish` модуля `warehouse.nomenclature.dish`", "summary": "Блюдо: удалить", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "description": "Идентификатор объекта", "type": "integer" } }, "required": [ "id" ] } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.nomenclature.dish.Dish.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "098edcd2eaaea7ced28979a90c7c15f0", "tags": [ "Блюда" ] } }, "/api/read?moduleName=warehouse.nomenclature.dish&className=ru.edgex.quickresto.modules.warehouse.nomenclature.dish.DishCategory": { "get": { "description": "Запросить объект с подобъектами в классе `ru.edgex.quickresto.modules.warehouse.nomenclature.dish.DishCategory` модуля `warehouse.nomenclature.dish`", "summary": "Группа блюд: запросить", "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "objectId", "in": "query", "description": "Идентификатор объекта", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.nomenclature.dish.DishCategory.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "f8286cc343e5f149882fd9213340e923", "tags": [ "Блюда" ] } }, "/api/list?moduleName=warehouse.nomenclature.dish&className=ru.edgex.quickresto.modules.warehouse.nomenclature.dish.DishCategory": { "get": { "description": "Запросить список объектов в классе `ru.edgex.quickresto.modules.warehouse.nomenclature.dish.DishCategory` модуля `warehouse.nomenclature.dish`", "summary": "Группа блюд: список", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "description": "Указывает максимальное количество записей, которое должно быть возвращено в одном запросе.", "type": "integer" }, "offset": { "description": "Указывает начальную позицию в наборе данных, с которой будут возвращены записи.\n\nИспользуется вместе с параметром **limit**.", "type": "integer" } } } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "sortFields", "in": "query", "description": "Поля сортировки\n\nИспользуется вместе с параметром **sortOrders**.\n\nНекоторые поля не поддерживают сортировку.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sortOrders", "in": "query", "description": "Порядок сортировки полей\n\nИспользуется вместе с параметром **sortFields**.\n\nКоличество элементов параметра **sortOrders** должно соответствовать количеству элементов, указанных в параметре **sortFields**.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "asc", "desc" ] } } }, { "name": "filters", "in": "query", "description": "Фильтрация элементов\n\nНекоторые поля не поддерживают фильтрацию.", "schema": { "type": "array", "items": { "type": "object", "required": [ "field", "operation", "value" ], "properties": { "field": { "type": "string", "description": "Поле фильтрации", "required": true }, "operation": { "type": "string", "enum": [ "eq", "neq", "gte", "lte", "gt", "lt", "like", "contains", "range" ], "description": "Операция фильтрации для поля, указанного в параметре **field**." }, "value": { "type": [ "string", "object" ], "description": "Значение фильтрации.\n\n При значении `range` параметра **operation** используется объект с параметрами **since** и **till**.", "properties": { "since": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **till**." }, "till": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **since**." } } } } } } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.nomenclature.dish.DishCategory.json" } } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "255a011302b94a38427315793dcabda4", "tags": [ "Блюда" ] } }, "/api/create?moduleName=warehouse.nomenclature.dish&className=ru.edgex.quickresto.modules.warehouse.nomenclature.dish.DishCategory": { "post": { "description": "Создать объект в классе `ru.edgex.quickresto.modules.warehouse.nomenclature.dish.DishCategory` модуля `warehouse.nomenclature.dish`", "summary": "Группа блюд: создать", "requestBody": { "content": { "application/json": { "schema": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.nomenclature.dish.DishCategory.json" } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.nomenclature.dish.DishCategory.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "f4980babf9592b89cc1ab8673e23d916", "tags": [ "Блюда" ] } }, "/api/update?moduleName=warehouse.nomenclature.dish&className=ru.edgex.quickresto.modules.warehouse.nomenclature.dish.DishCategory": { "post": { "description": "Модифицировать объект в классе `ru.edgex.quickresto.modules.warehouse.nomenclature.dish.DishCategory` модуля `warehouse.nomenclature.dish`", "summary": "Группа блюд: редактировать", "requestBody": { "content": { "application/json": { "schema": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.nomenclature.dish.DishCategory.json" } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.nomenclature.dish.DishCategory.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "64212787994710f494dca5fd13461dc8", "tags": [ "Блюда" ] } }, "/api/remove?moduleName=warehouse.nomenclature.dish&className=ru.edgex.quickresto.modules.warehouse.nomenclature.dish.DishCategory": { "post": { "description": "Удалить объект в классе `ru.edgex.quickresto.modules.warehouse.nomenclature.dish.DishCategory` модуля `warehouse.nomenclature.dish`", "summary": "Группа блюд: удалить", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "description": "Идентификатор объекта", "type": "integer" } }, "required": [ "id" ] } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.nomenclature.dish.DishCategory.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "a10ca00fd1dd919b7a91be3dc8de0cbb", "tags": [ "Блюда" ] } }, "/api/read?moduleName=warehouse.nomenclature.mods&className=ru.edgex.quickresto.modules.warehouse.nomenclature.mods.Modifier": { "get": { "description": "Запросить объект с подобъектами в классе `ru.edgex.quickresto.modules.warehouse.nomenclature.mods.Modifier` модуля `warehouse.nomenclature.mods`", "summary": "Модификатор: запросить", "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "objectId", "in": "query", "description": "Идентификатор объекта", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.nomenclature.mods.Modifier.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "7c536bcaa69b8086ee03daf986139e8d", "tags": [ "Модификаторы" ] } }, "/api/list?moduleName=warehouse.nomenclature.mods&className=ru.edgex.quickresto.modules.warehouse.nomenclature.mods.Modifier": { "get": { "description": "Запросить список объектов в классе `ru.edgex.quickresto.modules.warehouse.nomenclature.mods.Modifier` модуля `warehouse.nomenclature.mods`", "summary": "Модификатор: список", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "description": "Указывает максимальное количество записей, которое должно быть возвращено в одном запросе.", "type": "integer" }, "offset": { "description": "Указывает начальную позицию в наборе данных, с которой будут возвращены записи.\n\nИспользуется вместе с параметром **limit**.", "type": "integer" } } } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "sortFields", "in": "query", "description": "Поля сортировки\n\nИспользуется вместе с параметром **sortOrders**.\n\nНекоторые поля не поддерживают сортировку.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sortOrders", "in": "query", "description": "Порядок сортировки полей\n\nИспользуется вместе с параметром **sortFields**.\n\nКоличество элементов параметра **sortOrders** должно соответствовать количеству элементов, указанных в параметре **sortFields**.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "asc", "desc" ] } } }, { "name": "filters", "in": "query", "description": "Фильтрация элементов\n\nНекоторые поля не поддерживают фильтрацию.", "schema": { "type": "array", "items": { "type": "object", "required": [ "field", "operation", "value" ], "properties": { "field": { "type": "string", "description": "Поле фильтрации", "required": true }, "operation": { "type": "string", "enum": [ "eq", "neq", "gte", "lte", "gt", "lt", "like", "contains", "range" ], "description": "Операция фильтрации для поля, указанного в параметре **field**." }, "value": { "type": [ "string", "object" ], "description": "Значение фильтрации.\n\n При значении `range` параметра **operation** используется объект с параметрами **since** и **till**.", "properties": { "since": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **till**." }, "till": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **since**." } } } } } } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.nomenclature.mods.Modifier.json" } } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "7f8fef8a80ee68459ef5fb1dbe5cc322", "tags": [ "Модификаторы" ] } }, "/api/create?moduleName=warehouse.nomenclature.mods&className=ru.edgex.quickresto.modules.warehouse.nomenclature.mods.Modifier": { "post": { "description": "Создать объект в классе `ru.edgex.quickresto.modules.warehouse.nomenclature.mods.Modifier` модуля `warehouse.nomenclature.mods`", "summary": "Модификатор: создать", "requestBody": { "content": { "application/json": { "schema": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.nomenclature.mods.Modifier.json" } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.nomenclature.mods.Modifier.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "86ae5a90f790e4c718baf2dfa7cead49", "tags": [ "Модификаторы" ] } }, "/api/update?moduleName=warehouse.nomenclature.mods&className=ru.edgex.quickresto.modules.warehouse.nomenclature.mods.Modifier": { "post": { "description": "Модифицировать объект в классе `ru.edgex.quickresto.modules.warehouse.nomenclature.mods.Modifier` модуля `warehouse.nomenclature.mods`", "summary": "Модификатор: редактировать", "requestBody": { "content": { "application/json": { "schema": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.nomenclature.mods.Modifier.json" } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.nomenclature.mods.Modifier.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "510a7dcc6cb390db982a21efad7b5847", "tags": [ "Модификаторы" ] } }, "/api/remove?moduleName=warehouse.nomenclature.mods&className=ru.edgex.quickresto.modules.warehouse.nomenclature.mods.Modifier": { "post": { "description": "Удалить объект в классе `ru.edgex.quickresto.modules.warehouse.nomenclature.mods.Modifier` модуля `warehouse.nomenclature.mods`", "summary": "Модификатор: удалить", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "description": "Идентификатор объекта", "type": "integer" } }, "required": [ "id" ] } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.nomenclature.mods.Modifier.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "3b723c4081112d57f583f0985b0c592d", "tags": [ "Модификаторы" ] } }, "/api/read?moduleName=warehouse.nomenclature.mods&className=ru.edgex.quickresto.modules.warehouse.nomenclature.mods.ModifierGroup": { "get": { "description": "Запросить объект с подобъектами в классе `ru.edgex.quickresto.modules.warehouse.nomenclature.mods.ModifierGroup` модуля `warehouse.nomenclature.mods`", "summary": "Группа модификаторов: запросить", "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "objectId", "in": "query", "description": "Идентификатор объекта", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.nomenclature.mods.ModifierGroup.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "bbdc2fa4190581471554dca8eb01dc35", "tags": [ "Модификаторы" ] } }, "/api/list?moduleName=warehouse.nomenclature.mods&className=ru.edgex.quickresto.modules.warehouse.nomenclature.mods.ModifierGroup": { "get": { "description": "Запросить список объектов в классе `ru.edgex.quickresto.modules.warehouse.nomenclature.mods.ModifierGroup` модуля `warehouse.nomenclature.mods`", "summary": "Группа модификаторов: список", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "description": "Указывает максимальное количество записей, которое должно быть возвращено в одном запросе.", "type": "integer" }, "offset": { "description": "Указывает начальную позицию в наборе данных, с которой будут возвращены записи.\n\nИспользуется вместе с параметром **limit**.", "type": "integer" } } } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "sortFields", "in": "query", "description": "Поля сортировки\n\nИспользуется вместе с параметром **sortOrders**.\n\nНекоторые поля не поддерживают сортировку.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sortOrders", "in": "query", "description": "Порядок сортировки полей\n\nИспользуется вместе с параметром **sortFields**.\n\nКоличество элементов параметра **sortOrders** должно соответствовать количеству элементов, указанных в параметре **sortFields**.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "asc", "desc" ] } } }, { "name": "filters", "in": "query", "description": "Фильтрация элементов\n\nНекоторые поля не поддерживают фильтрацию.", "schema": { "type": "array", "items": { "type": "object", "required": [ "field", "operation", "value" ], "properties": { "field": { "type": "string", "description": "Поле фильтрации", "required": true }, "operation": { "type": "string", "enum": [ "eq", "neq", "gte", "lte", "gt", "lt", "like", "contains", "range" ], "description": "Операция фильтрации для поля, указанного в параметре **field**." }, "value": { "type": [ "string", "object" ], "description": "Значение фильтрации.\n\n При значении `range` параметра **operation** используется объект с параметрами **since** и **till**.", "properties": { "since": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **till**." }, "till": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **since**." } } } } } } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.nomenclature.mods.ModifierGroup.json" } } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "0a20616f383aaca12c3aa7513ee11320", "tags": [ "Модификаторы" ] } }, "/api/create?moduleName=warehouse.nomenclature.mods&className=ru.edgex.quickresto.modules.warehouse.nomenclature.mods.ModifierGroup": { "post": { "description": "Создать объект в классе `ru.edgex.quickresto.modules.warehouse.nomenclature.mods.ModifierGroup` модуля `warehouse.nomenclature.mods`", "summary": "Группа модификаторов: создать", "requestBody": { "content": { "application/json": { "schema": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.nomenclature.mods.ModifierGroup.json" } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.nomenclature.mods.ModifierGroup.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "6156b4fb79abcdb9bcf08b9470a8c73c", "tags": [ "Модификаторы" ] } }, "/api/update?moduleName=warehouse.nomenclature.mods&className=ru.edgex.quickresto.modules.warehouse.nomenclature.mods.ModifierGroup": { "post": { "description": "Модифицировать объект в классе `ru.edgex.quickresto.modules.warehouse.nomenclature.mods.ModifierGroup` модуля `warehouse.nomenclature.mods`", "summary": "Группа модификаторов: редактировать", "requestBody": { "content": { "application/json": { "schema": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.nomenclature.mods.ModifierGroup.json" } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.nomenclature.mods.ModifierGroup.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "ef01bde40a056d112c7f9cdd92d2c2af", "tags": [ "Модификаторы" ] } }, "/api/remove?moduleName=warehouse.nomenclature.mods&className=ru.edgex.quickresto.modules.warehouse.nomenclature.mods.ModifierGroup": { "post": { "description": "Удалить объект в классе `ru.edgex.quickresto.modules.warehouse.nomenclature.mods.ModifierGroup` модуля `warehouse.nomenclature.mods`", "summary": "Группа модификаторов: удалить", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "description": "Идентификатор объекта", "type": "integer" } }, "required": [ "id" ] } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.nomenclature.mods.ModifierGroup.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "84f3527ed6875f704a4b6bb4649a6d02", "tags": [ "Модификаторы" ] } }, "/api/read?moduleName=warehouse.nomenclature.sale_place&className=ru.edgex.quickresto.modules.warehouse.nomenclature.sale_place.SalePlace": { "get": { "description": "Запросить объект с подобъектами в классе `ru.edgex.quickresto.modules.warehouse.nomenclature.sale_place.SalePlace` модуля `warehouse.nomenclature.sale_place`", "summary": "Место реализации: запросить", "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "objectId", "in": "query", "description": "Идентификатор объекта", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.nomenclature.sale_place.SalePlace.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "d806c5c94ab53add2fba7d53194c9ef5", "tags": [ "Места реализации" ] } }, "/api/list?moduleName=warehouse.nomenclature.sale_place&className=ru.edgex.quickresto.modules.warehouse.nomenclature.sale_place.SalePlace": { "get": { "description": "Запросить список объектов в классе `ru.edgex.quickresto.modules.warehouse.nomenclature.sale_place.SalePlace` модуля `warehouse.nomenclature.sale_place`", "summary": "Место реализации: список", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "description": "Указывает максимальное количество записей, которое должно быть возвращено в одном запросе.", "type": "integer" }, "offset": { "description": "Указывает начальную позицию в наборе данных, с которой будут возвращены записи.\n\nИспользуется вместе с параметром **limit**.", "type": "integer" } } } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "sortFields", "in": "query", "description": "Поля сортировки\n\nИспользуется вместе с параметром **sortOrders**.\n\nНекоторые поля не поддерживают сортировку.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sortOrders", "in": "query", "description": "Порядок сортировки полей\n\nИспользуется вместе с параметром **sortFields**.\n\nКоличество элементов параметра **sortOrders** должно соответствовать количеству элементов, указанных в параметре **sortFields**.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "asc", "desc" ] } } }, { "name": "filters", "in": "query", "description": "Фильтрация элементов\n\nНекоторые поля не поддерживают фильтрацию.", "schema": { "type": "array", "items": { "type": "object", "required": [ "field", "operation", "value" ], "properties": { "field": { "type": "string", "description": "Поле фильтрации", "required": true }, "operation": { "type": "string", "enum": [ "eq", "neq", "gte", "lte", "gt", "lt", "like", "contains", "range" ], "description": "Операция фильтрации для поля, указанного в параметре **field**." }, "value": { "type": [ "string", "object" ], "description": "Значение фильтрации.\n\n При значении `range` параметра **operation** используется объект с параметрами **since** и **till**.", "properties": { "since": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **till**." }, "till": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **since**." } } } } } } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.nomenclature.sale_place.SalePlace.json" } } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "3972f9f2dc4dcd3f0e4f6a402ab8550c", "tags": [ "Места реализации" ] } }, "/api/remove?moduleName=warehouse.nomenclature.sale_place&className=ru.edgex.quickresto.modules.warehouse.nomenclature.sale_place.SalePlace": { "post": { "description": "Удалить объект в классе `ru.edgex.quickresto.modules.warehouse.nomenclature.sale_place.SalePlace` модуля `warehouse.nomenclature.sale_place`", "summary": "Место реализации: удалить", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "description": "Идентификатор объекта", "type": "integer" } }, "required": [ "id" ] } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.nomenclature.sale_place.SalePlace.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "ce587d961e7096480d6219cf18700bb3", "tags": [ "Места реализации" ] } }, "/api/read?moduleName=warehouse.nomenclature.semiproduct&className=ru.edgex.quickresto.modules.warehouse.nomenclature.semiproduct.SemiProduct": { "get": { "description": "Запросить объект с подобъектами в классе `ru.edgex.quickresto.modules.warehouse.nomenclature.semiproduct.SemiProduct` модуля `warehouse.nomenclature.semiproduct`", "summary": "П/ф: запросить", "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "objectId", "in": "query", "description": "Идентификатор объекта", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.nomenclature.semiproduct.SemiProduct.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "8ad64766eb584f9c071e7a70718d6996", "tags": [ "Полуфабрикаты" ] } }, "/api/list?moduleName=warehouse.nomenclature.semiproduct&className=ru.edgex.quickresto.modules.warehouse.nomenclature.semiproduct.SemiProduct": { "get": { "description": "Запросить список объектов в классе `ru.edgex.quickresto.modules.warehouse.nomenclature.semiproduct.SemiProduct` модуля `warehouse.nomenclature.semiproduct`", "summary": "П/ф: список", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "description": "Указывает максимальное количество записей, которое должно быть возвращено в одном запросе.", "type": "integer" }, "offset": { "description": "Указывает начальную позицию в наборе данных, с которой будут возвращены записи.\n\nИспользуется вместе с параметром **limit**.", "type": "integer" } } } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "sortFields", "in": "query", "description": "Поля сортировки\n\nИспользуется вместе с параметром **sortOrders**.\n\nНекоторые поля не поддерживают сортировку.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sortOrders", "in": "query", "description": "Порядок сортировки полей\n\nИспользуется вместе с параметром **sortFields**.\n\nКоличество элементов параметра **sortOrders** должно соответствовать количеству элементов, указанных в параметре **sortFields**.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "asc", "desc" ] } } }, { "name": "filters", "in": "query", "description": "Фильтрация элементов\n\nНекоторые поля не поддерживают фильтрацию.", "schema": { "type": "array", "items": { "type": "object", "required": [ "field", "operation", "value" ], "properties": { "field": { "type": "string", "description": "Поле фильтрации", "required": true }, "operation": { "type": "string", "enum": [ "eq", "neq", "gte", "lte", "gt", "lt", "like", "contains", "range" ], "description": "Операция фильтрации для поля, указанного в параметре **field**." }, "value": { "type": [ "string", "object" ], "description": "Значение фильтрации.\n\n При значении `range` параметра **operation** используется объект с параметрами **since** и **till**.", "properties": { "since": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **till**." }, "till": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **since**." } } } } } } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.nomenclature.semiproduct.SemiProduct.json" } } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "d2e5deb44836f9c27a6775206ded557a", "tags": [ "Полуфабрикаты" ] } }, "/api/read?moduleName=warehouse.nomenclature.semiproduct&className=ru.edgex.quickresto.modules.warehouse.nomenclature.StoreCategory": { "get": { "description": "Запросить объект с подобъектами в классе `ru.edgex.quickresto.modules.warehouse.nomenclature.StoreCategory` модуля `warehouse.nomenclature.semiproduct`", "summary": "Группа полуфабрикатов: запросить", "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "objectId", "in": "query", "description": "Идентификатор объекта", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.nomenclature.StoreCategory.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "8b708a1587400e44201e966fefe1f1ab", "tags": [ "Полуфабрикаты" ] } }, "/api/list?moduleName=warehouse.nomenclature.semiproduct&className=ru.edgex.quickresto.modules.warehouse.nomenclature.StoreCategory": { "get": { "description": "Запросить список объектов в классе `ru.edgex.quickresto.modules.warehouse.nomenclature.StoreCategory` модуля `warehouse.nomenclature.semiproduct`", "summary": "Группа полуфабрикатов: список", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "description": "Указывает максимальное количество записей, которое должно быть возвращено в одном запросе.", "type": "integer" }, "offset": { "description": "Указывает начальную позицию в наборе данных, с которой будут возвращены записи.\n\nИспользуется вместе с параметром **limit**.", "type": "integer" } } } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "sortFields", "in": "query", "description": "Поля сортировки\n\nИспользуется вместе с параметром **sortOrders**.\n\nНекоторые поля не поддерживают сортировку.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sortOrders", "in": "query", "description": "Порядок сортировки полей\n\nИспользуется вместе с параметром **sortFields**.\n\nКоличество элементов параметра **sortOrders** должно соответствовать количеству элементов, указанных в параметре **sortFields**.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "asc", "desc" ] } } }, { "name": "filters", "in": "query", "description": "Фильтрация элементов\n\nНекоторые поля не поддерживают фильтрацию.", "schema": { "type": "array", "items": { "type": "object", "required": [ "field", "operation", "value" ], "properties": { "field": { "type": "string", "description": "Поле фильтрации", "required": true }, "operation": { "type": "string", "enum": [ "eq", "neq", "gte", "lte", "gt", "lt", "like", "contains", "range" ], "description": "Операция фильтрации для поля, указанного в параметре **field**." }, "value": { "type": [ "string", "object" ], "description": "Значение фильтрации.\n\n При значении `range` параметра **operation** используется объект с параметрами **since** и **till**.", "properties": { "since": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **till**." }, "till": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **since**." } } } } } } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.nomenclature.StoreCategory.json" } } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "8c23a6a59c7c31ae75fd9f22d9d4434b", "tags": [ "Полуфабрикаты" ] } }, "/api/create?moduleName=warehouse.nomenclature.semiproduct&className=ru.edgex.quickresto.modules.warehouse.nomenclature.StoreCategory": { "post": { "description": "Создать объект в классе `ru.edgex.quickresto.modules.warehouse.nomenclature.StoreCategory` модуля `warehouse.nomenclature.semiproduct`", "summary": "Группа полуфабрикатов: создать", "requestBody": { "content": { "application/json": { "schema": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.nomenclature.StoreCategory.json" } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.nomenclature.StoreCategory.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "2d5ce4ce2392de60fc9d4ab1f674c0da", "tags": [ "Полуфабрикаты" ] } }, "/api/update?moduleName=warehouse.nomenclature.semiproduct&className=ru.edgex.quickresto.modules.warehouse.nomenclature.StoreCategory": { "post": { "description": "Модифицировать объект в классе `ru.edgex.quickresto.modules.warehouse.nomenclature.StoreCategory` модуля `warehouse.nomenclature.semiproduct`", "summary": "Группа полуфабрикатов: редактировать", "requestBody": { "content": { "application/json": { "schema": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.nomenclature.StoreCategory.json" } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.nomenclature.StoreCategory.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "b7eacad82a35307a0f94071130fa865d", "tags": [ "Полуфабрикаты" ] } }, "/api/remove?moduleName=warehouse.nomenclature.semiproduct&className=ru.edgex.quickresto.modules.warehouse.nomenclature.StoreCategory": { "post": { "description": "Удалить объект в классе `ru.edgex.quickresto.modules.warehouse.nomenclature.StoreCategory` модуля `warehouse.nomenclature.semiproduct`", "summary": "Группа полуфабрикатов: удалить", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "description": "Идентификатор объекта", "type": "integer" } }, "required": [ "id" ] } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.nomenclature.StoreCategory.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "197bc49dff276b1cd1b3b7bc77600bc9", "tags": [ "Полуфабрикаты" ] } }, "/api/read?moduleName=warehouse.nomenclature.singleproduct&className=ru.edgex.quickresto.modules.warehouse.nomenclature.singleproduct.SingleCategory": { "get": { "description": "Запросить объект с подобъектами в классе `ru.edgex.quickresto.modules.warehouse.nomenclature.singleproduct.SingleCategory` модуля `warehouse.nomenclature.singleproduct`", "summary": "Группа ингредиентов: запросить", "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "objectId", "in": "query", "description": "Идентификатор объекта", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.nomenclature.singleproduct.SingleCategory.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "d3e432bba29308758d20035ebf142727", "tags": [ "Ингредиенты" ] } }, "/api/list?moduleName=warehouse.nomenclature.singleproduct&className=ru.edgex.quickresto.modules.warehouse.nomenclature.singleproduct.SingleCategory": { "get": { "description": "Запросить список объектов в классе `ru.edgex.quickresto.modules.warehouse.nomenclature.singleproduct.SingleCategory` модуля `warehouse.nomenclature.singleproduct`", "summary": "Группа ингредиентов: список", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "description": "Указывает максимальное количество записей, которое должно быть возвращено в одном запросе.", "type": "integer" }, "offset": { "description": "Указывает начальную позицию в наборе данных, с которой будут возвращены записи.\n\nИспользуется вместе с параметром **limit**.", "type": "integer" } } } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "sortFields", "in": "query", "description": "Поля сортировки\n\nИспользуется вместе с параметром **sortOrders**.\n\nНекоторые поля не поддерживают сортировку.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sortOrders", "in": "query", "description": "Порядок сортировки полей\n\nИспользуется вместе с параметром **sortFields**.\n\nКоличество элементов параметра **sortOrders** должно соответствовать количеству элементов, указанных в параметре **sortFields**.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "asc", "desc" ] } } }, { "name": "filters", "in": "query", "description": "Фильтрация элементов\n\nНекоторые поля не поддерживают фильтрацию.", "schema": { "type": "array", "items": { "type": "object", "required": [ "field", "operation", "value" ], "properties": { "field": { "type": "string", "description": "Поле фильтрации", "required": true }, "operation": { "type": "string", "enum": [ "eq", "neq", "gte", "lte", "gt", "lt", "like", "contains", "range" ], "description": "Операция фильтрации для поля, указанного в параметре **field**." }, "value": { "type": [ "string", "object" ], "description": "Значение фильтрации.\n\n При значении `range` параметра **operation** используется объект с параметрами **since** и **till**.", "properties": { "since": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **till**." }, "till": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **since**." } } } } } } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.nomenclature.singleproduct.SingleCategory.json" } } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "1ebf31535181da934f84b564fbed2d2a", "tags": [ "Ингредиенты" ] } }, "/api/update?moduleName=warehouse.nomenclature.singleproduct&className=ru.edgex.quickresto.modules.warehouse.nomenclature.singleproduct.SingleCategory": { "post": { "description": "Модифицировать объект в классе `ru.edgex.quickresto.modules.warehouse.nomenclature.singleproduct.SingleCategory` модуля `warehouse.nomenclature.singleproduct`", "summary": "Группа ингредиентов: редактировать", "requestBody": { "content": { "application/json": { "schema": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.nomenclature.singleproduct.SingleCategory.json" } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.nomenclature.singleproduct.SingleCategory.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "17862a51e11001c13fe2b75731ea1804", "tags": [ "Ингредиенты" ] } }, "/api/read?moduleName=warehouse.nomenclature.singleproduct&className=ru.edgex.quickresto.modules.warehouse.nomenclature.singleproduct.SingleProduct": { "get": { "description": "Запросить объект с подобъектами в классе `ru.edgex.quickresto.modules.warehouse.nomenclature.singleproduct.SingleProduct` модуля `warehouse.nomenclature.singleproduct`", "summary": "Ингредиент: запросить", "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "objectId", "in": "query", "description": "Идентификатор объекта", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.nomenclature.singleproduct.SingleProduct.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "dda211078406d7ca6dd3f3fc125587f9", "tags": [ "Ингредиенты" ] } }, "/api/list?moduleName=warehouse.nomenclature.singleproduct&className=ru.edgex.quickresto.modules.warehouse.nomenclature.singleproduct.SingleProduct": { "get": { "description": "Запросить список объектов в классе `ru.edgex.quickresto.modules.warehouse.nomenclature.singleproduct.SingleProduct` модуля `warehouse.nomenclature.singleproduct`", "summary": "Ингредиент: список", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "description": "Указывает максимальное количество записей, которое должно быть возвращено в одном запросе.", "type": "integer" }, "offset": { "description": "Указывает начальную позицию в наборе данных, с которой будут возвращены записи.\n\nИспользуется вместе с параметром **limit**.", "type": "integer" } } } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "sortFields", "in": "query", "description": "Поля сортировки\n\nИспользуется вместе с параметром **sortOrders**.\n\nНекоторые поля не поддерживают сортировку.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sortOrders", "in": "query", "description": "Порядок сортировки полей\n\nИспользуется вместе с параметром **sortFields**.\n\nКоличество элементов параметра **sortOrders** должно соответствовать количеству элементов, указанных в параметре **sortFields**.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "asc", "desc" ] } } }, { "name": "filters", "in": "query", "description": "Фильтрация элементов\n\nНекоторые поля не поддерживают фильтрацию.", "schema": { "type": "array", "items": { "type": "object", "required": [ "field", "operation", "value" ], "properties": { "field": { "type": "string", "description": "Поле фильтрации", "required": true }, "operation": { "type": "string", "enum": [ "eq", "neq", "gte", "lte", "gt", "lt", "like", "contains", "range" ], "description": "Операция фильтрации для поля, указанного в параметре **field**." }, "value": { "type": [ "string", "object" ], "description": "Значение фильтрации.\n\n При значении `range` параметра **operation** используется объект с параметрами **since** и **till**.", "properties": { "since": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **till**." }, "till": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **since**." } } } } } } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.nomenclature.singleproduct.SingleProduct.json" } } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "a7bab95d25274b1838f43451a0ba2820", "tags": [ "Ингредиенты" ] } }, "/api/update?moduleName=warehouse.nomenclature.singleproduct&className=ru.edgex.quickresto.modules.warehouse.nomenclature.singleproduct.SingleProduct": { "post": { "description": "Модифицировать объект в классе `ru.edgex.quickresto.modules.warehouse.nomenclature.singleproduct.SingleProduct` модуля `warehouse.nomenclature.singleproduct`", "summary": "Ингредиент: редактировать", "requestBody": { "content": { "application/json": { "schema": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.nomenclature.singleproduct.SingleProduct.json" } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.nomenclature.singleproduct.SingleProduct.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "385d714d0c25a3644343aac5418c3f72", "tags": [ "Ингредиенты" ] } }, "/api/read?moduleName=warehouse.providers&className=ru.edgex.quickresto.modules.warehouse.providers.NaturalPerson": { "get": { "description": "Запросить объект с подобъектами в классе `ru.edgex.quickresto.modules.warehouse.providers.NaturalPerson` модуля `warehouse.providers`", "summary": "Физическое лицо: запросить", "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "objectId", "in": "query", "description": "Идентификатор объекта", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.providers.NaturalPerson.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "b87a745c11d6a767715c7a13e060fb3f", "tags": [ "Контрагенты" ] } }, "/api/list?moduleName=warehouse.providers&className=ru.edgex.quickresto.modules.warehouse.providers.NaturalPerson": { "get": { "description": "Запросить список объектов в классе `ru.edgex.quickresto.modules.warehouse.providers.NaturalPerson` модуля `warehouse.providers`", "summary": "Физическое лицо: список", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "description": "Указывает максимальное количество записей, которое должно быть возвращено в одном запросе.", "type": "integer" }, "offset": { "description": "Указывает начальную позицию в наборе данных, с которой будут возвращены записи.\n\nИспользуется вместе с параметром **limit**.", "type": "integer" } } } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "sortFields", "in": "query", "description": "Поля сортировки\n\nИспользуется вместе с параметром **sortOrders**.\n\nНекоторые поля не поддерживают сортировку.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sortOrders", "in": "query", "description": "Порядок сортировки полей\n\nИспользуется вместе с параметром **sortFields**.\n\nКоличество элементов параметра **sortOrders** должно соответствовать количеству элементов, указанных в параметре **sortFields**.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "asc", "desc" ] } } }, { "name": "filters", "in": "query", "description": "Фильтрация элементов\n\nНекоторые поля не поддерживают фильтрацию.", "schema": { "type": "array", "items": { "type": "object", "required": [ "field", "operation", "value" ], "properties": { "field": { "type": "string", "description": "Поле фильтрации", "required": true }, "operation": { "type": "string", "enum": [ "eq", "neq", "gte", "lte", "gt", "lt", "like", "contains", "range" ], "description": "Операция фильтрации для поля, указанного в параметре **field**." }, "value": { "type": [ "string", "object" ], "description": "Значение фильтрации.\n\n При значении `range` параметра **operation** используется объект с параметрами **since** и **till**.", "properties": { "since": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **till**." }, "till": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **since**." } } } } } } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.providers.NaturalPerson.json" } } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "95f8b1c162c12a2a8ddf5fb6a00e04b2", "tags": [ "Контрагенты" ] } }, "/api/remove?moduleName=warehouse.providers&className=ru.edgex.quickresto.modules.warehouse.providers.NaturalPerson": { "post": { "description": "Удалить объект в классе `ru.edgex.quickresto.modules.warehouse.providers.NaturalPerson` модуля `warehouse.providers`", "summary": "Физическое лицо: удалить", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "description": "Идентификатор объекта", "type": "integer" } }, "required": [ "id" ] } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.providers.NaturalPerson.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "a8c5a52bd008570fa7b0eed1022eb7a8", "tags": [ "Контрагенты" ] } }, "/api/read?moduleName=warehouse.providers&className=ru.edgex.quickresto.modules.warehouse.providers.Organization": { "get": { "description": "Запросить объект с подобъектами в классе `ru.edgex.quickresto.modules.warehouse.providers.Organization` модуля `warehouse.providers`", "summary": "Юридическое лицо: запросить", "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "objectId", "in": "query", "description": "Идентификатор объекта", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.providers.Organization.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "fb7a287ff5f8c9e89052f848888ff5cb", "tags": [ "Контрагенты" ] } }, "/api/list?moduleName=warehouse.providers&className=ru.edgex.quickresto.modules.warehouse.providers.Organization": { "get": { "description": "Запросить список объектов в классе `ru.edgex.quickresto.modules.warehouse.providers.Organization` модуля `warehouse.providers`", "summary": "Юридическое лицо: список", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "description": "Указывает максимальное количество записей, которое должно быть возвращено в одном запросе.", "type": "integer" }, "offset": { "description": "Указывает начальную позицию в наборе данных, с которой будут возвращены записи.\n\nИспользуется вместе с параметром **limit**.", "type": "integer" } } } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "sortFields", "in": "query", "description": "Поля сортировки\n\nИспользуется вместе с параметром **sortOrders**.\n\nНекоторые поля не поддерживают сортировку.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sortOrders", "in": "query", "description": "Порядок сортировки полей\n\nИспользуется вместе с параметром **sortFields**.\n\nКоличество элементов параметра **sortOrders** должно соответствовать количеству элементов, указанных в параметре **sortFields**.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "asc", "desc" ] } } }, { "name": "filters", "in": "query", "description": "Фильтрация элементов\n\nНекоторые поля не поддерживают фильтрацию.", "schema": { "type": "array", "items": { "type": "object", "required": [ "field", "operation", "value" ], "properties": { "field": { "type": "string", "description": "Поле фильтрации", "required": true }, "operation": { "type": "string", "enum": [ "eq", "neq", "gte", "lte", "gt", "lt", "like", "contains", "range" ], "description": "Операция фильтрации для поля, указанного в параметре **field**." }, "value": { "type": [ "string", "object" ], "description": "Значение фильтрации.\n\n При значении `range` параметра **operation** используется объект с параметрами **since** и **till**.", "properties": { "since": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **till**." }, "till": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **since**." } } } } } } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.providers.Organization.json" } } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "52d41ba2ec12bc427542083c3b4704ec", "tags": [ "Контрагенты" ] } }, "/api/remove?moduleName=warehouse.providers&className=ru.edgex.quickresto.modules.warehouse.providers.Organization": { "post": { "description": "Удалить объект в классе `ru.edgex.quickresto.modules.warehouse.providers.Organization` модуля `warehouse.providers`", "summary": "Юридическое лицо: удалить", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "description": "Идентификатор объекта", "type": "integer" } }, "required": [ "id" ] } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.providers.Organization.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "f6a6a27c8a3f82cac53d90c8dde11d8a", "tags": [ "Контрагенты" ] } }, "/api/read?moduleName=warehouse.providers&className=ru.edgex.quickresto.modules.warehouse.providers.Businessman": { "get": { "description": "Запросить объект с подобъектами в классе `ru.edgex.quickresto.modules.warehouse.providers.Businessman` модуля `warehouse.providers`", "summary": "Индивидуальный предприниматель: запросить", "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "objectId", "in": "query", "description": "Идентификатор объекта", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.providers.Businessman.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "e3c2b0debcf410b96b06883b8dddc528", "tags": [ "Контрагенты" ] } }, "/api/list?moduleName=warehouse.providers&className=ru.edgex.quickresto.modules.warehouse.providers.Businessman": { "get": { "description": "Запросить список объектов в классе `ru.edgex.quickresto.modules.warehouse.providers.Businessman` модуля `warehouse.providers`", "summary": "Индивидуальный предприниматель: список", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "description": "Указывает максимальное количество записей, которое должно быть возвращено в одном запросе.", "type": "integer" }, "offset": { "description": "Указывает начальную позицию в наборе данных, с которой будут возвращены записи.\n\nИспользуется вместе с параметром **limit**.", "type": "integer" } } } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "sortFields", "in": "query", "description": "Поля сортировки\n\nИспользуется вместе с параметром **sortOrders**.\n\nНекоторые поля не поддерживают сортировку.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sortOrders", "in": "query", "description": "Порядок сортировки полей\n\nИспользуется вместе с параметром **sortFields**.\n\nКоличество элементов параметра **sortOrders** должно соответствовать количеству элементов, указанных в параметре **sortFields**.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "asc", "desc" ] } } }, { "name": "filters", "in": "query", "description": "Фильтрация элементов\n\nНекоторые поля не поддерживают фильтрацию.", "schema": { "type": "array", "items": { "type": "object", "required": [ "field", "operation", "value" ], "properties": { "field": { "type": "string", "description": "Поле фильтрации", "required": true }, "operation": { "type": "string", "enum": [ "eq", "neq", "gte", "lte", "gt", "lt", "like", "contains", "range" ], "description": "Операция фильтрации для поля, указанного в параметре **field**." }, "value": { "type": [ "string", "object" ], "description": "Значение фильтрации.\n\n При значении `range` параметра **operation** используется объект с параметрами **since** и **till**.", "properties": { "since": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **till**." }, "till": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **since**." } } } } } } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.providers.Businessman.json" } } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "3ee6968bbebe424b2ec4d95e6519a4d4", "tags": [ "Контрагенты" ] } }, "/api/remove?moduleName=warehouse.providers&className=ru.edgex.quickresto.modules.warehouse.providers.Businessman": { "post": { "description": "Удалить объект в классе `ru.edgex.quickresto.modules.warehouse.providers.Businessman` модуля `warehouse.providers`", "summary": "Индивидуальный предприниматель: удалить", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "description": "Идентификатор объекта", "type": "integer" } }, "required": [ "id" ] } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.providers.Businessman.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "34090b24085519392aa1240968773a5b", "tags": [ "Контрагенты" ] } }, "/api/read?moduleName=warehouse.providers&className=ru.edgex.quickresto.modules.warehouse.providers.ProviderGroup": { "get": { "description": "Запросить объект с подобъектами в классе `ru.edgex.quickresto.modules.warehouse.providers.ProviderGroup` модуля `warehouse.providers`", "summary": "Группа контрагентов: запросить", "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "objectId", "in": "query", "description": "Идентификатор объекта", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.providers.ProviderGroup.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "bd2ee5ba1e59086cd7fe1ab95533b921", "tags": [ "Контрагенты" ] } }, "/api/list?moduleName=warehouse.providers&className=ru.edgex.quickresto.modules.warehouse.providers.ProviderGroup": { "get": { "description": "Запросить список объектов в классе `ru.edgex.quickresto.modules.warehouse.providers.ProviderGroup` модуля `warehouse.providers`", "summary": "Группа контрагентов: список", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "description": "Указывает максимальное количество записей, которое должно быть возвращено в одном запросе.", "type": "integer" }, "offset": { "description": "Указывает начальную позицию в наборе данных, с которой будут возвращены записи.\n\nИспользуется вместе с параметром **limit**.", "type": "integer" } } } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "sortFields", "in": "query", "description": "Поля сортировки\n\nИспользуется вместе с параметром **sortOrders**.\n\nНекоторые поля не поддерживают сортировку.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sortOrders", "in": "query", "description": "Порядок сортировки полей\n\nИспользуется вместе с параметром **sortFields**.\n\nКоличество элементов параметра **sortOrders** должно соответствовать количеству элементов, указанных в параметре **sortFields**.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "asc", "desc" ] } } }, { "name": "filters", "in": "query", "description": "Фильтрация элементов\n\nНекоторые поля не поддерживают фильтрацию.", "schema": { "type": "array", "items": { "type": "object", "required": [ "field", "operation", "value" ], "properties": { "field": { "type": "string", "description": "Поле фильтрации", "required": true }, "operation": { "type": "string", "enum": [ "eq", "neq", "gte", "lte", "gt", "lt", "like", "contains", "range" ], "description": "Операция фильтрации для поля, указанного в параметре **field**." }, "value": { "type": [ "string", "object" ], "description": "Значение фильтрации.\n\n При значении `range` параметра **operation** используется объект с параметрами **since** и **till**.", "properties": { "since": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **till**." }, "till": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **since**." } } } } } } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.providers.ProviderGroup.json" } } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "1e8f5033d0b73b54e3bcdeac994c4dc6", "tags": [ "Контрагенты" ] } }, "/api/remove?moduleName=warehouse.providers&className=ru.edgex.quickresto.modules.warehouse.providers.ProviderGroup": { "post": { "description": "Удалить объект в классе `ru.edgex.quickresto.modules.warehouse.providers.ProviderGroup` модуля `warehouse.providers`", "summary": "Группа контрагентов: удалить", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "description": "Идентификатор объекта", "type": "integer" } }, "required": [ "id" ] } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.providers.ProviderGroup.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "ab676121aa4454e58bd0362ffccd6567", "tags": [ "Контрагенты" ] } }, "/api/read?moduleName=warehouse.providers.concrete&className=ru.edgex.quickresto.modules.warehouse.providers.concrete.ConcreteProvider": { "get": { "description": "Запросить объект с подобъектами в классе `ru.edgex.quickresto.modules.warehouse.providers.concrete.ConcreteProvider` модуля `warehouse.providers.concrete`", "summary": "Конечный контрагент: запросить", "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "objectId", "in": "query", "description": "Идентификатор объекта", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.providers.concrete.ConcreteProvider.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "e79d9f4aabbe05393144268566253356", "tags": [ "Контрагенты" ] } }, "/api/list?moduleName=warehouse.providers.concrete&className=ru.edgex.quickresto.modules.warehouse.providers.concrete.ConcreteProvider": { "get": { "description": "Запросить список объектов в классе `ru.edgex.quickresto.modules.warehouse.providers.concrete.ConcreteProvider` модуля `warehouse.providers.concrete`", "summary": "Конечный контрагент: список", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "description": "Указывает максимальное количество записей, которое должно быть возвращено в одном запросе.", "type": "integer" }, "offset": { "description": "Указывает начальную позицию в наборе данных, с которой будут возвращены записи.\n\nИспользуется вместе с параметром **limit**.", "type": "integer" } } } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "sortFields", "in": "query", "description": "Поля сортировки\n\nИспользуется вместе с параметром **sortOrders**.\n\nНекоторые поля не поддерживают сортировку.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sortOrders", "in": "query", "description": "Порядок сортировки полей\n\nИспользуется вместе с параметром **sortFields**.\n\nКоличество элементов параметра **sortOrders** должно соответствовать количеству элементов, указанных в параметре **sortFields**.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "asc", "desc" ] } } }, { "name": "filters", "in": "query", "description": "Фильтрация элементов\n\nНекоторые поля не поддерживают фильтрацию.", "schema": { "type": "array", "items": { "type": "object", "required": [ "field", "operation", "value" ], "properties": { "field": { "type": "string", "description": "Поле фильтрации", "required": true }, "operation": { "type": "string", "enum": [ "eq", "neq", "gte", "lte", "gt", "lt", "like", "contains", "range" ], "description": "Операция фильтрации для поля, указанного в параметре **field**." }, "value": { "type": [ "string", "object" ], "description": "Значение фильтрации.\n\n При значении `range` параметра **operation** используется объект с параметрами **since** и **till**.", "properties": { "since": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **till**." }, "till": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **since**." } } } } } } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.providers.concrete.ConcreteProvider.json" } } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "033ce1f79c76bd788beaad0cc05de21b", "tags": [ "Контрагенты" ] } }, "/api/read?moduleName=warehouse.store&className=ru.edgex.quickresto.modules.warehouse.store.Store": { "get": { "description": "Запросить объект с подобъектами в классе `ru.edgex.quickresto.modules.warehouse.store.Store` модуля `warehouse.store`", "summary": "Склад: запросить", "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "objectId", "in": "query", "description": "Идентификатор объекта", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.store.Store.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "baa54ef37974159dd26a43fe86397e15", "tags": [ "Склады" ] } }, "/api/list?moduleName=warehouse.store&className=ru.edgex.quickresto.modules.warehouse.store.Store": { "get": { "description": "Запросить список объектов в классе `ru.edgex.quickresto.modules.warehouse.store.Store` модуля `warehouse.store`", "summary": "Склад: список", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "description": "Указывает максимальное количество записей, которое должно быть возвращено в одном запросе.", "type": "integer" }, "offset": { "description": "Указывает начальную позицию в наборе данных, с которой будут возвращены записи.\n\nИспользуется вместе с параметром **limit**.", "type": "integer" } } } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" }, { "name": "sortFields", "in": "query", "description": "Поля сортировки\n\nИспользуется вместе с параметром **sortOrders**.\n\nНекоторые поля не поддерживают сортировку.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sortOrders", "in": "query", "description": "Порядок сортировки полей\n\nИспользуется вместе с параметром **sortFields**.\n\nКоличество элементов параметра **sortOrders** должно соответствовать количеству элементов, указанных в параметре **sortFields**.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "asc", "desc" ] } } }, { "name": "filters", "in": "query", "description": "Фильтрация элементов\n\nНекоторые поля не поддерживают фильтрацию.", "schema": { "type": "array", "items": { "type": "object", "required": [ "field", "operation", "value" ], "properties": { "field": { "type": "string", "description": "Поле фильтрации", "required": true }, "operation": { "type": "string", "enum": [ "eq", "neq", "gte", "lte", "gt", "lt", "like", "contains", "range" ], "description": "Операция фильтрации для поля, указанного в параметре **field**." }, "value": { "type": [ "string", "object" ], "description": "Значение фильтрации.\n\n При значении `range` параметра **operation** используется объект с параметрами **since** и **till**.", "properties": { "since": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **till**." }, "till": { "type": "string", "format": "unix-timestamp", "description": "Используется вместе с параметром **since**." } } } } } } } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.store.Store.json" } } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "82c57468d8e056eb4796e0450c38ae61", "tags": [ "Склады" ] } }, "/api/update?moduleName=warehouse.store&className=ru.edgex.quickresto.modules.warehouse.store.Store": { "post": { "description": "Модифицировать объект в классе `ru.edgex.quickresto.modules.warehouse.store.Store` модуля `warehouse.store`", "summary": "Склад: редактировать", "requestBody": { "content": { "application/json": { "schema": { "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.store.Store.json" } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.store.Store.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "a167167608cb2818b41d874497dc0ed6", "tags": [ "Склады" ] } }, "/api/remove?moduleName=warehouse.store&className=ru.edgex.quickresto.modules.warehouse.store.Store": { "post": { "description": "Удалить объект в классе `ru.edgex.quickresto.modules.warehouse.store.Store` модуля `warehouse.store`", "summary": "Склад: удалить", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "description": "Идентификатор объекта", "type": "integer" } }, "required": [ "id" ] } } } }, "parameters": [ { "$ref": "#/components/parameters/contentType" }, { "$ref": "#/components/parameters/connection" } ], "responses": { "200": { "description": "Запрос выполнен успешно", "content": { "application/json": { "schema": { "type": "object", "$ref": "./components/schemas/ru.edgex.quickresto.modules.warehouse.store.Store.json" } } } }, "400": { "$ref": "./components/responses/400.json" }, "401": { "$ref": "./components/responses/401.json" } }, "operationId": "4bded7010c0583a846dabb3103d6a0db", "tags": [ "Склады" ] } } } }