From 90df7c8b3a2aea670020a02431b9ef8de7f5a81d Mon Sep 17 00:00:00 2001 From: alex-dolganov Date: Wed, 30 Sep 2026 11:44:20 +0400 Subject: [PATCH] =?UTF-8?q?=D0=94=D0=BE=D0=B1=D0=B0=D0=B2=D0=B8=D0=BB?= =?UTF-8?q?=D0=B8=20=D0=B2=20=D1=81=D1=85=D0=B5=D0=BC=D1=8B=20=D0=BF=D0=B5?= =?UTF-8?q?=D1=81=D0=BE=D1=87=D0=BD=D0=B8=D1=86=D1=8B=20=D0=BA=D0=BE=D0=BD?= =?UTF-8?q?=D1=82=D0=B5=D0=BA=D1=81=D1=82=20=D0=B4=D0=BB=D1=8F=20=D0=98?= =?UTF-8?q?=D0=98:=20=D0=BF=D1=80=D0=B8=D0=BC=D0=B5=D1=80=20=D0=B7=D0=B0?= =?UTF-8?q?=D0=BF=D1=80=D0=BE=D1=81=D0=B0=20=D0=B8=20=D0=BF=D0=BE=D0=B4?= =?UTF-8?q?=D1=81=D0=BA=D0=B0=D0=B7=D0=BA=D1=83=20=D0=BF=D0=BE=20=D0=B4?= =?UTF-8?q?=D0=B0=D1=82=D0=B0=D1=81=D0=B5=D1=82=D1=83?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Генератор кладёт в каждую схему метода два новых поля: - requestExample — тело запроса со страницы, прошедшее валидацию по её же таблице параметров. Примеры с подстановками оболочки и не проходящие валидацию не сохраняются. Покрытие: 1225 методов из 1596 (76,8%). - datasetHint — что реально лежит в датасете песочницы (entity, count, idFrom/idTo либо список ids) и runnableExample — готовый вызов с настоящим идентификатором. Каждый такой пример генератор выполняет и сохраняет только при успехе. 13 исполняемых методов. Это лечит случаи, когда пример со страницы указывает на несуществующий объект: у tasks.task.get страница предлагает taskId 8017, которого в датасете нет, — 84 ошибки из 84 вызовов в песочнице. Теперь рядом лежит taskId 100 и диапазон 100…129. Заодно схемы пересобраны с текущей документации: 19 новых методов и 194 обновившихся — блокирующий шаг asset-sync до этого был красным. Проверено: test.js 26/26, test-server.js 9/9, dashboard/test.js 32/32; generate-spec.js --lint и check-examples.js --strict проходят; повторный прогон генератора ничего не меняет; все 13 runnableExample выполняются. Ядро simulator/lib/core.js не затронуто — передеплой песочницы на вайбкоде не нужен, она берёт схемы с апидокса и обновится сама. Co-Authored-By: Claude Opus 5 (1M context) --- _assets/simulator/spec/index.json | 265 +++++++++-- .../simulator/spec/methods/access.name.json | 24 +- .../spec/methods/ai.engine.list.json | 36 +- .../spec/methods/ai.engine.register.json | 55 ++- .../spec/methods/ai.engine.unregister.json | 11 +- _assets/simulator/spec/methods/app.info.json | 81 ++++ .../spec/methods/app.option.get.json | 6 +- .../spec/methods/app.option.set.json | 12 +- .../methods/biconnector.connector.add.json | 32 +- .../methods/biconnector.connector.delete.json | 4 +- .../methods/biconnector.connector.fields.json | 43 +- .../methods/biconnector.connector.get.json | 21 +- .../methods/biconnector.connector.list.json | 21 +- .../methods/biconnector.connector.update.json | 32 +- .../spec/methods/biconnector.dataset.add.json | 17 +- .../methods/biconnector.dataset.delete.json | 7 +- .../methods/biconnector.dataset.fields.json | 44 +- .../biconnector.dataset.fields.update.json | 21 +- .../spec/methods/biconnector.dataset.get.json | 35 +- .../methods/biconnector.dataset.list.json | 24 +- .../methods/biconnector.dataset.update.json | 7 +- .../spec/methods/biconnector.source.add.json | 8 +- .../methods/biconnector.source.delete.json | 6 +- .../methods/biconnector.source.fields.json | 41 +- .../spec/methods/biconnector.source.get.json | 13 +- .../spec/methods/biconnector.source.list.json | 24 +- .../methods/biconnector.source.update.json | 12 +- .../spec/methods/biconnector.table.add.json | 108 +++++ .../methods/biconnector.table.delete.json | 52 +++ .../methods/biconnector.table.fields.json | 193 ++++++++ .../biconnector.table.fields.update.json | 85 ++++ .../spec/methods/biconnector.table.get.json | 125 +++++ .../spec/methods/biconnector.table.list.json | 110 +++++ .../methods/biconnector.table.update.json | 77 ++++ .../spec/methods/bizproc.event.send.json | 8 +- .../spec/methods/bizproc.robot.add.json | 18 +- .../spec/methods/bizproc.robot.delete.json | 2 +- .../spec/methods/bizproc.robot.list.json | 4 +- .../spec/methods/bizproc.robot.update.json | 10 +- .../spec/methods/bizproc.task.complete.json | 11 +- .../spec/methods/bizproc.task.delegate.json | 11 +- .../spec/methods/bizproc.workflow.start.json | 13 +- .../methods/bizproc.workflow.terminate.json | 6 +- .../spec/methods/booking.v1.booking.add.json | 23 +- .../booking.v1.booking.client.list.json | 5 +- .../booking.v1.booking.client.set.json | 21 +- .../booking.v1.booking.client.unset.json | 5 +- ...booking.v1.booking.createfromwaitlist.json | 38 +- .../methods/booking.v1.booking.delete.json | 5 +- .../booking.v1.booking.externalData.list.json | 13 +- .../booking.v1.booking.externalData.set.json | 14 +- ...booking.v1.booking.externalData.unset.json | 5 +- .../spec/methods/booking.v1.booking.get.json | 5 +- .../spec/methods/booking.v1.booking.list.json | 9 +- .../methods/booking.v1.booking.update.json | 24 +- .../methods/booking.v1.clienttype.list.json | 7 +- .../spec/methods/booking.v1.resource.add.json | 28 +- .../methods/booking.v1.resource.delete.json | 5 +- .../spec/methods/booking.v1.resource.get.json | 5 +- .../methods/booking.v1.resource.list.json | 14 +- .../booking.v1.resource.slots.list.json | 5 +- .../booking.v1.resource.slots.set.json | 20 +- .../booking.v1.resource.slots.unset.json | 5 +- .../methods/booking.v1.resource.update.json | 29 +- .../methods/booking.v1.resourceType.add.json | 25 +- .../booking.v1.resourceType.delete.json | 5 +- .../methods/booking.v1.resourceType.get.json | 5 +- .../methods/booking.v1.resourceType.list.json | 12 +- .../booking.v1.resourceType.update.json | 26 +- .../spec/methods/booking.v1.waitlist.add.json | 13 +- .../booking.v1.waitlist.client.list.json | 40 +- .../booking.v1.waitlist.client.set.json | 54 ++- .../booking.v1.waitlist.client.unset.json | 22 +- ...booking.v1.waitlist.createfrombooking.json | 5 +- .../methods/booking.v1.waitlist.delete.json | 5 +- ...booking.v1.waitlist.externalData.list.json | 5 +- .../booking.v1.waitlist.externalData.set.json | 12 +- ...ooking.v1.waitlist.externalData.unset.json | 5 +- .../spec/methods/booking.v1.waitlist.get.json | 5 +- .../methods/booking.v1.waitlist.list.json | 10 +- .../methods/booking.v1.waitlist.update.json | 8 +- .../spec/methods/calendar.event.add.json | 49 +- .../spec/methods/calendar.event.delete.json | 5 +- .../spec/methods/calendar.event.get.json | 12 +- .../methods/calendar.event.get.nearest.json | 12 +- .../spec/methods/calendar.event.getbyid.json | 5 +- .../spec/methods/calendar.event.update.json | 52 ++- .../methods/calendar.meeting.status.get.json | 5 +- .../methods/calendar.meeting.status.set.json | 6 +- .../spec/methods/calendar.resource.add.json | 5 +- .../methods/calendar.resource.delete.json | 5 +- .../methods/calendar.resource.update.json | 6 +- .../spec/methods/calendar.section.add.json | 14 +- .../spec/methods/calendar.section.delete.json | 7 +- .../spec/methods/calendar.section.get.json | 6 +- .../spec/methods/calendar.section.update.json | 16 +- .../spec/methods/call.followup.field.get.json | 14 +- .../methods/call.followup.field.list.json | 14 +- .../spec/methods/call.followup.get.json | 6 +- .../spec/methods/call.followup.list.json | 24 +- .../spec/methods/catalog.catalog.get.json | 5 +- .../methods/catalog.catalog.isOffers.json | 5 +- .../spec/methods/catalog.catalog.list.json | 26 +- .../spec/methods/catalog.document.add.json | 12 +- .../spec/methods/catalog.document.cancel.json | 5 +- .../methods/catalog.document.cancelList.json | 9 +- .../methods/catalog.document.conduct.json | 5 +- .../methods/catalog.document.conductList.json | 9 +- .../methods/catalog.document.confirm.json | 5 +- .../spec/methods/catalog.document.delete.json | 5 +- .../methods/catalog.document.deleteList.json | 9 +- .../methods/catalog.document.element.add.json | 11 +- .../catalog.document.element.delete.json | 5 +- .../catalog.document.element.fields.json | 3 +- .../catalog.document.element.getFields.json | 3 +- .../catalog.document.element.list.json | 18 +- .../catalog.document.element.update.json | 10 +- .../spec/methods/catalog.document.fields.json | 3 +- .../methods/catalog.document.getFields.json | 3 +- .../spec/methods/catalog.document.list.json | 21 +- .../methods/catalog.document.mode.status.json | 3 +- .../methods/catalog.document.unconfirm.json | 5 +- .../spec/methods/catalog.document.update.json | 10 +- .../catalog.documentcontractor.add.json | 9 +- .../catalog.documentcontractor.delete.json | 5 +- .../catalog.documentcontractor.getFields.json | 3 +- .../catalog.documentcontractor.list.json | 15 +- .../methods/catalog.enum.getRoundTypes.json | 3 +- .../catalog.enum.getStoreDocumentTypes.json | 3 +- .../spec/methods/catalog.extra.get.json | 5 +- .../spec/methods/catalog.extra.list.json | 14 +- .../spec/methods/catalog.measure.add.json | 12 +- .../spec/methods/catalog.measure.delete.json | 5 +- .../spec/methods/catalog.measure.get.json | 5 +- .../spec/methods/catalog.measure.list.json | 15 +- .../spec/methods/catalog.price.add.json | 10 +- .../spec/methods/catalog.price.delete.json | 5 +- .../spec/methods/catalog.price.get.json | 5 +- .../spec/methods/catalog.price.getFields.json | 3 +- .../spec/methods/catalog.price.list.json | 17 +- .../spec/methods/catalog.price.modify.json | 27 +- .../spec/methods/catalog.price.update.json | 9 +- .../spec/methods/catalog.priceType.add.json | 14 +- .../methods/catalog.priceType.delete.json | 7 +- .../spec/methods/catalog.priceType.get.json | 7 +- .../spec/methods/catalog.priceType.list.json | 51 ++- .../methods/catalog.priceType.update.json | 17 +- .../methods/catalog.priceTypeGroup.add.json | 9 +- .../catalog.priceTypeGroup.delete.json | 7 +- .../catalog.priceTypeGroup.getFields.json | 3 +- .../methods/catalog.priceTypeGroup.list.json | 25 +- .../methods/catalog.priceTypeLang.add.json | 11 +- .../methods/catalog.priceTypeLang.delete.json | 7 +- .../methods/catalog.priceTypeLang.get.json | 7 +- .../catalog.priceTypeLang.getLanguages.json | 19 +- .../methods/catalog.priceTypeLang.list.json | 20 +- .../methods/catalog.priceTypeLang.update.json | 12 +- .../spec/methods/catalog.product.delete.json | 5 +- .../methods/catalog.product.download.json | 9 +- .../spec/methods/catalog.product.get.json | 5 +- .../catalog.product.getFieldsByFilter.json | 7 +- .../spec/methods/catalog.product.list.json | 61 ++- .../methods/catalog.product.offer.delete.json | 5 +- .../catalog.product.offer.download.json | 25 +- .../methods/catalog.product.offer.get.json | 5 +- ...talog.product.offer.getFieldsByFilter.json | 7 +- .../methods/catalog.product.offer.list.json | 62 ++- .../catalog.product.service.delete.json | 5 +- .../catalog.product.service.download.json | 21 +- .../methods/catalog.product.service.get.json | 5 +- ...log.product.service.getFieldsByFilter.json | 7 +- .../methods/catalog.product.service.list.json | 44 +- .../methods/catalog.product.sku.delete.json | 5 +- .../methods/catalog.product.sku.download.json | 9 +- .../spec/methods/catalog.product.sku.get.json | 5 +- ...catalog.product.sku.getFieldsByFilter.json | 7 +- .../methods/catalog.product.sku.list.json | 54 ++- .../methods/catalog.productImage.add.json | 12 +- .../methods/catalog.productImage.delete.json | 6 +- .../methods/catalog.productImage.get.json | 6 +- .../methods/catalog.productImage.list.json | 14 +- .../methods/catalog.productProperty.add.json | 18 +- .../catalog.productProperty.delete.json | 5 +- .../methods/catalog.productProperty.get.json | 5 +- .../catalog.productProperty.getFields.json | 3 +- .../methods/catalog.productProperty.list.json | 16 +- .../catalog.productProperty.update.json | 12 +- .../catalog.productPropertyEnum.add.json | 11 +- .../catalog.productPropertyEnum.delete.json | 5 +- .../catalog.productPropertyEnum.get.json | 5 +- ...catalog.productPropertyEnum.getFields.json | 3 +- .../catalog.productPropertyEnum.list.json | 18 +- .../catalog.productPropertyEnum.update.json | 12 +- .../catalog.productPropertyFeature.add.json | 10 +- .../catalog.productPropertyFeature.get.json | 5 +- ...eature.getAvailableFeaturesByProperty.json | 5 +- ...alog.productPropertyFeature.getFields.json | 3 +- .../catalog.productPropertyFeature.list.json | 17 +- ...catalog.productPropertyFeature.update.json | 11 +- .../catalog.productPropertySection.get.json | 5 +- .../catalog.productPropertySection.list.json | 17 +- .../catalog.productPropertySection.set.json | 11 +- .../spec/methods/catalog.ratio.get.json | 5 +- .../spec/methods/catalog.ratio.list.json | 21 +- .../methods/catalog.roundingRule.add.json | 10 +- .../methods/catalog.roundingRule.delete.json | 5 +- .../methods/catalog.roundingRule.get.json | 5 +- .../methods/catalog.roundingRule.list.json | 15 +- .../spec/methods/catalog.section.add.json | 15 +- .../spec/methods/catalog.section.delete.json | 5 +- .../spec/methods/catalog.section.get.json | 5 +- .../spec/methods/catalog.section.list.json | 16 +- .../spec/methods/catalog.section.update.json | 11 +- .../spec/methods/catalog.store.add.json | 29 +- .../spec/methods/catalog.store.delete.json | 5 +- .../spec/methods/catalog.store.get.json | 5 +- .../spec/methods/catalog.store.list.json | 36 +- .../spec/methods/catalog.store.update.json | 30 +- .../methods/catalog.storeproduct.get.json | 5 +- .../catalog.storeproduct.getFields.json | 3 +- .../methods/catalog.storeproduct.list.json | 16 +- .../catalog.userfield.document.list.json | 17 +- .../spec/methods/catalog.vat.add.json | 10 +- .../spec/methods/catalog.vat.delete.json | 5 +- .../spec/methods/catalog.vat.get.json | 5 +- .../spec/methods/catalog.vat.list.json | 15 +- .../spec/methods/catalog.vat.update.json | 11 +- .../spec/methods/crm.activity.badge.add.json | 20 +- .../methods/crm.activity.badge.delete.json | 11 +- .../spec/methods/crm.activity.badge.get.json | 9 +- .../spec/methods/crm.activity.badge.list.json | 30 +- .../methods/crm.activity.binding.add.json | 7 +- .../methods/crm.activity.binding.delete.json | 7 +- .../methods/crm.activity.binding.list.json | 5 +- .../methods/crm.activity.binding.move.json | 9 +- .../crm.activity.call.getTranscript.json | 5 +- .../crm.activity.communication.fields.json | 3 +- .../crm.activity.configurable.add.json | 42 +- .../crm.activity.configurable.get.json | 142 +++++- .../crm.activity.configurable.update.json | 30 +- .../spec/methods/crm.activity.delete.json | 5 +- .../spec/methods/crm.activity.fields.json | 3 +- .../spec/methods/crm.activity.get.json | 5 +- .../crm.activity.layout.blocks.delete.json | 37 +- .../crm.activity.layout.blocks.get.json | 110 +++-- .../crm.activity.layout.blocks.set.json | 37 +- .../spec/methods/crm.activity.list.json | 108 ++++- .../crm.activity.todo.updateColor.json | 8 +- .../crm.activity.todo.updateDescription.json | 8 +- ...m.activity.todo.updateResponsibleUser.json | 8 +- .../spec/methods/crm.address.add.json | 16 +- .../spec/methods/crm.address.delete.json | 9 +- .../spec/methods/crm.address.update.json | 11 +- .../methods/crm.automatedsolution.add.json | 22 +- .../methods/crm.automatedsolution.delete.json | 25 +- .../methods/crm.automatedsolution.fields.json | 101 ++++ .../methods/crm.automatedsolution.get.json | 9 +- .../methods/crm.automatedsolution.list.json | 26 +- .../methods/crm.automatedsolution.update.json | 28 +- .../methods/crm.automation.trigger.add.json | 6 +- .../crm.automation.trigger.delete.json | 5 +- .../crm.automation.trigger.execute.json | 7 +- .../spec/methods/crm.automation.trigger.json | 6 +- .../spec/methods/crm.calllist.add.json | 11 +- .../spec/methods/crm.calllist.get.json | 5 +- .../spec/methods/crm.calllist.items.get.json | 8 +- .../spec/methods/crm.calllist.statuslist.json | 3 +- .../spec/methods/crm.calllist.update.json | 12 +- .../spec/methods/crm.category.add.json | 10 +- .../spec/methods/crm.category.delete.json | 6 +- .../spec/methods/crm.category.fields.json | 5 +- .../spec/methods/crm.category.get.json | 6 +- .../spec/methods/crm.category.list.json | 14 +- .../spec/methods/crm.category.update.json | 11 +- .../spec/methods/crm.company.add.json | 23 +- .../spec/methods/crm.company.contact.add.json | 10 +- .../methods/crm.company.contact.delete.json | 8 +- .../methods/crm.company.contact.fields.json | 3 +- .../crm.company.contact.items.delete.json | 5 +- .../crm.company.contact.items.get.json | 5 +- .../crm.company.contact.items.set.json | 20 +- ....configuration.forceCommonScopeForAll.json | 3 +- ...crm.company.details.configuration.get.json | 6 +- ...m.company.details.configuration.reset.json | 6 +- ...crm.company.details.configuration.set.json | 57 ++- .../spec/methods/crm.company.fields.json | 3 +- .../spec/methods/crm.company.get.json | 11 +- .../spec/methods/crm.company.list.json | 9 +- .../methods/crm.company.userfield.add.json | 40 +- .../methods/crm.company.userfield.delete.json | 5 +- .../methods/crm.company.userfield.get.json | 5 +- .../methods/crm.company.userfield.list.json | 13 +- .../spec/methods/crm.contact.company.add.json | 10 +- .../crm.contact.company.items.delete.json | 5 +- .../crm.contact.company.items.get.json | 5 +- .../crm.contact.company.items.set.json | 20 +- ...crm.contact.details.configuration.get.json | 6 +- ...m.contact.details.configuration.reset.json | 5 +- ...crm.contact.details.configuration.set.json | 74 ++- .../spec/methods/crm.contact.get.json | 11 +- .../spec/methods/crm.contact.list.json | 9 +- .../methods/crm.contact.userfield.add.json | 40 +- .../methods/crm.contact.userfield.delete.json | 5 +- .../methods/crm.contact.userfield.get.json | 5 +- .../methods/crm.contact.userfield.list.json | 13 +- .../spec/methods/crm.currency.add.json | 29 +- .../spec/methods/crm.currency.base.set.json | 5 +- .../spec/methods/crm.currency.delete.json | 5 +- .../spec/methods/crm.currency.get.json | 5 +- .../spec/methods/crm.currency.list.json | 8 +- .../crm.currency.localizations.delete.json | 9 +- .../crm.currency.localizations.get.json | 5 +- .../crm.currency.localizations.set.json | 21 +- .../spec/methods/crm.deal.contact.add.json | 10 +- .../spec/methods/crm.deal.contact.delete.json | 8 +- .../spec/methods/crm.deal.contact.fields.json | 3 +- .../crm.deal.contact.items.delete.json | 5 +- .../methods/crm.deal.contact.items.get.json | 5 +- .../methods/crm.deal.contact.items.set.json | 20 +- ....configuration.forceCommonScopeForAll.json | 7 +- .../crm.deal.details.configuration.get.json | 8 +- .../crm.deal.details.configuration.reset.json | 9 +- .../crm.deal.details.configuration.set.json | 68 ++- .../spec/methods/crm.deal.fields.json | 3 +- .../simulator/spec/methods/crm.deal.get.json | 11 +- .../simulator/spec/methods/crm.deal.list.json | 9 +- .../spec/methods/crm.deal.recurring.add.json | 20 +- .../methods/crm.deal.recurring.delete.json | 5 +- .../methods/crm.deal.recurring.expose.json | 5 +- .../methods/crm.deal.recurring.fields.json | 3 +- .../spec/methods/crm.deal.recurring.get.json | 5 +- .../spec/methods/crm.deal.recurring.list.json | 10 +- .../methods/crm.deal.recurring.update.json | 21 +- .../spec/methods/crm.deal.userfield.add.json | 40 +- .../methods/crm.deal.userfield.delete.json | 5 +- .../spec/methods/crm.deal.userfield.get.json | 5 +- .../spec/methods/crm.deal.userfield.list.json | 13 +- .../spec/methods/crm.dealcategory.add.json | 8 +- .../methods/crm.dealcategory.default.set.json | 5 +- .../spec/methods/crm.dealcategory.delete.json | 5 +- .../spec/methods/crm.dealcategory.get.json | 5 +- .../methods/crm.dealcategory.stage.list.json | 5 +- .../spec/methods/crm.dealcategory.update.json | 8 +- .../crm.documentgenerator.document.add.json | 24 +- ...crm.documentgenerator.document.delete.json | 5 +- ...entgenerator.document.enablepublicurl.json | 6 +- .../crm.documentgenerator.document.get.json | 5 +- ....documentgenerator.document.getfields.json | 8 +- .../crm.documentgenerator.document.list.json | 19 +- ...crm.documentgenerator.document.update.json | 9 +- ...crm.documentgenerator.document.upload.json | 14 +- .../crm.documentgenerator.numerator.add.json | 19 +- ...rm.documentgenerator.numerator.delete.json | 5 +- .../crm.documentgenerator.numerator.get.json | 5 +- .../crm.documentgenerator.numerator.list.json | 9 +- ...rm.documentgenerator.numerator.update.json | 20 +- .../crm.documentgenerator.template.add.json | 23 +- ...crm.documentgenerator.template.delete.json | 5 +- .../crm.documentgenerator.template.get.json | 5 +- ....documentgenerator.template.getfields.json | 10 +- .../crm.documentgenerator.template.list.json | 19 +- ...crm.documentgenerator.template.update.json | 23 +- .../methods/crm.duplicate.findbycomm.json | 10 +- .../crm.duplicate.volatileType.fields.json | 5 +- .../crm.duplicate.volatileType.list.json | 3 +- .../crm.duplicate.volatileType.register.json | 6 +- ...crm.duplicate.volatileType.unregister.json | 5 +- .../spec/methods/crm.entity.mergeBatch.json | 12 +- .../methods/crm.enum.activitydirection.json | 3 +- .../methods/crm.enum.activitynotifytype.json | 3 +- .../methods/crm.enum.activitypriority.json | 3 +- .../spec/methods/crm.enum.activitystatus.json | 3 +- .../spec/methods/crm.enum.activitytype.json | 3 +- .../spec/methods/crm.enum.addresstype.json | 3 +- .../spec/methods/crm.enum.contenttype.json | 3 +- .../spec/methods/crm.enum.fields.json | 3 +- .../methods/crm.enum.getorderownertypes.json | 3 +- .../spec/methods/crm.enum.ownertype.json | 3 +- .../spec/methods/crm.enum.settings.mode.json | 3 +- .../methods/crm.invoice.userfield.list.json | 10 +- .../methods/crm.invoice.userfield.update.json | 9 +- .../spec/methods/crm.item.batchImport.json | 79 +++- .../spec/methods/crm.item.delete.json | 6 +- .../spec/methods/crm.item.delivery.get.json | 45 +- .../spec/methods/crm.item.delivery.list.json | 101 +++- ....configuration.forceCommonScopeForAll.json | 8 +- .../crm.item.details.configuration.get.json | 10 +- .../crm.item.details.configuration.reset.json | 10 +- .../crm.item.details.configuration.set.json | 75 ++- .../spec/methods/crm.item.fields.json | 6 +- .../simulator/spec/methods/crm.item.get.json | 7 +- .../simulator/spec/methods/crm.item.list.json | 46 +- .../spec/methods/crm.item.payment.add.json | 6 +- .../spec/methods/crm.item.payment.delete.json | 5 +- .../crm.item.payment.delivery.add.json | 6 +- .../crm.item.payment.delivery.delete.json | 5 +- .../crm.item.payment.delivery.list.json | 11 +- ...crm.item.payment.delivery.setDelivery.json | 6 +- .../spec/methods/crm.item.payment.get.json | 5 +- .../spec/methods/crm.item.payment.list.json | 12 +- .../spec/methods/crm.item.payment.pay.json | 5 +- .../methods/crm.item.payment.product.add.json | 17 +- .../crm.item.payment.product.delete.json | 9 +- .../crm.item.payment.product.list.json | 20 +- .../crm.item.payment.product.setQuantity.json | 16 +- .../spec/methods/crm.item.payment.unpay.json | 5 +- .../spec/methods/crm.item.payment.update.json | 9 +- .../spec/methods/crm.item.productrow.add.json | 47 +- .../methods/crm.item.productrow.delete.json | 13 +- .../methods/crm.item.productrow.fields.json | 57 +++ .../spec/methods/crm.item.productrow.get.json | 19 +- ...tem.productrow.getAvailableForPayment.json | 19 +- .../methods/crm.item.productrow.list.json | 64 ++- .../spec/methods/crm.item.productrow.set.json | 63 ++- .../methods/crm.item.productrow.update.json | 46 +- .../simulator/spec/methods/crm.lead.add.json | 30 +- .../spec/methods/crm.lead.contact.add.json | 10 +- .../spec/methods/crm.lead.contact.delete.json | 8 +- .../crm.lead.contact.items.delete.json | 5 +- .../methods/crm.lead.contact.items.get.json | 5 +- .../methods/crm.lead.contact.items.set.json | 17 +- .../spec/methods/crm.lead.delete.json | 5 +- ....configuration.forceCommonScopeForAll.json | 7 +- .../crm.lead.details.configuration.get.json | 6 +- .../crm.lead.details.configuration.reset.json | 6 +- .../crm.lead.details.configuration.set.json | 47 +- .../spec/methods/crm.lead.fields.json | 3 +- .../simulator/spec/methods/crm.lead.get.json | 11 +- .../simulator/spec/methods/crm.lead.list.json | 9 +- .../methods/crm.lead.productrows.get.json | 5 +- .../methods/crm.lead.productrows.set.json | 29 +- .../spec/methods/crm.lead.update.json | 31 +- .../spec/methods/crm.lead.userfield.add.json | 40 +- .../methods/crm.lead.userfield.delete.json | 5 +- .../spec/methods/crm.lead.userfield.get.json | 5 +- .../spec/methods/crm.lead.userfield.list.json | 13 +- .../spec/methods/crm.measure.add.json | 12 +- .../spec/methods/crm.measure.delete.json | 5 +- .../spec/methods/crm.measure.get.json | 5 +- .../spec/methods/crm.measure.update.json | 8 +- .../spec/methods/crm.multifield.fields.json | 3 +- .../spec/methods/crm.orderentity.add.json | 9 +- .../crm.orderentity.deleteByFilter.json | 9 +- .../spec/methods/crm.orderentity.list.json | 19 +- .../spec/methods/crm.product.add.json | 10 +- .../methods/crm.product.property.list.json | 11 +- .../crm.product.property.settings.fields.json | 6 +- .../simulator/spec/methods/crm.quote.add.json | 20 +- .../spec/methods/crm.quote.contact.add.json | 10 +- .../methods/crm.quote.contact.delete.json | 8 +- .../methods/crm.quote.contact.fields.json | 3 +- .../crm.quote.contact.items.delete.json | 5 +- .../methods/crm.quote.contact.items.get.json | 5 +- .../methods/crm.quote.contact.items.set.json | 16 +- .../spec/methods/crm.quote.delete.json | 5 +- .../spec/methods/crm.quote.fields.json | 3 +- .../simulator/spec/methods/crm.quote.get.json | 5 +- .../spec/methods/crm.quote.list.json | 20 +- .../methods/crm.quote.productrows.get.json | 5 +- .../methods/crm.quote.productrows.set.json | 31 +- .../spec/methods/crm.quote.update.json | 12 +- .../spec/methods/crm.quote.userfield.add.json | 40 +- .../methods/crm.quote.userfield.delete.json | 5 +- .../spec/methods/crm.quote.userfield.get.json | 5 +- .../methods/crm.quote.userfield.list.json | 13 +- .../spec/methods/crm.requisite.add.json | 23 +- .../methods/crm.requisite.bankdetail.add.json | 18 +- .../crm.requisite.bankdetail.delete.json | 5 +- .../methods/crm.requisite.bankdetail.get.json | 5 +- .../crm.requisite.bankdetail.list.json | 15 +- .../crm.requisite.bankdetail.update.json | 11 +- .../spec/methods/crm.requisite.delete.json | 5 +- .../spec/methods/crm.requisite.get.json | 5 +- .../spec/methods/crm.requisite.link.get.json | 6 +- .../spec/methods/crm.requisite.link.list.json | 15 +- .../methods/crm.requisite.link.register.json | 12 +- .../crm.requisite.link.unregister.json | 6 +- .../spec/methods/crm.requisite.list.json | 16 +- .../methods/crm.requisite.preset.add.json | 12 +- .../methods/crm.requisite.preset.delete.json | 5 +- .../crm.requisite.preset.field.add.json | 13 +- ...requisite.preset.field.availabletoadd.json | 7 +- .../crm.requisite.preset.field.list.json | 7 +- .../methods/crm.requisite.preset.get.json | 5 +- .../methods/crm.requisite.preset.list.json | 14 +- .../methods/crm.requisite.preset.update.json | 9 +- .../spec/methods/crm.requisite.update.json | 11 +- .../methods/crm.requisite.userfield.add.json | 17 +- .../crm.requisite.userfield.delete.json | 5 +- .../methods/crm.requisite.userfield.get.json | 5 +- .../methods/crm.requisite.userfield.list.json | 11 +- .../crm.requisite.userfield.update.json | 10 +- .../spec/methods/crm.settings.mode.get.json | 4 +- .../spec/methods/crm.stagehistory.list.json | 16 +- .../spec/methods/crm.status.add.json | 11 +- .../spec/methods/crm.status.delete.json | 5 +- .../spec/methods/crm.status.entity.items.json | 5 +- .../spec/methods/crm.status.entity.types.json | 3 +- .../spec/methods/crm.status.fields.json | 3 +- .../spec/methods/crm.status.get.json | 5 +- .../spec/methods/crm.status.list.json | 24 +- .../spec/methods/crm.status.update.json | 9 +- .../methods/crm.timeline.bindings.bind.json | 43 +- .../methods/crm.timeline.bindings.fields.json | 96 ++++ .../methods/crm.timeline.bindings.list.json | 54 ++- .../methods/crm.timeline.bindings.unbind.json | 43 +- .../methods/crm.timeline.comment.add.json | 19 +- .../methods/crm.timeline.comment.delete.json | 7 +- .../methods/crm.timeline.comment.get.json | 5 +- .../methods/crm.timeline.comment.list.json | 18 +- .../methods/crm.timeline.comment.update.json | 18 +- .../spec/methods/crm.timeline.icon.add.json | 6 +- .../methods/crm.timeline.icon.delete.json | 5 +- .../spec/methods/crm.timeline.icon.get.json | 5 +- .../spec/methods/crm.timeline.item.pin.json | 7 +- .../spec/methods/crm.timeline.item.unpin.json | 7 +- .../crm.timeline.layout.blocks.delete.json | 7 +- .../crm.timeline.layout.blocks.get.json | 7 +- .../methods/crm.timeline.logmessage.add.json | 11 +- .../crm.timeline.logmessage.delete.json | 5 +- .../methods/crm.timeline.logmessage.get.json | 5 +- .../methods/crm.timeline.logmessage.list.json | 10 +- .../spec/methods/crm.timeline.logo.add.json | 6 +- .../methods/crm.timeline.logo.delete.json | 5 +- .../spec/methods/crm.timeline.logo.get.json | 5 +- .../methods/crm.timeline.note.delete.json | 8 +- .../spec/methods/crm.timeline.note.get.json | 8 +- .../spec/methods/crm.timeline.note.save.json | 9 +- .../spec/methods/crm.tracking.trace.add.json | 15 +- .../methods/crm.tracking.trace.delete.json | 5 +- .../simulator/spec/methods/crm.type.add.json | 51 ++- .../spec/methods/crm.type.delete.json | 5 +- .../simulator/spec/methods/crm.type.get.json | 5 +- .../methods/crm.type.getByEntityTypeId.json | 5 +- .../simulator/spec/methods/crm.type.list.json | 10 +- .../spec/methods/crm.type.update.json | 17 +- .../crm.userfield.enumeration.fields.json | 3 +- .../spec/methods/crm.userfield.fields.json | 3 +- .../crm.userfield.settings.fields.json | 5 +- .../spec/methods/crm.userfield.types.json | 3 +- .../simulator/spec/methods/crm.vat.add.json | 10 +- .../spec/methods/crm.vat.delete.json | 5 +- .../spec/methods/crm.vat.fields.json | 3 +- .../simulator/spec/methods/crm.vat.get.json | 5 +- .../simulator/spec/methods/crm.vat.list.json | 15 +- .../spec/methods/department.add.json | 8 +- .../spec/methods/department.delete.json | 5 +- .../spec/methods/department.get.json | 7 +- .../spec/methods/department.update.json | 9 +- .../spec/methods/disk.attachedObject.get.json | 5 +- .../spec/methods/disk.file.copyTo.json | 6 +- .../spec/methods/disk.file.delete.json | 5 +- .../simulator/spec/methods/disk.file.get.json | 5 +- .../methods/disk.file.getExternalLink.json | 5 +- .../spec/methods/disk.file.getFields.json | 3 +- .../spec/methods/disk.file.getVersions.json | 8 +- .../spec/methods/disk.file.markDeleted.json | 5 +- .../spec/methods/disk.file.moveTo.json | 6 +- .../spec/methods/disk.file.rename.json | 6 +- .../spec/methods/disk.file.restore.json | 5 +- .../methods/disk.file.restoreFromVersion.json | 6 +- .../spec/methods/disk.file.search.json | 9 +- .../spec/methods/disk.file.uploadVersion.json | 9 +- .../methods/disk.folder.addSubFolder.json | 25 +- .../spec/methods/disk.folder.copyTo.json | 6 +- .../spec/methods/disk.folder.deleteTree.json | 5 +- .../spec/methods/disk.folder.get.json | 5 +- .../spec/methods/disk.folder.getChildren.json | 11 +- .../methods/disk.folder.getExternalLink.json | 5 +- .../spec/methods/disk.folder.getFields.json | 3 +- .../spec/methods/disk.folder.markDeleted.json | 5 +- .../spec/methods/disk.folder.moveTo.json | 6 +- .../spec/methods/disk.folder.rename.json | 6 +- .../spec/methods/disk.folder.restore.json | 5 +- .../spec/methods/disk.folder.shareToUser.json | 7 +- .../spec/methods/disk.folder.uploadFile.json | 21 +- .../spec/methods/disk.rights.getTasks.json | 3 +- .../spec/methods/disk.storage.addFolder.json | 16 +- .../spec/methods/disk.storage.get.json | 5 +- .../methods/disk.storage.getChildren.json | 11 +- .../spec/methods/disk.storage.getFields.json | 3 +- .../spec/methods/disk.storage.getList.json | 10 +- .../spec/methods/disk.storage.getTypes.json | 3 +- .../spec/methods/disk.storage.uploadFile.json | 21 +- .../spec/methods/disk.version.get.json | 67 +-- .../documentgenerator.document.delete.json | 5 +- ...entgenerator.document.enablepublicurl.json | 6 +- .../documentgenerator.document.get.json | 5 +- .../documentgenerator.document.getfields.json | 14 +- .../documentgenerator.document.list.json | 27 +- .../documentgenerator.document.update.json | 15 +- .../documentgenerator.numerator.add.json | 19 +- .../documentgenerator.numerator.delete.json | 5 +- .../documentgenerator.numerator.get.json | 5 +- .../documentgenerator.numerator.list.json | 57 ++- .../documentgenerator.numerator.update.json | 20 +- .../methods/documentgenerator.region.add.json | 15 +- .../documentgenerator.region.delete.json | 5 +- .../methods/documentgenerator.region.get.json | 5 +- .../documentgenerator.region.update.json | 12 +- .../methods/documentgenerator.role.add.json | 20 +- .../documentgenerator.role.delete.json | 5 +- .../documentgenerator.role.fillaccesses.json | 18 +- .../methods/documentgenerator.role.get.json | 5 +- .../methods/documentgenerator.role.list.json | 5 +- .../documentgenerator.role.update.json | 20 +- .../documentgenerator.template.delete.json | 5 +- .../documentgenerator.template.get.json | 5 +- .../documentgenerator.template.getfields.json | 5 +- .../documentgenerator.template.list.json | 18 +- .../documentgenerator.template.update.json | 14 +- .../simulator/spec/methods/feature.get.json | 11 +- .../humanresources.employee.field.get.json | 18 +- .../humanresources.employee.field.list.json | 17 +- .../humanresources.employee.search.json | 14 +- .../humanresources.employee.subordinates.json | 5 +- .../spec/methods/humanresources.node.add.json | 33 +- .../methods/humanresources.node.children.json | 19 +- ...umanresources.node.communication.edit.json | 14 +- ...umanresources.node.communication.list.json | 5 +- .../methods/humanresources.node.edit.json | 7 +- .../humanresources.node.field.get.json | 10 +- .../humanresources.node.field.list.json | 11 +- .../spec/methods/humanresources.node.get.json | 20 +- .../methods/humanresources.node.list.json | 24 +- .../humanresources.node.member.add.json | 11 +- .../humanresources.node.member.field.get.json | 10 +- ...humanresources.node.member.field.list.json | 12 +- .../humanresources.node.member.move.json | 10 +- .../humanresources.node.member.remove.json | 10 +- .../humanresources.node.member.set.json | 18 +- .../methods/humanresources.node.move.json | 6 +- .../methods/humanresources.node.search.json | 10 +- .../simulator/spec/methods/im.chat.add.json | 15 +- .../simulator/spec/methods/im.chat.get.json | 6 +- .../simulator/spec/methods/im.chat.leave.json | 5 +- .../simulator/spec/methods/im.chat.mute.json | 6 +- .../spec/methods/im.chat.setOwner.json | 6 +- .../spec/methods/im.chat.updateAvatar.json | 6 +- .../spec/methods/im.chat.updateColor.json | 6 +- .../spec/methods/im.chat.updateTitle.json | 6 +- .../spec/methods/im.chat.user.add.json | 10 +- .../spec/methods/im.chat.user.delete.json | 6 +- .../spec/methods/im.chat.user.list.json | 5 +- .../spec/methods/im.counters.get.json | 3 +- .../im.department.colleagues.list.json | 7 +- .../methods/im.department.employees.get.json | 9 +- .../spec/methods/im.department.get.json | 9 +- .../methods/im.department.managers.get.json | 9 +- .../simulator/spec/methods/im.dialog.get.json | 5 +- .../spec/methods/im.dialog.messages.get.json | 7 +- .../methods/im.dialog.messages.search.json | 10 +- .../spec/methods/im.dialog.read.all.json | 3 +- .../spec/methods/im.dialog.read.json | 6 +- .../spec/methods/im.dialog.unread.json | 6 +- .../spec/methods/im.dialog.users.list.json | 8 +- .../spec/methods/im.dialog.writing.json | 5 +- .../spec/methods/im.disk.file.delete.json | 6 +- .../spec/methods/im.disk.file.save.json | 5 +- .../spec/methods/im.message.add.json | 9 +- .../spec/methods/im.message.command.json | 8 +- .../spec/methods/im.message.delete.json | 5 +- .../spec/methods/im.message.like.json | 6 +- .../spec/methods/im.message.share.json | 7 +- .../spec/methods/im.notify.answer.json | 6 +- .../spec/methods/im.notify.confirm.json | 6 +- .../spec/methods/im.notify.delete.json | 5 +- .../simulator/spec/methods/im.notify.get.json | 8 +- .../methods/im.notify.history.search.json | 11 +- _assets/simulator/spec/methods/im.notify.json | 10 +- .../spec/methods/im.notify.personal.add.json | 9 +- .../spec/methods/im.notify.read.json | 7 +- .../spec/methods/im.notify.read.list.json | 10 +- .../spec/methods/im.notify.system.add.json | 9 +- .../simulator/spec/methods/im.recent.get.json | 6 +- .../spec/methods/im.recent.hide.json | 5 +- .../spec/methods/im.recent.list.json | 34 +- .../simulator/spec/methods/im.recent.pin.json | 6 +- .../spec/methods/im.recent.unread.json | 6 +- .../spec/methods/im.revision.get.json | 3 +- .../spec/methods/im.search.chat.list.json | 7 +- .../methods/im.search.department.list.json | 8 +- .../spec/methods/im.search.last.add.json | 5 +- .../spec/methods/im.search.last.delete.json | 5 +- .../spec/methods/im.search.last.get.json | 7 +- .../spec/methods/im.search.user.list.json | 8 +- .../simulator/spec/methods/im.user.get.json | 6 +- .../spec/methods/im.user.list.get.json | 10 +- .../methods/im.user.status.idle.start.json | 5 +- .../spec/methods/im.user.status.set.json | 5 +- .../spec/methods/im.v2.Event.get.json | 6 +- .../spec/methods/im.v2.File.download.json | 6 +- .../spec/methods/im.v2.File.upload.json | 10 +- .../spec/methods/imbot.chat.setOwner.json | 6 +- .../spec/methods/imbot.v2.Bot.get.json | 6 +- .../spec/methods/imbot.v2.Bot.list.json | 9 +- .../spec/methods/imbot.v2.Bot.register.json | 14 +- .../spec/methods/imbot.v2.Bot.unregister.json | 6 +- .../spec/methods/imbot.v2.Bot.update.json | 12 +- .../imbot.v2.Chat.InputAction.notify.json | 9 +- .../methods/imbot.v2.Chat.Manager.add.json | 15 +- .../methods/imbot.v2.Chat.Manager.delete.json | 15 +- .../imbot.v2.Chat.Message.Reaction.add.json | 8 +- ...imbot.v2.Chat.Message.Reaction.delete.json | 8 +- .../methods/imbot.v2.Chat.Message.delete.json | 7 +- .../methods/imbot.v2.Chat.Message.get.json | 7 +- .../imbot.v2.Chat.Message.getContext.json | 8 +- .../methods/imbot.v2.Chat.Message.read.json | 8 +- .../methods/imbot.v2.Chat.Message.send.json | 23 +- .../methods/imbot.v2.Chat.Message.update.json | 16 +- .../imbot.v2.Chat.TextField.enabled.json | 8 +- .../spec/methods/imbot.v2.Chat.User.add.json | 18 +- .../methods/imbot.v2.Chat.User.delete.json | 12 +- .../spec/methods/imbot.v2.Chat.User.list.json | 37 +- .../spec/methods/imbot.v2.Chat.add.json | 136 +++--- .../spec/methods/imbot.v2.Chat.get.json | 87 +++- .../spec/methods/imbot.v2.Chat.leave.json | 11 +- .../spec/methods/imbot.v2.Chat.setOwner.json | 14 +- .../spec/methods/imbot.v2.Chat.update.json | 23 +- .../spec/methods/imbot.v2.Command.answer.json | 18 +- .../spec/methods/imbot.v2.Command.list.json | 6 +- .../methods/imbot.v2.Command.register.json | 17 +- .../methods/imbot.v2.Command.unregister.json | 7 +- .../spec/methods/imbot.v2.Command.update.json | 13 +- .../spec/methods/imbot.v2.Event.get.json | 9 +- .../spec/methods/imbot.v2.File.download.json | 7 +- .../spec/methods/imbot.v2.File.upload.json | 12 +- .../spec/methods/imconnector.activate.json | 18 +- .../methods/imconnector.chat.name.set.json | 8 +- .../imconnector.connector.data.set.json | 24 +- .../spec/methods/imconnector.list.json | 6 +- .../imconnector.send.status.delivery.json | 31 +- .../imconnector.send.status.reading.json | 33 +- .../spec/methods/imconnector.status.json | 16 +- .../imopenlines.bot.session.finish.json | 6 +- .../imopenlines.bot.session.message.send.json | 7 +- .../imopenlines.bot.session.operator.json | 5 +- .../imopenlines.bot.session.transfer.json | 8 +- .../spec/methods/imopenlines.config.add.json | 42 +- .../methods/imopenlines.config.delete.json | 5 +- .../spec/methods/imopenlines.config.get.json | 7 +- .../methods/imopenlines.config.list.get.json | 23 +- .../methods/imopenlines.config.update.json | 31 +- .../methods/imopenlines.crm.chat.get.json | 7 +- .../imopenlines.crm.chat.getLastId.json | 6 +- .../imopenlines.crm.chat.user.add.json | 8 +- .../imopenlines.crm.chat.user.delete.json | 8 +- .../methods/imopenlines.crm.lead.create.json | 5 +- .../methods/imopenlines.crm.message.add.json | 9 +- .../spec/methods/imopenlines.dialog.get.json | 5 +- .../imopenlines.message.quick.save.json | 6 +- .../imopenlines.message.session.start.json | 6 +- .../methods/imopenlines.network.join.json | 5 +- .../imopenlines.network.message.add.json | 47 +- .../imopenlines.operator.another.finish.json | 5 +- .../methods/imopenlines.operator.answer.json | 5 +- .../methods/imopenlines.operator.finish.json | 5 +- .../methods/imopenlines.operator.skip.json | 5 +- .../methods/imopenlines.operator.spam.json | 5 +- .../imopenlines.operator.transfer.json | 6 +- .../imopenlines.session.head.vote.json | 7 +- .../imopenlines.session.history.get.json | 5 +- .../imopenlines.session.intercept.json | 5 +- .../methods/imopenlines.session.join.json | 5 +- .../methods/imopenlines.session.mode.pin.json | 6 +- .../imopenlines.session.mode.silent.json | 6 +- .../methods/imopenlines.session.open.json | 5 +- .../methods/imopenlines.session.start.json | 5 +- .../methods/imopenlines.v2.Operator.list.json | 7 +- .../imopenlines.v2.Session.Rating.list.json | 8 +- .../imopenlines.v2.Session.Stat.get.json | 9 +- .../imopenlines.v2.Session.Transfer.list.json | 8 +- .../methods/imopenlines.v2.Session.list.json | 9 +- .../spec/methods/imopenlines.v2.Stat.get.json | 7 +- .../spec/methods/landing.block.addcard.json | 8 +- .../methods/landing.block.changeAnchor.json | 8 +- .../spec/methods/landing.block.clonecard.json | 7 +- ...anding.block.getContentFromRepository.json | 5 +- .../spec/methods/landing.block.getbyid.json | 9 +- .../methods/landing.block.getcontent.json | 10 +- .../spec/methods/landing.block.getlist.json | 9 +- .../methods/landing.block.getmanifest.json | 9 +- .../landing.block.getmanifestfile.json | 5 +- .../methods/landing.block.getrepository.json | 5 +- .../methods/landing.block.publication.json | 64 +++ .../methods/landing.block.removecard.json | 7 +- .../methods/landing.block.updatecontent.json | 8 +- .../spec/methods/landing.demos.getList.json | 22 +- .../methods/landing.demos.getPageList.json | 8 +- .../methods/landing.demos.getSiteList.json | 8 +- .../spec/methods/landing.demos.register.json | 47 +- .../methods/landing.demos.unregister.json | 5 +- .../spec/methods/landing.landing.add.json | 13 +- .../landing.landing.addByTemplate.json | 11 +- .../methods/landing.landing.addblock.json | 10 +- .../spec/methods/landing.landing.copy.json | 7 +- .../methods/landing.landing.copyblock.json | 10 +- .../spec/methods/landing.landing.delete.json | 5 +- .../methods/landing.landing.deleteblock.json | 6 +- .../methods/landing.landing.downblock.json | 6 +- .../landing.landing.favoriteBlock.json | 15 +- .../spec/methods/landing.landing.getList.json | 22 +- .../landing.landing.getadditionalfields.json | 5 +- .../methods/landing.landing.getpreview.json | 5 +- .../methods/landing.landing.getpublicurl.json | 5 +- .../methods/landing.landing.hideblock.json | 6 +- .../methods/landing.landing.markDelete.json | 5 +- .../methods/landing.landing.markUnDelete.json | 12 +- .../landing.landing.markdeletedblock.json | 6 +- .../landing.landing.markundeletedblock.json | 6 +- .../spec/methods/landing.landing.move.json | 7 +- .../methods/landing.landing.moveblock.json | 10 +- .../methods/landing.landing.publication.json | 5 +- .../landing.landing.removeEntities.json | 21 +- .../landing.landing.resolveIdByPublicUrl.json | 6 +- .../methods/landing.landing.showblock.json | 6 +- .../landing.landing.unFavoriteBlock.json | 5 +- .../methods/landing.landing.unpublic.json | 5 +- .../spec/methods/landing.landing.upblock.json | 6 +- .../spec/methods/landing.landing.update.json | 18 +- .../spec/methods/landing.repo.bind.json | 86 ++++ .../methods/landing.repo.checkContent.json | 6 +- .../spec/methods/landing.repo.getList.json | 20 +- .../spec/methods/landing.repo.register.json | 23 +- .../spec/methods/landing.repo.unregister.json | 5 +- .../methods/landing.repowidget.debug.json | 18 +- .../methods/landing.repowidget.getlist.json | 100 +++- .../methods/landing.repowidget.register.json | 12 +- .../landing.repowidget.unregister.json | 6 +- .../spec/methods/landing.role.enable.json | 5 +- .../spec/methods/landing.role.getList.json | 5 +- .../spec/methods/landing.role.getRights.json | 5 +- .../spec/methods/landing.role.isEnabled.json | 3 +- .../methods/landing.role.setAccessCodes.json | 10 +- .../spec/methods/landing.site.add.json | 11 +- .../spec/methods/landing.site.addFolder.json | 11 +- .../methods/landing.site.bindingToGroup.json | 6 +- .../methods/landing.site.bindingToMenu.json | 6 +- .../spec/methods/landing.site.delete.json | 5 +- .../spec/methods/landing.site.fullExport.json | 12 +- .../spec/methods/landing.site.getFolders.json | 10 +- .../landing.site.getGroupBindings.json | 5 +- .../spec/methods/landing.site.getList.json | 17 +- .../methods/landing.site.getMenuBindings.json | 5 +- .../spec/methods/landing.site.getPreview.json | 5 +- .../spec/methods/landing.site.getRights.json | 5 +- .../landing.site.getadditionalfields.json | 5 +- .../spec/methods/landing.site.markDelete.json | 5 +- .../landing.site.markFolderDelete.json | 5 +- .../landing.site.markFolderUnDelete.json | 5 +- .../methods/landing.site.markUnDelete.json | 5 +- .../methods/landing.site.publication.json | 5 +- .../landing.site.publicationFolder.json | 6 +- .../methods/landing.site.unPublicFolder.json | 5 +- .../landing.site.unbindingFromGroup.json | 6 +- .../landing.site.unbindingFromMenu.json | 6 +- .../spec/methods/landing.site.unpublic.json | 5 +- .../spec/methods/landing.site.update.json | 11 +- .../methods/landing.site.updateFolder.json | 13 +- .../landing.syspage.deleteForLanding.json | 5 +- .../landing.syspage.deleteForSite.json | 5 +- .../spec/methods/landing.syspage.get.json | 6 +- .../spec/methods/landing.syspage.set.json | 7 +- .../landing.template.getLandingRef.json | 5 +- .../methods/landing.template.getSiteRef.json | 5 +- .../methods/landing.template.getlist.json | 23 +- _assets/simulator/spec/methods/lists.add.json | 27 +- _assets/simulator/spec/methods/lists.get.json | 11 +- .../spec/methods/log.blogcomment.add.json | 13 +- .../spec/methods/log.blogcomment.delete.json | 6 +- .../methods/log.blogcomment.user.get.json | 7 +- .../spec/methods/log.blogpost.delete.json | 5 +- .../spec/methods/log.blogpost.get.json | 432 +++++++++++++++++- .../log.blogpost.getusers.important.json | 5 +- .../spec/methods/log.blogpost.share.json | 9 +- .../spec/methods/mail.mailbox.field.get.json | 10 +- .../spec/methods/mail.mailbox.field.list.json | 11 +- .../spec/methods/mail.mailbox.get.json | 11 +- .../spec/methods/mail.mailbox.list.json | 11 +- .../spec/methods/mail.mailbox.senders.json | 9 +- .../mail.message.createcalendarevent.json | 8 +- .../spec/methods/mail.message.createchat.json | 5 +- .../mail.message.createcrmactivity.json | 5 +- .../methods/mail.message.createfeedpost.json | 6 +- .../spec/methods/mail.message.createtask.json | 7 +- .../spec/methods/mail.message.field.get.json | 10 +- .../spec/methods/mail.message.field.list.json | 11 +- .../spec/methods/mail.message.forward.json | 11 +- .../spec/methods/mail.message.get.json | 20 +- .../spec/methods/mail.message.list.json | 12 +- .../methods/mail.message.movetofolder.json | 9 +- .../mail.message.removecrmactivity.json | 5 +- .../spec/methods/mail.message.reply.json | 11 +- .../spec/methods/mail.message.send.json | 10 +- .../spec/methods/mail.message.thread.json | 6 +- .../methods/mail.recipient.field.get.json | 10 +- .../methods/mail.recipient.field.list.json | 11 +- .../methods/mail.recipient.listcontacts.json | 10 +- .../methods/mail.recipient.listemployees.json | 10 +- .../spec/methods/mailservice.add.json | 11 +- .../spec/methods/mailservice.delete.json | 5 +- .../spec/methods/mailservice.get.json | 5 +- .../spec/methods/mailservice.update.json | 12 +- .../spec/methods/main.eventlog.field.get.json | 14 +- .../methods/main.eventlog.field.list.json | 13 +- .../spec/methods/main.eventlog.get.json | 5 +- .../spec/methods/main.eventlog.list.json | 34 +- .../spec/methods/main.eventlog.tail.json | 20 +- .../simulator/spec/methods/method.get.json | 23 +- .../spec/methods/note.collection.add.json | 8 +- .../spec/methods/note.collection.archive.json | 5 +- .../spec/methods/note.collection.delete.json | 5 +- .../methods/note.collection.field.get.json | 10 +- .../methods/note.collection.field.list.json | 11 +- .../spec/methods/note.collection.get.json | 5 +- .../spec/methods/note.collection.list.json | 11 +- .../spec/methods/note.collection.update.json | 8 +- .../spec/methods/note.document.add.json | 10 +- .../spec/methods/note.document.archive.json | 5 +- .../spec/methods/note.document.delete.json | 5 +- .../spec/methods/note.document.field.get.json | 10 +- .../methods/note.document.field.list.json | 11 +- .../spec/methods/note.document.get.json | 5 +- .../note.document.search.field.get.json | 10 +- .../note.document.search.field.list.json | 11 +- .../methods/note.document.search.list.json | 8 +- .../methods/note.document.tree.field.get.json | 10 +- .../note.document.tree.field.list.json | 11 +- .../spec/methods/note.document.tree.list.json | 5 +- .../spec/methods/note.document.update.json | 10 +- .../simulator/spec/methods/note.file.add.json | 7 +- .../spec/methods/note.file.field.get.json | 10 +- .../spec/methods/note.file.field.list.json | 11 +- .../simulator/spec/methods/note.file.get.json | 6 +- .../simulator/spec/methods/placement.get.json | 23 +- .../spec/methods/sale.basketitem.add.json | 104 ++--- .../sale.basketitem.addCatalogProduct.json | 79 ++-- .../spec/methods/sale.basketitem.delete.json | 11 +- .../spec/methods/sale.basketitem.get.json | 16 +- .../methods/sale.basketitem.getFields.json | 39 +- ...le.basketitem.getFieldsCatalogProduct.json | 39 +- .../spec/methods/sale.basketitem.list.json | 47 +- .../spec/methods/sale.basketitem.update.json | 67 ++- .../sale.basketitem.updateCatalogProduct.json | 91 ++-- .../methods/sale.basketproperties.add.json | 14 +- .../methods/sale.basketproperties.delete.json | 7 +- .../methods/sale.basketproperties.get.json | 5 +- .../sale.basketproperties.getFields.json | 5 +- .../methods/sale.basketproperties.list.json | 28 +- .../methods/sale.basketproperties.update.json | 18 +- .../sale.businessValuePersonDomain.add.json | 8 +- ...inessValuePersonDomain.deleteByFilter.json | 8 +- ...e.businessValuePersonDomain.getFields.json | 3 +- .../sale.businessValuePersonDomain.list.json | 13 +- .../spec/methods/sale.cashbox.add.json | 25 +- .../methods/sale.cashbox.check.apply.json | 12 +- .../spec/methods/sale.cashbox.delete.json | 5 +- .../methods/sale.cashbox.handler.delete.json | 5 +- .../methods/sale.cashbox.handler.list.json | 3 +- .../methods/sale.cashbox.handler.update.json | 54 ++- .../spec/methods/sale.cashbox.list.json | 15 +- .../spec/methods/sale.cashbox.update.json | 8 +- .../spec/methods/sale.delivery.add.json | 37 +- .../methods/sale.delivery.config.get.json | 5 +- .../methods/sale.delivery.config.update.json | 31 +- .../spec/methods/sale.delivery.delete.json | 5 +- .../sale.delivery.extra.service.add.json | 23 +- .../sale.delivery.extra.service.delete.json | 5 +- .../sale.delivery.extra.service.get.json | 5 +- .../sale.delivery.extra.service.update.json | 11 +- .../spec/methods/sale.delivery.getlist.json | 24 +- .../methods/sale.delivery.handler.delete.json | 5 +- .../methods/sale.delivery.handler.list.json | 11 +- .../methods/sale.delivery.handler.update.json | 66 ++- .../methods/sale.delivery.request.delete.json | 6 +- .../sale.delivery.request.sendmessage.json | 18 +- .../methods/sale.delivery.request.update.json | 31 +- .../spec/methods/sale.order.add.json | 145 +++--- .../spec/methods/sale.order.delete.json | 11 +- .../spec/methods/sale.order.get.json | 16 +- .../spec/methods/sale.order.getfields.json | 29 +- .../spec/methods/sale.order.list.json | 100 +++- .../spec/methods/sale.order.update.json | 317 +++++++++++-- .../spec/methods/sale.payment.add.json | 42 +- .../spec/methods/sale.payment.delete.json | 5 +- .../spec/methods/sale.payment.get.json | 5 +- .../spec/methods/sale.payment.getFields.json | 3 +- .../spec/methods/sale.payment.list.json | 61 ++- .../spec/methods/sale.payment.update.json | 23 +- .../methods/sale.paymentItemShipment.add.json | 9 +- .../sale.paymentItemShipment.delete.json | 5 +- .../methods/sale.paymentItemShipment.get.json | 5 +- .../sale.paymentItemShipment.getFields.json | 3 +- .../sale.paymentItemShipment.list.json | 18 +- .../sale.paymentItemShipment.update.json | 8 +- .../methods/sale.paymentitembasket.add.json | 10 +- .../sale.paymentitembasket.delete.json | 5 +- .../methods/sale.paymentitembasket.get.json | 5 +- .../sale.paymentitembasket.getfields.json | 3 +- .../methods/sale.paymentitembasket.list.json | 19 +- .../sale.paymentitembasket.update.json | 9 +- .../spec/methods/sale.paysystem.add.json | 27 +- .../spec/methods/sale.paysystem.delete.json | 5 +- .../sale.paysystem.handler.delete.json | 5 +- .../spec/methods/sale.paysystem.list.json | 41 +- .../methods/sale.paysystem.pay.invoice.json | 6 +- .../methods/sale.paysystem.pay.payment.json | 6 +- .../methods/sale.paysystem.settings.get.json | 6 +- .../sale.paysystem.settings.invoice.get.json | 6 +- .../sale.paysystem.settings.payment.get.json | 6 +- .../spec/methods/sale.paysystem.update.json | 14 +- .../spec/methods/sale.persontype.add.json | 11 +- .../spec/methods/sale.persontype.delete.json | 5 +- .../methods/sale.persontype.getFields.json | 3 +- .../spec/methods/sale.persontype.list.json | 15 +- .../spec/methods/sale.persontype.update.json | 8 +- .../spec/methods/sale.property.delete.json | 5 +- .../spec/methods/sale.property.get.json | 5 +- .../sale.property.getfieldsbytype.json | 5 +- .../spec/methods/sale.property.list.json | 41 +- .../methods/sale.propertyRelation.add.json | 9 +- .../sale.propertyRelation.deleteByFilter.json | 9 +- .../sale.propertyRelation.getFields.json | 3 +- .../methods/sale.propertyRelation.list.json | 15 +- .../spec/methods/sale.propertygroup.add.json | 9 +- .../methods/sale.propertygroup.delete.json | 5 +- .../spec/methods/sale.propertygroup.get.json | 5 +- .../methods/sale.propertygroup.getFields.json | 3 +- .../spec/methods/sale.propertygroup.list.json | 17 +- .../methods/sale.propertygroup.update.json | 10 +- .../methods/sale.propertyvalue.delete.json | 5 +- .../spec/methods/sale.propertyvalue.get.json | 5 +- .../methods/sale.propertyvalue.getfields.json | 3 +- .../spec/methods/sale.propertyvalue.list.json | 21 +- .../methods/sale.propertyvalue.modify.json | 47 +- .../methods/sale.propertyvariant.add.json | 11 +- .../methods/sale.propertyvariant.delete.json | 5 +- .../methods/sale.propertyvariant.get.json | 5 +- .../sale.propertyvariant.getFields.json | 3 +- .../methods/sale.propertyvariant.list.json | 17 +- .../methods/sale.propertyvariant.update.json | 11 +- .../spec/methods/sale.shipment.add.json | 18 +- .../spec/methods/sale.shipment.delete.json | 5 +- .../spec/methods/sale.shipment.get.json | 5 +- .../spec/methods/sale.shipment.getFields.json | 3 +- .../spec/methods/sale.shipment.list.json | 61 ++- .../spec/methods/sale.shipment.update.json | 18 +- .../spec/methods/sale.shipmentitem.add.json | 9 +- .../methods/sale.shipmentitem.delete.json | 5 +- .../spec/methods/sale.shipmentitem.get.json | 5 +- .../methods/sale.shipmentitem.getFields.json | 3 +- .../spec/methods/sale.shipmentitem.list.json | 24 +- .../methods/sale.shipmentitem.update.json | 9 +- .../methods/sale.shipmentproperty.delete.json | 5 +- .../methods/sale.shipmentproperty.get.json | 5 +- ...sale.shipmentproperty.getfieldsbytype.json | 5 +- .../methods/sale.shipmentproperty.list.json | 41 +- .../sale.shipmentpropertyvalue.delete.json | 5 +- .../sale.shipmentpropertyvalue.get.json | 5 +- .../sale.shipmentpropertyvalue.getFields.json | 3 +- .../sale.shipmentpropertyvalue.list.json | 21 +- .../sale.shipmentpropertyvalue.modify.json | 19 +- .../spec/methods/sale.status.add.json | 12 +- .../spec/methods/sale.status.delete.json | 5 +- .../spec/methods/sale.status.get.json | 5 +- .../spec/methods/sale.status.getFields.json | 3 +- .../spec/methods/sale.status.list.json | 18 +- .../spec/methods/sale.status.update.json | 12 +- .../spec/methods/sale.statusLang.add.json | 10 +- .../sale.statusLang.deleteByFilter.json | 9 +- .../methods/sale.statusLang.getFields.json | 3 +- .../methods/sale.statusLang.getListLangs.json | 3 +- .../spec/methods/sale.statusLang.list.json | 17 +- .../methods/sale.tradeBinding.getFields.json | 133 ++++++ .../spec/methods/sale.tradeBinding.list.json | 14 +- .../methods/sale.tradePlatform.getFields.json | 3 +- .../spec/methods/sale.tradePlatform.list.json | 15 +- .../salescenter.payment.getPublicUrl.json | 5 +- .../simulator/spec/methods/server.time.json | 65 +++ .../spec/methods/sign.b2e.document.send.json | 7 + .../socialnetwork.api.workgroup.get.json | 11 +- .../socialnetwork.api.workgroup.list.json | 54 ++- .../spec/methods/sonet_group.create.json | 13 +- .../spec/methods/sonet_group.delete.json | 5 +- .../methods/sonet_group.feature.access.json | 7 +- .../spec/methods/sonet_group.get.json | 144 +----- .../spec/methods/sonet_group.setowner.json | 6 +- .../spec/methods/sonet_group.update.json | 6 +- .../spec/methods/sonet_group.user.add.json | 9 +- .../spec/methods/sonet_group.user.delete.json | 9 +- .../spec/methods/sonet_group.user.get.json | 5 +- .../spec/methods/sonet_group.user.groups.json | 3 +- .../methods/sonet_group.user.request.json | 6 +- .../spec/methods/sonet_group.user.update.json | 10 +- .../spec/methods/task.checklistitem.add.json | 17 +- .../methods/task.checklistitem.complete.json | 6 +- .../methods/task.checklistitem.delete.json | 6 +- .../spec/methods/task.checklistitem.get.json | 6 +- .../methods/task.checklistitem.getlist.json | 8 +- .../task.checklistitem.getmanifest.json | 3 +- .../task.checklistitem.isactionallowed.json | 7 +- .../task.checklistitem.moveafteritem.json | 7 +- .../methods/task.checklistitem.renew.json | 6 +- .../methods/task.checklistitem.update.json | 21 +- .../spec/methods/task.commentitem.add.json | 14 +- .../spec/methods/task.commentitem.delete.json | 6 +- .../spec/methods/task.commentitem.get.json | 6 +- .../methods/task.commentitem.getlist.json | 12 +- .../spec/methods/task.commentitem.update.json | 12 +- .../spec/methods/task.dependence.add.json | 7 +- .../spec/methods/task.dependence.delete.json | 6 +- .../spec/methods/task.elapseditem.add.json | 45 +- .../spec/methods/task.elapseditem.delete.json | 24 +- .../spec/methods/task.elapseditem.get.json | 36 +- .../methods/task.elapseditem.getlist.json | 131 +++++- .../methods/task.elapseditem.getmanifest.json | 7 +- .../task.elapseditem.isactionallowed.json | 16 +- .../spec/methods/task.elapseditem.update.json | 40 +- .../spec/methods/task.item.addtofavorite.json | 8 +- .../spec/methods/task.item.approve.json | 5 +- .../spec/methods/task.item.complete.json | 5 +- .../spec/methods/task.item.defer.json | 5 +- .../spec/methods/task.item.delegate.json | 6 +- .../spec/methods/task.item.delete.json | 5 +- .../spec/methods/task.item.deletefile.json | 6 +- .../methods/task.item.deletefromfavorite.json | 8 +- .../spec/methods/task.item.disapprove.json | 5 +- .../methods/task.item.getallowedactions.json | 5 +- ...k.item.getallowedtaskactionsasstrings.json | 5 +- .../spec/methods/task.item.getdata.json | 5 +- .../spec/methods/task.item.getdependson.json | 5 +- .../spec/methods/task.item.list.json | 3 +- .../spec/methods/task.item.userfield.add.json | 21 +- .../methods/task.item.userfield.delete.json | 5 +- .../spec/methods/task.item.userfield.get.json | 5 +- .../methods/task.item.userfield.getlist.json | 7 +- .../methods/task.item.userfield.update.json | 12 +- .../spec/methods/task.items.getlist.json | 3 +- .../spec/methods/task.planner.getlist.json | 3 +- .../spec/methods/task.stages.add.json | 11 +- .../spec/methods/task.stages.canmovetask.json | 6 +- .../spec/methods/task.stages.delete.json | 5 +- .../spec/methods/task.stages.get.json | 5 +- .../spec/methods/task.stages.movetask.json | 8 +- .../methods/tasks.api.scrum.backlog.add.json | 8 +- .../tasks.api.scrum.backlog.delete.json | 5 +- .../methods/tasks.api.scrum.backlog.get.json | 5 +- .../tasks.api.scrum.backlog.getFields.json | 3 +- .../tasks.api.scrum.backlog.update.json | 9 +- .../methods/tasks.api.scrum.epic.add.json | 75 ++- .../methods/tasks.api.scrum.epic.delete.json | 34 +- .../methods/tasks.api.scrum.epic.get.json | 188 ++++---- .../tasks.api.scrum.epic.getFields.json | 128 +++--- .../methods/tasks.api.scrum.epic.list.json | 136 ++---- .../methods/tasks.api.scrum.epic.update.json | 123 ++--- .../tasks.api.scrum.kanban.addStage.json | 35 +- .../tasks.api.scrum.kanban.addTask.json | 25 +- .../tasks.api.scrum.kanban.deleteStage.json | 23 +- .../tasks.api.scrum.kanban.deleteTask.json | 24 +- .../tasks.api.scrum.kanban.getFields.json | 174 +++++++ .../tasks.api.scrum.kanban.getStages.json | 44 +- .../tasks.api.scrum.kanban.updateStage.json | 33 +- .../methods/tasks.api.scrum.sprint.add.json | 147 +++--- .../tasks.api.scrum.sprint.complete.json | 101 +--- .../tasks.api.scrum.sprint.delete.json | 35 +- .../methods/tasks.api.scrum.sprint.get.json | 101 +--- .../tasks.api.scrum.sprint.getFields.json | 139 ++---- .../methods/tasks.api.scrum.sprint.list.json | 176 +++---- .../methods/tasks.api.scrum.sprint.start.json | 101 +--- .../tasks.api.scrum.sprint.update.json | 139 +++--- .../methods/tasks.api.scrum.task.get.json | 61 +-- .../tasks.api.scrum.task.getFields.json | 100 ++-- .../methods/tasks.api.scrum.task.update.json | 67 ++- .../methods/tasks.flow.Flow.activate.json | 5 +- .../spec/methods/tasks.flow.Flow.create.json | 24 +- .../spec/methods/tasks.flow.Flow.get.json | 5 +- .../spec/methods/tasks.flow.Flow.pin.json | 5 +- .../spec/methods/tasks.flow.Flow.update.json | 25 +- .../methods/tasks.task.access.field.get.json | 14 +- .../methods/tasks.task.access.field.list.json | 13 +- .../spec/methods/tasks.task.access.get.json | 5 +- .../spec/methods/tasks.task.add.json | 20 +- .../spec/methods/tasks.task.approve.json | 5 +- .../tasks.task.chat.message.field.get.json | 14 +- .../tasks.task.chat.message.field.list.json | 13 +- .../methods/tasks.task.chat.message.send.json | 8 +- .../spec/methods/tasks.task.complete.json | 5 +- .../spec/methods/tasks.task.counters.get.json | 7 +- .../spec/methods/tasks.task.defer.json | 5 +- .../spec/methods/tasks.task.delegate.json | 6 +- .../spec/methods/tasks.task.delete.json | 5 +- .../spec/methods/tasks.task.disapprove.json | 5 +- .../spec/methods/tasks.task.favorite.add.json | 5 +- .../methods/tasks.task.favorite.remove.json | 5 +- .../spec/methods/tasks.task.field.get.json | 14 +- .../spec/methods/tasks.task.field.list.json | 13 +- .../spec/methods/tasks.task.file.attach.json | 9 +- .../methods/tasks.task.file.field.get.json | 14 +- .../methods/tasks.task.file.field.list.json | 13 +- .../spec/methods/tasks.task.files.attach.json | 6 +- .../methods/tasks.task.gantt.link.list.json | 18 +- .../spec/methods/tasks.task.get.json | 34 +- .../spec/methods/tasks.task.getFields.json | 3 +- .../spec/methods/tasks.task.getaccess.json | 9 +- .../spec/methods/tasks.task.history.list.json | 11 +- .../spec/methods/tasks.task.list.json | 9 +- .../spec/methods/tasks.task.mute.json | 5 +- .../spec/methods/tasks.task.pause.json | 5 +- .../spec/methods/tasks.task.pin.json | 5 +- .../spec/methods/tasks.task.renew.json | 5 +- .../spec/methods/tasks.task.result.add.json | 8 +- .../tasks.task.result.addFromComment.json | 5 +- .../tasks.task.result.addfromchatmessage.json | 7 +- .../methods/tasks.task.result.delete.json | 5 +- .../tasks.task.result.deleteFromComment.json | 5 +- .../spec/methods/tasks.task.result.list.json | 5 +- .../methods/tasks.task.result.update.json | 8 +- .../spec/methods/tasks.task.start.json | 5 +- .../spec/methods/tasks.task.startwatch.json | 5 +- .../spec/methods/tasks.task.stopwatch.json | 5 +- .../spec/methods/tasks.task.unmute.json | 5 +- .../spec/methods/tasks.task.unpin.json | 5 +- .../spec/methods/tasks.task.update.json | 18 +- .../spec/methods/tasks.template.add.json | 29 +- .../methods/tasks.template.checklist.add.json | 17 +- ...late.checklist.addAttachmentByContent.json | 10 +- ...late.checklist.addAttachmentsFromDisk.json | 10 +- .../tasks.template.checklist.complete.json | 6 +- .../tasks.template.checklist.delete.json | 6 +- .../methods/tasks.template.checklist.get.json | 6 +- .../tasks.template.checklist.list.json | 22 +- .../tasks.template.checklist.moveAfter.json | 7 +- .../tasks.template.checklist.moveBefore.json | 7 +- ....template.checklist.removeAttachments.json | 10 +- .../tasks.template.checklist.renew.json | 6 +- .../tasks.template.checklist.update.json | 9 +- .../spec/methods/tasks.template.delete.json | 5 +- .../spec/methods/tasks.template.fields.json | 3 +- .../spec/methods/tasks.template.get.json | 5 +- .../spec/methods/tasks.template.update.json | 16 +- .../telephony.call.attachTranscription.json | 19 +- .../telephony.externalCall.attachRecord.json | 7 +- ...ephony.externalCall.searchCrmEntities.json | 9 +- .../simulator/spec/methods/timeman.close.json | 9 +- .../methods/timeman.networkrange.check.json | 5 +- .../methods/timeman.networkrange.get.json | 3 +- .../simulator/spec/methods/timeman.open.json | 9 +- .../simulator/spec/methods/timeman.pause.json | 5 +- .../methods/timeman.record.field.get.json | 12 +- .../methods/timeman.record.field.list.json | 11 +- .../spec/methods/timeman.record.list.json | 32 +- .../spec/methods/timeman.schedule.get.json | 5 +- .../spec/methods/timeman.settings.json | 5 +- .../spec/methods/timeman.status.json | 5 +- .../timeman.timecontrol.report.add.json | 8 +- .../timeman.timecontrol.reports.get.json | 9 +- ...timeman.timecontrol.reports.users.get.json | 5 +- .../timeman.timecontrol.settings.set.json | 12 +- .../simulator/spec/methods/user.access.json | 24 +- .../simulator/spec/methods/user.admin.json | 65 +++ _assets/simulator/spec/methods/user.get.json | 17 +- .../spec/methods/user.option.get.json | 6 +- .../spec/methods/user.option.set.json | 12 +- .../simulator/spec/methods/user.search.json | 138 ++++-- .../simulator/spec/methods/user.update.json | 7 +- .../spec/methods/user.userfield.delete.json | 5 +- .../spec/methods/user.userfield.list.json | 26 +- .../spec/methods/user.userfield.update.json | 10 +- .../methods/userconsent.agreement.list.json | 3 +- .../methods/userconsent.agreement.text.json | 15 +- .../spec/methods/userconsent.consent.add.json | 10 +- .../spec/methods/userfieldconfig.delete.json | 6 +- .../spec/methods/userfieldconfig.get.json | 6 +- .../methods/userfieldconfig.getTypes.json | 5 +- .../spec/methods/userfieldconfig.update.json | 13 +- .../spec/methods/userfieldtype.add.json | 25 +- .../spec/methods/userfieldtype.delete.json | 2 +- .../spec/methods/userfieldtype.list.json | 93 ++++ .../spec/methods/vote.AttachedVote.vote.json | 2 +- .../methods/voximplant.callback.start.json | 8 +- .../voximplant.infocall.startwithsound.json | 7 +- .../voximplant.infocall.startwithtext.json | 7 +- .../spec/methods/voximplant.line.get.json | 3 +- .../methods/voximplant.line.outgoing.get.json | 3 +- .../methods/voximplant.line.outgoing.set.json | 5 +- .../voximplant.line.outgoing.sip.set.json | 5 +- .../spec/methods/voximplant.sip.add.json | 9 +- .../voximplant.sip.connector.status.json | 3 +- .../spec/methods/voximplant.sip.delete.json | 5 +- .../spec/methods/voximplant.sip.get.json | 13 +- .../spec/methods/voximplant.sip.status.json | 5 +- .../spec/methods/voximplant.sip.update.json | 6 +- .../methods/voximplant.statistic.get.json | 13 +- .../methods/voximplant.tts.voices.get.json | 3 +- .../spec/methods/voximplant.url.get.json | 3 +- .../voximplant.user.activatePhone.json | 5 +- .../voximplant.user.deactivatePhone.json | 57 +++ .../spec/methods/voximplant.user.get.json | 18 +- _assets/simulator/spec/pages.json | 2 +- simulator/generate-spec.js | 134 +++++- 1300 files changed, 17132 insertions(+), 3840 deletions(-) create mode 100644 _assets/simulator/spec/methods/app.info.json create mode 100644 _assets/simulator/spec/methods/biconnector.table.add.json create mode 100644 _assets/simulator/spec/methods/biconnector.table.delete.json create mode 100644 _assets/simulator/spec/methods/biconnector.table.fields.json create mode 100644 _assets/simulator/spec/methods/biconnector.table.fields.update.json create mode 100644 _assets/simulator/spec/methods/biconnector.table.get.json create mode 100644 _assets/simulator/spec/methods/biconnector.table.list.json create mode 100644 _assets/simulator/spec/methods/biconnector.table.update.json create mode 100644 _assets/simulator/spec/methods/crm.automatedsolution.fields.json create mode 100644 _assets/simulator/spec/methods/crm.item.productrow.fields.json create mode 100644 _assets/simulator/spec/methods/crm.timeline.bindings.fields.json create mode 100644 _assets/simulator/spec/methods/landing.block.publication.json create mode 100644 _assets/simulator/spec/methods/landing.repo.bind.json create mode 100644 _assets/simulator/spec/methods/sale.tradeBinding.getFields.json create mode 100644 _assets/simulator/spec/methods/server.time.json create mode 100644 _assets/simulator/spec/methods/tasks.api.scrum.kanban.getFields.json create mode 100644 _assets/simulator/spec/methods/user.admin.json create mode 100644 _assets/simulator/spec/methods/userfieldtype.list.json create mode 100644 _assets/simulator/spec/methods/voximplant.user.deactivatePhone.json diff --git a/_assets/simulator/spec/index.json b/_assets/simulator/spec/index.json index 01e864b93..785ad2bf9 100644 --- a/_assets/simulator/spec/index.json +++ b/_assets/simulator/spec/index.json @@ -1,7 +1,7 @@ { "$v": 1, "generator": "simulator/generate-spec.js", - "count": 1577, + "count": 1596, "methods": [ { "method": "access.name", @@ -10,7 +10,7 @@ "page": "/api-reference/common/system/access-name.html", "executable": false, "deprecated": false, - "title": "Получить названия прав доступа access.name" + "title": "Получить названия кодов доступа access.name" }, { "method": "ai.engine.list", @@ -39,6 +39,15 @@ "deprecated": false, "title": "Удалить сервис ai.engine.unregister" }, + { + "method": "app.info", + "scope": "базовый", + "kind": "write", + "page": "/api-reference/common/system/app-info.html", + "executable": false, + "deprecated": false, + "title": "Показать информацию о приложении app.info" + }, { "method": "app.option.get", "scope": "базовый", @@ -46,7 +55,7 @@ "page": "/api-reference/common/settings/app-option-get.html", "executable": false, "deprecated": false, - "title": "Получить привязанные к приложению данные app.option.get" + "title": "Получить общие настройки приложения app.option.get" }, { "method": "app.option.set", @@ -55,7 +64,7 @@ "page": "/api-reference/common/settings/app-option-set.html", "executable": false, "deprecated": false, - "title": "Привязать данные к приложению app.option.set" + "title": "Сохранить общие настройки приложения app.option.set" }, { "method": "biconnector.connector.add", @@ -109,7 +118,7 @@ "page": "/api-reference/biconnector/connector/biconnector-connector-update.html", "executable": false, "deprecated": false, - "title": "Изменить коннектор biconnector.connector.update" + "title": "Обновить коннектор biconnector.connector.update" }, { "method": "biconnector.dataset.add", @@ -117,7 +126,7 @@ "kind": "write", "page": "/api-reference/biconnector/dataset/biconnector-dataset-add.html", "executable": false, - "deprecated": false, + "deprecated": true, "title": "Создать датасет biconnector.dataset.add" }, { @@ -126,7 +135,7 @@ "kind": "write", "page": "/api-reference/biconnector/dataset/biconnector-dataset-delete.html", "executable": false, - "deprecated": false, + "deprecated": true, "title": "Удалить датасет biconnector.dataset.delete" }, { @@ -135,7 +144,7 @@ "kind": "read", "page": "/api-reference/biconnector/dataset/biconnector-dataset-fields.html", "executable": false, - "deprecated": false, + "deprecated": true, "title": "Получить поля датасета biconnector.dataset.fields" }, { @@ -144,7 +153,7 @@ "kind": "write", "page": "/api-reference/biconnector/dataset/biconnector-dataset-fields-update.html", "executable": false, - "deprecated": false, + "deprecated": true, "title": "Обновить поля датасета biconnector.dataset.fields.update" }, { @@ -153,7 +162,7 @@ "kind": "read", "page": "/api-reference/biconnector/dataset/biconnector-dataset-get.html", "executable": false, - "deprecated": false, + "deprecated": true, "title": "Получить датасет по id biconnector.dataset.get" }, { @@ -162,7 +171,7 @@ "kind": "read", "page": "/api-reference/biconnector/dataset/biconnector-dataset-list.html", "executable": false, - "deprecated": false, + "deprecated": true, "title": "Получить список датасетов biconnector.dataset.list" }, { @@ -171,7 +180,7 @@ "kind": "write", "page": "/api-reference/biconnector/dataset/biconnector-dataset-update.html", "executable": false, - "deprecated": false, + "deprecated": true, "title": "Обновить датасет biconnector.dataset.update" }, { @@ -226,7 +235,70 @@ "page": "/api-reference/biconnector/source/biconnector-source-update.html", "executable": false, "deprecated": false, - "title": "Изменить источник biconnector.source.update" + "title": "Обновить источник biconnector.source.update" + }, + { + "method": "biconnector.table.add", + "scope": "biconnector", + "kind": "write", + "page": "/api-reference/biconnector/table/biconnector-table-add.html", + "executable": false, + "deprecated": false, + "title": "Создать таблицу biconnector.table.add" + }, + { + "method": "biconnector.table.delete", + "scope": "biconnector", + "kind": "write", + "page": "/api-reference/biconnector/table/biconnector-table-delete.html", + "executable": false, + "deprecated": false, + "title": "Удалить таблицу biconnector.table.delete" + }, + { + "method": "biconnector.table.fields", + "scope": "biconnector", + "kind": "read", + "page": "/api-reference/biconnector/table/biconnector-table-fields.html", + "executable": false, + "deprecated": false, + "title": "Получить поля таблицы biconnector.table.fields" + }, + { + "method": "biconnector.table.fields.update", + "scope": "biconnector", + "kind": "write", + "page": "/api-reference/biconnector/table/biconnector-table-fields-update.html", + "executable": false, + "deprecated": false, + "title": "Обновить колонки таблицы biconnector.table.fields.update" + }, + { + "method": "biconnector.table.get", + "scope": "biconnector", + "kind": "read", + "page": "/api-reference/biconnector/table/biconnector-table-get.html", + "executable": false, + "deprecated": false, + "title": "Получить таблицу по id biconnector.table.get" + }, + { + "method": "biconnector.table.list", + "scope": "biconnector", + "kind": "read", + "page": "/api-reference/biconnector/table/biconnector-table-list.html", + "executable": false, + "deprecated": false, + "title": "Получить список таблиц biconnector.table.list" + }, + { + "method": "biconnector.table.update", + "scope": "biconnector", + "kind": "write", + "page": "/api-reference/biconnector/table/biconnector-table-update.html", + "executable": false, + "deprecated": false, + "title": "Обновить таблицу biconnector.table.update" }, { "method": "bizproc.activity.add", @@ -667,7 +739,7 @@ "page": "/api-reference/booking/waitlist/client/booking-v1-waitlist-client-list.html", "executable": false, "deprecated": false, - "title": "Получить список клиентов записи в лист ожидания booking.v1.waitlist.client.list" + "title": "Получить клиентов записи в листе ожидания booking.v1.waitlist.client.list" }, { "method": "booking.v1.waitlist.client.set", @@ -676,7 +748,7 @@ "page": "/api-reference/booking/waitlist/client/booking-v1-waitlist-client-set.html", "executable": false, "deprecated": false, - "title": "Добавить клиентов к записи в лист ожидания booking.v1.waitlist.client.set" + "title": "Установить клиентов записи в листе ожидания booking.v1.waitlist.client.set" }, { "method": "booking.v1.waitlist.client.unset", @@ -685,7 +757,7 @@ "page": "/api-reference/booking/waitlist/client/booking-v1-waitlist-client-unset.html", "executable": false, "deprecated": false, - "title": "Удалить клиентов из записи в лист ожидания booking.v1.waitlist.client.unset" + "title": "Удалить связи с клиентами записи в листе ожидания booking.v1.waitlist.client.unset" }, { "method": "booking.v1.waitlist.createfrombooking", @@ -1405,7 +1477,7 @@ "page": "/api-reference/catalog/price-type/price-type-group/catalog-price-type-group-delete.html", "executable": false, "deprecated": false, - "title": "Удалить привязку типа цен к группе покупателей catalog.priceTypeGroup.delete" + "title": "Удалить привязку типа цены к группе покупателей catalog.priceTypeGroup.delete" }, { "method": "catalog.priceTypeGroup.getFields", @@ -2314,7 +2386,7 @@ "page": "/api-reference/crm/timeline/activities/configurable/crm-activity-configurable-get.html", "executable": false, "deprecated": false, - "title": "Получить конфигурируемое дело по id crm.activity.configurable.get" + "title": "Получить конфигурируемое дело crm.activity.configurable.get" }, { "method": "crm.activity.configurable.update", @@ -2359,7 +2431,7 @@ "page": "/api-reference/crm/timeline/activities/layout-blocks/crm-activity-layout-blocks-delete.html", "executable": false, "deprecated": false, - "title": "Удалить набор дополнительных контентных блоков в деле crm.activity.layout.blocks.delete" + "title": "Удалить набор дополнительных контентных блоков из дела crm.activity.layout.blocks.delete" }, { "method": "crm.activity.layout.blocks.get", @@ -2368,7 +2440,7 @@ "page": "/api-reference/crm/timeline/activities/layout-blocks/crm-activity-layout-blocks-get.html", "executable": false, "deprecated": false, - "title": "Получить набор дополнительных контентных блоков в деле crm.activity.layout.blocks.get" + "title": "Получить набор дополнительных контентных блоков дела crm.activity.layout.blocks.get" }, { "method": "crm.activity.layout.blocks.set", @@ -2532,6 +2604,15 @@ "deprecated": false, "title": "Удалить цифровое рабочее место crm.automatedsolution.delete" }, + { + "method": "crm.automatedsolution.fields", + "scope": "crm", + "kind": "read", + "page": "/api-reference/crm/automated-solution/crm-automated-solution-fields.html", + "executable": false, + "deprecated": false, + "title": "Получить поля цифрового рабочего места crm.automatedsolution.fields" + }, { "method": "crm.automatedsolution.get", "scope": "crm", @@ -4224,6 +4305,15 @@ "deprecated": false, "title": "Удалить товарную позицию из объекта CRM crm.item.productrow.delete" }, + { + "method": "crm.item.productrow.fields", + "scope": "crm", + "kind": "read", + "page": "/api-reference/crm/universal/product-rows/crm-item-productrow-fields.html", + "executable": false, + "deprecated": false, + "title": "Получить список полей товарных позиций crm.item.productrow.fields" + }, { "method": "crm.item.productrow.get", "scope": "crm", @@ -4258,7 +4348,7 @@ "page": "/api-reference/crm/universal/product-rows/crm-item-productrow-set.html", "executable": false, "deprecated": false, - "title": "Сохранить товарную позицию объекта CRM crm.item.productrow.set" + "title": "Сохранить товарные позиции объекта CRM crm.item.productrow.set" }, { "method": "crm.item.productrow.update", @@ -5223,6 +5313,15 @@ "deprecated": false, "title": "Добавить связь записи таймлайна с элементом CRM crm.timeline.bindings.bind" }, + { + "method": "crm.timeline.bindings.fields", + "scope": "crm", + "kind": "read", + "page": "/api-reference/crm/timeline/bindings/crm-timeline-bindings-fields.html", + "executable": false, + "deprecated": false, + "title": "Получить поля связи записи таймлайна с элементом CRM crm.timeline.bindings.fields" + }, { "method": "crm.timeline.bindings.list", "scope": "crm", @@ -5230,7 +5329,7 @@ "page": "/api-reference/crm/timeline/bindings/crm-timeline-bindings-list.html", "executable": false, "deprecated": false, - "title": "Получить список связей записи в таймлайне crm.timeline.bindings.list" + "title": "Получить список связей записи таймлайна с элементами CRM crm.timeline.bindings.list" }, { "method": "crm.timeline.bindings.unbind", @@ -6463,7 +6562,7 @@ "page": "/api-reference/common/system/feature-get.html", "executable": false, "deprecated": false, - "title": "Получить информацию о доступности функционала в Битрикс24 feature.get" + "title": "Получить информацию о доступности возможности в Битрикс24 feature.get" }, { "method": "humanresources.employee.count", @@ -7849,7 +7948,7 @@ "page": "/api-reference/chat-bots/chat-bots-v2/imbot.v2/chats/chat-user-list.html", "executable": false, "deprecated": false, - "title": "Список участников чата imbot.v2.Chat.User.list" + "title": "Получить список участников чата imbot.v2.Chat.User.list" }, { "method": "imbot.v2.Command.answer", @@ -7943,7 +8042,7 @@ }, { "method": "imconnector.chat.name.set", - "scope": "imconnector", + "scope": "imopenlines", "kind": "write", "page": "/api-reference/imopenlines/imconnector/imconnector-chat-name-set.html", "executable": false, @@ -8011,7 +8110,7 @@ "page": "/api-reference/imopenlines/imconnector/imconnector-send-status-reading.html", "executable": false, "deprecated": false, - "title": "Обновить статус «прочитано» imconnector.send.status.reading" + "title": "Передать статус «прочитано» imconnector.send.status.reading" }, { "method": "imconnector.status", @@ -8535,6 +8634,15 @@ "deprecated": false, "title": "Получить список блоков из репозитория landing.block.getrepository" }, + { + "method": "landing.block.publication", + "scope": "landing", + "kind": "write", + "page": "/api-reference/landing/block/methods/landing-block-publication.html", + "executable": false, + "deprecated": false, + "title": "Опубликовать блок landing.block.publication" + }, { "method": "landing.block.removecard", "scope": "landing", @@ -8895,6 +9003,15 @@ "deprecated": false, "title": "Изменить страницу landing.landing.update" }, + { + "method": "landing.repo.bind", + "scope": "landing", + "kind": "write", + "page": "/api-reference/landing/embedding/landing-repo-bind.html", + "executable": false, + "deprecated": false, + "title": "Зарегистрировать место встраивания landing.repo.bind" + }, { "method": "landing.repo.checkContent", "scope": "landing", @@ -8947,7 +9064,7 @@ "page": "/api-reference/vibe/landing-repowidget-debug.html", "executable": false, "deprecated": false, - "title": "Включить режим отладки landing.repowidget.debug" + "title": "Включить или выключить режим отладки landing.repowidget.debug" }, { "method": "landing.repowidget.getlist", @@ -8965,7 +9082,7 @@ "page": "/api-reference/vibe/landing-repowidget-register.html", "executable": false, "deprecated": false, - "title": "Добавить виджет на Вайб landing.repowidget.register" + "title": "Добавить виджет для Вайба landing.repowidget.register" }, { "method": "landing.repowidget.unregister", @@ -9982,7 +10099,7 @@ "page": "/api-reference/common/system/method-get.html", "executable": false, "deprecated": false, - "title": "Получить список доступных методов method.get" + "title": "Проверить доступность метода method.get" }, { "method": "note.collection.add", @@ -10211,7 +10328,7 @@ }, { "method": "placement.get", - "scope": null, + "scope": "placement", "kind": "read", "page": "/api-reference/widgets/placement-get.html", "executable": false, @@ -10477,7 +10594,7 @@ "page": "/api-reference/sale/basket-item/sale-basket-item-add.html", "executable": false, "deprecated": false, - "title": "Добавить элемент (позицию) в корзину существующего заказа sale.basketitem.add" + "title": "Добавить произвольную позицию в корзину заказа sale.basketitem.add" }, { "method": "sale.basketitem.addCatalogProduct", @@ -10486,7 +10603,7 @@ "page": "/api-reference/sale/basket-item/sale-basket-item-add-catalog-product.html", "executable": false, "deprecated": false, - "title": "Добавить позицию с товаром или услугой из модуля catalog в корзину существующего заказа sale.basketitem.addCatalogProduct" + "title": "Добавить позицию с товаром из каталога в корзину заказа sale.basketitem.addCatalogProduct" }, { "method": "sale.basketitem.delete", @@ -10495,7 +10612,7 @@ "page": "/api-reference/sale/basket-item/sale-basket-item-delete.html", "executable": false, "deprecated": false, - "title": "Удалить элемент (позицию) корзины из заказа sale.basketitem.delete" + "title": "Удалить позицию из корзины заказа sale.basketitem.delete" }, { "method": "sale.basketitem.get", @@ -10504,7 +10621,7 @@ "page": "/api-reference/sale/basket-item/sale-basket-item-get.html", "executable": false, "deprecated": false, - "title": "Получить информацию об элементе (позиции) корзины заказа sale.basketitem.get" + "title": "Получить позицию корзины sale.basketitem.get" }, { "method": "sale.basketitem.getFields", @@ -10513,7 +10630,7 @@ "page": "/api-reference/sale/basket-item/sale-basket-item-get-fields.html", "executable": false, "deprecated": false, - "title": "Получить доступные поля элемента (позиции) корзины sale.basketitem.getFields" + "title": "Получить поля позиции корзины sale.basketitem.getFields" }, { "method": "sale.basketitem.getFieldsCatalogProduct", @@ -10522,7 +10639,7 @@ "page": "/api-reference/sale/basket-item/sale-basket-item-get-catalog-product-fields.html", "executable": false, "deprecated": false, - "title": "Получить доступные поля элемента корзины (товар из каталога) sale.basketitem.getFieldsCatalogProduct" + "title": "Получить поля позиции с товаром из каталога sale.basketitem.getFieldsCatalogProduct" }, { "method": "sale.basketitem.list", @@ -10531,7 +10648,7 @@ "page": "/api-reference/sale/basket-item/sale-basket-item-list.html", "executable": false, "deprecated": false, - "title": "Получить список элементов (позиций) корзины sale.basketitem.list" + "title": "Получить список позиций корзины sale.basketitem.list" }, { "method": "sale.basketitem.update", @@ -10540,7 +10657,7 @@ "page": "/api-reference/sale/basket-item/sale-basket-item-update.html", "executable": false, "deprecated": false, - "title": "Изменить позицию корзины существующего заказа sale.basketitem.update" + "title": "Изменить позицию корзины заказа sale.basketitem.update" }, { "method": "sale.basketitem.updateCatalogProduct", @@ -10549,7 +10666,7 @@ "page": "/api-reference/sale/basket-item/sale-basket-item-update-catalog-product.html", "executable": false, "deprecated": false, - "title": "Изменить позицию корзины (товар из каталога) существующего заказа sale.basketitem.updateCatalogProduct" + "title": "Изменить позицию с товаром из каталога sale.basketitem.updateCatalogProduct" }, { "method": "sale.basketproperties.add", @@ -10891,7 +11008,7 @@ "page": "/api-reference/sale/order/sale-order-delete.html", "executable": false, "deprecated": false, - "title": "Удалить заказ и связанные объекты sale.order.delete" + "title": "Удалить заказ sale.order.delete" }, { "method": "sale.order.get", @@ -10903,13 +11020,13 @@ "title": "Получить значения полей заказа и связанных объектов sale.order.get" }, { - "method": "sale.order.getfields", + "method": "sale.order.getFields", "scope": "sale", "kind": "read", "page": "/api-reference/sale/order/sale-order-get-fields.html", "executable": false, "deprecated": false, - "title": "Получить поля заказа sale.order.getfields" + "title": "Получить поля заказа sale.order.getFields" }, { "method": "sale.order.list", @@ -11811,6 +11928,15 @@ "deprecated": false, "title": "Получить список локализаций статусов sale.statusLang.list" }, + { + "method": "sale.tradeBinding.getFields", + "scope": "sale", + "kind": "read", + "page": "/api-reference/sale/trade-binding/sale-trade-binding-get-fields.html", + "executable": false, + "deprecated": false, + "title": "Получить доступные поля заказов из источников sale.tradeBinding.getFields" + }, { "method": "sale.tradeBinding.list", "scope": "sale", @@ -11847,6 +11973,15 @@ "deprecated": false, "title": "Сгенерировать ссылку на определенную оплату salescenter.payment.getPublicUrl" }, + { + "method": "server.time", + "scope": "базовый", + "kind": "write", + "page": "/api-reference/common/system/server-time.html", + "executable": false, + "deprecated": false, + "title": "Получить текущее время сервера server.time" + }, { "method": "sign.b2e.company.provider.list", "scope": "sign.b2e", @@ -12738,6 +12873,15 @@ "deprecated": false, "title": "Удалить задачу из канбана Скрама tasks.api.scrum.kanban.deleteTask" }, + { + "method": "tasks.api.scrum.kanban.getFields", + "scope": "task", + "kind": "read", + "page": "/api-reference/sonet-group/scrum/kanban/tasks-api-scrum-kanban-get-fields.html", + "executable": false, + "deprecated": false, + "title": "Получить список доступных полей стадии канбана tasks.api.scrum.kanban.getFields" + }, { "method": "tasks.api.scrum.kanban.getStages", "scope": "task", @@ -12790,7 +12934,7 @@ "page": "/api-reference/sonet-group/scrum/sprint/tasks-api-scrum-sprint-get.html", "executable": false, "deprecated": false, - "title": "Получить поля спринта по его идентификатору tasks.api.scrum.sprint.get" + "title": "Получить спринт по идентификатору tasks.api.scrum.sprint.get" }, { "method": "tasks.api.scrum.sprint.getFields", @@ -12835,7 +12979,7 @@ "page": "/api-reference/sonet-group/scrum/task/tasks-api-scrum-task-get.html", "executable": false, "deprecated": false, - "title": "Получить поля задачи Скрама по id tasks.api.scrum.task.get" + "title": "Получить поля задачи Скрама по идентификатору tasks.api.scrum.task.get" }, { "method": "tasks.api.scrum.task.getFields", @@ -13744,7 +13888,7 @@ "page": "/api-reference/common/users/user-access.html", "executable": false, "deprecated": false, - "title": "Определить набор прав пользователя user.access" + "title": "Проверить коды доступа пользователя user.access" }, { "method": "user.add", @@ -13755,6 +13899,15 @@ "deprecated": false, "title": "Пригласить пользователя user.add" }, + { + "method": "user.admin", + "scope": "базовый", + "kind": "write", + "page": "/api-reference/common/users/user-admin.html", + "executable": false, + "deprecated": false, + "title": "Проверить права администратора user.admin" + }, { "method": "user.get", "scope": "user", @@ -13771,7 +13924,7 @@ "page": "/api-reference/common/settings/user-option-get.html", "executable": false, "deprecated": false, - "title": "Получить пользовательские данные, привязанные к приложению user.option.get" + "title": "Получить настройки пользователя user.option.get" }, { "method": "user.option.set", @@ -13780,7 +13933,7 @@ "page": "/api-reference/common/settings/user-option-set.html", "executable": false, "deprecated": false, - "title": "Привязать данные к пользователю и приложению user.option.set" + "title": "Сохранить настройки пользователя user.option.set" }, { "method": "user.search", @@ -13935,6 +14088,15 @@ "deprecated": false, "title": "Удалить зарегистрированный тип пользовательских полей userfieldtype.delete" }, + { + "method": "userfieldtype.list", + "scope": "placement", + "kind": "read", + "page": "/api-reference/widgets/user-field/userfieldtype-list.html", + "executable": false, + "deprecated": false, + "title": "Получить список зарегистрированных типов пользовательских полей userfieldtype.list" + }, { "method": "userfieldtype.update", "scope": "placement", @@ -14187,6 +14349,15 @@ "deprecated": false, "title": "Активировать SIP-аппарат пользователя voximplant.user.activatePhone" }, + { + "method": "voximplant.user.deactivatePhone", + "scope": "telephony", + "kind": "write", + "page": "/api-reference/telephony/voximplant/users/voximplant-user-deactivate-phone.html", + "executable": false, + "deprecated": false, + "title": "Деактивировать SIP-аппарат пользователя voximplant.user.deactivatePhone" + }, { "method": "voximplant.user.get", "scope": "telephony", diff --git a/_assets/simulator/spec/methods/access.name.json b/_assets/simulator/spec/methods/access.name.json index c04e20399..4afd20572 100644 --- a/_assets/simulator/spec/methods/access.name.json +++ b/_assets/simulator/spec/methods/access.name.json @@ -3,15 +3,15 @@ "method": "access.name", "scope": "базовый", "kind": "write", - "title": "Получить названия прав доступа access.name", + "title": "Получить названия кодов доступа access.name", "permissions": "любой пользователь", "params": [ { "name": "ACCESS", - "type": "array", + "type": "string[]", "base": "array", - "required": true, - "description": "Список кодов доступа, названия для которых нужно получить. Форматы кодов: - U — пользователь, например U1 - G — группа пользователей, например G2 - AU — все авторизованные пользователи Если параметр не передан или пуст, метод вернет false", + "required": "unknown", + "description": "Список кодов доступа, названия для которых нужно получить, например [\"U1\", \"D107\"]. Основные форматы кодов: - U — пользователь, например U1 - IU — пользователь и его руководители, например IU1 - G — группа пользователей, например G1 - D — все сотрудники отдела, например D107 - DR — все сотрудники отдела и его подотделов, например DR107 - SG_A, SG_E, SG_K — владелец,…", "dynamic": { "allowed": true, "note": "Состав полей не описан подтаблицей на этой странице" @@ -19,7 +19,7 @@ } ], "defs": {}, - "requiredConvention": true, + "requiredConvention": false, "confidence": "parsed", "source": { "file": "api-reference/common/system/access-name.md" @@ -52,17 +52,23 @@ "name": "result", "type": "object", "base": "object", - "required": false, - "description": "Объект, где ключ это код доступа из параметра ACCESS, а значение это описание кода. Структура описана ниже. Если параметр ACCESS не передан или пуст, метод вернет false" + "required": "unknown", + "description": "Объект: ключ — код доступа из параметра ACCESS, значение — описание кода (подробное описание). Если ни одного из переданных кодов нет в Битрикс24, метод вернет пустой массив []. Если параметр ACCESS не передан, пуст или передан строкой, метод вернет false" }, { "name": "time", "type": "time", "base": "object", - "required": false, + "required": "unknown", "description": "Информация о времени выполнения запроса" } ], "page": "/api-reference/common/system/access-name.html", - "executable": false + "executable": false, + "requestExample": { + "ACCESS": [ + "G2", + "AU" + ] + } } diff --git a/_assets/simulator/spec/methods/ai.engine.list.json b/_assets/simulator/spec/methods/ai.engine.list.json index b172610b1..24cf5435c 100644 --- a/_assets/simulator/spec/methods/ai.engine.list.json +++ b/_assets/simulator/spec/methods/ai.engine.list.json @@ -8,10 +8,10 @@ "params": [ { "name": "filter", - "type": "array", - "base": "array", + "type": "object", + "base": "object", "required": false, - "description": "Массив формата: где: - field_n — название поля, по которому будет произведена фильтрация - value_n — значение фильтра К ключам field_n можно добавить префикс, уточняющий работу фильтра. Возможные значения префикса: - >= — больше либо равно - > — больше - <= — меньше либо равно - < — меньше - @ — IN, в качестве значения передается массив - !@ — NOT IN, в качестве значения передается массив - % — LI…", + "description": "Объект с условиями фильтрации. Ключ — название поля с необязательным префиксом оператора, значение — искомое значение. Например: Если параметр не передан, метод возвращает записи без дополнительной фильтрации.…", "ref": "#/defs/filterFields" }, { @@ -19,7 +19,7 @@ "type": "integer", "base": "integer", "required": false, - "description": "Максимальное количество элементов в ответе" + "description": "Максимальное количество элементов в ответе. Если параметр не передан, метод возвращает все найденные записи" } ], "defs": { @@ -63,7 +63,33 @@ "type": "string", "base": "string", "required": false, - "description": "Категория сервиса" + "description": "Категория сервиса. Возможные значения: - text — текстовые запросы - image — генерация изображений - audio — обработка аудио - call — обработка аудиозаписей звонков - vision — анализ изображений - classify — классификация данных", + "values": [ + { + "value": "text", + "title": "текстовые запросы" + }, + { + "value": "image", + "title": "генерация изображений" + }, + { + "value": "audio", + "title": "обработка аудио" + }, + { + "value": "call", + "title": "обработка аудиозаписей звонков" + }, + { + "value": "vision", + "title": "анализ изображений" + }, + { + "value": "classify", + "title": "классификация данных" + } + ] }, { "name": "COMPLETIONS_URL", diff --git a/_assets/simulator/spec/methods/ai.engine.register.json b/_assets/simulator/spec/methods/ai.engine.register.json index 3e9148c79..d36c66058 100644 --- a/_assets/simulator/spec/methods/ai.engine.register.json +++ b/_assets/simulator/spec/methods/ai.engine.register.json @@ -25,7 +25,33 @@ "type": "string", "base": "string", "required": true, - "description": "Категория сервиса. Возможные значения: - text - image - audio - call" + "description": "Категория сервиса. Возможные значения: - text — текстовые запросы - image — генерация изображений - audio — обработка аудио - call — обработка аудиозаписей звонков - vision — анализ изображений - classify — классификация данных", + "values": [ + { + "value": "text", + "title": "текстовые запросы" + }, + { + "value": "image", + "title": "генерация изображений" + }, + { + "value": "audio", + "title": "обработка аудио" + }, + { + "value": "call", + "title": "обработка аудиозаписей звонков" + }, + { + "value": "vision", + "title": "анализ изображений" + }, + { + "value": "classify", + "title": "классификация данных" + } + ] }, { "name": "completions_url", @@ -39,7 +65,7 @@ "type": "object", "base": "object", "required": false, - "description": "Дополнительные настройки сервиса (подробное описание)", + "description": "Дополнительные настройки сервиса (подробное описание). Если параметр не передан, сохраняется пустой набор настроек", "ref": "#/defs/settingsFields" } ], @@ -63,7 +89,17 @@ "type": "string", "base": "string", "required": false, - "description": "Способ подсчета контекста. Возможные значения: - token - symbol По умолчанию используется token" + "description": "Способ подсчета контекста. Возможные значения: - token — подсчет по токенам - symbol — подсчет по символам По умолчанию используется token", + "values": [ + { + "value": "token", + "title": "подсчет по токенам" + }, + { + "value": "symbol", + "title": "подсчет по символам По умолчанию используется token" + } + ] }, { "name": "model_context_limit", @@ -110,5 +146,16 @@ } ], "page": "/api-reference/ai/ai-engine-register.html", - "executable": false + "executable": false, + "requestExample": { + "name": "Acme GPT", + "code": "acme_gpt", + "category": "text", + "completions_url": "https://api.example.com/bitrix24/ai/completions", + "settings": { + "code_alias": "ChatGPT", + "model_context_type": "token", + "model_context_limit": 15666 + } + } } diff --git a/_assets/simulator/spec/methods/ai.engine.unregister.json b/_assets/simulator/spec/methods/ai.engine.unregister.json index 2c1738765..a9a26107b 100644 --- a/_assets/simulator/spec/methods/ai.engine.unregister.json +++ b/_assets/simulator/spec/methods/ai.engine.unregister.json @@ -10,8 +10,8 @@ "name": "code", "type": "string", "base": "string", - "required": false, - "description": "Символьный код удаляемого сервиса" + "required": true, + "description": "Символьный код удаляемого сервиса. Код должен совпадать с кодом сервиса, зарегистрированного текущим приложением или без привязки к приложению при вызове через вебхук" } ], "defs": {}, @@ -39,7 +39,7 @@ "type": "boolean", "base": "boolean", "required": false, - "description": "Результат удаления сервиса: - true — сервис удален - false — сервис не найден, не принадлежит текущему приложению или удаление не выполнено" + "description": "Результат удаления сервиса: - true — сервис удален - false — сервис не найден, не принадлежит текущему приложению, параметр code не передан или удаление не выполнено" }, { "name": "time", @@ -50,5 +50,8 @@ } ], "page": "/api-reference/ai/ai-engine-unregister.html", - "executable": false + "executable": false, + "requestExample": { + "code": "acme_gpt" + } } diff --git a/_assets/simulator/spec/methods/app.info.json b/_assets/simulator/spec/methods/app.info.json new file mode 100644 index 000000000..b926ce68d --- /dev/null +++ b/_assets/simulator/spec/methods/app.info.json @@ -0,0 +1,81 @@ +{ + "$v": 1, + "method": "app.info", + "scope": "базовый", + "kind": "write", + "title": "Показать информацию о приложении app.info", + "permissions": "любой пользователь", + "params": [ + { + "name": "result", + "type": "object", + "base": "object", + "required": "unknown", + "description": "Информация о приложении (подробное описание)", + "dynamic": { + "allowed": true, + "note": "Состав полей не описан подтаблицей на этой странице" + } + }, + { + "name": "time", + "type": "time", + "base": "object", + "required": "unknown", + "description": "Информация о времени выполнения запроса", + "dynamic": { + "allowed": true, + "note": "Состав полей не описан подтаблицей на этой странице" + } + } + ], + "defs": {}, + "requiredConvention": false, + "confidence": "parsed", + "source": { + "file": "api-reference/common/system/app-info.md" + }, + "resultExample": { + "result": { + "ID": 5, + "CODE": "telefum24.kp10", + "VERSION": 4, + "STATUS": "F", + "INSTALLED": true, + "PAYMENT_EXPIRED": "N", + "DAYS": null, + "LANGUAGE_ID": "ru", + "LICENSE": "ru_ent10000", + "LICENSE_TYPE": "ent10000", + "LICENSE_FAMILY": "ent" + }, + "time": { + "start": 1722841503.0585, + "finish": 1722841503.09885, + "duration": 0.0403509140014648, + "processing": 0.00533103942871094, + "date_start": "2024-08-05T07:05:03+00:00", + "date_finish": "2024-08-05T07:05:03+00:00", + "operating": 0 + } + }, + "returns": [ + { + "name": "result", + "type": "object", + "base": "object", + "required": "unknown", + "description": "Информация о приложении (подробное описание)" + }, + { + "name": "time", + "type": "time", + "base": "object", + "required": "unknown", + "description": "Информация о времени выполнения запроса" + } + ], + "page": "/api-reference/common/system/app-info.html", + "executable": false, + "requestExample": {} +} diff --git a/_assets/simulator/spec/methods/app.option.get.json b/_assets/simulator/spec/methods/app.option.get.json index 9395ca9ad..8f3a496ea 100644 --- a/_assets/simulator/spec/methods/app.option.get.json +++ b/_assets/simulator/spec/methods/app.option.get.json @@ -3,8 +3,8 @@ "method": "app.option.get", "scope": "базовый", "kind": "read", - "title": "Получить привязанные к приложению данные app.option.get", - "permissions": "любой пользователь", + "title": "Получить общие настройки приложения app.option.get", + "permissions": "любой авторизованный пользователь в контексте приложения", "params": [ { "name": "option", @@ -41,7 +41,7 @@ "type": "object", "base": "object", "required": false, - "description": "Зависит от параметра option: - параметр не передан — объект, где ключ это название настройки, а значение это сохраненное значение. Если настроек нет, объект пустой - параметр передан — сохраненное значение ключа - параметр передан, но такого ключа нет — null" + "description": "Зависит от параметра option: - параметр не передан — объект, где ключ — название настройки, значение — сохраненное значение. Если настроек нет, возвращается пустой массив [] - параметр передан — сохраненное значение ключа: строка, целое или дробное число, логическое значение, массив или объект - параметр передан, но такого ключа нет — null Значение возвращается в том виде, в каком его сохранил app…" }, { "name": "time", diff --git a/_assets/simulator/spec/methods/app.option.set.json b/_assets/simulator/spec/methods/app.option.set.json index e8f80479f..11b92ceb8 100644 --- a/_assets/simulator/spec/methods/app.option.set.json +++ b/_assets/simulator/spec/methods/app.option.set.json @@ -3,15 +3,15 @@ "method": "app.option.set", "scope": "базовый", "kind": "write", - "title": "Привязать данные к приложению app.option.set", - "permissions": "администратор", + "title": "Сохранить общие настройки приложения app.option.set", + "permissions": "администратор Битрикс24 в контексте приложения", "params": [ { "name": "options", - "type": "array", - "base": "array", - "required": true, - "description": "Массив, где ключ — название сохраняемого свойства, а значение — значение свойства. Если передать значение с новым ключом, то метод его запишет, а если существующее — обновит", + "type": "object", + "base": "object", + "required": false, + "description": "Объект настроек: ключ — название настройки, значение — ее значение. Передавайте options объектом. Не используйте ключи next и total: при чтении всех настроек REST API вернет их не в result, а в корне ответа. Перезаписываются только переданные ключи, остальные сохраненные настройки не меняются.…", "dynamic": { "allowed": true, "note": "Состав полей не описан подтаблицей на этой странице" diff --git a/_assets/simulator/spec/methods/biconnector.connector.add.json b/_assets/simulator/spec/methods/biconnector.connector.add.json index 055d7fffb..387e5f712 100644 --- a/_assets/simulator/spec/methods/biconnector.connector.add.json +++ b/_assets/simulator/spec/methods/biconnector.connector.add.json @@ -4,7 +4,7 @@ "scope": "biconnector", "kind": "write", "title": "Создать коннектор biconnector.connector.add", - "permissions": "пользователь с доступом к разделу «Рабочее место аналитика»", + "permissions": "пользователь с правами «Доступ к BI Конструктору» и «Доступ к рабочему месту аналитика» одновременно", "params": [ { "name": "fields", @@ -28,7 +28,7 @@ "type": "string", "base": "string", "required": true, - "description": "Название коннектора" + "description": "Название коннектора, максимальная длина — 512 символов" }, { "name": "logo", @@ -49,42 +49,56 @@ "type": "string", "base": "string", "required": true, - "description": "Эндпоинт коннектора для проверки доступности, (подробное описание)" + "description": "Эндпоинт коннектора для проверки доступности, максимальная длина — 2048 символов, (подробное описание)" }, { "name": "urlTableList", "type": "string", "base": "string", "required": true, - "description": "Эндпоинт коннектора для получения списка таблиц, (подробное описание)" + "description": "Эндпоинт коннектора для получения списка таблиц, максимальная длина — 2048 символов, (подробное описание)" }, { "name": "urlTableDescription", "type": "string", "base": "string", "required": true, - "description": "Эндпоинт коннектора для получения описания конкретной таблицы, (подробное описание)" + "description": "Эндпоинт коннектора для получения описания конкретной таблицы, максимальная длина — 2048 символов, (подробное описание)" }, { "name": "urlData", "type": "string", "base": "string", "required": true, - "description": "Эндпоинт коннектора для получения данных по выбранной таблице, (подробное описание)" + "description": "Эндпоинт коннектора для получения данных по выбранной таблице, максимальная длина — 2048 символов, (подробное описание)" }, { "name": "settings", "type": "array", "base": "array", "required": true, - "description": "Список параметров подключения, (подробное описание)" + "description": "Массив параметров подключения: коды и названия полей, значения которых пользователь заполнит при создании источника (подробное описание)" + }, + { + "name": "supportMapping", + "type": "boolean", + "base": "boolean", + "required": false, + "description": "Поддержка сопоставления полей таблицы с полями внешней системы. Значение по умолчанию — false. Значение проверяется строгим сравнением с булевым типом, поэтому в запросе с типом application/x-www-form-urlencoded оно не пройдет — передавайте его с заголовком Content-Type: application/json" + }, + { + "name": "sourceCode", + "type": "string", + "base": "string", + "required": false, + "description": "Символьный код внешней системы, максимальная длина — 64 символа" }, { "name": "sort", "type": "integer", "base": "integer", "required": false, - "description": "Параметр сортировки коннекторов. Значение по умолчанию 100" + "description": "Параметр сортировки коннекторов. Значение по умолчанию — 100" } ] } @@ -114,7 +128,7 @@ "type": "object", "base": "object", "required": false, - "description": "Корневой элемент ответа. Содержит поле id с идентификатором созданного коннектора" + "description": "Корневой элемент ответа (подробное описание)" }, { "name": "time", diff --git a/_assets/simulator/spec/methods/biconnector.connector.delete.json b/_assets/simulator/spec/methods/biconnector.connector.delete.json index 0d614c2d5..20563d0d9 100644 --- a/_assets/simulator/spec/methods/biconnector.connector.delete.json +++ b/_assets/simulator/spec/methods/biconnector.connector.delete.json @@ -4,7 +4,7 @@ "scope": "biconnector", "kind": "write", "title": "Удалить коннектор biconnector.connector.delete", - "permissions": "пользователь с доступом к разделу «Рабочее место аналитика»", + "permissions": "пользователь с правами «Доступ к BI Конструктору» и «Доступ к рабочему месту аналитика» одновременно", "params": [ { "name": "id", @@ -37,7 +37,7 @@ "type": "boolean", "base": "boolean", "required": false, - "description": "Корневой элемент ответа, содержит true в случае успеха" + "description": "Корневой элемент ответа. Содержит true, если коннектор удален. Другого значения при успехе метод не возвращает и объект удаленного коннектора не отдает. Если удалить коннектор не удалось, вместо true в result приходит объект с ключом error" }, { "name": "time", diff --git a/_assets/simulator/spec/methods/biconnector.connector.fields.json b/_assets/simulator/spec/methods/biconnector.connector.fields.json index 245e177a7..27d1975ad 100644 --- a/_assets/simulator/spec/methods/biconnector.connector.fields.json +++ b/_assets/simulator/spec/methods/biconnector.connector.fields.json @@ -4,14 +4,25 @@ "scope": "biconnector", "kind": "read", "title": "Получить поля коннектора biconnector.connector.fields", - "permissions": "любой пользователь", + "permissions": "пользователь с правами «Доступ к BI Конструктору» и «Доступ к рабочему месту аналитика» одновременно", "params": [ { "name": "result", "type": "object", "base": "object", "required": "unknown", - "description": "Корневой элемент ответа. Содержит массив fields с описанием полей коннектора. Структура элемента массива описана в статье Коннектор: обзор методов", + "description": "Корневой элемент ответа. Содержит единственный ключ fields", + "dynamic": { + "allowed": true, + "note": "Состав полей не описан подтаблицей на этой странице" + } + }, + { + "name": "result.fields", + "type": "object[]", + "base": "array", + "required": "unknown", + "description": "Массив дескрипторов полей коннектора, один элемент — одно поле (подробное описание)", "dynamic": { "allowed": true, "note": "Состав полей не описан подтаблицей на этой странице" @@ -118,6 +129,22 @@ "isImmutable": false, "isMultiple": true }, + { + "title": "supportMapping", + "type": "boolean", + "isRequired": false, + "isReadOnly": false, + "isImmutable": false, + "isMultiple": false + }, + { + "title": "sourceCode", + "type": "string", + "isRequired": false, + "isReadOnly": false, + "isImmutable": false, + "isMultiple": false + }, { "title": "dateCreate", "type": "datetime", @@ -143,7 +170,14 @@ "type": "object", "base": "object", "required": "unknown", - "description": "Корневой элемент ответа. Содержит массив fields с описанием полей коннектора. Структура элемента массива описана в статье Коннектор: обзор методов" + "description": "Корневой элемент ответа. Содержит единственный ключ fields" + }, + { + "name": "result.fields", + "type": "object[]", + "base": "array", + "required": "unknown", + "description": "Массив дескрипторов полей коннектора, один элемент — одно поле (подробное описание)" }, { "name": "time", @@ -154,5 +188,6 @@ } ], "page": "/api-reference/biconnector/connector/biconnector-connector-fields.html", - "executable": false + "executable": false, + "requestExample": {} } diff --git a/_assets/simulator/spec/methods/biconnector.connector.get.json b/_assets/simulator/spec/methods/biconnector.connector.get.json index 2242227e0..5b44a18db 100644 --- a/_assets/simulator/spec/methods/biconnector.connector.get.json +++ b/_assets/simulator/spec/methods/biconnector.connector.get.json @@ -4,7 +4,7 @@ "scope": "biconnector", "kind": "read", "title": "Получить коннектор по id biconnector.connector.get", - "permissions": "пользователь с доступом к разделу «Рабочее место аналитика»", + "permissions": "пользователь с правами «Доступ к BI Конструктору» и «Доступ к рабочему месту аналитика» одновременно", "params": [ { "name": "id", @@ -23,10 +23,10 @@ "resultExample": { "result": { "item": { - "id": 5, + "id": 4, "title": "SUPER REST CONNECTOR", "dateCreate": "2025-03-24 07:25:59", - "logo": "https://masterpiecer-images.s3.yandex.net/5fd531dca6427c7:upscaled", + "logo": "https://app.domain/logo.png", "description": "Connector with token", "sort": 100, "urlCheck": "http://app.domain/check", @@ -44,7 +44,9 @@ ], "urlData": "http://app.domain/data", "urlTableList": "http://app.domain/table_list", - "urlTableDescription": "http://app.domain/table_description" + "urlTableDescription": "http://app.domain/table_description", + "supportMapping": false, + "sourceCode": "" } }, "time": { @@ -62,7 +64,14 @@ "type": "object", "base": "object", "required": false, - "description": "Корневой элемент ответа. Содержит информацию о полях коннектора. Описание полей в статье Коннектор: обзор методов" + "description": "Корневой элемент ответа. Содержит единственный ключ item" + }, + { + "name": "result.item", + "type": "object", + "base": "object", + "required": false, + "description": "Данные коннектора (подробное описание)" }, { "name": "time", @@ -81,6 +90,8 @@ "logo", "settings", "sort", + "sourceCode", + "supportMapping", "title", "urlCheck", "urlData", diff --git a/_assets/simulator/spec/methods/biconnector.connector.list.json b/_assets/simulator/spec/methods/biconnector.connector.list.json index 62722248d..ce1433ef7 100644 --- a/_assets/simulator/spec/methods/biconnector.connector.list.json +++ b/_assets/simulator/spec/methods/biconnector.connector.list.json @@ -4,14 +4,14 @@ "scope": "biconnector", "kind": "read", "title": "Получить список коннекторов biconnector.connector.list", - "permissions": "пользователь с доступом к разделу «Рабочее место аналитика»", + "permissions": "пользователь с правами «Доступ к BI Конструктору» и «Доступ к рабочему месту аналитика» одновременно", "params": [ { "name": "select", "type": "string[]", "base": "array", "required": "unknown", - "description": "Список полей, которые должны быть заполнены у коннекторов в выборке. По умолчанию берутся все поля", + "description": "Список полей, которые должны быть заполнены у коннекторов в выборке. Допустимые значения — названия полей из таблицы элемента выборки и *. Значение [\"*\"] возвращает все поля, оно же используется по умолчанию", "dynamic": { "allowed": true, "note": "Состав полей не описан подтаблицей на этой странице" @@ -33,7 +33,7 @@ "type": "object", "base": "object", "required": "unknown", - "description": "Параметры сортировки. Пример формата: - field_n — название поля, по которому будет произведена сортировка выборки коннекторов - value_n — значение типа string, равное: - ASC — сортировка по возрастанию - DESC — сортировка по убыванию", + "description": "Параметры сортировки. Пример формата: - field_n — название поля, по которому будет произведена сортировка выборки коннекторов - value_n — значение типа string, равное: - ASC — сортировка по возрастанию - DESC — сортировка по убыванию Без этого параметра сортировка не применяется и порядок записей в выборке не гарантирован.…", "dynamic": { "allowed": true, "note": "Состав полей не описан подтаблицей на этой странице" @@ -44,7 +44,7 @@ "type": "integer", "base": "integer", "required": "unknown", - "description": "Управление постраничной навигацией. Размер страницы результатов — 50 записей. Для перехода по результатам передавайте номер страницы" + "description": "Номер страницы результатов. Нумерация начинается с единицы, значение по умолчанию — 1. Нечисловое, нулевое или отрицательное значение ошибки не вызывает: метод молча отдает первую страницу. Параметр start, общий для большинства списочных методов REST API, здесь не работает" } ], "defs": {}, @@ -56,13 +56,13 @@ "resultExample": { "result": [ { - "id": "11", + "id": 11, "title": "MyConnector_2", "urlCheck": "https://new_example.com/check", "dateCreate": "2025-03-24 07:25:59" }, { - "id": "9", + "id": 9, "title": "MyConnector", "urlCheck": "https://example.com/check", "dateCreate": "2025-03-21 12:22:32" @@ -78,6 +78,13 @@ } }, "returns": [ + { + "name": "result", + "type": "array", + "base": "array", + "required": "unknown", + "description": "Корневой элемент ответа. Массив коннекторов без дополнительной обертки (подробное описание)" + }, { "name": "time", "type": "time", @@ -95,6 +102,8 @@ "logo", "settings", "sort", + "sourceCode", + "supportMapping", "title", "urlCheck", "urlData", diff --git a/_assets/simulator/spec/methods/biconnector.connector.update.json b/_assets/simulator/spec/methods/biconnector.connector.update.json index 43bb01443..4c6c7302c 100644 --- a/_assets/simulator/spec/methods/biconnector.connector.update.json +++ b/_assets/simulator/spec/methods/biconnector.connector.update.json @@ -3,8 +3,8 @@ "method": "biconnector.connector.update", "scope": "biconnector", "kind": "write", - "title": "Изменить коннектор biconnector.connector.update", - "permissions": "пользователь с доступом к разделу «Рабочее место аналитика»", + "title": "Обновить коннектор biconnector.connector.update", + "permissions": "пользователь с правами «Доступ к BI Конструктору» и «Доступ к рабочему месту аналитика» одновременно", "params": [ { "name": "id", @@ -35,7 +35,7 @@ "type": "string", "base": "string", "required": false, - "description": "Новое название коннектора" + "description": "Новое название коннектора, максимальная длина — 512 символов" }, { "name": "logo", @@ -56,35 +56,49 @@ "type": "string", "base": "string", "required": false, - "description": "Новый эндпоинт для проверки доступности коннектора, (подробное описание)" + "description": "Новый эндпоинт для проверки доступности коннектора, максимальная длина — 2048 символов, (подробное описание)" }, { "name": "urlTableList", "type": "string", "base": "string", "required": false, - "description": "Новый эндпоинт для получения списка таблиц, (подробное описание)" + "description": "Новый эндпоинт для получения списка таблиц, максимальная длина — 2048 символов, (подробное описание)" }, { "name": "urlTableDescription", "type": "string", "base": "string", "required": false, - "description": "Новый эндпоинт для получения описания конкретной таблицы, (подробное описание)" + "description": "Новый эндпоинт для получения описания конкретной таблицы, максимальная длина — 2048 символов, (подробное описание)" }, { "name": "urlData", "type": "string", "base": "string", "required": false, - "description": "Новый эндпоинт для получения данных по выбранной таблице, (подробное описание)" + "description": "Новый эндпоинт для получения данных по выбранной таблице, максимальная длина — 2048 символов, (подробное описание)" }, { "name": "settings", "type": "array", "base": "array", "required": false, - "description": "Новый список параметров подключения, (подробное описание)" + "description": "Новый массив параметров подключения. Заменяет прежний целиком (подробное описание)" + }, + { + "name": "supportMapping", + "type": "boolean", + "base": "boolean", + "required": false, + "description": "Поддержка сопоставления полей таблицы с полями внешней системы. Если поле не передать, у коннектора останется прежнее значение. Значение проверяется строгим сравнением с булевым типом, поэтому в запросе с типом application/x-www-form-urlencoded оно не пройдет — передавайте его с заголовком Content-Type: application/json" + }, + { + "name": "sourceCode", + "type": "string", + "base": "string", + "required": false, + "description": "Символьный код внешней системы, максимальная длина — 64 символа" }, { "name": "sort", @@ -118,7 +132,7 @@ "type": "boolean", "base": "boolean", "required": false, - "description": "Корневой элемент ответа, содержит true в случае успеха" + "description": "Корневой элемент ответа. При успешном обновлении содержит true — объекта с данными коннектора в ответе нет. Чтобы увидеть новые значения полей, вызовите biconnector.connector.get" }, { "name": "time", diff --git a/_assets/simulator/spec/methods/biconnector.dataset.add.json b/_assets/simulator/spec/methods/biconnector.dataset.add.json index 3c39fdc62..071aac675 100644 --- a/_assets/simulator/spec/methods/biconnector.dataset.add.json +++ b/_assets/simulator/spec/methods/biconnector.dataset.add.json @@ -4,7 +4,7 @@ "scope": "biconnector", "kind": "write", "title": "Создать датасет biconnector.dataset.add", - "permissions": "пользователь с доступом к разделу «Рабочее место аналитика»", + "permissions": "пользователь с правами «Доступ к BI Конструктору» и «Доступ к рабочему месту аналитика» одновременно", "params": [ { "name": "fields", @@ -28,28 +28,28 @@ "type": "string", "base": "string", "required": true, - "description": "Название датасета. Название должно начинаться с буквы, можно использовать только строчные латинские буквы a-z, цифры и знак _. Максимальная длина названия 230 символа" + "description": "Название датасета. Название должно начинаться с буквы, можно использовать только строчные латинские буквы a-z, цифры и знак _. Максимальная длина названия 230 символов" }, { "name": "externalName", "type": "string", "base": "string", "required": true, - "description": "Название датасета во внешнем источнике, в приложении" + "description": "Название датасета во внешнем источнике, в приложении. Максимальная длина 512 символов" }, { "name": "externalCode", "type": "string", "base": "string", "required": true, - "description": "Уникальный код датасета во внешнем источнике, используется при выборке данных" + "description": "Уникальный код датасета во внешнем источнике, используется при выборке данных. Максимальная длина 512 символов" }, { "name": "sourceId", "type": "integer", "base": "integer", "required": true, - "description": "Идентификатор источника, можно получить методами biconnector.source.list или biconnector.source.add" + "description": "Идентификатор источника, можно получить методами biconnector.source.list или biconnector.source.add. Источник должен принадлежать коннектору текущего приложения, иначе метод вернет SOURCE_NOT_FOUND" }, { "name": "description", @@ -63,7 +63,7 @@ "type": "array", "base": "array", "required": true, - "description": "Список полей датасета, (Подробное описание)" + "description": "Массив полей датасета, (подробное описание)" } ] } @@ -73,6 +73,9 @@ "source": { "file": "api-reference/biconnector/dataset/biconnector-dataset-add.md" }, + "deprecated": { + "successor": "biconnector.table.add" + }, "resultExample": { "result": { "id": 10 @@ -93,7 +96,7 @@ "type": "object", "base": "object", "required": false, - "description": "Корневой элемент ответа. Содержит поле id с идентификатором созданного датасета" + "description": "Корневой элемент ответа (подробное описание)" }, { "name": "time", diff --git a/_assets/simulator/spec/methods/biconnector.dataset.delete.json b/_assets/simulator/spec/methods/biconnector.dataset.delete.json index e347cdbbe..05ceee495 100644 --- a/_assets/simulator/spec/methods/biconnector.dataset.delete.json +++ b/_assets/simulator/spec/methods/biconnector.dataset.delete.json @@ -4,7 +4,7 @@ "scope": "biconnector", "kind": "write", "title": "Удалить датасет biconnector.dataset.delete", - "permissions": "пользователь с доступом к разделу «Рабочее место аналитика»", + "permissions": "пользователь с правами «Доступ к BI Конструктору» и «Доступ к рабочему месту аналитика» одновременно", "params": [ { "name": "id", @@ -20,6 +20,9 @@ "source": { "file": "api-reference/biconnector/dataset/biconnector-dataset-delete.md" }, + "deprecated": { + "successor": "biconnector.table.delete" + }, "resultExample": { "result": true, "time": { @@ -37,7 +40,7 @@ "type": "boolean", "base": "boolean", "required": false, - "description": "Корневой элемент ответа, содержит true в случае успеха" + "description": "Корневой элемент ответа. Содержит true, если датасет удален. Другого значения при успехе метод не возвращает и объект удаленного датасета не отдает. Если удалить датасет не удалось, вместо true в result приходит объект с ключом error" }, { "name": "time", diff --git a/_assets/simulator/spec/methods/biconnector.dataset.fields.json b/_assets/simulator/spec/methods/biconnector.dataset.fields.json index 55fa411e1..cff03daa8 100644 --- a/_assets/simulator/spec/methods/biconnector.dataset.fields.json +++ b/_assets/simulator/spec/methods/biconnector.dataset.fields.json @@ -4,14 +4,25 @@ "scope": "biconnector", "kind": "read", "title": "Получить поля датасета biconnector.dataset.fields", - "permissions": "пользователь с доступом к разделу «Рабочее место аналитика»", + "permissions": "пользователь с правами «Доступ к BI Конструктору» и «Доступ к рабочему месту аналитика» одновременно", "params": [ { "name": "result", "type": "object", "base": "object", "required": "unknown", - "description": "Корневой элемент ответа. Содержит массив fields с описанием полей датасета. Структура элемента массива описана в статье Коннектор: обзор методов", + "description": "Корневой элемент ответа. Содержит единственный ключ fields", + "dynamic": { + "allowed": true, + "note": "Состав полей не описан подтаблицей на этой странице" + } + }, + { + "name": "result.fields", + "type": "object[]", + "base": "array", + "required": "unknown", + "description": "Массив дескрипторов полей датасета, один элемент — одно поле (подробное описание)", "dynamic": { "allowed": true, "note": "Состав полей не описан подтаблицей на этой странице" @@ -35,6 +46,9 @@ "source": { "file": "api-reference/biconnector/dataset/biconnector-dataset-fields.md" }, + "deprecated": { + "successor": "biconnector.table.fields" + }, "resultExample": { "result": { "fields": [ @@ -153,6 +167,30 @@ "date_finish": "2025-02-28T15:47:32+00:00" } }, + "returns": [ + { + "name": "result", + "type": "object", + "base": "object", + "required": "unknown", + "description": "Корневой элемент ответа. Содержит единственный ключ fields" + }, + { + "name": "result.fields", + "type": "object[]", + "base": "array", + "required": "unknown", + "description": "Массив дескрипторов полей датасета, один элемент — одно поле (подробное описание)" + }, + { + "name": "time", + "type": "time", + "base": "object", + "required": "unknown", + "description": "Информация о времени выполнения запроса" + } + ], "page": "/api-reference/biconnector/dataset/biconnector-dataset-fields.html", - "executable": false + "executable": false, + "requestExample": {} } diff --git a/_assets/simulator/spec/methods/biconnector.dataset.fields.update.json b/_assets/simulator/spec/methods/biconnector.dataset.fields.update.json index 4b971c599..85271e6d3 100644 --- a/_assets/simulator/spec/methods/biconnector.dataset.fields.update.json +++ b/_assets/simulator/spec/methods/biconnector.dataset.fields.update.json @@ -4,7 +4,7 @@ "scope": "biconnector", "kind": "write", "title": "Обновить поля датасета biconnector.dataset.fields.update", - "permissions": "пользователь с доступом к разделу «Рабочее место аналитика»", + "permissions": "пользователь с правами «Доступ к BI Конструктору» и «Доступ к рабочему месту аналитика» одновременно", "params": [ { "name": "id", @@ -15,10 +15,10 @@ }, { "name": "add", - "type": "object", - "base": "object", + "type": "array", + "base": "array", "required": false, - "description": "Объект, содержащий массив добавляемых полей со следующей структурой: - type — тип поля - name — название поля - externalCode — внешний код поля", + "description": "Массив добавляемых полей. Каждый элемент — объект с тремя обязательными ключами: - type string — тип данных поля - name string — название поля, заглавные латинские буквы A-Z, цифры и знак _, не длиннее 32 символов - externalCode string — внешний код поля Видимость у добавляемого поля не задается: новые поля создаются видимыми", "dynamic": { "allowed": true, "note": "Состав полей не описан подтаблицей на этой странице" @@ -26,10 +26,10 @@ }, { "name": "update", - "type": "object", - "base": "object", + "type": "array", + "base": "array", "required": false, - "description": "Объект, содержащий массив обновляемых полей со следующей структурой: - id — Идентификатор поля, можно получить методом biconnector.dataset.get - visible — видимость поля", + "description": "Массив изменяемых полей. Каждый элемент — объект с двумя обязательными ключами: - id integer — идентификатор поля, можно получить методом biconnector.dataset.get - visible boolean — видимость поля Видимость — единственный признак поля, который меняет этот блок. Название, тип и внешний код существующего поля изменить нельзя", "dynamic": { "allowed": true, "note": "Состав полей не описан подтаблицей на этой странице" @@ -40,7 +40,7 @@ "type": "integer[]", "base": "array", "required": false, - "description": "Объект, содержащий массив идентификаторов полей для их удаления. Идентификаторы полей можно получить методом biconnector.dataset.get", + "description": "Массив идентификаторов удаляемых полей. Идентификаторы можно получить методом biconnector.dataset.get", "dynamic": { "allowed": true, "note": "Состав полей не описан подтаблицей на этой странице" @@ -53,6 +53,9 @@ "source": { "file": "api-reference/biconnector/dataset/biconnector-dataset-fields-update.md" }, + "deprecated": { + "successor": "biconnector.table.fields.update" + }, "resultExample": { "result": true, "time": { @@ -70,7 +73,7 @@ "type": "boolean", "base": "boolean", "required": false, - "description": "Корневой элемент ответа, содержит true в случае успеха" + "description": "Корневой элемент ответа. При успешном обновлении содержит true — нового состава полей в ответе нет. Чтобы увидеть его, вызовите biconnector.dataset.get" }, { "name": "time", diff --git a/_assets/simulator/spec/methods/biconnector.dataset.get.json b/_assets/simulator/spec/methods/biconnector.dataset.get.json index a332bed24..2092c76f9 100644 --- a/_assets/simulator/spec/methods/biconnector.dataset.get.json +++ b/_assets/simulator/spec/methods/biconnector.dataset.get.json @@ -4,7 +4,7 @@ "scope": "biconnector", "kind": "read", "title": "Получить датасет по id biconnector.dataset.get", - "permissions": "пользователь с доступом к разделу «Рабочее место аналитика»", + "permissions": "пользователь с правами «Доступ к BI Конструктору» и «Доступ к рабочему месту аналитика» одновременно", "params": [ { "name": "id", @@ -20,6 +20,9 @@ "source": { "file": "api-reference/biconnector/dataset/biconnector-dataset-get.md" }, + "deprecated": { + "successor": "biconnector.table.get" + }, "resultExample": { "result": { "item": { @@ -27,13 +30,16 @@ "type": "rest", "name": "rest_dataset11111", "description": "new__2_", - "externalCode": "extrnalCode", - "externalName": "extranalName", + "externalCode": "sales_orders", + "externalName": "Sales orders", "dateCreate": "2025-03-26 15:28:06", "dateUpdate": "2025-03-27 07:47:43", "createdById": 1, "updatedById": 1, "externalId": 275, + "csvDelimiter": "", + "csvEncoding": "", + "csvHasHeaders": false, "fields": [ { "id": 224, @@ -41,7 +47,8 @@ "type": "int", "name": "ID", "externalCode": "ID", - "visible": true + "visible": true, + "description": "" }, { "id": 225, @@ -49,7 +56,8 @@ "type": "string", "name": "NAME", "externalCode": "NAME", - "visible": true + "visible": true, + "description": "" }, { "id": 226, @@ -57,7 +65,8 @@ "type": "string", "name": "SURNAME", "externalCode": "SURNAME", - "visible": true + "visible": true, + "description": "" }, { "id": 227, @@ -65,7 +74,8 @@ "type": "double", "name": "SCORE", "externalCode": "SCORE", - "visible": true + "visible": true, + "description": "" }, { "id": 228, @@ -73,7 +83,8 @@ "type": "date", "name": "DATA", "externalCode": "DATA", - "visible": true + "visible": true, + "description": "" }, { "id": 229, @@ -81,7 +92,8 @@ "type": "datetime", "name": "TIME", "externalCode": "TIME", - "visible": true + "visible": true, + "description": "" } ] } @@ -101,7 +113,7 @@ "type": "object", "base": "object", "required": false, - "description": "Корневой элемент ответа. Содержит информацию о полях датасета. Описание полей в статье Датасеты: обзор методов" + "description": "Корневой элемент ответа. Содержит единственный ключ item — сам датасет вместе с массивом fields. Состав полей описан в статье Датасеты: обзор методов" }, { "name": "time", @@ -115,6 +127,9 @@ "executable": false, "entityFields": [ "createdById", + "csvDelimiter", + "csvEncoding", + "csvHasHeaders", "dateCreate", "dateUpdate", "description", diff --git a/_assets/simulator/spec/methods/biconnector.dataset.list.json b/_assets/simulator/spec/methods/biconnector.dataset.list.json index 5d65ae31b..a4b1cd374 100644 --- a/_assets/simulator/spec/methods/biconnector.dataset.list.json +++ b/_assets/simulator/spec/methods/biconnector.dataset.list.json @@ -4,14 +4,14 @@ "scope": "biconnector", "kind": "read", "title": "Получить список датасетов biconnector.dataset.list", - "permissions": "пользователь с доступом к разделу «Рабочее место аналитика»", + "permissions": "пользователь с правами «Доступ к BI Конструктору» и «Доступ к рабочему месту аналитика» одновременно", "params": [ { "name": "select", "type": "string[]", "base": "array", "required": "unknown", - "description": "Список полей, которые должны быть заполнены у датасетов в выборке. По умолчанию берутся все поля. Не поддерживает поле fields, оно будет проигнорировано", + "description": "Список полей, которые должны быть заполнены у датасетов в выборке. Допустимые значения — названия полей из схемы метода biconnector.dataset.fields и *. По умолчанию берутся все поля, допустимо и явное select: [\"*\"]. Поля csvDelimiter, csvEncoding и csvHasHeaders в схему не входят: в ответе они приходят, но в select вызовут ошибку VALIDATION_FIELD_NOT_ALLOWED_IN_SELECT.…", "dynamic": { "allowed": true, "note": "Состав полей не описан подтаблицей на этой странице" @@ -33,7 +33,7 @@ "type": "object", "base": "object", "required": "unknown", - "description": "Параметры сортировки. Пример формата: где: - field_n — название поля, по которому будет произведена сортировка выборки датасетов - value_n — значение типа string, равное: - ASC — сортировка по возрастанию - DESC — сортировка по убыванию", + "description": "Параметры сортировки. Пример формата: где: - field_n — название поля, по которому будет произведена сортировка выборки датасетов - value_n — значение типа string, равное: - ASC — сортировка по возрастанию - DESC — сортировка по убыванию Без этого параметра сортировка не применяется и порядок записей в выборке не гарантирован.…", "dynamic": { "allowed": true, "note": "Состав полей не описан подтаблицей на этой странице" @@ -44,7 +44,7 @@ "type": "integer", "base": "integer", "required": "unknown", - "description": "Управление постраничной навигацией. Размер страницы результатов — 50 записей. Для перехода по результатам передавайте номер страницы" + "description": "Номер страницы выборки, нумерация начинается с единицы, значение по умолчанию — 1. Размер страницы фиксированный — 50 записей. Нечисловое, нулевое или отрицательное значение ошибки не вызывает: метод молча отдает первую страницу.…" } ], "defs": {}, @@ -53,20 +53,23 @@ "source": { "file": "api-reference/biconnector/dataset/biconnector-dataset-list.md" }, + "deprecated": { + "successor": "biconnector.table.list" + }, "resultExample": { "result": [ { - "id": "9", + "id": 9, "name": "sales_data_main", "description": "Monthly sales report" }, { - "id": "6", + "id": 6, "name": "sales_data_first_filial", "description": "Monthly sales report for first filial" }, { - "id": "5", + "id": 5, "name": "sales_data_second_filial", "description": "Monthly sales report for second filial" } @@ -81,6 +84,13 @@ } }, "returns": [ + { + "name": "result", + "type": "array", + "base": "array", + "required": "unknown", + "description": "Корневой элемент ответа. Плоский массив датасетов без дополнительной обертки (подробное описание)" + }, { "name": "time", "type": "time", diff --git a/_assets/simulator/spec/methods/biconnector.dataset.update.json b/_assets/simulator/spec/methods/biconnector.dataset.update.json index 3adbd79f9..8e2c73b0e 100644 --- a/_assets/simulator/spec/methods/biconnector.dataset.update.json +++ b/_assets/simulator/spec/methods/biconnector.dataset.update.json @@ -4,7 +4,7 @@ "scope": "biconnector", "kind": "write", "title": "Обновить датасет biconnector.dataset.update", - "permissions": "пользователь с доступом к разделу «Рабочее место аналитика»", + "permissions": "пользователь с правами «Доступ к BI Конструктору» и «Доступ к рабочему месту аналитика» одновременно", "params": [ { "name": "id", @@ -45,6 +45,9 @@ "source": { "file": "api-reference/biconnector/dataset/biconnector-dataset-update.md" }, + "deprecated": { + "successor": "biconnector.table.update" + }, "resultExample": { "result": true, "time": { @@ -62,7 +65,7 @@ "type": "boolean", "base": "boolean", "required": false, - "description": "Корневой элемент ответа, содержит true в случае успеха" + "description": "Корневой элемент ответа. При успешном обновлении содержит true — объекта с данными датасета в ответе нет. Чтобы увидеть новые значения полей, вызовите biconnector.dataset.get" }, { "name": "time", diff --git a/_assets/simulator/spec/methods/biconnector.source.add.json b/_assets/simulator/spec/methods/biconnector.source.add.json index 48f7266a7..5bee59398 100644 --- a/_assets/simulator/spec/methods/biconnector.source.add.json +++ b/_assets/simulator/spec/methods/biconnector.source.add.json @@ -4,7 +4,7 @@ "scope": "biconnector", "kind": "write", "title": "Создать источник biconnector.source.add", - "permissions": "пользователь с доступом к разделу «Рабочее место аналитика»", + "permissions": "пользователь с правами «Доступ к BI Конструктору» и «Доступ к рабочему месту аналитика» одновременно", "params": [ { "name": "fields", @@ -42,7 +42,7 @@ "type": "boolean", "base": "boolean", "required": false, - "description": "Активность источника. По умолчанию true" + "description": "Активность источника. Метод игнорирует переданное значение: созданный источник всегда активен" }, { "name": "connectorId", @@ -56,7 +56,7 @@ "type": "object", "base": "object", "required": true, - "description": "Список параметров для авторизации, передается объектом, где ключ — code параметра. Параметры можно получить методами biconnector.connector.list или biconnector.connector.get" + "description": "Значения параметров авторизации (подробное описание)" } ] } @@ -86,7 +86,7 @@ "type": "object", "base": "object", "required": false, - "description": "Корневой элемент ответа. Содержит поле id с идентификатором созданного источника" + "description": "Корневой элемент ответа (подробное описание)" }, { "name": "time", diff --git a/_assets/simulator/spec/methods/biconnector.source.delete.json b/_assets/simulator/spec/methods/biconnector.source.delete.json index 784266b02..05df45962 100644 --- a/_assets/simulator/spec/methods/biconnector.source.delete.json +++ b/_assets/simulator/spec/methods/biconnector.source.delete.json @@ -4,14 +4,14 @@ "scope": "biconnector", "kind": "write", "title": "Удалить источник biconnector.source.delete", - "permissions": "пользователь с доступом к разделу «Рабочее место аналитика»", + "permissions": "пользователь с правами «Доступ к BI Конструктору» и «Доступ к рабочему месту аналитика» одновременно", "params": [ { "name": "id", "type": "integer", "base": "integer", "required": true, - "description": "Идентификатор подключения, можно получить методами biconnector.source.list или biconnector.source.add" + "description": "Идентификатор источника, можно получить методами biconnector.source.list или biconnector.source.add" } ], "defs": {}, @@ -37,7 +37,7 @@ "type": "boolean", "base": "boolean", "required": false, - "description": "Корневой элемент ответа, содержит true в случае успеха" + "description": "Корневой элемент ответа. Содержит true, если источник удален. Другого значения при успехе метод не возвращает и объект удаленного источника не отдает. Если удалить источник не удалось, вместо true в result приходит объект с ключом error" }, { "name": "time", diff --git a/_assets/simulator/spec/methods/biconnector.source.fields.json b/_assets/simulator/spec/methods/biconnector.source.fields.json index a986290bb..84ee6b49d 100644 --- a/_assets/simulator/spec/methods/biconnector.source.fields.json +++ b/_assets/simulator/spec/methods/biconnector.source.fields.json @@ -4,14 +4,25 @@ "scope": "biconnector", "kind": "read", "title": "Получить поля источника biconnector.source.fields", - "permissions": "любой пользователь", + "permissions": "пользователь с правами «Доступ к BI Конструктору» и «Доступ к рабочему месту аналитика» одновременно", "params": [ { "name": "result", "type": "object", "base": "object", "required": "unknown", - "description": "Корневой элемент ответа. Содержит массив fields с описанием полей источника. Структура элемента массива описана в статье Коннектор: обзор методов", + "description": "Корневой элемент ответа. Содержит единственный ключ fields", + "dynamic": { + "allowed": true, + "note": "Состав полей не описан подтаблицей на этой странице" + } + }, + { + "name": "result.fields", + "type": "object[]", + "base": "array", + "required": "unknown", + "description": "Массив дескрипторов полей источника, один элемент — одно поле (подробное описание)", "dynamic": { "allowed": true, "note": "Состав полей не описан подтаблицей на этой странице" @@ -145,6 +156,30 @@ "date_finish": "2025-03-25T09:49:16+00:00" } }, + "returns": [ + { + "name": "result", + "type": "object", + "base": "object", + "required": "unknown", + "description": "Корневой элемент ответа. Содержит единственный ключ fields" + }, + { + "name": "result.fields", + "type": "object[]", + "base": "array", + "required": "unknown", + "description": "Массив дескрипторов полей источника, один элемент — одно поле (подробное описание)" + }, + { + "name": "time", + "type": "time", + "base": "object", + "required": "unknown", + "description": "Информация о времени выполнения запроса" + } + ], "page": "/api-reference/biconnector/source/biconnector-source-fields.html", - "executable": false + "executable": false, + "requestExample": {} } diff --git a/_assets/simulator/spec/methods/biconnector.source.get.json b/_assets/simulator/spec/methods/biconnector.source.get.json index 24f28c504..517bc5d1e 100644 --- a/_assets/simulator/spec/methods/biconnector.source.get.json +++ b/_assets/simulator/spec/methods/biconnector.source.get.json @@ -4,7 +4,7 @@ "scope": "biconnector", "kind": "read", "title": "Получить источник по id biconnector.source.get", - "permissions": "пользователь с доступом к разделу «Рабочее место аналитика»", + "permissions": "пользователь с правами «Доступ к BI Конструктору» и «Доступ к рабочему месту аналитика» одновременно", "params": [ { "name": "id", @@ -41,7 +41,7 @@ "code": "token", "name": "Токен", "type": "STRING", - "value": "beliberda", + "value": "a1b2c3d4e5", "id": 8 } ] @@ -62,7 +62,14 @@ "type": "object", "base": "object", "required": false, - "description": "Корневой элемент ответа. Содержит информацию о полях источника. Описание полей в статье Источники: обзор методов" + "description": "Корневой элемент ответа. Содержит единственный ключ item" + }, + { + "name": "result.item", + "type": "object", + "base": "object", + "required": false, + "description": "Данные источника (подробное описание)" }, { "name": "time", diff --git a/_assets/simulator/spec/methods/biconnector.source.list.json b/_assets/simulator/spec/methods/biconnector.source.list.json index e40f36570..9448dfa64 100644 --- a/_assets/simulator/spec/methods/biconnector.source.list.json +++ b/_assets/simulator/spec/methods/biconnector.source.list.json @@ -4,14 +4,14 @@ "scope": "biconnector", "kind": "read", "title": "Получить список источников biconnector.source.list", - "permissions": "пользователь с доступом к разделу «Рабочее место аналитика»", + "permissions": "пользователь с правами «Доступ к BI Конструктору» и «Доступ к рабочему месту аналитика» одновременно", "params": [ { "name": "select", "type": "string[]", "base": "array", "required": "unknown", - "description": "Список полей, которые должны быть заполнены у источников в выборке. По умолчанию берутся все поля", + "description": "Список полей, которые должны быть заполнены у источников в выборке. Допустимые значения — названия полей из схемы метода biconnector.source.fields и *. По умолчанию берутся все поля, то же дает значение *. Если передать в select только поле settings, в элементах выборки не будет идентификатора id", "dynamic": { "allowed": true, "note": "Состав полей не описан подтаблицей на этой странице" @@ -33,7 +33,7 @@ "type": "object", "base": "object", "required": "unknown", - "description": "Параметры сортировки. Пример формата: - field_n — название поля, по которому будет произведена сортировка выборки источников - value_n — значение типа string, равное: - ASC — сортировка по возрастанию - DESC — сортировка по убыванию", + "description": "Параметры сортировки. Пример формата: - field_n — название поля, по которому будет произведена сортировка выборки источников - value_n — значение типа string, равное: - ASC — сортировка по возрастанию - DESC — сортировка по убыванию Без этого параметра сортировка не применяется и порядок записей в выборке не гарантирован.…", "dynamic": { "allowed": true, "note": "Состав полей не описан подтаблицей на этой странице" @@ -44,7 +44,7 @@ "type": "integer", "base": "integer", "required": "unknown", - "description": "Управление постраничной навигацией. Размер страницы результатов — 50 записей. Для перехода по результатам передавайте номер страницы" + "description": "Номер страницы результатов. Нумерация начинается с единицы, значение по умолчанию — 1. Нечисловое, нулевое или отрицательное значение ошибки не вызывает: метод молча отдает первую страницу. Параметр start, общий для большинства списочных методов REST API, здесь не работает" } ], "defs": {}, @@ -56,16 +56,16 @@ "resultExample": { "result": [ { - "id": "11", + "id": 11, "title": "Sql_host", "active": true, - "dateCreate": "2025-03-24 07:25:59" + "description": "Подключение для отчетов по хостам" }, { - "id": "10", + "id": 10, "title": "Sql_partner", "active": false, - "dateCreate": "2025-03-21 12:22:32" + "description": "Подключение для отчетов по партнерам" } ], "time": { @@ -78,6 +78,13 @@ } }, "returns": [ + { + "name": "result", + "type": "array", + "base": "array", + "required": "unknown", + "description": "Корневой элемент ответа. Массив источников без дополнительной обертки (подробное описание)" + }, { "name": "time", "type": "time", @@ -91,7 +98,6 @@ "entityFields": [ "active", "connectorId", - "dateCreate", "description", "id", "settings", diff --git a/_assets/simulator/spec/methods/biconnector.source.update.json b/_assets/simulator/spec/methods/biconnector.source.update.json index a211b64ca..5d61c6c6f 100644 --- a/_assets/simulator/spec/methods/biconnector.source.update.json +++ b/_assets/simulator/spec/methods/biconnector.source.update.json @@ -3,8 +3,8 @@ "method": "biconnector.source.update", "scope": "biconnector", "kind": "write", - "title": "Изменить источник biconnector.source.update", - "permissions": "пользователь с доступом к разделу «Рабочее место аналитика»", + "title": "Обновить источник biconnector.source.update", + "permissions": "пользователь с правами «Доступ к BI Конструктору» и «Доступ к рабочему месту аналитика» одновременно", "params": [ { "name": "id", @@ -34,7 +34,7 @@ "name": "title", "type": "string", "base": "string", - "required": false, + "required": true, "description": "Новое название источника" }, { @@ -49,14 +49,14 @@ "type": "boolean", "base": "boolean", "required": false, - "description": "Активность источника" + "description": "Активность источника. Метод не читает это поле: выключить источник через REST нельзя" }, { "name": "settings", "type": "object", "base": "object", "required": false, - "description": "Список параметров для авторизации, передается объектом, где ключ — code параметра. Параметры можно получить методами biconnector.connector.list или biconnector.connector.get" + "description": "Значения параметров авторизации (подробное описание)" } ] } @@ -83,7 +83,7 @@ "type": "boolean", "base": "boolean", "required": false, - "description": "Корневой элемент ответа, содержит true в случае успеха" + "description": "Результат обновления. При успешном обновлении приходит true, данные источника метод не возвращает — получите их методом biconnector.source.get. При ошибке вместо true в result приходит объект с полем error, см. раздел «Обработка ошибок»" }, { "name": "time", diff --git a/_assets/simulator/spec/methods/biconnector.table.add.json b/_assets/simulator/spec/methods/biconnector.table.add.json new file mode 100644 index 000000000..abe9cfd97 --- /dev/null +++ b/_assets/simulator/spec/methods/biconnector.table.add.json @@ -0,0 +1,108 @@ +{ + "$v": 1, + "method": "biconnector.table.add", + "scope": "biconnector", + "kind": "write", + "title": "Создать таблицу biconnector.table.add", + "permissions": "пользователь с правами «Доступ к BI Конструктору» и «Доступ к рабочему месту аналитика» одновременно", + "params": [ + { + "name": "fields", + "type": "object", + "base": "object", + "required": true, + "description": "Объект, содержащий данные для создания новой таблицы. Формат объекта: - field_n — название поля - value_n — значение поля Подробное описание ниже", + "ref": "#/defs/fieldsFields" + } + ], + "defs": { + "fieldsFields": { + "dynamic": { + "allowed": false, + "ufAllowed": true, + "note": "Пользовательские поля UF_* в схеме не описаны" + }, + "fields": [ + { + "name": "name", + "type": "string", + "base": "string", + "required": true, + "description": "Название таблицы. Название должно начинаться с буквы, можно использовать только строчные латинские буквы a-z, цифры и знак _. Максимальная длина названия 230 символов" + }, + { + "name": "externalName", + "type": "string", + "base": "string", + "required": true, + "description": "Название таблицы во внешнем источнике, в приложении. Максимальная длина 512 символов" + }, + { + "name": "externalCode", + "type": "string", + "base": "string", + "required": true, + "description": "Уникальный код таблицы во внешнем источнике, используется при выборке данных. Максимальная длина 512 символов" + }, + { + "name": "sourceId", + "type": "integer", + "base": "integer", + "required": true, + "description": "Идентификатор источника, можно получить методами biconnector.source.list или biconnector.source.add. Источник должен принадлежать коннектору текущего приложения, иначе метод вернет SOURCE_NOT_FOUND" + }, + { + "name": "description", + "type": "string", + "base": "string", + "required": false, + "description": "Описание таблицы" + }, + { + "name": "fields", + "type": "array", + "base": "array", + "required": true, + "description": "Массив колонок таблицы (подробное описание)" + } + ] + } + }, + "requiredConvention": true, + "confidence": "parsed", + "source": { + "file": "api-reference/biconnector/table/biconnector-table-add.md" + }, + "resultExample": { + "result": { + "id": 10 + }, + "time": { + "start": 1725013197.635808, + "finish": 1725013198.580873, + "duration": 0.9450650215148926, + "processing": 0.6822988986968994, + "date_start": "2024-08-30T12:19:57+02:00", + "date_finish": "2024-08-30T12:19:58+02:00", + "operating": 0 + } + }, + "returns": [ + { + "name": "result", + "type": "object", + "base": "object", + "required": false, + "description": "Корневой элемент ответа (подробное описание)" + }, + { + "name": "time", + "type": "time", + "base": "object", + "required": false, + "description": "Информация о времени выполнения запроса" + } + ], + "page": "/api-reference/biconnector/table/biconnector-table-add.html", + "executable": false +} diff --git a/_assets/simulator/spec/methods/biconnector.table.delete.json b/_assets/simulator/spec/methods/biconnector.table.delete.json new file mode 100644 index 000000000..412648b77 --- /dev/null +++ b/_assets/simulator/spec/methods/biconnector.table.delete.json @@ -0,0 +1,52 @@ +{ + "$v": 1, + "method": "biconnector.table.delete", + "scope": "biconnector", + "kind": "write", + "title": "Удалить таблицу biconnector.table.delete", + "permissions": "пользователь с правами «Доступ к BI Конструктору» и «Доступ к рабочему месту аналитика» одновременно", + "params": [ + { + "name": "id", + "type": "integer", + "base": "integer", + "required": true, + "description": "Идентификатор таблицы, можно получить методами biconnector.table.list или biconnector.table.add" + } + ], + "defs": {}, + "requiredConvention": true, + "confidence": "parsed", + "source": { + "file": "api-reference/biconnector/table/biconnector-table-delete.md" + }, + "resultExample": { + "result": true, + "time": { + "start": 1725365418.056843, + "finish": 1725365419.671506, + "duration": 1.6146628856658936, + "processing": 1.3475170135498047, + "date_start": "2024-09-03T14:10:18+02:00", + "date_finish": "2024-09-03T14:10:19+02:00" + } + }, + "returns": [ + { + "name": "result", + "type": "boolean", + "base": "boolean", + "required": false, + "description": "Корневой элемент ответа. Содержит true, если таблица удалена. Другого значения при успехе метод не возвращает и объект удаленной таблицы не отдает. Если удалить таблицу не удалось, вместо true в result приходит объект с ключом error" + }, + { + "name": "time", + "type": "time", + "base": "object", + "required": false, + "description": "Информация о времени выполнения запроса" + } + ], + "page": "/api-reference/biconnector/table/biconnector-table-delete.html", + "executable": false +} diff --git a/_assets/simulator/spec/methods/biconnector.table.fields.json b/_assets/simulator/spec/methods/biconnector.table.fields.json new file mode 100644 index 000000000..374ba87c8 --- /dev/null +++ b/_assets/simulator/spec/methods/biconnector.table.fields.json @@ -0,0 +1,193 @@ +{ + "$v": 1, + "method": "biconnector.table.fields", + "scope": "biconnector", + "kind": "read", + "title": "Получить поля таблицы biconnector.table.fields", + "permissions": "пользователь с правами «Доступ к BI Конструктору» и «Доступ к рабочему месту аналитика» одновременно", + "params": [ + { + "name": "result", + "type": "object", + "base": "object", + "required": "unknown", + "description": "Корневой элемент ответа. Содержит единственный ключ fields", + "dynamic": { + "allowed": true, + "note": "Состав полей не описан подтаблицей на этой странице" + } + }, + { + "name": "result.fields", + "type": "object[]", + "base": "array", + "required": "unknown", + "description": "Массив дескрипторов полей таблицы, один элемент — одно поле (подробное описание)", + "dynamic": { + "allowed": true, + "note": "Состав полей не описан подтаблицей на этой странице" + } + }, + { + "name": "time", + "type": "time", + "base": "object", + "required": "unknown", + "description": "Информация о времени выполнения запроса", + "dynamic": { + "allowed": true, + "note": "Состав полей не описан подтаблицей на этой странице" + } + } + ], + "defs": {}, + "requiredConvention": false, + "confidence": "parsed", + "source": { + "file": "api-reference/biconnector/table/biconnector-table-fields.md" + }, + "resultExample": { + "result": { + "fields": [ + { + "title": "id", + "type": "integer", + "isRequired": true, + "isReadOnly": true, + "isImmutable": false, + "isMultiple": false + }, + { + "title": "sourceId", + "type": "integer", + "isRequired": true, + "isReadOnly": false, + "isImmutable": true, + "isMultiple": false + }, + { + "title": "name", + "type": "string", + "isRequired": true, + "isReadOnly": false, + "isImmutable": true, + "isMultiple": false + }, + { + "title": "type", + "type": "string", + "isRequired": true, + "isReadOnly": true, + "isImmutable": false, + "isMultiple": false + }, + { + "title": "description", + "type": "string", + "isRequired": false, + "isReadOnly": false, + "isImmutable": false, + "isMultiple": false + }, + { + "title": "externalName", + "type": "string", + "isRequired": true, + "isReadOnly": false, + "isImmutable": true, + "isMultiple": false + }, + { + "title": "externalCode", + "type": "string", + "isRequired": true, + "isReadOnly": false, + "isImmutable": true, + "isMultiple": false + }, + { + "title": "externalId", + "type": "integer", + "isRequired": true, + "isReadOnly": true, + "isImmutable": false, + "isMultiple": false + }, + { + "title": "dateCreate", + "type": "datetime", + "isRequired": true, + "isReadOnly": true, + "isImmutable": false, + "isMultiple": false + }, + { + "title": "dateUpdate", + "type": "datetime", + "isRequired": true, + "isReadOnly": true, + "isImmutable": false, + "isMultiple": false + }, + { + "title": "createdById", + "type": "integer", + "isRequired": true, + "isReadOnly": true, + "isImmutable": false, + "isMultiple": false + }, + { + "title": "updatedById", + "type": "integer", + "isRequired": true, + "isReadOnly": true, + "isImmutable": false, + "isMultiple": false + }, + { + "title": "fields", + "type": "array", + "isRequired": true, + "isReadOnly": false, + "isImmutable": false, + "isMultiple": true + } + ] + }, + "time": { + "start": 1740757652.264398, + "finish": 1740757652.343882, + "duration": 0.0794839859008789, + "processing": 0.00002002716064453125, + "date_start": "2025-02-28T15:47:32+00:00", + "date_finish": "2025-02-28T15:47:32+00:00" + } + }, + "returns": [ + { + "name": "result", + "type": "object", + "base": "object", + "required": "unknown", + "description": "Корневой элемент ответа. Содержит единственный ключ fields" + }, + { + "name": "result.fields", + "type": "object[]", + "base": "array", + "required": "unknown", + "description": "Массив дескрипторов полей таблицы, один элемент — одно поле (подробное описание)" + }, + { + "name": "time", + "type": "time", + "base": "object", + "required": "unknown", + "description": "Информация о времени выполнения запроса" + } + ], + "page": "/api-reference/biconnector/table/biconnector-table-fields.html", + "executable": false, + "requestExample": {} +} diff --git a/_assets/simulator/spec/methods/biconnector.table.fields.update.json b/_assets/simulator/spec/methods/biconnector.table.fields.update.json new file mode 100644 index 000000000..3bfd54469 --- /dev/null +++ b/_assets/simulator/spec/methods/biconnector.table.fields.update.json @@ -0,0 +1,85 @@ +{ + "$v": 1, + "method": "biconnector.table.fields.update", + "scope": "biconnector", + "kind": "write", + "title": "Обновить колонки таблицы biconnector.table.fields.update", + "permissions": "пользователь с правами «Доступ к BI Конструктору» и «Доступ к рабочему месту аналитика» одновременно", + "params": [ + { + "name": "id", + "type": "integer", + "base": "integer", + "required": true, + "description": "Идентификатор таблицы, можно получить методами biconnector.table.list или biconnector.table.add" + }, + { + "name": "add", + "type": "array", + "base": "array", + "required": false, + "description": "Массив добавляемых колонок. Каждый элемент — объект с тремя обязательными ключами: - type string — тип данных колонки - name string — название колонки, заглавные латинские буквы A-Z, цифры и знак _, не длиннее 32 символов - externalCode string — внешний код колонки Видимость у добавляемой колонки не задается: новые колонки создаются видимыми", + "dynamic": { + "allowed": true, + "note": "Состав полей не описан подтаблицей на этой странице" + } + }, + { + "name": "update", + "type": "array", + "base": "array", + "required": false, + "description": "Массив изменяемых колонок. Каждый элемент — объект с двумя обязательными ключами: - id integer — идентификатор колонки, можно получить методом biconnector.table.get - visible boolean — видимость колонки Видимость — единственный признак колонки, который меняет этот блок. Название, тип и внешний код существующей колонки изменить нельзя", + "dynamic": { + "allowed": true, + "note": "Состав полей не описан подтаблицей на этой странице" + } + }, + { + "name": "delete", + "type": "integer[]", + "base": "array", + "required": false, + "description": "Массив идентификаторов удаляемых колонок. Идентификаторы можно получить методом biconnector.table.get", + "dynamic": { + "allowed": true, + "note": "Состав полей не описан подтаблицей на этой странице" + } + } + ], + "defs": {}, + "requiredConvention": true, + "confidence": "parsed", + "source": { + "file": "api-reference/biconnector/table/biconnector-table-fields-update.md" + }, + "resultExample": { + "result": true, + "time": { + "start": 1725365418.056843, + "finish": 1725365419.671506, + "duration": 1.6146628856658936, + "processing": 1.3475170135498047, + "date_start": "2024-09-03T14:10:18+02:00", + "date_finish": "2024-09-03T14:10:19+02:00" + } + }, + "returns": [ + { + "name": "result", + "type": "boolean", + "base": "boolean", + "required": false, + "description": "Корневой элемент ответа. При успешном обновлении содержит true — нового состава колонок в ответе нет. Чтобы увидеть его, вызовите biconnector.table.get" + }, + { + "name": "time", + "type": "time", + "base": "object", + "required": false, + "description": "Информация о времени выполнения запроса" + } + ], + "page": "/api-reference/biconnector/table/biconnector-table-fields-update.html", + "executable": false +} diff --git a/_assets/simulator/spec/methods/biconnector.table.get.json b/_assets/simulator/spec/methods/biconnector.table.get.json new file mode 100644 index 000000000..78bd47b13 --- /dev/null +++ b/_assets/simulator/spec/methods/biconnector.table.get.json @@ -0,0 +1,125 @@ +{ + "$v": 1, + "method": "biconnector.table.get", + "scope": "biconnector", + "kind": "read", + "title": "Получить таблицу по id biconnector.table.get", + "permissions": "пользователь с правами «Доступ к BI Конструктору» и «Доступ к рабочему месту аналитика» одновременно", + "params": [ + { + "name": "id", + "type": "integer", + "base": "integer", + "required": true, + "description": "Идентификатор таблицы, можно получить методами biconnector.table.list и biconnector.table.add" + } + ], + "defs": {}, + "requiredConvention": true, + "confidence": "parsed", + "source": { + "file": "api-reference/biconnector/table/biconnector-table-get.md" + }, + "resultExample": { + "result": { + "item": { + "id": 27, + "type": "rest", + "name": "sales_orders", + "description": "Заказы из внешнего сервиса", + "externalCode": "sales_orders", + "externalName": "Sales orders", + "dateCreate": "2026-09-16 12:00:46", + "dateUpdate": null, + "createdById": 1, + "updatedById": 0, + "externalId": 0, + "csvDelimiter": "", + "csvEncoding": "", + "csvHasHeaders": false, + "fields": [ + { + "id": 43, + "datasetId": 27, + "type": "int", + "name": "ID", + "externalCode": "id", + "visible": true, + "description": "" + }, + { + "id": 45, + "datasetId": 27, + "type": "string", + "name": "CUSTOMER", + "externalCode": "customer", + "visible": true, + "description": "" + }, + { + "id": 47, + "datasetId": 27, + "type": "money", + "name": "AMOUNT", + "externalCode": "amount", + "visible": true, + "description": "" + }, + { + "id": 49, + "datasetId": 27, + "type": "date", + "name": "ORDER_DATE", + "externalCode": "order_date", + "visible": true, + "description": "" + } + ] + } + }, + "time": { + "start": 1789549489, + "finish": 1789549489.125967, + "duration": 0.12596702575683594, + "processing": 0, + "date_start": "2026-09-16T12:04:49+03:00", + "date_finish": "2026-09-16T12:04:49+03:00" + } + }, + "returns": [ + { + "name": "result", + "type": "object", + "base": "object", + "required": false, + "description": "Корневой элемент ответа. Содержит единственный ключ item с объектом table" + }, + { + "name": "time", + "type": "time", + "base": "object", + "required": false, + "description": "Информация о времени выполнения запроса" + } + ], + "page": "/api-reference/biconnector/table/biconnector-table-get.html", + "executable": false, + "entityFields": [ + "createdById", + "csvDelimiter", + "csvEncoding", + "csvHasHeaders", + "dateCreate", + "dateUpdate", + "description", + "externalCode", + "externalId", + "externalName", + "fields", + "id", + "name", + "sourceId", + "type", + "updatedById" + ] +} diff --git a/_assets/simulator/spec/methods/biconnector.table.list.json b/_assets/simulator/spec/methods/biconnector.table.list.json new file mode 100644 index 000000000..f5d5baa27 --- /dev/null +++ b/_assets/simulator/spec/methods/biconnector.table.list.json @@ -0,0 +1,110 @@ +{ + "$v": 1, + "method": "biconnector.table.list", + "scope": "biconnector", + "kind": "read", + "title": "Получить список таблиц biconnector.table.list", + "permissions": "пользователь с правами «Доступ к BI Конструктору» и «Доступ к рабочему месту аналитика» одновременно", + "params": [ + { + "name": "select", + "type": "string[]", + "base": "array", + "required": "unknown", + "description": "Список полей, которые должны быть заполнены у таблиц в выборке. Допустимые значения — названия полей из схемы метода biconnector.table.fields и *. По умолчанию берутся все поля. Поля csvDelimiter, csvEncoding и csvHasHeaders в схему не входят: в ответе они приходят, но в select вызовут ошибку VALIDATION_FIELD_NOT_ALLOWED_IN_SELECT.…", + "dynamic": { + "allowed": true, + "note": "Состав полей не описан подтаблицей на этой странице" + } + }, + { + "name": "filter", + "type": "object", + "base": "object", + "required": "unknown", + "description": "Фильтр для выборки таблиц. Пример формата: К ключам field_n можно добавить префикс, уточняющий работу фильтра. Возможные значения префикса: - >= — больше либо равно - > — больше - <= — меньше либо равно - < — меньше - @ — IN, в качестве значения передается массив - !@ — NOT IN, в качестве значения передается массив - % — LIKE, поиск по подстроке. Символ % в значении фильтра передавать не нужно.…", + "dynamic": { + "allowed": true, + "note": "Состав полей не описан подтаблицей на этой странице" + } + }, + { + "name": "order", + "type": "object", + "base": "object", + "required": "unknown", + "description": "Параметры сортировки. Пример формата: где: - field_n — название поля, по которому будет произведена сортировка выборки таблиц - value_n — значение типа string, равное: - ASC — сортировка по возрастанию - DESC — сортировка по убыванию Без этого параметра сортировка не применяется и порядок записей в выборке не гарантирован.…", + "dynamic": { + "allowed": true, + "note": "Состав полей не описан подтаблицей на этой странице" + } + }, + { + "name": "page", + "type": "integer", + "base": "integer", + "required": "unknown", + "description": "Номер страницы выборки, нумерация начинается с единицы, значение по умолчанию — 1. Размер страницы фиксированный — 50 записей. Нечисловое, нулевое или отрицательное значение ошибки не вызывает: метод молча отдает первую страницу.…" + } + ], + "defs": {}, + "requiredConvention": false, + "confidence": "parsed", + "source": { + "file": "api-reference/biconnector/table/biconnector-table-list.md" + }, + "resultExample": { + "result": [ + { + "id": 9, + "name": "sales_data_main", + "description": "Monthly sales report" + }, + { + "id": 6, + "name": "sales_data_first_filial", + "description": "Monthly sales report for first filial" + }, + { + "id": 5, + "name": "sales_data_second_filial", + "description": "Monthly sales report for second filial" + } + ], + "time": { + "start": 1743061675.963969, + "finish": 1743061676.064591, + "duration": 0.10062193870544434, + "processing": 0.011152029037475586, + "date_start": "2025-03-27T07:47:55+00:00", + "date_finish": "2025-03-27T07:47:56+00:00" + } + }, + "returns": [ + { + "name": "result", + "type": "array", + "base": "array", + "required": "unknown", + "description": "Корневой элемент ответа. Плоский массив таблиц без дополнительной обертки (подробное описание)" + }, + { + "name": "time", + "type": "time", + "base": "object", + "required": "unknown", + "description": "Информация о времени выполнения запроса" + } + ], + "page": "/api-reference/biconnector/table/biconnector-table-list.html", + "executable": false, + "entityFields": [ + "description", + "externalCode", + "externalName", + "fields", + "id", + "name", + "sourceId" + ] +} diff --git a/_assets/simulator/spec/methods/biconnector.table.update.json b/_assets/simulator/spec/methods/biconnector.table.update.json new file mode 100644 index 000000000..e539d03ab --- /dev/null +++ b/_assets/simulator/spec/methods/biconnector.table.update.json @@ -0,0 +1,77 @@ +{ + "$v": 1, + "method": "biconnector.table.update", + "scope": "biconnector", + "kind": "write", + "title": "Обновить таблицу biconnector.table.update", + "permissions": "пользователь с правами «Доступ к BI Конструктору» и «Доступ к рабочему месту аналитика» одновременно", + "params": [ + { + "name": "id", + "type": "integer", + "base": "integer", + "required": true, + "description": "Идентификатор таблицы, можно получить методами biconnector.table.list и biconnector.table.add" + }, + { + "name": "fields", + "type": "object", + "base": "object", + "required": true, + "description": "Объект, содержащий обновляемые данные. Формат объекта: - field_n — название поля - value_n — значение поля Подробное описание ниже", + "ref": "#/defs/fieldsFields" + } + ], + "defs": { + "fieldsFields": { + "dynamic": { + "allowed": false, + "ufAllowed": true, + "note": "Пользовательские поля UF_* в схеме не описаны" + }, + "fields": [ + { + "name": "description", + "type": "string", + "base": "string", + "required": false, + "description": "Описание таблицы" + } + ] + } + }, + "requiredConvention": true, + "confidence": "parsed", + "source": { + "file": "api-reference/biconnector/table/biconnector-table-update.md" + }, + "resultExample": { + "result": true, + "time": { + "start": 1725365418.056843, + "finish": 1725365419.671506, + "duration": 1.6146628856658936, + "processing": 1.3475170135498047, + "date_start": "2024-09-03T14:10:18+02:00", + "date_finish": "2024-09-03T14:10:19+02:00" + } + }, + "returns": [ + { + "name": "result", + "type": "boolean", + "base": "boolean", + "required": false, + "description": "Корневой элемент ответа. При успешном обновлении содержит true — объекта с данными таблицы в ответе нет. Чтобы увидеть новые значения полей, вызовите biconnector.table.get" + }, + { + "name": "time", + "type": "time", + "base": "object", + "required": false, + "description": "Информация о времени выполнения запроса" + } + ], + "page": "/api-reference/biconnector/table/biconnector-table-update.html", + "executable": false +} diff --git a/_assets/simulator/spec/methods/bizproc.event.send.json b/_assets/simulator/spec/methods/bizproc.event.send.json index 36883c6ad..27951a7bc 100644 --- a/_assets/simulator/spec/methods/bizproc.event.send.json +++ b/_assets/simulator/spec/methods/bizproc.event.send.json @@ -11,14 +11,14 @@ "type": "string", "base": "string", "required": true, - "description": "Специальный токен, который приходит на обработчик приложения, когда выполняется действие или робот. Значение этого токена обработчик получает в массиве входных данных. Отправить событие можно, если робот или действие зарегистрированы с 'USE_SUBSCRIPTION': 'Y'" + "description": "Токен запуска робота или действия. Битрикс24 передает его на обработчик приложения в поле event_token. Процесс примет результат, только если шаг с этим токеном еще ждет ответа. Ожидание включает параметр USE_SUBSCRIPTION: 'Y' при регистрации робота или действия. Если параметр не задали, по умолчанию шаг ответа не ждет, а включить ожидание можно в его настройках" }, { "name": "RETURN_VALUES", "type": "object", "base": "object", "required": false, - "description": "Массив возвращаемых значений действия или робота. Указываются значения свойств, которые были зарегистрированы как дополнительные результаты RETURN_PROPERTIES методами: - bizproc.robot.add, bizproc.robot.update - bizproc.activity.add, bizproc.activity.update", + "description": "Возвращаемые значения робота или действия. Ключи — коды параметров из RETURN_PROPERTIES, которые задали методами: - bizproc.robot.add, bizproc.robot.update - bizproc.activity.add, bizproc.activity.update Регистр ключей не важен. Значение Битрикс24 приводит к типу Type этого параметра. Ключи, которых нет в RETURN_PROPERTIES, Битрикс24 не сохранит", "dynamic": { "allowed": true, "note": "Состав полей не описан подтаблицей на этой странице" @@ -29,7 +29,7 @@ "type": "string", "base": "string", "required": false, - "description": "Текст для журнала бизнес-процесса. Если параметр не передать, метод отправит пустую строку. Запись событий в журнал должна быть включена в шаблоне бизнес-процесса" + "description": "Текст для журнала бизнес-процесса. Если параметр не передать, в журнал попадет стандартная запись «Получен ответ от приложения». Запись событий в журнал должна быть включена в шаблоне бизнес-процесса" } ], "defs": {}, @@ -57,7 +57,7 @@ "type": "boolean", "base": "boolean", "required": false, - "description": "Возвращает true, если значения успешно переданы в процесс" + "description": "true, если Битрикс24 принял запрос. Это не подтверждает, что процесс применил значения" }, { "name": "time", diff --git a/_assets/simulator/spec/methods/bizproc.robot.add.json b/_assets/simulator/spec/methods/bizproc.robot.add.json index f3513545d..328b909bd 100644 --- a/_assets/simulator/spec/methods/bizproc.robot.add.json +++ b/_assets/simulator/spec/methods/bizproc.robot.add.json @@ -11,28 +11,28 @@ "type": "string", "base": "string", "required": true, - "description": "Внутренний идентификатор робота. Является уникальным в рамках приложения. Допустимые символы — a-z, A-Z, 0-9, точка, дефис и нижнее подчеркивание _" + "description": "Внутренний идентификатор робота. Уникален среди роботов и действий приложения: если у приложения уже есть действие с таким CODE, метод вернет ошибку ERROR_ACTIVITY_ALREADY_INSTALLED. Допустимые символы — a-z, A-Z, 0-9, точка, дефис и нижнее подчеркивание _" }, { "name": "HANDLER", "type": "string", "base": "string", "required": true, - "description": "URL, на который робот будет отправлять данные через сервер очередей bitrix24. В ссылке должен быть тот же домен, на котором установлено приложение" + "description": "Адрес обработчика, на который Битрикс24 отправляет данные робота через сервер очередей. Он должен начинаться с http:// или https://, а имя хоста — содержать точку, например https://example.com/robot.php" }, { "name": "AUTH_USER_ID", "type": "integer", "base": "integer", "required": false, - "description": "Идентификатор пользователя, токен которого будет передан приложению" + "description": "Идентификатор пользователя, токен которого Битрикс24 передаст обработчику по умолчанию. Администратор может выбрать другого пользователя в настройках робота. Если параметр не передать, пользователь не задан" }, { "name": "USE_SUBSCRIPTION", "type": "boolean", "base": "boolean", "required": false, - "description": "Должен ли робот ожидать ответа от приложения. Возможные значения: - Y — да - N — нет По умолчанию параметр пустой, что равнозначно ожиданию ответа приложения. Робот не ожидает ответа только при явном значении N", + "description": "Должен ли робот ожидать ответа от приложения. Возможные значения: - Y — да - N — нет Если параметр не передать, по умолчанию робот ответа не ждет, а включить ожидание можно в его настройках. Значение Y включает ожидание для всех запусков робота, N — отключает", "values": [ { "value": "Y", @@ -40,7 +40,7 @@ }, { "value": "N", - "title": "нет По умолчанию параметр пустой, что равнозначно ожиданию ответа приложения" + "title": "нет Если параметр не передать, по умолчанию робот ответа не ждет, а включить ожи" } ] }, @@ -74,7 +74,7 @@ "type": "object", "base": "object", "required": false, - "description": "Объект с дополнительными результатами робота. Содержит объекты, каждый из которых описывает параметр робота. Параметр управляет возможностью робота ожидать ответа приложения и работать с данными, которые придут в ответе. Системное название параметра должно начинаться с буквы и может содержать символы a-z, A-Z, 0-9 и нижнее подчеркивание _", + "description": "Объект с дополнительными результатами робота. Содержит объекты, каждый из которых описывает параметр робота. Значения этих параметров приложение возвращает методом bizproc.event.send, и они становятся доступны следующим шагам. Ждать ли ответа, задает параметр USE_SUBSCRIPTION. Системное название параметра должно начинаться с буквы и может содержать символы a-z, A-Z, 0-9 и нижнее подчеркивание _", "dynamic": { "allowed": true, "note": "Состав полей не описан подтаблицей на этой странице" @@ -107,7 +107,7 @@ "type": "boolean", "base": "boolean", "required": false, - "description": "Дает возможность открывать дополнительные настройки робота в слайдере приложения. Возможные значения: - Y — да - N — нет", + "description": "Дает возможность открывать дополнительные настройки робота в слайдере приложения. Возможные значения: - Y — да - N — нет По умолчанию N", "values": [ { "value": "Y", @@ -115,7 +115,7 @@ }, { "value": "N", - "title": "нет" + "title": "нет По умолчанию N" } ] }, @@ -124,7 +124,7 @@ "type": "string", "base": "string", "required": false, - "description": "URL обработчика встройки на стороне приложения. Обязательное, если USE_PLACEMENT = 'Y'" + "description": "URL обработчика встройки на стороне приложения. Обязательное, если USE_PLACEMENT = 'Y'. Проверяется так же, как HANDLER. У каждого робота и действия приложения должен быть свой адрес" } ], "defs": {}, diff --git a/_assets/simulator/spec/methods/bizproc.robot.delete.json b/_assets/simulator/spec/methods/bizproc.robot.delete.json index bda7c15dc..01c3d624a 100644 --- a/_assets/simulator/spec/methods/bizproc.robot.delete.json +++ b/_assets/simulator/spec/methods/bizproc.robot.delete.json @@ -11,7 +11,7 @@ "type": "string", "base": "string", "required": true, - "description": "Символьный идентификатор робота приложения" + "description": "Код робота, который это приложение передало в CODE при регистрации. Получить коды можно методом bizproc.robot.list" } ], "defs": {}, diff --git a/_assets/simulator/spec/methods/bizproc.robot.list.json b/_assets/simulator/spec/methods/bizproc.robot.list.json index 97e87bf18..3620c7de0 100644 --- a/_assets/simulator/spec/methods/bizproc.robot.list.json +++ b/_assets/simulator/spec/methods/bizproc.robot.list.json @@ -11,7 +11,7 @@ "type": "array", "base": "array", "required": "unknown", - "description": "Список идентификаторов роботов приложения", + "description": "Коды CODE роботов, которые зарегистрировало это приложение. Если роботов нет, приходит пустой массив []", "dynamic": { "allowed": true, "note": "Состав полей не описан подтаблицей на этой странице" @@ -57,7 +57,7 @@ "type": "array", "base": "array", "required": "unknown", - "description": "Список идентификаторов роботов приложения" + "description": "Коды CODE роботов, которые зарегистрировало это приложение. Если роботов нет, приходит пустой массив []" }, { "name": "time", diff --git a/_assets/simulator/spec/methods/bizproc.robot.update.json b/_assets/simulator/spec/methods/bizproc.robot.update.json index 8930c1fce..bdb988d03 100644 --- a/_assets/simulator/spec/methods/bizproc.robot.update.json +++ b/_assets/simulator/spec/methods/bizproc.robot.update.json @@ -11,7 +11,7 @@ "type": "string", "base": "string", "required": true, - "description": "Внутренний идентификатор робота" + "description": "Код робота, который это приложение передало в CODE при регистрации. Получить коды можно методом bizproc.robot.list" }, { "name": "FIELDS", @@ -35,14 +35,14 @@ "type": "string", "base": "string", "required": false, - "description": "URL, на который робот будет отправлять данные через сервер очередей bitrix24. В ссылке должен быть тот же домен, на котором установлено приложение" + "description": "Адрес обработчика, на который Битрикс24 отправляет данные робота через сервер очередей. Он должен начинаться с http:// или https://, а имя хоста — содержать точку, например https://example.com/robot.php" }, { "name": "AUTH_USER_ID", "type": "integer", "base": "integer", "required": false, - "description": "Идентификатор пользователя, токен которого будет передан приложению" + "description": "Идентификатор пользователя, токен которого Битрикс24 передаст обработчику по умолчанию. Администратор может выбрать другого пользователя в настройках робота" }, { "name": "USE_SUBSCRIPTION", @@ -87,7 +87,7 @@ "type": "object", "base": "object", "required": false, - "description": "Объект с дополнительными результатами робота. Содержит объекты, каждый из которых описывает параметр робота. Параметр управляет возможностью робота ожидать ответа приложения и работать с данными, которые придут в ответе. Системное название параметра должно начинаться с буквы и может содержать символы a-z, A-Z, 0-9 и нижнее подчеркивание _" + "description": "Объект с дополнительными результатами робота. Содержит объекты, каждый из которых описывает параметр робота. Значения этих параметров приложение возвращает методом bizproc.event.send, и они становятся доступны следующим шагам. Ждать ли ответа, задает параметр USE_SUBSCRIPTION. Системное название параметра должно начинаться с буквы и может содержать символы a-z, A-Z, 0-9 и нижнее подчеркивание _" }, { "name": "DOCUMENT_TYPE", @@ -125,7 +125,7 @@ "type": "string", "base": "string", "required": false, - "description": "URL обработчика встройки на стороне приложения" + "description": "URL обработчика встройки на стороне приложения. Проверяется так же, как HANDLER. Чтобы включить встройку, передайте адрес вместе с USE_PLACEMENT: 'Y'. Значение USE_PLACEMENT: 'N' удаляет регистрацию обработчика, поэтому при повторном включении адрес нужно передать снова" } ] } diff --git a/_assets/simulator/spec/methods/bizproc.task.complete.json b/_assets/simulator/spec/methods/bizproc.task.complete.json index 7001b8cfa..d732ad657 100644 --- a/_assets/simulator/spec/methods/bizproc.task.complete.json +++ b/_assets/simulator/spec/methods/bizproc.task.complete.json @@ -75,5 +75,14 @@ } ], "page": "/api-reference/bizproc/bizproc-task/bizproc-task-complete.html", - "executable": false + "executable": false, + "requestExample": { + "TASK_ID": 1501, + "STATUS": 3, + "COMMENT": "Добавлено", + "FIELDS": { + "contractor": "C_607", + "phone_number": "89991234567" + } + } } diff --git a/_assets/simulator/spec/methods/bizproc.task.delegate.json b/_assets/simulator/spec/methods/bizproc.task.delegate.json index f49b53594..ba2392ef2 100644 --- a/_assets/simulator/spec/methods/bizproc.task.delegate.json +++ b/_assets/simulator/spec/methods/bizproc.task.delegate.json @@ -68,5 +68,14 @@ } ], "page": "/api-reference/bizproc/bizproc-task/bizproc-task-delegate.html", - "executable": false + "executable": false, + "requestExample": { + "TASK_IDS": [ + 1128, + 1129, + 1130 + ], + "FROM_USER_ID": 15, + "TO_USER_ID": 37 + } } diff --git a/_assets/simulator/spec/methods/bizproc.workflow.start.json b/_assets/simulator/spec/methods/bizproc.workflow.start.json index adfbc48a8..3c3fb23cc 100644 --- a/_assets/simulator/spec/methods/bizproc.workflow.start.json +++ b/_assets/simulator/spec/methods/bizproc.workflow.start.json @@ -59,5 +59,16 @@ } ], "page": "/api-reference/bizproc/bizproc-workflow-start.html", - "executable": false + "executable": false, + "requestExample": { + "TEMPLATE_ID": 1, + "DOCUMENT_ID": [ + "crm", + "CCrmDocumentLead", + "LEAD_1" + ], + "PARAMETERS": { + "Parameter1": "user_1" + } + } } diff --git a/_assets/simulator/spec/methods/bizproc.workflow.terminate.json b/_assets/simulator/spec/methods/bizproc.workflow.terminate.json index ab66b839d..4ab8e1ce1 100644 --- a/_assets/simulator/spec/methods/bizproc.workflow.terminate.json +++ b/_assets/simulator/spec/methods/bizproc.workflow.terminate.json @@ -44,5 +44,9 @@ } ], "page": "/api-reference/bizproc/bizproc-workflow-terminate.html", - "executable": false + "executable": false, + "requestExample": { + "ID": "65e5a449e8f135.21284909", + "STATUS": "Terminated by rest app." + } } diff --git a/_assets/simulator/spec/methods/booking.v1.booking.add.json b/_assets/simulator/spec/methods/booking.v1.booking.add.json index 09aeb1f08..c658f8527 100644 --- a/_assets/simulator/spec/methods/booking.v1.booking.add.json +++ b/_assets/simulator/spec/methods/booking.v1.booking.add.json @@ -90,5 +90,26 @@ } ], "page": "/api-reference/booking/booking/booking-v1-booking-add.html", - "executable": false + "executable": false, + "requestExample": { + "fields": { + "name": "Название", + "description": "Описание", + "resourceIds": [ + 1, + 2, + 3 + ], + "datePeriod": { + "from": { + "timestamp": 1723446900, + "timezone": "Europe/Moscow" + }, + "to": { + "timestamp": 1723447800, + "timezone": "Europe/Moscow" + } + } + } + } } diff --git a/_assets/simulator/spec/methods/booking.v1.booking.client.list.json b/_assets/simulator/spec/methods/booking.v1.booking.client.list.json index d9c9d699d..a8f38a3cb 100644 --- a/_assets/simulator/spec/methods/booking.v1.booking.client.list.json +++ b/_assets/simulator/spec/methods/booking.v1.booking.client.list.json @@ -70,5 +70,8 @@ "entityFields": [ "id", "type" - ] + ], + "requestExample": { + "bookingId": 123 + } } diff --git a/_assets/simulator/spec/methods/booking.v1.booking.client.set.json b/_assets/simulator/spec/methods/booking.v1.booking.client.set.json index 7a14baaeb..089931691 100644 --- a/_assets/simulator/spec/methods/booking.v1.booking.client.set.json +++ b/_assets/simulator/spec/methods/booking.v1.booking.client.set.json @@ -91,5 +91,24 @@ } ], "page": "/api-reference/booking/booking/client/booking-v1-booking-client-set.html", - "executable": false + "executable": false, + "requestExample": { + "bookingId": 14, + "clients": [ + { + "id": 1, + "type": { + "module": "crm", + "code": "CONTACT" + } + }, + { + "id": 2, + "type": { + "module": "crm", + "code": "CONTACT" + } + } + ] + } } diff --git a/_assets/simulator/spec/methods/booking.v1.booking.client.unset.json b/_assets/simulator/spec/methods/booking.v1.booking.client.unset.json index 74c84be97..e95d405ac 100644 --- a/_assets/simulator/spec/methods/booking.v1.booking.client.unset.json +++ b/_assets/simulator/spec/methods/booking.v1.booking.client.unset.json @@ -49,5 +49,8 @@ } ], "page": "/api-reference/booking/booking/client/booking-v1-booking-client-unset.html", - "executable": false + "executable": false, + "requestExample": { + "bookingId": 14 + } } diff --git a/_assets/simulator/spec/methods/booking.v1.booking.createfromwaitlist.json b/_assets/simulator/spec/methods/booking.v1.booking.createfromwaitlist.json index 4d81c00b0..51be654ae 100644 --- a/_assets/simulator/spec/methods/booking.v1.booking.createfromwaitlist.json +++ b/_assets/simulator/spec/methods/booking.v1.booking.createfromwaitlist.json @@ -17,7 +17,7 @@ "name": "fields", "type": "object", "base": "object", - "required": false, + "required": true, "description": "Объект, содержащий значения полей для создания бронирования (подробное описание)", "ref": "#/defs/fieldsFields" } @@ -37,20 +37,6 @@ "required": true, "description": "Массив идентификаторов ресурсов для брони. ID ресурсов можно получить методом booking.v1.resource.list" }, - { - "name": "name", - "type": "string", - "base": "string", - "required": false, - "description": "Название бронирования. Значение по умолчанию — пустая строка" - }, - { - "name": "description", - "type": "string", - "base": "string", - "required": false, - "description": "Описание бронирования. Значение по умолчанию — пустая строка" - }, { "name": "datePeriod", "type": "object", @@ -95,5 +81,25 @@ } ], "page": "/api-reference/booking/booking/booking-v1-booking-createfromwaitlist.html", - "executable": false + "executable": false, + "requestExample": { + "waitListId": 10, + "fields": { + "resourceIds": [ + 1, + 2, + 3 + ], + "datePeriod": { + "from": { + "timestamp": 1723446900, + "timezone": "Europe/Moscow" + }, + "to": { + "timestamp": 1723447800, + "timezone": "Europe/Moscow" + } + } + } + } } diff --git a/_assets/simulator/spec/methods/booking.v1.booking.delete.json b/_assets/simulator/spec/methods/booking.v1.booking.delete.json index 08819fb7b..9a92155ff 100644 --- a/_assets/simulator/spec/methods/booking.v1.booking.delete.json +++ b/_assets/simulator/spec/methods/booking.v1.booking.delete.json @@ -49,5 +49,8 @@ } ], "page": "/api-reference/booking/booking/booking-v1-booking-delete.html", - "executable": false + "executable": false, + "requestExample": { + "id": 15 + } } diff --git a/_assets/simulator/spec/methods/booking.v1.booking.externalData.list.json b/_assets/simulator/spec/methods/booking.v1.booking.externalData.list.json index f796de9e0..4ab752d0b 100644 --- a/_assets/simulator/spec/methods/booking.v1.booking.externalData.list.json +++ b/_assets/simulator/spec/methods/booking.v1.booking.externalData.list.json @@ -35,6 +35,7 @@ } ] }, + "total": 0, "time": { "start": 1724068028.331234, "finish": 1724068028.726591, @@ -53,6 +54,13 @@ "required": false, "description": "Корневой элемент ответа. Содержит массив объектов с информацией о связях. Структура описана ниже" }, + { + "name": "total", + "type": "integer", + "base": "integer", + "required": false, + "description": "Служебный ключ. Всегда содержит 0 и не показывает количество связей" + }, { "name": "time", "type": "time", @@ -67,5 +75,8 @@ "entityTypeId", "moduleId", "value" - ] + ], + "requestExample": { + "bookingId": 123 + } } diff --git a/_assets/simulator/spec/methods/booking.v1.booking.externalData.set.json b/_assets/simulator/spec/methods/booking.v1.booking.externalData.set.json index 5e5ad0492..4df039d44 100644 --- a/_assets/simulator/spec/methods/booking.v1.booking.externalData.set.json +++ b/_assets/simulator/spec/methods/booking.v1.booking.externalData.set.json @@ -18,7 +18,7 @@ "type": "array", "base": "array", "required": true, - "description": "Массив объектов, содержащий объекты для привязки (подробное описание)", + "description": "Полный набор связей бронирования. Новое значение заменяет все существующие связи. Пустой массив удаляет все связи. Структура объектов описана ниже", "ref": "#/defs/externalDataFields" } ], @@ -88,5 +88,15 @@ } ], "page": "/api-reference/booking/booking/external-data/booking-v1-booking-externaldata-set.html", - "executable": false + "executable": false, + "requestExample": { + "bookingId": 14, + "externalData": [ + { + "moduleId": "crm", + "entityTypeId": "DEAL", + "value": "1" + } + ] + } } diff --git a/_assets/simulator/spec/methods/booking.v1.booking.externalData.unset.json b/_assets/simulator/spec/methods/booking.v1.booking.externalData.unset.json index f3c0cf756..3225fcf83 100644 --- a/_assets/simulator/spec/methods/booking.v1.booking.externalData.unset.json +++ b/_assets/simulator/spec/methods/booking.v1.booking.externalData.unset.json @@ -49,5 +49,8 @@ } ], "page": "/api-reference/booking/booking/external-data/booking-v1-booking-externaldata-unset.html", - "executable": false + "executable": false, + "requestExample": { + "bookingId": 14 + } } diff --git a/_assets/simulator/spec/methods/booking.v1.booking.get.json b/_assets/simulator/spec/methods/booking.v1.booking.get.json index db125c849..0a1287769 100644 --- a/_assets/simulator/spec/methods/booking.v1.booking.get.json +++ b/_assets/simulator/spec/methods/booking.v1.booking.get.json @@ -76,5 +76,8 @@ "id", "name", "resourceIds" - ] + ], + "requestExample": { + "id": 15 + } } diff --git a/_assets/simulator/spec/methods/booking.v1.booking.list.json b/_assets/simulator/spec/methods/booking.v1.booking.list.json index 1e3d6d52c..b7de4228a 100644 --- a/_assets/simulator/spec/methods/booking.v1.booking.list.json +++ b/_assets/simulator/spec/methods/booking.v1.booking.list.json @@ -7,7 +7,7 @@ "permissions": "любой пользователь", "params": [ { - "name": "ORDER", + "name": "order", "type": "object", "base": "object", "required": "unknown", @@ -16,6 +16,13 @@ "allowed": true, "note": "Состав полей не описан подтаблицей на этой странице" } + }, + { + "name": "start", + "type": "integer", + "base": "integer", + "required": "unknown", + "description": "Смещение для постраничной выборки. Размер страницы — 50 записей. Передавайте 0 для первой страницы, 50 для второй, 100 для третьей и так далее. Значение по умолчанию — 0" } ], "defs": {}, diff --git a/_assets/simulator/spec/methods/booking.v1.booking.update.json b/_assets/simulator/spec/methods/booking.v1.booking.update.json index 30937dff8..ff43cc739 100644 --- a/_assets/simulator/spec/methods/booking.v1.booking.update.json +++ b/_assets/simulator/spec/methods/booking.v1.booking.update.json @@ -95,5 +95,27 @@ } ], "page": "/api-reference/booking/booking/booking-v1-booking-update.html", - "executable": false + "executable": false, + "requestExample": { + "id": 10, + "fields": { + "name": "Название", + "description": "Описание", + "resourceIds": [ + 1, + 2, + 3 + ], + "datePeriod": { + "from": { + "timestamp": 1723446900, + "timezone": "Europe/Moscow" + }, + "to": { + "timestamp": 1723447800, + "timezone": "Europe/Moscow" + } + } + } + } } diff --git a/_assets/simulator/spec/methods/booking.v1.clienttype.list.json b/_assets/simulator/spec/methods/booking.v1.clienttype.list.json index 5e6833e22..e95586266 100644 --- a/_assets/simulator/spec/methods/booking.v1.clienttype.list.json +++ b/_assets/simulator/spec/methods/booking.v1.clienttype.list.json @@ -11,7 +11,7 @@ "type": "object", "base": "object", "required": "unknown", - "description": "Объект, содержащий список типов клиентов", + "description": "Корневой элемент ответа (подробное описание)", "dynamic": { "allowed": true, "note": "Состав полей не описан подтаблицей на этой странице" @@ -64,7 +64,7 @@ "type": "object", "base": "object", "required": "unknown", - "description": "Объект, содержащий список типов клиентов" + "description": "Корневой элемент ответа (подробное описание)" }, { "name": "time", @@ -79,5 +79,6 @@ "entityFields": [ "code", "module" - ] + ], + "requestExample": {} } diff --git a/_assets/simulator/spec/methods/booking.v1.resource.add.json b/_assets/simulator/spec/methods/booking.v1.resource.add.json index 7b945e1a3..71f9ea75e 100644 --- a/_assets/simulator/spec/methods/booking.v1.resource.add.json +++ b/_assets/simulator/spec/methods/booking.v1.resource.add.json @@ -363,5 +363,31 @@ } ], "page": "/api-reference/booking/resource/booking-v1-resource-add.html", - "executable": false + "executable": false, + "requestExample": { + "fields": { + "name": "Название", + "description": "Описание", + "typeId": 1, + "isMain": "N", + "isInfoNotificationOn": "Y", + "templateTypeInfo": "inanimate", + "isConfirmationNotificationOn": "Y", + "templateTypeConfirmation": "animate", + "isReminderNotificationOn": "N", + "templateTypeReminder": "base", + "isFeedbackNotificationOn": "Y", + "templateTypeFeedback": "inanimate", + "isDelayedNotificationOn": "Y", + "templateTypeDelayed": "inanimate", + "infoNotificationDelay": 60, + "reminderNotificationDelay": -1, + "delayedNotificationDelay": 300, + "delayedCounterDelay": 7200, + "confirmationNotificationDelay": 86400, + "confirmationNotificationRepetitions": 1, + "confirmationNotificationRepetitionsInterval": 3600, + "confirmationCounterDelay": 7200 + } + } } diff --git a/_assets/simulator/spec/methods/booking.v1.resource.delete.json b/_assets/simulator/spec/methods/booking.v1.resource.delete.json index bdef1e4c3..61b26c603 100644 --- a/_assets/simulator/spec/methods/booking.v1.resource.delete.json +++ b/_assets/simulator/spec/methods/booking.v1.resource.delete.json @@ -49,5 +49,8 @@ } ], "page": "/api-reference/booking/resource/booking-v1-resource-delete.html", - "executable": false + "executable": false, + "requestExample": { + "id": 15 + } } diff --git a/_assets/simulator/spec/methods/booking.v1.resource.get.json b/_assets/simulator/spec/methods/booking.v1.resource.get.json index 03a2fb94d..3b33ba9bc 100644 --- a/_assets/simulator/spec/methods/booking.v1.resource.get.json +++ b/_assets/simulator/spec/methods/booking.v1.resource.get.json @@ -107,5 +107,8 @@ "templateTypeInfo", "templateTypeReminder", "typeId" - ] + ], + "requestExample": { + "id": 15 + } } diff --git a/_assets/simulator/spec/methods/booking.v1.resource.list.json b/_assets/simulator/spec/methods/booking.v1.resource.list.json index ab38b8956..dd792c4ba 100644 --- a/_assets/simulator/spec/methods/booking.v1.resource.list.json +++ b/_assets/simulator/spec/methods/booking.v1.resource.list.json @@ -167,5 +167,17 @@ "templateTypeInfo", "templateTypeReminder", "typeId" - ] + ], + "requestExample": { + "filter": { + "searchQuery": "авто", + "typeId": [ + 3, + 7 + ] + }, + "order": { + "id": "ASC" + } + } } diff --git a/_assets/simulator/spec/methods/booking.v1.resource.slots.list.json b/_assets/simulator/spec/methods/booking.v1.resource.slots.list.json index fae359de3..cb06becf0 100644 --- a/_assets/simulator/spec/methods/booking.v1.resource.slots.list.json +++ b/_assets/simulator/spec/methods/booking.v1.resource.slots.list.json @@ -82,5 +82,8 @@ "timezone", "to", "weekDays" - ] + ], + "requestExample": { + "resourceId": 15 + } } diff --git a/_assets/simulator/spec/methods/booking.v1.resource.slots.set.json b/_assets/simulator/spec/methods/booking.v1.resource.slots.set.json index a5f341c68..9510e12c5 100644 --- a/_assets/simulator/spec/methods/booking.v1.resource.slots.set.json +++ b/_assets/simulator/spec/methods/booking.v1.resource.slots.set.json @@ -132,5 +132,23 @@ } ], "page": "/api-reference/booking/resource/slots/booking-v1-resource-slots-set.html", - "executable": false + "executable": false, + "requestExample": { + "resourceId": 15, + "slots": [ + { + "from": 540, + "to": 1080, + "timezone": "Europe/Kaliningrad", + "weekDays": [ + "Mon", + "Tue", + "Wed", + "Thu", + "Fri" + ], + "slotSize": 30 + } + ] + } } diff --git a/_assets/simulator/spec/methods/booking.v1.resource.slots.unset.json b/_assets/simulator/spec/methods/booking.v1.resource.slots.unset.json index d7eb1b3dc..b16b5c472 100644 --- a/_assets/simulator/spec/methods/booking.v1.resource.slots.unset.json +++ b/_assets/simulator/spec/methods/booking.v1.resource.slots.unset.json @@ -49,5 +49,8 @@ } ], "page": "/api-reference/booking/resource/slots/booking-v1-resource-slots-unset.html", - "executable": false + "executable": false, + "requestExample": { + "resourceId": 15 + } } diff --git a/_assets/simulator/spec/methods/booking.v1.resource.update.json b/_assets/simulator/spec/methods/booking.v1.resource.update.json index b4643ab46..f5ecd4b77 100644 --- a/_assets/simulator/spec/methods/booking.v1.resource.update.json +++ b/_assets/simulator/spec/methods/booking.v1.resource.update.json @@ -370,5 +370,32 @@ } ], "page": "/api-reference/booking/resource/booking-v1-resource-update.html", - "executable": false + "executable": false, + "requestExample": { + "id": 10, + "fields": { + "name": "Новое название", + "description": "Новое описание", + "typeId": 1, + "isMain": "N", + "isInfoNotificationOn": "Y", + "templateTypeInfo": "inanimate", + "isConfirmationNotificationOn": "Y", + "templateTypeConfirmation": "animate", + "isReminderNotificationOn": "Y", + "templateTypeReminder": "base", + "isFeedbackNotificationOn": "N", + "templateTypeFeedback": "animate", + "isDelayedNotificationOn": "N", + "templateTypeDelayed": "animate", + "infoNotificationDelay": 300, + "reminderNotificationDelay": -1, + "delayedNotificationDelay": 300, + "delayedCounterDelay": 7200, + "confirmationNotificationDelay": 86400, + "confirmationNotificationRepetitions": 0, + "confirmationNotificationRepetitionsInterval": 0, + "confirmationCounterDelay": 7200 + } + } } diff --git a/_assets/simulator/spec/methods/booking.v1.resourceType.add.json b/_assets/simulator/spec/methods/booking.v1.resourceType.add.json index 9c9532d2b..8092c9a26 100644 --- a/_assets/simulator/spec/methods/booking.v1.resourceType.add.json +++ b/_assets/simulator/spec/methods/booking.v1.resourceType.add.json @@ -319,5 +319,28 @@ } ], "page": "/api-reference/booking/resource/resource-type/booking-v1-resourcetype-add.html", - "executable": false + "executable": false, + "requestExample": { + "fields": { + "name": "Название", + "code": "meeting-room", + "isInfoNotificationOn": "Y", + "isConfirmationNotificationOn": "Y", + "templateTypeConfirmation": "animate", + "isReminderNotificationOn": "N", + "templateTypeReminder": "base", + "isFeedbackNotificationOn": "Y", + "templateTypeFeedback": "inanimate", + "isDelayedNotificationOn": "Y", + "templateTypeDelayed": "inanimate", + "infoNotificationDelay": 300, + "reminderNotificationDelay": -1, + "delayedNotificationDelay": 300, + "delayedCounterDelay": 7200, + "confirmationNotificationDelay": 86400, + "confirmationNotificationRepetitions": 0, + "confirmationNotificationRepetitionsInterval": 0, + "confirmationCounterDelay": 7200 + } + } } diff --git a/_assets/simulator/spec/methods/booking.v1.resourceType.delete.json b/_assets/simulator/spec/methods/booking.v1.resourceType.delete.json index eb4f99474..9c28352f8 100644 --- a/_assets/simulator/spec/methods/booking.v1.resourceType.delete.json +++ b/_assets/simulator/spec/methods/booking.v1.resourceType.delete.json @@ -49,5 +49,8 @@ } ], "page": "/api-reference/booking/resource/resource-type/booking-v1-resourcetype-delete.html", - "executable": false + "executable": false, + "requestExample": { + "id": 15 + } } diff --git a/_assets/simulator/spec/methods/booking.v1.resourceType.get.json b/_assets/simulator/spec/methods/booking.v1.resourceType.get.json index 6e07b611c..d33d4c419 100644 --- a/_assets/simulator/spec/methods/booking.v1.resourceType.get.json +++ b/_assets/simulator/spec/methods/booking.v1.resourceType.get.json @@ -101,5 +101,8 @@ "templateTypeDelayed", "templateTypeFeedback", "templateTypeReminder" - ] + ], + "requestExample": { + "id": 15 + } } diff --git a/_assets/simulator/spec/methods/booking.v1.resourceType.list.json b/_assets/simulator/spec/methods/booking.v1.resourceType.list.json index 400548d3f..9a36e3fb0 100644 --- a/_assets/simulator/spec/methods/booking.v1.resourceType.list.json +++ b/_assets/simulator/spec/methods/booking.v1.resourceType.list.json @@ -158,5 +158,15 @@ "templateTypeDelayed", "templateTypeFeedback", "templateTypeReminder" - ] + ], + "requestExample": { + "filter": { + "moduleId": "booking" + }, + "order": { + "id": "ASC", + "name": "DESC", + "code": "DESC" + } + } } diff --git a/_assets/simulator/spec/methods/booking.v1.resourceType.update.json b/_assets/simulator/spec/methods/booking.v1.resourceType.update.json index 0086cfa05..c1c7d6cd2 100644 --- a/_assets/simulator/spec/methods/booking.v1.resourceType.update.json +++ b/_assets/simulator/spec/methods/booking.v1.resourceType.update.json @@ -325,5 +325,29 @@ } ], "page": "/api-reference/booking/resource/resource-type/booking-v1-resourcetype-update.html", - "executable": false + "executable": false, + "requestExample": { + "id": 10, + "fields": { + "name": "Новое название", + "code": "updated-code", + "isInfoNotificationOn": "Y", + "isConfirmationNotificationOn": "Y", + "templateTypeConfirmation": "animate", + "isReminderNotificationOn": "Y", + "templateTypeReminder": "base", + "isFeedbackNotificationOn": "N", + "templateTypeFeedback": "animate", + "isDelayedNotificationOn": "N", + "templateTypeDelayed": "animate", + "infoNotificationDelay": 300, + "reminderNotificationDelay": -1, + "delayedNotificationDelay": 300, + "delayedCounterDelay": 7200, + "confirmationNotificationDelay": 86400, + "confirmationNotificationRepetitions": 0, + "confirmationNotificationRepetitionsInterval": 0, + "confirmationCounterDelay": 7200 + } + } } diff --git a/_assets/simulator/spec/methods/booking.v1.waitlist.add.json b/_assets/simulator/spec/methods/booking.v1.waitlist.add.json index 7e4a20a95..51a4a73f3 100644 --- a/_assets/simulator/spec/methods/booking.v1.waitlist.add.json +++ b/_assets/simulator/spec/methods/booking.v1.waitlist.add.json @@ -27,7 +27,7 @@ "name": "note", "type": "string", "base": "string", - "required": true, + "required": false, "description": "Заметка к записи в лист ожидания. Значение по умолчанию — пустая строка" } ] @@ -39,9 +39,7 @@ "file": "api-reference/booking/waitlist/booking-v1-waitlist-add.md" }, "resultExample": { - "result": { - "id": 107 - }, + "result": 7, "time": { "start": 1724068028.331234, "finish": 1724068028.726591, @@ -69,5 +67,10 @@ } ], "page": "/api-reference/booking/waitlist/booking-v1-waitlist-add.html", - "executable": false + "executable": false, + "requestExample": { + "fields": { + "note": "Заметка" + } + } } diff --git a/_assets/simulator/spec/methods/booking.v1.waitlist.client.list.json b/_assets/simulator/spec/methods/booking.v1.waitlist.client.list.json index ea7b13c47..701561825 100644 --- a/_assets/simulator/spec/methods/booking.v1.waitlist.client.list.json +++ b/_assets/simulator/spec/methods/booking.v1.waitlist.client.list.json @@ -3,7 +3,7 @@ "method": "booking.v1.waitlist.client.list", "scope": "booking", "kind": "read", - "title": "Получить список клиентов записи в лист ожидания booking.v1.waitlist.client.list", + "title": "Получить клиентов записи в листе ожидания booking.v1.waitlist.client.list", "permissions": "любой пользователь", "params": [ { @@ -11,7 +11,7 @@ "type": "integer", "base": "integer", "required": true, - "description": "Идентификатор записи в лист ожидания. Можно получить методами booking.v1.waitlist.add и booking.v1.waitlist.list" + "description": "Идентификатор записи в листе ожидания. Можно получить методами booking.v1.waitlist.add и booking.v1.waitlist.list" } ], "defs": {}, @@ -24,28 +24,30 @@ "result": { "waitListClient": [ { - "id": 1, + "id": 2795, "type": { - "code": "COMPANY", + "code": "CONTACT", "module": "crm" } }, { - "id": 2, + "id": 3063, "type": { - "code": "CONTACT", + "code": "COMPANY", "module": "crm" } } ] }, + "total": 0, "time": { - "start": 1724068028.331234, - "finish": 1724068028.726591, - "duration": 0.3953571319580078, - "processing": 0.13033390045166016, - "date_start": "2025-01-21T13:47:08+02:00", - "date_finish": "2025-01-21T13:47:08+02:00", + "start": 1790294537, + "finish": 1790294537.508353, + "duration": 0.5083529949188232, + "processing": 0, + "date_start": "2026-09-25T03:02:17+03:00", + "date_finish": "2026-09-25T03:02:17+03:00", + "operating_reset_at": 1790295137, "operating": 0 } }, @@ -55,7 +57,14 @@ "type": "object", "base": "object", "required": false, - "description": "Корневой элемент ответа. Содержит массив объектов с информацией о клиентах. Структура описана ниже" + "description": "Объект с массивом waitListClient. Структура объекта" + }, + { + "name": "total", + "type": "integer", + "base": "integer", + "required": false, + "description": "Служебное поле, возвращает 0. Чтобы узнать количество клиентов, посчитайте элементы result.waitListClient" }, { "name": "time", @@ -70,5 +79,8 @@ "entityFields": [ "id", "type" - ] + ], + "requestExample": { + "waitListId": 13 + } } diff --git a/_assets/simulator/spec/methods/booking.v1.waitlist.client.set.json b/_assets/simulator/spec/methods/booking.v1.waitlist.client.set.json index 5faa7ffa8..2d9cbd4a6 100644 --- a/_assets/simulator/spec/methods/booking.v1.waitlist.client.set.json +++ b/_assets/simulator/spec/methods/booking.v1.waitlist.client.set.json @@ -3,7 +3,7 @@ "method": "booking.v1.waitlist.client.set", "scope": "booking", "kind": "write", - "title": "Добавить клиентов к записи в лист ожидания booking.v1.waitlist.client.set", + "title": "Установить клиентов записи в листе ожидания booking.v1.waitlist.client.set", "permissions": "любой пользователь", "params": [ { @@ -11,14 +11,14 @@ "type": "integer", "base": "integer", "required": true, - "description": "Идентификатор записи в лист ожидания. Можно получить методами booking.v1.waitlist.add и booking.v1.waitlist.list" + "description": "Идентификатор записи в листе ожидания. Можно получить методами booking.v1.waitlist.add и booking.v1.waitlist.list" }, { "name": "clients", "type": "array", "base": "array", "required": true, - "description": "Массив объектов, содержащий информацию о клиентах (подробное описание)", + "description": "Полный список клиентов записи. Каждый элемент — объект с полями id и type. Структура элемента, поведение пустого массива", "ref": "#/defs/clientsFields" } ], @@ -35,24 +35,14 @@ "type": "integer", "base": "integer", "required": true, - "description": "Идентификатор клиента, можно получить методом crm.item.list для контактов и компаний" + "description": "Идентификатор контакта или компании CRM. Получить можно методом crm.item.list: entityTypeId: 3 для контактов, entityTypeId: 4 для компаний" }, { "name": "type", "type": "object", "base": "object", "required": true, - "description": "Тип клиента в формате {\"module\": \"crm\", \"code\": \"CONTACT\"}. Возможные значения code: - CONTACT — контакт CRM - COMPANY — компания CRM Cтруктуру объекта возвращает метод booking.v1.clienttype.list", - "values": [ - { - "value": "CONTACT", - "title": "контакт CRM" - }, - { - "value": "COMPANY", - "title": "компания CRM Cтруктуру объекта возвращает метод booking.v1.clienttype.list" - } - ] + "description": "Тип клиента. Например, {\"module\": \"crm\", \"code\": \"CONTACT\"}. Структура объекта" } ] } @@ -65,12 +55,13 @@ "resultExample": { "result": true, "time": { - "start": 1724068028.331234, - "finish": 1724068028.726591, - "duration": 0.3953571319580078, - "processing": 0.13033390045166016, - "date_start": "2025-01-21T13:47:08+02:00", - "date_finish": "2025-01-21T13:47:08+02:00", + "start": 1790294535, + "finish": 1790294535.315704, + "duration": 0.3157041072845459, + "processing": 0, + "date_start": "2026-09-25T03:02:15+03:00", + "date_finish": "2026-09-25T03:02:15+03:00", + "operating_reset_at": 1790295135, "operating": 0 } }, @@ -91,5 +82,24 @@ } ], "page": "/api-reference/booking/waitlist/client/booking-v1-waitlist-client-set.html", - "executable": false + "executable": false, + "requestExample": { + "waitListId": 13, + "clients": [ + { + "id": 2795, + "type": { + "module": "crm", + "code": "CONTACT" + } + }, + { + "id": 3063, + "type": { + "module": "crm", + "code": "COMPANY" + } + } + ] + } } diff --git a/_assets/simulator/spec/methods/booking.v1.waitlist.client.unset.json b/_assets/simulator/spec/methods/booking.v1.waitlist.client.unset.json index d7d33d111..6eaffc577 100644 --- a/_assets/simulator/spec/methods/booking.v1.waitlist.client.unset.json +++ b/_assets/simulator/spec/methods/booking.v1.waitlist.client.unset.json @@ -3,7 +3,7 @@ "method": "booking.v1.waitlist.client.unset", "scope": "booking", "kind": "write", - "title": "Удалить клиентов из записи в лист ожидания booking.v1.waitlist.client.unset", + "title": "Удалить связи с клиентами записи в листе ожидания booking.v1.waitlist.client.unset", "permissions": "любой пользователь", "params": [ { @@ -11,7 +11,7 @@ "type": "integer", "base": "integer", "required": true, - "description": "Идентификатор записи в лист ожидания. Можно получить методами booking.v1.waitlist.add и booking.v1.waitlist.list" + "description": "Идентификатор записи в листе ожидания. Можно получить методами booking.v1.waitlist.add и booking.v1.waitlist.list" } ], "defs": {}, @@ -23,12 +23,13 @@ "resultExample": { "result": true, "time": { - "start": 1724068028.331234, - "finish": 1724068028.726591, - "duration": 0.3953571319580078, - "processing": 0.13033390045166016, - "date_start": "2025-01-21T13:47:08+02:00", - "date_finish": "2025-01-21T13:47:08+02:00", + "start": 1790294539, + "finish": 1790294539.731543, + "duration": 0.7315430641174316, + "processing": 0, + "date_start": "2026-09-25T03:02:19+03:00", + "date_finish": "2026-09-25T03:02:19+03:00", + "operating_reset_at": 1790295139, "operating": 0 } }, @@ -49,5 +50,8 @@ } ], "page": "/api-reference/booking/waitlist/client/booking-v1-waitlist-client-unset.html", - "executable": false + "executable": false, + "requestExample": { + "waitListId": 13 + } } diff --git a/_assets/simulator/spec/methods/booking.v1.waitlist.createfrombooking.json b/_assets/simulator/spec/methods/booking.v1.waitlist.createfrombooking.json index ec478e41e..01523e680 100644 --- a/_assets/simulator/spec/methods/booking.v1.waitlist.createfrombooking.json +++ b/_assets/simulator/spec/methods/booking.v1.waitlist.createfrombooking.json @@ -49,5 +49,8 @@ } ], "page": "/api-reference/booking/waitlist/booking-v1-waitlist-createfrombooking.html", - "executable": false + "executable": false, + "requestExample": { + "bookingId": 5 + } } diff --git a/_assets/simulator/spec/methods/booking.v1.waitlist.delete.json b/_assets/simulator/spec/methods/booking.v1.waitlist.delete.json index b779c0071..5b4eb249a 100644 --- a/_assets/simulator/spec/methods/booking.v1.waitlist.delete.json +++ b/_assets/simulator/spec/methods/booking.v1.waitlist.delete.json @@ -49,5 +49,8 @@ } ], "page": "/api-reference/booking/waitlist/booking-v1-waitlist-delete.html", - "executable": false + "executable": false, + "requestExample": { + "id": 15 + } } diff --git a/_assets/simulator/spec/methods/booking.v1.waitlist.externalData.list.json b/_assets/simulator/spec/methods/booking.v1.waitlist.externalData.list.json index dd0956000..0db51ba66 100644 --- a/_assets/simulator/spec/methods/booking.v1.waitlist.externalData.list.json +++ b/_assets/simulator/spec/methods/booking.v1.waitlist.externalData.list.json @@ -67,5 +67,8 @@ "entityTypeId", "moduleId", "value" - ] + ], + "requestExample": { + "waitListId": 257 + } } diff --git a/_assets/simulator/spec/methods/booking.v1.waitlist.externalData.set.json b/_assets/simulator/spec/methods/booking.v1.waitlist.externalData.set.json index 096f0109a..b2edb8308 100644 --- a/_assets/simulator/spec/methods/booking.v1.waitlist.externalData.set.json +++ b/_assets/simulator/spec/methods/booking.v1.waitlist.externalData.set.json @@ -88,5 +88,15 @@ } ], "page": "/api-reference/booking/waitlist/external-data/booking-v1-waitlist-externaldata-set.html", - "executable": false + "executable": false, + "requestExample": { + "waitListId": 14, + "externalData": [ + { + "moduleId": "crm", + "entityTypeId": "DEAL", + "value": "1" + } + ] + } } diff --git a/_assets/simulator/spec/methods/booking.v1.waitlist.externalData.unset.json b/_assets/simulator/spec/methods/booking.v1.waitlist.externalData.unset.json index d7c9a9be1..b5d7c0611 100644 --- a/_assets/simulator/spec/methods/booking.v1.waitlist.externalData.unset.json +++ b/_assets/simulator/spec/methods/booking.v1.waitlist.externalData.unset.json @@ -49,5 +49,8 @@ } ], "page": "/api-reference/booking/waitlist/external-data/booking-v1-waitlist-externaldata-unset.html", - "executable": false + "executable": false, + "requestExample": { + "waitListId": 14 + } } diff --git a/_assets/simulator/spec/methods/booking.v1.waitlist.get.json b/_assets/simulator/spec/methods/booking.v1.waitlist.get.json index a6c83f6f1..607edf6d2 100644 --- a/_assets/simulator/spec/methods/booking.v1.waitlist.get.json +++ b/_assets/simulator/spec/methods/booking.v1.waitlist.get.json @@ -58,5 +58,8 @@ "entityFields": [ "id", "note" - ] + ], + "requestExample": { + "id": 15 + } } diff --git a/_assets/simulator/spec/methods/booking.v1.waitlist.list.json b/_assets/simulator/spec/methods/booking.v1.waitlist.list.json index 8dea6fd91..a4721843b 100644 --- a/_assets/simulator/spec/methods/booking.v1.waitlist.list.json +++ b/_assets/simulator/spec/methods/booking.v1.waitlist.list.json @@ -68,5 +68,13 @@ "entityFields": [ "id", "note" - ] + ], + "requestExample": { + "filter": { + "createdWithin": { + "from": "01.04.2025", + "to": "16.04.2025" + } + } + } } diff --git a/_assets/simulator/spec/methods/booking.v1.waitlist.update.json b/_assets/simulator/spec/methods/booking.v1.waitlist.update.json index d57587f4f..15bacb473 100644 --- a/_assets/simulator/spec/methods/booking.v1.waitlist.update.json +++ b/_assets/simulator/spec/methods/booking.v1.waitlist.update.json @@ -74,5 +74,11 @@ } ], "page": "/api-reference/booking/waitlist/booking-v1-waitlist-update.html", - "executable": false + "executable": false, + "requestExample": { + "id": 5, + "fields": { + "note": "Новая заметка" + } + } } diff --git a/_assets/simulator/spec/methods/calendar.event.add.json b/_assets/simulator/spec/methods/calendar.event.add.json index a7713c44d..3ec37fbcf 100644 --- a/_assets/simulator/spec/methods/calendar.event.add.json +++ b/_assets/simulator/spec/methods/calendar.event.add.json @@ -365,5 +365,52 @@ } ], "page": "/api-reference/calendar/calendar-event/calendar-event-add.html", - "executable": false + "executable": false, + "requestExample": { + "type": "user", + "ownerId": 2, + "name": "New Event Name", + "description": "Description for event", + "from": "2024-06-14", + "to": "2024-06-14", + "skip_time": "Y", + "section": 5, + "color": "#9cbe1c", + "text_color": "#283033", + "accessibility": "absent", + "importance": "normal", + "is_meeting": "Y", + "private_event": "N", + "remind": [ + { + "type": "min", + "count": 20 + } + ], + "location": "London", + "attendees": [ + 1, + 2, + 3 + ], + "meeting": { + "notify": true, + "reinvite": false, + "allow_invite": false, + "hide_guests": false + }, + "rrule": { + "FREQ": "WEEKLY", + "BYDAY": [ + "MO", + "WE" + ], + "COUNT": 10, + "INTERVAL": 1 + }, + "crm_fields": [ + "C_5", + "L_11" + ] + } } diff --git a/_assets/simulator/spec/methods/calendar.event.delete.json b/_assets/simulator/spec/methods/calendar.event.delete.json index 173f3f9e4..0514e3c3d 100644 --- a/_assets/simulator/spec/methods/calendar.event.delete.json +++ b/_assets/simulator/spec/methods/calendar.event.delete.json @@ -41,5 +41,8 @@ } ], "page": "/api-reference/calendar/calendar-event/calendar-event-delete.html", - "executable": false + "executable": false, + "requestExample": { + "id": 698 + } } diff --git a/_assets/simulator/spec/methods/calendar.event.get.json b/_assets/simulator/spec/methods/calendar.event.get.json index 2ae4cac37..1b628a180 100644 --- a/_assets/simulator/spec/methods/calendar.event.get.json +++ b/_assets/simulator/spec/methods/calendar.event.get.json @@ -54,5 +54,15 @@ }, "returns": [], "page": "/api-reference/calendar/calendar-event/calendar-event-get.html", - "executable": false + "executable": false, + "requestExample": { + "type": "user", + "ownerId": 1, + "from": "2024-06-20", + "to": "2024-08-20", + "section": [ + 21, + 44 + ] + } } diff --git a/_assets/simulator/spec/methods/calendar.event.get.nearest.json b/_assets/simulator/spec/methods/calendar.event.get.nearest.json index ae820b430..ffc66fcbf 100644 --- a/_assets/simulator/spec/methods/calendar.event.get.nearest.json +++ b/_assets/simulator/spec/methods/calendar.event.get.nearest.json @@ -18,7 +18,7 @@ "type": "integer", "base": "integer", "required": "unknown", - "description": "Идентификатор владельца календаря. Для календаря компании параметр ownerId имеет значение 0" + "description": "Идентификатор владельца календаря. Передавайте ownerId вместе с type. Значение параметра не влияет на список возвращаемых событий. Для календаря компании передайте значение 0" }, { "name": "days", @@ -57,5 +57,13 @@ }, "returns": [], "page": "/api-reference/calendar/calendar-event/calendar-event-get-nearest.html", - "executable": false + "executable": false, + "requestExample": { + "type": "user", + "ownerId": 2, + "days": 10, + "forCurrentUser": true, + "maxEventsCount": 100, + "detailUrl": "/company/personal/user/#user_id#/calendar/" + } } diff --git a/_assets/simulator/spec/methods/calendar.event.getbyid.json b/_assets/simulator/spec/methods/calendar.event.getbyid.json index fd057ebf3..b4f2a173c 100644 --- a/_assets/simulator/spec/methods/calendar.event.getbyid.json +++ b/_assets/simulator/spec/methods/calendar.event.getbyid.json @@ -134,5 +134,8 @@ }, "returns": [], "page": "/api-reference/calendar/calendar-event/calendar-event-get-by-id.html", - "executable": false + "executable": false, + "requestExample": { + "id": 324 + } } diff --git a/_assets/simulator/spec/methods/calendar.event.update.json b/_assets/simulator/spec/methods/calendar.event.update.json index 22dffefcd..3a97cca33 100644 --- a/_assets/simulator/spec/methods/calendar.event.update.json +++ b/_assets/simulator/spec/methods/calendar.event.update.json @@ -379,5 +379,55 @@ } ], "page": "/api-reference/calendar/calendar-event/calendar-event-update.html", - "executable": false + "executable": false, + "requestExample": { + "id": 699, + "type": "user", + "ownerId": 2, + "name": "Changed Event Name", + "description": "New description for event", + "from": "2024-06-17", + "to": "2024-06-17", + "skip_time": "Y", + "section": 5, + "color": "#9cbe1c", + "text_color": "#283033", + "accessibility": "free", + "importance": "normal", + "is_meeting": "Y", + "private_event": "Y", + "recurrence_mode": "next", + "current_date_from": "2024-12-04", + "remind": [ + { + "type": "min", + "count": 10 + } + ], + "location": "London", + "attendees": [ + 1, + 2, + 3 + ], + "meeting": { + "notify": true, + "reinvite": false, + "allow_invite": false, + "hide_guests": false + }, + "rrule": { + "FREQ": "WEEKLY", + "BYDAY": [ + "MO", + "WE" + ], + "COUNT": 10, + "INTERVAL": 1 + }, + "crm_fields": [ + "C_5", + "L_11" + ] + } } diff --git a/_assets/simulator/spec/methods/calendar.meeting.status.get.json b/_assets/simulator/spec/methods/calendar.meeting.status.get.json index 3ffc21a10..6adbcbc81 100644 --- a/_assets/simulator/spec/methods/calendar.meeting.status.get.json +++ b/_assets/simulator/spec/methods/calendar.meeting.status.get.json @@ -55,5 +55,8 @@ } ], "page": "/api-reference/calendar/calendar-event/calendar-meeting-status-get.html", - "executable": false + "executable": false, + "requestExample": { + "eventId": 651 + } } diff --git a/_assets/simulator/spec/methods/calendar.meeting.status.set.json b/_assets/simulator/spec/methods/calendar.meeting.status.set.json index 32c72b465..61e39e179 100644 --- a/_assets/simulator/spec/methods/calendar.meeting.status.set.json +++ b/_assets/simulator/spec/methods/calendar.meeting.status.set.json @@ -62,5 +62,9 @@ } ], "page": "/api-reference/calendar/calendar-event/calendar-meeting-status-set.html", - "executable": false + "executable": false, + "requestExample": { + "eventId": 651, + "status": "Y" + } } diff --git a/_assets/simulator/spec/methods/calendar.resource.add.json b/_assets/simulator/spec/methods/calendar.resource.add.json index 245aab8e6..ed4707234 100644 --- a/_assets/simulator/spec/methods/calendar.resource.add.json +++ b/_assets/simulator/spec/methods/calendar.resource.add.json @@ -41,5 +41,8 @@ } ], "page": "/api-reference/calendar/resource/calendar-resource-add.html", - "executable": false + "executable": false, + "requestExample": { + "name": "My resource title" + } } diff --git a/_assets/simulator/spec/methods/calendar.resource.delete.json b/_assets/simulator/spec/methods/calendar.resource.delete.json index 8efa0da43..75c79de37 100644 --- a/_assets/simulator/spec/methods/calendar.resource.delete.json +++ b/_assets/simulator/spec/methods/calendar.resource.delete.json @@ -41,5 +41,8 @@ } ], "page": "/api-reference/calendar/resource/calendar-resource-delete.html", - "executable": false + "executable": false, + "requestExample": { + "resourceId": 521 + } } diff --git a/_assets/simulator/spec/methods/calendar.resource.update.json b/_assets/simulator/spec/methods/calendar.resource.update.json index b2c5dc8e9..32115ba1f 100644 --- a/_assets/simulator/spec/methods/calendar.resource.update.json +++ b/_assets/simulator/spec/methods/calendar.resource.update.json @@ -48,5 +48,9 @@ } ], "page": "/api-reference/calendar/resource/calendar-resource-update.html", - "executable": false + "executable": false, + "requestExample": { + "resourceId": 197, + "name": "Changed Resource Name" + } } diff --git a/_assets/simulator/spec/methods/calendar.section.add.json b/_assets/simulator/spec/methods/calendar.section.add.json index 13f25d34f..a063e6455 100644 --- a/_assets/simulator/spec/methods/calendar.section.add.json +++ b/_assets/simulator/spec/methods/calendar.section.add.json @@ -142,5 +142,17 @@ } ], "page": "/api-reference/calendar/calendar-section-add.html", - "executable": false + "executable": false, + "requestExample": { + "type": "user", + "ownerId": 2, + "name": "New Section", + "description": "Description for section", + "color": "#9cbeee", + "text_color": "#283000", + "export": { + "ALLOW": false, + "SET": "3_9" + } + } } diff --git a/_assets/simulator/spec/methods/calendar.section.delete.json b/_assets/simulator/spec/methods/calendar.section.delete.json index 7666f518b..94f682c5e 100644 --- a/_assets/simulator/spec/methods/calendar.section.delete.json +++ b/_assets/simulator/spec/methods/calendar.section.delete.json @@ -55,5 +55,10 @@ } ], "page": "/api-reference/calendar/calendar-section-delete.html", - "executable": false + "executable": false, + "requestExample": { + "type": "user", + "ownerId": 2, + "id": 521 + } } diff --git a/_assets/simulator/spec/methods/calendar.section.get.json b/_assets/simulator/spec/methods/calendar.section.get.json index b4c53a7d7..e7557cc53 100644 --- a/_assets/simulator/spec/methods/calendar.section.get.json +++ b/_assets/simulator/spec/methods/calendar.section.get.json @@ -170,5 +170,9 @@ } ], "page": "/api-reference/calendar/calendar-section-get.html", - "executable": false + "executable": false, + "requestExample": { + "type": "user", + "ownerId": 1 + } } diff --git a/_assets/simulator/spec/methods/calendar.section.update.json b/_assets/simulator/spec/methods/calendar.section.update.json index 0a1f227d4..41f701c63 100644 --- a/_assets/simulator/spec/methods/calendar.section.update.json +++ b/_assets/simulator/spec/methods/calendar.section.update.json @@ -139,5 +139,19 @@ } ], "page": "/api-reference/calendar/calendar-section-update.html", - "executable": false + "executable": false, + "requestExample": { + "id": 325, + "type": "user", + "ownerId": 2, + "name": "Changed Section Name", + "description": "New description for section", + "color": "#9cbeAA", + "text_color": "#283099", + "export": [ + { + "ALLOW": false + } + ] + } } diff --git a/_assets/simulator/spec/methods/call.followup.field.get.json b/_assets/simulator/spec/methods/call.followup.field.get.json index 04462e7ef..3ae5c6778 100644 --- a/_assets/simulator/spec/methods/call.followup.field.get.json +++ b/_assets/simulator/spec/methods/call.followup.field.get.json @@ -87,5 +87,17 @@ "sortable", "title", "type" - ] + ], + "requestExample": { + "name": "callId", + "select": [ + "name", + "type", + "title", + "description", + "filterable", + "sortable", + "multiple" + ] + } } diff --git a/_assets/simulator/spec/methods/call.followup.field.list.json b/_assets/simulator/spec/methods/call.followup.field.list.json index 6b6ccda58..2c537bb92 100644 --- a/_assets/simulator/spec/methods/call.followup.field.list.json +++ b/_assets/simulator/spec/methods/call.followup.field.list.json @@ -37,6 +37,11 @@ "type": "int", "description": "Call type: 1 = instant ad-hoc, 2 = permanent conference room, 3 = large room." }, + { + "name": "chatId", + "type": "int", + "description": "Id of the chat the call belongs to. Opt-in: list this in `select` to receive it." + }, { "name": "initiatorId", "type": "int", @@ -159,5 +164,12 @@ "description", "name", "type" - ] + ], + "requestExample": { + "select": [ + "name", + "type", + "description" + ] + } } diff --git a/_assets/simulator/spec/methods/call.followup.get.json b/_assets/simulator/spec/methods/call.followup.get.json index 77720f6ee..9bdd63ea9 100644 --- a/_assets/simulator/spec/methods/call.followup.get.json +++ b/_assets/simulator/spec/methods/call.followup.get.json @@ -82,5 +82,9 @@ } ], "page": "/api-reference/telephony/follow-up/call-followup-get.html", - "executable": false + "executable": false, + "requestExample": { + "callId": 12345, + "mentionFormat": "html" + } } diff --git a/_assets/simulator/spec/methods/call.followup.list.json b/_assets/simulator/spec/methods/call.followup.list.json index 765c88781..0fb3e1e98 100644 --- a/_assets/simulator/spec/methods/call.followup.list.json +++ b/_assets/simulator/spec/methods/call.followup.list.json @@ -233,5 +233,27 @@ "overview", "participants", "startDate" - ] + ], + "requestExample": { + "filter": { + "startDate": { + "from": "2026-01-01T00:00:00Z", + "to": "2026-01-31T23:59:59Z" + } + }, + "select": [ + "callId", + "startDate", + "participants", + "overview.topic", + "overview.actionItems" + ], + "order": { + "startDate": "desc" + }, + "pagination": { + "limit": 20 + }, + "mentionFormat": "html" + } } diff --git a/_assets/simulator/spec/methods/catalog.catalog.get.json b/_assets/simulator/spec/methods/catalog.catalog.get.json index f7d43eb64..8772d22e6 100644 --- a/_assets/simulator/spec/methods/catalog.catalog.get.json +++ b/_assets/simulator/spec/methods/catalog.catalog.get.json @@ -78,5 +78,8 @@ "skuPropertyId", "subscription", "vatId" - ] + ], + "requestExample": { + "id": 23 + } } diff --git a/_assets/simulator/spec/methods/catalog.catalog.isOffers.json b/_assets/simulator/spec/methods/catalog.catalog.isOffers.json index 932046bfb..1c8191bac 100644 --- a/_assets/simulator/spec/methods/catalog.catalog.isOffers.json +++ b/_assets/simulator/spec/methods/catalog.catalog.isOffers.json @@ -48,5 +48,8 @@ } ], "page": "/api-reference/catalog/catalog/catalog-catalog-is-offers.html", - "executable": false + "executable": false, + "requestExample": { + "id": 23 + } } diff --git a/_assets/simulator/spec/methods/catalog.catalog.list.json b/_assets/simulator/spec/methods/catalog.catalog.list.json index f1a7881e0..13ea5e963 100644 --- a/_assets/simulator/spec/methods/catalog.catalog.list.json +++ b/_assets/simulator/spec/methods/catalog.catalog.list.json @@ -131,5 +131,29 @@ "skuPropertyId", "subscription", "vatId" - ] + ], + "requestExample": { + "select": [ + "iblockId", + "iblockTypeId", + "id", + "lid", + "name", + "productIblockId", + "skuPropertyId", + "subscription", + "vatId" + ], + "filter": { + ">id": 10, + "@vatId": [ + 1, + 2 + ], + "skuPropertyId": 121 + }, + "order": { + "id": "desc" + } + } } diff --git a/_assets/simulator/spec/methods/catalog.document.add.json b/_assets/simulator/spec/methods/catalog.document.add.json index 0146986bd..d1fe44af6 100644 --- a/_assets/simulator/spec/methods/catalog.document.add.json +++ b/_assets/simulator/spec/methods/catalog.document.add.json @@ -183,5 +183,15 @@ } ], "page": "/api-reference/catalog/document/catalog-document-add.html", - "executable": false + "executable": false, + "requestExample": { + "fields": { + "docType": "A", + "currency": "RUB", + "responsibleId": 29, + "docNumber": "IN-00042", + "title": "Поступление от Поставщик-1", + "commentary": "Плановое пополнение склада" + } + } } diff --git a/_assets/simulator/spec/methods/catalog.document.cancel.json b/_assets/simulator/spec/methods/catalog.document.cancel.json index c4091d09c..b0e51275f 100644 --- a/_assets/simulator/spec/methods/catalog.document.cancel.json +++ b/_assets/simulator/spec/methods/catalog.document.cancel.json @@ -50,5 +50,8 @@ } ], "page": "/api-reference/catalog/document/catalog-document-cancel.html", - "executable": false + "executable": false, + "requestExample": { + "id": 142 + } } diff --git a/_assets/simulator/spec/methods/catalog.document.cancelList.json b/_assets/simulator/spec/methods/catalog.document.cancelList.json index 9f7d1d257..7e2485ce8 100644 --- a/_assets/simulator/spec/methods/catalog.document.cancelList.json +++ b/_assets/simulator/spec/methods/catalog.document.cancelList.json @@ -54,5 +54,12 @@ } ], "page": "/api-reference/catalog/document/catalog-document-cancel-list.html", - "executable": false + "executable": false, + "requestExample": { + "documentIds": [ + 142, + 143, + 144 + ] + } } diff --git a/_assets/simulator/spec/methods/catalog.document.conduct.json b/_assets/simulator/spec/methods/catalog.document.conduct.json index 14c395bea..f7e8449ed 100644 --- a/_assets/simulator/spec/methods/catalog.document.conduct.json +++ b/_assets/simulator/spec/methods/catalog.document.conduct.json @@ -50,5 +50,8 @@ } ], "page": "/api-reference/catalog/document/catalog-document-conduct.html", - "executable": false + "executable": false, + "requestExample": { + "id": 142 + } } diff --git a/_assets/simulator/spec/methods/catalog.document.conductList.json b/_assets/simulator/spec/methods/catalog.document.conductList.json index eff4cf8d5..bb30aefd8 100644 --- a/_assets/simulator/spec/methods/catalog.document.conductList.json +++ b/_assets/simulator/spec/methods/catalog.document.conductList.json @@ -54,5 +54,12 @@ } ], "page": "/api-reference/catalog/document/catalog-document-conduct-list.html", - "executable": false + "executable": false, + "requestExample": { + "documentIds": [ + 142, + 143, + 144 + ] + } } diff --git a/_assets/simulator/spec/methods/catalog.document.confirm.json b/_assets/simulator/spec/methods/catalog.document.confirm.json index ad60ca023..47990faca 100644 --- a/_assets/simulator/spec/methods/catalog.document.confirm.json +++ b/_assets/simulator/spec/methods/catalog.document.confirm.json @@ -52,5 +52,8 @@ } ], "page": "/api-reference/catalog/document/outdated/catalog-document-confirm.html", - "executable": false + "executable": false, + "requestExample": { + "id": 42 + } } diff --git a/_assets/simulator/spec/methods/catalog.document.delete.json b/_assets/simulator/spec/methods/catalog.document.delete.json index 2146e7d96..0f0820411 100644 --- a/_assets/simulator/spec/methods/catalog.document.delete.json +++ b/_assets/simulator/spec/methods/catalog.document.delete.json @@ -50,5 +50,8 @@ } ], "page": "/api-reference/catalog/document/catalog-document-delete.html", - "executable": false + "executable": false, + "requestExample": { + "id": 142 + } } diff --git a/_assets/simulator/spec/methods/catalog.document.deleteList.json b/_assets/simulator/spec/methods/catalog.document.deleteList.json index 3f4bbf4ca..b8805e3d9 100644 --- a/_assets/simulator/spec/methods/catalog.document.deleteList.json +++ b/_assets/simulator/spec/methods/catalog.document.deleteList.json @@ -54,5 +54,12 @@ } ], "page": "/api-reference/catalog/document/catalog-document-delete-list.html", - "executable": false + "executable": false, + "requestExample": { + "documentIds": [ + 142, + 143, + 144 + ] + } } diff --git a/_assets/simulator/spec/methods/catalog.document.element.add.json b/_assets/simulator/spec/methods/catalog.document.element.add.json index b949e7a0f..8aca6616c 100644 --- a/_assets/simulator/spec/methods/catalog.document.element.add.json +++ b/_assets/simulator/spec/methods/catalog.document.element.add.json @@ -119,5 +119,14 @@ } ], "page": "/api-reference/catalog/document/document-element/catalog-document-element-add.html", - "executable": false + "executable": false, + "requestExample": { + "fields": { + "docId": 64, + "elementId": 312, + "storeTo": 2, + "amount": 15, + "purchasingPrice": 1250.5 + } + } } diff --git a/_assets/simulator/spec/methods/catalog.document.element.delete.json b/_assets/simulator/spec/methods/catalog.document.element.delete.json index c6b145efe..293d3f202 100644 --- a/_assets/simulator/spec/methods/catalog.document.element.delete.json +++ b/_assets/simulator/spec/methods/catalog.document.element.delete.json @@ -49,5 +49,8 @@ } ], "page": "/api-reference/catalog/document/document-element/catalog-document-element-delete.html", - "executable": false + "executable": false, + "requestExample": { + "id": 148 + } } diff --git a/_assets/simulator/spec/methods/catalog.document.element.fields.json b/_assets/simulator/spec/methods/catalog.document.element.fields.json index a9a81650b..8797fe646 100644 --- a/_assets/simulator/spec/methods/catalog.document.element.fields.json +++ b/_assets/simulator/spec/methods/catalog.document.element.fields.json @@ -79,5 +79,6 @@ } ], "page": "/api-reference/catalog/document/outdated/catalog-document-element-fields.html", - "executable": false + "executable": false, + "requestExample": {} } diff --git a/_assets/simulator/spec/methods/catalog.document.element.getFields.json b/_assets/simulator/spec/methods/catalog.document.element.getFields.json index bed578e1e..81a6e593c 100644 --- a/_assets/simulator/spec/methods/catalog.document.element.getFields.json +++ b/_assets/simulator/spec/methods/catalog.document.element.getFields.json @@ -127,5 +127,6 @@ } ], "page": "/api-reference/catalog/document/document-element/catalog-document-element-get-fields.html", - "executable": false + "executable": false, + "requestExample": {} } diff --git a/_assets/simulator/spec/methods/catalog.document.element.list.json b/_assets/simulator/spec/methods/catalog.document.element.list.json index 69e23e528..342efa7ec 100644 --- a/_assets/simulator/spec/methods/catalog.document.element.list.json +++ b/_assets/simulator/spec/methods/catalog.document.element.list.json @@ -144,5 +144,21 @@ "purchasingPrice", "storeFrom", "storeTo" - ] + ], + "requestExample": { + "select": [ + "id", + "docId", + "elementId", + "amount", + "storeFrom", + "storeTo" + ], + "filter": { + "docId": 64 + }, + "order": { + "id": "ASC" + } + } } diff --git a/_assets/simulator/spec/methods/catalog.document.element.update.json b/_assets/simulator/spec/methods/catalog.document.element.update.json index 36124fcf3..4b2c25c6e 100644 --- a/_assets/simulator/spec/methods/catalog.document.element.update.json +++ b/_assets/simulator/spec/methods/catalog.document.element.update.json @@ -112,5 +112,13 @@ } ], "page": "/api-reference/catalog/document/document-element/catalog-document-element-update.html", - "executable": false + "executable": false, + "requestExample": { + "id": 148, + "fields": { + "amount": 12, + "purchasingPrice": 1180, + "storeTo": 2 + } + } } diff --git a/_assets/simulator/spec/methods/catalog.document.fields.json b/_assets/simulator/spec/methods/catalog.document.fields.json index 333b13b04..087e2da40 100644 --- a/_assets/simulator/spec/methods/catalog.document.fields.json +++ b/_assets/simulator/spec/methods/catalog.document.fields.json @@ -79,5 +79,6 @@ } ], "page": "/api-reference/catalog/document/outdated/catalog-document-fields.html", - "executable": false + "executable": false, + "requestExample": {} } diff --git a/_assets/simulator/spec/methods/catalog.document.getFields.json b/_assets/simulator/spec/methods/catalog.document.getFields.json index 90d96c079..c93c57f3f 100644 --- a/_assets/simulator/spec/methods/catalog.document.getFields.json +++ b/_assets/simulator/spec/methods/catalog.document.getFields.json @@ -188,5 +188,6 @@ } ], "page": "/api-reference/catalog/document/catalog-document-get-fields.html", - "executable": false + "executable": false, + "requestExample": {} } diff --git a/_assets/simulator/spec/methods/catalog.document.list.json b/_assets/simulator/spec/methods/catalog.document.list.json index c5d461995..4afe7358b 100644 --- a/_assets/simulator/spec/methods/catalog.document.list.json +++ b/_assets/simulator/spec/methods/catalog.document.list.json @@ -113,5 +113,24 @@ "siteId", "title", "total" - ] + ], + "requestExample": { + "select": [ + "id", + "docType", + "docNumber", + "title", + "status", + "dateDocument", + "total" + ], + "filter": { + ">=dateCreate": "2025-10-01T00:00:00+03:00", + "<=dateCreate": "2025-10-15T23:59:59+03:00" + }, + "order": { + "id": "ASC" + }, + "start": 50 + } } diff --git a/_assets/simulator/spec/methods/catalog.document.mode.status.json b/_assets/simulator/spec/methods/catalog.document.mode.status.json index c0b8577ec..287e5983f 100644 --- a/_assets/simulator/spec/methods/catalog.document.mode.status.json +++ b/_assets/simulator/spec/methods/catalog.document.mode.status.json @@ -60,5 +60,6 @@ } ], "page": "/api-reference/catalog/document/catalog-document-mode-status.html", - "executable": false + "executable": false, + "requestExample": {} } diff --git a/_assets/simulator/spec/methods/catalog.document.unconfirm.json b/_assets/simulator/spec/methods/catalog.document.unconfirm.json index eca6c89eb..69d68e8ca 100644 --- a/_assets/simulator/spec/methods/catalog.document.unconfirm.json +++ b/_assets/simulator/spec/methods/catalog.document.unconfirm.json @@ -52,5 +52,8 @@ } ], "page": "/api-reference/catalog/document/outdated/catalog-document-unconfirm.html", - "executable": false + "executable": false, + "requestExample": { + "id": 42 + } } diff --git a/_assets/simulator/spec/methods/catalog.document.update.json b/_assets/simulator/spec/methods/catalog.document.update.json index 7efe24e3e..a26655d41 100644 --- a/_assets/simulator/spec/methods/catalog.document.update.json +++ b/_assets/simulator/spec/methods/catalog.document.update.json @@ -152,5 +152,13 @@ } ], "page": "/api-reference/catalog/document/catalog-document-update.html", - "executable": false + "executable": false, + "requestExample": { + "id": 142, + "fields": { + "title": "Поступление от Поставщик-1 (корректировка)", + "commentary": "Обновили ответсвенного", + "responsibleId": 21 + } + } } diff --git a/_assets/simulator/spec/methods/catalog.documentcontractor.add.json b/_assets/simulator/spec/methods/catalog.documentcontractor.add.json index 8cee421d7..31987384b 100644 --- a/_assets/simulator/spec/methods/catalog.documentcontractor.add.json +++ b/_assets/simulator/spec/methods/catalog.documentcontractor.add.json @@ -68,5 +68,12 @@ } ], "page": "/api-reference/catalog/documentcontractor/catalog-documentcontractor-add.html", - "executable": false + "executable": false, + "requestExample": { + "fields": { + "documentId": 42, + "entityTypeId": 3, + "entityId": 101 + } + } } diff --git a/_assets/simulator/spec/methods/catalog.documentcontractor.delete.json b/_assets/simulator/spec/methods/catalog.documentcontractor.delete.json index 14c7781a2..6ee44ff75 100644 --- a/_assets/simulator/spec/methods/catalog.documentcontractor.delete.json +++ b/_assets/simulator/spec/methods/catalog.documentcontractor.delete.json @@ -34,5 +34,8 @@ } }, "page": "/api-reference/catalog/documentcontractor/catalog-documentcontractor-delete.html", - "executable": false + "executable": false, + "requestExample": { + "id": 42 + } } diff --git a/_assets/simulator/spec/methods/catalog.documentcontractor.getFields.json b/_assets/simulator/spec/methods/catalog.documentcontractor.getFields.json index d8769c7b8..a534aa933 100644 --- a/_assets/simulator/spec/methods/catalog.documentcontractor.getFields.json +++ b/_assets/simulator/spec/methods/catalog.documentcontractor.getFields.json @@ -110,5 +110,6 @@ } ], "page": "/api-reference/catalog/documentcontractor/catalog-documentcontractor-get-fields.html", - "executable": false + "executable": false, + "requestExample": {} } diff --git a/_assets/simulator/spec/methods/catalog.documentcontractor.list.json b/_assets/simulator/spec/methods/catalog.documentcontractor.list.json index e118ee0e4..407f4d3b7 100644 --- a/_assets/simulator/spec/methods/catalog.documentcontractor.list.json +++ b/_assets/simulator/spec/methods/catalog.documentcontractor.list.json @@ -126,5 +126,18 @@ "entityFields": [ "documentId", "id" - ] + ], + "requestExample": { + "select": [ + "id", + "documentId" + ], + "filter": { + "documentId": 7 + }, + "order": { + "id": "ASC" + }, + "start": 0 + } } diff --git a/_assets/simulator/spec/methods/catalog.enum.getRoundTypes.json b/_assets/simulator/spec/methods/catalog.enum.getRoundTypes.json index b23f63533..db37440d4 100644 --- a/_assets/simulator/spec/methods/catalog.enum.getRoundTypes.json +++ b/_assets/simulator/spec/methods/catalog.enum.getRoundTypes.json @@ -98,5 +98,6 @@ } ], "page": "/api-reference/catalog/enum/catalog-enum-get-round-types.html", - "executable": false + "executable": false, + "requestExample": {} } diff --git a/_assets/simulator/spec/methods/catalog.enum.getStoreDocumentTypes.json b/_assets/simulator/spec/methods/catalog.enum.getStoreDocumentTypes.json index ed21b6419..7c9d9c263 100644 --- a/_assets/simulator/spec/methods/catalog.enum.getStoreDocumentTypes.json +++ b/_assets/simulator/spec/methods/catalog.enum.getStoreDocumentTypes.json @@ -106,5 +106,6 @@ } ], "page": "/api-reference/catalog/enum/catalog-enum-get-store-document-types.html", - "executable": false + "executable": false, + "requestExample": {} } diff --git a/_assets/simulator/spec/methods/catalog.extra.get.json b/_assets/simulator/spec/methods/catalog.extra.get.json index d8ca6e13a..b2eea6442 100644 --- a/_assets/simulator/spec/methods/catalog.extra.get.json +++ b/_assets/simulator/spec/methods/catalog.extra.get.json @@ -67,5 +67,8 @@ "id", "name", "percentage" - ] + ], + "requestExample": { + "id": 1 + } } diff --git a/_assets/simulator/spec/methods/catalog.extra.list.json b/_assets/simulator/spec/methods/catalog.extra.list.json index dbe8e03e9..4ad72fefb 100644 --- a/_assets/simulator/spec/methods/catalog.extra.list.json +++ b/_assets/simulator/spec/methods/catalog.extra.list.json @@ -112,5 +112,17 @@ } ], "page": "/api-reference/catalog/extra/catalog-extra-list.html", - "executable": false + "executable": false, + "requestExample": { + "select": [ + "id", + "percentage" + ], + "filter": { + ">percentage": 5 + }, + "order": { + "id": "ASC" + } + } } diff --git a/_assets/simulator/spec/methods/catalog.measure.add.json b/_assets/simulator/spec/methods/catalog.measure.add.json index a55bfe607..9f7b3bb26 100644 --- a/_assets/simulator/spec/methods/catalog.measure.add.json +++ b/_assets/simulator/spec/methods/catalog.measure.add.json @@ -129,5 +129,15 @@ } ], "page": "/api-reference/catalog/measure/catalog-measure-add.html", - "executable": false + "executable": false, + "requestExample": { + "fields": { + "code": 715, + "measureTitle": "Пара", + "symbol": "пар", + "symbolLetterIntl": "NPR", + "symbolIntl": "pr; 2", + "isDefault": "N" + } + } } diff --git a/_assets/simulator/spec/methods/catalog.measure.delete.json b/_assets/simulator/spec/methods/catalog.measure.delete.json index 28e9fdfcd..f6dc7ee3d 100644 --- a/_assets/simulator/spec/methods/catalog.measure.delete.json +++ b/_assets/simulator/spec/methods/catalog.measure.delete.json @@ -49,5 +49,8 @@ } ], "page": "/api-reference/catalog/measure/catalog-measure-delete.html", - "executable": false + "executable": false, + "requestExample": { + "id": 6 + } } diff --git a/_assets/simulator/spec/methods/catalog.measure.get.json b/_assets/simulator/spec/methods/catalog.measure.get.json index d19fc549c..035148987 100644 --- a/_assets/simulator/spec/methods/catalog.measure.get.json +++ b/_assets/simulator/spec/methods/catalog.measure.get.json @@ -75,5 +75,8 @@ "symbol", "symbolIntl", "symbolLetterIntl" - ] + ], + "requestExample": { + "id": 6 + } } diff --git a/_assets/simulator/spec/methods/catalog.measure.list.json b/_assets/simulator/spec/methods/catalog.measure.list.json index e749d845d..6b95f77c4 100644 --- a/_assets/simulator/spec/methods/catalog.measure.list.json +++ b/_assets/simulator/spec/methods/catalog.measure.list.json @@ -136,5 +136,18 @@ "symbol", "symbolIntl", "symbolLetterIntl" - ] + ], + "requestExample": { + "select": [ + "id", + "code", + "symbolIntl" + ], + "filter": { + "<=code": 200 + }, + "order": { + "code": "DESC" + } + } } diff --git a/_assets/simulator/spec/methods/catalog.price.add.json b/_assets/simulator/spec/methods/catalog.price.add.json index 444665f85..fe918064d 100644 --- a/_assets/simulator/spec/methods/catalog.price.add.json +++ b/_assets/simulator/spec/methods/catalog.price.add.json @@ -107,5 +107,13 @@ } ], "page": "/api-reference/catalog/price/catalog-price-add.html", - "executable": false + "executable": false, + "requestExample": { + "fields": { + "catalogGroupId": 1, + "currency": "RUB", + "price": 2000, + "productId": 1 + } + } } diff --git a/_assets/simulator/spec/methods/catalog.price.delete.json b/_assets/simulator/spec/methods/catalog.price.delete.json index a0556728e..ac71ceb53 100644 --- a/_assets/simulator/spec/methods/catalog.price.delete.json +++ b/_assets/simulator/spec/methods/catalog.price.delete.json @@ -49,5 +49,8 @@ } ], "page": "/api-reference/catalog/price/catalog-price-delete.html", - "executable": false + "executable": false, + "requestExample": { + "id": 1 + } } diff --git a/_assets/simulator/spec/methods/catalog.price.get.json b/_assets/simulator/spec/methods/catalog.price.get.json index 70a60f1ae..5a1877f48 100644 --- a/_assets/simulator/spec/methods/catalog.price.get.json +++ b/_assets/simulator/spec/methods/catalog.price.get.json @@ -79,5 +79,8 @@ "quantityFrom", "quantityTo", "timestampX" - ] + ], + "requestExample": { + "id": 1 + } } diff --git a/_assets/simulator/spec/methods/catalog.price.getFields.json b/_assets/simulator/spec/methods/catalog.price.getFields.json index e645f466e..bb928ab90 100644 --- a/_assets/simulator/spec/methods/catalog.price.getFields.json +++ b/_assets/simulator/spec/methods/catalog.price.getFields.json @@ -145,5 +145,6 @@ } ], "page": "/api-reference/catalog/price/catalog-price-get-fields.html", - "executable": false + "executable": false, + "requestExample": {} } diff --git a/_assets/simulator/spec/methods/catalog.price.list.json b/_assets/simulator/spec/methods/catalog.price.list.json index 0fb5efc23..18ba2bfba 100644 --- a/_assets/simulator/spec/methods/catalog.price.list.json +++ b/_assets/simulator/spec/methods/catalog.price.list.json @@ -132,5 +132,20 @@ "id", "price", "productId" - ] + ], + "requestExample": { + "select": [ + "id", + "productId", + "catalogGroupId", + "price", + "currency" + ], + "filter": { + "productId": 1 + }, + "order": { + "id": "ASC" + } + } } diff --git a/_assets/simulator/spec/methods/catalog.price.modify.json b/_assets/simulator/spec/methods/catalog.price.modify.json index 846247a29..6ef490c5c 100644 --- a/_assets/simulator/spec/methods/catalog.price.modify.json +++ b/_assets/simulator/spec/methods/catalog.price.modify.json @@ -113,5 +113,30 @@ } ], "page": "/api-reference/catalog/price/catalog-price-modify.html", - "executable": false + "executable": false, + "requestExample": { + "fields": { + "product": { + "id": 8, + "prices": [ + { + "catalogGroupId": 1, + "currency": "RUB", + "price": 2001 + }, + { + "catalogGroupId": 3, + "currency": "RUB", + "price": 2001 + }, + { + "catalogGroupId": 5, + "currency": "RUB", + "price": 2001, + "id": 122 + } + ] + } + } + } } diff --git a/_assets/simulator/spec/methods/catalog.price.update.json b/_assets/simulator/spec/methods/catalog.price.update.json index 849d589a3..3f2c903df 100644 --- a/_assets/simulator/spec/methods/catalog.price.update.json +++ b/_assets/simulator/spec/methods/catalog.price.update.json @@ -100,5 +100,12 @@ } ], "page": "/api-reference/catalog/price/catalog-price-update.html", - "executable": false + "executable": false, + "requestExample": { + "id": 1, + "fields": { + "currency": "RUB", + "price": 5000 + } + } } diff --git a/_assets/simulator/spec/methods/catalog.priceType.add.json b/_assets/simulator/spec/methods/catalog.priceType.add.json index 870c8af19..88b0db38b 100644 --- a/_assets/simulator/spec/methods/catalog.priceType.add.json +++ b/_assets/simulator/spec/methods/catalog.priceType.add.json @@ -4,7 +4,7 @@ "scope": "catalog", "kind": "write", "title": "Создать тип цены catalog.priceType.add", - "permissions": "администратор", + "permissions": "пользователь с правом «Управление типами цен»", "params": [ { "name": "fields", @@ -28,7 +28,7 @@ "type": "string", "base": "string", "required": true, - "description": "Код типа цены. Чтобы обеспечить стабильную работу внутренних сервисов, код типа цены необходимо указывать только английскими символами" + "description": "Код типа цены. Значение не должно быть пустым" }, { "name": "base", @@ -117,5 +117,13 @@ } ], "page": "/api-reference/catalog/price-type/catalog-price-type-add.html", - "executable": false + "executable": false, + "requestExample": { + "fields": { + "name": "Wholesale price", + "base": "N", + "sort": 10, + "xmlId": "wholesale" + } + } } diff --git a/_assets/simulator/spec/methods/catalog.priceType.delete.json b/_assets/simulator/spec/methods/catalog.priceType.delete.json index 8893d2f0f..73b084cc3 100644 --- a/_assets/simulator/spec/methods/catalog.priceType.delete.json +++ b/_assets/simulator/spec/methods/catalog.priceType.delete.json @@ -4,7 +4,7 @@ "scope": "catalog", "kind": "write", "title": "Удалить тип цены catalog.priceType.delete", - "permissions": "администратор", + "permissions": "пользователь с правом «Управление типами цен»", "params": [ { "name": "id", @@ -49,5 +49,8 @@ } ], "page": "/api-reference/catalog/price-type/catalog-price-type-delete.html", - "executable": false + "executable": false, + "requestExample": { + "id": 2 + } } diff --git a/_assets/simulator/spec/methods/catalog.priceType.get.json b/_assets/simulator/spec/methods/catalog.priceType.get.json index 908c15c25..c9955d2f5 100644 --- a/_assets/simulator/spec/methods/catalog.priceType.get.json +++ b/_assets/simulator/spec/methods/catalog.priceType.get.json @@ -4,7 +4,7 @@ "scope": "catalog", "kind": "read", "title": "Получить значения полей типа цены catalog.priceType.get", - "permissions": "администратор", + "permissions": "пользователь с правом «Просмотр каталога товаров» или «Управление типами цен»", "params": [ { "name": "id", @@ -79,5 +79,8 @@ "sort", "timestampX", "xmlId" - ] + ], + "requestExample": { + "id": 1 + } } diff --git a/_assets/simulator/spec/methods/catalog.priceType.list.json b/_assets/simulator/spec/methods/catalog.priceType.list.json index 76dab6b24..7e8a81c33 100644 --- a/_assets/simulator/spec/methods/catalog.priceType.list.json +++ b/_assets/simulator/spec/methods/catalog.priceType.list.json @@ -4,7 +4,7 @@ "scope": "catalog", "kind": "read", "title": "Получить список типов цен по фильтру catalog.priceType.list", - "permissions": "администратор", + "permissions": "пользователь с правом «Просмотр каталога товаров» или «Управление типами цен»", "params": [ { "name": "select", @@ -64,18 +64,20 @@ "file": "api-reference/catalog/price-type/catalog-price-type-list.md" }, "resultExample": { - "priceTypes": [ - { - "id": 1, - "name": "BASE", - "xmlId": "BASE" - }, - { - "id": 2, - "name": "Base wholesale price", - "xmlId": "basewholesale" - } - ], + "result": { + "priceTypes": [ + { + "id": 1, + "name": "BASE", + "xmlId": "BASE" + }, + { + "id": 2, + "name": "Base wholesale price", + "xmlId": "basewholesale" + } + ] + }, "total": 2, "time": { "start": 1712326352.63409, @@ -109,6 +111,13 @@ "required": "unknown", "description": "Общее количество найденных записей" }, + { + "name": "next", + "type": "integer", + "base": "integer", + "required": "unknown", + "description": "Значение параметра start для получения следующей страницы. Поле отсутствует, если получена последняя страница" + }, { "name": "time", "type": "time", @@ -121,8 +130,22 @@ "executable": false, "entityFields": [ "base", + "id", "name", "sort", "xmlId" - ] + ], + "requestExample": { + "select": [ + "id", + "name", + "xmlId" + ], + "filter": { + "modifiedBy": 1 + }, + "order": { + "id": "ASC" + } + } } diff --git a/_assets/simulator/spec/methods/catalog.priceType.update.json b/_assets/simulator/spec/methods/catalog.priceType.update.json index d3c7b4ddd..0c965f459 100644 --- a/_assets/simulator/spec/methods/catalog.priceType.update.json +++ b/_assets/simulator/spec/methods/catalog.priceType.update.json @@ -4,7 +4,7 @@ "scope": "catalog", "kind": "write", "title": "Обновить тип цены catalog.priceType.update", - "permissions": "администратор", + "permissions": "пользователь с правом «Управление типами цен»", "params": [ { "name": "id", @@ -34,8 +34,8 @@ "name": "name", "type": "string", "base": "string", - "required": true, - "description": "Код типа цены" + "required": false, + "description": "Код типа цены. Значение не должно быть пустым" }, { "name": "base", @@ -124,5 +124,14 @@ } ], "page": "/api-reference/catalog/price-type/catalog-price-type-update.html", - "executable": false + "executable": false, + "requestExample": { + "id": 2, + "fields": { + "name": "Base wholesale price", + "base": "Y", + "sort": 1, + "xmlId": "basewholesale" + } + } } diff --git a/_assets/simulator/spec/methods/catalog.priceTypeGroup.add.json b/_assets/simulator/spec/methods/catalog.priceTypeGroup.add.json index a5baddc35..4e9314f2d 100644 --- a/_assets/simulator/spec/methods/catalog.priceTypeGroup.add.json +++ b/_assets/simulator/spec/methods/catalog.priceTypeGroup.add.json @@ -107,5 +107,12 @@ } ], "page": "/api-reference/catalog/price-type/price-type-group/catalog-price-type-group-add.html", - "executable": false + "executable": false, + "requestExample": { + "fields": { + "catalogGroupId": 9, + "groupId": 23, + "access": "Y" + } + } } diff --git a/_assets/simulator/spec/methods/catalog.priceTypeGroup.delete.json b/_assets/simulator/spec/methods/catalog.priceTypeGroup.delete.json index beff0ca7d..586fe665a 100644 --- a/_assets/simulator/spec/methods/catalog.priceTypeGroup.delete.json +++ b/_assets/simulator/spec/methods/catalog.priceTypeGroup.delete.json @@ -3,7 +3,7 @@ "method": "catalog.priceTypeGroup.delete", "scope": "catalog", "kind": "write", - "title": "Удалить привязку типа цен к группе покупателей catalog.priceTypeGroup.delete", + "title": "Удалить привязку типа цены к группе покупателей catalog.priceTypeGroup.delete", "permissions": "пользователь с правом «Управление типами цен»", "params": [ { @@ -50,5 +50,8 @@ } ], "page": "/api-reference/catalog/price-type/price-type-group/catalog-price-type-group-delete.html", - "executable": false + "executable": false, + "requestExample": { + "id": 109 + } } diff --git a/_assets/simulator/spec/methods/catalog.priceTypeGroup.getFields.json b/_assets/simulator/spec/methods/catalog.priceTypeGroup.getFields.json index e525475dc..e691e25fe 100644 --- a/_assets/simulator/spec/methods/catalog.priceTypeGroup.getFields.json +++ b/_assets/simulator/spec/methods/catalog.priceTypeGroup.getFields.json @@ -110,5 +110,6 @@ } ], "page": "/api-reference/catalog/price-type/price-type-group/catalog-price-type-group-get-fields.html", - "executable": false + "executable": false, + "requestExample": {} } diff --git a/_assets/simulator/spec/methods/catalog.priceTypeGroup.list.json b/_assets/simulator/spec/methods/catalog.priceTypeGroup.list.json index 3ff0d7f85..7fd62c44f 100644 --- a/_assets/simulator/spec/methods/catalog.priceTypeGroup.list.json +++ b/_assets/simulator/spec/methods/catalog.priceTypeGroup.list.json @@ -114,6 +114,13 @@ "required": "unknown", "description": "Общее количество найденных записей" }, + { + "name": "next", + "type": "integer", + "base": "integer", + "required": "unknown", + "description": "Значение параметра start для получения следующей страницы. Поле отсутствует, если получена последняя страница" + }, { "name": "time", "type": "time", @@ -129,5 +136,21 @@ "catalogGroupId", "groupId", "id" - ] + ], + "requestExample": { + "select": [ + "id", + "catalogGroupId", + "groupId", + "access" + ], + "filter": { + "catalogGroupId": 9, + "groupId": 23 + }, + "order": { + "id": "ASC" + }, + "start": 0 + } } diff --git a/_assets/simulator/spec/methods/catalog.priceTypeLang.add.json b/_assets/simulator/spec/methods/catalog.priceTypeLang.add.json index 5dae6c8b1..0d7729725 100644 --- a/_assets/simulator/spec/methods/catalog.priceTypeLang.add.json +++ b/_assets/simulator/spec/methods/catalog.priceTypeLang.add.json @@ -4,7 +4,7 @@ "scope": "catalog", "kind": "write", "title": "Добавить перевод названия типа цены catalog.priceTypeLang.add", - "permissions": "администратор", + "permissions": "пользователь с правом «Управление типами цен»", "params": [ { "name": "fields", @@ -95,5 +95,12 @@ } ], "page": "/api-reference/catalog/price-type/price-type-lang/catalog-price-type-lang-add.html", - "executable": false + "executable": false, + "requestExample": { + "fields": { + "catalogGroupId": 1, + "lang": "kz", + "name": "PRICE" + } + } } diff --git a/_assets/simulator/spec/methods/catalog.priceTypeLang.delete.json b/_assets/simulator/spec/methods/catalog.priceTypeLang.delete.json index 86e317f32..986dee69a 100644 --- a/_assets/simulator/spec/methods/catalog.priceTypeLang.delete.json +++ b/_assets/simulator/spec/methods/catalog.priceTypeLang.delete.json @@ -4,7 +4,7 @@ "scope": "catalog", "kind": "write", "title": "Удалить перевод названия типа цены catalog.priceTypeLang.delete", - "permissions": "администратор", + "permissions": "пользователь с правом «Управление типами цен»", "params": [ { "name": "id", @@ -49,5 +49,8 @@ } ], "page": "/api-reference/catalog/price-type/price-type-lang/catalog-price-type-lang-delete.html", - "executable": false + "executable": false, + "requestExample": { + "id": 3 + } } diff --git a/_assets/simulator/spec/methods/catalog.priceTypeLang.get.json b/_assets/simulator/spec/methods/catalog.priceTypeLang.get.json index 40b6dacb7..bb7a9a2de 100644 --- a/_assets/simulator/spec/methods/catalog.priceTypeLang.get.json +++ b/_assets/simulator/spec/methods/catalog.priceTypeLang.get.json @@ -4,7 +4,7 @@ "scope": "catalog", "kind": "read", "title": "Получить значения полей перевода названия типа цены catalog.priceTypeLang.get", - "permissions": "администратор", + "permissions": "пользователь с правом «Просмотр каталога товаров» или «Управление типами цен»", "params": [ { "name": "id", @@ -69,5 +69,8 @@ "id", "lang", "name" - ] + ], + "requestExample": { + "id": 2 + } } diff --git a/_assets/simulator/spec/methods/catalog.priceTypeLang.getLanguages.json b/_assets/simulator/spec/methods/catalog.priceTypeLang.getLanguages.json index 05ca195bb..8df0a8a35 100644 --- a/_assets/simulator/spec/methods/catalog.priceTypeLang.getLanguages.json +++ b/_assets/simulator/spec/methods/catalog.priceTypeLang.getLanguages.json @@ -4,7 +4,7 @@ "scope": "catalog", "kind": "write", "title": "Получить доступные для перевода языки catalog.priceTypeLang.getLanguages", - "permissions": "администратор", + "permissions": "пользователь с правом «Просмотр каталога товаров» или «Управление типами цен»", "params": [ { "name": "result", @@ -28,6 +28,13 @@ "note": "Состав полей не описан подтаблицей на этой странице" } }, + { + "name": "total", + "type": "integer", + "base": "integer", + "required": "unknown", + "description": "Общее количество языков" + }, { "name": "time", "type": "time", @@ -162,6 +169,13 @@ "required": "unknown", "description": "Массив объектов с информацией о доступных для перевода языках" }, + { + "name": "total", + "type": "integer", + "base": "integer", + "required": "unknown", + "description": "Общее количество языков" + }, { "name": "time", "type": "time", @@ -171,5 +185,6 @@ } ], "page": "/api-reference/catalog/price-type/price-type-lang/catalog-price-type-lang-get-languages.html", - "executable": false + "executable": false, + "requestExample": {} } diff --git a/_assets/simulator/spec/methods/catalog.priceTypeLang.list.json b/_assets/simulator/spec/methods/catalog.priceTypeLang.list.json index 4b62b8764..97c01b725 100644 --- a/_assets/simulator/spec/methods/catalog.priceTypeLang.list.json +++ b/_assets/simulator/spec/methods/catalog.priceTypeLang.list.json @@ -4,7 +4,7 @@ "scope": "catalog", "kind": "read", "title": "Получить список переводов названий типов цен по фильтру catalog.priceTypeLang.list", - "permissions": "администратор", + "permissions": "пользователь с правом «Просмотр каталога товаров» или «Управление типами цен»", "params": [ { "name": "select", @@ -117,6 +117,13 @@ "required": "unknown", "description": "Общее количество найденных записей" }, + { + "name": "next", + "type": "integer", + "base": "integer", + "required": "unknown", + "description": "Значение параметра start для получения следующей страницы. Поле отсутствует, если получена последняя страница" + }, { "name": "time", "type": "time", @@ -131,5 +138,14 @@ "catalogGroupId", "lang", "name" - ] + ], + "requestExample": { + "select": [ + "name", + "lang" + ], + "order": { + "lang": "ASC" + } + } } diff --git a/_assets/simulator/spec/methods/catalog.priceTypeLang.update.json b/_assets/simulator/spec/methods/catalog.priceTypeLang.update.json index 141306143..1b194613a 100644 --- a/_assets/simulator/spec/methods/catalog.priceTypeLang.update.json +++ b/_assets/simulator/spec/methods/catalog.priceTypeLang.update.json @@ -4,10 +4,10 @@ "scope": "catalog", "kind": "write", "title": "Изменить перевод названия типа цены catalog.priceTypeLang.update", - "permissions": "администратор", + "permissions": "пользователь с правом «Управление типами цен»", "params": [ { - "name": "Id", + "name": "id", "type": "catalog_price_type_lang.id", "base": "any", "required": true, @@ -102,5 +102,11 @@ } ], "page": "/api-reference/catalog/price-type/price-type-lang/catalog-price-type-lang-update.html", - "executable": false + "executable": false, + "requestExample": { + "id": 6, + "fields": { + "name": "Base Price" + } + } } diff --git a/_assets/simulator/spec/methods/catalog.product.delete.json b/_assets/simulator/spec/methods/catalog.product.delete.json index ddc298914..4c9f68992 100644 --- a/_assets/simulator/spec/methods/catalog.product.delete.json +++ b/_assets/simulator/spec/methods/catalog.product.delete.json @@ -48,5 +48,8 @@ } ], "page": "/api-reference/catalog/product/catalog-product-delete.html", - "executable": false + "executable": false, + "requestExample": { + "id": 1242 + } } diff --git a/_assets/simulator/spec/methods/catalog.product.download.json b/_assets/simulator/spec/methods/catalog.product.download.json index ed69be75c..7f969a985 100644 --- a/_assets/simulator/spec/methods/catalog.product.download.json +++ b/_assets/simulator/spec/methods/catalog.product.download.json @@ -58,5 +58,12 @@ }, "returns": [], "page": "/api-reference/catalog/product/catalog-product-download.html", - "executable": false + "executable": false, + "requestExample": { + "fields": { + "fileId": 6439, + "productId": 1243, + "fieldName": "detailPicture" + } + } } diff --git a/_assets/simulator/spec/methods/catalog.product.get.json b/_assets/simulator/spec/methods/catalog.product.get.json index 130d80af3..9b08c6eca 100644 --- a/_assets/simulator/spec/methods/catalog.product.get.json +++ b/_assets/simulator/spec/methods/catalog.product.get.json @@ -165,5 +165,8 @@ "width", "withoutOrder", "xmlId" - ] + ], + "requestExample": { + "id": 1243 + } } diff --git a/_assets/simulator/spec/methods/catalog.product.getFieldsByFilter.json b/_assets/simulator/spec/methods/catalog.product.getFieldsByFilter.json index 4a8ec7e7c..1738f6b24 100644 --- a/_assets/simulator/spec/methods/catalog.product.getFieldsByFilter.json +++ b/_assets/simulator/spec/methods/catalog.product.getFieldsByFilter.json @@ -371,5 +371,10 @@ } ], "page": "/api-reference/catalog/product/catalog-product-get-fields-by-filter.html", - "executable": false + "executable": false, + "requestExample": { + "filter": { + "iblockId": 23 + } + } } diff --git a/_assets/simulator/spec/methods/catalog.product.list.json b/_assets/simulator/spec/methods/catalog.product.list.json index 54a014512..b5f66d098 100644 --- a/_assets/simulator/spec/methods/catalog.product.list.json +++ b/_assets/simulator/spec/methods/catalog.product.list.json @@ -223,5 +223,64 @@ "width", "withoutOrder", "xmlId" - ] + ], + "requestExample": { + "select": [ + "id", + "iblockId", + "name", + "active", + "available", + "barcodeMulti", + "bundle", + "canBuyZero", + "code", + "createdBy", + "dateActiveFrom", + "dateActiveTo", + "dateCreate", + "detailPicture", + "detailText", + "detailTextType", + "height", + "iblockSectionId", + "length", + "measure", + "modifiedBy", + "previewPicture", + "previewText", + "previewTextType", + "purchasingCurrency", + "purchasingPrice", + "quantity", + "quantityReserved", + "quantityTrace", + "recurSchemeLength", + "recurSchemeType", + "sort", + "subscribe", + "timestampX", + "trialPriceId", + "type", + "vatId", + "vatIncluded", + "weight", + "width", + "withoutOrder", + "xmlId", + "property258", + "property259" + ], + "filter": { + "iblockId": 23, + ">id": 10, + "vatId": [ + 1, + 2 + ] + }, + "order": { + "id": "desc" + } + } } diff --git a/_assets/simulator/spec/methods/catalog.product.offer.delete.json b/_assets/simulator/spec/methods/catalog.product.offer.delete.json index a0becf0b1..e53231aa6 100644 --- a/_assets/simulator/spec/methods/catalog.product.offer.delete.json +++ b/_assets/simulator/spec/methods/catalog.product.offer.delete.json @@ -48,5 +48,8 @@ } ], "page": "/api-reference/catalog/product/offer/catalog-product-offer-delete.html", - "executable": false + "executable": false, + "requestExample": { + "id": 1285 + } } diff --git a/_assets/simulator/spec/methods/catalog.product.offer.download.json b/_assets/simulator/spec/methods/catalog.product.offer.download.json index dfa898aca..864afcb8c 100644 --- a/_assets/simulator/spec/methods/catalog.product.offer.download.json +++ b/_assets/simulator/spec/methods/catalog.product.offer.download.json @@ -11,7 +11,7 @@ "type": "object", "base": "object", "required": true, - "description": "Значения полей для скачивания файлов вариации товара", + "description": "Параметры файла вариации товара (подробное описание)", "ref": "#/defs/fieldsFields" } ], @@ -28,7 +28,7 @@ "type": "integer", "base": "integer", "required": true, - "description": "Идентификатор зарегистрированного файла. Для получения идентификаторов файлов вариации товара необходимо использовать catalog.product.offer.get либо catalog.product.offer.list" + "description": "Идентификатор зарегистрированного файла. Идентификатор возьмите из поля id объекта файла в ответе метода catalog.product.offer.get или catalog.product.offer.list" }, { "name": "productId", @@ -42,19 +42,19 @@ "type": "string", "base": "string", "required": true, - "description": "Имя поля (свойства или поля элемента информационного блока), в котором хранится файл. Возможные значения: - DETAIL_PICTURE — детальная картинка, поле доступно в старой карточке товара - PREVIEW_PICTURE — картинка для анонса, поле доступно в старой карточке товара - PROPERTY_N — свойство, где N — идентификатор свойства либо код свойства Для получения существующих идентификаторов либо кодов свойств…", + "description": "Имя поля, в котором хранится файл. Передавайте имя в camelCase — в том же формате, в котором поле возвращают методы catalog.product.offer.get и catalog.product.offer.list. Возможные значения: - detailPicture — детальная картинка, поле доступно в старой карточке товара - previewPicture — картинка для анонса, поле доступно в старой карточке товара - propertyN — файловое свойство, где N — идентификат…", "values": [ { - "value": "DETAIL_PICTURE", + "value": "detailPicture", "title": "детальная картинка, поле доступно в старой карточке товара" }, { - "value": "PREVIEW_PICTURE", + "value": "previewPicture", "title": "картинка для анонса, поле доступно в старой карточке товара" }, { - "value": "PROPERTY_N", - "title": "свойство, где N — идентификатор свойства либо код свойства Для получения существ" + "value": "propertyN", + "title": "файловое свойство, где N — идентификат…" } ] } @@ -67,10 +67,17 @@ "file": "api-reference/catalog/product/offer/catalog-product-offer-download.md" }, "resultExample": { - "error": 0, + "error": "0", "error_description": "Required fields: fileId" }, "returns": [], "page": "/api-reference/catalog/product/offer/catalog-product-offer-download.html", - "executable": false + "executable": false, + "requestExample": { + "fields": { + "fileId": 6538, + "productId": 1286, + "fieldName": "detailPicture" + } + } } diff --git a/_assets/simulator/spec/methods/catalog.product.offer.get.json b/_assets/simulator/spec/methods/catalog.product.offer.get.json index bcc1d9122..0d7931e1f 100644 --- a/_assets/simulator/spec/methods/catalog.product.offer.get.json +++ b/_assets/simulator/spec/methods/catalog.product.offer.get.json @@ -170,5 +170,8 @@ "width", "withoutOrder", "xmlId" - ] + ], + "requestExample": { + "id": 1286 + } } diff --git a/_assets/simulator/spec/methods/catalog.product.offer.getFieldsByFilter.json b/_assets/simulator/spec/methods/catalog.product.offer.getFieldsByFilter.json index 0faf79f3a..f981ff902 100644 --- a/_assets/simulator/spec/methods/catalog.product.offer.getFieldsByFilter.json +++ b/_assets/simulator/spec/methods/catalog.product.offer.getFieldsByFilter.json @@ -382,5 +382,10 @@ } ], "page": "/api-reference/catalog/product/offer/catalog-product-offer-get-fields-by-filter.html", - "executable": false + "executable": false, + "requestExample": { + "filter": { + "iblockId": 24 + } + } } diff --git a/_assets/simulator/spec/methods/catalog.product.offer.list.json b/_assets/simulator/spec/methods/catalog.product.offer.list.json index 3145e7591..293db15de 100644 --- a/_assets/simulator/spec/methods/catalog.product.offer.list.json +++ b/_assets/simulator/spec/methods/catalog.product.offer.list.json @@ -212,5 +212,65 @@ "width", "withoutOrder", "xmlId" - ] + ], + "requestExample": { + "select": [ + "id", + "iblockId", + "name", + "active", + "available", + "barcodeMulti", + "bundle", + "canBuyZero", + "code", + "createdBy", + "dateActiveFrom", + "dateActiveTo", + "dateCreate", + "detailPicture", + "detailText", + "detailTextType", + "height", + "iblockSectionId", + "length", + "measure", + "modifiedBy", + "previewPicture", + "previewText", + "previewTextType", + "purchasingCurrency", + "purchasingPrice", + "quantity", + "quantityReserved", + "quantityTrace", + "recurSchemeLength", + "recurSchemeType", + "sort", + "subscribe", + "timestampX", + "trialPriceId", + "type", + "vatId", + "vatIncluded", + "weight", + "width", + "withoutOrder", + "xmlId", + "parentId", + "property258", + "property259" + ], + "filter": { + "iblockId": 24, + ">id": 10, + "vatId": [ + 1, + 2 + ] + }, + "order": { + "id": "desc" + } + } } diff --git a/_assets/simulator/spec/methods/catalog.product.service.delete.json b/_assets/simulator/spec/methods/catalog.product.service.delete.json index 65e86f783..2f3170227 100644 --- a/_assets/simulator/spec/methods/catalog.product.service.delete.json +++ b/_assets/simulator/spec/methods/catalog.product.service.delete.json @@ -48,5 +48,8 @@ } ], "page": "/api-reference/catalog/product/service/catalog-product-service-delete.html", - "executable": false + "executable": false, + "requestExample": { + "id": 1264 + } } diff --git a/_assets/simulator/spec/methods/catalog.product.service.download.json b/_assets/simulator/spec/methods/catalog.product.service.download.json index 536e2c93b..e8b92b0c1 100644 --- a/_assets/simulator/spec/methods/catalog.product.service.download.json +++ b/_assets/simulator/spec/methods/catalog.product.service.download.json @@ -11,7 +11,7 @@ "type": "object", "base": "object", "required": true, - "description": "Значения полей для скачивания файлов услуги", + "description": "Параметры файла услуги (подробное описание)", "ref": "#/defs/fieldsFields" } ], @@ -42,19 +42,19 @@ "type": "string", "base": "string", "required": true, - "description": "Имя поля (свойства или поля элемента информационного блока), в котором хранится файл. Возможные значения: - DETAIL_PICTURE — детальная картинка, поле доступно в старой карточке товара - PREVIEW_PICTURE — картинка для анонса, поле доступно в старой карточке товара - PROPERTY_N — свойство, где N — идентификатор свойства либо код свойства Для получения существующих идентификаторов либо кодов свойств…", + "description": "Имя поля (свойства или поля элемента информационного блока), в котором хранится файл. Возможные значения: - detailPicture — детальная картинка, поле доступно в старой карточке товара - previewPicture — картинка для анонса, поле доступно в старой карточке товара - propertyN — файловое свойство, где N — идентификатор или символьный код свойства, например property258 или propertyMorePhoto Получить ид…", "values": [ { - "value": "DETAIL_PICTURE", + "value": "detailPicture", "title": "детальная картинка, поле доступно в старой карточке товара" }, { - "value": "PREVIEW_PICTURE", + "value": "previewPicture", "title": "картинка для анонса, поле доступно в старой карточке товара" }, { - "value": "PROPERTY_N", - "title": "свойство, где N — идентификатор свойства либо код свойства Для получения существ" + "value": "propertyN", + "title": "файловое свойство, где N — идентификатор или символьный код свойства, например p" } ] } @@ -72,5 +72,12 @@ }, "returns": [], "page": "/api-reference/catalog/product/service/catalog-product-service-download.html", - "executable": false + "executable": false, + "requestExample": { + "fields": { + "fileId": 6497, + "productId": 1265, + "fieldName": "detailPicture" + } + } } diff --git a/_assets/simulator/spec/methods/catalog.product.service.get.json b/_assets/simulator/spec/methods/catalog.product.service.get.json index f3344287c..50f593568 100644 --- a/_assets/simulator/spec/methods/catalog.product.service.get.json +++ b/_assets/simulator/spec/methods/catalog.product.service.get.json @@ -137,5 +137,8 @@ "vatId", "vatIncluded", "xmlId" - ] + ], + "requestExample": { + "id": 1265 + } } diff --git a/_assets/simulator/spec/methods/catalog.product.service.getFieldsByFilter.json b/_assets/simulator/spec/methods/catalog.product.service.getFieldsByFilter.json index 43eae4777..405094f6b 100644 --- a/_assets/simulator/spec/methods/catalog.product.service.getFieldsByFilter.json +++ b/_assets/simulator/spec/methods/catalog.product.service.getFieldsByFilter.json @@ -280,5 +280,10 @@ } ], "page": "/api-reference/catalog/product/service/catalog-product-service-get-fields-by-filter.html", - "executable": false + "executable": false, + "requestExample": { + "filter": { + "iblockId": 14 + } + } } diff --git a/_assets/simulator/spec/methods/catalog.product.service.list.json b/_assets/simulator/spec/methods/catalog.product.service.list.json index 3e0cd8abe..8256a8cf7 100644 --- a/_assets/simulator/spec/methods/catalog.product.service.list.json +++ b/_assets/simulator/spec/methods/catalog.product.service.list.json @@ -174,5 +174,47 @@ "vatId", "vatIncluded", "xmlId" - ] + ], + "requestExample": { + "select": [ + "id", + "iblockId", + "name", + "active", + "available", + "bundle", + "code", + "createdBy", + "dateActiveFrom", + "dateActiveTo", + "dateCreate", + "detailPicture", + "detailText", + "detailTextType", + "iblockSectionId", + "modifiedBy", + "previewPicture", + "previewText", + "previewTextType", + "sort", + "timestampX", + "type", + "vatId", + "vatIncluded", + "xmlId", + "property94", + "property95" + ], + "filter": { + "iblockId": 23, + ">id": 10, + "vatId": [ + 1, + 2 + ] + }, + "order": { + "id": "desc" + } + } } diff --git a/_assets/simulator/spec/methods/catalog.product.sku.delete.json b/_assets/simulator/spec/methods/catalog.product.sku.delete.json index 3d51751eb..f68e7a7a7 100644 --- a/_assets/simulator/spec/methods/catalog.product.sku.delete.json +++ b/_assets/simulator/spec/methods/catalog.product.sku.delete.json @@ -48,5 +48,8 @@ } ], "page": "/api-reference/catalog/product/sku/catalog-product-sku-delete.html", - "executable": false + "executable": false, + "requestExample": { + "id": 1288 + } } diff --git a/_assets/simulator/spec/methods/catalog.product.sku.download.json b/_assets/simulator/spec/methods/catalog.product.sku.download.json index e25218335..8448f27d4 100644 --- a/_assets/simulator/spec/methods/catalog.product.sku.download.json +++ b/_assets/simulator/spec/methods/catalog.product.sku.download.json @@ -72,5 +72,12 @@ }, "returns": [], "page": "/api-reference/catalog/product/sku/catalog-product-sku-download.html", - "executable": false + "executable": false, + "requestExample": { + "fields": { + "fileId": 6546, + "productId": 1289, + "fieldName": "detailPicture" + } + } } diff --git a/_assets/simulator/spec/methods/catalog.product.sku.get.json b/_assets/simulator/spec/methods/catalog.product.sku.get.json index 3c17ce1cb..3c86a9cf8 100644 --- a/_assets/simulator/spec/methods/catalog.product.sku.get.json +++ b/_assets/simulator/spec/methods/catalog.product.sku.get.json @@ -156,5 +156,8 @@ "weight", "width", "xmlId" - ] + ], + "requestExample": { + "id": 1289 + } } diff --git a/_assets/simulator/spec/methods/catalog.product.sku.getFieldsByFilter.json b/_assets/simulator/spec/methods/catalog.product.sku.getFieldsByFilter.json index 5a95144ea..4a8faba86 100644 --- a/_assets/simulator/spec/methods/catalog.product.sku.getFieldsByFilter.json +++ b/_assets/simulator/spec/methods/catalog.product.sku.getFieldsByFilter.json @@ -350,5 +350,10 @@ } ], "page": "/api-reference/catalog/product/sku/catalog-product-sku-get-fields-by-filter.html", - "executable": false + "executable": false, + "requestExample": { + "filter": { + "iblockId": 23 + } + } } diff --git a/_assets/simulator/spec/methods/catalog.product.sku.list.json b/_assets/simulator/spec/methods/catalog.product.sku.list.json index 2bd67771b..b554240ac 100644 --- a/_assets/simulator/spec/methods/catalog.product.sku.list.json +++ b/_assets/simulator/spec/methods/catalog.product.sku.list.json @@ -209,5 +209,57 @@ "weight", "width", "xmlId" - ] + ], + "requestExample": { + "select": [ + "id", + "iblockId", + "name", + "active", + "available", + "bundle", + "canBuyZero", + "code", + "createdBy", + "dateActiveFrom", + "dateActiveTo", + "dateCreate", + "detailPicture", + "detailText", + "detailTextType", + "height", + "iblockSectionId", + "length", + "measure", + "modifiedBy", + "previewPicture", + "previewText", + "previewTextType", + "purchasingCurrency", + "purchasingPrice", + "quantity", + "sort", + "subscribe", + "timestampX", + "type", + "vatId", + "vatIncluded", + "weight", + "width", + "xmlId", + "property258", + "property259" + ], + "filter": { + "iblockId": 23, + ">id": 10, + "vatId": [ + 1, + 2 + ] + }, + "order": { + "id": "desc" + } + } } diff --git a/_assets/simulator/spec/methods/catalog.productImage.add.json b/_assets/simulator/spec/methods/catalog.productImage.add.json index e46919264..bf2c91ee2 100644 --- a/_assets/simulator/spec/methods/catalog.productImage.add.json +++ b/_assets/simulator/spec/methods/catalog.productImage.add.json @@ -80,5 +80,15 @@ } ], "page": "/api-reference/catalog/product-image/catalog-product-image-add.html", - "executable": false + "executable": false, + "requestExample": { + "fields": { + "productId": 1, + "type": "MORE_PHOTO" + }, + "fileContent": [ + "test.jpeg", + "iVBORw0KGgoAAAANSUhEUgAAAMgAAADIBAMAAABfdrOtAAAAG1BMVEX37ff/­///58fn9+v3+/P779vv8+Pz47/j68/oDfe+3AAAACXBIWXMAAA7EAAAOxAGV­Kw4bAAABrUlEQVR4nO3UT0/CMBjH8ccx2I56IFynkHg1SgxHHCocSfQFGKP3­+e++xL1wn7bPUCAeKF5Mvp+EluX3ZN3ariIAAAAAAAAAAAAAAAAA/q2TwrXZ­ib94LTbj5GdgVbtKxhdXS+2uL270ajQbL9fz4WzcXwVWtbNeIdmt3qSQtwdJ­Ssku1/NHkfdVEKriHFey0G4haS3+ty4ZtEGoipMW+VS7T2m0zc+28tICq4rT­qXtuJV7kWdvsUJtuoc1Hm08ssKo4B1Wn1i6tJu5qrj9dA8lWEzOQEFhV3CCN­Tph2naJ0V+eu0SV+ry3WWQqBVcUNsgiP16ndS4SnzuffL5LWEgKrihqje7Y9­iDTN6mZ38geDNNX2dEm338b5XPafrmRuj/dj4fULfGoXeFTJ/guvayybW1i3­Vl7aM7h+3y2c+y07FfeZjaT9GHVrNYXPG/fkIbCqCPf+9d1WKiWtJSyP21r+­FaTrZ8+CULW7XliCUe0PyIUdkD29qQzdv7A0FoSq3R0fqaU78d0hPtw86hMX­99vAqqJlp757/W3vhMCqAAAAAAAAAAAAAAAAAPxbX82/SILlk9xfAAAAAElF­TkSuQmCCiVBORw0KGgoAAAANSUhEUgAAAMgAAADIBAMAAABfdrOtAAAAG1BM­VEX37ff////58fn9+v3+/P779vv8+Pz47/j68/oDfe+3AAAACXBIWXMAAA7E­AAAOxAGVKw4bAAABrUlEQVR4nO3UT0/CMBjH8ccx2I56IFynkHg1SgxHHCoc­SfQFGKP3+e++xL1wn7bPUCAeKF5Mvp+EluX3ZN3ariIAAAAAAAAAAAAAAAAA­/q2TwrXZib94LTbj5GdgVbtKxhdXS+2uL270ajQbL9fz4WzcXwVWtbNeIdmt­3qSQtwdJSsku1/NHkfdVEKriHFey0G4haS3+ty4ZtEGoipMW+VS7T2m0zc+2­8tICq4rTqXtuJV7kWdvsUJtuoc1Hm08ssKo4B1Wn1i6tJu5qrj9dA8lWEzOQ­EFhV3CCNTph2naJ0V+eu0SV+ry3WWQqBVcUNsgiP16ndS4SnzuffL5LWEgKr­ihqje7Y9iDTN6mZ38geDNNX2dEm338b5XPafrmRuj/dj4fULfGoXeFTJ/guv­ayybW1i3Vl7aM7h+3y2c+y07FfeZjaT9GHVrNYXPG/fkIbCqCPf+9d1WKiWt­JSyP21r+FaTrZ8+CULW7XliCUe0PyIUdkD29qQzdv7A0FoSq3R0fqaU78d0h­Ptw86hMX99vAqqJlp757/W3vhMCqAAAAAAAAAAAAAAAAAPxbX82/SILlk9xf­AAAAAElFTkSuQmCC" + ] + } } diff --git a/_assets/simulator/spec/methods/catalog.productImage.delete.json b/_assets/simulator/spec/methods/catalog.productImage.delete.json index 48facd844..ce5bb9fbe 100644 --- a/_assets/simulator/spec/methods/catalog.productImage.delete.json +++ b/_assets/simulator/spec/methods/catalog.productImage.delete.json @@ -44,5 +44,9 @@ } ], "page": "/api-reference/catalog/product-image/catalog-product-image-delete.html", - "executable": false + "executable": false, + "requestExample": { + "productId": 1, + "id": 1 + } } diff --git a/_assets/simulator/spec/methods/catalog.productImage.get.json b/_assets/simulator/spec/methods/catalog.productImage.get.json index d4f03f047..af23beb27 100644 --- a/_assets/simulator/spec/methods/catalog.productImage.get.json +++ b/_assets/simulator/spec/methods/catalog.productImage.get.json @@ -55,5 +55,9 @@ "entityFields": [ "productId", "type" - ] + ], + "requestExample": { + "productId": 1, + "id": 1 + } } diff --git a/_assets/simulator/spec/methods/catalog.productImage.list.json b/_assets/simulator/spec/methods/catalog.productImage.list.json index c9f162eb3..503070d21 100644 --- a/_assets/simulator/spec/methods/catalog.productImage.list.json +++ b/_assets/simulator/spec/methods/catalog.productImage.list.json @@ -66,5 +66,17 @@ "entityFields": [ "productId", "type" - ] + ], + "requestExample": { + "productId": 1, + "select": [ + "id", + "name", + "productId", + "type", + "createTime", + "downloadUrl", + "detailUrl" + ] + } } diff --git a/_assets/simulator/spec/methods/catalog.productProperty.add.json b/_assets/simulator/spec/methods/catalog.productProperty.add.json index c04aa7567..e5d5379b9 100644 --- a/_assets/simulator/spec/methods/catalog.productProperty.add.json +++ b/_assets/simulator/spec/methods/catalog.productProperty.add.json @@ -358,5 +358,21 @@ } ], "page": "/api-reference/catalog/product-property/catalog-product-property-add.html", - "executable": false + "executable": false, + "requestExample": { + "fields": { + "iblockId": 19, + "name": "Рубрика", + "code": "CATEGORY", + "propertyType": "S", + "userType": "directory", + "multiple": "N", + "isRequired": "N", + "active": "Y", + "sort": 100, + "userTypeSettings": { + "tableName": "b_hlbd_categories" + } + } + } } diff --git a/_assets/simulator/spec/methods/catalog.productProperty.delete.json b/_assets/simulator/spec/methods/catalog.productProperty.delete.json index d2311215a..58c1f95f0 100644 --- a/_assets/simulator/spec/methods/catalog.productProperty.delete.json +++ b/_assets/simulator/spec/methods/catalog.productProperty.delete.json @@ -50,5 +50,8 @@ } ], "page": "/api-reference/catalog/product-property/catalog-product-property-delete.html", - "executable": false + "executable": false, + "requestExample": { + "id": 659 + } } diff --git a/_assets/simulator/spec/methods/catalog.productProperty.get.json b/_assets/simulator/spec/methods/catalog.productProperty.get.json index 8dc09c115..05a4b46dc 100644 --- a/_assets/simulator/spec/methods/catalog.productProperty.get.json +++ b/_assets/simulator/spec/methods/catalog.productProperty.get.json @@ -116,5 +116,8 @@ "userTypeSettings", "withDescription", "xmlId" - ] + ], + "requestExample": { + "id": 659 + } } diff --git a/_assets/simulator/spec/methods/catalog.productProperty.getFields.json b/_assets/simulator/spec/methods/catalog.productProperty.getFields.json index ab65ba1c6..586888159 100644 --- a/_assets/simulator/spec/methods/catalog.productProperty.getFields.json +++ b/_assets/simulator/spec/methods/catalog.productProperty.getFields.json @@ -70,5 +70,6 @@ } ], "page": "/api-reference/catalog/product-property/catalog-product-property-get-fields.html", - "executable": false + "executable": false, + "requestExample": {} } diff --git a/_assets/simulator/spec/methods/catalog.productProperty.list.json b/_assets/simulator/spec/methods/catalog.productProperty.list.json index c56e2b90a..4a9bca999 100644 --- a/_assets/simulator/spec/methods/catalog.productProperty.list.json +++ b/_assets/simulator/spec/methods/catalog.productProperty.list.json @@ -125,5 +125,19 @@ "userTypeSettings", "withDescription", "xmlId" - ] + ], + "requestExample": { + "select": [ + "id", + "name", + "iblockId", + "propertyType" + ], + "filter": { + "iblockId": 19 + }, + "order": { + "id": "ASC" + } + } } diff --git a/_assets/simulator/spec/methods/catalog.productProperty.update.json b/_assets/simulator/spec/methods/catalog.productProperty.update.json index 1649ff561..3ca8c0893 100644 --- a/_assets/simulator/spec/methods/catalog.productProperty.update.json +++ b/_assets/simulator/spec/methods/catalog.productProperty.update.json @@ -333,5 +333,15 @@ } ], "page": "/api-reference/catalog/product-property/catalog-product-property-update.html", - "executable": false + "executable": false, + "requestExample": { + "id": 115, + "fields": { + "iblockId": 19, + "name": "Размер", + "propertyType": "L", + "isRequired": "Y", + "active": "Y" + } + } } diff --git a/_assets/simulator/spec/methods/catalog.productPropertyEnum.add.json b/_assets/simulator/spec/methods/catalog.productPropertyEnum.add.json index f381e4423..915d1ddfb 100644 --- a/_assets/simulator/spec/methods/catalog.productPropertyEnum.add.json +++ b/_assets/simulator/spec/methods/catalog.productPropertyEnum.add.json @@ -123,5 +123,14 @@ } ], "page": "/api-reference/catalog/product-property-enum/catalog-product-property-enum-add.html", - "executable": false + "executable": false, + "requestExample": { + "fields": { + "propertyId": 431, + "value": "Средний", + "xmlId": "M", + "def": "Y", + "sort": 100 + } + } } diff --git a/_assets/simulator/spec/methods/catalog.productPropertyEnum.delete.json b/_assets/simulator/spec/methods/catalog.productPropertyEnum.delete.json index a04e5346e..20d1f88ab 100644 --- a/_assets/simulator/spec/methods/catalog.productPropertyEnum.delete.json +++ b/_assets/simulator/spec/methods/catalog.productPropertyEnum.delete.json @@ -50,5 +50,8 @@ } ], "page": "/api-reference/catalog/product-property-enum/catalog-product-property-enum-delete.html", - "executable": false + "executable": false, + "requestExample": { + "id": 122 + } } diff --git a/_assets/simulator/spec/methods/catalog.productPropertyEnum.get.json b/_assets/simulator/spec/methods/catalog.productPropertyEnum.get.json index 8e03e0b09..995826d36 100644 --- a/_assets/simulator/spec/methods/catalog.productPropertyEnum.get.json +++ b/_assets/simulator/spec/methods/catalog.productPropertyEnum.get.json @@ -74,5 +74,8 @@ "sort", "value", "xmlId" - ] + ], + "requestExample": { + "id": 1739 + } } diff --git a/_assets/simulator/spec/methods/catalog.productPropertyEnum.getFields.json b/_assets/simulator/spec/methods/catalog.productPropertyEnum.getFields.json index 9faca9cc0..e0d53f776 100644 --- a/_assets/simulator/spec/methods/catalog.productPropertyEnum.getFields.json +++ b/_assets/simulator/spec/methods/catalog.productPropertyEnum.getFields.json @@ -122,5 +122,6 @@ } ], "page": "/api-reference/catalog/product-property-enum/catalog-product-property-enum-get-fields.html", - "executable": false + "executable": false, + "requestExample": {} } diff --git a/_assets/simulator/spec/methods/catalog.productPropertyEnum.list.json b/_assets/simulator/spec/methods/catalog.productPropertyEnum.list.json index ccbe0690c..0b2416e6b 100644 --- a/_assets/simulator/spec/methods/catalog.productPropertyEnum.list.json +++ b/_assets/simulator/spec/methods/catalog.productPropertyEnum.list.json @@ -166,5 +166,21 @@ "sort", "value", "xmlId" - ] + ], + "requestExample": { + "select": [ + "id", + "propertyId", + "value", + "def", + "sort", + "xmlId" + ], + "filter": { + "propertyId": 431 + }, + "order": { + "id": "ASC" + } + } } diff --git a/_assets/simulator/spec/methods/catalog.productPropertyEnum.update.json b/_assets/simulator/spec/methods/catalog.productPropertyEnum.update.json index d188ca5ff..5b4d46aa7 100644 --- a/_assets/simulator/spec/methods/catalog.productPropertyEnum.update.json +++ b/_assets/simulator/spec/methods/catalog.productPropertyEnum.update.json @@ -130,5 +130,15 @@ } ], "page": "/api-reference/catalog/product-property-enum/catalog-product-property-enum-update.html", - "executable": false + "executable": false, + "requestExample": { + "id": 1739, + "fields": { + "propertyId": 431, + "value": "Средний", + "xmlId": "M", + "def": "N", + "sort": 110 + } + } } diff --git a/_assets/simulator/spec/methods/catalog.productPropertyFeature.add.json b/_assets/simulator/spec/methods/catalog.productPropertyFeature.add.json index a59ccdb59..7cecc3769 100644 --- a/_assets/simulator/spec/methods/catalog.productPropertyFeature.add.json +++ b/_assets/simulator/spec/methods/catalog.productPropertyFeature.add.json @@ -115,5 +115,13 @@ } ], "page": "/api-reference/catalog/product-property-feature/catalog-product-property-feature-add.html", - "executable": false + "executable": false, + "requestExample": { + "fields": { + "propertyId": 901, + "moduleId": "iblock", + "featureId": "LIST_PAGE_SHOW", + "isEnabled": "Y" + } + } } diff --git a/_assets/simulator/spec/methods/catalog.productPropertyFeature.get.json b/_assets/simulator/spec/methods/catalog.productPropertyFeature.get.json index e0d2bbca1..7895bd7b7 100644 --- a/_assets/simulator/spec/methods/catalog.productPropertyFeature.get.json +++ b/_assets/simulator/spec/methods/catalog.productPropertyFeature.get.json @@ -72,5 +72,8 @@ "isEnabled", "moduleId", "propertyId" - ] + ], + "requestExample": { + "id": 101 + } } diff --git a/_assets/simulator/spec/methods/catalog.productPropertyFeature.getAvailableFeaturesByProperty.json b/_assets/simulator/spec/methods/catalog.productPropertyFeature.getAvailableFeaturesByProperty.json index 40603bb5f..388d164f6 100644 --- a/_assets/simulator/spec/methods/catalog.productPropertyFeature.getAvailableFeaturesByProperty.json +++ b/_assets/simulator/spec/methods/catalog.productPropertyFeature.getAvailableFeaturesByProperty.json @@ -70,5 +70,8 @@ } ], "page": "/api-reference/catalog/product-property-feature/catalog-product-property-feature-get-available-features-by-property.html", - "executable": false + "executable": false, + "requestExample": { + "propertyId": 901 + } } diff --git a/_assets/simulator/spec/methods/catalog.productPropertyFeature.getFields.json b/_assets/simulator/spec/methods/catalog.productPropertyFeature.getFields.json index a8da2b78d..bf3cc5afc 100644 --- a/_assets/simulator/spec/methods/catalog.productPropertyFeature.getFields.json +++ b/_assets/simulator/spec/methods/catalog.productPropertyFeature.getFields.json @@ -116,5 +116,6 @@ } ], "page": "/api-reference/catalog/product-property-feature/catalog-product-property-feature-get-fields.html", - "executable": false + "executable": false, + "requestExample": {} } diff --git a/_assets/simulator/spec/methods/catalog.productPropertyFeature.list.json b/_assets/simulator/spec/methods/catalog.productPropertyFeature.list.json index e6a2bb67f..61c2b4e9e 100644 --- a/_assets/simulator/spec/methods/catalog.productPropertyFeature.list.json +++ b/_assets/simulator/spec/methods/catalog.productPropertyFeature.list.json @@ -139,5 +139,20 @@ "isEnabled", "moduleId", "propertyId" - ] + ], + "requestExample": { + "select": [ + "id", + "propertyId", + "moduleId", + "featureId", + "isEnabled" + ], + "filter": { + "propertyId": 901 + }, + "order": { + "id": "ASC" + } + } } diff --git a/_assets/simulator/spec/methods/catalog.productPropertyFeature.update.json b/_assets/simulator/spec/methods/catalog.productPropertyFeature.update.json index 6e3a11009..1cb826cb7 100644 --- a/_assets/simulator/spec/methods/catalog.productPropertyFeature.update.json +++ b/_assets/simulator/spec/methods/catalog.productPropertyFeature.update.json @@ -122,5 +122,14 @@ } ], "page": "/api-reference/catalog/product-property-feature/catalog-product-property-feature-update.html", - "executable": false + "executable": false, + "requestExample": { + "id": 101, + "fields": { + "propertyId": 901, + "moduleId": "iblock", + "featureId": "LIST_PAGE_SHOW", + "isEnabled": "N" + } + } } diff --git a/_assets/simulator/spec/methods/catalog.productPropertySection.get.json b/_assets/simulator/spec/methods/catalog.productPropertySection.get.json index 0c09eebba..7d553a2d4 100644 --- a/_assets/simulator/spec/methods/catalog.productPropertySection.get.json +++ b/_assets/simulator/spec/methods/catalog.productPropertySection.get.json @@ -72,5 +72,8 @@ "filterHint", "propertyId", "smartFilter" - ] + ], + "requestExample": { + "propertyId": 901 + } } diff --git a/_assets/simulator/spec/methods/catalog.productPropertySection.list.json b/_assets/simulator/spec/methods/catalog.productPropertySection.list.json index ab3cc70e1..8f737cb32 100644 --- a/_assets/simulator/spec/methods/catalog.productPropertySection.list.json +++ b/_assets/simulator/spec/methods/catalog.productPropertySection.list.json @@ -132,5 +132,20 @@ "filterHint", "propertyId", "smartFilter" - ] + ], + "requestExample": { + "select": [ + "propertyId", + "smartFilter", + "displayType", + "displayExpanded", + "filterHint" + ], + "filter": { + "propertyId": 901 + }, + "order": { + "propertyId": "ASC" + } + } } diff --git a/_assets/simulator/spec/methods/catalog.productPropertySection.set.json b/_assets/simulator/spec/methods/catalog.productPropertySection.set.json index 929f3557b..ca8a438af 100644 --- a/_assets/simulator/spec/methods/catalog.productPropertySection.set.json +++ b/_assets/simulator/spec/methods/catalog.productPropertySection.set.json @@ -150,5 +150,14 @@ } ], "page": "/api-reference/catalog/product-property-section/catalog-product-property-section-set.html", - "executable": false + "executable": false, + "requestExample": { + "propertyId": 901, + "fields": { + "smartFilter": "Y", + "displayType": "F", + "displayExpanded": "N", + "filterHint": "Подсказка для фильтра" + } + } } diff --git a/_assets/simulator/spec/methods/catalog.ratio.get.json b/_assets/simulator/spec/methods/catalog.ratio.get.json index 4669dae27..a192767ba 100644 --- a/_assets/simulator/spec/methods/catalog.ratio.get.json +++ b/_assets/simulator/spec/methods/catalog.ratio.get.json @@ -44,5 +44,8 @@ } ], "page": "/api-reference/catalog/ratio/catalog-ratio-get.html", - "executable": false + "executable": false, + "requestExample": { + "id": 1 + } } diff --git a/_assets/simulator/spec/methods/catalog.ratio.list.json b/_assets/simulator/spec/methods/catalog.ratio.list.json index a3bb54094..655a15cee 100644 --- a/_assets/simulator/spec/methods/catalog.ratio.list.json +++ b/_assets/simulator/spec/methods/catalog.ratio.list.json @@ -94,5 +94,24 @@ } ], "page": "/api-reference/catalog/ratio/catalog-ratio-list.html", - "executable": false + "executable": false, + "requestExample": { + "select": [ + "id", + "productId", + "ratio", + "isDefault" + ], + "filter": { + "@productId": [ + 1, + 2 + ], + ">ratio": 0.5, + "isDefault": "Y" + }, + "order": { + "id": "desc" + } + } } diff --git a/_assets/simulator/spec/methods/catalog.roundingRule.add.json b/_assets/simulator/spec/methods/catalog.roundingRule.add.json index b63feadbb..57a091826 100644 --- a/_assets/simulator/spec/methods/catalog.roundingRule.add.json +++ b/_assets/simulator/spec/methods/catalog.roundingRule.add.json @@ -121,5 +121,13 @@ } ], "page": "/api-reference/catalog/rounding-rule/catalog-rounding-rule-add.html", - "executable": false + "executable": false, + "requestExample": { + "fields": { + "catalogGroupId": 14, + "price": 1000, + "roundType": 4, + "roundPrecision": 100 + } + } } diff --git a/_assets/simulator/spec/methods/catalog.roundingRule.delete.json b/_assets/simulator/spec/methods/catalog.roundingRule.delete.json index 2a857d18b..c9caea564 100644 --- a/_assets/simulator/spec/methods/catalog.roundingRule.delete.json +++ b/_assets/simulator/spec/methods/catalog.roundingRule.delete.json @@ -49,5 +49,8 @@ } ], "page": "/api-reference/catalog/rounding-rule/catalog-rounding-rule-delete.html", - "executable": false + "executable": false, + "requestExample": { + "id": 1 + } } diff --git a/_assets/simulator/spec/methods/catalog.roundingRule.get.json b/_assets/simulator/spec/methods/catalog.roundingRule.get.json index 2fcd276f5..8b094d6bc 100644 --- a/_assets/simulator/spec/methods/catalog.roundingRule.get.json +++ b/_assets/simulator/spec/methods/catalog.roundingRule.get.json @@ -79,5 +79,8 @@ "price", "roundPrecision", "roundType" - ] + ], + "requestExample": { + "id": 1 + } } diff --git a/_assets/simulator/spec/methods/catalog.roundingRule.list.json b/_assets/simulator/spec/methods/catalog.roundingRule.list.json index 30bab8514..8382352a3 100644 --- a/_assets/simulator/spec/methods/catalog.roundingRule.list.json +++ b/_assets/simulator/spec/methods/catalog.roundingRule.list.json @@ -129,5 +129,18 @@ "price", "roundPrecision", "roundType" - ] + ], + "requestExample": { + "select": [ + "id", + "price", + "roundType" + ], + "filter": { + "modifiedBy": 1 + }, + "order": { + "id": "ASC" + } + } } diff --git a/_assets/simulator/spec/methods/catalog.section.add.json b/_assets/simulator/spec/methods/catalog.section.add.json index 3a7a6a0ed..dfdce35f9 100644 --- a/_assets/simulator/spec/methods/catalog.section.add.json +++ b/_assets/simulator/spec/methods/catalog.section.add.json @@ -143,5 +143,18 @@ } ], "page": "/api-reference/catalog/section/catalog-section-add.html", - "executable": false + "executable": false, + "requestExample": { + "fields": { + "name": "Детские игрушки", + "iblockId": 14, + "iblockSectionId": 13, + "sort": "100", + "active": "Y", + "code": "toys", + "xmlId": "myXmlId", + "description": "Товары для детей - игрушки", + "descriptionType": "text" + } + } } diff --git a/_assets/simulator/spec/methods/catalog.section.delete.json b/_assets/simulator/spec/methods/catalog.section.delete.json index c8ab7e731..636f5638d 100644 --- a/_assets/simulator/spec/methods/catalog.section.delete.json +++ b/_assets/simulator/spec/methods/catalog.section.delete.json @@ -49,5 +49,8 @@ } ], "page": "/api-reference/catalog/section/catalog-section-delete.html", - "executable": false + "executable": false, + "requestExample": { + "id": 31 + } } diff --git a/_assets/simulator/spec/methods/catalog.section.get.json b/_assets/simulator/spec/methods/catalog.section.get.json index c0af1aa3b..aa91c08e5 100644 --- a/_assets/simulator/spec/methods/catalog.section.get.json +++ b/_assets/simulator/spec/methods/catalog.section.get.json @@ -81,5 +81,8 @@ "name", "sort", "xmlId" - ] + ], + "requestExample": { + "id": 31 + } } diff --git a/_assets/simulator/spec/methods/catalog.section.list.json b/_assets/simulator/spec/methods/catalog.section.list.json index 5b5916e3b..2aba18c6f 100644 --- a/_assets/simulator/spec/methods/catalog.section.list.json +++ b/_assets/simulator/spec/methods/catalog.section.list.json @@ -134,5 +134,19 @@ "name", "sort", "xmlId" - ] + ], + "requestExample": { + "select": [ + "id", + "name", + "sort" + ], + "filter": { + "iblockId": 14, + "<=sort": 100 + }, + "order": { + "sort": "DESC" + } + } } diff --git a/_assets/simulator/spec/methods/catalog.section.update.json b/_assets/simulator/spec/methods/catalog.section.update.json index be289ac9d..5f4b31105 100644 --- a/_assets/simulator/spec/methods/catalog.section.update.json +++ b/_assets/simulator/spec/methods/catalog.section.update.json @@ -150,5 +150,14 @@ } ], "page": "/api-reference/catalog/section/catalog-section-update.html", - "executable": false + "executable": false, + "requestExample": { + "id": 32, + "fields": { + "iblockId": 14, + "name": "Детские игрушки", + "description": "

Детские игрушки

Товары для детей

", + "descriptionType": "html" + } + } } diff --git a/_assets/simulator/spec/methods/catalog.store.add.json b/_assets/simulator/spec/methods/catalog.store.add.json index 6d9a384f1..7d1d40cba 100644 --- a/_assets/simulator/spec/methods/catalog.store.add.json +++ b/_assets/simulator/spec/methods/catalog.store.add.json @@ -201,5 +201,32 @@ } ], "page": "/api-reference/catalog/store/catalog-store-add.html", - "executable": false + "executable": false, + "requestExample": { + "fields": { + "address": "пр. Московский д. 52", + "title": "Склад 1", + "active": "Y", + "description": "Описание", + "gpsN": "54.71411", + "gpsS": "21.56675", + "imageId": { + "fileData": [ + "detailPicture.png", + "iVBORw0KGgoAAAANSUhEUgAAAMgAAADIBAMAAABfdrOtAAAAG1BMVEX37ff/­///58fn9+v3+/P779vv8+Pz47/j68/oDfe+3AAAACXBIWXMAAA7EAAAOxAGV­Kw4bAAABrUlEQVR4nO3UT0/CMBjH8ccx2I56IFynkHg1SgxHHCocSfQFGKP3­+e++xL1wn7bPUCAeKF5Mvp+EluX3ZN3ariIAAAAAAAAAAAAAAAAA/q2TwrXZ­ib94LTbj5GdgVbtKxhdXS+2uL270ajQbL9fz4WzcXwVWtbNeIdmt3qSQtwdJ­Ssku1/NHkfdVEKriHFey0G4haS3+ty4ZtEGoipMW+VS7T2m0zc+28tICq4rT­qXtuJV7kWdvsUJtuoc1Hm08ssKo4B1Wn1i6tJu5qrj9dA8lWEzOQEFhV3CCN­Tph2naJ0V+eu0SV+ry3WWQqBVcUNsgiP16ndS4SnzuffL5LWEgKrihqje7Y9­iDTN6mZ38geDNNX2dEm338b5XPafrmRuj/dj4fULfGoXeFTJ/guvayybW1i3­Vl7aM7h+3y2c+y07FfeZjaT9GHVrNYXPG/fkIbCqCPf+9d1WKiWtJSyP21r+­FaTrZ8+CULW7XliCUe0PyIUdkD29qQzdv7A0FoSq3R0fqaU78d0hPtw86hMX­99vAqqJlp757/W3vhMCqAAAAAAAAAAAAAAAAAPxbX82/SILlk9xfAAAAAElF­TkSuQmCCiVBORw0KGgoAAAANSUhEUgAAAMgAAADIBAMAAABfdrOtAAAAG1BM­VEX37ff////58fn9+v3+/P779vv8+Pz47/j68/oDfe+3AAAACXBIWXMAAA7E­AAAOxAGVKw4bAAABrUlEQVR4nO3UT0/CMBjH8ccx2I56IFynkHg1SgxHHCoc­SfQFGKP3+e++xL1wn7bPUCAeKF5Mvp+EluX3ZN3ariIAAAAAAAAAAAAAAAAA­/q2TwrXZib94LTbj5GdgVbtKxhdXS+2uL270ajQbL9fz4WzcXwVWtbNeIdmt­3qSQtwdJSsku1/NHkfdVEKriHFey0G4haS3+ty4ZtEGoipMW+VS7T2m0zc+2­8tICq4rTqXtuJV7kWdvsUJtuoc1Hm08ssKo4B1Wn1i6tJu5qrj9dA8lWEzOQ­EFhV3CCNTph2naJ0V+eu0SV+ry3WWQqBVcUNsgiP16ndS4SnzuffL5LWEgKr­ihqje7Y9iDTN6mZ38geDNNX2dEm338b5XPafrmRuj/dj4fULfGoXeFTJ/guv­ayybW1i3Vl7aM7h+3y2c+y07FfeZjaT9GHVrNYXPG/fkIbCqCPf+9d1WKiWt­JSyP21r+FaTrZ8+CULW7XliCUe0PyIUdkD29qQzdv7A0FoSq3R0fqaU78d0h­Ptw86hMX99vAqqJlp757/W3vhMCqAAAAAAAAAAAAAAAAAPxbX82/SILlk9xf­AAAAAElFTkSuQmCC" + ] + }, + "dateModify": "2024-10-21T10:00:00", + "dateCreate": "2024-10-21T10:00:00", + "userId": 1, + "modifiedBy": 1, + "phone": "8 (495) 212 85 06", + "schedule": "Пн.-Пт. с 9:00 до 20:00, Сб.-Вс. с 11:00 до 18:00", + "xmlId": "", + "sort": 100, + "email": "test@test.ru", + "issuingCenter": "N", + "code": "store_1" + } + } } diff --git a/_assets/simulator/spec/methods/catalog.store.delete.json b/_assets/simulator/spec/methods/catalog.store.delete.json index 65aa1c5e4..36e0c03e3 100644 --- a/_assets/simulator/spec/methods/catalog.store.delete.json +++ b/_assets/simulator/spec/methods/catalog.store.delete.json @@ -37,5 +37,8 @@ } ], "page": "/api-reference/catalog/store/catalog-store-delete.html", - "executable": false + "executable": false, + "requestExample": { + "id": 1 + } } diff --git a/_assets/simulator/spec/methods/catalog.store.get.json b/_assets/simulator/spec/methods/catalog.store.get.json index 0ac2373eb..3124be6e7 100644 --- a/_assets/simulator/spec/methods/catalog.store.get.json +++ b/_assets/simulator/spec/methods/catalog.store.get.json @@ -64,5 +64,8 @@ "title", "userId", "xmlId" - ] + ], + "requestExample": { + "id": 1 + } } diff --git a/_assets/simulator/spec/methods/catalog.store.list.json b/_assets/simulator/spec/methods/catalog.store.list.json index c4aab866e..e60146b47 100644 --- a/_assets/simulator/spec/methods/catalog.store.list.json +++ b/_assets/simulator/spec/methods/catalog.store.list.json @@ -154,5 +154,39 @@ "title", "userId", "xmlId" - ] + ], + "requestExample": { + "select": [ + "id", + "title", + "active", + "address", + "description", + "gpsN", + "gpsS", + "imageId", + "dateModify", + "dateCreate", + "userId", + "modifiedBy", + "phone", + "schedule", + "xmlId", + "sort", + "email", + "issuingCenter", + "code" + ], + "filter": { + "@userId": [ + 1, + 2 + ], + "=sort": 200 + }, + "order": { + "id": "ASC" + } + } } diff --git a/_assets/simulator/spec/methods/catalog.vat.update.json b/_assets/simulator/spec/methods/catalog.vat.update.json index 5fc8c1232..55d11959f 100644 --- a/_assets/simulator/spec/methods/catalog.vat.update.json +++ b/_assets/simulator/spec/methods/catalog.vat.update.json @@ -121,5 +121,14 @@ } ], "page": "/api-reference/catalog/vat/catalog-vat-update.html", - "executable": false + "executable": false, + "requestExample": { + "id": 6, + "fields": { + "name": "Налог 23%", + "rate": 23, + "sort": 20, + "active": "Y" + } + } } diff --git a/_assets/simulator/spec/methods/crm.activity.badge.add.json b/_assets/simulator/spec/methods/crm.activity.badge.add.json index 12109c9ca..892dcd754 100644 --- a/_assets/simulator/spec/methods/crm.activity.badge.add.json +++ b/_assets/simulator/spec/methods/crm.activity.badge.add.json @@ -4,35 +4,35 @@ "scope": "crm", "kind": "write", "title": "Добавить бейдж crm.activity.badge.add", - "permissions": "пользователи с административным доступом к разделу crm", + "permissions": "пользователь с административным доступом к разделу CRM", "params": [ { "name": "code", "type": "string", "base": "string", "required": true, - "description": "Код бейджа, например missedCall" + "description": "Код бейджа, например missedCall. Не длиннее 30 символов и уникальный" }, { "name": "title", "type": "string", "base": "string", "required": true, - "description": "Заголовок бейджа. Может быть строкой или массивом строк для разных языков" + "description": "Название бейджа. Строка или объект с переводами, где ключ — код языка" }, { "name": "value", "type": "string", "base": "string", "required": true, - "description": "Заголовок бейджа. Может быть строкой или массивом строк для разных языков" + "description": "Текст внутри значка, выводится в верхнем регистре. Строка или объект с переводами" }, { "name": "type", "type": "string", "base": "string", "required": true, - "description": "Тип бейджа" + "description": "Тип бейджа. Определяет цвет значка: success, failure, warning, primary или secondary" } ], "defs": {}, @@ -66,7 +66,7 @@ "type": "object", "base": "object", "required": false, - "description": "Корневой элемент ответа, содержащий информацию о добавленном бейдже в случае успеха. В случае неудачи вернет null" + "description": "Корневой элемент ответа с единственным ключом badge (подробное описание)" }, { "name": "time", @@ -77,5 +77,11 @@ } ], "page": "/api-reference/crm/timeline/activities/configurable/badges/crm-activity-badge-add.html", - "executable": false + "executable": false, + "requestExample": { + "code": "missedCall", + "title": "Статус звонка", + "value": "Пропущен", + "type": "failure" + } } diff --git a/_assets/simulator/spec/methods/crm.activity.badge.delete.json b/_assets/simulator/spec/methods/crm.activity.badge.delete.json index 62f9f5d57..f549b5998 100644 --- a/_assets/simulator/spec/methods/crm.activity.badge.delete.json +++ b/_assets/simulator/spec/methods/crm.activity.badge.delete.json @@ -4,14 +4,14 @@ "scope": "crm", "kind": "write", "title": "Удалить бейдж по коду crm.activity.badge.delete", - "permissions": "пользователи с административным доступом к разделу crm", + "permissions": "пользователь с административным доступом к разделу CRM", "params": [ { "name": "code", "type": "string", "base": "string", "required": true, - "description": "Код бейджа, например missedCall" + "description": "Код бейджа, например missedCall. Список занятых кодов возвращает метод crm.activity.badge.list" } ], "defs": {}, @@ -38,7 +38,7 @@ "type": "boolean", "base": "boolean", "required": false, - "description": "Корневой элемент ответа. Содержит: - true — в случае успеха - null — в случае неудачи (произошла ошибка)" + "description": "Содержит true, если бейдж удален. При ошибке поля result в ответе нет — вместо него приходят error и error_description" }, { "name": "time", @@ -49,5 +49,8 @@ } ], "page": "/api-reference/crm/timeline/activities/configurable/badges/crm-activity-badge-delete.html", - "executable": false + "executable": false, + "requestExample": { + "code": "missedCall" + } } diff --git a/_assets/simulator/spec/methods/crm.activity.badge.get.json b/_assets/simulator/spec/methods/crm.activity.badge.get.json index 3dcdcb1e9..91a6d912c 100644 --- a/_assets/simulator/spec/methods/crm.activity.badge.get.json +++ b/_assets/simulator/spec/methods/crm.activity.badge.get.json @@ -11,7 +11,7 @@ "type": "string", "base": "string", "required": true, - "description": "Код бейджа, например missedCall" + "description": "Код бейджа, например missedCall. Список занятых кодов возвращает метод crm.activity.badge.list" } ], "defs": {}, @@ -45,7 +45,7 @@ "type": "object", "base": "object", "required": false, - "description": "Корневой элемент ответа, содержащий информацию о бейдже в случае успеха. В случае неудачи вернет null" + "description": "Корневой элемент ответа с единственным ключом badge (подробное описание)" }, { "name": "time", @@ -62,5 +62,8 @@ "title", "type", "value" - ] + ], + "requestExample": { + "code": "missedCall" + } } diff --git a/_assets/simulator/spec/methods/crm.activity.badge.list.json b/_assets/simulator/spec/methods/crm.activity.badge.list.json index 87b4c67ff..82155217b 100644 --- a/_assets/simulator/spec/methods/crm.activity.badge.list.json +++ b/_assets/simulator/spec/methods/crm.activity.badge.list.json @@ -8,15 +8,22 @@ "params": [ { "name": "result", - "type": "array", - "base": "array", + "type": "object", + "base": "object", "required": "unknown", - "description": "Корневой элемент ответа, содержащий массив, каждый элемент которого несет информацию о бейдже", + "description": "Корневой элемент ответа с единственным ключом badges (подробное описание)", "dynamic": { "allowed": true, "note": "Состав полей не описан подтаблицей на этой странице" } }, + { + "name": "total", + "type": "integer", + "base": "integer", + "required": "unknown", + "description": "Количество бейджей в ответе" + }, { "name": "time", "type": "time", @@ -46,6 +53,7 @@ } ] }, + "total": 1, "time": { "start": 1724068028.331234, "finish": 1724068028.726591, @@ -59,10 +67,17 @@ "returns": [ { "name": "result", - "type": "array", - "base": "array", + "type": "object", + "base": "object", "required": "unknown", - "description": "Корневой элемент ответа, содержащий массив, каждый элемент которого несет информацию о бейдже" + "description": "Корневой элемент ответа с единственным ключом badges (подробное описание)" + }, + { + "name": "total", + "type": "integer", + "base": "integer", + "required": "unknown", + "description": "Количество бейджей в ответе" }, { "name": "time", @@ -79,5 +94,6 @@ "title", "type", "value" - ] + ], + "requestExample": {} } diff --git a/_assets/simulator/spec/methods/crm.activity.binding.add.json b/_assets/simulator/spec/methods/crm.activity.binding.add.json index 188754386..cc08f7399 100644 --- a/_assets/simulator/spec/methods/crm.activity.binding.add.json +++ b/_assets/simulator/spec/methods/crm.activity.binding.add.json @@ -64,5 +64,10 @@ } ], "page": "/api-reference/crm/timeline/activities/binding/crm-activity-binding-add.html", - "executable": false + "executable": false, + "requestExample": { + "activityId": 999, + "entityTypeId": 2, + "entityId": 1 + } } diff --git a/_assets/simulator/spec/methods/crm.activity.binding.delete.json b/_assets/simulator/spec/methods/crm.activity.binding.delete.json index c53534e6b..6904f42a3 100644 --- a/_assets/simulator/spec/methods/crm.activity.binding.delete.json +++ b/_assets/simulator/spec/methods/crm.activity.binding.delete.json @@ -64,5 +64,10 @@ } ], "page": "/api-reference/crm/timeline/activities/binding/crm-activity-binding-delete.html", - "executable": false + "executable": false, + "requestExample": { + "activityId": 999, + "entityTypeId": 2, + "entityId": 1 + } } diff --git a/_assets/simulator/spec/methods/crm.activity.binding.list.json b/_assets/simulator/spec/methods/crm.activity.binding.list.json index 6bee2c7b1..721000015 100644 --- a/_assets/simulator/spec/methods/crm.activity.binding.list.json +++ b/_assets/simulator/spec/methods/crm.activity.binding.list.json @@ -67,5 +67,8 @@ "entityFields": [ "entityId", "entityTypeId" - ] + ], + "requestExample": { + "activityId": 999 + } } diff --git a/_assets/simulator/spec/methods/crm.activity.binding.move.json b/_assets/simulator/spec/methods/crm.activity.binding.move.json index 53e180f12..4ecb19454 100644 --- a/_assets/simulator/spec/methods/crm.activity.binding.move.json +++ b/_assets/simulator/spec/methods/crm.activity.binding.move.json @@ -78,5 +78,12 @@ } ], "page": "/api-reference/crm/timeline/activities/binding/crm-activity-binding-move.html", - "executable": false + "executable": false, + "requestExample": { + "activityId": 999, + "sourceEntityTypeId": 2, + "sourceEntityId": 1, + "targetEntityTypeId": 2, + "targetEntityId": 100 + } } diff --git a/_assets/simulator/spec/methods/crm.activity.call.getTranscript.json b/_assets/simulator/spec/methods/crm.activity.call.getTranscript.json index ffff6784d..cd5403e02 100644 --- a/_assets/simulator/spec/methods/crm.activity.call.getTranscript.json +++ b/_assets/simulator/spec/methods/crm.activity.call.getTranscript.json @@ -50,5 +50,8 @@ } ], "page": "/api-reference/crm/timeline/activities/activity-base/crm-activity-call-get-transcript.html", - "executable": false + "executable": false, + "requestExample": { + "activityId": 12345 + } } diff --git a/_assets/simulator/spec/methods/crm.activity.communication.fields.json b/_assets/simulator/spec/methods/crm.activity.communication.fields.json index 4f36a74cd..12d163c73 100644 --- a/_assets/simulator/spec/methods/crm.activity.communication.fields.json +++ b/_assets/simulator/spec/methods/crm.activity.communication.fields.json @@ -120,5 +120,6 @@ } ], "page": "/api-reference/crm/timeline/activities/activity-base/crm-activity-communication-fields.html", - "executable": false + "executable": false, + "requestExample": {} } diff --git a/_assets/simulator/spec/methods/crm.activity.configurable.add.json b/_assets/simulator/spec/methods/crm.activity.configurable.add.json index a7cc4c012..8a17b5c2f 100644 --- a/_assets/simulator/spec/methods/crm.activity.configurable.add.json +++ b/_assets/simulator/spec/methods/crm.activity.configurable.add.json @@ -4,28 +4,28 @@ "scope": "crm", "kind": "write", "title": "Добавить конфигурируемое дело crm.activity.configurable.add", - "permissions": "любой пользователь", + "permissions": "пользователь с доступом на изменение элемента CRM, в который добавляется дело", "params": [ { "name": "ownerTypeId", "type": "integer", "base": "integer", "required": true, - "description": "Целочисленный идентификатор типа объекта CRM, в котором создаем дело, например 2 для сделки" + "description": "Целочисленный идентификатор типа объекта CRM, в элементе которого создается дело, например 2 для сделки" }, { "name": "ownerId", "type": "integer", "base": "integer", "required": true, - "description": "Целочисленный идентификатор элемента CRM, в котором создаем дело, например 1" + "description": "Целочисленный идентификатор элемента CRM, в котором создается дело, например 1" }, { "name": "fields", "type": "array", "base": "array", "required": true, - "description": "Ассоциативный массив значений полей дела в виде структуры:", + "description": "Ассоциативный массив значений полей дела в виде структуры: Параметр обязательный, но может быть пустым массивом", "ref": "#/defs/fieldsFields" }, { @@ -33,7 +33,7 @@ "type": "LayoutDto", "base": "any", "required": true, - "description": "Ассоциативный массив особой структуры, описывающий внешний вид дела в таймлайне" + "description": "Структура, которая задает внешний вид записи в таймлайне. Готовый пример объекта — на странице структуры" } ], "defs": { @@ -49,49 +49,49 @@ "type": "string", "base": "string", "required": false, - "description": "Тип конфигурируемого дела. Если значение не указано, то оно устанавливается в значение по умолчанию CONFIGURABLE. Если указано, то значение должно соответствовать одному из типов, созданных методом crm.activity.type.add с полем IS_CONFIGURABLE_TYPE равным Y в контексте того же приложения" + "description": "Тип конфигурируемого дела. Значение, отличное от CONFIGURABLE, должно соответствовать типу, который создало то же приложение методом crm.activity.type.add с полем IS_CONFIGURABLE_TYPE равным Y" }, { "name": "completed", "type": "boolean", "base": "boolean", "required": false, - "description": "Флаг, говорящий закрыто ли дело. Для установки значения можно использовать Y/N, 1/0, true/false" + "description": "Закрыто ли дело. Значение можно передать как Y/N, 1/0 или true/false" }, { "name": "deadline", "type": "datetime", "base": "datetime", "required": false, - "description": "Крайний срок исполнения дела" + "description": "Крайний срок исполнения дела в формате ISO 8601, например 2025-02-01T12:00:00+03:00. Входящему делу крайний срок задать нельзя — метод вернет ошибку INCOMING_ACTIVITY_CAN_NOT_BE_WITH_DEADLINE" }, { "name": "pingOffsets", "type": "array", "base": "array", "required": false, - "description": "Массив смещений в минутах относительно крайнего срока, определяющий когда нужно сформировать записи-пинги по этому делу" + "description": "Смещения в минутах относительно крайнего срока. Задают, когда Битрикс24 сформирует по делу записи-пинги. Повторяющиеся значения Битрикс24 отбрасывает" }, { "name": "isIncomingChannel", "type": "boolean", "base": "boolean", "required": false, - "description": "Флаг, говорящий создано ли дело из входящего канала. Для установки значения можно использовать Y/N, 1/0, true/false" + "description": "Создано ли дело из входящего канала. Значение можно передать как Y/N, 1/0 или true/false" }, { "name": "responsibleId", "type": "integer", "base": "integer", "required": false, - "description": "Ответственный за дело" + "description": "Идентификатор ответственного за дело" }, { "name": "badgeCode", "type": "string", "base": "string", "required": false, - "description": "Код значка на канбане, соответствующего делу" + "description": "Код бейджа — значка на карточке элемента в канбане. Бейдж должен быть заранее зарегистрирован методом crm.activity.badge.add, иначе метод вернет ошибку WRONG_FIELD_VALUE" }, { "name": "originatorId", @@ -115,13 +115,29 @@ "source": { "file": "api-reference/crm/timeline/activities/configurable/crm-activity-configurable-add.md" }, + "resultExample": { + "result": { + "activity": { + "id": 999 + } + }, + "time": { + "start": 1724068028.331234, + "finish": 1724068028.726591, + "duration": 0.3953571319580078, + "processing": 0.13033390045166016, + "date_start": "2025-01-21T13:47:08+02:00", + "date_finish": "2025-01-21T13:47:08+02:00", + "operating": 0 + } + }, "returns": [ { "name": "result", "type": "object", "base": "object", "required": false, - "description": "Корневой элемент ответа, содержащий информацию о добавленном идентификаторе дела id в случае успеха. В случае неудачи вернет null" + "description": "Корневой элемент ответа с единственным ключом activity (подробное описание)" }, { "name": "time", diff --git a/_assets/simulator/spec/methods/crm.activity.configurable.get.json b/_assets/simulator/spec/methods/crm.activity.configurable.get.json index a8c08b982..dd86735fa 100644 --- a/_assets/simulator/spec/methods/crm.activity.configurable.get.json +++ b/_assets/simulator/spec/methods/crm.activity.configurable.get.json @@ -3,8 +3,8 @@ "method": "crm.activity.configurable.get", "scope": "crm", "kind": "read", - "title": "Получить конфигурируемое дело по id crm.activity.configurable.get", - "permissions": "любой пользователь", + "title": "Получить конфигурируемое дело crm.activity.configurable.get", + "permissions": "пользователь с доступом на чтение элемента CRM, к которому привязано дело", "params": [ { "name": "id", @@ -20,13 +20,139 @@ "source": { "file": "api-reference/crm/timeline/activities/configurable/crm-activity-configurable-get.md" }, + "resultExample": { + "result": { + "activity": { + "id": 8903, + "ownerTypeId": 1, + "ownerId": 2975, + "fields": { + "typeId": "CONFIGURABLE", + "completed": false, + "deadline": "2025-02-01T01:00:00+03:00", + "pingOffsets": [], + "isIncomingChannel": false, + "responsibleId": 1, + "badgeCode": "", + "originatorId": null, + "originId": null + }, + "layout": { + "icon": { + "code": "call-completed" + }, + "header": { + "title": "Входящий звонок", + "tags": { + "status2": { + "title": "не расшифрован", + "type": "warning" + } + } + }, + "body": { + "logo": { + "code": "call-incoming", + "action": { + "type": "redirect", + "uri": "/crm/deal/details/123/" + } + }, + "blocks": { + "client": { + "type": "withTitle", + "properties": { + "title": "Клиент", + "inline": true, + "block": { + "type": "text", + "properties": { + "value": "ООО Рога и Копыта" + } + } + } + }, + "responsible": { + "type": "lineOfBlocks", + "properties": { + "blocks": { + "client": { + "type": "link", + "properties": { + "text": "Сергей Востриков", + "bold": true, + "action": { + "type": "redirect", + "uri": "/crm/lead/details/789/" + } + } + }, + "phone": { + "type": "text", + "properties": { + "value": "+7 999 888 7777" + } + } + } + } + } + } + }, + "footer": { + "buttons": { + "startCall": { + "title": "О клиенте", + "type": "primary", + "action": { + "type": "openRestApp", + "actionParams": { + "clientId": "456" + } + } + } + }, + "menu": { + "showPostponeItem": false, + "items": { + "confirm": { + "title": "Подтвердить заявку", + "action": { + "type": "restEvent", + "id": "confirm", + "animationType": "loader" + } + }, + "decline": { + "title": "Отклонить заявку", + "action": { + "type": "restEvent", + "id": "decline", + "animationType": "loader" + } + } + } + } + } + } + } + }, + "time": { + "start": 1724068028.331234, + "finish": 1724068028.726591, + "duration": 0.3953571319580078, + "processing": 0.13033390045166016, + "date_start": "2025-01-21T13:47:08+02:00", + "date_finish": "2025-01-21T13:47:08+02:00", + "operating": 0 + } + }, "returns": [ { "name": "result", "type": "object", "base": "object", "required": false, - "description": "Корневой элемент ответа - ассоциативный массив с ключом activity, в котором будет содержаться поля" + "description": "Корневой элемент ответа с единственным ключом activity (подробное описание)" }, { "name": "time", @@ -42,11 +168,19 @@ "badgeCode", "completed", "deadline", + "fields", + "id", "isIncomingChannel", + "layout", "originId", "originatorId", + "ownerId", + "ownerTypeId", "pingOffsets", "responsibleId", "typeId" - ] + ], + "requestExample": { + "id": 999 + } } diff --git a/_assets/simulator/spec/methods/crm.activity.configurable.update.json b/_assets/simulator/spec/methods/crm.activity.configurable.update.json index 3640fcaa2..fc46dc3a6 100644 --- a/_assets/simulator/spec/methods/crm.activity.configurable.update.json +++ b/_assets/simulator/spec/methods/crm.activity.configurable.update.json @@ -4,21 +4,21 @@ "scope": "crm", "kind": "write", "title": "Обновить конфигурируемое дело crm.activity.configurable.update", - "permissions": "любой пользователь", + "permissions": "пользователь с доступом на изменение элемента CRM, к которому привязано дело", "params": [ { "name": "id", "type": "integer", "base": "integer", "required": true, - "description": "Целочисленный идентификатор дела, например 999" + "description": "Целочисленный идентификатор дела, например 999. Его возвращает метод crm.activity.configurable.add" }, { "name": "fields", "type": "array", "base": "array", - "required": true, - "description": "Ассоциативный массив значений полей дела в виде структуры:", + "required": false, + "description": "Ассоциативный массив значений полей дела в виде структуры: Переданные поля обновятся, остальные сохранят прежние значения", "dynamic": { "allowed": true, "note": "Состав полей не описан подтаблицей на этой странице" @@ -28,8 +28,8 @@ "name": "layout", "type": "LayoutDto", "base": "any", - "required": true, - "description": "Ассоциативный массив особой структуры, описывающий внешний вид дела в таймлайне" + "required": false, + "description": "Структура, которая задает внешний вид записи в таймлайне. Готовый пример объекта — на странице структуры" } ], "defs": {}, @@ -38,13 +38,29 @@ "source": { "file": "api-reference/crm/timeline/activities/configurable/crm-activity-configurable-update.md" }, + "resultExample": { + "result": { + "activity": { + "id": 999 + } + }, + "time": { + "start": 1724068028.331234, + "finish": 1724068028.726591, + "duration": 0.3953571319580078, + "processing": 0.13033390045166016, + "date_start": "2025-01-21T13:47:08+02:00", + "date_finish": "2025-01-21T13:47:08+02:00", + "operating": 0 + } + }, "returns": [ { "name": "result", "type": "object", "base": "object", "required": false, - "description": "Корневой элемент ответа, содержащий информацию об идентификаторе дела id в случае успеха. В случае неудачи вернет null" + "description": "Корневой элемент ответа с единственным ключом activity (подробное описание)" }, { "name": "time", diff --git a/_assets/simulator/spec/methods/crm.activity.delete.json b/_assets/simulator/spec/methods/crm.activity.delete.json index 08856cbaa..592ca4f2b 100644 --- a/_assets/simulator/spec/methods/crm.activity.delete.json +++ b/_assets/simulator/spec/methods/crm.activity.delete.json @@ -50,5 +50,8 @@ } ], "page": "/api-reference/crm/timeline/activities/activity-base/crm-activity-delete.html", - "executable": false + "executable": false, + "requestExample": { + "id": 999 + } } diff --git a/_assets/simulator/spec/methods/crm.activity.fields.json b/_assets/simulator/spec/methods/crm.activity.fields.json index 21eb8959d..ccfb84008 100644 --- a/_assets/simulator/spec/methods/crm.activity.fields.json +++ b/_assets/simulator/spec/methods/crm.activity.fields.json @@ -463,5 +463,6 @@ } ], "page": "/api-reference/crm/timeline/activities/activity-base/crm-activity-fields.html", - "executable": false + "executable": false, + "requestExample": {} } diff --git a/_assets/simulator/spec/methods/crm.activity.get.json b/_assets/simulator/spec/methods/crm.activity.get.json index 811dde1bb..f702051a3 100644 --- a/_assets/simulator/spec/methods/crm.activity.get.json +++ b/_assets/simulator/spec/methods/crm.activity.get.json @@ -121,5 +121,8 @@ "SUBJECT", "TYPE_ID", "WEBDAV_ELEMENTS" - ] + ], + "requestExample": { + "id": 999 + } } diff --git a/_assets/simulator/spec/methods/crm.activity.layout.blocks.delete.json b/_assets/simulator/spec/methods/crm.activity.layout.blocks.delete.json index 2022119dc..759e56ea2 100644 --- a/_assets/simulator/spec/methods/crm.activity.layout.blocks.delete.json +++ b/_assets/simulator/spec/methods/crm.activity.layout.blocks.delete.json @@ -3,7 +3,7 @@ "method": "crm.activity.layout.blocks.delete", "scope": "crm", "kind": "write", - "title": "Удалить набор дополнительных контентных блоков в деле crm.activity.layout.blocks.delete", + "title": "Удалить набор дополнительных контентных блоков из дела crm.activity.layout.blocks.delete", "permissions": "любой пользователь с правом на изменение элемента CRM, к которому привязано дело", "params": [ { @@ -11,21 +11,21 @@ "type": "integer", "base": "integer", "required": true, - "description": "Идентификатор типа объекта CRM, к которому привязано дело" + "description": "Идентификатор типа объекта CRM, к которому привязано дело, например 2 для сделки" }, { "name": "entityId", "type": "integer", "base": "integer", "required": true, - "description": "Идентификатор объекта CRM, к которому привязано дело" + "description": "Идентификатор объекта CRM, к которому привязано дело, например идентификатор сделки" }, { "name": "activityId", "type": "integer", "base": "integer", "required": true, - "description": "Идентификатор дела" + "description": "Идентификатор дела. Возвращают методы crm.activity.add и crm.activity.list" } ], "defs": {}, @@ -35,8 +35,35 @@ "file": "api-reference/crm/timeline/activities/layout-blocks/crm-activity-layout-blocks-delete.md" }, "resultExample": { - "success": true + "result": { + "success": true + }, + "time": { + "start": 1753341040.475739, + "finish": 1753341040.582705, + "duration": 0.10696601867675781, + "processing": 0.04708504676818848, + "date_start": "2025-07-24T17:57:20+00:00", + "date_finish": "2025-07-24T17:57:20+00:00", + "operating": 0 + } }, + "returns": [ + { + "name": "result", + "type": "object", + "base": "object", + "required": false, + "description": "Корневой элемент ответа (подробное описание). Если набор блоков удалить не удалось, метод возвращает не result, а объект error — смотрите раздел «Обработка ошибок»" + }, + { + "name": "time", + "type": "time", + "base": "object", + "required": false, + "description": "Информация о времени выполнения запроса" + } + ], "page": "/api-reference/crm/timeline/activities/layout-blocks/crm-activity-layout-blocks-delete.html", "executable": false } diff --git a/_assets/simulator/spec/methods/crm.activity.layout.blocks.get.json b/_assets/simulator/spec/methods/crm.activity.layout.blocks.get.json index 8d11783d8..d588a32b8 100644 --- a/_assets/simulator/spec/methods/crm.activity.layout.blocks.get.json +++ b/_assets/simulator/spec/methods/crm.activity.layout.blocks.get.json @@ -3,7 +3,7 @@ "method": "crm.activity.layout.blocks.get", "scope": "crm", "kind": "read", - "title": "Получить набор дополнительных контентных блоков в деле crm.activity.layout.blocks.get", + "title": "Получить набор дополнительных контентных блоков дела crm.activity.layout.blocks.get", "permissions": "любой пользователь с правом на чтение элемента CRM, к которому привязано дело", "params": [ { @@ -11,21 +11,21 @@ "type": "integer", "base": "integer", "required": true, - "description": "Идентификатор типа объекта CRM, к которому привязано дело" + "description": "Идентификатор типа объекта CRM, к которому привязано дело, например 2 для сделки" }, { "name": "entityId", "type": "integer", "base": "integer", "required": true, - "description": "Идентификатор объекта CRM, к которому привязано дело" + "description": "Идентификатор объекта CRM, к которому привязано дело, например идентификатор сделки" }, { "name": "activityId", "type": "integer", "base": "integer", "required": true, - "description": "Идентификатор дела" + "description": "Идентификатор дела. Возвращают методы crm.activity.add и crm.activity.list" } ], "defs": {}, @@ -35,49 +35,79 @@ "file": "api-reference/crm/timeline/activities/layout-blocks/crm-activity-layout-blocks-get.md" }, "resultExample": { - "layout": { - "blocks": { - "block_1": { - "type": "text", - "properties": { - "value": "Здравствуйте!\nМы начинаем.", - "multiline": true, - "bold": true, - "color": "base_90" - } - }, - "block_2": { - "type": "largeText", - "properties": { - "value": "Здравствуйте!\nМы начинаем.\nМы продолжаем.\nМы все еще работаем над этим.\nМы продолжаем.\nМы близки к результату.\nДо свидания." - } - }, - "block_3": { - "type": "link", - "properties": { - "text": "Открыть сделку", - "bold": true, - "action": { - "type": "redirect", - "uri": "/crm/deal/details/123/" + "result": { + "layout": { + "blocks": { + "block_1": { + "type": "text", + "properties": { + "value": "Здравствуйте!\nМы начинаем.", + "multiline": true, + "bold": true, + "color": "base_90" } - } - }, - "block_4": { - "type": "withTitle", - "properties": { - "title": "Заголовок", - "block": { - "type": "text", - "properties": { - "value": "Какое-то значение" + }, + "block_2": { + "type": "largeText", + "properties": { + "value": "Здравствуйте!\nМы начинаем.\nМы продолжаем.\nМы все еще работаем над этим.\nМы продолжаем.\nМы близки к результату.\nДо свидания." + } + }, + "block_3": { + "type": "link", + "properties": { + "text": "Открыть сделку", + "bold": true, + "action": { + "type": "redirect", + "uri": "/crm/deal/details/123/" + } + } + }, + "block_4": { + "type": "withTitle", + "properties": { + "title": "Заголовок", + "block": { + "type": "text", + "properties": { + "value": "Какое-то значение" + } } } } } } + }, + "time": { + "start": 1753341040.475739, + "finish": 1753341040.582705, + "duration": 0.10696601867675781, + "processing": 0.04708504676818848, + "date_start": "2025-07-24T17:57:20+00:00", + "date_finish": "2025-07-24T17:57:20+00:00", + "operating": 0 } }, + "returns": [ + { + "name": "result", + "type": "object", + "base": "object", + "required": false, + "description": "Корневой элемент ответа (подробное описание). Если получить набор блоков не удалось, метод возвращает не result, а объект error — смотрите раздел «Обработка ошибок»" + }, + { + "name": "time", + "type": "time", + "base": "object", + "required": false, + "description": "Информация о времени выполнения запроса" + } + ], "page": "/api-reference/crm/timeline/activities/layout-blocks/crm-activity-layout-blocks-get.html", - "executable": false + "executable": false, + "entityFields": [ + "blocks" + ] } diff --git a/_assets/simulator/spec/methods/crm.activity.layout.blocks.set.json b/_assets/simulator/spec/methods/crm.activity.layout.blocks.set.json index 3e7815678..1d7d87a90 100644 --- a/_assets/simulator/spec/methods/crm.activity.layout.blocks.set.json +++ b/_assets/simulator/spec/methods/crm.activity.layout.blocks.set.json @@ -11,28 +11,28 @@ "type": "integer", "base": "integer", "required": true, - "description": "Идентификатор типа объекта CRM, к которому привязано дело" + "description": "Идентификатор типа объекта CRM, к которому привязано дело, например 2 для сделки" }, { "name": "entityId", "type": "integer", "base": "integer", "required": true, - "description": "Идентификатор объекта CRM, к которому привязано дело" + "description": "Идентификатор объекта CRM, к которому привязано дело, например идентификатор сделки" }, { "name": "activityId", "type": "integer", "base": "integer", "required": true, - "description": "Идентификатор дела" + "description": "Идентификатор дела. Возвращают методы crm.activity.add и crm.activity.list" }, { "name": "layout", "type": "RestAppLayoutDto", "base": "any", "required": true, - "description": "Объект, описывающий набор дополнительных контентных блоков" + "description": "Объект, описывающий набор дополнительных контентных блоков (подробное описание)" } ], "defs": {}, @@ -42,8 +42,35 @@ "file": "api-reference/crm/timeline/activities/layout-blocks/crm-activity-layout-blocks-set.md" }, "resultExample": { - "success": true + "result": { + "success": true + }, + "time": { + "start": 1753341040.475739, + "finish": 1753341040.582705, + "duration": 0.10696601867675781, + "processing": 0.04708504676818848, + "date_start": "2025-07-24T17:57:20+00:00", + "date_finish": "2025-07-24T17:57:20+00:00", + "operating": 0 + } }, + "returns": [ + { + "name": "result", + "type": "object", + "base": "object", + "required": false, + "description": "Корневой элемент ответа (подробное описание). Если набор блоков установить не удалось, метод возвращает не result, а объект error — смотрите раздел «Обработка ошибок»" + }, + { + "name": "time", + "type": "time", + "base": "object", + "required": false, + "description": "Информация о времени выполнения запроса" + } + ], "page": "/api-reference/crm/timeline/activities/layout-blocks/crm-activity-layout-blocks-set.html", "executable": false } diff --git a/_assets/simulator/spec/methods/crm.activity.list.json b/_assets/simulator/spec/methods/crm.activity.list.json index 69f813ec6..e3a78fded 100644 --- a/_assets/simulator/spec/methods/crm.activity.list.json +++ b/_assets/simulator/spec/methods/crm.activity.list.json @@ -11,7 +11,7 @@ "type": "array", "base": "array", "required": false, - "description": "Массив полей дела crm.activity.fields, которые необходимо выбрать. Чтобы получить поля COMMUNICATIONS и FILES укажите их в select.", + "description": "Массив полей дела crm.activity.fields, которые необходимо выбрать. Чтобы получить поля COMMUNICATIONS и FILES, укажите их в select.", "dynamic": { "allowed": true, "note": "Состав полей не описан подтаблицей на этой странице" @@ -33,7 +33,7 @@ "type": "object", "base": "object", "required": false, - "description": "Набор пар ключ-значение для сортировки результатов вывода. В качестве ключей можно использовать смотрите поля дела crm.activity.fields. Возможные значения для order: - asc — в порядке возрастания - desc — в порядке убывания По-умолчанию сортируется по увеличению поля Дата начала (START_TIME)", + "description": "Набор пар ключ-значение для сортировки результатов вывода. В качестве ключей можно использовать поля дела crm.activity.fields. Возможные значения для order: - asc — в порядке возрастания - desc — в порядке убывания По умолчанию результаты сортируются по возрастанию значения поля START_TIME", "values": [ { "value": "asc", @@ -41,7 +41,7 @@ }, { "value": "desc", - "title": "в порядке убывания По-умолчанию сортируется по увеличению поля Дата начала (STAR" + "title": "в порядке убывания По умолчанию результаты сортируются по возрастанию значения п" } ], "dynamic": { @@ -63,6 +63,63 @@ "source": { "file": "api-reference/crm/timeline/activities/activity-base/crm-activity-list.md" }, + "resultExample": { + "result": [ + { + "ID": "20", + "OWNER_ID": "15", + "OWNER_TYPE_ID": "3", + "TYPE_ID": "2", + "PROVIDER_ID": "VOXIMPLANT_CALL", + "PROVIDER_TYPE_ID": "CALL", + "PROVIDER_GROUP_ID": null, + "ASSOCIATED_ENTITY_ID": "0", + "SUBJECT": "Исходящий звонок Андрей Николаев", + "CREATED": "2020-09-27T13:26:55+03:00", + "LAST_UPDATED": "2021-03-21T20:28:24+03:00", + "START_TIME": "2020-09-27T13:25:00+03:00", + "END_TIME": "2020-09-27T19:25:00+03:00", + "DEADLINE": "2020-09-27T13:25:00+03:00", + "COMPLETED": "Y", + "STATUS": "2", + "RESPONSIBLE_ID": "505", + "PRIORITY": "2", + "NOTIFY_TYPE": "1", + "NOTIFY_VALUE": "15", + "DESCRIPTION": "", + "DESCRIPTION_TYPE": "1", + "DIRECTION": "2", + "LOCATION": "", + "SETTINGS": [], + "ORIGINATOR_ID": null, + "ORIGIN_ID": null, + "AUTHOR_ID": "505", + "EDITOR_ID": "505", + "PROVIDER_PARAMS": [], + "PROVIDER_DATA": null, + "RESULT_MARK": "0", + "RESULT_VALUE": null, + "RESULT_SUM": null, + "RESULT_CURRENCY_ID": null, + "RESULT_STATUS": "0", + "RESULT_STREAM": "0", + "RESULT_SOURCE_ID": null, + "AUTOCOMPLETE_RULE": "0" + } + ], + "next": 50, + "total": 123456, + "time": { + "start": 1724677896.295857, + "finish": 1724677897.197243, + "duration": 0.901386022567749, + "processing": 0.8762130737304688, + "date_start": "2024-08-26T16:11:36+03:00", + "date_finish": "2024-08-26T16:11:37+03:00", + "operating_reset_at": "2024-08-26T16:11:37+03:00", + "operating": 0.0162130737304688 + } + }, "returns": [ { "name": "result", @@ -71,6 +128,20 @@ "required": false, "description": "Массив дел. Для получения информации о структуре дела смотрите метод crm.activity.fields" }, + { + "name": "next", + "type": "integer", + "base": "integer", + "required": false, + "description": "Значение параметра start для получения следующей страницы. Поле возвращается, если доступна следующая страница" + }, + { + "name": "total", + "type": "integer", + "base": "integer", + "required": false, + "description": "Общее количество найденных дел" + }, { "name": "time", "type": "time", @@ -83,16 +154,24 @@ "executable": false, "entityFields": [ "ASSOCIATED_ENTITY_ID", + "AUTHOR_ID", + "AUTOCOMPLETE_RULE", "COMMUNICATIONS", + "COMPLETED", + "CREATED", "DEADLINE", "DESCRIPTION", "DESCRIPTION_TYPE", "DIRECTION", + "EDITOR_ID", "END_TIME", "FILES", + "ID", "IS_INCOMING_CHANNEL", + "LAST_UPDATED", "LOCATION", "NOTIFY_TYPE", + "NOTIFY_VALUE", "ORIGINATOR_ID", "ORIGIN_ID", "ORIGIN_VERSION", @@ -105,11 +184,32 @@ "PROVIDER_PARAMS", "PROVIDER_TYPE_ID", "RESPONSIBLE_ID", + "RESULT_CURRENCY_ID", + "RESULT_MARK", + "RESULT_SOURCE_ID", + "RESULT_STATUS", + "RESULT_STREAM", + "RESULT_SUM", + "RESULT_VALUE", "SETTINGS", "START_TIME", "STATUS", "SUBJECT", "TYPE_ID", "WEBDAV_ELEMENTS" - ] + ], + "requestExample": { + "order": { + "ID": "DESC" + }, + "filter": { + "OWNER_TYPE_ID": 3, + "OWNER_ID": 102 + }, + "select": [ + "*", + "COMMUNICATIONS" + ], + "start": 0 + } } diff --git a/_assets/simulator/spec/methods/crm.activity.todo.updateColor.json b/_assets/simulator/spec/methods/crm.activity.todo.updateColor.json index b05822c85..366f3d6e5 100644 --- a/_assets/simulator/spec/methods/crm.activity.todo.updateColor.json +++ b/_assets/simulator/spec/methods/crm.activity.todo.updateColor.json @@ -72,5 +72,11 @@ } ], "page": "/api-reference/crm/timeline/activities/todo/crm-activity-todo-update-color.html", - "executable": false + "executable": false, + "requestExample": { + "id": 999, + "ownerTypeId": 2, + "ownerId": 1, + "colorId": "3" + } } diff --git a/_assets/simulator/spec/methods/crm.activity.todo.updateDescription.json b/_assets/simulator/spec/methods/crm.activity.todo.updateDescription.json index 8080a9871..c696d5707 100644 --- a/_assets/simulator/spec/methods/crm.activity.todo.updateDescription.json +++ b/_assets/simulator/spec/methods/crm.activity.todo.updateDescription.json @@ -72,5 +72,11 @@ } ], "page": "/api-reference/crm/timeline/activities/todo/crm-activity-todo-update-description.html", - "executable": false + "executable": false, + "requestExample": { + "id": 999, + "ownerTypeId": 2, + "ownerId": 1, + "value": "Новое описание дела" + } } diff --git a/_assets/simulator/spec/methods/crm.activity.todo.updateResponsibleUser.json b/_assets/simulator/spec/methods/crm.activity.todo.updateResponsibleUser.json index 2457828e8..6a7a2ea2e 100644 --- a/_assets/simulator/spec/methods/crm.activity.todo.updateResponsibleUser.json +++ b/_assets/simulator/spec/methods/crm.activity.todo.updateResponsibleUser.json @@ -72,5 +72,11 @@ } ], "page": "/api-reference/crm/timeline/activities/todo/crm-activity-todo-update-responsible-user.html", - "executable": false + "executable": false, + "requestExample": { + "id": 999, + "ownerTypeId": 2, + "ownerId": 1, + "responsibleId": 5 + } } diff --git a/_assets/simulator/spec/methods/crm.address.add.json b/_assets/simulator/spec/methods/crm.address.add.json index 30bc7b895..d3fcd01f6 100644 --- a/_assets/simulator/spec/methods/crm.address.add.json +++ b/_assets/simulator/spec/methods/crm.address.add.json @@ -143,5 +143,19 @@ } ], "page": "/api-reference/crm/requisites/addresses/crm-address-add.html", - "executable": false + "executable": false, + "requestExample": { + "fields": { + "TYPE_ID": 1, + "ENTITY_TYPE_ID": 8, + "ENTITY_ID": 1, + "ADDRESS_1": "проспект Мира, 4", + "ADDRESS_2": "Калининградский областной драматический театр", + "CITY": "Калининград", + "POSTAL_CODE": "236036", + "REGION": "городской округ Калининград", + "PROVINCE": "Калининградская область", + "COUNTRY": "Россия" + } + } } diff --git a/_assets/simulator/spec/methods/crm.address.delete.json b/_assets/simulator/spec/methods/crm.address.delete.json index a4be299d4..de554f3dc 100644 --- a/_assets/simulator/spec/methods/crm.address.delete.json +++ b/_assets/simulator/spec/methods/crm.address.delete.json @@ -80,5 +80,12 @@ } ], "page": "/api-reference/crm/requisites/addresses/crm-address-delete.html", - "executable": false + "executable": false, + "requestExample": { + "fields": { + "TYPE_ID": 1, + "ENTITY_TYPE_ID": 3, + "ENTITY_ID": 1 + } + } } diff --git a/_assets/simulator/spec/methods/crm.address.update.json b/_assets/simulator/spec/methods/crm.address.update.json index 0df12f231..c34c9d8cc 100644 --- a/_assets/simulator/spec/methods/crm.address.update.json +++ b/_assets/simulator/spec/methods/crm.address.update.json @@ -143,5 +143,14 @@ } ], "page": "/api-reference/crm/requisites/addresses/crm-address-update.html", - "executable": false + "executable": false, + "requestExample": { + "fields": { + "TYPE_ID": 1, + "ENTITY_TYPE_ID": 3, + "ENTITY_ID": 1, + "ADDRESS_1": "Московский проспект, 261", + "CITY": "Калининград" + } + } } diff --git a/_assets/simulator/spec/methods/crm.automatedsolution.add.json b/_assets/simulator/spec/methods/crm.automatedsolution.add.json index aacd47f7d..0e67f8610 100644 --- a/_assets/simulator/spec/methods/crm.automatedsolution.add.json +++ b/_assets/simulator/spec/methods/crm.automatedsolution.add.json @@ -4,14 +4,14 @@ "scope": "crm", "kind": "write", "title": "Создать цифровое рабочее место crm.automatedsolution.add", - "permissions": "пользователи с административным доступом к разделу CRM", + "permissions": "администратор Битрикс24 или пользователь с правом «Редактирование» или «Разрешить изменять настройки» в разделе «Цифровые рабочие места» прав доступа CRM", "params": [ { "name": "fields", "type": "object", "base": "object", "required": true, - "description": "Значения полей (подробное описание приведено ниже) для создания цифрового рабочего места в виде структуры:", + "description": "Значения полей (подробное описание) для создания цифрового рабочего места в виде структуры:", "ref": "#/defs/fieldsFields" } ], @@ -28,14 +28,14 @@ "type": "string", "base": "string", "required": true, - "description": "Название цифрового рабочего места. На основании заголовка цифрового рабочего места будет строиться ссылка на соответствующий раздел на портале" + "description": "Название цифрового рабочего места. По названию строится ссылка на раздел рабочего места в Битрикс24" }, { "name": "typeIds", "type": "crm_dynamic_type.id[]", "base": "array", "required": false, - "description": "Массив идентификаторов смарт-процессов, которые нужно привязать к этому рабочему месту. Если смарт-процесс до этого был привязан к другому рабочему месту или к CRM, то после привязки к новому рабочему месту, он оттуда пропадет. Цифровое рабочее место без смарт-процессов не будет выводиться в левое меню. Но его можно будет найти в списке цифровых рабочих мест" + "description": "Массив идентификаторов типов смарт-процессов (id), которые нужно привязать к этому рабочему месту. Если не передан, рабочее место создается без смарт-процессов. Несуществующие идентификаторы игнорируются без ошибки. Если смарт-процесс уже привязан к другому рабочему месту или к CRM, при привязке к новому рабочему месту он убирается из прежнего места.…" } ] } @@ -81,7 +81,7 @@ "type": "object", "base": "object", "required": false, - "description": "Объект с информацией о добавленном цифровом рабочем месте" + "description": "Созданное цифровое рабочее место. Объект вложен в result (подробное описание)" }, { "name": "time", @@ -92,5 +92,15 @@ } ], "page": "/api-reference/crm/automated-solution/crm-automated-solution-add.html", - "executable": false + "executable": false, + "requestExample": { + "fields": { + "title": "HR", + "typeIds": [ + 1, + 2, + 3 + ] + } + } } diff --git a/_assets/simulator/spec/methods/crm.automatedsolution.delete.json b/_assets/simulator/spec/methods/crm.automatedsolution.delete.json index d2578427f..59cb1025e 100644 --- a/_assets/simulator/spec/methods/crm.automatedsolution.delete.json +++ b/_assets/simulator/spec/methods/crm.automatedsolution.delete.json @@ -4,14 +4,14 @@ "scope": "crm", "kind": "write", "title": "Удалить цифровое рабочее место crm.automatedsolution.delete", - "permissions": "пользователи с административным доступом к разделу CRM", + "permissions": "администратор Битрикс24 или пользователь с правом «Редактирование» или «Разрешить изменять настройки» в разделе «Цифровые рабочие места» прав доступа CRM", "params": [ { "name": "id", "type": "integer", "base": "integer", "required": true, - "description": "Идентификатор цифрового рабочего места. Может быть получен из ответа метода crm.automatedsolution.add (result.automatedSolution.id), который был вызван при добавлении цифрового рабочего места, или crm.automatedsolution.list. Так же можно воспользоваться разделом «Цифровые рабочие места» на портале Битрикс24 — колонка ID в списке цифровых рабочих мест" + "description": "Идентификатор цифрового рабочего места. Его можно получить из ответа метода crm.automatedsolution.add (result.automatedSolution.id) или crm.automatedsolution.list. В Битрикс24 идентификатор виден в колонке ID списка цифровых рабочих мест" } ], "defs": {}, @@ -33,6 +33,25 @@ "operating": 0 } }, + "returns": [ + { + "name": "result", + "type": "null", + "base": "any", + "required": false, + "description": "Возвращается null — и после удаления, и для несуществующего id" + }, + { + "name": "time", + "type": "time", + "base": "object", + "required": false, + "description": "Информация о времени выполнения запроса" + } + ], "page": "/api-reference/crm/automated-solution/crm-automated-solution-delete.html", - "executable": false + "executable": false, + "requestExample": { + "id": 5 + } } diff --git a/_assets/simulator/spec/methods/crm.automatedsolution.fields.json b/_assets/simulator/spec/methods/crm.automatedsolution.fields.json new file mode 100644 index 000000000..9a4705d8d --- /dev/null +++ b/_assets/simulator/spec/methods/crm.automatedsolution.fields.json @@ -0,0 +1,101 @@ +{ + "$v": 1, + "method": "crm.automatedsolution.fields", + "scope": "crm", + "kind": "read", + "title": "Получить поля цифрового рабочего места crm.automatedsolution.fields", + "permissions": "администратор Битрикс24 или пользователь с правом «Редактирование» или «Разрешить изменять настройки» в разделе «Цифровые рабочие места» прав доступа CRM", + "params": [ + { + "name": "result", + "type": "object", + "base": "object", + "required": "unknown", + "description": "Объект в формате {\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}, где field — поле цифрового рабочего места, а value — описание поля типа crm_rest_field_description", + "dynamic": { + "allowed": true, + "note": "Состав полей не описан подтаблицей на этой странице" + } + }, + { + "name": "time", + "type": "time", + "base": "object", + "required": "unknown", + "description": "Информация о времени выполнения запроса", + "dynamic": { + "allowed": true, + "note": "Состав полей не описан подтаблицей на этой странице" + } + } + ], + "defs": {}, + "requiredConvention": false, + "confidence": "parsed", + "source": { + "file": "api-reference/crm/automated-solution/crm-automated-solution-fields.md" + }, + "resultExample": { + "result": { + "id": { + "type": "integer", + "isRequired": false, + "isReadOnly": true, + "isImmutable": false, + "isMultiple": false, + "isDynamic": false, + "title": "ID", + "upperName": "ID" + }, + "title": { + "type": "string", + "isRequired": true, + "isReadOnly": false, + "isImmutable": false, + "isMultiple": false, + "isDynamic": false, + "title": "TITLE", + "upperName": "TITLE" + }, + "typeIds": { + "type": "crm_dynamic_type", + "isRequired": false, + "isReadOnly": false, + "isImmutable": false, + "isMultiple": true, + "isDynamic": false, + "title": "TYPE_IDS", + "upperName": "TYPE_IDS" + } + }, + "time": { + "start": 1715848631.568101, + "finish": 1715848631.898371, + "duration": 0.33027005195617676, + "processing": 0.0055119991302490234, + "date_start": "2024-05-16T11:37:11+03:00", + "date_finish": "2024-05-16T11:37:11+03:00", + "operating_reset_at": 1715849231, + "operating": 0 + } + }, + "returns": [ + { + "name": "result", + "type": "object", + "base": "object", + "required": "unknown", + "description": "Объект в формате {\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}, где field — поле цифрового рабочего места, а value — описание поля типа crm_rest_field_description" + }, + { + "name": "time", + "type": "time", + "base": "object", + "required": "unknown", + "description": "Информация о времени выполнения запроса" + } + ], + "page": "/api-reference/crm/automated-solution/crm-automated-solution-fields.html", + "executable": false, + "requestExample": {} +} diff --git a/_assets/simulator/spec/methods/crm.automatedsolution.get.json b/_assets/simulator/spec/methods/crm.automatedsolution.get.json index 969770287..0d2ce90a2 100644 --- a/_assets/simulator/spec/methods/crm.automatedsolution.get.json +++ b/_assets/simulator/spec/methods/crm.automatedsolution.get.json @@ -4,7 +4,7 @@ "scope": "crm", "kind": "read", "title": "Получить данные о цифровом рабочем месте по id crm.automatedsolution.get", - "permissions": "пользователи с административным доступом к разделу CRM", + "permissions": "администратор Битрикс24 или пользователь с правом «Редактирование» или «Разрешить изменять настройки» в разделе «Цифровые рабочие места» прав доступа CRM", "params": [ { "name": "id", @@ -58,7 +58,7 @@ "type": "object", "base": "object", "required": false, - "description": "Информация о цифровом рабочем месте" + "description": "Информация о цифровом рабочем месте. Объект вложен в result (подробное описание)" }, { "name": "time", @@ -74,5 +74,8 @@ "id", "title", "typeIds" - ] + ], + "requestExample": { + "id": 393 + } } diff --git a/_assets/simulator/spec/methods/crm.automatedsolution.list.json b/_assets/simulator/spec/methods/crm.automatedsolution.list.json index b56a03097..38a5f05e5 100644 --- a/_assets/simulator/spec/methods/crm.automatedsolution.list.json +++ b/_assets/simulator/spec/methods/crm.automatedsolution.list.json @@ -4,14 +4,14 @@ "scope": "crm", "kind": "read", "title": "Получить список цифровых рабочих мест crm.automatedsolution.list", - "permissions": "пользователи с административным доступом к разделу CRM", + "permissions": "администратор Битрикс24 или пользователь с правом «Редактирование» или «Разрешить изменять настройки» в разделе «Цифровые рабочие места» прав доступа CRM", "params": [ { "name": "order", "type": "object", "base": "object", "required": "unknown", - "description": "Список для сортировки в формате {\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}, где ключ — поле, а значение — ASC или DESC. Доступные для сортировки поля: - id - title", + "description": "Объект для сортировки в формате {\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}, где ключ — поле, а значение — ASC или DESC. По умолчанию {\"id\": \"ASC\"}. Значения ASC и DESC пишутся в верхнем регистре, имена полей — в нижнем. Доступные для сортировки поля: - id - title", "dynamic": { "allowed": true, "note": "Состав полей не описан подтаблицей на этой странице" @@ -33,7 +33,7 @@ "type": "integer", "base": "integer", "required": "unknown", - "description": "Параметр используется для управления постраничной навигацией. Размер страницы результатов всегда статичный: 50 записей. Чтобы выбрать вторую страницу результатов необходимо передавать значение 50. Чтобы выбрать третью страницу результатов значение — 100 и так далее. Формула расчета значения параметра start: start = (N-1) * 50, где N — номер нужной страницы" + "description": "Параметр используется для управления постраничной навигацией. Размер страницы результатов всегда статичный: 50 записей. По умолчанию 0. Чтобы выбрать вторую страницу результатов, передайте значение 50, третью — 100 и так далее. Формула расчета значения параметра start: start = (N-1) * 50, где N — номер нужной страницы" } ], "defs": {}, @@ -89,10 +89,10 @@ }, { "name": "automatedSolutions", - "type": "object", - "base": "object", + "type": "object[]", + "base": "array", "required": "unknown", - "description": "Массив объектов с информацией о выбранных оплатах" + "description": "Массив цифровых рабочих мест, которые соответствуют фильтру. Массив вложен в result. Если таких рабочих мест нет, возвращается пустой массив (подробное описание)" }, { "name": "total", @@ -101,6 +101,13 @@ "required": "unknown", "description": "Общее количество найденных записей" }, + { + "name": "next", + "type": "integer", + "base": "integer", + "required": "unknown", + "description": "Значение start для следующей страницы. Возвращается, только если есть следующая страница" + }, { "name": "time", "type": "time", @@ -115,5 +122,10 @@ "id", "title", "typeIds" - ] + ], + "requestExample": { + "order": { + "id": "DESC" + } + } } diff --git a/_assets/simulator/spec/methods/crm.automatedsolution.update.json b/_assets/simulator/spec/methods/crm.automatedsolution.update.json index 39158d3ed..0dff6543f 100644 --- a/_assets/simulator/spec/methods/crm.automatedsolution.update.json +++ b/_assets/simulator/spec/methods/crm.automatedsolution.update.json @@ -4,21 +4,21 @@ "scope": "crm", "kind": "write", "title": "Изменить цифровое рабочее место crm.automatedsolution.update", - "permissions": "пользователи с административным доступом к разделу crm", + "permissions": "администратор Битрикс24 или пользователь с правом «Редактирование» или «Разрешить изменять настройки» в разделе «Цифровые рабочие места» прав доступа CRM", "params": [ { "name": "id", "type": "integer", "base": "integer", "required": true, - "description": "Идентификатор цифрового рабочего места. Может быть получен из ответа метода crm.automatedsolution.add (result.automatedSolution.id), который был вызван при добавлении цифрового рабочего места, или crm.automatedsolution.list. Так же можно воспользоваться разделом «Цифровые рабочие места» на портале Битрикс24 — колонка ID в списке цифровых рабочих мест" + "description": "Идентификатор цифрового рабочего места. Его можно получить из ответа метода crm.automatedsolution.add (result.automatedSolution.id) или crm.automatedsolution.list. В Битрикс24 идентификатор виден в колонке ID списка цифровых рабочих мест" }, { "name": "fields", "type": "object", "base": "object", "required": true, - "description": "Значения полей (подробное описание приведено ниже) для создания цифрового рабочего места в виде структуры:", + "description": "Значения полей (подробное описание) для изменения цифрового рабочего места в виде структуры:", "ref": "#/defs/fieldsFields" } ], @@ -35,14 +35,14 @@ "type": "string", "base": "string", "required": false, - "description": "Название цифрового рабочего места. Будьте внимательны с изменением поля title. Так как ссылка на цифровое рабочее место строится на основании названия, при его изменении изменится и ссылка на цифровое рабочее место" + "description": "Название цифрового рабочего места. Ссылка на цифровое рабочее место строится по названию, поэтому при смене title меняется и ссылка. Если title передан, он не может быть пустым" }, { "name": "typeIds", "type": "crm_dynamic_type.id[]", "base": "array", "required": false, - "description": "Массив идентификаторов смарт-процессов, которые нужно привязать к этому рабочему месту. Чтобы изменить список привязанных смарт-процессов, нужно передать поле typeIds с желаемым набором смарт-процессов. Настройки переписываются полностью. При изменении списка привязанных смарт-процессов, надо передавать набор typeIds целиком, либо опустить ключ typeIds вообще" + "description": "Массив идентификаторов типов смарт-процессов (id), которые нужно привязать к этому рабочему месту. Несуществующие идентификаторы игнорируются без ошибки. Список typeIds перезаписывается целиком: передайте полный набор нужных смарт-процессов. Если typeIds не передан, привязки не меняются. Отвязанные смарт-процессы возвращаются в CRM.…" } ] } @@ -55,12 +55,10 @@ "resultExample": { "result": { "automatedSolution": { - "id": 1, - "title": "HR", + "id": 238, + "title": "HR & Customer Success", "typeIds": [ - 1, - 2, - 3 + 14 ] } }, @@ -88,7 +86,7 @@ "type": "object", "base": "object", "required": false, - "description": "Объект с информацией об обновленном цифровом рабочем месте" + "description": "Цифровое рабочее место после изменения. Объект вложен в result (подробное описание)" }, { "name": "time", @@ -99,5 +97,11 @@ } ], "page": "/api-reference/crm/automated-solution/crm-automated-solution-update.html", - "executable": false + "executable": false, + "requestExample": { + "id": 238, + "fields": { + "title": "HR & Customer Success" + } + } } diff --git a/_assets/simulator/spec/methods/crm.automation.trigger.add.json b/_assets/simulator/spec/methods/crm.automation.trigger.add.json index e841e1f7e..e61b65d97 100644 --- a/_assets/simulator/spec/methods/crm.automation.trigger.add.json +++ b/_assets/simulator/spec/methods/crm.automation.trigger.add.json @@ -55,5 +55,9 @@ } ], "page": "/api-reference/crm/automation/triggers/crm-automation-trigger-add.html", - "executable": false + "executable": false, + "requestExample": { + "CODE": "c5u4m", + "NAME": "trigger name" + } } diff --git a/_assets/simulator/spec/methods/crm.automation.trigger.delete.json b/_assets/simulator/spec/methods/crm.automation.trigger.delete.json index f5e7316b7..e466edc78 100644 --- a/_assets/simulator/spec/methods/crm.automation.trigger.delete.json +++ b/_assets/simulator/spec/methods/crm.automation.trigger.delete.json @@ -48,5 +48,8 @@ } ], "page": "/api-reference/crm/automation/triggers/crm-automation-trigger-delete.html", - "executable": false + "executable": false, + "requestExample": { + "CODE": "c5u4m" + } } diff --git a/_assets/simulator/spec/methods/crm.automation.trigger.execute.json b/_assets/simulator/spec/methods/crm.automation.trigger.execute.json index 164156485..bc1492702 100644 --- a/_assets/simulator/spec/methods/crm.automation.trigger.execute.json +++ b/_assets/simulator/spec/methods/crm.automation.trigger.execute.json @@ -62,5 +62,10 @@ } ], "page": "/api-reference/crm/automation/triggers/crm-automation-trigger-execute.html", - "executable": false + "executable": false, + "requestExample": { + "CODE": "c5u4m", + "OWNER_TYPE_ID": 2, + "OWNER_ID": 6 + } } diff --git a/_assets/simulator/spec/methods/crm.automation.trigger.json b/_assets/simulator/spec/methods/crm.automation.trigger.json index 57ee36331..388e69b64 100644 --- a/_assets/simulator/spec/methods/crm.automation.trigger.json +++ b/_assets/simulator/spec/methods/crm.automation.trigger.json @@ -55,5 +55,9 @@ } ], "page": "/api-reference/crm/automation/crm-automation-trigger.html", - "executable": false + "executable": false, + "requestExample": { + "target": "DEAL_57", + "code": "c5u4m" + } } diff --git a/_assets/simulator/spec/methods/crm.calllist.add.json b/_assets/simulator/spec/methods/crm.calllist.add.json index c7e7e0170..b1d42f4c1 100644 --- a/_assets/simulator/spec/methods/crm.calllist.add.json +++ b/_assets/simulator/spec/methods/crm.calllist.add.json @@ -68,5 +68,14 @@ } ], "page": "/api-reference/crm/call-list/crm-calllist-add.html", - "executable": false + "executable": false, + "requestExample": { + "ENTITY_TYPE": "CONTACT", + "ENTITIES": [ + 1, + 2, + 3 + ], + "WEBFORM_ID": 5 + } } diff --git a/_assets/simulator/spec/methods/crm.calllist.get.json b/_assets/simulator/spec/methods/crm.calllist.get.json index c003a8e96..0234aa007 100644 --- a/_assets/simulator/spec/methods/crm.calllist.get.json +++ b/_assets/simulator/spec/methods/crm.calllist.get.json @@ -100,5 +100,8 @@ "ENTITY_TYPE_ID", "ID", "WEBFORM_ID" - ] + ], + "requestExample": { + "ID": 123 + } } diff --git a/_assets/simulator/spec/methods/crm.calllist.items.get.json b/_assets/simulator/spec/methods/crm.calllist.items.get.json index 00c562be4..19b76061a 100644 --- a/_assets/simulator/spec/methods/crm.calllist.items.get.json +++ b/_assets/simulator/spec/methods/crm.calllist.items.get.json @@ -82,5 +82,11 @@ "ENTITY_TYPE", "ID", "STATUS" - ] + ], + "requestExample": { + "LIST_ID": 13, + "FILTER": { + "STATUS": "IN_WORK" + } + } } diff --git a/_assets/simulator/spec/methods/crm.calllist.statuslist.json b/_assets/simulator/spec/methods/crm.calllist.statuslist.json index 7796753f8..0ea9dc96f 100644 --- a/_assets/simulator/spec/methods/crm.calllist.statuslist.json +++ b/_assets/simulator/spec/methods/crm.calllist.statuslist.json @@ -90,5 +90,6 @@ } ], "page": "/api-reference/crm/call-list/crm-calllist-statuslist.html", - "executable": false + "executable": false, + "requestExample": {} } diff --git a/_assets/simulator/spec/methods/crm.calllist.update.json b/_assets/simulator/spec/methods/crm.calllist.update.json index cd9796cbd..4474f1c57 100644 --- a/_assets/simulator/spec/methods/crm.calllist.update.json +++ b/_assets/simulator/spec/methods/crm.calllist.update.json @@ -75,5 +75,15 @@ } ], "page": "/api-reference/crm/call-list/crm-calllist-update.html", - "executable": false + "executable": false, + "requestExample": { + "LIST_ID": 123, + "ENTITY_TYPE": "CONTACT", + "ENTITIES": [ + 1, + 2, + 3 + ], + "WEBFORM_ID": 5 + } } diff --git a/_assets/simulator/spec/methods/crm.category.add.json b/_assets/simulator/spec/methods/crm.category.add.json index 1bb758a66..6da0c5057 100644 --- a/_assets/simulator/spec/methods/crm.category.add.json +++ b/_assets/simulator/spec/methods/crm.category.add.json @@ -80,5 +80,13 @@ } }, "page": "/api-reference/crm/universal/category/crm-category-add.html", - "executable": false + "executable": false, + "requestExample": { + "entityTypeId": 1152, + "fields": { + "name": "Новая воронка по умолчанию", + "sort": 50, + "isDefault": "Y" + } + } } diff --git a/_assets/simulator/spec/methods/crm.category.delete.json b/_assets/simulator/spec/methods/crm.category.delete.json index 7a3fa2314..f24466cd9 100644 --- a/_assets/simulator/spec/methods/crm.category.delete.json +++ b/_assets/simulator/spec/methods/crm.category.delete.json @@ -56,5 +56,9 @@ } ], "page": "/api-reference/crm/universal/category/crm-category-delete.html", - "executable": false + "executable": false, + "requestExample": { + "entityTypeId": 2, + "id": 5 + } } diff --git a/_assets/simulator/spec/methods/crm.category.fields.json b/_assets/simulator/spec/methods/crm.category.fields.json index f6f0806eb..e7fc5d74a 100644 --- a/_assets/simulator/spec/methods/crm.category.fields.json +++ b/_assets/simulator/spec/methods/crm.category.fields.json @@ -122,5 +122,8 @@ } ], "page": "/api-reference/crm/universal/category/crm-category-fields.html", - "executable": false + "executable": false, + "requestExample": { + "entityTypeId": 2 + } } diff --git a/_assets/simulator/spec/methods/crm.category.get.json b/_assets/simulator/spec/methods/crm.category.get.json index 78217690a..32ebfcd9a 100644 --- a/_assets/simulator/spec/methods/crm.category.get.json +++ b/_assets/simulator/spec/methods/crm.category.get.json @@ -75,5 +75,9 @@ "originId", "originatorId", "sort" - ] + ], + "requestExample": { + "entityTypeId": 2, + "id": 1 + } } diff --git a/_assets/simulator/spec/methods/crm.category.list.json b/_assets/simulator/spec/methods/crm.category.list.json index 6164942a9..a987c256d 100644 --- a/_assets/simulator/spec/methods/crm.category.list.json +++ b/_assets/simulator/spec/methods/crm.category.list.json @@ -103,5 +103,17 @@ "originId", "originatorId", "sort" - ] + ], + "requestExample": { + "entityTypeId": 2 + }, + "datasetHint": { + "entity": "categories", + "count": 3, + "idFrom": 0, + "idTo": 2, + "runnableExample": { + "entityTypeId": 2 + } + } } diff --git a/_assets/simulator/spec/methods/crm.category.update.json b/_assets/simulator/spec/methods/crm.category.update.json index 1655bba8c..4ea49602d 100644 --- a/_assets/simulator/spec/methods/crm.category.update.json +++ b/_assets/simulator/spec/methods/crm.category.update.json @@ -103,5 +103,14 @@ } ], "page": "/api-reference/crm/universal/category/crm-category-update.html", - "executable": false + "executable": false, + "requestExample": { + "entityTypeId": 1152, + "id": 4, + "fields": { + "name": "Новое название воронки", + "sort": 1000, + "isDefault": "Y" + } + } } diff --git a/_assets/simulator/spec/methods/crm.company.add.json b/_assets/simulator/spec/methods/crm.company.add.json index 0922c96a5..416d892fb 100644 --- a/_assets/simulator/spec/methods/crm.company.add.json +++ b/_assets/simulator/spec/methods/crm.company.add.json @@ -271,5 +271,26 @@ } ], "page": "/api-reference/crm/companies/crm-company-add.html", - "executable": false + "executable": false, + "requestExample": { + "fields": { + "TITLE": "ИП Титов", + "COMPANY_TYPE": "CUSTOMER", + "INDUSTRY": "MANUFACTURING", + "EMPLOYEES": "EMPLOYEES_2", + "CURRENCY_ID": "RUB", + "REVENUE": 3000000, + "OPENED": "Y", + "ASSIGNED_BY_ID": 1, + "PHONE": [ + { + "VALUE": "555888", + "VALUE_TYPE": "WORK" + } + ] + }, + "params": { + "REGISTER_SONET_EVENT": "Y" + } + } } diff --git a/_assets/simulator/spec/methods/crm.company.contact.add.json b/_assets/simulator/spec/methods/crm.company.contact.add.json index 92adddf3e..4ccfa5f76 100644 --- a/_assets/simulator/spec/methods/crm.company.contact.add.json +++ b/_assets/simulator/spec/methods/crm.company.contact.add.json @@ -98,5 +98,13 @@ } ], "page": "/api-reference/crm/companies/contacts/crm-company-contact-add.html", - "executable": false + "executable": false, + "requestExample": { + "id": 32, + "fields": { + "CONTACT_ID": 54, + "IS_PRIMARY": "Y", + "SORT": 1000 + } + } } diff --git a/_assets/simulator/spec/methods/crm.company.contact.delete.json b/_assets/simulator/spec/methods/crm.company.contact.delete.json index 439a3f00e..b8a0c1c25 100644 --- a/_assets/simulator/spec/methods/crm.company.contact.delete.json +++ b/_assets/simulator/spec/methods/crm.company.contact.delete.json @@ -73,5 +73,11 @@ } ], "page": "/api-reference/crm/companies/contacts/crm-company-contact-delete.html", - "executable": false + "executable": false, + "requestExample": { + "id": 32, + "fields": { + "CONTACT_ID": 54 + } + } } diff --git a/_assets/simulator/spec/methods/crm.company.contact.fields.json b/_assets/simulator/spec/methods/crm.company.contact.fields.json index 4f9f43bda..f2a57f095 100644 --- a/_assets/simulator/spec/methods/crm.company.contact.fields.json +++ b/_assets/simulator/spec/methods/crm.company.contact.fields.json @@ -91,5 +91,6 @@ } ], "page": "/api-reference/crm/companies/contacts/crm-company-contact-fields.html", - "executable": false + "executable": false, + "requestExample": {} } diff --git a/_assets/simulator/spec/methods/crm.company.contact.items.delete.json b/_assets/simulator/spec/methods/crm.company.contact.items.delete.json index b846493fa..fec4c53a7 100644 --- a/_assets/simulator/spec/methods/crm.company.contact.items.delete.json +++ b/_assets/simulator/spec/methods/crm.company.contact.items.delete.json @@ -48,5 +48,8 @@ } ], "page": "/api-reference/crm/companies/contacts/crm-company-contact-items-delete.html", - "executable": false + "executable": false, + "requestExample": { + "id": 32 + } } diff --git a/_assets/simulator/spec/methods/crm.company.contact.items.get.json b/_assets/simulator/spec/methods/crm.company.contact.items.get.json index 97bb56eda..e4286e8bf 100644 --- a/_assets/simulator/spec/methods/crm.company.contact.items.get.json +++ b/_assets/simulator/spec/methods/crm.company.contact.items.get.json @@ -73,5 +73,8 @@ "IS_PRIMARY", "ROLE_ID", "SORT" - ] + ], + "requestExample": { + "id": 32 + } } diff --git a/_assets/simulator/spec/methods/crm.company.contact.items.set.json b/_assets/simulator/spec/methods/crm.company.contact.items.set.json index d2263ff51..168bd99dd 100644 --- a/_assets/simulator/spec/methods/crm.company.contact.items.set.json +++ b/_assets/simulator/spec/methods/crm.company.contact.items.set.json @@ -99,5 +99,23 @@ } ], "page": "/api-reference/crm/companies/contacts/crm-company-contact-items-set.html", - "executable": false + "executable": false, + "requestExample": { + "id": 32, + "items": [ + { + "CONTACT_ID": 8, + "IS_PRIMARY": "Y", + "SORT": 100 + }, + { + "CONTACT_ID": 9, + "SORT": 200 + }, + { + "CONTACT_ID": 10, + "SORT": 400 + } + ] + } } diff --git a/_assets/simulator/spec/methods/crm.company.details.configuration.forceCommonScopeForAll.json b/_assets/simulator/spec/methods/crm.company.details.configuration.forceCommonScopeForAll.json index 5e4d0f7a3..b201f4935 100644 --- a/_assets/simulator/spec/methods/crm.company.details.configuration.forceCommonScopeForAll.json +++ b/_assets/simulator/spec/methods/crm.company.details.configuration.forceCommonScopeForAll.json @@ -64,5 +64,6 @@ } ], "page": "/api-reference/crm/companies/custom-form/crm-company-details-configuration-force-common-scope-for-all.html", - "executable": false + "executable": false, + "requestExample": {} } diff --git a/_assets/simulator/spec/methods/crm.company.details.configuration.get.json b/_assets/simulator/spec/methods/crm.company.details.configuration.get.json index 26106e95a..463287c51 100644 --- a/_assets/simulator/spec/methods/crm.company.details.configuration.get.json +++ b/_assets/simulator/spec/methods/crm.company.details.configuration.get.json @@ -180,5 +180,9 @@ "name", "title", "type" - ] + ], + "requestExample": { + "scope": "P", + "userId": 6 + } } diff --git a/_assets/simulator/spec/methods/crm.company.details.configuration.reset.json b/_assets/simulator/spec/methods/crm.company.details.configuration.reset.json index e9be45ccb..16ba7a6d1 100644 --- a/_assets/simulator/spec/methods/crm.company.details.configuration.reset.json +++ b/_assets/simulator/spec/methods/crm.company.details.configuration.reset.json @@ -70,5 +70,9 @@ } ], "page": "/api-reference/crm/companies/custom-form/crm-company-details-configuration-reset.html", - "executable": false + "executable": false, + "requestExample": { + "scope": "P", + "userId": 1 + } } diff --git a/_assets/simulator/spec/methods/crm.company.details.configuration.set.json b/_assets/simulator/spec/methods/crm.company.details.configuration.set.json index edaaf1a87..5c65b1f8a 100644 --- a/_assets/simulator/spec/methods/crm.company.details.configuration.set.json +++ b/_assets/simulator/spec/methods/crm.company.details.configuration.set.json @@ -81,5 +81,60 @@ } ], "page": "/api-reference/crm/companies/custom-form/crm-company-details-configuration-set.html", - "executable": false + "executable": false, + "requestExample": { + "userId": 1, + "data": [ + { + "name": "main", + "title": "О компании", + "type": "section", + "elements": [ + { + "name": "TITLE" + }, + { + "name": "LOGO" + }, + { + "name": "COMPANY_TYPE" + }, + { + "name": "POST" + }, + { + "name": "PHONE", + "options": { + "defaultCountry": "RU" + } + }, + { + "name": "EMAIL" + }, + { + "name": "CONTACT" + } + ] + }, + { + "name": "additional", + "title": "Дополнительно", + "type": "section", + "elements": [ + { + "name": "INDUSTRY" + }, + { + "name": "OPENED" + }, + { + "name": "ASSIGNED_BY_ID" + }, + { + "name": "COMMENTS" + } + ] + } + ] + } } diff --git a/_assets/simulator/spec/methods/crm.company.fields.json b/_assets/simulator/spec/methods/crm.company.fields.json index f16132401..f5bfb6abd 100644 --- a/_assets/simulator/spec/methods/crm.company.fields.json +++ b/_assets/simulator/spec/methods/crm.company.fields.json @@ -1242,5 +1242,6 @@ } ], "page": "/api-reference/crm/companies/crm-company-fields.html", - "executable": false + "executable": false, + "requestExample": {} } diff --git a/_assets/simulator/spec/methods/crm.company.get.json b/_assets/simulator/spec/methods/crm.company.get.json index 18228d539..73aecc293 100644 --- a/_assets/simulator/spec/methods/crm.company.get.json +++ b/_assets/simulator/spec/methods/crm.company.get.json @@ -168,5 +168,14 @@ "UTM_SOURCE", "UTM_TERM", "WEB" - ] + ], + "datasetHint": { + "entity": "companies", + "count": 12, + "idFrom": 1, + "idTo": 12, + "runnableExample": { + "id": 1 + } + } } diff --git a/_assets/simulator/spec/methods/crm.company.list.json b/_assets/simulator/spec/methods/crm.company.list.json index 1faea7ddc..742aca8f6 100644 --- a/_assets/simulator/spec/methods/crm.company.list.json +++ b/_assets/simulator/spec/methods/crm.company.list.json @@ -133,5 +133,12 @@ "UTM_SOURCE", "UTM_TERM", "WEB" - ] + ], + "datasetHint": { + "entity": "companies", + "count": 12, + "idFrom": 1, + "idTo": 12, + "runnableExample": {} + } } diff --git a/_assets/simulator/spec/methods/crm.company.userfield.add.json b/_assets/simulator/spec/methods/crm.company.userfield.add.json index a06f67403..fc1d9e432 100644 --- a/_assets/simulator/spec/methods/crm.company.userfield.add.json +++ b/_assets/simulator/spec/methods/crm.company.userfield.add.json @@ -305,5 +305,43 @@ } ], "page": "/api-reference/crm/companies/userfields/crm-company-userfield-add.html", - "executable": false + "executable": false, + "requestExample": { + "fields": { + "LABEL": "Пользовательское поле (список)", + "USER_TYPE_ID": "enumeration", + "FIELD_NAME": "ENUMERATION_EXAMPLE", + "MULTIPLE": "N", + "MANDATORY": "N", + "SHOW_FILTER": "Y", + "LIST": [ + { + "VALUE": "Элемент списка #1", + "DEF": "Y", + "XML_ID": "XML_ID_1", + "SORT": 100 + }, + { + "VALUE": "Элемент списка #2", + "XML_ID": "XML_ID_2", + "SORT": 200 + }, + { + "VALUE": "Элемент списка #3", + "XML_ID": "XML_ID_3", + "SORT": 300 + }, + { + "VALUE": "Элемент списка #4", + "XML_ID": "XML_ID_4", + "SORT": 400 + } + ], + "SETTINGS": { + "DISPLAY": "UI", + "LIST_HEIGHT": 2 + }, + "SORT": 2000 + } + } } diff --git a/_assets/simulator/spec/methods/crm.company.userfield.delete.json b/_assets/simulator/spec/methods/crm.company.userfield.delete.json index af11ceabe..323a75c59 100644 --- a/_assets/simulator/spec/methods/crm.company.userfield.delete.json +++ b/_assets/simulator/spec/methods/crm.company.userfield.delete.json @@ -49,5 +49,8 @@ } ], "page": "/api-reference/crm/companies/userfields/crm-company-userfield-delete.html", - "executable": false + "executable": false, + "requestExample": { + "id": 432 + } } diff --git a/_assets/simulator/spec/methods/crm.company.userfield.get.json b/_assets/simulator/spec/methods/crm.company.userfield.get.json index 5f6b120aa..787ba5674 100644 --- a/_assets/simulator/spec/methods/crm.company.userfield.get.json +++ b/_assets/simulator/spec/methods/crm.company.userfield.get.json @@ -206,5 +206,8 @@ "SORT", "USER_TYPE_ID", "XML_ID" - ] + ], + "requestExample": { + "id": 399 + } } diff --git a/_assets/simulator/spec/methods/crm.company.userfield.list.json b/_assets/simulator/spec/methods/crm.company.userfield.list.json index 8d8b478f2..ba6a5dec9 100644 --- a/_assets/simulator/spec/methods/crm.company.userfield.list.json +++ b/_assets/simulator/spec/methods/crm.company.userfield.list.json @@ -316,5 +316,16 @@ "SORT", "USER_TYPE_ID", "XML_ID" - ] + ], + "requestExample": { + "filter": { + "MULTIPLE": "Y", + "MANDATORY": "Y", + "LANG": "ru" + }, + "order": { + "USER_TYPE_ID": "ASC", + "SORT": "ASC" + } + } } diff --git a/_assets/simulator/spec/methods/crm.contact.company.add.json b/_assets/simulator/spec/methods/crm.contact.company.add.json index 3067d79d5..335535ae4 100644 --- a/_assets/simulator/spec/methods/crm.contact.company.add.json +++ b/_assets/simulator/spec/methods/crm.contact.company.add.json @@ -97,5 +97,13 @@ } ], "page": "/api-reference/crm/contacts/company/crm-contact-company-add.html", - "executable": false + "executable": false, + "requestExample": { + "id": 54, + "fields": { + "COMPANY_ID": 32, + "IS_PRIMARY": "Y", + "SORT": 1000 + } + } } diff --git a/_assets/simulator/spec/methods/crm.contact.company.items.delete.json b/_assets/simulator/spec/methods/crm.contact.company.items.delete.json index 45b53193b..172e66e30 100644 --- a/_assets/simulator/spec/methods/crm.contact.company.items.delete.json +++ b/_assets/simulator/spec/methods/crm.contact.company.items.delete.json @@ -48,5 +48,8 @@ } ], "page": "/api-reference/crm/contacts/company/crm-contact-company-items-delete.html", - "executable": false + "executable": false, + "requestExample": { + "id": 54 + } } diff --git a/_assets/simulator/spec/methods/crm.contact.company.items.get.json b/_assets/simulator/spec/methods/crm.contact.company.items.get.json index 87d2ccc6f..7329fbd8f 100644 --- a/_assets/simulator/spec/methods/crm.contact.company.items.get.json +++ b/_assets/simulator/spec/methods/crm.contact.company.items.get.json @@ -73,5 +73,8 @@ "IS_PRIMARY", "ROLE_ID", "SORT" - ] + ], + "requestExample": { + "id": 54 + } } diff --git a/_assets/simulator/spec/methods/crm.contact.company.items.set.json b/_assets/simulator/spec/methods/crm.contact.company.items.set.json index 25882fa34..cb9f8605c 100644 --- a/_assets/simulator/spec/methods/crm.contact.company.items.set.json +++ b/_assets/simulator/spec/methods/crm.contact.company.items.set.json @@ -60,5 +60,23 @@ } ], "page": "/api-reference/crm/contacts/company/crm-contact-company-items-set.html", - "executable": false + "executable": false, + "requestExample": { + "id": 82, + "items": [ + { + "COMPANY_ID": 8, + "IS_PRIMARY": "Y", + "SORT": 100 + }, + { + "COMPANY_ID": 9, + "SORT": 200 + }, + { + "COMPANY_ID": 10, + "SORT": 400 + } + ] + } } diff --git a/_assets/simulator/spec/methods/crm.contact.details.configuration.get.json b/_assets/simulator/spec/methods/crm.contact.details.configuration.get.json index d25d14f86..28c3539e0 100644 --- a/_assets/simulator/spec/methods/crm.contact.details.configuration.get.json +++ b/_assets/simulator/spec/methods/crm.contact.details.configuration.get.json @@ -125,5 +125,9 @@ "name", "title", "type" - ] + ], + "requestExample": { + "scope": "P", + "userId": 6 + } } diff --git a/_assets/simulator/spec/methods/crm.contact.details.configuration.reset.json b/_assets/simulator/spec/methods/crm.contact.details.configuration.reset.json index dc41ee79e..c38d8edca 100644 --- a/_assets/simulator/spec/methods/crm.contact.details.configuration.reset.json +++ b/_assets/simulator/spec/methods/crm.contact.details.configuration.reset.json @@ -69,5 +69,8 @@ } ], "page": "/api-reference/crm/contacts/custom-form/crm-contact-details-configuration-reset.html", - "executable": false + "executable": false, + "requestExample": { + "scope": "C" + } } diff --git a/_assets/simulator/spec/methods/crm.contact.details.configuration.set.json b/_assets/simulator/spec/methods/crm.contact.details.configuration.set.json index cf1e5dba8..dd9a83dcd 100644 --- a/_assets/simulator/spec/methods/crm.contact.details.configuration.set.json +++ b/_assets/simulator/spec/methods/crm.contact.details.configuration.set.json @@ -64,5 +64,77 @@ } }, "page": "/api-reference/crm/contacts/custom-form/crm-contact-details-configuration-set.html", - "executable": false + "executable": false, + "requestExample": { + "userId": 1, + "data": [ + { + "name": "section_1", + "title": "Личные данные", + "type": "section", + "elements": [ + { + "name": "NAME", + "optionFlags": 1 + }, + { + "name": "LAST_NAME", + "optionFlags": 1 + }, + { + "name": "SECOND_NAME" + }, + { + "name": "BIRTHDATE" + }, + { + "name": "PHONE", + "optionFlags": 1, + "options": { + "defaultCountry": "GB" + } + }, + { + "name": "ADDRESS", + "optionFlags": 1, + "options": { + "defaultAddressType": 4 + } + } + ] + }, + { + "name": "section_2", + "title": "Основная информация", + "type": "section", + "elements": [ + { + "name": "TYPE_ID" + }, + { + "name": "SOURCE_ID" + }, + { + "name": "POST" + } + ] + }, + { + "name": "section_3", + "title": "Дополнительная информация", + "type": "section", + "elements": [ + { + "name": "PHOTO" + }, + { + "name": "COMMENTS" + }, + { + "name": "UF_CRM_1720697698689" + } + ] + } + ] + } } diff --git a/_assets/simulator/spec/methods/crm.contact.get.json b/_assets/simulator/spec/methods/crm.contact.get.json index ee4605b10..60e8de0dc 100644 --- a/_assets/simulator/spec/methods/crm.contact.get.json +++ b/_assets/simulator/spec/methods/crm.contact.get.json @@ -156,5 +156,14 @@ "UTM_SOURCE", "UTM_TERM", "WEB" - ] + ], + "datasetHint": { + "entity": "contacts", + "count": 30, + "idFrom": 1, + "idTo": 30, + "runnableExample": { + "id": 1 + } + } } diff --git a/_assets/simulator/spec/methods/crm.contact.list.json b/_assets/simulator/spec/methods/crm.contact.list.json index 4af0a09fc..a2ee3329e 100644 --- a/_assets/simulator/spec/methods/crm.contact.list.json +++ b/_assets/simulator/spec/methods/crm.contact.list.json @@ -213,5 +213,12 @@ "UTM_SOURCE", "UTM_TERM", "WEB" - ] + ], + "datasetHint": { + "entity": "contacts", + "count": 30, + "idFrom": 1, + "idTo": 30, + "runnableExample": {} + } } diff --git a/_assets/simulator/spec/methods/crm.contact.userfield.add.json b/_assets/simulator/spec/methods/crm.contact.userfield.add.json index 31fa67d27..c6118a6f1 100644 --- a/_assets/simulator/spec/methods/crm.contact.userfield.add.json +++ b/_assets/simulator/spec/methods/crm.contact.userfield.add.json @@ -304,5 +304,43 @@ } ], "page": "/api-reference/crm/contacts/userfield/crm-contact-userfield-add.html", - "executable": false + "executable": false, + "requestExample": { + "fields": { + "LABEL": "Пользовательское поле (список)", + "USER_TYPE_ID": "enumeration", + "FIELD_NAME": "ENUMERATION_EXAMPLE", + "MULTIPLE": "N", + "MANDATORY": "N", + "SHOW_FILTER": "Y", + "LIST": [ + { + "VALUE": "Элемент списка #1", + "DEF": "Y", + "XML_ID": "XML_ID_1", + "SORT": 100 + }, + { + "VALUE": "Элемент списка #2", + "XML_ID": "XML_ID_2", + "SORT": 200 + }, + { + "VALUE": "Элемент списка #3", + "XML_ID": "XML_ID_3", + "SORT": 300 + }, + { + "VALUE": "Элемент списка #4", + "XML_ID": "XML_ID_4", + "SORT": 400 + } + ], + "SETTINGS": { + "DISPLAY": "UI", + "LIST_HEIGHT": 2 + }, + "SORT": 2000 + } + } } diff --git a/_assets/simulator/spec/methods/crm.contact.userfield.delete.json b/_assets/simulator/spec/methods/crm.contact.userfield.delete.json index 6afe6aa2a..0fefc09be 100644 --- a/_assets/simulator/spec/methods/crm.contact.userfield.delete.json +++ b/_assets/simulator/spec/methods/crm.contact.userfield.delete.json @@ -49,5 +49,8 @@ } ], "page": "/api-reference/crm/contacts/userfield/crm-contact-userfield-delete.html", - "executable": false + "executable": false, + "requestExample": { + "id": 432 + } } diff --git a/_assets/simulator/spec/methods/crm.contact.userfield.get.json b/_assets/simulator/spec/methods/crm.contact.userfield.get.json index a38e40190..7b2d0c1fe 100644 --- a/_assets/simulator/spec/methods/crm.contact.userfield.get.json +++ b/_assets/simulator/spec/methods/crm.contact.userfield.get.json @@ -57,5 +57,8 @@ "SORT", "USER_TYPE_ID", "XML_ID" - ] + ], + "requestExample": { + "id": 399 + } } diff --git a/_assets/simulator/spec/methods/crm.contact.userfield.list.json b/_assets/simulator/spec/methods/crm.contact.userfield.list.json index 73c308f09..44cab0221 100644 --- a/_assets/simulator/spec/methods/crm.contact.userfield.list.json +++ b/_assets/simulator/spec/methods/crm.contact.userfield.list.json @@ -244,5 +244,16 @@ "SORT", "USER_TYPE_ID", "XML_ID" - ] + ], + "requestExample": { + "filter": { + "MULTIPLE": "Y", + "MANDATORY": "Y", + "LANG": "ru" + }, + "order": { + "USER_TYPE_ID": "ASC", + "SORT": "ASC" + } + } } diff --git a/_assets/simulator/spec/methods/crm.currency.add.json b/_assets/simulator/spec/methods/crm.currency.add.json index 055fb8bb0..8373d84b3 100644 --- a/_assets/simulator/spec/methods/crm.currency.add.json +++ b/_assets/simulator/spec/methods/crm.currency.add.json @@ -112,5 +112,32 @@ } ], "page": "/api-reference/crm/currency/crm-currency-add.html", - "executable": false + "executable": false, + "requestExample": { + "fields": { + "CURRENCY": "CNY", + "BASE": "N", + "AMOUNT": 12.2251, + "AMOUNT_CNT": 1, + "SORT": 9000, + "LANG": { + "ru": { + "DECIMALS": 2, + "DEC_POINT": ".", + "FORMAT_STRING": "# CNY", + "FULL_NAME": "юань", + "HIDE_ZERO": "Y", + "THOUSANDS_VARIANT": "S" + }, + "en": { + "DECIMALS": 2, + "DEC_POINT": ",", + "FORMAT_STRING": "# CNY", + "FULL_NAME": "yuan", + "HIDE_ZERO": "Y", + "THOUSANDS_SEP": "." + } + } + } + } } diff --git a/_assets/simulator/spec/methods/crm.currency.base.set.json b/_assets/simulator/spec/methods/crm.currency.base.set.json index 27b2c242f..6a4d5391f 100644 --- a/_assets/simulator/spec/methods/crm.currency.base.set.json +++ b/_assets/simulator/spec/methods/crm.currency.base.set.json @@ -49,5 +49,8 @@ } ], "page": "/api-reference/crm/currency/crm-currency-base-set.html", - "executable": false + "executable": false, + "requestExample": { + "id": "RUB" + } } diff --git a/_assets/simulator/spec/methods/crm.currency.delete.json b/_assets/simulator/spec/methods/crm.currency.delete.json index 33500aa2f..030fe16c3 100644 --- a/_assets/simulator/spec/methods/crm.currency.delete.json +++ b/_assets/simulator/spec/methods/crm.currency.delete.json @@ -49,5 +49,8 @@ } ], "page": "/api-reference/crm/currency/crm-currency-delete.html", - "executable": false + "executable": false, + "requestExample": { + "id": "IDR" + } } diff --git a/_assets/simulator/spec/methods/crm.currency.get.json b/_assets/simulator/spec/methods/crm.currency.get.json index 960b5b430..8fc9348cf 100644 --- a/_assets/simulator/spec/methods/crm.currency.get.json +++ b/_assets/simulator/spec/methods/crm.currency.get.json @@ -92,5 +92,8 @@ "SORT", "en", "ru" - ] + ], + "requestExample": { + "id": "RUB" + } } diff --git a/_assets/simulator/spec/methods/crm.currency.list.json b/_assets/simulator/spec/methods/crm.currency.list.json index 69227dbd0..5810ae43f 100644 --- a/_assets/simulator/spec/methods/crm.currency.list.json +++ b/_assets/simulator/spec/methods/crm.currency.list.json @@ -66,5 +66,11 @@ "CURRENCY", "LANG", "SORT" - ] + ], + "requestExample": { + "order": { + "sort": "asc", + "currency": "asc" + } + } } diff --git a/_assets/simulator/spec/methods/crm.currency.localizations.delete.json b/_assets/simulator/spec/methods/crm.currency.localizations.delete.json index d04722bba..f1fb64f24 100644 --- a/_assets/simulator/spec/methods/crm.currency.localizations.delete.json +++ b/_assets/simulator/spec/methods/crm.currency.localizations.delete.json @@ -60,5 +60,12 @@ } ], "page": "/api-reference/crm/currency/localizations/crm-currency-localizations-delete.html", - "executable": false + "executable": false, + "requestExample": { + "id": "CLF", + "lids": [ + "en", + "de" + ] + } } diff --git a/_assets/simulator/spec/methods/crm.currency.localizations.get.json b/_assets/simulator/spec/methods/crm.currency.localizations.get.json index ee0e50023..e212b2c6b 100644 --- a/_assets/simulator/spec/methods/crm.currency.localizations.get.json +++ b/_assets/simulator/spec/methods/crm.currency.localizations.get.json @@ -77,5 +77,8 @@ "HIDE_ZERO", "THOUSANDS_SEP", "THOUSANDS_VARIANT" - ] + ], + "requestExample": { + "id": "RUB" + } } diff --git a/_assets/simulator/spec/methods/crm.currency.localizations.set.json b/_assets/simulator/spec/methods/crm.currency.localizations.set.json index fa74ef0cf..b8a3f13ca 100644 --- a/_assets/simulator/spec/methods/crm.currency.localizations.set.json +++ b/_assets/simulator/spec/methods/crm.currency.localizations.set.json @@ -60,5 +60,24 @@ } ], "page": "/api-reference/crm/currency/localizations/crm-currency-localizations-set.html", - "executable": false + "executable": false, + "requestExample": { + "id": "CLF", + "localizations": { + "en": { + "FULL_NAME": "Unidad de Fomento", + "FORMAT_STRING": "CLF#VALUE#", + "DEC_POINT": ".", + "THOUSANDS_VARIANT": "C", + "DECIMALS": 4 + }, + "ru": { + "FULL_NAME": "Единица развития", + "FORMAT_STRING": "#VALUE# CLF", + "DEC_POINT": ".", + "THOUSANDS_VARIANT": "B", + "DECIMALS": 4 + } + } + } } diff --git a/_assets/simulator/spec/methods/crm.deal.contact.add.json b/_assets/simulator/spec/methods/crm.deal.contact.add.json index 02f63d638..ec82c7897 100644 --- a/_assets/simulator/spec/methods/crm.deal.contact.add.json +++ b/_assets/simulator/spec/methods/crm.deal.contact.add.json @@ -100,5 +100,13 @@ } ], "page": "/api-reference/crm/deals/contacts/crm-deal-contact-add.html", - "executable": false + "executable": false, + "requestExample": { + "id": 1875, + "fields": { + "CONTACT_ID": 55, + "IS_PRIMARY": "Y", + "SORT": 1000 + } + } } diff --git a/_assets/simulator/spec/methods/crm.deal.contact.delete.json b/_assets/simulator/spec/methods/crm.deal.contact.delete.json index d8cbeeb75..83aef0920 100644 --- a/_assets/simulator/spec/methods/crm.deal.contact.delete.json +++ b/_assets/simulator/spec/methods/crm.deal.contact.delete.json @@ -75,5 +75,11 @@ } ], "page": "/api-reference/crm/deals/contacts/crm-deal-contact-delete.html", - "executable": false + "executable": false, + "requestExample": { + "id": 1875, + "fields": { + "CONTACT_ID": 55 + } + } } diff --git a/_assets/simulator/spec/methods/crm.deal.contact.fields.json b/_assets/simulator/spec/methods/crm.deal.contact.fields.json index 7c186ea3d..5102227f6 100644 --- a/_assets/simulator/spec/methods/crm.deal.contact.fields.json +++ b/_assets/simulator/spec/methods/crm.deal.contact.fields.json @@ -93,5 +93,6 @@ } ], "page": "/api-reference/crm/deals/contacts/crm-deal-contact-fields.html", - "executable": false + "executable": false, + "requestExample": {} } diff --git a/_assets/simulator/spec/methods/crm.deal.contact.items.delete.json b/_assets/simulator/spec/methods/crm.deal.contact.items.delete.json index 3c4195ae3..b00110eb1 100644 --- a/_assets/simulator/spec/methods/crm.deal.contact.items.delete.json +++ b/_assets/simulator/spec/methods/crm.deal.contact.items.delete.json @@ -50,5 +50,8 @@ } ], "page": "/api-reference/crm/deals/contacts/crm-deal-contact-items-delete.html", - "executable": false + "executable": false, + "requestExample": { + "id": 1875 + } } diff --git a/_assets/simulator/spec/methods/crm.deal.contact.items.get.json b/_assets/simulator/spec/methods/crm.deal.contact.items.get.json index 6359b515f..8ecb946bc 100644 --- a/_assets/simulator/spec/methods/crm.deal.contact.items.get.json +++ b/_assets/simulator/spec/methods/crm.deal.contact.items.get.json @@ -75,5 +75,8 @@ "IS_PRIMARY", "ROLE_ID", "SORT" - ] + ], + "requestExample": { + "id": 1875 + } } diff --git a/_assets/simulator/spec/methods/crm.deal.contact.items.set.json b/_assets/simulator/spec/methods/crm.deal.contact.items.set.json index d51a01e94..6a5883cc5 100644 --- a/_assets/simulator/spec/methods/crm.deal.contact.items.set.json +++ b/_assets/simulator/spec/methods/crm.deal.contact.items.set.json @@ -61,5 +61,23 @@ } ], "page": "/api-reference/crm/deals/contacts/crm-deal-contact-items-set.html", - "executable": false + "executable": false, + "requestExample": { + "id": 1875, + "items": [ + { + "CONTACT_ID": 55, + "IS_PRIMARY": "Y", + "SORT": 100 + }, + { + "CONTACT_ID": 54, + "SORT": 200 + }, + { + "CONTACT_ID": 56, + "SORT": 400 + } + ] + } } diff --git a/_assets/simulator/spec/methods/crm.deal.details.configuration.forceCommonScopeForAll.json b/_assets/simulator/spec/methods/crm.deal.details.configuration.forceCommonScopeForAll.json index ecdbb7af1..f5619f69c 100644 --- a/_assets/simulator/spec/methods/crm.deal.details.configuration.forceCommonScopeForAll.json +++ b/_assets/simulator/spec/methods/crm.deal.details.configuration.forceCommonScopeForAll.json @@ -71,5 +71,10 @@ } ], "page": "/api-reference/crm/deals/custom-form/crm-deal-details-configuration-force-common-scope-for-all.html", - "executable": false + "executable": false, + "requestExample": { + "extras": { + "dealCategoryId": 32 + } + } } diff --git a/_assets/simulator/spec/methods/crm.deal.details.configuration.get.json b/_assets/simulator/spec/methods/crm.deal.details.configuration.get.json index 49d959fc4..baece67b4 100644 --- a/_assets/simulator/spec/methods/crm.deal.details.configuration.get.json +++ b/_assets/simulator/spec/methods/crm.deal.details.configuration.get.json @@ -179,5 +179,11 @@ "name", "title", "type" - ] + ], + "requestExample": { + "scope": "C", + "extras": { + "dealCategoryId": 32 + } + } } diff --git a/_assets/simulator/spec/methods/crm.deal.details.configuration.reset.json b/_assets/simulator/spec/methods/crm.deal.details.configuration.reset.json index 3852dffef..1affb0956 100644 --- a/_assets/simulator/spec/methods/crm.deal.details.configuration.reset.json +++ b/_assets/simulator/spec/methods/crm.deal.details.configuration.reset.json @@ -95,5 +95,12 @@ } ], "page": "/api-reference/crm/deals/custom-form/crm-deal-details-configuration-reset.html", - "executable": false + "executable": false, + "requestExample": { + "scope": "P", + "userId": 1, + "extras": { + "dealCategoryId": 32 + } + } } diff --git a/_assets/simulator/spec/methods/crm.deal.details.configuration.set.json b/_assets/simulator/spec/methods/crm.deal.details.configuration.set.json index 7c54fd1d0..65e5ab231 100644 --- a/_assets/simulator/spec/methods/crm.deal.details.configuration.set.json +++ b/_assets/simulator/spec/methods/crm.deal.details.configuration.set.json @@ -106,5 +106,71 @@ } ], "page": "/api-reference/crm/deals/custom-form/crm-deal-details-configuration-set.html", - "executable": false + "executable": false, + "requestExample": { + "scope": "P", + "userId": 1, + "extras": { + "dealCategoryId": 32 + }, + "data": [ + { + "name": "main", + "title": "О сделке", + "type": "section", + "elements": [ + { + "name": "TITLE" + }, + { + "name": "OPPORTUNITY_WITH_CURRENCY" + }, + { + "name": "STAGE_ID" + }, + { + "name": "CLOSEDATE" + }, + { + "name": "CLIENT" + } + ] + }, + { + "name": "additional", + "title": "Дополнительно", + "type": "section", + "elements": [ + { + "name": "TYPE_ID" + }, + { + "name": "SOURCE_ID" + }, + { + "name": "SOURCE_DESCRIPTION" + }, + { + "name": "OPENED" + }, + { + "name": "ASSIGNED_BY_ID" + }, + { + "name": "COMMENTS" + } + ] + }, + { + "name": "products", + "title": "Товары", + "type": "section", + "elements": [ + { + "name": "PRODUCT_ROW_SUMMARY" + } + ] + } + ] + } } diff --git a/_assets/simulator/spec/methods/crm.deal.fields.json b/_assets/simulator/spec/methods/crm.deal.fields.json index 4b1ab700a..bac7be4e6 100644 --- a/_assets/simulator/spec/methods/crm.deal.fields.json +++ b/_assets/simulator/spec/methods/crm.deal.fields.json @@ -486,5 +486,6 @@ } ], "page": "/api-reference/crm/deals/crm-deal-fields.html", - "executable": false + "executable": false, + "requestExample": {} } diff --git a/_assets/simulator/spec/methods/crm.deal.get.json b/_assets/simulator/spec/methods/crm.deal.get.json index df29552d1..a7221e273 100644 --- a/_assets/simulator/spec/methods/crm.deal.get.json +++ b/_assets/simulator/spec/methods/crm.deal.get.json @@ -151,5 +151,14 @@ "UTM_MEDIUM", "UTM_SOURCE", "UTM_TERM" - ] + ], + "datasetHint": { + "entity": "deals", + "count": 60, + "idFrom": 1, + "idTo": 60, + "runnableExample": { + "id": 1 + } + } } diff --git a/_assets/simulator/spec/methods/crm.deal.list.json b/_assets/simulator/spec/methods/crm.deal.list.json index 193d6ca92..4ef1fe181 100644 --- a/_assets/simulator/spec/methods/crm.deal.list.json +++ b/_assets/simulator/spec/methods/crm.deal.list.json @@ -206,5 +206,12 @@ "UTM_MEDIUM", "UTM_SOURCE", "UTM_TERM" - ] + ], + "datasetHint": { + "entity": "deals", + "count": 60, + "idFrom": 1, + "idTo": 60, + "runnableExample": {} + } } diff --git a/_assets/simulator/spec/methods/crm.deal.recurring.add.json b/_assets/simulator/spec/methods/crm.deal.recurring.add.json index 06e2088ee..96f5a988d 100644 --- a/_assets/simulator/spec/methods/crm.deal.recurring.add.json +++ b/_assets/simulator/spec/methods/crm.deal.recurring.add.json @@ -130,5 +130,23 @@ } ], "page": "/api-reference/crm/deals/recurring-deals/crm-deal-recurring-add.html", - "executable": false + "executable": false, + "requestExample": { + "fields": { + "DEAL_ID": 45, + "CATEGORY_ID": "1", + "IS_LIMIT": "D", + "LIMIT_DATE": "2027-03-04", + "START_DATE": "2026-04-04", + "PARAMS": { + "MODE": "multiple", + "MULTIPLE_TYPE": "month", + "MULTIPLE_INTERVAL": 1, + "OFFSET_BEGINDATE_TYPE": "day", + "OFFSET_BEGINDATE_VALUE": 1, + "OFFSET_CLOSEDATE_TYPE": "month", + "OFFSET_CLOSEDATE_VALUE": 2 + } + } + } } diff --git a/_assets/simulator/spec/methods/crm.deal.recurring.delete.json b/_assets/simulator/spec/methods/crm.deal.recurring.delete.json index 9e9c60445..f1df97cc7 100644 --- a/_assets/simulator/spec/methods/crm.deal.recurring.delete.json +++ b/_assets/simulator/spec/methods/crm.deal.recurring.delete.json @@ -50,5 +50,8 @@ } ], "page": "/api-reference/crm/deals/recurring-deals/crm-deal-recurring-delete.html", - "executable": false + "executable": false, + "requestExample": { + "id": 15 + } } diff --git a/_assets/simulator/spec/methods/crm.deal.recurring.expose.json b/_assets/simulator/spec/methods/crm.deal.recurring.expose.json index 22e7c0868..5d08ef752 100644 --- a/_assets/simulator/spec/methods/crm.deal.recurring.expose.json +++ b/_assets/simulator/spec/methods/crm.deal.recurring.expose.json @@ -59,5 +59,8 @@ } ], "page": "/api-reference/crm/deals/recurring-deals/crm-deal-recurring-expose.html", - "executable": false + "executable": false, + "requestExample": { + "id": 15 + } } diff --git a/_assets/simulator/spec/methods/crm.deal.recurring.fields.json b/_assets/simulator/spec/methods/crm.deal.recurring.fields.json index bb7223de7..144cff284 100644 --- a/_assets/simulator/spec/methods/crm.deal.recurring.fields.json +++ b/_assets/simulator/spec/methods/crm.deal.recurring.fields.json @@ -266,5 +266,6 @@ } ], "page": "/api-reference/crm/deals/recurring-deals/crm-deal-recurring-fields.html", - "executable": false + "executable": false, + "requestExample": {} } diff --git a/_assets/simulator/spec/methods/crm.deal.recurring.get.json b/_assets/simulator/spec/methods/crm.deal.recurring.get.json index 7b35b74cf..d101e2340 100644 --- a/_assets/simulator/spec/methods/crm.deal.recurring.get.json +++ b/_assets/simulator/spec/methods/crm.deal.recurring.get.json @@ -84,5 +84,8 @@ "LIMIT_REPEAT", "PARAMS", "START_DATE" - ] + ], + "requestExample": { + "id": 15 + } } diff --git a/_assets/simulator/spec/methods/crm.deal.recurring.list.json b/_assets/simulator/spec/methods/crm.deal.recurring.list.json index c053aa9cf..690ce1c83 100644 --- a/_assets/simulator/spec/methods/crm.deal.recurring.list.json +++ b/_assets/simulator/spec/methods/crm.deal.recurring.list.json @@ -155,5 +155,13 @@ "category_id", "deal_id", "id" - ] + ], + "requestExample": { + "order": { + "deal_id": "ASC" + }, + "filter": { + ">COUNTER_REPEAT": 0 + } + } } diff --git a/_assets/simulator/spec/methods/crm.deal.recurring.update.json b/_assets/simulator/spec/methods/crm.deal.recurring.update.json index f91eb287b..52704bdee 100644 --- a/_assets/simulator/spec/methods/crm.deal.recurring.update.json +++ b/_assets/simulator/spec/methods/crm.deal.recurring.update.json @@ -130,5 +130,24 @@ } ], "page": "/api-reference/crm/deals/recurring-deals/crm-deal-recurring-update.html", - "executable": false + "executable": false, + "requestExample": { + "id": 15, + "fields": { + "ACTIVE": "Y", + "CATEGORY_ID": "2", + "IS_LIMIT": "D", + "LIMIT_DATE": "2027-03-05", + "START_DATE": "2026-04-05", + "PARAMS": { + "MODE": "multiple", + "MULTIPLE_TYPE": "month", + "MULTIPLE_INTERVAL": 1, + "OFFSET_BEGINDATE_TYPE": "day", + "OFFSET_BEGINDATE_VALUE": 1, + "OFFSET_CLOSEDATE_TYPE": "month", + "OFFSET_CLOSEDATE_VALUE": 2 + } + } + } } diff --git a/_assets/simulator/spec/methods/crm.deal.userfield.add.json b/_assets/simulator/spec/methods/crm.deal.userfield.add.json index 75cb89b65..430e7887d 100644 --- a/_assets/simulator/spec/methods/crm.deal.userfield.add.json +++ b/_assets/simulator/spec/methods/crm.deal.userfield.add.json @@ -305,5 +305,43 @@ } ], "page": "/api-reference/crm/deals/user-defined-fields/crm-deal-userfield-add.html", - "executable": false + "executable": false, + "requestExample": { + "fields": { + "LABEL": "Пользовательское поле (список)", + "USER_TYPE_ID": "enumeration", + "FIELD_NAME": "ENUMERATION_EXAMPLE", + "MULTIPLE": "N", + "MANDATORY": "N", + "SHOW_FILTER": "Y", + "LIST": [ + { + "VALUE": "Элемент списка #1", + "DEF": "Y", + "XML_ID": "XML_ID_1", + "SORT": 100 + }, + { + "VALUE": "Элемент списка #2", + "XML_ID": "XML_ID_2", + "SORT": 200 + }, + { + "VALUE": "Элемент списка #3", + "XML_ID": "XML_ID_3", + "SORT": 300 + }, + { + "VALUE": "Элемент списка #4", + "XML_ID": "XML_ID_4", + "SORT": 400 + } + ], + "SETTINGS": { + "DISPLAY": "UI", + "LIST_HEIGHT": 2 + }, + "SORT": 2000 + } + } } diff --git a/_assets/simulator/spec/methods/crm.deal.userfield.delete.json b/_assets/simulator/spec/methods/crm.deal.userfield.delete.json index 5e50b5f36..ba6e906de 100644 --- a/_assets/simulator/spec/methods/crm.deal.userfield.delete.json +++ b/_assets/simulator/spec/methods/crm.deal.userfield.delete.json @@ -49,5 +49,8 @@ } ], "page": "/api-reference/crm/deals/user-defined-fields/crm-deal-userfield-delete.html", - "executable": false + "executable": false, + "requestExample": { + "id": 432 + } } diff --git a/_assets/simulator/spec/methods/crm.deal.userfield.get.json b/_assets/simulator/spec/methods/crm.deal.userfield.get.json index 3165d72a4..7568fc7fd 100644 --- a/_assets/simulator/spec/methods/crm.deal.userfield.get.json +++ b/_assets/simulator/spec/methods/crm.deal.userfield.get.json @@ -206,5 +206,8 @@ "SORT", "USER_TYPE_ID", "XML_ID" - ] + ], + "requestExample": { + "id": 399 + } } diff --git a/_assets/simulator/spec/methods/crm.deal.userfield.list.json b/_assets/simulator/spec/methods/crm.deal.userfield.list.json index 224fb4255..12f5b1e32 100644 --- a/_assets/simulator/spec/methods/crm.deal.userfield.list.json +++ b/_assets/simulator/spec/methods/crm.deal.userfield.list.json @@ -316,5 +316,16 @@ "SORT", "USER_TYPE_ID", "XML_ID" - ] + ], + "requestExample": { + "filter": { + "MULTIPLE": "Y", + "MANDATORY": "Y", + "LANG": "ru" + }, + "order": { + "USER_TYPE_ID": "ASC", + "SORT": "ASC" + } + } } diff --git a/_assets/simulator/spec/methods/crm.dealcategory.add.json b/_assets/simulator/spec/methods/crm.dealcategory.add.json index 8c33b4a34..80312ec0b 100644 --- a/_assets/simulator/spec/methods/crm.dealcategory.add.json +++ b/_assets/simulator/spec/methods/crm.dealcategory.add.json @@ -28,5 +28,11 @@ "successor": "crm.category.add" }, "page": "/api-reference/crm/outdated/category-old/crm-deal-category-add.html", - "executable": false + "executable": false, + "requestExample": { + "fields": { + "NAME": "Новое направление", + "SORT": "20" + } + } } diff --git a/_assets/simulator/spec/methods/crm.dealcategory.default.set.json b/_assets/simulator/spec/methods/crm.dealcategory.default.set.json index e1e8186a6..22c46607e 100644 --- a/_assets/simulator/spec/methods/crm.dealcategory.default.set.json +++ b/_assets/simulator/spec/methods/crm.dealcategory.default.set.json @@ -24,5 +24,8 @@ "successor": null }, "page": "/api-reference/crm/outdated/category-old/crm-deal-category-default-set.html", - "executable": false + "executable": false, + "requestExample": { + "name": "" + } } diff --git a/_assets/simulator/spec/methods/crm.dealcategory.delete.json b/_assets/simulator/spec/methods/crm.dealcategory.delete.json index 6ebab8d3d..973380903 100644 --- a/_assets/simulator/spec/methods/crm.dealcategory.delete.json +++ b/_assets/simulator/spec/methods/crm.dealcategory.delete.json @@ -24,5 +24,8 @@ "successor": "crm.category.delete" }, "page": "/api-reference/crm/outdated/category-old/crm-deal-category-delete.html", - "executable": false + "executable": false, + "requestExample": { + "id": "1" + } } diff --git a/_assets/simulator/spec/methods/crm.dealcategory.get.json b/_assets/simulator/spec/methods/crm.dealcategory.get.json index aa9bf67b9..89f8cf1d5 100644 --- a/_assets/simulator/spec/methods/crm.dealcategory.get.json +++ b/_assets/simulator/spec/methods/crm.dealcategory.get.json @@ -24,5 +24,8 @@ "successor": "crm.category.get" }, "page": "/api-reference/crm/outdated/category-old/crm-deal-category-get.html", - "executable": false + "executable": false, + "requestExample": { + "id": "1" + } } diff --git a/_assets/simulator/spec/methods/crm.dealcategory.stage.list.json b/_assets/simulator/spec/methods/crm.dealcategory.stage.list.json index 61f513269..d480d8577 100644 --- a/_assets/simulator/spec/methods/crm.dealcategory.stage.list.json +++ b/_assets/simulator/spec/methods/crm.dealcategory.stage.list.json @@ -24,5 +24,8 @@ "successor": null }, "page": "/api-reference/crm/outdated/category-old/crm-deal-category-stage-list.html", - "executable": false + "executable": false, + "requestExample": { + "id": "1" + } } diff --git a/_assets/simulator/spec/methods/crm.dealcategory.update.json b/_assets/simulator/spec/methods/crm.dealcategory.update.json index 9832d7e0d..01929e6b5 100644 --- a/_assets/simulator/spec/methods/crm.dealcategory.update.json +++ b/_assets/simulator/spec/methods/crm.dealcategory.update.json @@ -35,5 +35,11 @@ "successor": "crm.category.update" }, "page": "/api-reference/crm/outdated/category-old/crm-deal-category-update.html", - "executable": false + "executable": false, + "requestExample": { + "id": "1", + "fields": { + "SORT": "100" + } + } } diff --git a/_assets/simulator/spec/methods/crm.documentgenerator.document.add.json b/_assets/simulator/spec/methods/crm.documentgenerator.document.add.json index 15bb5b8f9..db340ba3a 100644 --- a/_assets/simulator/spec/methods/crm.documentgenerator.document.add.json +++ b/_assets/simulator/spec/methods/crm.documentgenerator.document.add.json @@ -131,5 +131,27 @@ } ], "page": "/api-reference/crm/document-generator/documents/crm-document-generator-document-add.html", - "executable": false + "executable": false, + "requestExample": { + "templateId": 39, + "entityTypeId": 2, + "entityId": 101, + "values": { + "DocumentNumber": "2026-001" + }, + "fields": { + "DocumentTitle": { + "title": "Название документа", + "value": "Демонстрационная реализация товара 1", + "required": "Y", + "default": "Демонстрационная реализация товара 1", + "chain": [ + {}, + "getTitle" + ], + "VALUE": "Тест через fields" + } + }, + "stampsEnabled": 1 + } } diff --git a/_assets/simulator/spec/methods/crm.documentgenerator.document.delete.json b/_assets/simulator/spec/methods/crm.documentgenerator.document.delete.json index bce954604..3c3ec9168 100644 --- a/_assets/simulator/spec/methods/crm.documentgenerator.document.delete.json +++ b/_assets/simulator/spec/methods/crm.documentgenerator.document.delete.json @@ -50,5 +50,8 @@ } ], "page": "/api-reference/crm/document-generator/documents/crm-document-generator-document-delete.html", - "executable": false + "executable": false, + "requestExample": { + "id": 61 + } } diff --git a/_assets/simulator/spec/methods/crm.documentgenerator.document.enablepublicurl.json b/_assets/simulator/spec/methods/crm.documentgenerator.document.enablepublicurl.json index 37d87ff6c..f7d47ce9e 100644 --- a/_assets/simulator/spec/methods/crm.documentgenerator.document.enablepublicurl.json +++ b/_assets/simulator/spec/methods/crm.documentgenerator.document.enablepublicurl.json @@ -59,5 +59,9 @@ } ], "page": "/api-reference/crm/document-generator/documents/crm-document-generator-document-enable-public-url.html", - "executable": false + "executable": false, + "requestExample": { + "id": 61, + "status": 1 + } } diff --git a/_assets/simulator/spec/methods/crm.documentgenerator.document.get.json b/_assets/simulator/spec/methods/crm.documentgenerator.document.get.json index a1e1eeb80..ad9747ce1 100644 --- a/_assets/simulator/spec/methods/crm.documentgenerator.document.get.json +++ b/_assets/simulator/spec/methods/crm.documentgenerator.document.get.json @@ -119,5 +119,8 @@ "updateTime", "updatedBy", "values" - ] + ], + "requestExample": { + "id": 61 + } } diff --git a/_assets/simulator/spec/methods/crm.documentgenerator.document.getfields.json b/_assets/simulator/spec/methods/crm.documentgenerator.document.getfields.json index 1fa480417..da7396e5f 100644 --- a/_assets/simulator/spec/methods/crm.documentgenerator.document.getfields.json +++ b/_assets/simulator/spec/methods/crm.documentgenerator.document.getfields.json @@ -167,5 +167,11 @@ } ], "page": "/api-reference/crm/document-generator/documents/crm-document-generator-document-get-fields.html", - "executable": false + "executable": false, + "requestExample": { + "id": 101, + "values": { + "DocumentNumber": "2026-001" + } + } } diff --git a/_assets/simulator/spec/methods/crm.documentgenerator.document.list.json b/_assets/simulator/spec/methods/crm.documentgenerator.document.list.json index ffbc33cde..321ab0581 100644 --- a/_assets/simulator/spec/methods/crm.documentgenerator.document.list.json +++ b/_assets/simulator/spec/methods/crm.documentgenerator.document.list.json @@ -176,5 +176,22 @@ "updateTime", "updatedBy", "values" - ] + ], + "requestExample": { + "select": [ + "id", + "title", + "number", + "entityId", + "createTime" + ], + "order": { + "id": "desc" + }, + "filter": { + "entityTypeId": 2, + "entityId": 101 + }, + "start": 0 + } } diff --git a/_assets/simulator/spec/methods/crm.documentgenerator.document.update.json b/_assets/simulator/spec/methods/crm.documentgenerator.document.update.json index 2744c62ad..ce3fdbef5 100644 --- a/_assets/simulator/spec/methods/crm.documentgenerator.document.update.json +++ b/_assets/simulator/spec/methods/crm.documentgenerator.document.update.json @@ -106,5 +106,12 @@ } ], "page": "/api-reference/crm/document-generator/documents/crm-document-generator-document-update.html", - "executable": false + "executable": false, + "requestExample": { + "id": 61, + "values": { + "DocumentNumber": "2026-002" + }, + "stampsEnabled": 1 + } } diff --git a/_assets/simulator/spec/methods/crm.documentgenerator.document.upload.json b/_assets/simulator/spec/methods/crm.documentgenerator.document.upload.json index d3971dba5..bdb6d13af 100644 --- a/_assets/simulator/spec/methods/crm.documentgenerator.document.upload.json +++ b/_assets/simulator/spec/methods/crm.documentgenerator.document.upload.json @@ -151,5 +151,17 @@ } ], "page": "/api-reference/crm/document-generator/documents/crm-document-generator-document-upload.html", - "executable": false + "executable": false, + "requestExample": { + "fields": { + "entityTypeId": 2, + "entityId": 101, + "fileContent": "**base64_docx_content**", + "region": "ru", + "title": "Демонстрационная реализация товара", + "number": "2026-001", + "pdfContent": "**base64_pdf_content**", + "imageContent": "**base64_image_content**" + } + } } diff --git a/_assets/simulator/spec/methods/crm.documentgenerator.numerator.add.json b/_assets/simulator/spec/methods/crm.documentgenerator.numerator.add.json index ffda68654..6586d3745 100644 --- a/_assets/simulator/spec/methods/crm.documentgenerator.numerator.add.json +++ b/_assets/simulator/spec/methods/crm.documentgenerator.numerator.add.json @@ -100,5 +100,22 @@ } ], "page": "/api-reference/crm/document-generator/numerator/crm-document-generator-numerator-add.html", - "executable": false + "executable": false, + "requestExample": { + "fields": { + "name": "Нумератор из REST", + "template": "{NUMBER}", + "settings": { + "Bitrix_Main_Numerator_Generator_SequentNumberGenerator": { + "start": 1, + "step": 1, + "length": 6, + "padString": "0", + "periodicBy": "", + "timezone": "", + "isDirectNumeration": false + } + } + } + } } diff --git a/_assets/simulator/spec/methods/crm.documentgenerator.numerator.delete.json b/_assets/simulator/spec/methods/crm.documentgenerator.numerator.delete.json index 59a9cbfa4..1c6e8cc76 100644 --- a/_assets/simulator/spec/methods/crm.documentgenerator.numerator.delete.json +++ b/_assets/simulator/spec/methods/crm.documentgenerator.numerator.delete.json @@ -50,5 +50,8 @@ } ], "page": "/api-reference/crm/document-generator/numerator/crm-document-generator-numerator-delete.html", - "executable": false + "executable": false, + "requestExample": { + "id": 47 + } } diff --git a/_assets/simulator/spec/methods/crm.documentgenerator.numerator.get.json b/_assets/simulator/spec/methods/crm.documentgenerator.numerator.get.json index 853879fe1..1eb599c09 100644 --- a/_assets/simulator/spec/methods/crm.documentgenerator.numerator.get.json +++ b/_assets/simulator/spec/methods/crm.documentgenerator.numerator.get.json @@ -75,5 +75,8 @@ "name", "settings", "template" - ] + ], + "requestExample": { + "id": 45 + } } diff --git a/_assets/simulator/spec/methods/crm.documentgenerator.numerator.list.json b/_assets/simulator/spec/methods/crm.documentgenerator.numerator.list.json index 3927850dd..9c80e4810 100644 --- a/_assets/simulator/spec/methods/crm.documentgenerator.numerator.list.json +++ b/_assets/simulator/spec/methods/crm.documentgenerator.numerator.list.json @@ -11,7 +11,7 @@ "type": "integer", "base": "integer", "required": "unknown", - "description": "Смещение для постраничной навигации. Подробнее в статье Особенности списочных методов" + "description": "Смещение для постраничной навигации. Размер страницы — 50 записей. Для страницы с номером N вычислите значение по формуле: start = (N - 1) * 50, где N — номер нужной страницы" } ], "defs": {}, @@ -80,7 +80,7 @@ "type": "integer", "base": "integer", "required": "unknown", - "description": "Общее количество нумераторов" + "description": "Количество нумераторов на текущей странице. Поле не содержит общее количество записей во всей выборке" }, { "name": "time", @@ -97,5 +97,8 @@ "name", "settings", "template" - ] + ], + "requestExample": { + "start": 0 + } } diff --git a/_assets/simulator/spec/methods/crm.documentgenerator.numerator.update.json b/_assets/simulator/spec/methods/crm.documentgenerator.numerator.update.json index a967dd679..0b159cfd7 100644 --- a/_assets/simulator/spec/methods/crm.documentgenerator.numerator.update.json +++ b/_assets/simulator/spec/methods/crm.documentgenerator.numerator.update.json @@ -105,5 +105,23 @@ } ], "page": "/api-reference/crm/document-generator/numerator/crm-document-generator-numerator-update.html", - "executable": false + "executable": false, + "requestExample": { + "id": 45, + "fields": { + "name": "Нумератор из REST (обновлен)", + "template": "INV-{NUMBER}", + "settings": { + "Bitrix_Main_Numerator_Generator_SequentNumberGenerator": { + "start": 100, + "step": 1, + "length": 6, + "padString": "0", + "periodicBy": "", + "timezone": "", + "isDirectNumeration": false + } + } + } + } } diff --git a/_assets/simulator/spec/methods/crm.documentgenerator.template.add.json b/_assets/simulator/spec/methods/crm.documentgenerator.template.add.json index 1f4362e4e..b6528f9a5 100644 --- a/_assets/simulator/spec/methods/crm.documentgenerator.template.add.json +++ b/_assets/simulator/spec/methods/crm.documentgenerator.template.add.json @@ -149,5 +149,26 @@ } ], "page": "/api-reference/crm/document-generator/templates/crm-document-generator-template-add.html", - "executable": false + "executable": false, + "requestExample": { + "fields": { + "name": "Шаблон КП из REST", + "file": [ + "template.docx", + "**base64_encoded_content**" + ], + "numeratorId": 49, + "region": "ru", + "entityTypeId": [ + "2", + "2_category_0" + ], + "users": [ + "UA" + ], + "active": "Y", + "withStamps": "N", + "sort": 500 + } + } } diff --git a/_assets/simulator/spec/methods/crm.documentgenerator.template.delete.json b/_assets/simulator/spec/methods/crm.documentgenerator.template.delete.json index 0df50ae7a..f4a23bd1d 100644 --- a/_assets/simulator/spec/methods/crm.documentgenerator.template.delete.json +++ b/_assets/simulator/spec/methods/crm.documentgenerator.template.delete.json @@ -50,5 +50,8 @@ } ], "page": "/api-reference/crm/document-generator/templates/crm-document-generator-template-delete.html", - "executable": false + "executable": false, + "requestExample": { + "id": 41 + } } diff --git a/_assets/simulator/spec/methods/crm.documentgenerator.template.get.json b/_assets/simulator/spec/methods/crm.documentgenerator.template.get.json index 398332b8d..25446dc06 100644 --- a/_assets/simulator/spec/methods/crm.documentgenerator.template.get.json +++ b/_assets/simulator/spec/methods/crm.documentgenerator.template.get.json @@ -92,5 +92,8 @@ "updateTime", "users", "withStamps" - ] + ], + "requestExample": { + "id": 41 + } } diff --git a/_assets/simulator/spec/methods/crm.documentgenerator.template.getfields.json b/_assets/simulator/spec/methods/crm.documentgenerator.template.getfields.json index 643215286..e8c14e144 100644 --- a/_assets/simulator/spec/methods/crm.documentgenerator.template.getfields.json +++ b/_assets/simulator/spec/methods/crm.documentgenerator.template.getfields.json @@ -335,5 +335,13 @@ } ], "page": "/api-reference/crm/document-generator/templates/crm-document-generator-template-get-fields.html", - "executable": false + "executable": false, + "requestExample": { + "id": 1, + "entityTypeId": 2, + "entityId": 123, + "values": { + "DocumentNumber": "2026-001" + } + } } diff --git a/_assets/simulator/spec/methods/crm.documentgenerator.template.list.json b/_assets/simulator/spec/methods/crm.documentgenerator.template.list.json index 1421673d7..660b53a64 100644 --- a/_assets/simulator/spec/methods/crm.documentgenerator.template.list.json +++ b/_assets/simulator/spec/methods/crm.documentgenerator.template.list.json @@ -135,5 +135,22 @@ "sort", "users", "withStamps" - ] + ], + "requestExample": { + "select": [ + "id", + "name", + "region", + "entityTypeId", + "users" + ], + "order": { + "id": "desc" + }, + "filter": { + "region": "ru", + "active": "Y" + }, + "start": 0 + } } diff --git a/_assets/simulator/spec/methods/crm.documentgenerator.template.update.json b/_assets/simulator/spec/methods/crm.documentgenerator.template.update.json index 790429da6..dfdda1dc0 100644 --- a/_assets/simulator/spec/methods/crm.documentgenerator.template.update.json +++ b/_assets/simulator/spec/methods/crm.documentgenerator.template.update.json @@ -156,5 +156,26 @@ } ], "page": "/api-reference/crm/document-generator/templates/crm-document-generator-template-update.html", - "executable": false + "executable": false, + "requestExample": { + "id": 41, + "fields": { + "name": "Шаблон из файла (обновлен)", + "file": [ + "template-updated.docx", + "**base64_encoded_content**" + ], + "numeratorId": 49, + "region": "ru", + "entityTypeId": [ + "2" + ], + "users": [ + "UA" + ], + "active": "Y", + "withStamps": "N", + "sort": 500 + } + } } diff --git a/_assets/simulator/spec/methods/crm.duplicate.findbycomm.json b/_assets/simulator/spec/methods/crm.duplicate.findbycomm.json index 72f7dc66a..316d3b4e9 100644 --- a/_assets/simulator/spec/methods/crm.duplicate.findbycomm.json +++ b/_assets/simulator/spec/methods/crm.duplicate.findbycomm.json @@ -111,5 +111,13 @@ } ], "page": "/api-reference/crm/duplicates/crm-duplicate-find-by-comm.html", - "executable": false + "executable": false, + "requestExample": { + "entity_type": "CONTACT", + "type": "PHONE", + "values": [ + "8976543", + "11223355" + ] + } } diff --git a/_assets/simulator/spec/methods/crm.duplicate.volatileType.fields.json b/_assets/simulator/spec/methods/crm.duplicate.volatileType.fields.json index 38ec307c8..c7a43aa75 100644 --- a/_assets/simulator/spec/methods/crm.duplicate.volatileType.fields.json +++ b/_assets/simulator/spec/methods/crm.duplicate.volatileType.fields.json @@ -65,5 +65,8 @@ } ], "page": "/api-reference/crm/duplicates/volatile-type/crm-duplicate-volatile-type-fields.html", - "executable": false + "executable": false, + "requestExample": { + "entityTypeId": 1 + } } diff --git a/_assets/simulator/spec/methods/crm.duplicate.volatileType.list.json b/_assets/simulator/spec/methods/crm.duplicate.volatileType.list.json index 002226518..e67a04a72 100644 --- a/_assets/simulator/spec/methods/crm.duplicate.volatileType.list.json +++ b/_assets/simulator/spec/methods/crm.duplicate.volatileType.list.json @@ -100,5 +100,6 @@ "entityTypeId", "fieldCode", "id" - ] + ], + "requestExample": {} } diff --git a/_assets/simulator/spec/methods/crm.duplicate.volatileType.register.json b/_assets/simulator/spec/methods/crm.duplicate.volatileType.register.json index 5f41e54fd..223442bff 100644 --- a/_assets/simulator/spec/methods/crm.duplicate.volatileType.register.json +++ b/_assets/simulator/spec/methods/crm.duplicate.volatileType.register.json @@ -73,5 +73,9 @@ } ], "page": "/api-reference/crm/duplicates/volatile-type/crm-duplicate-volatile-type-register.html", - "executable": false + "executable": false, + "requestExample": { + "entityTypeId": 1, + "fieldCode": "TITLE" + } } diff --git a/_assets/simulator/spec/methods/crm.duplicate.volatileType.unregister.json b/_assets/simulator/spec/methods/crm.duplicate.volatileType.unregister.json index d280f9ac2..cfe3af3b2 100644 --- a/_assets/simulator/spec/methods/crm.duplicate.volatileType.unregister.json +++ b/_assets/simulator/spec/methods/crm.duplicate.volatileType.unregister.json @@ -50,5 +50,8 @@ } ], "page": "/api-reference/crm/duplicates/volatile-type/crm-duplicate-volatile-type-unregister.html", - "executable": false + "executable": false, + "requestExample": { + "id": 101 + } } diff --git a/_assets/simulator/spec/methods/crm.entity.mergeBatch.json b/_assets/simulator/spec/methods/crm.entity.mergeBatch.json index 2ccb2b1eb..1a7bb7374 100644 --- a/_assets/simulator/spec/methods/crm.entity.mergeBatch.json +++ b/_assets/simulator/spec/methods/crm.entity.mergeBatch.json @@ -132,5 +132,15 @@ } ], "page": "/api-reference/crm/duplicates/crm-entity-merge-batch.html", - "executable": false + "executable": false, + "requestExample": { + "params": { + "entityTypeId": 3, + "entityIds": [ + 100, + 101, + 102 + ] + } + } } diff --git a/_assets/simulator/spec/methods/crm.enum.activitydirection.json b/_assets/simulator/spec/methods/crm.enum.activitydirection.json index f0deee263..4515fe336 100644 --- a/_assets/simulator/spec/methods/crm.enum.activitydirection.json +++ b/_assets/simulator/spec/methods/crm.enum.activitydirection.json @@ -87,5 +87,6 @@ } ], "page": "/api-reference/crm/auxiliary/enum/outdated/crm-enum-activity-direction.html", - "executable": false + "executable": false, + "requestExample": {} } diff --git a/_assets/simulator/spec/methods/crm.enum.activitynotifytype.json b/_assets/simulator/spec/methods/crm.enum.activitynotifytype.json index d1d5d38c6..bfaf6649f 100644 --- a/_assets/simulator/spec/methods/crm.enum.activitynotifytype.json +++ b/_assets/simulator/spec/methods/crm.enum.activitynotifytype.json @@ -93,5 +93,6 @@ } ], "page": "/api-reference/crm/auxiliary/enum/outdated/crm-enum-activity-notify-type.html", - "executable": false + "executable": false, + "requestExample": {} } diff --git a/_assets/simulator/spec/methods/crm.enum.activitypriority.json b/_assets/simulator/spec/methods/crm.enum.activitypriority.json index 97ba7b364..e6edbdb01 100644 --- a/_assets/simulator/spec/methods/crm.enum.activitypriority.json +++ b/_assets/simulator/spec/methods/crm.enum.activitypriority.json @@ -93,5 +93,6 @@ } ], "page": "/api-reference/crm/auxiliary/enum/outdated/crm-enum-activity-priority.html", - "executable": false + "executable": false, + "requestExample": {} } diff --git a/_assets/simulator/spec/methods/crm.enum.activitystatus.json b/_assets/simulator/spec/methods/crm.enum.activitystatus.json index c98bd9d2b..6c33a355c 100644 --- a/_assets/simulator/spec/methods/crm.enum.activitystatus.json +++ b/_assets/simulator/spec/methods/crm.enum.activitystatus.json @@ -93,5 +93,6 @@ } ], "page": "/api-reference/crm/auxiliary/enum/outdated/crm-enum-activity-status.html", - "executable": false + "executable": false, + "requestExample": {} } diff --git a/_assets/simulator/spec/methods/crm.enum.activitytype.json b/_assets/simulator/spec/methods/crm.enum.activitytype.json index 6b6963c34..7b24cb429 100644 --- a/_assets/simulator/spec/methods/crm.enum.activitytype.json +++ b/_assets/simulator/spec/methods/crm.enum.activitytype.json @@ -111,5 +111,6 @@ } ], "page": "/api-reference/crm/auxiliary/enum/outdated/crm-enum-activity-type.html", - "executable": false + "executable": false, + "requestExample": {} } diff --git a/_assets/simulator/spec/methods/crm.enum.addresstype.json b/_assets/simulator/spec/methods/crm.enum.addresstype.json index b8450cf46..4641dad33 100644 --- a/_assets/simulator/spec/methods/crm.enum.addresstype.json +++ b/_assets/simulator/spec/methods/crm.enum.addresstype.json @@ -102,5 +102,6 @@ } ], "page": "/api-reference/crm/auxiliary/enum/crm-enum-address-type.html", - "executable": false + "executable": false, + "requestExample": {} } diff --git a/_assets/simulator/spec/methods/crm.enum.contenttype.json b/_assets/simulator/spec/methods/crm.enum.contenttype.json index 3237781ff..de0368888 100644 --- a/_assets/simulator/spec/methods/crm.enum.contenttype.json +++ b/_assets/simulator/spec/methods/crm.enum.contenttype.json @@ -93,5 +93,6 @@ } ], "page": "/api-reference/crm/auxiliary/enum/outdated/crm-enum-content-type.html", - "executable": false + "executable": false, + "requestExample": {} } diff --git a/_assets/simulator/spec/methods/crm.enum.fields.json b/_assets/simulator/spec/methods/crm.enum.fields.json index 30d5d9baf..b98e8d81e 100644 --- a/_assets/simulator/spec/methods/crm.enum.fields.json +++ b/_assets/simulator/spec/methods/crm.enum.fields.json @@ -102,5 +102,6 @@ } ], "page": "/api-reference/crm/auxiliary/enum/crm-enum-fields.html", - "executable": false + "executable": false, + "requestExample": {} } diff --git a/_assets/simulator/spec/methods/crm.enum.getorderownertypes.json b/_assets/simulator/spec/methods/crm.enum.getorderownertypes.json index f012cacf2..eb39ef619 100644 --- a/_assets/simulator/spec/methods/crm.enum.getorderownertypes.json +++ b/_assets/simulator/spec/methods/crm.enum.getorderownertypes.json @@ -72,5 +72,6 @@ } ], "page": "/api-reference/crm/auxiliary/enum/crm-enum-get-order-owner-types.html", - "executable": false + "executable": false, + "requestExample": {} } diff --git a/_assets/simulator/spec/methods/crm.enum.ownertype.json b/_assets/simulator/spec/methods/crm.enum.ownertype.json index 4d14deedd..1c83e9578 100644 --- a/_assets/simulator/spec/methods/crm.enum.ownertype.json +++ b/_assets/simulator/spec/methods/crm.enum.ownertype.json @@ -138,5 +138,6 @@ } ], "page": "/api-reference/crm/auxiliary/enum/crm-enum-owner-type.html", - "executable": false + "executable": false, + "requestExample": {} } diff --git a/_assets/simulator/spec/methods/crm.enum.settings.mode.json b/_assets/simulator/spec/methods/crm.enum.settings.mode.json index 251df2000..eacfdcddc 100644 --- a/_assets/simulator/spec/methods/crm.enum.settings.mode.json +++ b/_assets/simulator/spec/methods/crm.enum.settings.mode.json @@ -78,5 +78,6 @@ } ], "page": "/api-reference/crm/auxiliary/enum/crm-enum-settings-mode.html", - "executable": false + "executable": false, + "requestExample": {} } diff --git a/_assets/simulator/spec/methods/crm.invoice.userfield.list.json b/_assets/simulator/spec/methods/crm.invoice.userfield.list.json index 7b3a915fd..74941cecf 100644 --- a/_assets/simulator/spec/methods/crm.invoice.userfield.list.json +++ b/_assets/simulator/spec/methods/crm.invoice.userfield.list.json @@ -31,5 +31,13 @@ "successor": null }, "page": "/api-reference/crm/outdated/invoice/crm-invoice-user-field-list.html", - "executable": false + "executable": false, + "requestExample": { + "order": { + "SORT": "ASC" + }, + "filter": { + "MANDATORY": "N" + } + } } diff --git a/_assets/simulator/spec/methods/crm.invoice.userfield.update.json b/_assets/simulator/spec/methods/crm.invoice.userfield.update.json index db74500ec..6350a941b 100644 --- a/_assets/simulator/spec/methods/crm.invoice.userfield.update.json +++ b/_assets/simulator/spec/methods/crm.invoice.userfield.update.json @@ -38,5 +38,12 @@ "successor": null }, "page": "/api-reference/crm/outdated/invoice/crm-invoice-user-field-update.html", - "executable": false + "executable": false, + "requestExample": { + "id": "**put_id_here**", + "fields": { + "EDIT_FORM_LABEL": "**put_label_here**", + "LIST_COLUMN_LABEL": "**put_label_here**" + } + } } diff --git a/_assets/simulator/spec/methods/crm.item.batchImport.json b/_assets/simulator/spec/methods/crm.item.batchImport.json index 6cdae401a..efd06caf7 100644 --- a/_assets/simulator/spec/methods/crm.item.batchImport.json +++ b/_assets/simulator/spec/methods/crm.item.batchImport.json @@ -110,5 +110,82 @@ } ], "page": "/api-reference/crm/universal/import/crm-item-batch-import.html", - "executable": false + "executable": false, + "requestExample": { + "entityTypeId": 2, + "data": [ + { + "title": "Новая сделка (специально для примера REST методов)", + "typeId": "SERVICE", + "categoryId": 9, + "stageId": "C9:UC_KN8KFI", + "isReccurring": "Y", + "probability": 50, + "currencyId": "RUB", + "isManualOpportunity": "Y", + "opportunity": 999.99, + "taxValue": 99.9, + "companyId": 5, + "contactId": 4, + "contactIds": [ + 4, + 5 + ], + "quoteId": 7, + "begindate": "formatDate(monthAgo)", + "closedate": "formatDate(twelveDaysInAdvance)", + "opened": "N", + "comments": "commentsExample", + "assignedById": 6, + "sourceId": "WEB", + "sourceDescription": "Тут должно быть дополнительное описание об источнике", + "leadId": 102, + "additionalInfo": "Тут должна быть дополнительная информация", + "observers": [ + 2, + 3 + ], + "utmSource": "google", + "utmMedium": "CPC", + "ufCrm_1721244707107": 1111.1, + "parentId1220": 2 + }, + { + "title": "Новая сделка (специально для примера REST методов)", + "typeId": "SERVICE", + "categoryId": 4, + "stageId": "C9:UC_KN8KFI", + "isReccurring": "Y", + "probability": 50, + "currencyId": "RUB", + "isManualOpportunity": "Y", + "opportunity": 999.99, + "taxValue": 99.9, + "companyId": 5, + "contactId": 4, + "contactIds": [ + 4, + 5 + ], + "quoteId": 7, + "begindate": "formatDate(monthAgo)", + "closedate": "formatDate(twelveDaysInAdvance)", + "opened": "N", + "comments": "commentsExample", + "assignedById": 6, + "sourceId": "WEB", + "sourceDescription": "Тут должно быть дополнительное описание об источнике", + "leadId": 102, + "additionalInfo": "Тут должна быть дополнительная информация", + "observers": [ + 2, + 3 + ], + "utmSource": "google", + "utmMedium": "CPC", + "ufCrm_1721244707107": 1111.1, + "parentId1220": 2 + } + ] + } } diff --git a/_assets/simulator/spec/methods/crm.item.delete.json b/_assets/simulator/spec/methods/crm.item.delete.json index c752f9e53..b2d628c06 100644 --- a/_assets/simulator/spec/methods/crm.item.delete.json +++ b/_assets/simulator/spec/methods/crm.item.delete.json @@ -40,5 +40,9 @@ } }, "page": "/api-reference/crm/universal/crm-item-delete.html", - "executable": false + "executable": false, + "requestExample": { + "entityTypeId": 1268, + "id": 1 + } } diff --git a/_assets/simulator/spec/methods/crm.item.delivery.get.json b/_assets/simulator/spec/methods/crm.item.delivery.get.json index 205bc9039..35f276b34 100644 --- a/_assets/simulator/spec/methods/crm.item.delivery.get.json +++ b/_assets/simulator/spec/methods/crm.item.delivery.get.json @@ -4,14 +4,14 @@ "scope": "crm", "kind": "read", "title": "Получить информацию о доставке по id crm.item.delivery.get", - "permissions": "требуется право на чтение заказа доставки", + "permissions": "пользователь с правом на чтение заказа, к которому относится доставка", "params": [ { "name": "id", "type": "sale_order_shipment.id", "base": "any", "required": true, - "description": "Идентификатор доставки" + "description": "Идентификатор доставки. Получить идентификаторы доставок объекта CRM можно методом crm.item.delivery.list" } ], "defs": {}, @@ -20,13 +20,33 @@ "source": { "file": "api-reference/crm/universal/delivery/crm-item-delivery-get.md" }, + "resultExample": { + "result": { + "id": 4077, + "accountNumber": "3657/2", + "deducted": "N", + "dateDeducted": null, + "deliveryId": 228, + "priceDelivery": 79.99, + "currency": "RUB", + "deliveryName": "Uber Taxi (Cargo)" + }, + "time": { + "start": 1716369295.614557, + "finish": 1716369296.143089, + "duration": 0.5285320281982422, + "processing": 0.2371680736541748, + "date_start": "2024-05-22T12:14:55+03:00", + "date_finish": "2024-05-22T12:14:56+03:00" + } + }, "returns": [ { "name": "result", - "type": "sale_order_shipment_crm_simple", - "base": "any", + "type": "object", + "base": "object", "required": false, - "description": "Объект, содержащий краткую информацию о доставке" + "description": "Объект с краткой информацией о доставке (подробное описание)" }, { "name": "time", @@ -37,5 +57,18 @@ } ], "page": "/api-reference/crm/universal/delivery/crm-item-delivery-get.html", - "executable": false + "executable": false, + "entityFields": [ + "accountNumber", + "currency", + "dateDeducted", + "deducted", + "deliveryId", + "deliveryName", + "id", + "priceDelivery" + ], + "requestExample": { + "id": 4077 + } } diff --git a/_assets/simulator/spec/methods/crm.item.delivery.list.json b/_assets/simulator/spec/methods/crm.item.delivery.list.json index 69ecb6e3d..4bbb0b4b3 100644 --- a/_assets/simulator/spec/methods/crm.item.delivery.list.json +++ b/_assets/simulator/spec/methods/crm.item.delivery.list.json @@ -4,58 +4,121 @@ "scope": "crm", "kind": "read", "title": "Получить список доставок объекта CRM crm.item.delivery.list", - "permissions": "требуется право на чтение объекта crm, из которого выбираются доставки", + "permissions": "пользователь с правом на чтение объекта CRM, из которого выбираются доставки", "params": [ { "name": "entityId", "type": "integer", "base": "integer", "required": true, - "description": "Идентификатор объекта crm" + "description": "Идентификатор объекта CRM, доставки которого нужно получить. Например, идентификатор сделки" }, { "name": "entityTypeId", "type": "integer", "base": "integer", "required": true, - "description": "Идентификатор типа объекта crm" + "description": "Идентификатор типа объекта CRM. Доставки есть только у сделок и счетов: для них entityTypeId равен 2 и 31 соответственно" }, { "name": "filter", "type": "object", "base": "object", "required": false, - "description": "Дополнительный фильтр для случаев, когда нужно получить не все доставки объекта crm, а по какому-то более специфичному фильтру. Формат параметра filter соответствует описанному в методе sale.shipment.list", - "dynamic": { - "allowed": true, - "note": "Состав полей не описан подтаблицей на этой странице" - } + "description": "Фильтр, который сужает выборку доставок объекта CRM (подробное описание)", + "ref": "#/defs/filterFields" }, { "name": "order", "type": "object", "base": "object", "required": false, - "description": "Формат параметра order соответствует описанному в методе sale.shipment.list", + "description": "Порядок сортировки в формате {\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}. Допустимые значения order_N: - asc — по возрастанию - desc — по убыванию Сортировать можно по полям объекта saleordershipment. По умолчанию список сортируется по id в порядке возрастания", + "values": [ + { + "value": "asc", + "title": "по возрастанию" + }, + { + "value": "desc", + "title": "по убыванию Сортировать можно по полям объекта saleordershipment" + } + ], "dynamic": { "allowed": true, "note": "Состав полей не описан подтаблицей на этой странице" } } ], - "defs": {}, + "defs": { + "filterFields": { + "dynamic": { + "allowed": false, + "ufAllowed": true, + "note": "Пользовательские поля UF_* в схеме не описаны" + }, + "fields": [ + { + "name": "result", + "type": "array", + "base": "array", + "required": false, + "description": "Массив объектов с краткой информацией о выбранных доставках (подробное описание)" + }, + { + "name": "time", + "type": "time", + "base": "object", + "required": false, + "description": "Информация о времени выполнения запроса" + } + ] + } + }, "requiredConvention": true, "confidence": "parsed", "source": { "file": "api-reference/crm/universal/delivery/crm-item-delivery-list.md" }, + "resultExample": { + "result": [ + { + "id": 4077, + "accountNumber": "3657/2", + "deducted": "N", + "dateDeducted": null, + "deliveryId": 228, + "priceDelivery": 79.99, + "currency": "RUB", + "deliveryName": "Uber Taxi (Cargo)" + }, + { + "id": 4078, + "accountNumber": "3657/3", + "deducted": "N", + "dateDeducted": null, + "deliveryId": 228, + "priceDelivery": 79.99, + "currency": "RUB", + "deliveryName": "Uber Taxi (Cargo)" + } + ], + "time": { + "start": 1716369036.246855, + "finish": 1716369036.734466, + "duration": 0.4876110553741455, + "processing": 0.18442106246948242, + "date_start": "2024-05-22T12:10:36+03:00", + "date_finish": "2024-05-22T12:10:36+03:00" + } + }, "returns": [ { "name": "result", - "type": "sale_order_shipment_crm_simple", - "base": "any", + "type": "array", + "base": "array", "required": false, - "description": "Массив объектов, содержащий краткую информацию о выбранных доставках" + "description": "Массив объектов с краткой информацией о выбранных доставках (подробное описание)" }, { "name": "time", @@ -66,5 +129,15 @@ } ], "page": "/api-reference/crm/universal/delivery/crm-item-delivery-list.html", - "executable": false + "executable": false, + "entityFields": [ + "accountNumber", + "currency", + "dateDeducted", + "deducted", + "deliveryId", + "deliveryName", + "id", + "priceDelivery" + ] } diff --git a/_assets/simulator/spec/methods/crm.item.details.configuration.forceCommonScopeForAll.json b/_assets/simulator/spec/methods/crm.item.details.configuration.forceCommonScopeForAll.json index 50de63c76..f192a341a 100644 --- a/_assets/simulator/spec/methods/crm.item.details.configuration.forceCommonScopeForAll.json +++ b/_assets/simulator/spec/methods/crm.item.details.configuration.forceCommonScopeForAll.json @@ -60,5 +60,11 @@ } ], "page": "/api-reference/crm/universal/item-details-configuration/crm-item-details-configuration-forceCommonScopeForAll.html", - "executable": false + "executable": false, + "requestExample": { + "entityTypeId": 2, + "extras": { + "dealCategoryId": 9 + } + } } diff --git a/_assets/simulator/spec/methods/crm.item.details.configuration.get.json b/_assets/simulator/spec/methods/crm.item.details.configuration.get.json index 485431bfc..197f60733 100644 --- a/_assets/simulator/spec/methods/crm.item.details.configuration.get.json +++ b/_assets/simulator/spec/methods/crm.item.details.configuration.get.json @@ -180,5 +180,13 @@ "name", "title", "type" - ] + ], + "requestExample": { + "entityTypeId": 2, + "userId": 1, + "scope": "C", + "extras": { + "dealCategoryId": 9 + } + } } diff --git a/_assets/simulator/spec/methods/crm.item.details.configuration.reset.json b/_assets/simulator/spec/methods/crm.item.details.configuration.reset.json index fadf7905c..7c1a57e41 100644 --- a/_assets/simulator/spec/methods/crm.item.details.configuration.reset.json +++ b/_assets/simulator/spec/methods/crm.item.details.configuration.reset.json @@ -74,5 +74,13 @@ } ], "page": "/api-reference/crm/universal/item-details-configuration/crm-item-details-configuration-reset.html", - "executable": false + "executable": false, + "requestExample": { + "entityTypeId": 2, + "userId": 1, + "scope": "C", + "extras": { + "dealCategoryId": 9 + } + } } diff --git a/_assets/simulator/spec/methods/crm.item.details.configuration.set.json b/_assets/simulator/spec/methods/crm.item.details.configuration.set.json index 0e5a3528a..3f01c881c 100644 --- a/_assets/simulator/spec/methods/crm.item.details.configuration.set.json +++ b/_assets/simulator/spec/methods/crm.item.details.configuration.set.json @@ -85,5 +85,78 @@ } ], "page": "/api-reference/crm/universal/item-details-configuration/crm-item-details-configuration-set.html", - "executable": false + "executable": false, + "requestExample": { + "entityTypeId": 3, + "userId": 1, + "data": [ + { + "name": "section_1", + "title": "Личные данные", + "type": "section", + "elements": [ + { + "name": "NAME", + "optionFlags": 1 + }, + { + "name": "LAST_NAME", + "optionFlags": 1 + }, + { + "name": "SECOND_NAME" + }, + { + "name": "BIRTHDATE" + }, + { + "name": "PHONE", + "optionFlags": 1, + "options": { + "defaultCountry": "GB" + } + }, + { + "name": "ADDRESS", + "optionFlags": 1, + "options": { + "defaultAddressType": 4 + } + } + ] + }, + { + "name": "section_2", + "title": "Основная информация", + "type": "section", + "elements": [ + { + "name": "TYPE_ID" + }, + { + "name": "SOURCE_ID" + }, + { + "name": "POST" + } + ] + }, + { + "name": "section_3", + "title": "Дополнительная информация", + "type": "section", + "elements": [ + { + "name": "PHOTO" + }, + { + "name": "COMMENTS" + }, + { + "name": "UF_CRM_1720697698689" + } + ] + } + ] + } } diff --git a/_assets/simulator/spec/methods/crm.item.fields.json b/_assets/simulator/spec/methods/crm.item.fields.json index 1b38c4258..80a8b4573 100644 --- a/_assets/simulator/spec/methods/crm.item.fields.json +++ b/_assets/simulator/spec/methods/crm.item.fields.json @@ -437,5 +437,9 @@ } ], "page": "/api-reference/crm/universal/crm-item-fields.html", - "executable": false + "executable": false, + "requestExample": { + "entityTypeId": 1268, + "useOriginalUfNames": "N" + } } diff --git a/_assets/simulator/spec/methods/crm.item.get.json b/_assets/simulator/spec/methods/crm.item.get.json index 335781e00..eda712b8b 100644 --- a/_assets/simulator/spec/methods/crm.item.get.json +++ b/_assets/simulator/spec/methods/crm.item.get.json @@ -254,5 +254,10 @@ "utmSource", "utmTerm", "webformId" - ] + ], + "requestExample": { + "entityTypeId": 1, + "id": 250, + "useOriginalUfNames": "N" + } } diff --git a/_assets/simulator/spec/methods/crm.item.list.json b/_assets/simulator/spec/methods/crm.item.list.json index 7bf47160b..a30cbfb40 100644 --- a/_assets/simulator/spec/methods/crm.item.list.json +++ b/_assets/simulator/spec/methods/crm.item.list.json @@ -211,5 +211,49 @@ "utmSource", "utmTerm", "webformId" - ] + ], + "requestExample": { + "entityTypeId": 1, + "select": [ + "id", + "title", + "lastName", + "name", + "stageId", + "sourceId", + "assignedById", + "opportunity", + "isManualOpportunity" + ], + "filter": { + "0": { + "0": { + "!=name": "" + }, + "1": { + "!=lastName": "" + }, + "logic": "OR" + }, + "@stageId": [ + "NEW", + "IN_PROCESS" + ], + "@sourceId": [ + "WEB", + "ADVERTISING" + ], + "@assignedById": [ + 1, + 6 + ], + ">=opportunity": 5000, + "<=opportunity": 20000, + "isManualOpportunity": "Y" + }, + "order": { + "lastName": "ASC", + "name": "ASC" + } + } } diff --git a/_assets/simulator/spec/methods/crm.item.payment.add.json b/_assets/simulator/spec/methods/crm.item.payment.add.json index 3dc6cdbf4..a76572961 100644 --- a/_assets/simulator/spec/methods/crm.item.payment.add.json +++ b/_assets/simulator/spec/methods/crm.item.payment.add.json @@ -44,5 +44,9 @@ } ], "page": "/api-reference/crm/universal/payment/crm-item-payment-add.html", - "executable": false + "executable": false, + "requestExample": { + "entityId": 13123, + "entityTypeId": 2 + } } diff --git a/_assets/simulator/spec/methods/crm.item.payment.delete.json b/_assets/simulator/spec/methods/crm.item.payment.delete.json index bed7f19c0..317b6a1bf 100644 --- a/_assets/simulator/spec/methods/crm.item.payment.delete.json +++ b/_assets/simulator/spec/methods/crm.item.payment.delete.json @@ -37,5 +37,8 @@ } ], "page": "/api-reference/crm/universal/payment/crm-item-payment-delete.html", - "executable": false + "executable": false, + "requestExample": { + "id": 1035 + } } diff --git a/_assets/simulator/spec/methods/crm.item.payment.delivery.add.json b/_assets/simulator/spec/methods/crm.item.payment.delivery.add.json index df7d90367..6f7929f5a 100644 --- a/_assets/simulator/spec/methods/crm.item.payment.delivery.add.json +++ b/_assets/simulator/spec/methods/crm.item.payment.delivery.add.json @@ -44,5 +44,9 @@ } ], "page": "/api-reference/crm/universal/payment/delivery-in-payment/crm-item-payment-delivery-add.html", - "executable": false + "executable": false, + "requestExample": { + "paymentId": 1039, + "deliveryId": 4072 + } } diff --git a/_assets/simulator/spec/methods/crm.item.payment.delivery.delete.json b/_assets/simulator/spec/methods/crm.item.payment.delivery.delete.json index 044633039..b78a80a53 100644 --- a/_assets/simulator/spec/methods/crm.item.payment.delivery.delete.json +++ b/_assets/simulator/spec/methods/crm.item.payment.delivery.delete.json @@ -37,5 +37,8 @@ } ], "page": "/api-reference/crm/universal/payment/delivery-in-payment/crm-item-payment-delivery-delete.html", - "executable": false + "executable": false, + "requestExample": { + "id": 1199 + } } diff --git a/_assets/simulator/spec/methods/crm.item.payment.delivery.list.json b/_assets/simulator/spec/methods/crm.item.payment.delivery.list.json index de4043e9b..149eb041e 100644 --- a/_assets/simulator/spec/methods/crm.item.payment.delivery.list.json +++ b/_assets/simulator/spec/methods/crm.item.payment.delivery.list.json @@ -69,5 +69,14 @@ } ], "page": "/api-reference/crm/universal/payment/delivery-in-payment/crm-item-payment-delivery-list.html", - "executable": false + "executable": false, + "requestExample": { + "paymentId": 1040, + "filter": { + "@id": [ + 1201 + ], + ">=quantity": 1 + } + } } diff --git a/_assets/simulator/spec/methods/crm.item.payment.delivery.setDelivery.json b/_assets/simulator/spec/methods/crm.item.payment.delivery.setDelivery.json index 58035f1a5..bab7a68d0 100644 --- a/_assets/simulator/spec/methods/crm.item.payment.delivery.setDelivery.json +++ b/_assets/simulator/spec/methods/crm.item.payment.delivery.setDelivery.json @@ -44,5 +44,9 @@ } ], "page": "/api-reference/crm/universal/payment/delivery-in-payment/crm-item-payment-delivery-set-delivery.html", - "executable": false + "executable": false, + "requestExample": { + "id": 1201, + "deliveryId": 4073 + } } diff --git a/_assets/simulator/spec/methods/crm.item.payment.get.json b/_assets/simulator/spec/methods/crm.item.payment.get.json index 79847951f..7e3a5347a 100644 --- a/_assets/simulator/spec/methods/crm.item.payment.get.json +++ b/_assets/simulator/spec/methods/crm.item.payment.get.json @@ -37,5 +37,8 @@ } ], "page": "/api-reference/crm/universal/payment/crm-item-payment-get.html", - "executable": false + "executable": false, + "requestExample": { + "id": 1036 + } } diff --git a/_assets/simulator/spec/methods/crm.item.payment.list.json b/_assets/simulator/spec/methods/crm.item.payment.list.json index b998f3e62..26eb8a967 100644 --- a/_assets/simulator/spec/methods/crm.item.payment.list.json +++ b/_assets/simulator/spec/methods/crm.item.payment.list.json @@ -66,5 +66,15 @@ } ], "page": "/api-reference/crm/universal/payment/crm-item-payment-list.html", - "executable": false + "executable": false, + "requestExample": { + "entityId": 13123, + "entityTypeId": 2, + "filter": { + "@id": [ + 1036, + 1037 + ] + } + } } diff --git a/_assets/simulator/spec/methods/crm.item.payment.pay.json b/_assets/simulator/spec/methods/crm.item.payment.pay.json index 87eb7f541..5b0827000 100644 --- a/_assets/simulator/spec/methods/crm.item.payment.pay.json +++ b/_assets/simulator/spec/methods/crm.item.payment.pay.json @@ -37,5 +37,8 @@ } ], "page": "/api-reference/crm/universal/payment/crm-item-payment-pay.html", - "executable": false + "executable": false, + "requestExample": { + "id": 1038 + } } diff --git a/_assets/simulator/spec/methods/crm.item.payment.product.add.json b/_assets/simulator/spec/methods/crm.item.payment.product.add.json index 679e36748..a283610c1 100644 --- a/_assets/simulator/spec/methods/crm.item.payment.product.add.json +++ b/_assets/simulator/spec/methods/crm.item.payment.product.add.json @@ -4,7 +4,7 @@ "scope": "crm", "kind": "write", "title": "Добавить товарную позицию в оплату crm.item.payment.product.add", - "permissions": "требуется право на изменение заказа, в оплату которого добавляется товарная позиция", + "permissions": "пользователь с правом «Изменение» для объекта CRM, к которому относится оплата", "params": [ { "name": "paymentId", @@ -18,14 +18,14 @@ "type": "integer", "base": "integer", "required": true, - "description": "Идентификатор товарной позиции в объекте CRM. Можно получить с помощью crm.item.productrow.list" + "description": "Идентификатор товарной позиции в объекте CRM, к которому относится оплата. Можно получить с помощью метода crm.item.productrow.list" }, { "name": "quantity", - "type": "double", - "base": "number", + "type": "integer", + "base": "integer", "required": true, - "description": "Количество товара" + "description": "Количество товара. Значение должно быть больше нуля и не превышать остаток, который еще не распределен по оплатам заказа" } ], "defs": {}, @@ -51,5 +51,10 @@ } ], "page": "/api-reference/crm/universal/payment/products-in-payment/crm-item-payment-product-add.html", - "executable": false + "executable": false, + "requestExample": { + "paymentId": 1039, + "rowId": 17587, + "quantity": 2 + } } diff --git a/_assets/simulator/spec/methods/crm.item.payment.product.delete.json b/_assets/simulator/spec/methods/crm.item.payment.product.delete.json index c17e9e656..bc6703445 100644 --- a/_assets/simulator/spec/methods/crm.item.payment.product.delete.json +++ b/_assets/simulator/spec/methods/crm.item.payment.product.delete.json @@ -4,14 +4,14 @@ "scope": "crm", "kind": "write", "title": "Удалить товарную позицию из оплаты crm.item.payment.product.delete", - "permissions": "требуется право на изменение заказа, из которого удаляется товарная позиция", + "permissions": "пользователь с правом «Изменение» для объекта CRM, к которому относится оплата", "params": [ { "name": "id", "type": "integer", "base": "integer", "required": true, - "description": "Идентификатор товарной позиции в оплате. Можно получить с помощью crm.item.payment.product.list" + "description": "Идентификатор товарной позиции в оплате. Можно получить с помощью метода crm.item.payment.product.list" } ], "defs": {}, @@ -37,5 +37,8 @@ } ], "page": "/api-reference/crm/universal/payment/products-in-payment/crm-item-payment-product-delete.html", - "executable": false + "executable": false, + "requestExample": { + "id": 1194 + } } diff --git a/_assets/simulator/spec/methods/crm.item.payment.product.list.json b/_assets/simulator/spec/methods/crm.item.payment.product.list.json index f4059c162..18a6b54de 100644 --- a/_assets/simulator/spec/methods/crm.item.payment.product.list.json +++ b/_assets/simulator/spec/methods/crm.item.payment.product.list.json @@ -4,7 +4,7 @@ "scope": "crm", "kind": "read", "title": "Получить список товарных позиций оплаты crm.item.payment.product.list", - "permissions": "требуется право на чтение заказа оплаты", + "permissions": "пользователь с правом «Чтение» для объекта CRM, к которому относится оплата", "params": [ { "name": "paymentId", @@ -17,8 +17,8 @@ "name": "filter", "type": "object", "base": "object", - "required": true, - "description": "Объект для фильтрации выбранных товарных позиций оплаты в формате {\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}. Возможные значения для field: - id - quantity Ключу может быть задан дополнительный префикс, уточняющий поведение фильтра. Возможные значения префикса: - = — равно, точное совпадение (используется по умолчанию) - % — LIKE, поиск по подстроке.…", + "required": false, + "description": "Объект для фильтрации выбранных товарных позиций оплаты в формате {\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}. По умолчанию фильтр не применяется. Возможные значения для field: - id - quantity Ключу может быть задан дополнительный префикс, уточняющий поведение фильтра. Возможные значения префикса: - = — равно, точное совпадение (используется по умолчанию) - % — LIKE, поиск по подстроке.…", "dynamic": { "allowed": true, "note": "Состав полей не описан подтаблицей на этой странице" @@ -29,7 +29,7 @@ "type": "object", "base": "object", "required": false, - "description": "Объект для сортировки выбранных товарных позиций оплаты в формате {\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}. Возможные значения для field: - id - quantity Возможные значения для order: - asc — в порядке возрастания - desc — в порядке убывания", + "description": "Объект для сортировки выбранных товарных позиций оплаты в формате {\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}. По умолчанию записи сортируются по id в порядке возрастания. Возможные значения для field: - id - quantity Возможные значения для order: - asc — в порядке возрастания - desc — в порядке убывания", "values": [ { "value": "asc", @@ -69,5 +69,15 @@ } ], "page": "/api-reference/crm/universal/payment/products-in-payment/crm-item-payment-product-list.html", - "executable": false + "executable": false, + "requestExample": { + "paymentId": 1039, + "filter": { + ">=quantity": 2, + "@id": [ + 1195, + 1196 + ] + } + } } diff --git a/_assets/simulator/spec/methods/crm.item.payment.product.setQuantity.json b/_assets/simulator/spec/methods/crm.item.payment.product.setQuantity.json index 87833981e..e9d32b9cb 100644 --- a/_assets/simulator/spec/methods/crm.item.payment.product.setQuantity.json +++ b/_assets/simulator/spec/methods/crm.item.payment.product.setQuantity.json @@ -4,21 +4,21 @@ "scope": "crm", "kind": "write", "title": "Изменить количество товара crm.item.payment.product.setQuantity", - "permissions": "требуется право на изменение заказа оплаты", + "permissions": "пользователь с правом «Изменение» для объекта CRM, к которому относится оплата", "params": [ { "name": "id", "type": "integer", "base": "integer", "required": true, - "description": "Идентификатор товарной позиции в оплате" + "description": "Идентификатор товарной позиции в оплате. Можно получить методом crm.item.payment.product.list" }, { "name": "quantity", - "type": "double", - "base": "number", + "type": "integer", + "base": "integer", "required": true, - "description": "Количество товара" + "description": "Новое количество товара. Значение должно быть больше нуля, а общее количество этой товарной позиции во всех оплатах не должно превышать количество в исходной товарной строке" } ], "defs": {}, @@ -44,5 +44,9 @@ } ], "page": "/api-reference/crm/universal/payment/products-in-payment/crm-item-payment-product-set-quantity.html", - "executable": false + "executable": false, + "requestExample": { + "id": 1195, + "quantity": 3 + } } diff --git a/_assets/simulator/spec/methods/crm.item.payment.unpay.json b/_assets/simulator/spec/methods/crm.item.payment.unpay.json index 8c5dcde05..f8a47b5cc 100644 --- a/_assets/simulator/spec/methods/crm.item.payment.unpay.json +++ b/_assets/simulator/spec/methods/crm.item.payment.unpay.json @@ -37,5 +37,8 @@ } ], "page": "/api-reference/crm/universal/payment/crm-item-payment-unpay.html", - "executable": false + "executable": false, + "requestExample": { + "id": 1038 + } } diff --git a/_assets/simulator/spec/methods/crm.item.payment.update.json b/_assets/simulator/spec/methods/crm.item.payment.update.json index 896920699..9d5358b65 100644 --- a/_assets/simulator/spec/methods/crm.item.payment.update.json +++ b/_assets/simulator/spec/methods/crm.item.payment.update.json @@ -79,5 +79,12 @@ } ], "page": "/api-reference/crm/universal/payment/crm-item-payment-update.html", - "executable": false + "executable": false, + "requestExample": { + "id": 1036, + "fields": { + "paid": "Y", + "paySystemId": 110 + } + } } diff --git a/_assets/simulator/spec/methods/crm.item.productrow.add.json b/_assets/simulator/spec/methods/crm.item.productrow.add.json index 6f81d9b61..c237e56bb 100644 --- a/_assets/simulator/spec/methods/crm.item.productrow.add.json +++ b/_assets/simulator/spec/methods/crm.item.productrow.add.json @@ -11,7 +11,7 @@ "type": "object", "base": "object", "required": true, - "description": "Объект, содержащий значения полей для добавления товарной позиции в объект CRM", + "description": "Объект, содержащий значения полей для добавления товарной позиции в объект CRM (подробное описание)", "ref": "#/defs/fieldsFields" } ], @@ -35,14 +35,14 @@ "type": "string", "base": "string", "required": true, - "description": "Идентификатор типа объекта CRM. Передавайте Краткий символьный код типа" + "description": "Краткий символьный код типа объекта CRM: L — лид, D — сделка, Q — предложение, SI — новый счет, T и шестнадцатеричный идентификатор типа — смарт-процесс" }, { "name": "productId", "type": "catalog_product.id", "base": "any", "required": false, - "description": "Идентификатор товара из каталога" + "description": "Идентификатор товара из каталога. Если не передан, создается позиция без привязки к каталогу" }, { "name": "productName", @@ -56,7 +56,7 @@ "type": "double", "base": "number", "required": false, - "description": "Цена за единицу товарной позиции с учетом скидок и налогов" + "description": "Цена за единицу товарной позиции с учетом скидок и налогов. Указывается в валюте объекта CRM. Если не передана, цена будет равна 0 — даже когда передан productId с ценой в каталоге" }, { "name": "quantity", @@ -108,7 +108,7 @@ "type": "string", "base": "string", "required": false, - "description": "Индикатор того, включен ли налог в стоимость. Возможные значения: - Y – налог включен - N – налог не включен По умолчанию - N", + "description": "Индикатор того, включен ли налог в стоимость. Возможные значения: - Y — налог включен - N — налог не включен По умолчанию — N", "values": [ { "value": "Y", @@ -116,16 +116,23 @@ }, { "value": "N", - "title": "налог не включен По умолчанию - N" + "title": "налог не включен По умолчанию — N" } ] }, + { + "name": "taxName", + "type": "string", + "base": "string", + "required": false, + "description": "Название налоговой ставки. Например, НДС 20. Это только подпись: в расчете участвует значение taxRate, а taxName метод сохраняет как есть. Если не передать taxName, позиция без налога получит значение Без НДС" + }, { "name": "measureCode", "type": "catalog_measure.code", "base": "any", "required": false, - "description": "Код единицы измерения Если не передано и передано значение productId, то используется единица измерения из каталога товаров" + "description": "Код единицы измерения. Если не передано, но передано значение productId, то используется единица измерения из каталога товаров" }, { "name": "sort", @@ -148,14 +155,7 @@ "type": "object", "base": "object", "required": false, - "description": "Корневой элемент ответа" - }, - { - "name": "productRow", - "type": "crm_item_product_row", - "base": "object", - "required": false, - "description": "Объект, содержащий информацию о добавленной товарной позиции" + "description": "Корневой элемент ответа (подробное описание)" }, { "name": "time", @@ -166,5 +166,20 @@ } ], "page": "/api-reference/crm/universal/product-rows/crm-item-productrow-add.html", - "executable": false + "executable": false, + "requestExample": { + "fields": { + "ownerId": 13142, + "ownerType": "D", + "productId": 9621, + "price": 80000, + "quantity": 2, + "discountTypeId": 2, + "discountRate": 20, + "taxRate": 20, + "taxIncluded": "Y", + "measureCode": 796, + "sort": 10 + } + } } diff --git a/_assets/simulator/spec/methods/crm.item.productrow.delete.json b/_assets/simulator/spec/methods/crm.item.productrow.delete.json index 703303889..23212847d 100644 --- a/_assets/simulator/spec/methods/crm.item.productrow.delete.json +++ b/_assets/simulator/spec/methods/crm.item.productrow.delete.json @@ -4,14 +4,14 @@ "scope": "crm", "kind": "write", "title": "Удалить товарную позицию из объекта CRM crm.item.productrow.delete", - "permissions": "требуется право на изменение объекта CRM, товарная позиция которого удаляется", + "permissions": "требуется право на изменение объекта CRM, которому принадлежит товарная позиция", "params": [ { "name": "id", "type": "crm_item_product_row.id", "base": "any", "required": true, - "description": "Идентификатор товарной позиции" + "description": "Идентификатор товарной позиции. Получить его можно методом crm.item.productrow.list" } ], "defs": {}, @@ -23,10 +23,10 @@ "returns": [ { "name": "result", - "type": "any", + "type": "null", "base": "any", "required": false, - "description": "Результат операции. Значение всегда null" + "description": "Метод не возвращает данных. Признак успеха — отсутствие ошибки в ответе" }, { "name": "time", @@ -37,5 +37,8 @@ } ], "page": "/api-reference/crm/universal/product-rows/crm-item-productrow-delete.html", - "executable": false + "executable": false, + "requestExample": { + "id": 17655 + } } diff --git a/_assets/simulator/spec/methods/crm.item.productrow.fields.json b/_assets/simulator/spec/methods/crm.item.productrow.fields.json new file mode 100644 index 000000000..de62bb33f --- /dev/null +++ b/_assets/simulator/spec/methods/crm.item.productrow.fields.json @@ -0,0 +1,57 @@ +{ + "$v": 1, + "method": "crm.item.productrow.fields", + "scope": "crm", + "kind": "read", + "title": "Получить список полей товарных позиций crm.item.productrow.fields", + "permissions": "любой пользователь", + "params": [ + { + "name": "result", + "type": "object", + "base": "object", + "required": "unknown", + "description": "Корневой элемент ответа (подробное описание)", + "dynamic": { + "allowed": true, + "note": "Состав полей не описан подтаблицей на этой странице" + } + }, + { + "name": "time", + "type": "time", + "base": "object", + "required": "unknown", + "description": "Информация о времени выполнения запроса", + "dynamic": { + "allowed": true, + "note": "Состав полей не описан подтаблицей на этой странице" + } + } + ], + "defs": {}, + "requiredConvention": false, + "confidence": "parsed", + "source": { + "file": "api-reference/crm/universal/product-rows/crm-item-productrow-fields.md" + }, + "returns": [ + { + "name": "result", + "type": "object", + "base": "object", + "required": "unknown", + "description": "Корневой элемент ответа (подробное описание)" + }, + { + "name": "time", + "type": "time", + "base": "object", + "required": "unknown", + "description": "Информация о времени выполнения запроса" + } + ], + "page": "/api-reference/crm/universal/product-rows/crm-item-productrow-fields.html", + "executable": false, + "requestExample": {} +} diff --git a/_assets/simulator/spec/methods/crm.item.productrow.get.json b/_assets/simulator/spec/methods/crm.item.productrow.get.json index fcffb982d..e91ebf461 100644 --- a/_assets/simulator/spec/methods/crm.item.productrow.get.json +++ b/_assets/simulator/spec/methods/crm.item.productrow.get.json @@ -4,14 +4,14 @@ "scope": "crm", "kind": "read", "title": "Получить информацию о товарной позиции по id crm.item.productrow.get", - "permissions": "требуется право на чтение объекта, к которому привязаны товарные позиции", + "permissions": "требуется право на чтение объекта CRM, которому принадлежит товарная позиция", "params": [ { "name": "id", "type": "crm_item_product_row.id", "base": "any", "required": true, - "description": "Идентификатор товарной позиции" + "description": "Идентификатор товарной позиции. Получить его можно методом crm.item.productrow.list" } ], "defs": {}, @@ -26,14 +26,7 @@ "type": "object", "base": "object", "required": false, - "description": "Корневой элемент ответа" - }, - { - "name": "productRow", - "type": "crm_item_product_row", - "base": "object", - "required": false, - "description": "Объект, содержащий информацию о товарной позиции" + "description": "Корневой элемент ответа (подробное описание)" }, { "name": "time", @@ -58,6 +51,10 @@ "quantity", "sort", "taxIncluded", + "taxName", "taxRate" - ] + ], + "requestExample": { + "id": 17622 + } } diff --git a/_assets/simulator/spec/methods/crm.item.productrow.getAvailableForPayment.json b/_assets/simulator/spec/methods/crm.item.productrow.getAvailableForPayment.json index 407822177..9219ddecd 100644 --- a/_assets/simulator/spec/methods/crm.item.productrow.getAvailableForPayment.json +++ b/_assets/simulator/spec/methods/crm.item.productrow.getAvailableForPayment.json @@ -11,14 +11,14 @@ "type": "integer", "base": "integer", "required": true, - "description": "Идентификатор объекта CRM" + "description": "Идентификатор объекта CRM. Получить его можно методом crm.item.list или из ответа метода crm.item.add" }, { "name": "ownerType", "type": "string", "base": "string", "required": true, - "description": "Идентификатор типа объекта CRM. Передавайте Краткий символьный код типа" + "description": "Краткий символьный код типа объекта CRM: L — лид, D — сделка, Q — предложение, SI — новый счет, T и шестнадцатеричный идентификатор типа — смарт-процесс. Например, для типа с entityTypeId: 128 код — T80" } ], "defs": {}, @@ -33,14 +33,7 @@ "type": "object", "base": "object", "required": false, - "description": "Корневой элемент ответа" - }, - { - "name": "productRows", - "type": "crm_item_product_row[]", - "base": "array", - "required": false, - "description": "Массив объектов, содержащий информацию о всех товарных позициях объекта CRM, по которым клиенту еще не была выставлена оплата" + "description": "Корневой элемент ответа (подробное описание)" }, { "name": "time", @@ -51,5 +44,9 @@ } ], "page": "/api-reference/crm/universal/product-rows/crm-item-productrow-get-available-for-payment.html", - "executable": false + "executable": false, + "requestExample": { + "ownerType": "D", + "ownerId": 13144 + } } diff --git a/_assets/simulator/spec/methods/crm.item.productrow.list.json b/_assets/simulator/spec/methods/crm.item.productrow.list.json index 1f6f74063..5392997be 100644 --- a/_assets/simulator/spec/methods/crm.item.productrow.list.json +++ b/_assets/simulator/spec/methods/crm.item.productrow.list.json @@ -11,18 +11,15 @@ "type": "object", "base": "object", "required": true, - "description": "Объект для фильтрации выбранных записей в формате {\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}. Возможные значения для field соответствуют полям объекта crm_item_product_row. Следующие ключи должны обязательно присутствовать: =ownerType =ownerId В =ownerType передавайте Краткий символьный код типа. Ключу может быть задан дополнительный префикс, уточняющий поведение фильтра.…", - "dynamic": { - "allowed": true, - "note": "Состав полей не описан подтаблицей на этой странице" - } + "description": "Объект для фильтрации выбранных записей в формате {\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"} (подробное описание)", + "ref": "#/defs/filterFields" }, { "name": "order", "type": "object", "base": "object", "required": false, - "description": "Объект для сортировки выбранных элементов табличной части отгрузки в формате {\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}. Возможные значения для field соответствуют полям объекта crm_item_product_row. Возможные значения для order: - asc — в порядке возрастания - desc — в порядке убывания", + "description": "Объект для сортировки выбранных товарных позиций в формате {\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}. Сортировать можно по полям id и sort. Остальные поля метод игнорирует. Без параметра order метод возвращает позиции в порядке возрастания значения sort. Возможные значения для order: - asc — в порядке возрастания - desc — в порядке убывания", "values": [ { "value": "asc", @@ -43,10 +40,48 @@ "type": "integer", "base": "integer", "required": false, - "description": "Параметр используется для управления постраничной навигацией. Размер страницы результатов всегда статичный: 50 записей. Чтобы выбрать вторую страницу результатов необходимо передавать значение 50. Чтобы выбрать третью страницу результатов значение — 100 и так далее. Формула расчета значения параметра start: start = (N-1) * 50, где N — номер нужной страницы" + "description": "Параметр используется для управления постраничной навигацией. Размер страницы результатов всегда статичный: 50 записей. Чтобы выбрать вторую страницу результатов, передайте значение 50, третью — 100 и так далее. Формула расчета значения параметра start: start = (N-1) * 50, где N — номер нужной страницы.…" } ], - "defs": {}, + "defs": { + "filterFields": { + "dynamic": { + "allowed": false, + "ufAllowed": true, + "note": "Пользовательские поля UF_* в схеме не описаны" + }, + "fields": [ + { + "name": "=ownerType", + "type": "string", + "base": "string", + "required": true, + "description": "Краткий символьный код типа объекта CRM: L — лид, D — сделка, Q — предложение, SI — новый счет, T и шестнадцатеричный идентификатор типа — смарт-процесс" + }, + { + "name": "=ownerId", + "type": "integer", + "base": "integer", + "required": true, + "description": "Идентификатор объекта CRM" + }, + { + "name": "id", + "type": "crm_item_product_row.id", + "base": "any", + "required": false, + "description": "Идентификатор товарной позиции" + }, + { + "name": "productId", + "type": "catalog_product.id", + "base": "any", + "required": false, + "description": "Идентификатор товара из каталога" + } + ] + } + }, "requiredConvention": true, "confidence": "parsed", "source": { @@ -58,21 +93,21 @@ "type": "object", "base": "object", "required": false, - "description": "Корневой элемент ответа" + "description": "Корневой элемент ответа (подробное описание)" }, { - "name": "productRows", - "type": "crm_item_product_row[]", - "base": "array", + "name": "next", + "type": "integer", + "base": "integer", "required": false, - "description": "Массив объектов, содержащий информацию о выбранных товарных позициях объекта CRM" + "description": "Значение для параметра start следующей страницы. Возвращается, только если выбраны не все записи" }, { "name": "total", "type": "integer", "base": "integer", "required": false, - "description": "Общее количество найденных записей" + "description": "Общее количество найденных записей. Не возвращается, если передан start: -1" }, { "name": "time", @@ -97,6 +132,7 @@ "quantity", "sort", "taxIncluded", + "taxName", "taxRate" ] } diff --git a/_assets/simulator/spec/methods/crm.item.productrow.set.json b/_assets/simulator/spec/methods/crm.item.productrow.set.json index 3b49c654a..215f262c0 100644 --- a/_assets/simulator/spec/methods/crm.item.productrow.set.json +++ b/_assets/simulator/spec/methods/crm.item.productrow.set.json @@ -3,8 +3,8 @@ "method": "crm.item.productrow.set", "scope": "crm", "kind": "write", - "title": "Сохранить товарную позицию объекта CRM crm.item.productrow.set", - "permissions": "требуется право на изменение объекта CRM, товарная позиция которого устанавливается", + "title": "Сохранить товарные позиции объекта CRM crm.item.productrow.set", + "permissions": "требуется право на изменение объекта CRM, товарные позиции которого сохраняются", "params": [ { "name": "ownerId", @@ -18,14 +18,14 @@ "type": "string", "base": "string", "required": true, - "description": "Идентификатор типа объекта CRM. Передавайте Краткий символьный код типа" + "description": "Краткий символьный код типа объекта CRM: L — лид, D — сделка, Q — предложение, SI — новый счет, T и шестнадцатеричный идентификатор типа — смарт-процесс" }, { "name": "productRows", "type": "object[]", "base": "array", "required": true, - "description": "Массив объектов с информацией о товарных позициях, которые нужно сохранить в объекте", + "description": "Массив объектов с информацией о товарных позициях, которые нужно сохранить в объекте (подробное описание)", "ref": "#/defs/productRowsFields" } ], @@ -37,26 +37,33 @@ "note": "Пользовательские поля UF_* в схеме не описаны" }, "fields": [ + { + "name": "id", + "type": "crm_item_product_row.id", + "base": "any", + "required": false, + "description": "Идентификатор существующей товарной позиции. Получить его можно методом crm.item.productrow.list. Передайте id, чтобы сохранить позицию с тем же идентификатором. Без id позиция создается заново. Если передать id несуществующей позиции или позиции другого объекта CRM, метод создаст новую позицию и не вернет ошибку" + }, { "name": "productId", "type": "catalog_product.id", "base": "any", "required": false, - "description": "Идентификатор товара из каталога" + "description": "Идентификатор товара из каталога. Если не передан, создается позиция без привязки к каталогу" }, { "name": "productName", "type": "string", "base": "string", "required": false, - "description": "Название товара в товарной позиции. Если не передано и передано значение productId, то используется название товара из каталога товаров" + "description": "Название товара в товарной позиции. Если не передано, но передано значение productId, то используется название товара из каталога товаров" }, { "name": "price", "type": "double", "base": "number", "required": false, - "description": "Цена за единицу товарной позиции с учетом скидок и налогов" + "description": "Цена за единицу товарной позиции с учетом скидок и налогов. Указывается в валюте объекта CRM. Если не передана, цена будет равна 0 — даже когда передан productId с ценой в каталоге" }, { "name": "quantity", @@ -108,7 +115,7 @@ "type": "string", "base": "string", "required": false, - "description": "Индикатор того, включен ли налог в стоимость. Возможные значения: - Y – налог включен - N – налог не включен По умолчанию - N", + "description": "Индикатор того, включен ли налог в стоимость. Возможные значения: - Y — налог включен - N — налог не включен По умолчанию — N", "values": [ { "value": "Y", @@ -116,16 +123,23 @@ }, { "value": "N", - "title": "налог не включен По умолчанию - N" + "title": "налог не включен По умолчанию — N" } ] }, + { + "name": "taxName", + "type": "string", + "base": "string", + "required": false, + "description": "Название налоговой ставки. Например, НДС 20. Это только подпись: в расчете участвует значение taxRate, а taxName метод сохраняет как есть. Если не передать taxName, позиция без налога получит значение Без НДС" + }, { "name": "measureCode", "type": "catalog_measure.code", "base": "any", "required": false, - "description": "Код единицы измерения. Если не передано и передано значение productId, то используется единица измерения из каталога товаров" + "description": "Код единицы измерения. Если не передано, но передано значение productId, то используется единица измерения из каталога товаров" }, { "name": "sort", @@ -148,14 +162,7 @@ "type": "object", "base": "object", "required": false, - "description": "Корневой элемент ответа" - }, - { - "name": "productRow", - "type": "crm_item_product_row[]", - "base": "array", - "required": false, - "description": "Массив объектов, содержащий информацию о всех товарных позициях объекта CRM" + "description": "Корневой элемент ответа (подробное описание)" }, { "name": "time", @@ -166,5 +173,23 @@ } ], "page": "/api-reference/crm/universal/product-rows/crm-item-productrow-set.html", - "executable": false + "executable": false, + "requestExample": { + "ownerType": "D", + "ownerId": 13143, + "productRows": [ + { + "productId": 9621, + "price": 99999.99, + "quantity": 1, + "sort": 10 + }, + { + "productId": 9623, + "price": 15900, + "quantity": 2, + "sort": 10 + } + ] + } } diff --git a/_assets/simulator/spec/methods/crm.item.productrow.update.json b/_assets/simulator/spec/methods/crm.item.productrow.update.json index 338e4ad00..f90a0b33e 100644 --- a/_assets/simulator/spec/methods/crm.item.productrow.update.json +++ b/_assets/simulator/spec/methods/crm.item.productrow.update.json @@ -4,21 +4,21 @@ "scope": "crm", "kind": "write", "title": "Изменить товарную позицию объекта CRM crm.item.productrow.update", - "permissions": "требуется право на изменение объекта CRM, товарная позиция которого изменяется", + "permissions": "требуется право на изменение объекта CRM, которому принадлежит товарная позиция", "params": [ { "name": "id", "type": "crm_item_product_row.id", "base": "any", "required": true, - "description": "Идентификатор товарной позиции" + "description": "Идентификатор товарной позиции. Получить его можно методом crm.item.productrow.list" }, { "name": "fields", "type": "object", "base": "object", "required": true, - "description": "Объект, содержащий значения полей для обновления товарной позиции объекта CRM", + "description": "Объект, содержащий значения полей для обновления товарной позиции объекта CRM (подробное описание)", "ref": "#/defs/fieldsFields" } ], @@ -42,14 +42,14 @@ "type": "string", "base": "string", "required": false, - "description": "Название товара в товарной позиции" + "description": "Название товара в товарной позиции. Если сменить productId и не передать productName, метод подставит название нового товара из каталога" }, { "name": "price", "type": "double", "base": "number", "required": false, - "description": "Цена за единицу товарной позиции с учетом скидок и налогов" + "description": "Цена за единицу товарной позиции с учетом скидок и налогов. Указывается в валюте объекта CRM. При смене productId цена из каталога не подставляется: чтобы изменить цену, передайте price" }, { "name": "quantity", @@ -101,7 +101,7 @@ "type": "string", "base": "string", "required": false, - "description": "Индикатор того, включен ли налог в стоимость. Возможные значения: - Y – налог включен - N – налог не включен", + "description": "Индикатор того, включен ли налог в стоимость. Возможные значения: - Y — налог включен - N — налог не включен", "values": [ { "value": "Y", @@ -113,12 +113,19 @@ } ] }, + { + "name": "taxName", + "type": "string", + "base": "string", + "required": false, + "description": "Название налоговой ставки. Например, НДС 20. Это только подпись: в расчете участвует значение taxRate, а taxName метод сохраняет как есть" + }, { "name": "measureCode", "type": "catalog_measure.code", "base": "any", "required": false, - "description": "Код единицы измерения" + "description": "Код единицы измерения. При смене productId единица измерения из каталога не подставляется" }, { "name": "sort", @@ -141,14 +148,7 @@ "type": "object", "base": "object", "required": false, - "description": "Корневой элемент ответа" - }, - { - "name": "productRow", - "type": "crm_item_product_row", - "base": "object", - "required": false, - "description": "Объект, содержащий информацию об обновленной товарной позиции" + "description": "Корневой элемент ответа (подробное описание). Если в fields передан пустой объект, метод вернет null" }, { "name": "time", @@ -159,5 +159,19 @@ } ], "page": "/api-reference/crm/universal/product-rows/crm-item-productrow-update.html", - "executable": false + "executable": false, + "requestExample": { + "id": 17648, + "fields": { + "productId": 9621, + "price": 90000, + "quantity": 3, + "discountTypeId": 2, + "discountRate": 10, + "taxRate": 10, + "taxIncluded": "Y", + "measureCode": 796, + "sort": 20 + } + } } diff --git a/_assets/simulator/spec/methods/crm.lead.add.json b/_assets/simulator/spec/methods/crm.lead.add.json index a20166633..4d300eb2a 100644 --- a/_assets/simulator/spec/methods/crm.lead.add.json +++ b/_assets/simulator/spec/methods/crm.lead.add.json @@ -384,5 +384,33 @@ } ], "page": "/api-reference/crm/leads/crm-lead-add.html", - "executable": false + "executable": false, + "requestExample": { + "fields": { + "TITLE": "ИП Титов", + "NAME": "Глеб", + "SECOND_NAME": "Егорович", + "LAST_NAME": "Титов", + "STATUS_ID": "NEW", + "OPENED": "Y", + "ASSIGNED_BY_ID": 1, + "CURRENCY_ID": "USD", + "OPPORTUNITY": 12500, + "PHONE": [ + { + "VALUE": "555888", + "VALUE_TYPE": "WORK" + } + ], + "WEB": [ + { + "VALUE": "www.mysite.com", + "VALUE_TYPE": "WORK" + } + ] + }, + "params": { + "REGISTER_SONET_EVENT": "Y" + } + } } diff --git a/_assets/simulator/spec/methods/crm.lead.contact.add.json b/_assets/simulator/spec/methods/crm.lead.contact.add.json index 97ef27846..622cffd73 100644 --- a/_assets/simulator/spec/methods/crm.lead.contact.add.json +++ b/_assets/simulator/spec/methods/crm.lead.contact.add.json @@ -87,5 +87,13 @@ } ], "page": "/api-reference/crm/leads/management-communication/crm-lead-contact-add.html", - "executable": false + "executable": false, + "requestExample": { + "id": 1, + "fields": { + "CONTACT_ID": 1010, + "SORT": 10, + "IS_PRIMARY": "Y" + } + } } diff --git a/_assets/simulator/spec/methods/crm.lead.contact.delete.json b/_assets/simulator/spec/methods/crm.lead.contact.delete.json index 6ba174b6e..2a66bf1a9 100644 --- a/_assets/simulator/spec/methods/crm.lead.contact.delete.json +++ b/_assets/simulator/spec/methods/crm.lead.contact.delete.json @@ -73,5 +73,11 @@ } ], "page": "/api-reference/crm/leads/management-communication/crm-lead-contact-delete.html", - "executable": false + "executable": false, + "requestExample": { + "id": 1, + "fields": { + "CONTACT_ID": 1010 + } + } } diff --git a/_assets/simulator/spec/methods/crm.lead.contact.items.delete.json b/_assets/simulator/spec/methods/crm.lead.contact.items.delete.json index 9b106e75a..50fc24ffc 100644 --- a/_assets/simulator/spec/methods/crm.lead.contact.items.delete.json +++ b/_assets/simulator/spec/methods/crm.lead.contact.items.delete.json @@ -48,5 +48,8 @@ } ], "page": "/api-reference/crm/leads/management-communication/crm-lead-contact-items-delete.html", - "executable": false + "executable": false, + "requestExample": { + "id": 1 + } } diff --git a/_assets/simulator/spec/methods/crm.lead.contact.items.get.json b/_assets/simulator/spec/methods/crm.lead.contact.items.get.json index cfd9fb830..6cc012fcc 100644 --- a/_assets/simulator/spec/methods/crm.lead.contact.items.get.json +++ b/_assets/simulator/spec/methods/crm.lead.contact.items.get.json @@ -37,5 +37,8 @@ } ], "page": "/api-reference/crm/leads/management-communication/crm-lead-contact-items-get.html", - "executable": false + "executable": false, + "requestExample": { + "id": 1 + } } diff --git a/_assets/simulator/spec/methods/crm.lead.contact.items.set.json b/_assets/simulator/spec/methods/crm.lead.contact.items.set.json index 78845c543..001a60a84 100644 --- a/_assets/simulator/spec/methods/crm.lead.contact.items.set.json +++ b/_assets/simulator/spec/methods/crm.lead.contact.items.set.json @@ -59,5 +59,20 @@ } ], "page": "/api-reference/crm/leads/management-communication/crm-lead-contact-items-set.html", - "executable": false + "executable": false, + "requestExample": { + "id": 1, + "items": [ + { + "CONTACT_ID": 1010, + "SORT": 10, + "IS_PRIMARY": "Y" + }, + { + "CONTACT_ID": 1020, + "SORT": 20, + "IS_PRIMARY": "N" + } + ] + } } diff --git a/_assets/simulator/spec/methods/crm.lead.delete.json b/_assets/simulator/spec/methods/crm.lead.delete.json index 112bd1123..fbacaa17c 100644 --- a/_assets/simulator/spec/methods/crm.lead.delete.json +++ b/_assets/simulator/spec/methods/crm.lead.delete.json @@ -53,5 +53,8 @@ } ], "page": "/api-reference/crm/leads/crm-lead-delete.html", - "executable": false + "executable": false, + "requestExample": { + "id": "123" + } } diff --git a/_assets/simulator/spec/methods/crm.lead.details.configuration.forceCommonScopeForAll.json b/_assets/simulator/spec/methods/crm.lead.details.configuration.forceCommonScopeForAll.json index 8cf5067e0..df9c6e3ea 100644 --- a/_assets/simulator/spec/methods/crm.lead.details.configuration.forceCommonScopeForAll.json +++ b/_assets/simulator/spec/methods/crm.lead.details.configuration.forceCommonScopeForAll.json @@ -70,5 +70,10 @@ } ], "page": "/api-reference/crm/leads/custom-form/crm-lead-details-configuration-force-common-scope-for-all.html", - "executable": false + "executable": false, + "requestExample": { + "extras": { + "leadCustomerType": 2 + } + } } diff --git a/_assets/simulator/spec/methods/crm.lead.details.configuration.get.json b/_assets/simulator/spec/methods/crm.lead.details.configuration.get.json index 7ec852c16..d4c2e16f0 100644 --- a/_assets/simulator/spec/methods/crm.lead.details.configuration.get.json +++ b/_assets/simulator/spec/methods/crm.lead.details.configuration.get.json @@ -125,5 +125,9 @@ "name", "title", "type" - ] + ], + "requestExample": { + "scope": "P", + "userId": 1 + } } diff --git a/_assets/simulator/spec/methods/crm.lead.details.configuration.reset.json b/_assets/simulator/spec/methods/crm.lead.details.configuration.reset.json index 79f815a73..3b64c8d25 100644 --- a/_assets/simulator/spec/methods/crm.lead.details.configuration.reset.json +++ b/_assets/simulator/spec/methods/crm.lead.details.configuration.reset.json @@ -84,5 +84,9 @@ } ], "page": "/api-reference/crm/leads/custom-form/crm-lead-details-configuration-reset.html", - "executable": false + "executable": false, + "requestExample": { + "scope": "P", + "userId": 1 + } } diff --git a/_assets/simulator/spec/methods/crm.lead.details.configuration.set.json b/_assets/simulator/spec/methods/crm.lead.details.configuration.set.json index ca0bf4e79..73a0aa4dc 100644 --- a/_assets/simulator/spec/methods/crm.lead.details.configuration.set.json +++ b/_assets/simulator/spec/methods/crm.lead.details.configuration.set.json @@ -95,5 +95,50 @@ } ], "page": "/api-reference/crm/leads/custom-form/crm-lead-details-configuration-set.html", - "executable": false + "executable": false, + "requestExample": { + "scope": "P", + "userId": 1, + "extras": { + "leadCustomerType": 2 + }, + "data": [ + { + "name": "main", + "title": "О лиде", + "type": "section", + "elements": [ + { + "name": "TITLE" + }, + { + "name": "STATUS_ID" + }, + { + "name": "SOURCE_ID" + }, + { + "name": "NAME" + }, + { + "name": "PHONE", + "optionFlags": 1 + } + ] + }, + { + "name": "additional", + "title": "Дополнительно", + "type": "section", + "elements": [ + { + "name": "ASSIGNED_BY_ID" + }, + { + "name": "COMMENTS" + } + ] + } + ] + } } diff --git a/_assets/simulator/spec/methods/crm.lead.fields.json b/_assets/simulator/spec/methods/crm.lead.fields.json index 328aec565..dfc3b2e71 100644 --- a/_assets/simulator/spec/methods/crm.lead.fields.json +++ b/_assets/simulator/spec/methods/crm.lead.fields.json @@ -584,5 +584,6 @@ } ], "page": "/api-reference/crm/leads/crm-lead-fields.html", - "executable": false + "executable": false, + "requestExample": {} } diff --git a/_assets/simulator/spec/methods/crm.lead.get.json b/_assets/simulator/spec/methods/crm.lead.get.json index 75ae17ea0..332079dbc 100644 --- a/_assets/simulator/spec/methods/crm.lead.get.json +++ b/_assets/simulator/spec/methods/crm.lead.get.json @@ -165,5 +165,14 @@ "UTM_SOURCE", "UTM_TERM", "WEB" - ] + ], + "datasetHint": { + "entity": "leads", + "count": 25, + "idFrom": 1, + "idTo": 25, + "runnableExample": { + "id": 1 + } + } } diff --git a/_assets/simulator/spec/methods/crm.lead.list.json b/_assets/simulator/spec/methods/crm.lead.list.json index 572ca2a14..d04e36ad7 100644 --- a/_assets/simulator/spec/methods/crm.lead.list.json +++ b/_assets/simulator/spec/methods/crm.lead.list.json @@ -120,5 +120,12 @@ "UTM_SOURCE", "UTM_TERM", "WEB" - ] + ], + "datasetHint": { + "entity": "leads", + "count": 25, + "idFrom": 1, + "idTo": 25, + "runnableExample": {} + } } diff --git a/_assets/simulator/spec/methods/crm.lead.productrows.get.json b/_assets/simulator/spec/methods/crm.lead.productrows.get.json index 9c35040ba..6ea7e2e3d 100644 --- a/_assets/simulator/spec/methods/crm.lead.productrows.get.json +++ b/_assets/simulator/spec/methods/crm.lead.productrows.get.json @@ -144,5 +144,8 @@ "TAX_RATE", "TYPE", "XML_ID" - ] + ], + "requestExample": { + "id": 5 + } } diff --git a/_assets/simulator/spec/methods/crm.lead.productrows.set.json b/_assets/simulator/spec/methods/crm.lead.productrows.set.json index fa4d7151f..190bf65b1 100644 --- a/_assets/simulator/spec/methods/crm.lead.productrows.set.json +++ b/_assets/simulator/spec/methods/crm.lead.productrows.set.json @@ -64,5 +64,32 @@ } ], "page": "/api-reference/crm/leads/crm-lead-productrows-set.html", - "executable": false + "executable": false, + "requestExample": { + "id": 5, + "rows": [ + { + "PRODUCT_ID": 456, + "PRICE": 1000, + "QUANTITY": 10, + "DISCOUNT_TYPE_ID": 1, + "DISCOUNT_SUM": 100, + "TAX_RATE": 13, + "MEASURE_CODE": 796, + "MEASURE_NAME": "шт", + "SORT": 10 + }, + { + "PRODUCT_NAME": "Товар #2", + "PRICE": 500, + "QUANTITY": 5, + "DISCOUNT_TYPE_ID": 2, + "DISCOUNT_RATE": 10, + "TAX_RATE": 10, + "MEASURE_CODE": 166, + "MEASURE_NAME": "кг", + "SORT": 20 + } + ] + } } diff --git a/_assets/simulator/spec/methods/crm.lead.update.json b/_assets/simulator/spec/methods/crm.lead.update.json index 1ec6e790a..0c8a0dffa 100644 --- a/_assets/simulator/spec/methods/crm.lead.update.json +++ b/_assets/simulator/spec/methods/crm.lead.update.json @@ -75,5 +75,34 @@ } ], "page": "/api-reference/crm/leads/crm-lead-update.html", - "executable": false + "executable": false, + "requestExample": { + "id": 1608, + "fields": { + "TITLE": "ИП Титов", + "NAME": "Глеб", + "SECOND_NAME": "Егорович", + "LAST_NAME": "Титов", + "STATUS_ID": "NEW", + "OPENED": "Y", + "ASSIGNED_BY_ID": 1, + "CURRENCY_ID": "USD", + "OPPORTUNITY": 12500, + "PHONE": [ + { + "VALUE": "555888", + "VALUE_TYPE": "WORK" + } + ], + "WEB": [ + { + "VALUE": "www.mysite.com", + "VALUE_TYPE": "WORK" + } + ] + }, + "params": { + "REGISTER_SONET_EVENT": "Y" + } + } } diff --git a/_assets/simulator/spec/methods/crm.lead.userfield.add.json b/_assets/simulator/spec/methods/crm.lead.userfield.add.json index 7c6ad9626..8ab035c1a 100644 --- a/_assets/simulator/spec/methods/crm.lead.userfield.add.json +++ b/_assets/simulator/spec/methods/crm.lead.userfield.add.json @@ -305,5 +305,43 @@ } ], "page": "/api-reference/crm/leads/userfield/crm-lead-userfield-add.html", - "executable": false + "executable": false, + "requestExample": { + "fields": { + "LABEL": "Пользовательское поле (список)", + "USER_TYPE_ID": "enumeration", + "FIELD_NAME": "ENUMERATION_EXAMPLE", + "MULTIPLE": "N", + "MANDATORY": "N", + "SHOW_FILTER": "Y", + "LIST": [ + { + "VALUE": "Элемент списка #1", + "DEF": "Y", + "XML_ID": "XML_ID_1", + "SORT": 100 + }, + { + "VALUE": "Элемент списка #2", + "XML_ID": "XML_ID_2", + "SORT": 200 + }, + { + "VALUE": "Элемент списка #3", + "XML_ID": "XML_ID_3", + "SORT": 300 + }, + { + "VALUE": "Элемент списка #4", + "XML_ID": "XML_ID_4", + "SORT": 400 + } + ], + "SETTINGS": { + "DISPLAY": "UI", + "LIST_HEIGHT": 2 + }, + "SORT": 2000 + } + } } diff --git a/_assets/simulator/spec/methods/crm.lead.userfield.delete.json b/_assets/simulator/spec/methods/crm.lead.userfield.delete.json index 8ff09494c..29bf1c82d 100644 --- a/_assets/simulator/spec/methods/crm.lead.userfield.delete.json +++ b/_assets/simulator/spec/methods/crm.lead.userfield.delete.json @@ -49,5 +49,8 @@ } ], "page": "/api-reference/crm/leads/userfield/crm-lead-userfield-delete.html", - "executable": false + "executable": false, + "requestExample": { + "id": 432 + } } diff --git a/_assets/simulator/spec/methods/crm.lead.userfield.get.json b/_assets/simulator/spec/methods/crm.lead.userfield.get.json index c06721766..cad743198 100644 --- a/_assets/simulator/spec/methods/crm.lead.userfield.get.json +++ b/_assets/simulator/spec/methods/crm.lead.userfield.get.json @@ -206,5 +206,8 @@ "SORT", "USER_TYPE_ID", "XML_ID" - ] + ], + "requestExample": { + "id": 399 + } } diff --git a/_assets/simulator/spec/methods/crm.lead.userfield.list.json b/_assets/simulator/spec/methods/crm.lead.userfield.list.json index b84fa3be3..05eaa5706 100644 --- a/_assets/simulator/spec/methods/crm.lead.userfield.list.json +++ b/_assets/simulator/spec/methods/crm.lead.userfield.list.json @@ -316,5 +316,16 @@ "SORT", "USER_TYPE_ID", "XML_ID" - ] + ], + "requestExample": { + "filter": { + "MULTIPLE": "Y", + "MANDATORY": "Y", + "LANG": "ru" + }, + "order": { + "USER_TYPE_ID": "ASC", + "SORT": "ASC" + } + } } diff --git a/_assets/simulator/spec/methods/crm.measure.add.json b/_assets/simulator/spec/methods/crm.measure.add.json index 377b99c14..08fa1928d 100644 --- a/_assets/simulator/spec/methods/crm.measure.add.json +++ b/_assets/simulator/spec/methods/crm.measure.add.json @@ -78,5 +78,15 @@ "successor": "catalog.measure.add" }, "page": "/api-reference/crm/outdated/measure/crm-measure-add.html", - "executable": false + "executable": false, + "requestExample": { + "fields": { + "CODE": "212", + "MEASURE_TITLE": "Ватт", + "SYMBOL_RUS": "Вт", + "SYMBOL_INTL": "W", + "SYMBOL_LETTER_INTL": "WTT", + "IS_DEFAULT": "N" + } + } } diff --git a/_assets/simulator/spec/methods/crm.measure.delete.json b/_assets/simulator/spec/methods/crm.measure.delete.json index 71798eaa3..6373fdba8 100644 --- a/_assets/simulator/spec/methods/crm.measure.delete.json +++ b/_assets/simulator/spec/methods/crm.measure.delete.json @@ -24,5 +24,8 @@ "successor": "catalog.measure.delete" }, "page": "/api-reference/crm/outdated/measure/crm-measure-delete.html", - "executable": false + "executable": false, + "requestExample": { + "id": "**put_id_here**" + } } diff --git a/_assets/simulator/spec/methods/crm.measure.get.json b/_assets/simulator/spec/methods/crm.measure.get.json index 659e48df0..bc90bf2b4 100644 --- a/_assets/simulator/spec/methods/crm.measure.get.json +++ b/_assets/simulator/spec/methods/crm.measure.get.json @@ -32,5 +32,8 @@ "SYMBOL_INTL", "SYMBOL_LETTER_INTL", "SYMBOL_RUS" - ] + ], + "requestExample": { + "id": "**put_id_here**" + } } diff --git a/_assets/simulator/spec/methods/crm.measure.update.json b/_assets/simulator/spec/methods/crm.measure.update.json index d661e1e6a..ec0d9f722 100644 --- a/_assets/simulator/spec/methods/crm.measure.update.json +++ b/_assets/simulator/spec/methods/crm.measure.update.json @@ -35,5 +35,11 @@ "successor": "catalog.measure.update" }, "page": "/api-reference/crm/outdated/measure/crm-measure-update.html", - "executable": false + "executable": false, + "requestExample": { + "id": "**put_id_here**", + "fields": { + "MEASURE_TITLE": "**put_new_title_here**" + } + } } diff --git a/_assets/simulator/spec/methods/crm.multifield.fields.json b/_assets/simulator/spec/methods/crm.multifield.fields.json index 4883a7d24..b7afecb30 100644 --- a/_assets/simulator/spec/methods/crm.multifield.fields.json +++ b/_assets/simulator/spec/methods/crm.multifield.fields.json @@ -102,5 +102,6 @@ } ], "page": "/api-reference/crm/auxiliary/multifield/crm-multifield-fields.html", - "executable": false + "executable": false, + "requestExample": {} } diff --git a/_assets/simulator/spec/methods/crm.orderentity.add.json b/_assets/simulator/spec/methods/crm.orderentity.add.json index 8ccac1584..82cdeb131 100644 --- a/_assets/simulator/spec/methods/crm.orderentity.add.json +++ b/_assets/simulator/spec/methods/crm.orderentity.add.json @@ -94,5 +94,12 @@ } ], "page": "/api-reference/crm/universal/order-entity/crm-order-entity-add.html", - "executable": false + "executable": false, + "requestExample": { + "fields": { + "orderId": 5125, + "ownerId": 6933, + "ownerTypeId": 2 + } + } } diff --git a/_assets/simulator/spec/methods/crm.orderentity.deleteByFilter.json b/_assets/simulator/spec/methods/crm.orderentity.deleteByFilter.json index d84e25740..1803dbeff 100644 --- a/_assets/simulator/spec/methods/crm.orderentity.deleteByFilter.json +++ b/_assets/simulator/spec/methods/crm.orderentity.deleteByFilter.json @@ -81,5 +81,12 @@ } ], "page": "/api-reference/crm/universal/order-entity/crm-order-entity-delete-by-filter.html", - "executable": false + "executable": false, + "requestExample": { + "fields": { + "orderId": 5125, + "ownerId": 6933, + "ownerTypeId": 2 + } + } } diff --git a/_assets/simulator/spec/methods/crm.orderentity.list.json b/_assets/simulator/spec/methods/crm.orderentity.list.json index da080efe3..62ce90bcb 100644 --- a/_assets/simulator/spec/methods/crm.orderentity.list.json +++ b/_assets/simulator/spec/methods/crm.orderentity.list.json @@ -127,5 +127,22 @@ "orderId", "ownerId", "ownerTypeId" - ] + ], + "requestExample": { + "select": [ + "orderId", + "ownerId" + ], + "filter": { + "=ownerTypeId": 2, + "@ownerId": [ + 6938, + 6937, + 6933 + ] + }, + "order": { + "orderId": "asc" + } + } } diff --git a/_assets/simulator/spec/methods/crm.product.add.json b/_assets/simulator/spec/methods/crm.product.add.json index dfb580e89..717cac6f0 100644 --- a/_assets/simulator/spec/methods/crm.product.add.json +++ b/_assets/simulator/spec/methods/crm.product.add.json @@ -28,5 +28,13 @@ "successor": "catalog.product.add" }, "page": "/api-reference/crm/outdated/products/crm-product-add.html", - "executable": false + "executable": false, + "requestExample": { + "fields": { + "NAME": "Стул пластиковый", + "CURRENCY_ID": "RUB", + "PRICE": 4900, + "SORT": 500 + } + } } diff --git a/_assets/simulator/spec/methods/crm.product.property.list.json b/_assets/simulator/spec/methods/crm.product.property.list.json index 737163c36..72c60b1b8 100644 --- a/_assets/simulator/spec/methods/crm.product.property.list.json +++ b/_assets/simulator/spec/methods/crm.product.property.list.json @@ -31,5 +31,14 @@ "successor": "catalog.productProperty.list" }, "page": "/api-reference/crm/outdated/products/crm-product-property-list.html", - "executable": false + "executable": false, + "requestExample": { + "order": { + "SORT": "ASC" + }, + "filter": { + "PROPERTY_TYPE": "S", + "USER_TYPE": "HTML" + } + } } diff --git a/_assets/simulator/spec/methods/crm.product.property.settings.fields.json b/_assets/simulator/spec/methods/crm.product.property.settings.fields.json index fc7f01b53..ba5285523 100644 --- a/_assets/simulator/spec/methods/crm.product.property.settings.fields.json +++ b/_assets/simulator/spec/methods/crm.product.property.settings.fields.json @@ -31,5 +31,9 @@ "successor": null }, "page": "/api-reference/crm/outdated/products/crm-product-property-settings-fields.html", - "executable": false + "executable": false, + "requestExample": { + "propertyType": "S", + "userType": "HTML" + } } diff --git a/_assets/simulator/spec/methods/crm.quote.add.json b/_assets/simulator/spec/methods/crm.quote.add.json index a046cd05d..9e7e878ef 100644 --- a/_assets/simulator/spec/methods/crm.quote.add.json +++ b/_assets/simulator/spec/methods/crm.quote.add.json @@ -228,5 +228,23 @@ } ], "page": "/api-reference/crm/quote/crm-quote-add.html", - "executable": false + "executable": false, + "requestExample": { + "fields": { + "TITLE": "КП на поставку мебели", + "STATUS_ID": "DRAFT", + "OPENED": "Y", + "ASSIGNED_BY_ID": 1, + "CURRENCY_ID": "RUB", + "OPPORTUNITY": 150000, + "COMPANY_ID": 1, + "MYCOMPANY_ID": 3, + "COMMENTS": "Подготовлено по запросу клиента", + "BEGINDATE": "2026-03-13T10:00:00+03:00", + "CLOSEDATE": "2026-03-20T18:00:00+03:00" + }, + "params": { + "IMPORT": "N" + } + } } diff --git a/_assets/simulator/spec/methods/crm.quote.contact.add.json b/_assets/simulator/spec/methods/crm.quote.contact.add.json index 257db044c..ce6d0acaf 100644 --- a/_assets/simulator/spec/methods/crm.quote.contact.add.json +++ b/_assets/simulator/spec/methods/crm.quote.contact.add.json @@ -100,5 +100,13 @@ } ], "page": "/api-reference/crm/quote/contacts/crm-quote-contact-add.html", - "executable": false + "executable": false, + "requestExample": { + "id": 113, + "fields": { + "CONTACT_ID": 2647, + "IS_PRIMARY": "Y", + "SORT": 10 + } + } } diff --git a/_assets/simulator/spec/methods/crm.quote.contact.delete.json b/_assets/simulator/spec/methods/crm.quote.contact.delete.json index 18026b45f..fff5ef8a3 100644 --- a/_assets/simulator/spec/methods/crm.quote.contact.delete.json +++ b/_assets/simulator/spec/methods/crm.quote.contact.delete.json @@ -75,5 +75,11 @@ } ], "page": "/api-reference/crm/quote/contacts/crm-quote-contact-delete.html", - "executable": false + "executable": false, + "requestExample": { + "id": 113, + "fields": { + "CONTACT_ID": 2647 + } + } } diff --git a/_assets/simulator/spec/methods/crm.quote.contact.fields.json b/_assets/simulator/spec/methods/crm.quote.contact.fields.json index dad6e1847..0e60acd33 100644 --- a/_assets/simulator/spec/methods/crm.quote.contact.fields.json +++ b/_assets/simulator/spec/methods/crm.quote.contact.fields.json @@ -93,5 +93,6 @@ } ], "page": "/api-reference/crm/quote/contacts/crm-quote-contact-fields.html", - "executable": false + "executable": false, + "requestExample": {} } diff --git a/_assets/simulator/spec/methods/crm.quote.contact.items.delete.json b/_assets/simulator/spec/methods/crm.quote.contact.items.delete.json index c7a918e89..67004e14a 100644 --- a/_assets/simulator/spec/methods/crm.quote.contact.items.delete.json +++ b/_assets/simulator/spec/methods/crm.quote.contact.items.delete.json @@ -50,5 +50,8 @@ } ], "page": "/api-reference/crm/quote/contacts/crm-quote-contact-items-delete.html", - "executable": false + "executable": false, + "requestExample": { + "id": 113 + } } diff --git a/_assets/simulator/spec/methods/crm.quote.contact.items.get.json b/_assets/simulator/spec/methods/crm.quote.contact.items.get.json index 498c5ed6a..6125025a7 100644 --- a/_assets/simulator/spec/methods/crm.quote.contact.items.get.json +++ b/_assets/simulator/spec/methods/crm.quote.contact.items.get.json @@ -69,5 +69,8 @@ "IS_PRIMARY", "ROLE_ID", "SORT" - ] + ], + "requestExample": { + "id": 113 + } } diff --git a/_assets/simulator/spec/methods/crm.quote.contact.items.set.json b/_assets/simulator/spec/methods/crm.quote.contact.items.set.json index 93e77b93e..ad4e1665d 100644 --- a/_assets/simulator/spec/methods/crm.quote.contact.items.set.json +++ b/_assets/simulator/spec/methods/crm.quote.contact.items.set.json @@ -61,5 +61,19 @@ } ], "page": "/api-reference/crm/quote/contacts/crm-quote-contact-items-set.html", - "executable": false + "executable": false, + "requestExample": { + "id": 113, + "items": [ + { + "CONTACT_ID": 2649, + "SORT": 10, + "IS_PRIMARY": "Y" + }, + { + "CONTACT_ID": 2647, + "SORT": 20 + } + ] + } } diff --git a/_assets/simulator/spec/methods/crm.quote.delete.json b/_assets/simulator/spec/methods/crm.quote.delete.json index 192b224c0..4e6114bc0 100644 --- a/_assets/simulator/spec/methods/crm.quote.delete.json +++ b/_assets/simulator/spec/methods/crm.quote.delete.json @@ -53,5 +53,8 @@ } ], "page": "/api-reference/crm/quote/crm-quote-delete.html", - "executable": false + "executable": false, + "requestExample": { + "id": 43 + } } diff --git a/_assets/simulator/spec/methods/crm.quote.fields.json b/_assets/simulator/spec/methods/crm.quote.fields.json index 271cb916c..7c3de7d00 100644 --- a/_assets/simulator/spec/methods/crm.quote.fields.json +++ b/_assets/simulator/spec/methods/crm.quote.fields.json @@ -476,5 +476,6 @@ } ], "page": "/api-reference/crm/quote/crm-quote-fields.html", - "executable": false + "executable": false, + "requestExample": {} } diff --git a/_assets/simulator/spec/methods/crm.quote.get.json b/_assets/simulator/spec/methods/crm.quote.get.json index 14f2e799c..5a60561e1 100644 --- a/_assets/simulator/spec/methods/crm.quote.get.json +++ b/_assets/simulator/spec/methods/crm.quote.get.json @@ -169,5 +169,8 @@ "UTM_MEDIUM", "UTM_SOURCE", "UTM_TERM" - ] + ], + "requestExample": { + "id": 43 + } } diff --git a/_assets/simulator/spec/methods/crm.quote.list.json b/_assets/simulator/spec/methods/crm.quote.list.json index 17440856d..efb8f5e00 100644 --- a/_assets/simulator/spec/methods/crm.quote.list.json +++ b/_assets/simulator/spec/methods/crm.quote.list.json @@ -138,5 +138,23 @@ "PERSON_TYPE_ID", "STATUS_ID", "TITLE" - ] + ], + "requestExample": { + "order": { + "STATUS_ID": "ASC", + "ID": "ASC" + }, + "filter": { + "=COMPANY_ID": 1, + "=STATUS_ID": "SENT" + }, + "select": [ + "ID", + "TITLE", + "STATUS_ID", + "OPPORTUNITY", + "CURRENCY_ID", + "ASSIGNED_BY_ID" + ] + } } diff --git a/_assets/simulator/spec/methods/crm.quote.productrows.get.json b/_assets/simulator/spec/methods/crm.quote.productrows.get.json index 65fd5ca91..0e984d08c 100644 --- a/_assets/simulator/spec/methods/crm.quote.productrows.get.json +++ b/_assets/simulator/spec/methods/crm.quote.productrows.get.json @@ -114,5 +114,8 @@ "TAX_RATE", "TYPE", "XML_ID" - ] + ], + "requestExample": { + "id": 1 + } } diff --git a/_assets/simulator/spec/methods/crm.quote.productrows.set.json b/_assets/simulator/spec/methods/crm.quote.productrows.set.json index fedfaea92..f85e488d1 100644 --- a/_assets/simulator/spec/methods/crm.quote.productrows.set.json +++ b/_assets/simulator/spec/methods/crm.quote.productrows.set.json @@ -64,5 +64,34 @@ } ], "page": "/api-reference/crm/quote/crm-quote-product-rows-set.html", - "executable": false + "executable": false, + "requestExample": { + "id": 1, + "rows": [ + { + "PRODUCT_ID": 459, + "PRICE": 3000, + "QUANTITY": 1, + "DISCOUNT_TYPE_ID": 2, + "DISCOUNT_RATE": 0, + "TAX_RATE": 0, + "TAX_INCLUDED": "Y", + "MEASURE_CODE": 796, + "MEASURE_NAME": "шт", + "SORT": 10 + }, + { + "PRODUCT_NAME": "Услуга сопровождения", + "PRICE": 1500, + "QUANTITY": 2, + "DISCOUNT_TYPE_ID": 2, + "DISCOUNT_RATE": 0, + "TAX_RATE": 0, + "TAX_INCLUDED": "Y", + "MEASURE_CODE": 796, + "MEASURE_NAME": "шт", + "SORT": 20 + } + ] + } } diff --git a/_assets/simulator/spec/methods/crm.quote.update.json b/_assets/simulator/spec/methods/crm.quote.update.json index 49ea2d17e..b452bdb0e 100644 --- a/_assets/simulator/spec/methods/crm.quote.update.json +++ b/_assets/simulator/spec/methods/crm.quote.update.json @@ -242,5 +242,15 @@ } ], "page": "/api-reference/crm/quote/crm-quote-update.html", - "executable": false + "executable": false, + "requestExample": { + "id": 43, + "fields": { + "STATUS_ID": "SENT", + "COMMENTS": "Уточнены условия и сроки" + }, + "params": { + "REGISTER_HISTORY_EVENT": "Y" + } + } } diff --git a/_assets/simulator/spec/methods/crm.quote.userfield.add.json b/_assets/simulator/spec/methods/crm.quote.userfield.add.json index 4a1d8a074..6369ea301 100644 --- a/_assets/simulator/spec/methods/crm.quote.userfield.add.json +++ b/_assets/simulator/spec/methods/crm.quote.userfield.add.json @@ -305,5 +305,43 @@ } ], "page": "/api-reference/crm/quote/user-field/crm-quote-user-field-add.html", - "executable": false + "executable": false, + "requestExample": { + "fields": { + "LABEL": "Пользовательское поле (список)", + "USER_TYPE_ID": "enumeration", + "FIELD_NAME": "ENUMERATION_EXAMPLE", + "MULTIPLE": "N", + "MANDATORY": "N", + "SHOW_FILTER": "Y", + "LIST": [ + { + "VALUE": "Элемент списка #1", + "DEF": "Y", + "XML_ID": "XML_ID_1", + "SORT": 100 + }, + { + "VALUE": "Элемент списка #2", + "XML_ID": "XML_ID_2", + "SORT": 200 + }, + { + "VALUE": "Элемент списка #3", + "XML_ID": "XML_ID_3", + "SORT": 300 + }, + { + "VALUE": "Элемент списка #4", + "XML_ID": "XML_ID_4", + "SORT": 400 + } + ], + "SETTINGS": { + "DISPLAY": "UI", + "LIST_HEIGHT": 2 + }, + "SORT": 2000 + } + } } diff --git a/_assets/simulator/spec/methods/crm.quote.userfield.delete.json b/_assets/simulator/spec/methods/crm.quote.userfield.delete.json index f6dafc569..744de13f2 100644 --- a/_assets/simulator/spec/methods/crm.quote.userfield.delete.json +++ b/_assets/simulator/spec/methods/crm.quote.userfield.delete.json @@ -49,5 +49,8 @@ } ], "page": "/api-reference/crm/quote/user-field/crm-quote-user-field-delete.html", - "executable": false + "executable": false, + "requestExample": { + "id": 432 + } } diff --git a/_assets/simulator/spec/methods/crm.quote.userfield.get.json b/_assets/simulator/spec/methods/crm.quote.userfield.get.json index bbba2d867..538d7686d 100644 --- a/_assets/simulator/spec/methods/crm.quote.userfield.get.json +++ b/_assets/simulator/spec/methods/crm.quote.userfield.get.json @@ -206,5 +206,8 @@ "SORT", "USER_TYPE_ID", "XML_ID" - ] + ], + "requestExample": { + "id": 399 + } } diff --git a/_assets/simulator/spec/methods/crm.quote.userfield.list.json b/_assets/simulator/spec/methods/crm.quote.userfield.list.json index 435b93077..489a1dd38 100644 --- a/_assets/simulator/spec/methods/crm.quote.userfield.list.json +++ b/_assets/simulator/spec/methods/crm.quote.userfield.list.json @@ -316,5 +316,16 @@ "SORT", "USER_TYPE_ID", "XML_ID" - ] + ], + "requestExample": { + "filter": { + "MULTIPLE": "Y", + "MANDATORY": "Y", + "LANG": "ru" + }, + "order": { + "USER_TYPE_ID": "ASC", + "SORT": "ASC" + } + } } diff --git a/_assets/simulator/spec/methods/crm.requisite.add.json b/_assets/simulator/spec/methods/crm.requisite.add.json index 750f965f3..fe69a7b00 100644 --- a/_assets/simulator/spec/methods/crm.requisite.add.json +++ b/_assets/simulator/spec/methods/crm.requisite.add.json @@ -53,5 +53,26 @@ } ], "page": "/api-reference/crm/requisites/universal/crm-requisite-add.html", - "executable": false + "executable": false, + "requestExample": { + "fields": { + "ENTITY_TYPE_ID": 4, + "ENTITY_ID": 1, + "PRESET_ID": 1, + "NAME": "Организация", + "ACTIVE": "Y", + "ADDRESS_ONLY": "N", + "SORT": 500, + "RQ_COMPANY_NAME": "ООО \"1С-БИТРИКС\"", + "RQ_COMPANY_FULL_NAME": "ОБЩЕСТВО С ОГРАНИЧЕННОЙ ОТВЕТСТВЕННОСТЬЮ \"1С-БИТРИКС\"", + "RQ_COMPANY_REG_DATE": "06.04.2007", + "RQ_DIRECTOR": "РЫЖИКОВ СЕРГЕЙ ВЛАДИМИРОВИЧ", + "RQ_INN": "7717586110", + "RQ_KPP": "770501001", + "RQ_OGRN": "5077746476209", + "UF_CRM_1707997209": "56", + "UF_CRM_1708012333": "Категория 1", + "XML_ID": "5e4641fd-1dd9-11e6-b2f2-005056c00008" + } + } } diff --git a/_assets/simulator/spec/methods/crm.requisite.bankdetail.add.json b/_assets/simulator/spec/methods/crm.requisite.bankdetail.add.json index fb66a8843..213c86aaa 100644 --- a/_assets/simulator/spec/methods/crm.requisite.bankdetail.add.json +++ b/_assets/simulator/spec/methods/crm.requisite.bankdetail.add.json @@ -257,5 +257,21 @@ } ], "page": "/api-reference/crm/requisites/bank-detail/crm-requisite-bank-detail-add.html", - "executable": false + "executable": false, + "requestExample": { + "fields": { + "ENTITY_ID": 27, + "COUNTRY_ID": 1, + "NAME": "Супербанк", + "RQ_BANK_NAME": "ПАО Супербанк", + "RQ_BANK_ADDR": "117312, г. Москва, улица Вавилова, дом 19", + "RQ_BIK": "044525225", + "RQ_ACC_NUM": "40702810938000060473", + "RQ_ACC_CURRENCY": "RUR", + "RQ_COR_ACC_NUM": "30101810400000000225", + "XML_ID": "1e4641fd-2dd9-31e6-b2f2-105056c00008", + "ACTIVE": "Y", + "SORT": 600 + } + } } diff --git a/_assets/simulator/spec/methods/crm.requisite.bankdetail.delete.json b/_assets/simulator/spec/methods/crm.requisite.bankdetail.delete.json index 0454f84de..e30fcd139 100644 --- a/_assets/simulator/spec/methods/crm.requisite.bankdetail.delete.json +++ b/_assets/simulator/spec/methods/crm.requisite.bankdetail.delete.json @@ -49,5 +49,8 @@ } ], "page": "/api-reference/crm/requisites/bank-detail/crm-requisite-bank-detail-delete.html", - "executable": false + "executable": false, + "requestExample": { + "id": 357 + } } diff --git a/_assets/simulator/spec/methods/crm.requisite.bankdetail.get.json b/_assets/simulator/spec/methods/crm.requisite.bankdetail.get.json index bb7e2199b..4ae19c382 100644 --- a/_assets/simulator/spec/methods/crm.requisite.bankdetail.get.json +++ b/_assets/simulator/spec/methods/crm.requisite.bankdetail.get.json @@ -118,5 +118,8 @@ "RQ_SWIFT", "SORT", "XML_ID" - ] + ], + "requestExample": { + "id": 357 + } } diff --git a/_assets/simulator/spec/methods/crm.requisite.bankdetail.list.json b/_assets/simulator/spec/methods/crm.requisite.bankdetail.list.json index 8093dfb4b..109a9490e 100644 --- a/_assets/simulator/spec/methods/crm.requisite.bankdetail.list.json +++ b/_assets/simulator/spec/methods/crm.requisite.bankdetail.list.json @@ -157,5 +157,18 @@ "RQ_SWIFT", "SORT", "XML_ID" - ] + ], + "requestExample": { + "order": { + "DATE_CREATE": "ASC" + }, + "filter": { + "COUNTRY_ID": "1" + }, + "select": [ + "ENTITY_ID", + "ID", + "NAME" + ] + } } diff --git a/_assets/simulator/spec/methods/crm.requisite.bankdetail.update.json b/_assets/simulator/spec/methods/crm.requisite.bankdetail.update.json index c7813f40a..676766157 100644 --- a/_assets/simulator/spec/methods/crm.requisite.bankdetail.update.json +++ b/_assets/simulator/spec/methods/crm.requisite.bankdetail.update.json @@ -250,5 +250,14 @@ } ], "page": "/api-reference/crm/requisites/bank-detail/crm-requisite-bank-detail-update.html", - "executable": false + "executable": false, + "requestExample": { + "id": 357, + "fields": { + "NAME": "ПАО Супербанк (не использовать)", + "COMMENTS": "Устаревший", + "SORT": 10000, + "ACTIVE": "N" + } + } } diff --git a/_assets/simulator/spec/methods/crm.requisite.delete.json b/_assets/simulator/spec/methods/crm.requisite.delete.json index ac412d651..a8dab95b0 100644 --- a/_assets/simulator/spec/methods/crm.requisite.delete.json +++ b/_assets/simulator/spec/methods/crm.requisite.delete.json @@ -49,5 +49,8 @@ } ], "page": "/api-reference/crm/requisites/universal/crm-requisite-delete.html", - "executable": false + "executable": false, + "requestExample": { + "id": 27 + } } diff --git a/_assets/simulator/spec/methods/crm.requisite.get.json b/_assets/simulator/spec/methods/crm.requisite.get.json index 11be01fe6..11c3327f6 100644 --- a/_assets/simulator/spec/methods/crm.requisite.get.json +++ b/_assets/simulator/spec/methods/crm.requisite.get.json @@ -202,5 +202,8 @@ "RQ_VAT_PAYER", "SORT", "XML_ID" - ] + ], + "requestExample": { + "id": 27 + } } diff --git a/_assets/simulator/spec/methods/crm.requisite.link.get.json b/_assets/simulator/spec/methods/crm.requisite.link.get.json index 02c7e481c..caba472c9 100644 --- a/_assets/simulator/spec/methods/crm.requisite.link.get.json +++ b/_assets/simulator/spec/methods/crm.requisite.link.get.json @@ -71,5 +71,9 @@ "MC_BANK_DETAIL_ID", "MC_REQUISITE_ID", "REQUISITE_ID" - ] + ], + "requestExample": { + "entityTypeId": 31, + "entityId": 315 + } } diff --git a/_assets/simulator/spec/methods/crm.requisite.link.list.json b/_assets/simulator/spec/methods/crm.requisite.link.list.json index 1af6f63e0..3ddcf3f93 100644 --- a/_assets/simulator/spec/methods/crm.requisite.link.list.json +++ b/_assets/simulator/spec/methods/crm.requisite.link.list.json @@ -173,5 +173,18 @@ "MC_BANK_DETAIL_ID", "MC_REQUISITE_ID", "REQUISITE_ID" - ] + ], + "requestExample": { + "order": { + "ENTITY_ID": "ASC" + }, + "filter": { + "@ENTITY_TYPE_ID": [ + 1, + 2, + 7, + 31 + ] + } + } } diff --git a/_assets/simulator/spec/methods/crm.requisite.link.register.json b/_assets/simulator/spec/methods/crm.requisite.link.register.json index a4b89af33..f3d3355d8 100644 --- a/_assets/simulator/spec/methods/crm.requisite.link.register.json +++ b/_assets/simulator/spec/methods/crm.requisite.link.register.json @@ -102,5 +102,15 @@ } ], "page": "/api-reference/crm/requisites/links/crm-requisite-link-register.html", - "executable": false + "executable": false, + "requestExample": { + "fields": { + "ENTITY_TYPE_ID": 31, + "ENTITY_ID": 315, + "REQUISITE_ID": 60, + "BANK_DETAIL_ID": 24, + "MC_REQUISITE_ID": 2, + "MC_BANK_DETAIL_ID": 2 + } + } } diff --git a/_assets/simulator/spec/methods/crm.requisite.link.unregister.json b/_assets/simulator/spec/methods/crm.requisite.link.unregister.json index 69a63d747..09d3b4cb0 100644 --- a/_assets/simulator/spec/methods/crm.requisite.link.unregister.json +++ b/_assets/simulator/spec/methods/crm.requisite.link.unregister.json @@ -56,5 +56,9 @@ } ], "page": "/api-reference/crm/requisites/links/crm-requisite-link-unregister.html", - "executable": false + "executable": false, + "requestExample": { + "entityTypeId": 31, + "entityId": 315 + } } diff --git a/_assets/simulator/spec/methods/crm.requisite.list.json b/_assets/simulator/spec/methods/crm.requisite.list.json index 1119a7588..f3c48c743 100644 --- a/_assets/simulator/spec/methods/crm.requisite.list.json +++ b/_assets/simulator/spec/methods/crm.requisite.list.json @@ -87,5 +87,19 @@ } ], "page": "/api-reference/crm/requisites/universal/crm-requisite-list.html", - "executable": false + "executable": false, + "requestExample": { + "order": { + "DATE_CREATE": "ASC" + }, + "filter": { + "PRESET_ID": "1" + }, + "select": [ + "ENTITY_TYPE_ID", + "ENTITY_ID", + "ID", + "NAME" + ] + } } diff --git a/_assets/simulator/spec/methods/crm.requisite.preset.add.json b/_assets/simulator/spec/methods/crm.requisite.preset.add.json index 762d900de..73b1a02e6 100644 --- a/_assets/simulator/spec/methods/crm.requisite.preset.add.json +++ b/_assets/simulator/spec/methods/crm.requisite.preset.add.json @@ -103,5 +103,15 @@ } ], "page": "/api-reference/crm/requisites/presets/crm-requisite-preset-add.html", - "executable": false + "executable": false, + "requestExample": { + "fields": { + "ENTITY_TYPE_ID": 8, + "COUNTRY_ID": 1, + "NAME": "ИП", + "XML_ID": "EXAMPLE_COMPANY__VALUE_1", + "ACTIVE": "Y", + "SORT": 520 + } + } } diff --git a/_assets/simulator/spec/methods/crm.requisite.preset.delete.json b/_assets/simulator/spec/methods/crm.requisite.preset.delete.json index 3a5a9a94b..aaae242b7 100644 --- a/_assets/simulator/spec/methods/crm.requisite.preset.delete.json +++ b/_assets/simulator/spec/methods/crm.requisite.preset.delete.json @@ -49,5 +49,8 @@ } ], "page": "/api-reference/crm/requisites/presets/crm-requisite-preset-delete.html", - "executable": false + "executable": false, + "requestExample": { + "id": 347 + } } diff --git a/_assets/simulator/spec/methods/crm.requisite.preset.field.add.json b/_assets/simulator/spec/methods/crm.requisite.preset.field.add.json index 7ff96c010..acd4696f6 100644 --- a/_assets/simulator/spec/methods/crm.requisite.preset.field.add.json +++ b/_assets/simulator/spec/methods/crm.requisite.preset.field.add.json @@ -100,5 +100,16 @@ } ], "page": "/api-reference/crm/requisites/presets/fields/crm-requisite-preset-field-add.html", - "executable": false + "executable": false, + "requestExample": { + "preset": { + "ID": 27 + }, + "fields": { + "FIELD_NAME": "RQ_NAME", + "FIELD_TITLE": "TEST", + "IN_SHORT_LIST": "N", + "SORT": 580 + } + } } diff --git a/_assets/simulator/spec/methods/crm.requisite.preset.field.availabletoadd.json b/_assets/simulator/spec/methods/crm.requisite.preset.field.availabletoadd.json index 54fd8308f..0866dd98b 100644 --- a/_assets/simulator/spec/methods/crm.requisite.preset.field.availabletoadd.json +++ b/_assets/simulator/spec/methods/crm.requisite.preset.field.availabletoadd.json @@ -81,5 +81,10 @@ } ], "page": "/api-reference/crm/requisites/presets/fields/crm-requisite-preset-field-available-to-add.html", - "executable": false + "executable": false, + "requestExample": { + "preset": { + "ID": 27 + } + } } diff --git a/_assets/simulator/spec/methods/crm.requisite.preset.field.list.json b/_assets/simulator/spec/methods/crm.requisite.preset.field.list.json index 496af707c..a88344fd4 100644 --- a/_assets/simulator/spec/methods/crm.requisite.preset.field.list.json +++ b/_assets/simulator/spec/methods/crm.requisite.preset.field.list.json @@ -173,5 +173,10 @@ "ID", "IN_SHORT_LIST", "SORT" - ] + ], + "requestExample": { + "preset": { + "ID": 27 + } + } } diff --git a/_assets/simulator/spec/methods/crm.requisite.preset.get.json b/_assets/simulator/spec/methods/crm.requisite.preset.get.json index 4661d73f5..55e9def79 100644 --- a/_assets/simulator/spec/methods/crm.requisite.preset.get.json +++ b/_assets/simulator/spec/methods/crm.requisite.preset.get.json @@ -74,5 +74,8 @@ "NAME", "SORT", "XML_ID" - ] + ], + "requestExample": { + "id": 347 + } } diff --git a/_assets/simulator/spec/methods/crm.requisite.preset.list.json b/_assets/simulator/spec/methods/crm.requisite.preset.list.json index 6f2d661c2..ad40e8b2b 100644 --- a/_assets/simulator/spec/methods/crm.requisite.preset.list.json +++ b/_assets/simulator/spec/methods/crm.requisite.preset.list.json @@ -126,5 +126,17 @@ "NAME", "SORT", "XML_ID" - ] + ], + "requestExample": { + "order": { + "ID": "ASC" + }, + "filter": { + "COUNTRY_ID": "1" + }, + "select": [ + "ID", + "NAME" + ] + } } diff --git a/_assets/simulator/spec/methods/crm.requisite.preset.update.json b/_assets/simulator/spec/methods/crm.requisite.preset.update.json index 4cf6abda4..377ce9b37 100644 --- a/_assets/simulator/spec/methods/crm.requisite.preset.update.json +++ b/_assets/simulator/spec/methods/crm.requisite.preset.update.json @@ -96,5 +96,12 @@ } ], "page": "/api-reference/crm/requisites/presets/crm-requisite-preset-update.html", - "executable": false + "executable": false, + "requestExample": { + "id": 347, + "fields": { + "NAME": "ИП (архив)", + "ACTIVE": "N" + } + } } diff --git a/_assets/simulator/spec/methods/crm.requisite.update.json b/_assets/simulator/spec/methods/crm.requisite.update.json index ff7bcad99..ad6ac4f5d 100644 --- a/_assets/simulator/spec/methods/crm.requisite.update.json +++ b/_assets/simulator/spec/methods/crm.requisite.update.json @@ -60,5 +60,14 @@ } ], "page": "/api-reference/crm/requisites/universal/crm-requisite-update.html", - "executable": false + "executable": false, + "requestExample": { + "id": 27, + "fields": { + "RQ_OKPO": "80715150", + "RQ_OKTMO": "45381000000", + "UF_CRM_1707997209": "78", + "UF_CRM_1708012333": "Категория 3" + } + } } diff --git a/_assets/simulator/spec/methods/crm.requisite.userfield.add.json b/_assets/simulator/spec/methods/crm.requisite.userfield.add.json index ee94e9b7d..9cb5a34af 100644 --- a/_assets/simulator/spec/methods/crm.requisite.userfield.add.json +++ b/_assets/simulator/spec/methods/crm.requisite.userfield.add.json @@ -260,5 +260,20 @@ } ], "page": "/api-reference/crm/requisites/user-fields/crm-requisite-userfield-add.html", - "executable": false + "executable": false, + "requestExample": { + "fields": { + "USER_TYPE_ID": "string", + "ENTITY_ID": "CRM_REQUISITE", + "SORT": 100, + "MULTIPLE": "N", + "MANDATORY": "N", + "SHOW_FILTER": "E", + "SHOW_IN_LIST": "Y", + "EDIT_FORM_LABEL": "ПП - Строка", + "LIST_COLUMN_LABEL": "ПП - Строка", + "LIST_FILTER_LABEL": "ПП - Строка", + "FIELD_NAME": "NEWTECH_v1_STRING" + } + } } diff --git a/_assets/simulator/spec/methods/crm.requisite.userfield.delete.json b/_assets/simulator/spec/methods/crm.requisite.userfield.delete.json index ad30e2268..0f638a53f 100644 --- a/_assets/simulator/spec/methods/crm.requisite.userfield.delete.json +++ b/_assets/simulator/spec/methods/crm.requisite.userfield.delete.json @@ -49,5 +49,8 @@ } ], "page": "/api-reference/crm/requisites/user-fields/crm-requisite-userfield-delete.html", - "executable": false + "executable": false, + "requestExample": { + "id": 235 + } } diff --git a/_assets/simulator/spec/methods/crm.requisite.userfield.get.json b/_assets/simulator/spec/methods/crm.requisite.userfield.get.json index 13f4fe6c2..4f5eb0cd7 100644 --- a/_assets/simulator/spec/methods/crm.requisite.userfield.get.json +++ b/_assets/simulator/spec/methods/crm.requisite.userfield.get.json @@ -110,5 +110,8 @@ "SORT", "USER_TYPE_ID", "XML_ID" - ] + ], + "requestExample": { + "id": 235 + } } diff --git a/_assets/simulator/spec/methods/crm.requisite.userfield.list.json b/_assets/simulator/spec/methods/crm.requisite.userfield.list.json index 983c997b0..2778340ad 100644 --- a/_assets/simulator/spec/methods/crm.requisite.userfield.list.json +++ b/_assets/simulator/spec/methods/crm.requisite.userfield.list.json @@ -212,5 +212,14 @@ "SORT", "USER_TYPE_ID", "XML_ID" - ] + ], + "requestExample": { + "order": { + "SORT": "ASC" + }, + "filter": { + "MANDATORY": "N", + "LANG": "ru" + } + } } diff --git a/_assets/simulator/spec/methods/crm.requisite.userfield.update.json b/_assets/simulator/spec/methods/crm.requisite.userfield.update.json index 0b56a3599..819cefe29 100644 --- a/_assets/simulator/spec/methods/crm.requisite.userfield.update.json +++ b/_assets/simulator/spec/methods/crm.requisite.userfield.update.json @@ -246,5 +246,13 @@ } ], "page": "/api-reference/crm/requisites/user-fields/crm-requisite-userfield-update.html", - "executable": false + "executable": false, + "requestExample": { + "id": 235, + "fields": { + "EDIT_FORM_LABEL": "Категория", + "LIST_COLUMN_LABEL": "Категория", + "LIST_FILTER_LABEL": "Категория" + } + } } diff --git a/_assets/simulator/spec/methods/crm.settings.mode.get.json b/_assets/simulator/spec/methods/crm.settings.mode.get.json index 164b528d9..aee4b7eae 100644 --- a/_assets/simulator/spec/methods/crm.settings.mode.get.json +++ b/_assets/simulator/spec/methods/crm.settings.mode.get.json @@ -11,7 +11,7 @@ "type": "integer", "base": "integer", "required": "unknown", - "description": "Возвращает значение, определённое в crm.enum.settings.mode" + "description": "Идентификатор текущего режима работы CRM. Возможные значения описаны ниже" }, { "name": "time", @@ -48,7 +48,7 @@ "type": "integer", "base": "integer", "required": "unknown", - "description": "Возвращает значение, определённое в crm.enum.settings.mode" + "description": "Идентификатор текущего режима работы CRM. Возможные значения описаны ниже" }, { "name": "time", diff --git a/_assets/simulator/spec/methods/crm.stagehistory.list.json b/_assets/simulator/spec/methods/crm.stagehistory.list.json index 01a1833b2..3efd06d66 100644 --- a/_assets/simulator/spec/methods/crm.stagehistory.list.json +++ b/_assets/simulator/spec/methods/crm.stagehistory.list.json @@ -111,5 +111,19 @@ "STAGE_ID", "STAGE_SEMANTIC_ID", "TYPE_ID" - ] + ], + "requestExample": { + "entityTypeId": 2, + "order": { + "ID": "ASC" + }, + "filter": { + "OWNER_ID": 1 + }, + "select": [ + "ID", + "STAGE_ID", + "CREATED_TIME" + ] + } } diff --git a/_assets/simulator/spec/methods/crm.status.add.json b/_assets/simulator/spec/methods/crm.status.add.json index a33afd068..0c070219d 100644 --- a/_assets/simulator/spec/methods/crm.status.add.json +++ b/_assets/simulator/spec/methods/crm.status.add.json @@ -103,5 +103,14 @@ } ], "page": "/api-reference/crm/status/crm-status-add.html", - "executable": false + "executable": false, + "requestExample": { + "fields": { + "ENTITY_ID": "DEAL_STAGE_1", + "STATUS_ID": "DECISION", + "NAME": "Принятие решения", + "SORT": 70, + "COLOR": "#FFA900" + } + } } diff --git a/_assets/simulator/spec/methods/crm.status.delete.json b/_assets/simulator/spec/methods/crm.status.delete.json index 47ac12782..ca53eb275 100644 --- a/_assets/simulator/spec/methods/crm.status.delete.json +++ b/_assets/simulator/spec/methods/crm.status.delete.json @@ -57,5 +57,8 @@ } ], "page": "/api-reference/crm/status/crm-status-delete.html", - "executable": false + "executable": false, + "requestExample": { + "id": 123 + } } diff --git a/_assets/simulator/spec/methods/crm.status.entity.items.json b/_assets/simulator/spec/methods/crm.status.entity.items.json index a225dd860..3bfa11bbd 100644 --- a/_assets/simulator/spec/methods/crm.status.entity.items.json +++ b/_assets/simulator/spec/methods/crm.status.entity.items.json @@ -91,5 +91,8 @@ } ], "page": "/api-reference/crm/status/crm-status-entity-items.html", - "executable": false + "executable": false, + "requestExample": { + "entityId": "DEAL_STAGE" + } } diff --git a/_assets/simulator/spec/methods/crm.status.entity.types.json b/_assets/simulator/spec/methods/crm.status.entity.types.json index 84480e17b..7bb099455 100644 --- a/_assets/simulator/spec/methods/crm.status.entity.types.json +++ b/_assets/simulator/spec/methods/crm.status.entity.types.json @@ -52,5 +52,6 @@ } ], "page": "/api-reference/crm/status/crm-status-entity-types.html", - "executable": false + "executable": false, + "requestExample": {} } diff --git a/_assets/simulator/spec/methods/crm.status.fields.json b/_assets/simulator/spec/methods/crm.status.fields.json index 6500787a9..20d00b3d8 100644 --- a/_assets/simulator/spec/methods/crm.status.fields.json +++ b/_assets/simulator/spec/methods/crm.status.fields.json @@ -165,5 +165,6 @@ } ], "page": "/api-reference/crm/status/crm-status-fields.html", - "executable": false + "executable": false, + "requestExample": {} } diff --git a/_assets/simulator/spec/methods/crm.status.get.json b/_assets/simulator/spec/methods/crm.status.get.json index 25199acc0..c8d71e750 100644 --- a/_assets/simulator/spec/methods/crm.status.get.json +++ b/_assets/simulator/spec/methods/crm.status.get.json @@ -136,5 +136,8 @@ "SORT", "STATUS_ID", "SYSTEM" - ] + ], + "requestExample": { + "id": 123 + } } diff --git a/_assets/simulator/spec/methods/crm.status.list.json b/_assets/simulator/spec/methods/crm.status.list.json index 77a1e690d..e0c3d2a11 100644 --- a/_assets/simulator/spec/methods/crm.status.list.json +++ b/_assets/simulator/spec/methods/crm.status.list.json @@ -215,5 +215,27 @@ "SORT", "STATUS_ID", "SYSTEM" - ] + ], + "requestExample": { + "order": { + "SORT": "ASC" + }, + "filter": { + "ENTITY_ID": "DEAL_STAGE" + } + }, + "datasetHint": { + "entity": "statuses", + "count": 23, + "idFrom": 100, + "idTo": 122, + "runnableExample": { + "order": { + "SORT": "ASC" + }, + "filter": { + "ENTITY_ID": "DEAL_STAGE" + } + } + } } diff --git a/_assets/simulator/spec/methods/crm.status.update.json b/_assets/simulator/spec/methods/crm.status.update.json index 493c97a3d..37d42f8bc 100644 --- a/_assets/simulator/spec/methods/crm.status.update.json +++ b/_assets/simulator/spec/methods/crm.status.update.json @@ -89,5 +89,12 @@ } ], "page": "/api-reference/crm/status/crm-status-update.html", - "executable": false + "executable": false, + "requestExample": { + "id": 123, + "fields": { + "NAME": "Новое название", + "COLOR": "#00A9F4" + } + } } diff --git a/_assets/simulator/spec/methods/crm.timeline.bindings.bind.json b/_assets/simulator/spec/methods/crm.timeline.bindings.bind.json index 80dc0c596..94e7be3d6 100644 --- a/_assets/simulator/spec/methods/crm.timeline.bindings.bind.json +++ b/_assets/simulator/spec/methods/crm.timeline.bindings.bind.json @@ -4,7 +4,7 @@ "scope": "crm", "kind": "write", "title": "Добавить связь записи таймлайна с элементом CRM crm.timeline.bindings.bind", - "permissions": "любой пользователь", + "permissions": "пользователь с правом на изменение элемента CRM, с которым связывается запись", "params": [ { "name": "fields", @@ -28,21 +28,21 @@ "type": "integer", "base": "integer", "required": true, - "description": "Идентификатор записи таймлайна" + "description": "Идентификатор записи таймлайна. Возьмите его из ответа метода crm.timeline.comment.add или crm.timeline.logmessage.add либо получите из списка методом crm.timeline.comment.list или crm.timeline.logmessage.list" }, { "name": "ENTITY_ID", "type": "integer", "base": "integer", "required": true, - "description": "Идентификатор элемента CRM, к которому привязана запись таймлайна" + "description": "Идентификатор элемента CRM, с которым связывается запись таймлайна" }, { "name": "ENTITY_TYPE", "type": "string", "base": "string", "required": true, - "description": "Тип элемента CRM, к которому привязана запись таймлайна. Возможные значения: - lead — лид - deal — сделка - contact — контакт - company — компания - order — заказ", + "description": "Символьный код типа объекта CRM entityTypeName, с которым связывается запись таймлайна. Регистр значения не важен. Возможные значения: - lead — лид - deal — сделка - contact — контакт - company — компания - quote — предложение - smart_invoice — счет - order — заказ - activity — дело - invoice — счет в старом формате - order_payment — оплата заказа - order_shipment — отгрузка заказа - dynamic_=CREATE_TIME": "2026-01-12" + }, + "order": { + "NAME": "DESC" + } + } } diff --git a/_assets/simulator/spec/methods/disk.folder.getExternalLink.json b/_assets/simulator/spec/methods/disk.folder.getExternalLink.json index f0ef93d98..071c111ef 100644 --- a/_assets/simulator/spec/methods/disk.folder.getExternalLink.json +++ b/_assets/simulator/spec/methods/disk.folder.getExternalLink.json @@ -50,5 +50,8 @@ } ], "page": "/api-reference/disk/folder/disk-folder-get-external-link.html", - "executable": false + "executable": false, + "requestExample": { + "id": 8930 + } } diff --git a/_assets/simulator/spec/methods/disk.folder.getFields.json b/_assets/simulator/spec/methods/disk.folder.getFields.json index 4c3f0d600..6f77f978a 100644 --- a/_assets/simulator/spec/methods/disk.folder.getFields.json +++ b/_assets/simulator/spec/methods/disk.folder.getFields.json @@ -332,5 +332,6 @@ } ], "page": "/api-reference/disk/folder/disk-folder-get-fields.html", - "executable": false + "executable": false, + "requestExample": {} } diff --git a/_assets/simulator/spec/methods/disk.folder.markDeleted.json b/_assets/simulator/spec/methods/disk.folder.markDeleted.json index e7e1ed343..788314ae7 100644 --- a/_assets/simulator/spec/methods/disk.folder.markDeleted.json +++ b/_assets/simulator/spec/methods/disk.folder.markDeleted.json @@ -185,5 +185,8 @@ } ], "page": "/api-reference/disk/folder/disk-folder-mark-deleted.html", - "executable": false + "executable": false, + "requestExample": { + "id": 8996 + } } diff --git a/_assets/simulator/spec/methods/disk.folder.moveTo.json b/_assets/simulator/spec/methods/disk.folder.moveTo.json index 581b59d4c..7edbc2652 100644 --- a/_assets/simulator/spec/methods/disk.folder.moveTo.json +++ b/_assets/simulator/spec/methods/disk.folder.moveTo.json @@ -192,5 +192,9 @@ } ], "page": "/api-reference/disk/folder/disk-folder-move-to.html", - "executable": false + "executable": false, + "requestExample": { + "id": 8968, + "targetFolderId": 8907 + } } diff --git a/_assets/simulator/spec/methods/disk.folder.rename.json b/_assets/simulator/spec/methods/disk.folder.rename.json index 4d014c63d..05912d288 100644 --- a/_assets/simulator/spec/methods/disk.folder.rename.json +++ b/_assets/simulator/spec/methods/disk.folder.rename.json @@ -192,5 +192,9 @@ } ], "page": "/api-reference/disk/folder/disk-folder-rename.html", - "executable": false + "executable": false, + "requestExample": { + "id": 8968, + "newName": "Новое имя папки" + } } diff --git a/_assets/simulator/spec/methods/disk.folder.restore.json b/_assets/simulator/spec/methods/disk.folder.restore.json index cba27ff93..b364f57b1 100644 --- a/_assets/simulator/spec/methods/disk.folder.restore.json +++ b/_assets/simulator/spec/methods/disk.folder.restore.json @@ -185,5 +185,8 @@ } ], "page": "/api-reference/disk/folder/disk-folder-restore.html", - "executable": false + "executable": false, + "requestExample": { + "id": 8996 + } } diff --git a/_assets/simulator/spec/methods/disk.folder.shareToUser.json b/_assets/simulator/spec/methods/disk.folder.shareToUser.json index 5fbdfd14a..c2dbf7cea 100644 --- a/_assets/simulator/spec/methods/disk.folder.shareToUser.json +++ b/_assets/simulator/spec/methods/disk.folder.shareToUser.json @@ -82,5 +82,10 @@ } ], "page": "/api-reference/disk/folder/disk-folder-share-to-user.html", - "executable": false + "executable": false, + "requestExample": { + "id": 8994, + "userId": 1271, + "taskName": "disk_access_read" + } } diff --git a/_assets/simulator/spec/methods/disk.folder.uploadFile.json b/_assets/simulator/spec/methods/disk.folder.uploadFile.json index f5145a25b..dfb36efe6 100644 --- a/_assets/simulator/spec/methods/disk.folder.uploadFile.json +++ b/_assets/simulator/spec/methods/disk.folder.uploadFile.json @@ -40,7 +40,7 @@ "type": "array", "base": "array", "required": false, - "description": "Массив прав доступа на загружаемый файл в формате {\"TASK_ID\": 42, \"ACCESS_CODE\": \"U35\"}, где - TASK_ID — идентификатор уровня доступа - ACCESS_CODE — код доступа, состоящий из буквенного кода пользователя или отдела и идентификатора Категории пользователей: - U — пользователь - * — все пользователи - D — все сотрудники отдела - DR — все сотрудники отдела с подотделами Список доступных идентификато…", + "description": "Массив прав доступа на загружаемый файл. Каждый элемент содержит: - ACCESS_CODE — непустая строка длиной до 50 символов с кодом получателя права, например U35 - TASK_ID — целочисленный идентификатор существующего уровня доступа - NEGATIVE — необязательный логический признак запрещающего права.…", "dynamic": { "allowed": true, "note": "Состав полей не описан подтаблицей на этой странице" @@ -259,5 +259,22 @@ } ], "page": "/api-reference/disk/folder/disk-folder-upload-file.html", - "executable": false + "executable": false, + "requestExample": { + "id": 8930, + "data": { + "NAME": "test.png" + }, + "fileContent": [ + "test.png", + "iVBORw0KGgoAAAANSUhEUgAAAD4AAABDCAYAAADEfbZbAAAACXBIWXMAABJ0AAASdAHeZh94...rk5CYII=" + ], + "generateUniqueName": true, + "rights": [ + { + "TASK_ID": 75, + "ACCESS_CODE": "U1271" + } + ] + } } diff --git a/_assets/simulator/spec/methods/disk.rights.getTasks.json b/_assets/simulator/spec/methods/disk.rights.getTasks.json index 7bd748308..8be95da6e 100644 --- a/_assets/simulator/spec/methods/disk.rights.getTasks.json +++ b/_assets/simulator/spec/methods/disk.rights.getTasks.json @@ -123,5 +123,6 @@ } ], "page": "/api-reference/disk/rights/disk-rights-get-tasks.html", - "executable": false + "executable": false, + "requestExample": {} } diff --git a/_assets/simulator/spec/methods/disk.storage.addFolder.json b/_assets/simulator/spec/methods/disk.storage.addFolder.json index ed29fdd18..01da0eda7 100644 --- a/_assets/simulator/spec/methods/disk.storage.addFolder.json +++ b/_assets/simulator/spec/methods/disk.storage.addFolder.json @@ -29,7 +29,7 @@ "type": "array", "base": "array", "required": false, - "description": "Массив прав доступа на папку в формате {\"TASK_ID\": 42, \"ACCESS_CODE\": \"U35\"}, где - TASK_ID — идентификатор уровня доступа - ACCESS_CODE — код доступа, состоящий из буквенного кода пользователя или отдела и идентификатора Категории пользователей: - U — пользователь - * — все пользователи - D — все сотрудники отдела - DR — все сотрудники отдела с подотделами Список доступных идентификаторов TASK_ID…", + "description": "Массив прав доступа на папку. Каждый элемент содержит: - ACCESS_CODE — непустая строка длиной до 50 символов с кодом получателя права, например U35 - TASK_ID — целочисленный идентификатор существующего уровня доступа - NEGATIVE — необязательный логический признак запрещающего права.…", "dynamic": { "allowed": true, "note": "Состав полей не описан подтаблицей на этой странице" @@ -207,5 +207,17 @@ } ], "page": "/api-reference/disk/storage/disk-storage-add-folder.html", - "executable": false + "executable": false, + "requestExample": { + "id": 1357, + "data": { + "NAME": "Новая папка" + }, + "rights": [ + { + "TASK_ID": 71, + "ACCESS_CODE": "U1271" + } + ] + } } diff --git a/_assets/simulator/spec/methods/disk.storage.get.json b/_assets/simulator/spec/methods/disk.storage.get.json index 1dae312d0..b4b337dee 100644 --- a/_assets/simulator/spec/methods/disk.storage.get.json +++ b/_assets/simulator/spec/methods/disk.storage.get.json @@ -130,5 +130,8 @@ "MODULE_ID", "NAME", "ROOT_OBJECT_ID" - ] + ], + "requestExample": { + "id": 1357 + } } diff --git a/_assets/simulator/spec/methods/disk.storage.getChildren.json b/_assets/simulator/spec/methods/disk.storage.getChildren.json index 7bf0d9dfd..6c6b73fc9 100644 --- a/_assets/simulator/spec/methods/disk.storage.getChildren.json +++ b/_assets/simulator/spec/methods/disk.storage.getChildren.json @@ -286,5 +286,14 @@ } ], "page": "/api-reference/disk/storage/disk-storage-get-children.html", - "executable": false + "executable": false, + "requestExample": { + "id": 1357, + "filter": { + "NAME": "%Папка%" + }, + "order": { + "NAME": "DESC" + } + } } diff --git a/_assets/simulator/spec/methods/disk.storage.getFields.json b/_assets/simulator/spec/methods/disk.storage.getFields.json index 0d3f02a84..140d25149 100644 --- a/_assets/simulator/spec/methods/disk.storage.getFields.json +++ b/_assets/simulator/spec/methods/disk.storage.getFields.json @@ -227,5 +227,6 @@ } ], "page": "/api-reference/disk/storage/disk-storage-get-fields.html", - "executable": false + "executable": false, + "requestExample": {} } diff --git a/_assets/simulator/spec/methods/disk.storage.getList.json b/_assets/simulator/spec/methods/disk.storage.getList.json index ab353a2f1..a269c62d5 100644 --- a/_assets/simulator/spec/methods/disk.storage.getList.json +++ b/_assets/simulator/spec/methods/disk.storage.getList.json @@ -162,5 +162,13 @@ } ], "page": "/api-reference/disk/storage/disk-storage-get-list.html", - "executable": false + "executable": false, + "requestExample": { + "filter": { + "NAME": "%Битрикс24%" + }, + "order": { + "NAME": "DESC" + } + } } diff --git a/_assets/simulator/spec/methods/disk.storage.getTypes.json b/_assets/simulator/spec/methods/disk.storage.getTypes.json index 9c7f59c86..a8b939fab 100644 --- a/_assets/simulator/spec/methods/disk.storage.getTypes.json +++ b/_assets/simulator/spec/methods/disk.storage.getTypes.json @@ -69,5 +69,6 @@ } ], "page": "/api-reference/disk/storage/disk-storage-get-types.html", - "executable": false + "executable": false, + "requestExample": {} } diff --git a/_assets/simulator/spec/methods/disk.storage.uploadFile.json b/_assets/simulator/spec/methods/disk.storage.uploadFile.json index c0f867895..73c54b2a4 100644 --- a/_assets/simulator/spec/methods/disk.storage.uploadFile.json +++ b/_assets/simulator/spec/methods/disk.storage.uploadFile.json @@ -40,7 +40,7 @@ "type": "array", "base": "array", "required": false, - "description": "Массив прав доступа на загружаемый файл в формате {\"TASK_ID\": 42, \"ACCESS_CODE\": \"U35\"}, где - TASK_ID — идентификатор уровня доступа - ACCESS_CODE — код доступа, состоящий из буквенного кода пользователя или отдела и идентификатора Категории пользователей: - U — пользователь - * — все пользователи - D — все сотрудники отдела - DR — все сотрудники отдела с подотделами Список доступных идентификато…", + "description": "Массив прав доступа на загружаемый файл. Каждый элемент содержит: - ACCESS_CODE — непустая строка длиной до 50 символов с кодом получателя права, например U35 - TASK_ID — целочисленный идентификатор существующего уровня доступа - NEGATIVE — необязательный логический признак запрещающего права.…", "dynamic": { "allowed": true, "note": "Состав полей не описан подтаблицей на этой странице" @@ -259,5 +259,22 @@ } ], "page": "/api-reference/disk/storage/disk-storage-upload-file.html", - "executable": false + "executable": false, + "requestExample": { + "id": 1357, + "data": { + "NAME": "picture.png" + }, + "fileContent": [ + "picture.png", + "iVBORw0KGgoAAAANSUhEUgAAAD4AAABDCAYAAADEfbZbAAAACXBIWXMAABJ0AAASdAHeZh94...RK5CYII=" + ], + "generateUniqueName": true, + "rights": [ + { + "TASK_ID": 79, + "ACCESS_CODE": "U1271" + } + ] + } } diff --git a/_assets/simulator/spec/methods/disk.version.get.json b/_assets/simulator/spec/methods/disk.version.get.json index b0fc059ce..1773fd657 100644 --- a/_assets/simulator/spec/methods/disk.version.get.json +++ b/_assets/simulator/spec/methods/disk.version.get.json @@ -45,66 +45,10 @@ "returns": [ { "name": "result", - "type": "array", - "base": "array", - "required": false, - "description": "Массив с данными о версии" - }, - { - "name": "ID", - "type": "integer", - "base": "integer", - "required": false, - "description": "Идентификатор версии" - }, - { - "name": "OBJECT_ID", - "type": "integer", - "base": "integer", - "required": false, - "description": "Идентификатор файла, к которому принадлежит версия" - }, - { - "name": "SIZE", - "type": "integer", - "base": "integer", - "required": false, - "description": "Размер версии в байтах" - }, - { - "name": "NAME", - "type": "string", - "base": "string", - "required": false, - "description": "Название файла на момент создания версии" - }, - { - "name": "GLOBAL_CONTENT_VERSION", - "type": "integer", - "base": "integer", - "required": false, - "description": "Инкрементальный счетчик версии файла" - }, - { - "name": "CREATE_TIME", - "type": "string", - "base": "string", - "required": false, - "description": "Время создания версии" - }, - { - "name": "CREATED_BY", - "type": "integer", - "base": "integer", - "required": false, - "description": "Идентификатор пользователя, который создал версию" - }, - { - "name": "DOWNLOAD_URL", - "type": "string", - "base": "string", + "type": "object", + "base": "object", "required": false, - "description": "Ссылка на скачивание версии" + "description": "Объект с данными о версии (подробное описание)" }, { "name": "time", @@ -125,5 +69,8 @@ "NAME", "OBJECT_ID", "SIZE" - ] + ], + "requestExample": { + "id": 7169 + } } diff --git a/_assets/simulator/spec/methods/documentgenerator.document.delete.json b/_assets/simulator/spec/methods/documentgenerator.document.delete.json index 2834ab9fc..0a5edab8f 100644 --- a/_assets/simulator/spec/methods/documentgenerator.document.delete.json +++ b/_assets/simulator/spec/methods/documentgenerator.document.delete.json @@ -50,5 +50,8 @@ } ], "page": "/api-reference/document-generator/document-generator-document-delete.html", - "executable": false + "executable": false, + "requestExample": { + "id": 51 + } } diff --git a/_assets/simulator/spec/methods/documentgenerator.document.enablepublicurl.json b/_assets/simulator/spec/methods/documentgenerator.document.enablepublicurl.json index 738381151..90ebc5608 100644 --- a/_assets/simulator/spec/methods/documentgenerator.document.enablepublicurl.json +++ b/_assets/simulator/spec/methods/documentgenerator.document.enablepublicurl.json @@ -59,5 +59,9 @@ } ], "page": "/api-reference/document-generator/document-generator-document-enable-public-url.html", - "executable": false + "executable": false, + "requestExample": { + "id": 51, + "status": 1 + } } diff --git a/_assets/simulator/spec/methods/documentgenerator.document.get.json b/_assets/simulator/spec/methods/documentgenerator.document.get.json index 4518c3ae3..63a87ce6f 100644 --- a/_assets/simulator/spec/methods/documentgenerator.document.get.json +++ b/_assets/simulator/spec/methods/documentgenerator.document.get.json @@ -121,5 +121,8 @@ "updatedBy", "value", "values" - ] + ], + "requestExample": { + "id": 51 + } } diff --git a/_assets/simulator/spec/methods/documentgenerator.document.getfields.json b/_assets/simulator/spec/methods/documentgenerator.document.getfields.json index ffa7a8425..da0861048 100644 --- a/_assets/simulator/spec/methods/documentgenerator.document.getfields.json +++ b/_assets/simulator/spec/methods/documentgenerator.document.getfields.json @@ -111,5 +111,17 @@ } ], "page": "/api-reference/document-generator/document-generator-document-get-fields.html", - "executable": false + "executable": false, + "requestExample": { + "id": 51, + "values": { + "DocumentNumber": "ДГ-2026-001", + "CurrentDate": "2026-03-18T00:00:00+03:00", + "ClientName": "ООО Ромашка", + "ClientPhone": "+7 999 123-45-67", + "Total": "51000", + "Comment": "Оплата в течение 5 рабочих дней после подписания", + "UserName": "Иван Петров" + } + } } diff --git a/_assets/simulator/spec/methods/documentgenerator.document.list.json b/_assets/simulator/spec/methods/documentgenerator.document.list.json index e3f2ab0d7..7ec85f900 100644 --- a/_assets/simulator/spec/methods/documentgenerator.document.list.json +++ b/_assets/simulator/spec/methods/documentgenerator.document.list.json @@ -83,5 +83,30 @@ "PROVIDER", "TITLE", "TYPE" - ] + ], + "requestExample": { + "select": [ + "id", + "title", + "number", + "templateId", + "provider", + "value", + "fileId", + "imageId", + "pdfId", + "createTime", + "updateTime", + "createdBy" + ], + "order": { + "updateTime": "desc", + "id": "desc" + }, + "filter": { + ">=createTime": "2026-03-18T00:00:00+03:00", + "%title": "ДГ-2026" + }, + "start": 0 + } } diff --git a/_assets/simulator/spec/methods/documentgenerator.document.update.json b/_assets/simulator/spec/methods/documentgenerator.document.update.json index 5cea29ce7..56dfc6a75 100644 --- a/_assets/simulator/spec/methods/documentgenerator.document.update.json +++ b/_assets/simulator/spec/methods/documentgenerator.document.update.json @@ -154,5 +154,18 @@ } ], "page": "/api-reference/document-generator/document-generator-document-update.html", - "executable": false + "executable": false, + "requestExample": { + "id": 51, + "values": { + "DocumentNumber": "ДГ-2026-001", + "CurrentDate": "2026-03-20T00:00:00+03:00", + "ClientName": "ООО Ромашка", + "ClientPhone": "+7 999 123-45-67", + "Total": "130000", + "Comment": "Оплата в течение 3 рабочих дней после подписания", + "UserName": "Иван Петров" + }, + "stampsEnabled": 1 + } } diff --git a/_assets/simulator/spec/methods/documentgenerator.numerator.add.json b/_assets/simulator/spec/methods/documentgenerator.numerator.add.json index f4c5ad580..158f25b40 100644 --- a/_assets/simulator/spec/methods/documentgenerator.numerator.add.json +++ b/_assets/simulator/spec/methods/documentgenerator.numerator.add.json @@ -100,5 +100,22 @@ } ], "page": "/api-reference/document-generator/numerators/document-generator-numerator-add.html", - "executable": false + "executable": false, + "requestExample": { + "fields": { + "name": "REST Invoice Numerator", + "template": "INV-{NUMBER}", + "settings": { + "Bitrix_Main_Numerator_Generator_SequentNumberGenerator": { + "start": 1000, + "step": 5, + "length": 8, + "padString": "0", + "periodicBy": "year", + "timezone": "Europe/Moscow", + "isDirectNumeration": false + } + } + } + } } diff --git a/_assets/simulator/spec/methods/documentgenerator.numerator.delete.json b/_assets/simulator/spec/methods/documentgenerator.numerator.delete.json index d5ab3edb6..3180f433f 100644 --- a/_assets/simulator/spec/methods/documentgenerator.numerator.delete.json +++ b/_assets/simulator/spec/methods/documentgenerator.numerator.delete.json @@ -50,5 +50,8 @@ } ], "page": "/api-reference/document-generator/numerators/document-generator-numerator-delete.html", - "executable": false + "executable": false, + "requestExample": { + "id": 57 + } } diff --git a/_assets/simulator/spec/methods/documentgenerator.numerator.get.json b/_assets/simulator/spec/methods/documentgenerator.numerator.get.json index b126d62ca..9f3720c30 100644 --- a/_assets/simulator/spec/methods/documentgenerator.numerator.get.json +++ b/_assets/simulator/spec/methods/documentgenerator.numerator.get.json @@ -75,5 +75,8 @@ "name", "settings", "template" - ] + ], + "requestExample": { + "id": 55 + } } diff --git a/_assets/simulator/spec/methods/documentgenerator.numerator.list.json b/_assets/simulator/spec/methods/documentgenerator.numerator.list.json index ea7be0f3c..7b55b6663 100644 --- a/_assets/simulator/spec/methods/documentgenerator.numerator.list.json +++ b/_assets/simulator/spec/methods/documentgenerator.numerator.list.json @@ -20,6 +20,55 @@ "source": { "file": "api-reference/document-generator/numerators/document-generator-numerator-list.md" }, + "resultExample": { + "result": { + "numerators": [ + { + "id": "53", + "name": "Общий номер", + "template": "{NUMBER}", + "settings": { + "Bitrix_Main_Numerator_Generator_SequentNumberGenerator": { + "start": 1, + "step": 1, + "length": 0, + "padString": "0", + "periodicBy": null, + "timezone": null, + "isDirectNumeration": false + } + } + }, + { + "id": "55", + "name": "REST Invoice Numerator Updated", + "template": "INV-UPD-{NUMBER}", + "settings": { + "Bitrix_Main_Numerator_Generator_SequentNumberGenerator": { + "start": 2000, + "step": 10, + "length": 8, + "padString": "0", + "periodicBy": "year", + "timezone": "Europe/Moscow", + "isDirectNumeration": false + } + } + } + ] + }, + "total": 2, + "time": { + "start": 1774363478, + "finish": 1774363478.809978, + "duration": 0.8099780082702637, + "processing": 0, + "date_start": "2026-03-24T17:44:38+03:00", + "date_finish": "2026-03-24T17:44:38+03:00", + "operating_reset_at": 1774364078, + "operating": 0 + } + }, "returns": [ { "name": "result", @@ -33,7 +82,7 @@ "type": "integer", "base": "integer", "required": "unknown", - "description": "Количество нумераторов в текущей выборке" + "description": "Количество нумераторов на текущей странице. Поле не содержит общее количество записей во всей выборке" }, { "name": "time", @@ -46,8 +95,12 @@ "page": "/api-reference/document-generator/numerators/document-generator-numerator-list.html", "executable": false, "entityFields": [ + "id", "name", "settings", "template" - ] + ], + "requestExample": { + "start": 0 + } } diff --git a/_assets/simulator/spec/methods/documentgenerator.numerator.update.json b/_assets/simulator/spec/methods/documentgenerator.numerator.update.json index d7d6c9180..10badf968 100644 --- a/_assets/simulator/spec/methods/documentgenerator.numerator.update.json +++ b/_assets/simulator/spec/methods/documentgenerator.numerator.update.json @@ -105,5 +105,23 @@ } ], "page": "/api-reference/document-generator/numerators/document-generator-numerator-update.html", - "executable": false + "executable": false, + "requestExample": { + "id": 55, + "fields": { + "name": "REST Invoice Numerator Updated", + "template": "INV-UPD-{NUMBER}", + "settings": { + "Bitrix_Main_Numerator_Generator_SequentNumberGenerator": { + "start": 2000, + "step": 10, + "length": 8, + "padString": "0", + "periodicBy": "year", + "timezone": "Europe/Moscow", + "isDirectNumeration": false + } + } + } + } } diff --git a/_assets/simulator/spec/methods/documentgenerator.region.add.json b/_assets/simulator/spec/methods/documentgenerator.region.add.json index a35f2ce70..70e88af30 100644 --- a/_assets/simulator/spec/methods/documentgenerator.region.add.json +++ b/_assets/simulator/spec/methods/documentgenerator.region.add.json @@ -116,5 +116,18 @@ } ], "page": "/api-reference/document-generator/region/document-generator-region-add.html", - "executable": false + "executable": false, + "requestExample": { + "fields": { + "title": "Россия (Пользовательский)", + "languageId": "ru", + "formatDate": "DD.MM.YYYY", + "formatDatetime": "DD.MM.YYYY HH:MI:SS", + "formatName": "#LAST_NAME# #NAME# #SECOND_NAME#", + "phrases": { + "TAX_INCLUDED": "НДС включен в цену", + "TAX_NOT_INCLUDED": "НДС не включен в цену" + } + } + } } diff --git a/_assets/simulator/spec/methods/documentgenerator.region.delete.json b/_assets/simulator/spec/methods/documentgenerator.region.delete.json index 50fe77651..d3aee74fe 100644 --- a/_assets/simulator/spec/methods/documentgenerator.region.delete.json +++ b/_assets/simulator/spec/methods/documentgenerator.region.delete.json @@ -50,5 +50,8 @@ } ], "page": "/api-reference/document-generator/region/document-generator-region-delete.html", - "executable": false + "executable": false, + "requestExample": { + "id": 1 + } } diff --git a/_assets/simulator/spec/methods/documentgenerator.region.get.json b/_assets/simulator/spec/methods/documentgenerator.region.get.json index 8ad17f692..2b6b7cfa9 100644 --- a/_assets/simulator/spec/methods/documentgenerator.region.get.json +++ b/_assets/simulator/spec/methods/documentgenerator.region.get.json @@ -72,5 +72,8 @@ "languageId", "phrases", "title" - ] + ], + "requestExample": { + "id": "1" + } } diff --git a/_assets/simulator/spec/methods/documentgenerator.region.update.json b/_assets/simulator/spec/methods/documentgenerator.region.update.json index 226d71bd3..2975eb394 100644 --- a/_assets/simulator/spec/methods/documentgenerator.region.update.json +++ b/_assets/simulator/spec/methods/documentgenerator.region.update.json @@ -123,5 +123,15 @@ } ], "page": "/api-reference/document-generator/region/document-generator-region-update.html", - "executable": false + "executable": false, + "requestExample": { + "id": 1, + "fields": { + "title": "Россия (Пользовательский)", + "formatDate": "YYYY-MM-DD", + "phrases": { + "TAX_INCLUDED": "Налог включен в цену" + } + } + } } diff --git a/_assets/simulator/spec/methods/documentgenerator.role.add.json b/_assets/simulator/spec/methods/documentgenerator.role.add.json index 2f765eb6d..c827d5bda 100644 --- a/_assets/simulator/spec/methods/documentgenerator.role.add.json +++ b/_assets/simulator/spec/methods/documentgenerator.role.add.json @@ -100,5 +100,23 @@ } ], "page": "/api-reference/document-generator/role/document-generator-role-add.html", - "executable": false + "executable": false, + "requestExample": { + "fields": { + "name": "Редакторы шаблонов", + "code": "DOCGEN_TEMPLATE_EDITORS", + "permissions": { + "SETTINGS": { + "MODIFY": "" + }, + "TEMPLATES": { + "MODIFY": "D" + }, + "DOCUMENTS": { + "MODIFY": "X", + "VIEW": "X" + } + } + } + } } diff --git a/_assets/simulator/spec/methods/documentgenerator.role.delete.json b/_assets/simulator/spec/methods/documentgenerator.role.delete.json index efe622cb3..f1ba7298b 100644 --- a/_assets/simulator/spec/methods/documentgenerator.role.delete.json +++ b/_assets/simulator/spec/methods/documentgenerator.role.delete.json @@ -50,5 +50,8 @@ } ], "page": "/api-reference/document-generator/role/document-generator-role-delete.html", - "executable": false + "executable": false, + "requestExample": { + "id": 9 + } } diff --git a/_assets/simulator/spec/methods/documentgenerator.role.fillaccesses.json b/_assets/simulator/spec/methods/documentgenerator.role.fillaccesses.json index 969b90b90..75490e2c9 100644 --- a/_assets/simulator/spec/methods/documentgenerator.role.fillaccesses.json +++ b/_assets/simulator/spec/methods/documentgenerator.role.fillaccesses.json @@ -54,5 +54,21 @@ } ], "page": "/api-reference/document-generator/role/document-generator-role-fill-accesses.html", - "executable": false + "executable": false, + "requestExample": { + "accesses": [ + { + "roleId": 9, + "accessCode": "U1" + }, + { + "roleId": 9, + "accessCode": "D1" + }, + { + "roleId": 9, + "accessCode": "UA" + } + ] + } } diff --git a/_assets/simulator/spec/methods/documentgenerator.role.get.json b/_assets/simulator/spec/methods/documentgenerator.role.get.json index 3951bfb0b..06261e6eb 100644 --- a/_assets/simulator/spec/methods/documentgenerator.role.get.json +++ b/_assets/simulator/spec/methods/documentgenerator.role.get.json @@ -74,5 +74,8 @@ "id", "name", "permissions" - ] + ], + "requestExample": { + "id": 9 + } } diff --git a/_assets/simulator/spec/methods/documentgenerator.role.list.json b/_assets/simulator/spec/methods/documentgenerator.role.list.json index aa2d8d509..e56e2ef69 100644 --- a/_assets/simulator/spec/methods/documentgenerator.role.list.json +++ b/_assets/simulator/spec/methods/documentgenerator.role.list.json @@ -82,5 +82,8 @@ "id", "name", "permissions" - ] + ], + "requestExample": { + "start": 0 + } } diff --git a/_assets/simulator/spec/methods/documentgenerator.role.update.json b/_assets/simulator/spec/methods/documentgenerator.role.update.json index 0f6e7118e..b0b721546 100644 --- a/_assets/simulator/spec/methods/documentgenerator.role.update.json +++ b/_assets/simulator/spec/methods/documentgenerator.role.update.json @@ -107,5 +107,23 @@ } ], "page": "/api-reference/document-generator/role/document-generator-role-update.html", - "executable": false + "executable": false, + "requestExample": { + "id": 9, + "fields": { + "name": "Редакторы своих шаблонов", + "permissions": { + "SETTINGS": { + "MODIFY": "" + }, + "TEMPLATES": { + "MODIFY": "A" + }, + "DOCUMENTS": { + "MODIFY": "X", + "VIEW": "X" + } + } + } + } } diff --git a/_assets/simulator/spec/methods/documentgenerator.template.delete.json b/_assets/simulator/spec/methods/documentgenerator.template.delete.json index 85f5ce28b..29b4bfe36 100644 --- a/_assets/simulator/spec/methods/documentgenerator.template.delete.json +++ b/_assets/simulator/spec/methods/documentgenerator.template.delete.json @@ -50,5 +50,8 @@ } ], "page": "/api-reference/document-generator/templates/document-generator-template-delete.html", - "executable": false + "executable": false, + "requestExample": { + "id": 59 + } } diff --git a/_assets/simulator/spec/methods/documentgenerator.template.get.json b/_assets/simulator/spec/methods/documentgenerator.template.get.json index 0e429d1de..4e164259c 100644 --- a/_assets/simulator/spec/methods/documentgenerator.template.get.json +++ b/_assets/simulator/spec/methods/documentgenerator.template.get.json @@ -93,5 +93,8 @@ "updateTime", "users", "withStamps" - ] + ], + "requestExample": { + "id": 57 + } } diff --git a/_assets/simulator/spec/methods/documentgenerator.template.getfields.json b/_assets/simulator/spec/methods/documentgenerator.template.getfields.json index a03c6caab..78986a8c2 100644 --- a/_assets/simulator/spec/methods/documentgenerator.template.getfields.json +++ b/_assets/simulator/spec/methods/documentgenerator.template.getfields.json @@ -100,5 +100,8 @@ } ], "page": "/api-reference/document-generator/templates/document-generator-template-get-fields.html", - "executable": false + "executable": false, + "requestExample": { + "id": 57 + } } diff --git a/_assets/simulator/spec/methods/documentgenerator.template.list.json b/_assets/simulator/spec/methods/documentgenerator.template.list.json index 8ce76718d..cb0ff8e6e 100644 --- a/_assets/simulator/spec/methods/documentgenerator.template.list.json +++ b/_assets/simulator/spec/methods/documentgenerator.template.list.json @@ -89,5 +89,21 @@ "sort", "users", "withStamps" - ] + ], + "requestExample": { + "select": [ + "*", + "users", + "providers" + ], + "order": { + "id": "desc" + }, + "filter": { + "region": "ru", + "active": "Y", + ">=createTime": "2026-03-18T00:00:00+03:00" + }, + "start": 0 + } } diff --git a/_assets/simulator/spec/methods/documentgenerator.template.update.json b/_assets/simulator/spec/methods/documentgenerator.template.update.json index 5b05b776d..151c88f84 100644 --- a/_assets/simulator/spec/methods/documentgenerator.template.update.json +++ b/_assets/simulator/spec/methods/documentgenerator.template.update.json @@ -193,5 +193,17 @@ } ], "page": "/api-reference/document-generator/templates/document-generator-template-update.html", - "executable": false + "executable": false, + "requestExample": { + "id": 57, + "fields": { + "name": "SUPPLY_CONTRACT_NEW Template", + "numeratorId": 3, + "code": "REST_TEMPLATE", + "users": [ + "U503" + ], + "sort": 700 + } + } } diff --git a/_assets/simulator/spec/methods/feature.get.json b/_assets/simulator/spec/methods/feature.get.json index d87a6a9e4..b5bd12026 100644 --- a/_assets/simulator/spec/methods/feature.get.json +++ b/_assets/simulator/spec/methods/feature.get.json @@ -3,7 +3,7 @@ "method": "feature.get", "scope": "базовый", "kind": "read", - "title": "Получить информацию о доступности функционала в Битрикс24 feature.get", + "title": "Получить информацию о доступности возможности в Битрикс24 feature.get", "permissions": "любой пользователь", "params": [ { @@ -11,7 +11,7 @@ "type": "string", "base": "string", "required": true, - "description": "Доступные ключи: - rest_offline_extended — доступность офлайн-событий - rest_auth_connector — доступность ключа auth_connector в событиях" + "description": "Код возможности. Доступные коды: - rest_offline_extended — расширенный режим офлайн-событий: получение событий методом event.offline.get с параметром clear = 0, без удаления из очереди - rest_auth_connector — доступность ключа auth_connector в событиях Метод не проверяет, существует ли код, и не возвращает ошибку для неизвестного кода.…" } ], "defs": {}, @@ -40,7 +40,7 @@ "type": "object", "base": "object", "required": false, - "description": "Объект содержит информацию о доступности метода: - value — (Y/N) наличие функционала в Битрикс24 - lang_selfhosted — lang заменяется на en, ru, ua, kz и так далее (используется для коробочной версии Битрикс24)" + "description": "Результат проверки (подробное описание)" }, { "name": "time", @@ -54,5 +54,8 @@ "executable": false, "entityFields": [ "value" - ] + ], + "requestExample": { + "CODE": "rest_offline_extended" + } } diff --git a/_assets/simulator/spec/methods/humanresources.employee.field.get.json b/_assets/simulator/spec/methods/humanresources.employee.field.get.json index 52a4e8601..82b386582 100644 --- a/_assets/simulator/spec/methods/humanresources.employee.field.get.json +++ b/_assets/simulator/spec/methods/humanresources.employee.field.get.json @@ -95,5 +95,21 @@ "title", "type", "validationRules" - ] + ], + "requestExample": { + "name": "userId", + "select": [ + "name", + "type", + "title", + "description", + "validationRules", + "requiredGroups", + "filterable", + "sortable", + "editable", + "multiple", + "elementType" + ] + } } diff --git a/_assets/simulator/spec/methods/humanresources.employee.field.list.json b/_assets/simulator/spec/methods/humanresources.employee.field.list.json index 8ae68643e..f2e78a868 100644 --- a/_assets/simulator/spec/methods/humanresources.employee.field.list.json +++ b/_assets/simulator/spec/methods/humanresources.employee.field.list.json @@ -168,5 +168,20 @@ "title", "type", "validationRules" - ] + ], + "requestExample": { + "select": [ + "name", + "type", + "title", + "description", + "validationRules", + "requiredGroups", + "filterable", + "sortable", + "editable", + "multiple", + "elementType" + ] + } } diff --git a/_assets/simulator/spec/methods/humanresources.employee.search.json b/_assets/simulator/spec/methods/humanresources.employee.search.json index 89af1d345..b68e1c0a8 100644 --- a/_assets/simulator/spec/methods/humanresources.employee.search.json +++ b/_assets/simulator/spec/methods/humanresources.employee.search.json @@ -92,5 +92,17 @@ } ], "page": "/api-reference/departments/employee/humanresources-employee-search.html", - "executable": false + "executable": false, + "requestExample": { + "name": "Иван", + "select": [ + "userId", + "name", + "workPosition", + "avatar", + "url", + "departments", + "teams" + ] + } } diff --git a/_assets/simulator/spec/methods/humanresources.employee.subordinates.json b/_assets/simulator/spec/methods/humanresources.employee.subordinates.json index fdb7782ef..9a14f6d74 100644 --- a/_assets/simulator/spec/methods/humanresources.employee.subordinates.json +++ b/_assets/simulator/spec/methods/humanresources.employee.subordinates.json @@ -114,5 +114,8 @@ } ], "page": "/api-reference/departments/employee/humanresources-employee-subordinates.html", - "executable": false + "executable": false, + "requestExample": { + "id": 7 + } } diff --git a/_assets/simulator/spec/methods/humanresources.node.add.json b/_assets/simulator/spec/methods/humanresources.node.add.json index 5880b2ba2..97d241b35 100644 --- a/_assets/simulator/spec/methods/humanresources.node.add.json +++ b/_assets/simulator/spec/methods/humanresources.node.add.json @@ -537,5 +537,36 @@ } ], "page": "/api-reference/departments/node/humanresources-node-add.html", - "executable": false + "executable": false, + "requestExample": { + "type": "DEPARTMENT", + "name": "Отдел маркетинга", + "parentId": 1, + "description": "Отвечает за продвижение", + "userIds": { + "MEMBER_HEAD": [ + 7 + ], + "MEMBER_EMPLOYEE": [ + 12, + 15 + ] + }, + "moveUsersToNode": true, + "createChat": true, + "bindingChatIds": [ + 31 + ], + "createChannel": false, + "createCollab": false, + "settings": { + "BUSINESS_PROC_AUTHORITY": [ + "HEAD", + "DEPUTY_HEAD" + ], + "REPORTS_AUTHORITY": [ + "HEAD" + ] + } + } } diff --git a/_assets/simulator/spec/methods/humanresources.node.children.json b/_assets/simulator/spec/methods/humanresources.node.children.json index c25a31e47..9068e8e31 100644 --- a/_assets/simulator/spec/methods/humanresources.node.children.json +++ b/_assets/simulator/spec/methods/humanresources.node.children.json @@ -99,5 +99,22 @@ } ], "page": "/api-reference/departments/node/humanresources-node-children.html", - "executable": false + "executable": false, + "requestExample": { + "id": 1, + "select": [ + "id", + "name", + "type", + "structureId", + "parentId", + "description", + "accessCode", + "userCount", + "colorName", + "xmlId", + "createdAt", + "updatedAt" + ] + } } diff --git a/_assets/simulator/spec/methods/humanresources.node.communication.edit.json b/_assets/simulator/spec/methods/humanresources.node.communication.edit.json index 7c0298471..f400bef8e 100644 --- a/_assets/simulator/spec/methods/humanresources.node.communication.edit.json +++ b/_assets/simulator/spec/methods/humanresources.node.communication.edit.json @@ -136,5 +136,17 @@ } ], "page": "/api-reference/departments/node-communication/humanresources-node-communication-edit.html", - "executable": false + "executable": false, + "requestExample": { + "nodeId": 15, + "communicationType": "CHAT", + "ids": [ + 21 + ], + "removeIds": [ + 18 + ], + "createDefault": false, + "withChildren": false + } } diff --git a/_assets/simulator/spec/methods/humanresources.node.communication.list.json b/_assets/simulator/spec/methods/humanresources.node.communication.list.json index eaf5adc41..d7918cc80 100644 --- a/_assets/simulator/spec/methods/humanresources.node.communication.list.json +++ b/_assets/simulator/spec/methods/humanresources.node.communication.list.json @@ -148,5 +148,8 @@ "subtitle", "title", "type" - ] + ], + "requestExample": { + "id": 15 + } } diff --git a/_assets/simulator/spec/methods/humanresources.node.edit.json b/_assets/simulator/spec/methods/humanresources.node.edit.json index 97d49f3be..107f107ef 100644 --- a/_assets/simulator/spec/methods/humanresources.node.edit.json +++ b/_assets/simulator/spec/methods/humanresources.node.edit.json @@ -194,5 +194,10 @@ } ], "page": "/api-reference/departments/node/humanresources-node-edit.html", - "executable": false + "executable": false, + "requestExample": { + "id": 44, + "name": "Отдел продаж B2B", + "description": "Работает с корпоративными клиентами" + } } diff --git a/_assets/simulator/spec/methods/humanresources.node.field.get.json b/_assets/simulator/spec/methods/humanresources.node.field.get.json index f80bcf1ae..5227dad98 100644 --- a/_assets/simulator/spec/methods/humanresources.node.field.get.json +++ b/_assets/simulator/spec/methods/humanresources.node.field.get.json @@ -79,5 +79,13 @@ "name", "title", "type" - ] + ], + "requestExample": { + "name": "name", + "select": [ + "name", + "type", + "title" + ] + } } diff --git a/_assets/simulator/spec/methods/humanresources.node.field.list.json b/_assets/simulator/spec/methods/humanresources.node.field.list.json index 2b54eab25..0a8420c0a 100644 --- a/_assets/simulator/spec/methods/humanresources.node.field.list.json +++ b/_assets/simulator/spec/methods/humanresources.node.field.list.json @@ -162,5 +162,14 @@ "sortable", "title", "type" - ] + ], + "requestExample": { + "select": [ + "name", + "type", + "title", + "filterable", + "sortable" + ] + } } diff --git a/_assets/simulator/spec/methods/humanresources.node.get.json b/_assets/simulator/spec/methods/humanresources.node.get.json index 6e9117912..561e9e828 100644 --- a/_assets/simulator/spec/methods/humanresources.node.get.json +++ b/_assets/simulator/spec/methods/humanresources.node.get.json @@ -108,5 +108,23 @@ "updatedAt", "userCount", "xmlId" - ] + ], + "requestExample": { + "id": 1, + "select": [ + "id", + "name", + "type", + "structureId", + "parentId", + "description", + "accessCode", + "userCount", + "colorName", + "xmlId", + "createdAt", + "updatedAt", + "members" + ] + } } diff --git a/_assets/simulator/spec/methods/humanresources.node.list.json b/_assets/simulator/spec/methods/humanresources.node.list.json index 9ecc15991..2d6293697 100644 --- a/_assets/simulator/spec/methods/humanresources.node.list.json +++ b/_assets/simulator/spec/methods/humanresources.node.list.json @@ -134,5 +134,27 @@ "updatedAt", "userCount", "xmlId" - ] + ], + "requestExample": { + "type": "DEPARTMENT", + "select": [ + "id", + "name", + "type", + "structureId", + "parentId", + "description", + "accessCode", + "userCount", + "colorName", + "xmlId", + "createdAt", + "updatedAt" + ], + "pagination": { + "page": 1, + "limit": 20, + "offset": 0 + } + } } diff --git a/_assets/simulator/spec/methods/humanresources.node.member.add.json b/_assets/simulator/spec/methods/humanresources.node.member.add.json index 2a9c2c7c2..392f4d42f 100644 --- a/_assets/simulator/spec/methods/humanresources.node.member.add.json +++ b/_assets/simulator/spec/methods/humanresources.node.member.add.json @@ -99,5 +99,14 @@ } ], "page": "/api-reference/departments/node-member/humanresources-node-member-add.html", - "executable": false + "executable": false, + "requestExample": { + "nodeId": 15, + "userIds": [ + 7, + 12, + 18 + ], + "role": "MEMBER_EMPLOYEE" + } } diff --git a/_assets/simulator/spec/methods/humanresources.node.member.field.get.json b/_assets/simulator/spec/methods/humanresources.node.member.field.get.json index bc1577f42..06c99906e 100644 --- a/_assets/simulator/spec/methods/humanresources.node.member.field.get.json +++ b/_assets/simulator/spec/methods/humanresources.node.member.field.get.json @@ -79,5 +79,13 @@ "name", "title", "type" - ] + ], + "requestExample": { + "name": "userId", + "select": [ + "name", + "type", + "title" + ] + } } diff --git a/_assets/simulator/spec/methods/humanresources.node.member.field.list.json b/_assets/simulator/spec/methods/humanresources.node.member.field.list.json index e72340e52..5f2b36d72 100644 --- a/_assets/simulator/spec/methods/humanresources.node.member.field.list.json +++ b/_assets/simulator/spec/methods/humanresources.node.member.field.list.json @@ -120,5 +120,15 @@ "sortable", "title", "type" - ] + ], + "requestExample": { + "select": [ + "name", + "type", + "title", + "description", + "filterable", + "sortable" + ] + } } diff --git a/_assets/simulator/spec/methods/humanresources.node.member.move.json b/_assets/simulator/spec/methods/humanresources.node.member.move.json index b45f69f7e..c167d23f2 100644 --- a/_assets/simulator/spec/methods/humanresources.node.member.move.json +++ b/_assets/simulator/spec/methods/humanresources.node.member.move.json @@ -99,5 +99,13 @@ } ], "page": "/api-reference/departments/node-member/humanresources-node-member-move.html", - "executable": false + "executable": false, + "requestExample": { + "nodeId": 28, + "userIds": [ + 12, + 18 + ], + "role": "MEMBER_EMPLOYEE" + } } diff --git a/_assets/simulator/spec/methods/humanresources.node.member.remove.json b/_assets/simulator/spec/methods/humanresources.node.member.remove.json index 70457f447..7f08dd220 100644 --- a/_assets/simulator/spec/methods/humanresources.node.member.remove.json +++ b/_assets/simulator/spec/methods/humanresources.node.member.remove.json @@ -107,5 +107,13 @@ } ], "page": "/api-reference/departments/node-member/humanresources-node-member-remove.html", - "executable": false + "executable": false, + "requestExample": { + "nodeId": 15, + "userIds": [ + 18, + 25, + 31 + ] + } } diff --git a/_assets/simulator/spec/methods/humanresources.node.member.set.json b/_assets/simulator/spec/methods/humanresources.node.member.set.json index 870fbde39..1eb1ae969 100644 --- a/_assets/simulator/spec/methods/humanresources.node.member.set.json +++ b/_assets/simulator/spec/methods/humanresources.node.member.set.json @@ -119,5 +119,21 @@ } ], "page": "/api-reference/departments/node-member/humanresources-node-member-set.html", - "executable": false + "executable": false, + "requestExample": { + "nodeId": 15, + "userIds": { + "MEMBER_HEAD": [ + 7 + ], + "MEMBER_DEPUTY_HEAD": [ + 12 + ], + "MEMBER_EMPLOYEE": [ + 18, + 25, + 31 + ] + } + } } diff --git a/_assets/simulator/spec/methods/humanresources.node.move.json b/_assets/simulator/spec/methods/humanresources.node.move.json index 6ac173eaf..8dd27785c 100644 --- a/_assets/simulator/spec/methods/humanresources.node.move.json +++ b/_assets/simulator/spec/methods/humanresources.node.move.json @@ -154,5 +154,9 @@ } ], "page": "/api-reference/departments/node/humanresources-node-move.html", - "executable": false + "executable": false, + "requestExample": { + "id": 44, + "parentId": 2 + } } diff --git a/_assets/simulator/spec/methods/humanresources.node.search.json b/_assets/simulator/spec/methods/humanresources.node.search.json index ec2ccc051..925cf856f 100644 --- a/_assets/simulator/spec/methods/humanresources.node.search.json +++ b/_assets/simulator/spec/methods/humanresources.node.search.json @@ -200,5 +200,13 @@ } ], "page": "/api-reference/departments/node/humanresources-node-search.html", - "executable": false + "executable": false, + "requestExample": { + "type": "DEPARTMENT", + "name": "Продажи", + "parentId": 1, + "pagination": { + "limit": 20 + } + } } diff --git a/_assets/simulator/spec/methods/im.chat.add.json b/_assets/simulator/spec/methods/im.chat.add.json index 40b03e5b6..fa9a37e67 100644 --- a/_assets/simulator/spec/methods/im.chat.add.json +++ b/_assets/simulator/spec/methods/im.chat.add.json @@ -217,5 +217,18 @@ } ], "page": "/api-reference/chats/im-chat-add.html", - "executable": false + "executable": false, + "requestExample": { + "USERS": [ + 103, + 547 + ], + "TYPE": "CHAT", + "TITLE": "Чат по сделке", + "DESCRIPTION": "Здесь обсуждаем сделку", + "COLOR": "PINK", + "MESSAGE": "Добро пожаловать в чат сделки", + "ENTITY_TYPE": "CRM", + "ENTITY_ID": "DEAL|1663" + } } diff --git a/_assets/simulator/spec/methods/im.chat.get.json b/_assets/simulator/spec/methods/im.chat.get.json index aecc53eb7..be7aeb134 100644 --- a/_assets/simulator/spec/methods/im.chat.get.json +++ b/_assets/simulator/spec/methods/im.chat.get.json @@ -92,5 +92,9 @@ "executable": false, "entityFields": [ "ID" - ] + ], + "requestExample": { + "ENTITY_TYPE": "CRM", + "ENTITY_ID": "DEAL|1663" + } } diff --git a/_assets/simulator/spec/methods/im.chat.leave.json b/_assets/simulator/spec/methods/im.chat.leave.json index 1ce27f907..67317071c 100644 --- a/_assets/simulator/spec/methods/im.chat.leave.json +++ b/_assets/simulator/spec/methods/im.chat.leave.json @@ -50,5 +50,8 @@ } ], "page": "/api-reference/chats/chat-users/im-chat-leave.html", - "executable": false + "executable": false, + "requestExample": { + "CHAT_ID": 2935 + } } diff --git a/_assets/simulator/spec/methods/im.chat.mute.json b/_assets/simulator/spec/methods/im.chat.mute.json index 08e26e98b..9cd976d3f 100644 --- a/_assets/simulator/spec/methods/im.chat.mute.json +++ b/_assets/simulator/spec/methods/im.chat.mute.json @@ -64,5 +64,9 @@ } ], "page": "/api-reference/chats/special-operations/im-chat-mute.html", - "executable": false + "executable": false, + "requestExample": { + "CHAT_ID": 1489, + "MUTE": "Y" + } } diff --git a/_assets/simulator/spec/methods/im.chat.setOwner.json b/_assets/simulator/spec/methods/im.chat.setOwner.json index 9f3d8e672..8dd5bffac 100644 --- a/_assets/simulator/spec/methods/im.chat.setOwner.json +++ b/_assets/simulator/spec/methods/im.chat.setOwner.json @@ -64,5 +64,9 @@ } ], "page": "/api-reference/chats/chat-update/im-chat-set-owner.html", - "executable": false + "executable": false, + "requestExample": { + "CHAT_ID": 2935, + "USER_ID": 1271 + } } diff --git a/_assets/simulator/spec/methods/im.chat.updateAvatar.json b/_assets/simulator/spec/methods/im.chat.updateAvatar.json index 239f5dd8c..74c5fda9f 100644 --- a/_assets/simulator/spec/methods/im.chat.updateAvatar.json +++ b/_assets/simulator/spec/methods/im.chat.updateAvatar.json @@ -64,5 +64,9 @@ } ], "page": "/api-reference/chats/chat-update/im-chat-update-avatar.html", - "executable": false + "executable": false, + "requestExample": { + "CHAT_ID": 2935, + "AVATAR": "/9j/4QAYRXhpZgAAS...CgCgCgCgP/9k=" + } } diff --git a/_assets/simulator/spec/methods/im.chat.updateColor.json b/_assets/simulator/spec/methods/im.chat.updateColor.json index 232794b38..2cc1e9db4 100644 --- a/_assets/simulator/spec/methods/im.chat.updateColor.json +++ b/_assets/simulator/spec/methods/im.chat.updateColor.json @@ -126,5 +126,9 @@ } ], "page": "/api-reference/chats/chat-update/im-chat-update-color.html", - "executable": false + "executable": false, + "requestExample": { + "CHAT_ID": 2935, + "COLOR": "SAND" + } } diff --git a/_assets/simulator/spec/methods/im.chat.updateTitle.json b/_assets/simulator/spec/methods/im.chat.updateTitle.json index a8cebcb86..9fdb0a794 100644 --- a/_assets/simulator/spec/methods/im.chat.updateTitle.json +++ b/_assets/simulator/spec/methods/im.chat.updateTitle.json @@ -64,5 +64,9 @@ } ], "page": "/api-reference/chats/chat-update/im-chat-update-title.html", - "executable": false + "executable": false, + "requestExample": { + "CHAT_ID": 2935, + "TITLE": "Чат по проекту" + } } diff --git a/_assets/simulator/spec/methods/im.chat.user.add.json b/_assets/simulator/spec/methods/im.chat.user.add.json index b4592fa31..969591894 100644 --- a/_assets/simulator/spec/methods/im.chat.user.add.json +++ b/_assets/simulator/spec/methods/im.chat.user.add.json @@ -68,5 +68,13 @@ } ], "page": "/api-reference/chats/chat-users/im-chat-user-add.html", - "executable": false + "executable": false, + "requestExample": { + "CHAT_ID": 2935, + "USERS": [ + 99, + 1271 + ], + "HIDE_HISTORY": "N" + } } diff --git a/_assets/simulator/spec/methods/im.chat.user.delete.json b/_assets/simulator/spec/methods/im.chat.user.delete.json index 2472815bb..c4e0b4441 100644 --- a/_assets/simulator/spec/methods/im.chat.user.delete.json +++ b/_assets/simulator/spec/methods/im.chat.user.delete.json @@ -57,5 +57,9 @@ } ], "page": "/api-reference/chats/chat-users/im-chat-user-delete.html", - "executable": false + "executable": false, + "requestExample": { + "CHAT_ID": 2935, + "USER_ID": 1291 + } } diff --git a/_assets/simulator/spec/methods/im.chat.user.list.json b/_assets/simulator/spec/methods/im.chat.user.list.json index bd042d851..08fa3c073 100644 --- a/_assets/simulator/spec/methods/im.chat.user.list.json +++ b/_assets/simulator/spec/methods/im.chat.user.list.json @@ -54,5 +54,8 @@ } ], "page": "/api-reference/chats/chat-users/im-chat-user-list.html", - "executable": false + "executable": false, + "requestExample": { + "CHAT_ID": 2935 + } } diff --git a/_assets/simulator/spec/methods/im.counters.get.json b/_assets/simulator/spec/methods/im.counters.get.json index b53410291..4b4dfe2cd 100644 --- a/_assets/simulator/spec/methods/im.counters.get.json +++ b/_assets/simulator/spec/methods/im.counters.get.json @@ -219,5 +219,6 @@ "LINES", "MESSENGER", "NOTIFY" - ] + ], + "requestExample": {} } diff --git a/_assets/simulator/spec/methods/im.department.colleagues.list.json b/_assets/simulator/spec/methods/im.department.colleagues.list.json index d4128adbd..a127a19b2 100644 --- a/_assets/simulator/spec/methods/im.department.colleagues.list.json +++ b/_assets/simulator/spec/methods/im.department.colleagues.list.json @@ -75,5 +75,10 @@ } ], "page": "/api-reference/chats/departments/im-department-colleagues-list.html", - "executable": false + "executable": false, + "requestExample": { + "USER_DATA": "Y", + "OFFSET": 0, + "LIMIT": 5 + } } diff --git a/_assets/simulator/spec/methods/im.department.employees.get.json b/_assets/simulator/spec/methods/im.department.employees.get.json index 99ef141e9..0427e2f89 100644 --- a/_assets/simulator/spec/methods/im.department.employees.get.json +++ b/_assets/simulator/spec/methods/im.department.employees.get.json @@ -58,5 +58,12 @@ } ], "page": "/api-reference/chats/departments/im-department-employees-get.html", - "executable": false + "executable": false, + "requestExample": { + "ID": [ + 3, + 7 + ], + "USER_DATA": "Y" + } } diff --git a/_assets/simulator/spec/methods/im.department.get.json b/_assets/simulator/spec/methods/im.department.get.json index 7a2122ffc..28fe00bf9 100644 --- a/_assets/simulator/spec/methods/im.department.get.json +++ b/_assets/simulator/spec/methods/im.department.get.json @@ -58,5 +58,12 @@ } ], "page": "/api-reference/chats/departments/im-department-get.html", - "executable": false + "executable": false, + "requestExample": { + "ID": [ + 3, + 7 + ], + "USER_DATA": "Y" + } } diff --git a/_assets/simulator/spec/methods/im.department.managers.get.json b/_assets/simulator/spec/methods/im.department.managers.get.json index 2313ee446..fa2060013 100644 --- a/_assets/simulator/spec/methods/im.department.managers.get.json +++ b/_assets/simulator/spec/methods/im.department.managers.get.json @@ -58,5 +58,12 @@ } ], "page": "/api-reference/chats/departments/im-department-managers-get.html", - "executable": false + "executable": false, + "requestExample": { + "ID": [ + 3, + 7 + ], + "USER_DATA": "Y" + } } diff --git a/_assets/simulator/spec/methods/im.dialog.get.json b/_assets/simulator/spec/methods/im.dialog.get.json index ce5218c21..e7be2671d 100644 --- a/_assets/simulator/spec/methods/im.dialog.get.json +++ b/_assets/simulator/spec/methods/im.dialog.get.json @@ -144,5 +144,8 @@ "rename", "send", "user_list" - ] + ], + "requestExample": { + "DIALOG_ID": "chat1435" + } } diff --git a/_assets/simulator/spec/methods/im.dialog.messages.get.json b/_assets/simulator/spec/methods/im.dialog.messages.get.json index bb29288f4..d3d89d503 100644 --- a/_assets/simulator/spec/methods/im.dialog.messages.get.json +++ b/_assets/simulator/spec/methods/im.dialog.messages.get.json @@ -242,5 +242,10 @@ "text", "unread", "uuid" - ] + ], + "requestExample": { + "DIALOG_ID": "chat1489", + "FIRST_ID": 84869, + "LIMIT": 10 + } } diff --git a/_assets/simulator/spec/methods/im.dialog.messages.search.json b/_assets/simulator/spec/methods/im.dialog.messages.search.json index a6aee01fe..71536f5cb 100644 --- a/_assets/simulator/spec/methods/im.dialog.messages.search.json +++ b/_assets/simulator/spec/methods/im.dialog.messages.search.json @@ -236,5 +236,13 @@ } ], "page": "/api-reference/chats/messages/im-dialog-messages-search.html", - "executable": false + "executable": false, + "requestExample": { + "CHAT_ID": 3, + "SEARCH_MESSAGE": "test", + "ORDER": { + "ID": "DESC" + }, + "LIMIT": 20 + } } diff --git a/_assets/simulator/spec/methods/im.dialog.read.all.json b/_assets/simulator/spec/methods/im.dialog.read.all.json index 37b6d385d..32792ca8a 100644 --- a/_assets/simulator/spec/methods/im.dialog.read.all.json +++ b/_assets/simulator/spec/methods/im.dialog.read.all.json @@ -61,5 +61,6 @@ } ], "page": "/api-reference/chats/special-operations/im-dialog-read-all.html", - "executable": false + "executable": false, + "requestExample": {} } diff --git a/_assets/simulator/spec/methods/im.dialog.read.json b/_assets/simulator/spec/methods/im.dialog.read.json index 58b44fbe7..d90ac2c6e 100644 --- a/_assets/simulator/spec/methods/im.dialog.read.json +++ b/_assets/simulator/spec/methods/im.dialog.read.json @@ -62,5 +62,9 @@ } ], "page": "/api-reference/chats/messages/im-dialog-read.html", - "executable": false + "executable": false, + "requestExample": { + "DIALOG_ID": "chat1489", + "MESSAGE_ID": 84875 + } } diff --git a/_assets/simulator/spec/methods/im.dialog.unread.json b/_assets/simulator/spec/methods/im.dialog.unread.json index d2afa653e..6d11447e3 100644 --- a/_assets/simulator/spec/methods/im.dialog.unread.json +++ b/_assets/simulator/spec/methods/im.dialog.unread.json @@ -57,5 +57,9 @@ } ], "page": "/api-reference/chats/messages/im-dialog-unread.html", - "executable": false + "executable": false, + "requestExample": { + "DIALOG_ID": "chat1489", + "MESSAGE_ID": 84869 + } } diff --git a/_assets/simulator/spec/methods/im.dialog.users.list.json b/_assets/simulator/spec/methods/im.dialog.users.list.json index 5e53773e5..d0f13ac3c 100644 --- a/_assets/simulator/spec/methods/im.dialog.users.list.json +++ b/_assets/simulator/spec/methods/im.dialog.users.list.json @@ -229,5 +229,11 @@ "type", "website", "work_position" - ] + ], + "requestExample": { + "DIALOG_ID": "chat2935", + "SKIP_EXTERNAL": "Y", + "LIMIT": 20, + "OFFSET": 0 + } } diff --git a/_assets/simulator/spec/methods/im.dialog.writing.json b/_assets/simulator/spec/methods/im.dialog.writing.json index 389babbd2..e44a7867e 100644 --- a/_assets/simulator/spec/methods/im.dialog.writing.json +++ b/_assets/simulator/spec/methods/im.dialog.writing.json @@ -50,5 +50,8 @@ } ], "page": "/api-reference/chats/messages/im-dialog-writing.html", - "executable": false + "executable": false, + "requestExample": { + "DIALOG_ID": "chat2935" + } } diff --git a/_assets/simulator/spec/methods/im.disk.file.delete.json b/_assets/simulator/spec/methods/im.disk.file.delete.json index 1c2f62e3a..d46fbb376 100644 --- a/_assets/simulator/spec/methods/im.disk.file.delete.json +++ b/_assets/simulator/spec/methods/im.disk.file.delete.json @@ -57,5 +57,9 @@ } ], "page": "/api-reference/chats/files/im-disk-file-delete.html", - "executable": false + "executable": false, + "requestExample": { + "CHAT_ID": 1489, + "FILE_ID": 5163 + } } diff --git a/_assets/simulator/spec/methods/im.disk.file.save.json b/_assets/simulator/spec/methods/im.disk.file.save.json index 89f690e67..abe2d51d8 100644 --- a/_assets/simulator/spec/methods/im.disk.file.save.json +++ b/_assets/simulator/spec/methods/im.disk.file.save.json @@ -73,5 +73,8 @@ } ], "page": "/api-reference/chats/files/im-disk-file-save.html", - "executable": false + "executable": false, + "requestExample": { + "FILE_ID": 5155 + } } diff --git a/_assets/simulator/spec/methods/im.message.add.json b/_assets/simulator/spec/methods/im.message.add.json index 20cb270e8..9db217b76 100644 --- a/_assets/simulator/spec/methods/im.message.add.json +++ b/_assets/simulator/spec/methods/im.message.add.json @@ -131,5 +131,12 @@ } ], "page": "/api-reference/chats/messages/im-message-add.html", - "executable": false + "executable": false, + "requestExample": { + "DIALOG_ID": "chat2941", + "MESSAGE": "Текст сообщения", + "SYSTEM": "N", + "URL_PREVIEW": "Y", + "REPLY_ID": 34237 + } } diff --git a/_assets/simulator/spec/methods/im.message.command.json b/_assets/simulator/spec/methods/im.message.command.json index 6fb8e4264..f966e7f09 100644 --- a/_assets/simulator/spec/methods/im.message.command.json +++ b/_assets/simulator/spec/methods/im.message.command.json @@ -71,5 +71,11 @@ } ], "page": "/api-reference/chats/messages/im-message-command.html", - "executable": false + "executable": false, + "requestExample": { + "MESSAGE_ID": 34261, + "BOT_ID": 1291, + "COMMAND": "task", + "COMMAND_PARAMS": "task №1" + } } diff --git a/_assets/simulator/spec/methods/im.message.delete.json b/_assets/simulator/spec/methods/im.message.delete.json index ed7339723..ad01ce3e3 100644 --- a/_assets/simulator/spec/methods/im.message.delete.json +++ b/_assets/simulator/spec/methods/im.message.delete.json @@ -50,5 +50,8 @@ } ], "page": "/api-reference/chats/messages/im-message-delete.html", - "executable": false + "executable": false, + "requestExample": { + "MESSAGE_ID": 34247 + } } diff --git a/_assets/simulator/spec/methods/im.message.like.json b/_assets/simulator/spec/methods/im.message.like.json index d95d9e74c..3676dfaa2 100644 --- a/_assets/simulator/spec/methods/im.message.like.json +++ b/_assets/simulator/spec/methods/im.message.like.json @@ -71,5 +71,9 @@ } ], "page": "/api-reference/chats/messages/im-message-like.html", - "executable": false + "executable": false, + "requestExample": { + "MESSAGE_ID": 34247, + "ACTION": "plus" + } } diff --git a/_assets/simulator/spec/methods/im.message.share.json b/_assets/simulator/spec/methods/im.message.share.json index 103943b46..3bf586349 100644 --- a/_assets/simulator/spec/methods/im.message.share.json +++ b/_assets/simulator/spec/methods/im.message.share.json @@ -82,5 +82,10 @@ } ], "page": "/api-reference/chats/messages/im-message-share.html", - "executable": false + "executable": false, + "requestExample": { + "MESSAGE_ID": 34261, + "DIALOG_ID": "chat2941", + "TYPE": "TASK" + } } diff --git a/_assets/simulator/spec/methods/im.notify.answer.json b/_assets/simulator/spec/methods/im.notify.answer.json index de19218c3..1dfdf845b 100644 --- a/_assets/simulator/spec/methods/im.notify.answer.json +++ b/_assets/simulator/spec/methods/im.notify.answer.json @@ -61,5 +61,9 @@ } ], "page": "/api-reference/chats/notifications/im-notify-answer.html", - "executable": false + "executable": false, + "requestExample": { + "NOTIFY_ID": 270, + "ANSWER_TEXT": "Приму участие" + } } diff --git a/_assets/simulator/spec/methods/im.notify.confirm.json b/_assets/simulator/spec/methods/im.notify.confirm.json index 301b0a5a9..5ba28f465 100644 --- a/_assets/simulator/spec/methods/im.notify.confirm.json +++ b/_assets/simulator/spec/methods/im.notify.confirm.json @@ -61,5 +61,9 @@ } ], "page": "/api-reference/chats/notifications/im-notify-confirm.html", - "executable": false + "executable": false, + "requestExample": { + "NOTIFY_ID": 288, + "NOTIFY_VALUE": "Y" + } } diff --git a/_assets/simulator/spec/methods/im.notify.delete.json b/_assets/simulator/spec/methods/im.notify.delete.json index 9a745302e..4eea5996a 100644 --- a/_assets/simulator/spec/methods/im.notify.delete.json +++ b/_assets/simulator/spec/methods/im.notify.delete.json @@ -71,5 +71,8 @@ } ], "page": "/api-reference/chats/notifications/im-notify-delete.html", - "executable": false + "executable": false, + "requestExample": { + "ID": 101 + } } diff --git a/_assets/simulator/spec/methods/im.notify.get.json b/_assets/simulator/spec/methods/im.notify.get.json index 09c0f7a3f..ba081ce0a 100644 --- a/_assets/simulator/spec/methods/im.notify.get.json +++ b/_assets/simulator/spec/methods/im.notify.get.json @@ -156,5 +156,11 @@ "params", "setting_name", "text" - ] + ], + "requestExample": { + "LAST_ID": 1500, + "LAST_TYPE": 3, + "LIMIT": 20, + "CONVERT_TEXT": "Y" + } } diff --git a/_assets/simulator/spec/methods/im.notify.history.search.json b/_assets/simulator/spec/methods/im.notify.history.search.json index 1dd8e9d2d..e061e609b 100644 --- a/_assets/simulator/spec/methods/im.notify.history.search.json +++ b/_assets/simulator/spec/methods/im.notify.history.search.json @@ -186,5 +186,14 @@ } ], "page": "/api-reference/chats/notifications/im-notify-history-search.html", - "executable": false + "executable": false, + "requestExample": { + "SEARCH_TEXT": "счет", + "SEARCH_TYPE": "tasks|task_update", + "SEARCH_DATE": "2026-03-03T16:52:29+03:00", + "LAST_ID": 1500, + "LIMIT": 20, + "CONVERT_TEXT": "Y", + "GROUP_TAG": "TASK|42" + } } diff --git a/_assets/simulator/spec/methods/im.notify.json b/_assets/simulator/spec/methods/im.notify.json index e92c1c27d..84e03a3cb 100644 --- a/_assets/simulator/spec/methods/im.notify.json +++ b/_assets/simulator/spec/methods/im.notify.json @@ -113,5 +113,13 @@ } ], "page": "/api-reference/chats/notifications/im-notify.html", - "executable": false + "executable": false, + "requestExample": { + "USER_ID": 5, + "TYPE": "USER", + "MESSAGE": "Напоминание", + "MESSAGE_OUT": "Напоминание (email)", + "TAG": "TASK_42", + "SUB_TAG": "TASK|42" + } } diff --git a/_assets/simulator/spec/methods/im.notify.personal.add.json b/_assets/simulator/spec/methods/im.notify.personal.add.json index a5d21ea6d..eed8a4ae8 100644 --- a/_assets/simulator/spec/methods/im.notify.personal.add.json +++ b/_assets/simulator/spec/methods/im.notify.personal.add.json @@ -96,5 +96,12 @@ } ], "page": "/api-reference/chats/notifications/im-notify-personal-add.html", - "executable": false + "executable": false, + "requestExample": { + "USER_ID": 5, + "MESSAGE": "Напоминание по задаче", + "MESSAGE_OUT": "Напоминание по задаче (email)", + "TAG": "TASK_REMINDER_42", + "SUB_TAG": "TASK_REMINDER|42" + } } diff --git a/_assets/simulator/spec/methods/im.notify.read.json b/_assets/simulator/spec/methods/im.notify.read.json index cd64e77e2..510e19c75 100644 --- a/_assets/simulator/spec/methods/im.notify.read.json +++ b/_assets/simulator/spec/methods/im.notify.read.json @@ -64,5 +64,10 @@ } ], "page": "/api-reference/chats/notifications/im-notify-read.html", - "executable": false + "executable": false, + "requestExample": { + "ID": 101, + "ACTION": "Y", + "ONLY_CURRENT": "Y" + } } diff --git a/_assets/simulator/spec/methods/im.notify.read.list.json b/_assets/simulator/spec/methods/im.notify.read.list.json index 997362079..22a52c6b4 100644 --- a/_assets/simulator/spec/methods/im.notify.read.list.json +++ b/_assets/simulator/spec/methods/im.notify.read.list.json @@ -61,5 +61,13 @@ } ], "page": "/api-reference/chats/notifications/im-notify-read-list.html", - "executable": false + "executable": false, + "requestExample": { + "IDS": [ + 101, + 102, + 103 + ], + "ACTION": "Y" + } } diff --git a/_assets/simulator/spec/methods/im.notify.system.add.json b/_assets/simulator/spec/methods/im.notify.system.add.json index 2a66f1bc4..782a16655 100644 --- a/_assets/simulator/spec/methods/im.notify.system.add.json +++ b/_assets/simulator/spec/methods/im.notify.system.add.json @@ -96,5 +96,12 @@ } ], "page": "/api-reference/chats/notifications/im-notify-system-add.html", - "executable": false + "executable": false, + "requestExample": { + "USER_ID": 5, + "MESSAGE": "Системное уведомление", + "MESSAGE_OUT": "Системное уведомление для email", + "TAG": "SYSTEM_EVENT_42", + "SUB_TAG": "SYSTEM_EVENT|42" + } } diff --git a/_assets/simulator/spec/methods/im.recent.get.json b/_assets/simulator/spec/methods/im.recent.get.json index 2de8339cd..a7a9d0889 100644 --- a/_assets/simulator/spec/methods/im.recent.get.json +++ b/_assets/simulator/spec/methods/im.recent.get.json @@ -312,5 +312,9 @@ "type", "unread", "user" - ] + ], + "requestExample": { + "SKIP_OPENLINES": "Y", + "LAST_UPDATE": "2026-02-25T18:30:00+01:00" + } } diff --git a/_assets/simulator/spec/methods/im.recent.hide.json b/_assets/simulator/spec/methods/im.recent.hide.json index 8a625c115..d6d0e14f8 100644 --- a/_assets/simulator/spec/methods/im.recent.hide.json +++ b/_assets/simulator/spec/methods/im.recent.hide.json @@ -50,5 +50,8 @@ } ], "page": "/api-reference/chats/special-operations/im-recent-hide.html", - "executable": false + "executable": false, + "requestExample": { + "DIALOG_ID": "chat1489" + } } diff --git a/_assets/simulator/spec/methods/im.recent.list.json b/_assets/simulator/spec/methods/im.recent.list.json index 86006c046..d6dc16f93 100644 --- a/_assets/simulator/spec/methods/im.recent.list.json +++ b/_assets/simulator/spec/methods/im.recent.list.json @@ -132,6 +132,23 @@ } ] }, + { + "name": "ONLY_OPENLINES", + "type": "string", + "base": "string", + "required": "unknown", + "description": "Возвращать только чаты открытых линий. Возможные значения: - Y — да - N — нет", + "values": [ + { + "value": "Y", + "title": "да" + }, + { + "value": "N", + "title": "нет" + } + ] + }, { "name": "ONLY_COPILOT", "type": "string", @@ -501,5 +518,20 @@ "type", "unread", "user" - ] + ], + "requestExample": { + "LAST_MESSAGE_DATE": "2026-02-25T18:30:00+03:00", + "SKIP_OPENLINES": "N", + "SKIP_DIALOG": "N", + "SKIP_CHAT": "N", + "UNREAD_ONLY": "Y", + "PARSE_TEXT": "Y", + "GET_ORIGINAL_TEXT": "N", + "SKIP_UNDISTRIBUTED_OPENLINES": "Y", + "ONLY_COPILOT": "N", + "ONLY_CHANNEL": "N", + "CAN_MANAGE_MESSAGES": "Y", + "OFFSET": 0, + "LIMIT": 20 + } } diff --git a/_assets/simulator/spec/methods/im.recent.pin.json b/_assets/simulator/spec/methods/im.recent.pin.json index 21c4f2abe..c78b6afbb 100644 --- a/_assets/simulator/spec/methods/im.recent.pin.json +++ b/_assets/simulator/spec/methods/im.recent.pin.json @@ -57,5 +57,9 @@ } ], "page": "/api-reference/chats/special-operations/im-recent-pin.html", - "executable": false + "executable": false, + "requestExample": { + "DIALOG_ID": "chat1489", + "PIN": "Y" + } } diff --git a/_assets/simulator/spec/methods/im.recent.unread.json b/_assets/simulator/spec/methods/im.recent.unread.json index 28ac44a50..34a05629c 100644 --- a/_assets/simulator/spec/methods/im.recent.unread.json +++ b/_assets/simulator/spec/methods/im.recent.unread.json @@ -57,5 +57,9 @@ } ], "page": "/api-reference/chats/special-operations/im-recent-unread.html", - "executable": false + "executable": false, + "requestExample": { + "DIALOG_ID": "chat2941", + "ACTION": "Y" + } } diff --git a/_assets/simulator/spec/methods/im.revision.get.json b/_assets/simulator/spec/methods/im.revision.get.json index c5ddbc2c7..ef0922a6d 100644 --- a/_assets/simulator/spec/methods/im.revision.get.json +++ b/_assets/simulator/spec/methods/im.revision.get.json @@ -148,5 +148,6 @@ "mobile", "rest", "web" - ] + ], + "requestExample": {} } diff --git a/_assets/simulator/spec/methods/im.search.chat.list.json b/_assets/simulator/spec/methods/im.search.chat.list.json index 3e323eaba..576951136 100644 --- a/_assets/simulator/spec/methods/im.search.chat.list.json +++ b/_assets/simulator/spec/methods/im.search.chat.list.json @@ -182,5 +182,10 @@ "type", "unread_id", "user_counter" - ] + ], + "requestExample": { + "FIND": "Проект", + "OFFSET": 0, + "LIMIT": 10 + } } diff --git a/_assets/simulator/spec/methods/im.search.department.list.json b/_assets/simulator/spec/methods/im.search.department.list.json index 5ca3290a9..1309c44a9 100644 --- a/_assets/simulator/spec/methods/im.search.department.list.json +++ b/_assets/simulator/spec/methods/im.search.department.list.json @@ -145,5 +145,11 @@ "manager_user_data", "manager_user_id", "name" - ] + ], + "requestExample": { + "FIND": "Отдел", + "USER_DATA": "Y", + "OFFSET": 0, + "LIMIT": 10 + } } diff --git a/_assets/simulator/spec/methods/im.search.last.add.json b/_assets/simulator/spec/methods/im.search.last.add.json index 220457f60..2b8e727e2 100644 --- a/_assets/simulator/spec/methods/im.search.last.add.json +++ b/_assets/simulator/spec/methods/im.search.last.add.json @@ -50,5 +50,8 @@ } ], "page": "/api-reference/chats/search/im-search-last-add.html", - "executable": false + "executable": false, + "requestExample": { + "DIALOG_ID": "chat17" + } } diff --git a/_assets/simulator/spec/methods/im.search.last.delete.json b/_assets/simulator/spec/methods/im.search.last.delete.json index 921a8e2a7..e1552c3ef 100644 --- a/_assets/simulator/spec/methods/im.search.last.delete.json +++ b/_assets/simulator/spec/methods/im.search.last.delete.json @@ -50,5 +50,8 @@ } ], "page": "/api-reference/chats/search/im-search-last-delete.html", - "executable": false + "executable": false, + "requestExample": { + "DIALOG_ID": "chat17" + } } diff --git a/_assets/simulator/spec/methods/im.search.last.get.json b/_assets/simulator/spec/methods/im.search.last.get.json index cd00535be..5f70b430c 100644 --- a/_assets/simulator/spec/methods/im.search.last.get.json +++ b/_assets/simulator/spec/methods/im.search.last.get.json @@ -174,5 +174,10 @@ "id", "title", "type" - ] + ], + "requestExample": { + "SKIP_OPENLINES": "N", + "SKIP_CHAT": "N", + "SKIP_DIALOG": "N" + } } diff --git a/_assets/simulator/spec/methods/im.search.user.list.json b/_assets/simulator/spec/methods/im.search.user.list.json index 35b0e120b..3449516ec 100644 --- a/_assets/simulator/spec/methods/im.search.user.list.json +++ b/_assets/simulator/spec/methods/im.search.user.list.json @@ -150,5 +150,11 @@ "phones", "status", "work_position" - ] + ], + "requestExample": { + "FIND": "Иван", + "BUSINESS": "N", + "OFFSET": 0, + "LIMIT": 10 + } } diff --git a/_assets/simulator/spec/methods/im.user.get.json b/_assets/simulator/spec/methods/im.user.get.json index 234baf278..57d0f4670 100644 --- a/_assets/simulator/spec/methods/im.user.get.json +++ b/_assets/simulator/spec/methods/im.user.get.json @@ -92,5 +92,9 @@ } ], "page": "/api-reference/chats/users/im-user-get.html", - "executable": false + "executable": false, + "requestExample": { + "ID": 5, + "AVATAR_HR": "Y" + } } diff --git a/_assets/simulator/spec/methods/im.user.list.get.json b/_assets/simulator/spec/methods/im.user.list.get.json index 154a2008b..3fd85fd7e 100644 --- a/_assets/simulator/spec/methods/im.user.list.get.json +++ b/_assets/simulator/spec/methods/im.user.list.get.json @@ -172,5 +172,13 @@ "type", "website", "work_position" - ] + ], + "requestExample": { + "ID": [ + 4, + 5 + ], + "AVATAR_HR": "Y", + "RESULT_TYPE": "array" + } } diff --git a/_assets/simulator/spec/methods/im.user.status.idle.start.json b/_assets/simulator/spec/methods/im.user.status.idle.start.json index 37bb874b5..27a570cfd 100644 --- a/_assets/simulator/spec/methods/im.user.status.idle.start.json +++ b/_assets/simulator/spec/methods/im.user.status.idle.start.json @@ -50,5 +50,8 @@ } ], "page": "/api-reference/chats/users/im-user-status-idle-start.html", - "executable": false + "executable": false, + "requestExample": { + "AGO": 10 + } } diff --git a/_assets/simulator/spec/methods/im.user.status.set.json b/_assets/simulator/spec/methods/im.user.status.set.json index d370bddac..482e91c52 100644 --- a/_assets/simulator/spec/methods/im.user.status.set.json +++ b/_assets/simulator/spec/methods/im.user.status.set.json @@ -68,5 +68,8 @@ } ], "page": "/api-reference/chats/users/im-user-status-set.html", - "executable": false + "executable": false, + "requestExample": { + "STATUS": "dnd" + } } diff --git a/_assets/simulator/spec/methods/im.v2.Event.get.json b/_assets/simulator/spec/methods/im.v2.Event.get.json index a52ec418d..56da64eb0 100644 --- a/_assets/simulator/spec/methods/im.v2.Event.get.json +++ b/_assets/simulator/spec/methods/im.v2.Event.get.json @@ -56,5 +56,9 @@ "date", "eventId", "type" - ] + ], + "requestExample": { + "offset": 2000, + "limit": 50 + } } diff --git a/_assets/simulator/spec/methods/im.v2.File.download.json b/_assets/simulator/spec/methods/im.v2.File.download.json index d175de3d0..71368de2a 100644 --- a/_assets/simulator/spec/methods/im.v2.File.download.json +++ b/_assets/simulator/spec/methods/im.v2.File.download.json @@ -64,5 +64,9 @@ } ], "page": "/api-reference/chat-bots/chat-bots-v2/im.v2/files/file-download.html", - "executable": false + "executable": false, + "requestExample": { + "dialogId": "chat5", + "fileId": 138 + } } diff --git a/_assets/simulator/spec/methods/im.v2.File.upload.json b/_assets/simulator/spec/methods/im.v2.File.upload.json index c97a55497..1a7f4cbe3 100644 --- a/_assets/simulator/spec/methods/im.v2.File.upload.json +++ b/_assets/simulator/spec/methods/im.v2.File.upload.json @@ -157,5 +157,13 @@ } ], "page": "/api-reference/chat-bots/chat-bots-v2/im.v2/files/file-upload.html", - "executable": false + "executable": false, + "requestExample": { + "dialogId": "chat5", + "fields": { + "name": "report.pdf", + "content": "SGVsbG8gV29ybGQh", + "message": "Here is the report" + } + } } diff --git a/_assets/simulator/spec/methods/imbot.chat.setOwner.json b/_assets/simulator/spec/methods/imbot.chat.setOwner.json index 2c770532b..5fcd4041e 100644 --- a/_assets/simulator/spec/methods/imbot.chat.setOwner.json +++ b/_assets/simulator/spec/methods/imbot.chat.setOwner.json @@ -74,5 +74,9 @@ } ], "page": "/api-reference/chat-bots/outdated/chats/imbot-chat-set-owner.html", - "executable": false + "executable": false, + "requestExample": { + "CHAT_ID": 2727, + "USER_ID": 1269 + } } diff --git a/_assets/simulator/spec/methods/imbot.v2.Bot.get.json b/_assets/simulator/spec/methods/imbot.v2.Bot.get.json index f2d9c4315..f8d3852bb 100644 --- a/_assets/simulator/spec/methods/imbot.v2.Bot.get.json +++ b/_assets/simulator/spec/methods/imbot.v2.Bot.get.json @@ -88,5 +88,9 @@ "language", "moduleId", "type" - ] + ], + "requestExample": { + "botToken": "my_bot_token", + "code": "support_bot" + } } diff --git a/_assets/simulator/spec/methods/imbot.v2.Bot.list.json b/_assets/simulator/spec/methods/imbot.v2.Bot.list.json index 63df46bd0..6a4280b17 100644 --- a/_assets/simulator/spec/methods/imbot.v2.Bot.list.json +++ b/_assets/simulator/spec/methods/imbot.v2.Bot.list.json @@ -102,5 +102,12 @@ "language", "moduleId", "type" - ] + ], + "requestExample": { + "botToken": "my_bot_token", + "filter": { + "type": "bot" + }, + "limit": 10 + } } diff --git a/_assets/simulator/spec/methods/imbot.v2.Bot.register.json b/_assets/simulator/spec/methods/imbot.v2.Bot.register.json index b00d2184e..552120c61 100644 --- a/_assets/simulator/spec/methods/imbot.v2.Bot.register.json +++ b/_assets/simulator/spec/methods/imbot.v2.Bot.register.json @@ -167,5 +167,17 @@ } }, "page": "/api-reference/chat-bots/chat-bots-v2/imbot.v2/bots/bot-register.html", - "executable": false + "executable": false, + "requestExample": { + "fields": { + "code": "support_bot", + "botToken": "my_bot_token", + "properties": { + "name": "Support Bot", + "workPosition": "AI Assistant" + }, + "type": "bot", + "eventMode": "fetch" + } + } } diff --git a/_assets/simulator/spec/methods/imbot.v2.Bot.unregister.json b/_assets/simulator/spec/methods/imbot.v2.Bot.unregister.json index 31d02eafa..2c6e60100 100644 --- a/_assets/simulator/spec/methods/imbot.v2.Bot.unregister.json +++ b/_assets/simulator/spec/methods/imbot.v2.Bot.unregister.json @@ -41,5 +41,9 @@ } }, "page": "/api-reference/chat-bots/chat-bots-v2/imbot.v2/bots/bot-unregister.html", - "executable": false + "executable": false, + "requestExample": { + "botId": 456, + "botToken": "my_bot_token" + } } diff --git a/_assets/simulator/spec/methods/imbot.v2.Bot.update.json b/_assets/simulator/spec/methods/imbot.v2.Bot.update.json index f7d156007..fdcbf334e 100644 --- a/_assets/simulator/spec/methods/imbot.v2.Bot.update.json +++ b/_assets/simulator/spec/methods/imbot.v2.Bot.update.json @@ -139,5 +139,15 @@ } }, "page": "/api-reference/chat-bots/chat-bots-v2/imbot.v2/bots/bot-update.html", - "executable": false + "executable": false, + "requestExample": { + "botId": 456, + "botToken": "my_bot_token", + "fields": { + "properties": { + "name": "Updated Bot" + }, + "isHidden": true + } + } } diff --git a/_assets/simulator/spec/methods/imbot.v2.Chat.InputAction.notify.json b/_assets/simulator/spec/methods/imbot.v2.Chat.InputAction.notify.json index 30c3a4cb9..036eaa6dc 100644 --- a/_assets/simulator/spec/methods/imbot.v2.Chat.InputAction.notify.json +++ b/_assets/simulator/spec/methods/imbot.v2.Chat.InputAction.notify.json @@ -62,5 +62,12 @@ } }, "page": "/api-reference/chat-bots/chat-bots-v2/imbot.v2/ui/chat-input-action-notify.html", - "executable": false + "executable": false, + "requestExample": { + "botId": 456, + "botToken": "my_bot_token", + "dialogId": "chat5", + "statusMessageCode": "IMBOT_AGENT_ACTION_THINKING", + "duration": 30 + } } diff --git a/_assets/simulator/spec/methods/imbot.v2.Chat.Manager.add.json b/_assets/simulator/spec/methods/imbot.v2.Chat.Manager.add.json index 1791aeb19..44deba1b9 100644 --- a/_assets/simulator/spec/methods/imbot.v2.Chat.Manager.add.json +++ b/_assets/simulator/spec/methods/imbot.v2.Chat.Manager.add.json @@ -18,14 +18,14 @@ "type": "string", "base": "string", "required": false, - "description": "Уникальный токен авторизации бота. Обязателен при авторизации через вебхук, не нужен для OAuth. Передавайте тот же botToken, который был указан при регистрации чат-бота" + "description": "Токен бота. Обязателен при авторизации через вебхук, для OAuth не нужен. Передавайте тот же botToken, который указали при регистрации бота" }, { "name": "dialogId", "type": "string", "base": "string", "required": true, - "description": "ID диалога. Для групповых чатов — chat{chatId}" + "description": "ID группового чата в формате dialogId: chat{chatId}" }, { "name": "userIds", @@ -59,5 +59,14 @@ } }, "page": "/api-reference/chat-bots/chat-bots-v2/imbot.v2/chats/chat-manager-add.html", - "executable": false + "executable": false, + "requestExample": { + "botId": 456, + "botToken": "my_bot_token", + "dialogId": "chat5", + "userIds": [ + 4, + 5 + ] + } } diff --git a/_assets/simulator/spec/methods/imbot.v2.Chat.Manager.delete.json b/_assets/simulator/spec/methods/imbot.v2.Chat.Manager.delete.json index ecfb16e6b..5eb085df1 100644 --- a/_assets/simulator/spec/methods/imbot.v2.Chat.Manager.delete.json +++ b/_assets/simulator/spec/methods/imbot.v2.Chat.Manager.delete.json @@ -18,14 +18,14 @@ "type": "string", "base": "string", "required": false, - "description": "Уникальный токен авторизации бота. Обязателен при авторизации через вебхук, не нужен для OAuth. Передавайте тот же botToken, который был указан при регистрации чат-бота" + "description": "Токен бота. Обязателен при авторизации через вебхук, для OAuth не нужен. Передавайте тот же botToken, который указали при регистрации бота" }, { "name": "dialogId", "type": "string", "base": "string", "required": true, - "description": "ID диалога. Для групповых чатов — chat{chatId}" + "description": "ID группового чата в формате dialogId: chat{chatId}" }, { "name": "userIds", @@ -59,5 +59,14 @@ } }, "page": "/api-reference/chat-bots/chat-bots-v2/imbot.v2/chats/chat-manager-delete.html", - "executable": false + "executable": false, + "requestExample": { + "botId": 456, + "botToken": "my_bot_token", + "dialogId": "chat5", + "userIds": [ + 4, + 5 + ] + } } diff --git a/_assets/simulator/spec/methods/imbot.v2.Chat.Message.Reaction.add.json b/_assets/simulator/spec/methods/imbot.v2.Chat.Message.Reaction.add.json index ebf6d9374..d7a981aee 100644 --- a/_assets/simulator/spec/methods/imbot.v2.Chat.Message.Reaction.add.json +++ b/_assets/simulator/spec/methods/imbot.v2.Chat.Message.Reaction.add.json @@ -55,5 +55,11 @@ } }, "page": "/api-reference/chat-bots/chat-bots-v2/imbot.v2/messages/chat-message-reaction-add.html", - "executable": false + "executable": false, + "requestExample": { + "botId": 456, + "botToken": "my_bot_token", + "messageId": 789, + "reaction": "like" + } } diff --git a/_assets/simulator/spec/methods/imbot.v2.Chat.Message.Reaction.delete.json b/_assets/simulator/spec/methods/imbot.v2.Chat.Message.Reaction.delete.json index bc8ae31fb..ddd3e3c95 100644 --- a/_assets/simulator/spec/methods/imbot.v2.Chat.Message.Reaction.delete.json +++ b/_assets/simulator/spec/methods/imbot.v2.Chat.Message.Reaction.delete.json @@ -55,5 +55,11 @@ } }, "page": "/api-reference/chat-bots/chat-bots-v2/imbot.v2/messages/chat-message-reaction-delete.html", - "executable": false + "executable": false, + "requestExample": { + "botId": 456, + "botToken": "my_bot_token", + "messageId": 789, + "reaction": "like" + } } diff --git a/_assets/simulator/spec/methods/imbot.v2.Chat.Message.delete.json b/_assets/simulator/spec/methods/imbot.v2.Chat.Message.delete.json index c67c30c9a..d79fa5d47 100644 --- a/_assets/simulator/spec/methods/imbot.v2.Chat.Message.delete.json +++ b/_assets/simulator/spec/methods/imbot.v2.Chat.Message.delete.json @@ -55,5 +55,10 @@ } }, "page": "/api-reference/chat-bots/chat-bots-v2/imbot.v2/messages/chat-message-delete.html", - "executable": false + "executable": false, + "requestExample": { + "botId": 456, + "botToken": "my_bot_token", + "messageId": 789 + } } diff --git a/_assets/simulator/spec/methods/imbot.v2.Chat.Message.get.json b/_assets/simulator/spec/methods/imbot.v2.Chat.Message.get.json index cc286baf0..5e0fa9ee8 100644 --- a/_assets/simulator/spec/methods/imbot.v2.Chat.Message.get.json +++ b/_assets/simulator/spec/methods/imbot.v2.Chat.Message.get.json @@ -78,5 +78,10 @@ "text", "uuid", "viewedByOthers" - ] + ], + "requestExample": { + "botId": 456, + "botToken": "my_bot_token", + "messageId": 789 + } } diff --git a/_assets/simulator/spec/methods/imbot.v2.Chat.Message.getContext.json b/_assets/simulator/spec/methods/imbot.v2.Chat.Message.getContext.json index 114230bc2..ea4e9e0cb 100644 --- a/_assets/simulator/spec/methods/imbot.v2.Chat.Message.getContext.json +++ b/_assets/simulator/spec/methods/imbot.v2.Chat.Message.getContext.json @@ -98,5 +98,11 @@ } }, "page": "/api-reference/chat-bots/chat-bots-v2/imbot.v2/messages/chat-message-get-context.html", - "executable": false + "executable": false, + "requestExample": { + "botId": 456, + "botToken": "my_bot_token", + "messageId": 789, + "range": 20 + } } diff --git a/_assets/simulator/spec/methods/imbot.v2.Chat.Message.read.json b/_assets/simulator/spec/methods/imbot.v2.Chat.Message.read.json index fcdfb8399..2d6c0eeaf 100644 --- a/_assets/simulator/spec/methods/imbot.v2.Chat.Message.read.json +++ b/_assets/simulator/spec/methods/imbot.v2.Chat.Message.read.json @@ -62,5 +62,11 @@ } }, "page": "/api-reference/chat-bots/chat-bots-v2/imbot.v2/messages/chat-message-read.html", - "executable": false + "executable": false, + "requestExample": { + "botId": 456, + "botToken": "my_bot_token", + "dialogId": "chat5", + "messageId": 789 + } } diff --git a/_assets/simulator/spec/methods/imbot.v2.Chat.Message.send.json b/_assets/simulator/spec/methods/imbot.v2.Chat.Message.send.json index d83300f03..58264d599 100644 --- a/_assets/simulator/spec/methods/imbot.v2.Chat.Message.send.json +++ b/_assets/simulator/spec/methods/imbot.v2.Chat.Message.send.json @@ -53,10 +53,10 @@ }, { "name": "attach", - "type": "array", - "base": "array", + "type": "object", + "base": "object", "required": false, - "description": "Вложения. Подробнее: Как использовать вложения" + "description": "Вложение: объект с массивом BLOCKS или сразу массив блоков. Подробнее: Как использовать вложения" }, { "name": "keyboard", @@ -123,5 +123,20 @@ } }, "page": "/api-reference/chat-bots/chat-bots-v2/imbot.v2/messages/chat-message-send.html", - "executable": false + "executable": false, + "requestExample": { + "botId": 456, + "botToken": "my_bot_token", + "dialogId": "chat5", + "fields": { + "message": "Hello from bot!", + "keyboard": [ + { + "TEXT": "Open", + "LINK": "https://example.com", + "BG_COLOR_TOKEN": "primary" + } + ] + } + } } diff --git a/_assets/simulator/spec/methods/imbot.v2.Chat.Message.update.json b/_assets/simulator/spec/methods/imbot.v2.Chat.Message.update.json index 37165f0e8..0c70912aa 100644 --- a/_assets/simulator/spec/methods/imbot.v2.Chat.Message.update.json +++ b/_assets/simulator/spec/methods/imbot.v2.Chat.Message.update.json @@ -53,10 +53,10 @@ }, { "name": "attach", - "type": "array", - "base": "array", + "type": "object", + "base": "object", "required": false, - "description": "Новые вложения. Подробнее: Как использовать вложения" + "description": "Новое вложение в полной форме: объект с массивом BLOCKS. Краткую форму — массив блоков — метод не принимает и удаляет вложение. Пустая строка удаляет вложение. Подробнее: Как использовать вложения" }, { "name": "keyboard", @@ -94,5 +94,13 @@ } }, "page": "/api-reference/chat-bots/chat-bots-v2/imbot.v2/messages/chat-message-update.html", - "executable": false + "executable": false, + "requestExample": { + "botId": 456, + "botToken": "my_bot_token", + "messageId": 789, + "fields": { + "message": "Updated text" + } + } } diff --git a/_assets/simulator/spec/methods/imbot.v2.Chat.TextField.enabled.json b/_assets/simulator/spec/methods/imbot.v2.Chat.TextField.enabled.json index 525e7fc18..2454c8abf 100644 --- a/_assets/simulator/spec/methods/imbot.v2.Chat.TextField.enabled.json +++ b/_assets/simulator/spec/methods/imbot.v2.Chat.TextField.enabled.json @@ -55,5 +55,11 @@ } }, "page": "/api-reference/chat-bots/chat-bots-v2/imbot.v2/ui/chat-text-field-enabled.html", - "executable": false + "executable": false, + "requestExample": { + "botId": 456, + "botToken": "my_bot_token", + "dialogId": "chat5", + "enabled": false + } } diff --git a/_assets/simulator/spec/methods/imbot.v2.Chat.User.add.json b/_assets/simulator/spec/methods/imbot.v2.Chat.User.add.json index 876b73eea..777e90836 100644 --- a/_assets/simulator/spec/methods/imbot.v2.Chat.User.add.json +++ b/_assets/simulator/spec/methods/imbot.v2.Chat.User.add.json @@ -18,20 +18,20 @@ "type": "string", "base": "string", "required": false, - "description": "Уникальный токен авторизации бота. Обязателен при авторизации через вебхук, не нужен для OAuth. Передавайте тот же botToken, который был указан при регистрации чат-бота" + "description": "Токен бота. Обязателен при авторизации через вебхук, для OAuth не нужен. Передавайте тот же botToken, который указали при регистрации бота" }, { "name": "dialogId", "type": "string", "base": "string", "required": true, - "description": "ID диалога. Для групповых чатов — chat{chatId}" + "description": "ID группового чата в формате dialogId: chat{chatId}" }, { "name": "userIds", "type": "integer[]", "base": "array", - "required": true, + "required": false, "description": "Массив ID пользователей для добавления", "dynamic": { "allowed": true, @@ -59,5 +59,15 @@ } }, "page": "/api-reference/chat-bots/chat-bots-v2/imbot.v2/chats/chat-user-add.html", - "executable": false + "executable": false, + "requestExample": { + "botId": 456, + "botToken": "my_bot_token", + "dialogId": "chat5", + "userIds": [ + 1, + 2, + 3 + ] + } } diff --git a/_assets/simulator/spec/methods/imbot.v2.Chat.User.delete.json b/_assets/simulator/spec/methods/imbot.v2.Chat.User.delete.json index 5efef30ae..43226856c 100644 --- a/_assets/simulator/spec/methods/imbot.v2.Chat.User.delete.json +++ b/_assets/simulator/spec/methods/imbot.v2.Chat.User.delete.json @@ -18,14 +18,14 @@ "type": "string", "base": "string", "required": false, - "description": "Уникальный токен авторизации бота. Обязателен при авторизации через вебхук, не нужен для OAuth. Передавайте тот же botToken, который был указан при регистрации чат-бота" + "description": "Токен бота. Обязателен при авторизации через вебхук, для OAuth не нужен. Передавайте тот же botToken, который указали при регистрации бота" }, { "name": "dialogId", "type": "string", "base": "string", "required": true, - "description": "ID диалога. Для групповых чатов — chat{chatId}" + "description": "ID группового чата в формате dialogId: chat{chatId}" }, { "name": "userId", @@ -55,5 +55,11 @@ } }, "page": "/api-reference/chat-bots/chat-bots-v2/imbot.v2/chats/chat-user-delete.html", - "executable": false + "executable": false, + "requestExample": { + "botId": 456, + "botToken": "my_bot_token", + "dialogId": "chat5", + "userId": 1 + } } diff --git a/_assets/simulator/spec/methods/imbot.v2.Chat.User.list.json b/_assets/simulator/spec/methods/imbot.v2.Chat.User.list.json index c7c4d354f..698db3f3b 100644 --- a/_assets/simulator/spec/methods/imbot.v2.Chat.User.list.json +++ b/_assets/simulator/spec/methods/imbot.v2.Chat.User.list.json @@ -3,7 +3,7 @@ "method": "imbot.v2.Chat.User.list", "scope": "imbot", "kind": "read", - "title": "Список участников чата imbot.v2.Chat.User.list", + "title": "Получить список участников чата imbot.v2.Chat.User.list", "permissions": "владелец зарегистрированного бота", "params": [ { @@ -18,21 +18,21 @@ "type": "string", "base": "string", "required": false, - "description": "Уникальный токен авторизации бота. Обязателен при авторизации через вебхук, не нужен для OAuth. Передавайте тот же botToken, который был указан при регистрации чат-бота" + "description": "Токен бота. Обязателен при авторизации через вебхук, для OAuth не нужен. Передавайте тот же botToken, который указали при регистрации бота" }, { "name": "dialogId", "type": "string", "base": "string", "required": true, - "description": "ID диалога. Для групповых чатов — chat{chatId}" + "description": "ID группового чата в формате dialogId: chat{chatId}" }, { "name": "order", "type": "object", "base": "object", "required": false, - "description": "Сортировка. Доступные поля: id, lastSendMessageId, userId. Значение: ASC или DESC. Пример: {\"id\": \"ASC\"}", + "description": "Сортировка. Доступные поля: - id — порядок вступления в чат - lastSendMessageId — ID последнего сообщения участника - userId — ID пользователя Направление сортировки: ASC или DESC. Если передать несколько полей, метод учтет одно — то, что стоит выше в списке доступных полей. Без order порядок не гарантирован. Пример: {\"id\": \"ASC\"}", "dynamic": { "allowed": true, "note": "Состав полей не описан подтаблицей на этой странице" @@ -43,7 +43,7 @@ "type": "integer", "base": "integer", "required": false, - "description": "Количество записей (1–200). По умолчанию 50" + "description": "Количество записей, от 1 до 200. По умолчанию 50. Значение вне диапазона не вызывает ошибку — метод вернет до 50 записей" } ], "defs": {}, @@ -72,12 +72,16 @@ "status": "online", "idle": false, "lastActivityDate": "2025-01-15T14:25:00+03:00", + "mobileLastDate": false, + "desktopLastDate": "2025-01-15T14:25:00+03:00", "absent": false, "departments": [ 7 ], "phones": false, - "type": "employee" + "type": "user", + "website": "", + "email": "" }, { "id": 2, @@ -97,12 +101,16 @@ "status": "online", "idle": false, "lastActivityDate": "2025-01-15T14:20:00+03:00", + "mobileLastDate": false, + "desktopLastDate": "2025-01-15T14:20:00+03:00", "absent": false, "departments": [ 12 ], "phones": false, - "type": "employee" + "type": "user", + "website": "", + "email": "" } ], "time": { @@ -125,6 +133,8 @@ "color", "connector", "departments", + "desktopLastDate", + "email", "externalAuthId", "extranet", "firstName", @@ -133,10 +143,21 @@ "idle", "lastActivityDate", "lastName", + "mobileLastDate", "name", "phones", "status", "type", + "website", "workPosition" - ] + ], + "requestExample": { + "botId": 456, + "botToken": "my_bot_token", + "dialogId": "chat5", + "order": { + "id": "ASC" + }, + "limit": 50 + } } diff --git a/_assets/simulator/spec/methods/imbot.v2.Chat.add.json b/_assets/simulator/spec/methods/imbot.v2.Chat.add.json index e7f186840..6c23844a1 100644 --- a/_assets/simulator/spec/methods/imbot.v2.Chat.add.json +++ b/_assets/simulator/spec/methods/imbot.v2.Chat.add.json @@ -18,14 +18,14 @@ "type": "string", "base": "string", "required": false, - "description": "Уникальный токен авторизации бота. Обязателен при авторизации через вебхук, не нужен для OAuth. Передавайте тот же botToken, который был указан при регистрации чат-бота" + "description": "Токен бота. Обязателен при авторизации через вебхук, для OAuth не нужен. Передавайте тот же botToken, который указали при регистрации бота" }, { "name": "fields", "type": "object", "base": "object", "required": false, - "description": "Свойства создаваемого чата. Структура объекта описана ниже", + "description": "Свойства создаваемого чата (подробное описание)", "ref": "#/defs/fieldsFields" } ], @@ -37,6 +37,13 @@ "note": "Пользовательские поля UF_* в схеме не описаны" }, "fields": [ + { + "name": "type", + "type": "string", + "base": "string", + "required": false, + "description": "Тип чата: - chat — закрытый групповой чат, по умолчанию - open — открытый чат, в который может вступить любой сотрудник С другим значением метод создаст закрытый чат" + }, { "name": "title", "type": "string", @@ -70,21 +77,14 @@ "type": "integer[]", "base": "array", "required": false, - "description": "Массив ID участников" + "description": "Массив ID участников. Бота передавать не нужно — он добавляется в чат автоматически" }, { "name": "ownerId", "type": "integer", "base": "integer", "required": false, - "description": "ID владельца чата. Если не указан — владельцем становится бот" - }, - { - "name": "message", - "type": "string", - "base": "string", - "required": false, - "description": "Первое сообщение в чате" + "description": "ID владельца чата, по умолчанию — бот. Владелец автоматически добавляется в чат участником и менеджером. Метод не проверяет, существует ли пользователь: с несуществующим ID чат создастся без ошибки и останется без владельца" } ] } @@ -113,77 +113,77 @@ "entityData1": "", "entityData2": "", "entityData3": "", - "entityLink": {}, - "diskFolderId": 42, + "entityLink": { + "type": "", + "url": "", + "id": "" + }, + "diskFolderId": null, "role": "owner", - "permissions": {}, + "permissions": { + "manageUsersAdd": "member", + "manageUsersDelete": "manager", + "manageUi": "member", + "manageSettings": "owner", + "manageMessages": "member", + "manageMessagesAutoDelete": "manager", + "manageGuestInvites": "manager", + "manageDelete": "member", + "canPost": "member" + }, + "hasManageCapability": false, + "canHaveThreads": true, "muteList": [], "parentChatId": null, "parentMessageId": null, - "isNew": true, - "textFieldEnabled": "Y", + "isNew": false, + "textFieldEnabled": true, "backgroundId": null, "dateCreate": "2025-01-15T10:00:00+03:00", "lastMessageId": 789, - "lastMessageViews": "{}", - "lastId": null, - "managerList": [], - "markedId": null, + "lastMessageViews": { + "messageId": 789, + "firstViewers": [], + "countOfViewers": 0 + }, + "lastId": 0, + "managerList": [ + 456 + ], + "markedId": 0, "messageCount": 1, "public": "", - "unreadId": null, - "userCounter": 3 + "unreadId": 0, + "userCounter": 3, + "guestCount": 0 }, "users": [ { - "id": 1, + "id": 456, "active": true, - "name": "John Smith", - "firstName": "John", - "lastName": "Smith", - "workPosition": "Developer", - "color": "#ab7761", + "name": "Support Bot", + "firstName": "Support Bot", + "lastName": "", + "workPosition": "", + "color": "#4ba984", "avatar": "", "gender": "M", - "birthday": "15-03", + "birthday": "", "extranet": false, - "bot": false, + "bot": true, "connector": false, - "externalAuthId": "default", + "externalAuthId": "bot", "status": "online", "idle": false, - "lastActivityDate": "2025-01-15T14:25:00+03:00", + "lastActivityDate": false, + "mobileLastDate": false, + "desktopLastDate": false, "absent": false, - "departments": [ - 7 - ], + "departments": [], "phones": false, - "type": "employee" - }, - { - "id": 2, - "active": true, - "name": "Anna Davis", - "firstName": "Anna", - "lastName": "Davis", - "workPosition": "Manager", - "color": "#5b7e91", - "avatar": "", - "gender": "F", - "birthday": "22-08", - "extranet": false, - "bot": false, - "connector": false, - "externalAuthId": "default", - "status": "online", - "idle": false, - "lastActivityDate": "2025-01-15T14:20:00+03:00", - "absent": false, - "departments": [ - 12 - ], - "phones": false, - "type": "employee" + "type": "bot", + "website": "", + "email": "" } ] }, @@ -197,5 +197,17 @@ } }, "page": "/api-reference/chat-bots/chat-bots-v2/imbot.v2/chats/chat-add.html", - "executable": false + "executable": false, + "requestExample": { + "botId": 456, + "botToken": "my_bot_token", + "fields": { + "title": "Support Chat", + "color": "mint", + "userIds": [ + 1, + 2 + ] + } + } } diff --git a/_assets/simulator/spec/methods/imbot.v2.Chat.get.json b/_assets/simulator/spec/methods/imbot.v2.Chat.get.json index 221ff02c4..c24d17e9b 100644 --- a/_assets/simulator/spec/methods/imbot.v2.Chat.get.json +++ b/_assets/simulator/spec/methods/imbot.v2.Chat.get.json @@ -18,14 +18,14 @@ "type": "string", "base": "string", "required": false, - "description": "Уникальный токен авторизации бота. Обязателен при авторизации через вебхук, не нужен для OAuth. Передавайте тот же botToken, который был указан при регистрации чат-бота" + "description": "Токен бота. Обязателен при авторизации через вебхук, для OAuth не нужен. Передавайте тот же botToken, который указали при регистрации бота" }, { "name": "dialogId", "type": "string", "base": "string", "required": true, - "description": "ID диалога. Для групповых чатов — chat{chatId}, для личных — {userId}" + "description": "ID диалога в формате dialogId: chat{chatId} для группового чата, {userId} для личного" } ], "defs": {}, @@ -53,27 +53,79 @@ "entityData1": "", "entityData2": "", "entityData3": "", - "entityLink": {}, - "diskFolderId": 42, + "entityLink": { + "type": "", + "url": "", + "id": "" + }, + "diskFolderId": null, "role": "owner", - "permissions": {}, + "permissions": { + "manageUsersAdd": "member", + "manageUsersDelete": "manager", + "manageUi": "member", + "manageSettings": "owner", + "manageMessages": "member", + "manageMessagesAutoDelete": "manager", + "manageGuestInvites": "manager", + "manageDelete": "member", + "canPost": "member" + }, + "hasManageCapability": false, + "canHaveThreads": true, "muteList": [], "parentChatId": null, "parentMessageId": null, "isNew": false, - "textFieldEnabled": "Y", + "textFieldEnabled": true, "backgroundId": null, "dateCreate": "2025-01-15T10:00:00+03:00", "lastMessageId": 789, - "lastMessageViews": "{}", + "lastMessageViews": { + "messageId": 789, + "firstViewers": [], + "countOfViewers": 0 + }, "lastId": 789, - "managerList": [], - "markedId": null, + "managerList": [ + 456 + ], + "markedId": 0, "messageCount": 15, "public": "", - "unreadId": null, - "userCounter": 3 - } + "unreadId": 0, + "userCounter": 3, + "guestCount": 0 + }, + "users": [ + { + "id": 456, + "active": true, + "name": "Support Bot", + "firstName": "Support Bot", + "lastName": "", + "workPosition": "", + "color": "#4ba984", + "avatar": "", + "gender": "M", + "birthday": "", + "extranet": false, + "bot": true, + "connector": false, + "externalAuthId": "bot", + "status": "online", + "idle": false, + "lastActivityDate": false, + "mobileLastDate": false, + "desktopLastDate": false, + "absent": false, + "departments": [], + "phones": false, + "type": "bot", + "website": "", + "email": "" + } + ] }, "time": { "start": 1728626400.123, @@ -89,6 +141,7 @@ "entityFields": [ "avatar", "backgroundId", + "canHaveThreads", "color", "containsCollaber", "dateCreate", @@ -102,6 +155,8 @@ "entityLink", "entityType", "extranet", + "guestCount", + "hasManageCapability", "id", "isNew", "lastId", @@ -109,7 +164,6 @@ "lastMessageViews", "managerList", "markedId", - "message", "messageCount", "messageType", "muteList", @@ -127,5 +181,10 @@ "unreadId", "userCounter", "userIds" - ] + ], + "requestExample": { + "botId": 456, + "botToken": "my_bot_token", + "dialogId": "chat5" + } } diff --git a/_assets/simulator/spec/methods/imbot.v2.Chat.leave.json b/_assets/simulator/spec/methods/imbot.v2.Chat.leave.json index 25a38406d..342727cba 100644 --- a/_assets/simulator/spec/methods/imbot.v2.Chat.leave.json +++ b/_assets/simulator/spec/methods/imbot.v2.Chat.leave.json @@ -18,14 +18,14 @@ "type": "string", "base": "string", "required": false, - "description": "Уникальный токен авторизации бота. Обязателен при авторизации через вебхук, не нужен для OAuth. Передавайте тот же botToken, который был указан при регистрации чат-бота" + "description": "Токен бота. Обязателен при авторизации через вебхук, для OAuth не нужен. Передавайте тот же botToken, который указали при регистрации бота" }, { "name": "dialogId", "type": "string", "base": "string", "required": true, - "description": "ID диалога. Для групповых чатов — chat{chatId}" + "description": "ID группового чата в формате dialogId: chat{chatId}" } ], "defs": {}, @@ -48,5 +48,10 @@ } }, "page": "/api-reference/chat-bots/chat-bots-v2/imbot.v2/chats/chat-leave.html", - "executable": false + "executable": false, + "requestExample": { + "botId": 456, + "botToken": "my_bot_token", + "dialogId": "chat5" + } } diff --git a/_assets/simulator/spec/methods/imbot.v2.Chat.setOwner.json b/_assets/simulator/spec/methods/imbot.v2.Chat.setOwner.json index 66e206fdb..00fe815c3 100644 --- a/_assets/simulator/spec/methods/imbot.v2.Chat.setOwner.json +++ b/_assets/simulator/spec/methods/imbot.v2.Chat.setOwner.json @@ -18,21 +18,21 @@ "type": "string", "base": "string", "required": false, - "description": "Уникальный токен авторизации бота. Обязателен при авторизации через вебхук, не нужен для OAuth. Передавайте тот же botToken, который был указан при регистрации чат-бота" + "description": "Токен бота. Обязателен при авторизации через вебхук, для OAuth не нужен. Передавайте тот же botToken, который указали при регистрации бота" }, { "name": "dialogId", "type": "string", "base": "string", "required": true, - "description": "ID диалога. Для групповых чатов — chat{chatId}" + "description": "ID группового чата в формате dialogId: chat{chatId}" }, { "name": "userId", "type": "integer", "base": "integer", "required": true, - "description": "ID нового владельца чата" + "description": "ID нового владельца чата. Пользователь должен состоять в чате — см. предупреждение выше" } ], "defs": {}, @@ -55,5 +55,11 @@ } }, "page": "/api-reference/chat-bots/chat-bots-v2/imbot.v2/chats/chat-set-owner.html", - "executable": false + "executable": false, + "requestExample": { + "botId": 456, + "botToken": "my_bot_token", + "dialogId": "chat5", + "userId": 1 + } } diff --git a/_assets/simulator/spec/methods/imbot.v2.Chat.update.json b/_assets/simulator/spec/methods/imbot.v2.Chat.update.json index 83cddf583..0d6b54845 100644 --- a/_assets/simulator/spec/methods/imbot.v2.Chat.update.json +++ b/_assets/simulator/spec/methods/imbot.v2.Chat.update.json @@ -18,21 +18,21 @@ "type": "string", "base": "string", "required": false, - "description": "Уникальный токен авторизации бота. Обязателен при авторизации через вебхук, не нужен для OAuth. Передавайте тот же botToken, который был указан при регистрации чат-бота" + "description": "Токен бота. Обязателен при авторизации через вебхук, для OAuth не нужен. Передавайте тот же botToken, который указали при регистрации бота" }, { "name": "dialogId", "type": "string", "base": "string", "required": true, - "description": "ID диалога. Для групповых чатов — chat{chatId}, для личных — {userId}" + "description": "ID группового чата в формате dialogId: chat{chatId}" }, { "name": "fields", "type": "object", "base": "object", - "required": true, - "description": "Обновляемые свойства чата. Структура объекта описана ниже", + "required": false, + "description": "Обновляемые свойства чата (подробное описание). Без fields метод ничего не меняет и возвращает true", "ref": "#/defs/fieldsFields" } ], @@ -63,14 +63,14 @@ "type": "string", "base": "string", "required": false, - "description": "Цвет чата — доступные цвета" + "description": "Цвет чата — доступные цвета. Неизвестный код цвета игнорируется без ошибки, цвет не меняется" }, { "name": "avatar", "type": "file", "base": "any", "required": false, - "description": "Новый аватар чата в формате Base64" + "description": "Новый аватар чата в формате Base64. Если строка не содержит изображение, текущий аватар снимается без ошибки" } ] } @@ -94,5 +94,14 @@ } }, "page": "/api-reference/chat-bots/chat-bots-v2/imbot.v2/chats/chat-update.html", - "executable": false + "executable": false, + "requestExample": { + "botId": 456, + "botToken": "my_bot_token", + "dialogId": "chat5", + "fields": { + "title": "New Title", + "color": "azure" + } + } } diff --git a/_assets/simulator/spec/methods/imbot.v2.Command.answer.json b/_assets/simulator/spec/methods/imbot.v2.Command.answer.json index 0895cc8b5..e6b0b825d 100644 --- a/_assets/simulator/spec/methods/imbot.v2.Command.answer.json +++ b/_assets/simulator/spec/methods/imbot.v2.Command.answer.json @@ -67,10 +67,10 @@ }, { "name": "attach", - "type": "array", - "base": "array", + "type": "object", + "base": "object", "required": false, - "description": "Вложения. Подробнее: Как использовать вложения" + "description": "Вложение: объект с массивом BLOCKS или сразу массив блоков. Подробнее: Как использовать вложения" }, { "name": "keyboard", @@ -115,5 +115,15 @@ } }, "page": "/api-reference/chat-bots/chat-bots-v2/imbot.v2/commands/command-answer.html", - "executable": false + "executable": false, + "requestExample": { + "botId": 456, + "botToken": "my_bot_token", + "commandId": 42, + "messageId": 789, + "dialogId": "chat5", + "fields": { + "message": "Here is the help text..." + } + } } diff --git a/_assets/simulator/spec/methods/imbot.v2.Command.list.json b/_assets/simulator/spec/methods/imbot.v2.Command.list.json index 839da0c7a..9ec126059 100644 --- a/_assets/simulator/spec/methods/imbot.v2.Command.list.json +++ b/_assets/simulator/spec/methods/imbot.v2.Command.list.json @@ -66,5 +66,9 @@ "id", "params", "title" - ] + ], + "requestExample": { + "botId": 456, + "botToken": "my_bot_token" + } } diff --git a/_assets/simulator/spec/methods/imbot.v2.Command.register.json b/_assets/simulator/spec/methods/imbot.v2.Command.register.json index f90fc60cf..5b0b08f45 100644 --- a/_assets/simulator/spec/methods/imbot.v2.Command.register.json +++ b/_assets/simulator/spec/methods/imbot.v2.Command.register.json @@ -108,5 +108,20 @@ } }, "page": "/api-reference/chat-bots/chat-bots-v2/imbot.v2/commands/command-register.html", - "executable": false + "executable": false, + "requestExample": { + "botId": 456, + "botToken": "my_bot_token", + "fields": { + "command": "help", + "title": { + "en": "Show help", + "ru": "Показать помощь" + }, + "params": { + "en": "query", + "ru": "запрос" + } + } + } } diff --git a/_assets/simulator/spec/methods/imbot.v2.Command.unregister.json b/_assets/simulator/spec/methods/imbot.v2.Command.unregister.json index 136063894..d1aefe651 100644 --- a/_assets/simulator/spec/methods/imbot.v2.Command.unregister.json +++ b/_assets/simulator/spec/methods/imbot.v2.Command.unregister.json @@ -48,5 +48,10 @@ } }, "page": "/api-reference/chat-bots/chat-bots-v2/imbot.v2/commands/command-unregister.html", - "executable": false + "executable": false, + "requestExample": { + "botId": 456, + "botToken": "my_bot_token", + "commandId": 42 + } } diff --git a/_assets/simulator/spec/methods/imbot.v2.Command.update.json b/_assets/simulator/spec/methods/imbot.v2.Command.update.json index 30f469f22..9cd91c5ec 100644 --- a/_assets/simulator/spec/methods/imbot.v2.Command.update.json +++ b/_assets/simulator/spec/methods/imbot.v2.Command.update.json @@ -115,5 +115,16 @@ } }, "page": "/api-reference/chat-bots/chat-bots-v2/imbot.v2/commands/command-update.html", - "executable": false + "executable": false, + "requestExample": { + "botId": 456, + "botToken": "b15f6e80ef345c97e23db31e727281f4", + "commandId": 42, + "fields": { + "title": { + "en": "Updated help", + "ru": "Обновленная помощь" + } + } + } } diff --git a/_assets/simulator/spec/methods/imbot.v2.Event.get.json b/_assets/simulator/spec/methods/imbot.v2.Event.get.json index 37fe9474a..126fbc7b2 100644 --- a/_assets/simulator/spec/methods/imbot.v2.Event.get.json +++ b/_assets/simulator/spec/methods/imbot.v2.Event.get.json @@ -77,5 +77,12 @@ "date", "eventId", "type" - ] + ], + "requestExample": { + "botId": 456, + "botToken": "my_bot_token", + "offset": 1000, + "limit": 50, + "withUserEvents": true + } } diff --git a/_assets/simulator/spec/methods/imbot.v2.File.download.json b/_assets/simulator/spec/methods/imbot.v2.File.download.json index 0f66e86d4..52f3b76a6 100644 --- a/_assets/simulator/spec/methods/imbot.v2.File.download.json +++ b/_assets/simulator/spec/methods/imbot.v2.File.download.json @@ -48,5 +48,10 @@ } }, "page": "/api-reference/chat-bots/chat-bots-v2/imbot.v2/files/file-download.html", - "executable": false + "executable": false, + "requestExample": { + "botId": 456, + "botToken": "my_bot_token", + "fileId": 138 + } } diff --git a/_assets/simulator/spec/methods/imbot.v2.File.upload.json b/_assets/simulator/spec/methods/imbot.v2.File.upload.json index 3a9f9345d..bb7a6a522 100644 --- a/_assets/simulator/spec/methods/imbot.v2.File.upload.json +++ b/_assets/simulator/spec/methods/imbot.v2.File.upload.json @@ -96,5 +96,15 @@ } }, "page": "/api-reference/chat-bots/chat-bots-v2/imbot.v2/files/file-upload.html", - "executable": false + "executable": false, + "requestExample": { + "botId": 456, + "botToken": "my_bot_token", + "dialogId": "chat5", + "fields": { + "name": "report.pdf", + "content": "SGVsbG8gV29ybGQh", + "message": "Here is the report" + } + } } diff --git a/_assets/simulator/spec/methods/imconnector.activate.json b/_assets/simulator/spec/methods/imconnector.activate.json index e18c97572..b8430f9a9 100644 --- a/_assets/simulator/spec/methods/imconnector.activate.json +++ b/_assets/simulator/spec/methods/imconnector.activate.json @@ -25,7 +25,7 @@ "type": "string", "base": "string", "required": true, - "description": "Признак активации. Любое непустое значение включает коннектор, пустое значение или 0 отключает коннектор. Рекомендуется использовать 1 и 0 (или Y и N), а не произвольные строки" + "description": "Признак включения. Битрикс24 различает только пустые и непустые значения: - 0 и пустая строка выключают коннектор - любое другое значение включает коннектор, например 1 или Y Строку N метод тоже считает непустой и включает коннектор, поэтому для выключения передавайте 0. Параметр нужно передать всегда: без ключа ACTIVE или со значением null метод возвращает ошибку ERROR_ARGUMENT" } ], "defs": {}, @@ -37,12 +37,14 @@ "resultExample": { "result": true, "time": { - "start": 1738065600.11, - "finish": 1738065600.19, - "duration": 0.08, - "processing": 0.03, - "date_start": "2025-01-28T12:00:00+00:00", - "date_finish": "2025-01-28T12:00:00+00:00" + "start": 1773267900.126, + "finish": 1773267900.489, + "duration": 0.3630001544952393, + "processing": 0.0884850025177002, + "date_start": "2026-03-11T14:25:00+03:00", + "date_finish": "2026-03-11T14:25:00+03:00", + "operating_reset_at": 1773268500, + "operating": 0.0884850025177002 } }, "returns": [ @@ -51,7 +53,7 @@ "type": "boolean", "base": "boolean", "required": false, - "description": "true, если действие выполнено успешно" + "description": "true, если действие выполнено успешно. Метод возвращает true, даже если коннектор уже был в нужном состоянии — при повторном включении или при выключении коннектора, не включенного на этой линии. Значение false возможно только при выключении, если удалить запись статуса не удалось" }, { "name": "time", diff --git a/_assets/simulator/spec/methods/imconnector.chat.name.set.json b/_assets/simulator/spec/methods/imconnector.chat.name.set.json index 8d7520729..ce692f208 100644 --- a/_assets/simulator/spec/methods/imconnector.chat.name.set.json +++ b/_assets/simulator/spec/methods/imconnector.chat.name.set.json @@ -1,7 +1,7 @@ { "$v": 1, "method": "imconnector.chat.name.set", - "scope": "imconnector", + "scope": "imopenlines", "kind": "write", "title": "Установить новое имя чата imconnector.chat.name.set", "permissions": "любой пользователь", @@ -18,14 +18,14 @@ "type": "integer", "base": "integer", "required": true, - "description": "Идентификатор открытой линии Идентификатор можно получить методами imopenlines.config.get и imopenlines.config.list.get" + "description": "Идентификатор открытой линии. Идентификатор можно получить методами imopenlines.config.get и imopenlines.config.list.get" }, { "name": "CHAT_ID", "type": "string", "base": "string", "required": true, - "description": "Идентификатор чата во внешней системе" + "description": "Идентификатор чата во внешней системе — то же значение, что передают в chat.id метода imconnector.send.messages" }, { "name": "NAME", @@ -39,7 +39,7 @@ "type": "string", "base": "string", "required": false, - "description": "Идентификатор пользователя. Параметр является обязательным только для коннекторов без групповых чатов с внешней стороны. У такого коннектора в методе imconnector.register параметр CHAT_GROUP должен быть равен false" + "description": "Идентификатор собеседника во внешней системе — то же значение, что передают в user.id метода imconnector.send.messages. Идентификатор пользователя Битрикс24 здесь не подходит. Параметр обязателен для коннекторов, у которых при регистрации методом imconnector.register параметр CHAT_GROUP равен false. Если CHAT_GROUP равен true, переданное значение игнорируется" } ], "defs": {}, diff --git a/_assets/simulator/spec/methods/imconnector.connector.data.set.json b/_assets/simulator/spec/methods/imconnector.connector.data.set.json index e03485b82..1adbd5da1 100644 --- a/_assets/simulator/spec/methods/imconnector.connector.data.set.json +++ b/_assets/simulator/spec/methods/imconnector.connector.data.set.json @@ -25,7 +25,7 @@ "type": "object", "base": "object", "required": true, - "description": "Объект настроек канала во внешней системе. Метод не поддерживает отдельную установку или изменение одного поля: настройки записываются и перезаписываются через этот объект целиком. Структура объекта подробно описана ниже", + "description": "Объект настроек канала во внешней системе. Структура объекта подробно описана ниже", "ref": "#/defs/DATAFields" } ], @@ -42,7 +42,7 @@ "type": "string", "base": "string", "required": false, - "description": "Идентификатор канала во внешней системе, например channel-123. Идентификатор нужно взять из внешней системы. Если готового нет, используйте уникальный ключ, например, комбинацию ID коннектора и линии: myconnector_line107" + "description": "Идентификатор канала во внешней системе, например, channel-123. Идентификатор нужно взять из внешней системы. Если готового нет, используйте уникальный ключ, например, комбинацию кода коннектора и идентификатора линии: myconnector_line107" }, { "name": "URL", @@ -56,14 +56,14 @@ "type": "string", "base": "string", "required": false, - "description": "Полная ссылка на чат в формате для интерфейса оператора. Если отдельной ссылки для оператора нет, используйте значение URL" + "description": "Ссылка на чат, которую оператор открывает из интерфейса открытых линий. Если отдельной ссылки для оператора нет, поле можно не передавать — у коннектора останется только URL" }, { "name": "NAME", "type": "string", "base": "string", "required": false, - "description": "Название канала для отображения в интерфейсе" + "description": "Название канала, которое видит оператор" } ] } @@ -76,12 +76,14 @@ "resultExample": { "result": true, "time": { - "start": 1738065600.11, - "finish": 1738065600.2, - "duration": 0.09, - "processing": 0.04, - "date_start": "2025-01-28T12:00:00+00:00", - "date_finish": "2025-01-28T12:00:00+00:00" + "start": 1773267900.126, + "finish": 1773267900.489, + "duration": 0.3630001544952393, + "processing": 0.0884850025177002, + "date_start": "2026-03-11T14:25:00+03:00", + "date_finish": "2026-03-11T14:25:00+03:00", + "operating_reset_at": 1773268500, + "operating": 0.0884850025177002 } }, "returns": [ @@ -90,7 +92,7 @@ "type": "boolean", "base": "boolean", "required": false, - "description": "true, если данные сохранены" + "description": "Всегда true, если переданы обязательные параметры: существование коннектора и открытой линии метод не проверяет" }, { "name": "time", diff --git a/_assets/simulator/spec/methods/imconnector.list.json b/_assets/simulator/spec/methods/imconnector.list.json index 04752232b..6da5a8035 100644 --- a/_assets/simulator/spec/methods/imconnector.list.json +++ b/_assets/simulator/spec/methods/imconnector.list.json @@ -11,7 +11,7 @@ "type": "object", "base": "object", "required": "unknown", - "description": "Объект вида connector_id: connector_name для доступных коннекторов", + "description": "Объект вида connector_id: connector_name, где: - ключ — код коннектора. Для пользовательского коннектора это значение параметра ID метода imconnector.register, приведенное к нижнему регистру - значение — название коннектора на языке интерфейса Битрикс24: для пользовательского коннектора это параметр NAME метода imconnector.register Ключ подставляют в параметр CONNECTOR остальных методов раздела.…", "dynamic": { "allowed": true, "note": "Состав полей не описан подтаблицей на этой странице" @@ -39,7 +39,7 @@ "result": { "livechat": "Онлайн-чат", "telegrambot": "Telegram", - "network": "Битрикс24.Network", + "network": "Битрикс24 Network", "myconnector": "Мой коннектор" }, "time": { @@ -57,7 +57,7 @@ "type": "object", "base": "object", "required": "unknown", - "description": "Объект вида connector_id: connector_name для доступных коннекторов" + "description": "Объект вида connector_id: connector_name, где: - ключ — код коннектора. Для пользовательского коннектора это значение параметра ID метода imconnector.register, приведенное к нижнему регистру - значение — название коннектора на языке интерфейса Битрикс24: для пользовательского коннектора это параметр NAME метода imconnector.register Ключ подставляют в параметр CONNECTOR остальных методов раздела.…" }, { "name": "time", diff --git a/_assets/simulator/spec/methods/imconnector.send.status.delivery.json b/_assets/simulator/spec/methods/imconnector.send.status.delivery.json index 57fc2ee00..f3e3d7c36 100644 --- a/_assets/simulator/spec/methods/imconnector.send.status.delivery.json +++ b/_assets/simulator/spec/methods/imconnector.send.status.delivery.json @@ -41,7 +41,7 @@ "name": "im", "type": "object", "base": "object", - "required": false, + "required": true, "description": "Внутренние идентификаторы сообщения в Битрикс24 (подробное описание)" }, { @@ -72,28 +72,23 @@ "DATA": [] }, "time": { - "start": 1738065600.11, - "finish": 1738065600.21, - "duration": 0.1, - "processing": 0.04, - "date_start": "2025-01-28T12:00:00+00:00", - "date_finish": "2025-01-28T12:00:00+00:00" + "start": 1773267900.126, + "finish": 1773267900.489, + "duration": 0.3630001544952393, + "processing": 0.0884850025177002, + "date_start": "2026-03-11T14:25:00+03:00", + "date_finish": "2026-03-11T14:25:00+03:00", + "operating_reset_at": 1773268500, + "operating": 0.0884850025177002 } }, "returns": [ { - "name": "SUCCESS", - "type": "boolean", - "base": "boolean", - "required": false, - "description": "Возвращает true, если статус доставки успешно принят и обновлен в Битрикс24" - }, - { - "name": "DATA", - "type": "array", - "base": "array", + "name": "result", + "type": "object", + "base": "object", "required": false, - "description": "Пустой массив при успешной обработке" + "description": "Результат обработки статусов доставки (подробное описание)" }, { "name": "time", diff --git a/_assets/simulator/spec/methods/imconnector.send.status.reading.json b/_assets/simulator/spec/methods/imconnector.send.status.reading.json index b59c3e900..1224e0f1e 100644 --- a/_assets/simulator/spec/methods/imconnector.send.status.reading.json +++ b/_assets/simulator/spec/methods/imconnector.send.status.reading.json @@ -3,7 +3,7 @@ "method": "imconnector.send.status.reading", "scope": "imopenlines", "kind": "write", - "title": "Обновить статус «прочитано» imconnector.send.status.reading", + "title": "Передать статус «прочитано» imconnector.send.status.reading", "permissions": "любой пользователь", "params": [ { @@ -25,7 +25,7 @@ "type": "array", "base": "array", "required": true, - "description": "Массив статусов прочтения. Каждый элемент массива — объект с блоками im, message, chat Структура объекта подробно описана ниже", + "description": "Массив статусов прочтения. Каждый элемент массива — объект с блоками im, message, chat. Структура объекта подробно описана ниже", "ref": "#/defs/MESSAGESFields" } ], @@ -72,28 +72,23 @@ "DATA": [] }, "time": { - "start": 1738065600.11, - "finish": 1738065600.21, - "duration": 0.1, - "processing": 0.04, - "date_start": "2025-01-28T12:00:00+00:00", - "date_finish": "2025-01-28T12:00:00+00:00" + "start": 1773267900.126, + "finish": 1773267900.489, + "duration": 0.3630001544952393, + "processing": 0.0884850025177002, + "date_start": "2026-03-11T14:25:00+03:00", + "date_finish": "2026-03-11T14:25:00+03:00", + "operating_reset_at": 1773268500, + "operating": 0.0884850025177002 } }, "returns": [ { - "name": "SUCCESS", - "type": "boolean", - "base": "boolean", - "required": false, - "description": "Возвращает true, если статус прочтения успешно принят и обновлен в Битрикс24" - }, - { - "name": "DATA", - "type": "array", - "base": "array", + "name": "result", + "type": "object", + "base": "object", "required": false, - "description": "Пустой массив при успешной обработке" + "description": "Результат приема запроса (подробное описание)" }, { "name": "time", diff --git a/_assets/simulator/spec/methods/imconnector.status.json b/_assets/simulator/spec/methods/imconnector.status.json index c3edcf8fa..b1dfd7b7a 100644 --- a/_assets/simulator/spec/methods/imconnector.status.json +++ b/_assets/simulator/spec/methods/imconnector.status.json @@ -18,7 +18,7 @@ "type": "integer", "base": "integer", "required": false, - "description": "Идентификатор открытой линии" + "description": "Идентификатор открытой линии. Идентификатор можно получить методами imopenlines.config.get и imopenlines.config.list.get" } ], "defs": {}, @@ -36,12 +36,14 @@ "STATUS": true }, "time": { - "start": 1738065600.11, - "finish": 1738065600.18, - "duration": 0.07, - "processing": 0.03, - "date_start": "2025-01-28T12:00:00+00:00", - "date_finish": "2025-01-28T12:00:00+00:00" + "start": 1773267900.126, + "finish": 1773267900.489, + "duration": 0.3630001544952393, + "processing": 0.0884850025177002, + "date_start": "2026-03-11T14:25:00+03:00", + "date_finish": "2026-03-11T14:25:00+03:00", + "operating_reset_at": 1773268500, + "operating": 0.0884850025177002 } }, "returns": [ diff --git a/_assets/simulator/spec/methods/imopenlines.bot.session.finish.json b/_assets/simulator/spec/methods/imopenlines.bot.session.finish.json index 29576bcc2..aa928eeb3 100644 --- a/_assets/simulator/spec/methods/imopenlines.bot.session.finish.json +++ b/_assets/simulator/spec/methods/imopenlines.bot.session.finish.json @@ -56,5 +56,9 @@ } ], "page": "/api-reference/imopenlines/openlines/chat-bots/imopenlines-bot-session-finish.html", - "executable": false + "executable": false, + "requestExample": { + "CHAT_ID": 112, + "CLIENT_ID": "**put_your_client_id_or_bot_token_here**" + } } diff --git a/_assets/simulator/spec/methods/imopenlines.bot.session.message.send.json b/_assets/simulator/spec/methods/imopenlines.bot.session.message.send.json index 0a7703fcb..f8e8c9a2f 100644 --- a/_assets/simulator/spec/methods/imopenlines.bot.session.message.send.json +++ b/_assets/simulator/spec/methods/imopenlines.bot.session.message.send.json @@ -73,5 +73,10 @@ } ], "page": "/api-reference/imopenlines/openlines/chat-bots/imopenlines-bot-session-message-send.html", - "executable": false + "executable": false, + "requestExample": { + "CHAT_ID": 112, + "NAME": "DEFAULT", + "MESSAGE": "Здравствуйте! Чем могу помочь?" + } } diff --git a/_assets/simulator/spec/methods/imopenlines.bot.session.operator.json b/_assets/simulator/spec/methods/imopenlines.bot.session.operator.json index a1ec172d9..1e46a4dbc 100644 --- a/_assets/simulator/spec/methods/imopenlines.bot.session.operator.json +++ b/_assets/simulator/spec/methods/imopenlines.bot.session.operator.json @@ -49,5 +49,8 @@ } ], "page": "/api-reference/imopenlines/openlines/chat-bots/imopenlines-bot-session-operator.html", - "executable": false + "executable": false, + "requestExample": { + "CHAT_ID": 112 + } } diff --git a/_assets/simulator/spec/methods/imopenlines.bot.session.transfer.json b/_assets/simulator/spec/methods/imopenlines.bot.session.transfer.json index e8ea29f44..9ad97940c 100644 --- a/_assets/simulator/spec/methods/imopenlines.bot.session.transfer.json +++ b/_assets/simulator/spec/methods/imopenlines.bot.session.transfer.json @@ -94,5 +94,11 @@ } ], "page": "/api-reference/imopenlines/openlines/chat-bots/imopenlines-bot-session-transfer.html", - "executable": false + "executable": false, + "requestExample": { + "CHAT_ID": 112, + "USER_ID": 12, + "LEAVE": "N", + "CLIENT_ID": "**put_your_client_id_or_bot_token_here**" + } } diff --git a/_assets/simulator/spec/methods/imopenlines.config.add.json b/_assets/simulator/spec/methods/imopenlines.config.add.json index d9e28ba89..0e6c90cb3 100644 --- a/_assets/simulator/spec/methods/imopenlines.config.add.json +++ b/_assets/simulator/spec/methods/imopenlines.config.add.json @@ -1048,5 +1048,45 @@ } ], "page": "/api-reference/imopenlines/openlines/imopenlines-config-add.html", - "executable": false + "executable": false, + "requestExample": { + "PARAMS": { + "LINE_NAME": "Линия поддержки интернет-магазина", + "QUEUE": [ + { + "ENTITY_TYPE": "user", + "ENTITY_ID": "1" + }, + { + "ENTITY_TYPE": "user", + "ENTITY_ID": "15" + }, + { + "ENTITY_TYPE": "user", + "ENTITY_ID": "23" + } + ], + "QUEUE_TYPE": "strictly", + "QUEUE_TIME": 45, + "NO_ANSWER_TIME": 120, + "WELCOME_MESSAGE": "Y", + "WELCOME_MESSAGE_TEXT": "Здравствуйте! Ответим в течение пары минут", + "CRM": "Y", + "CRM_CREATE": "deal", + "CRM_SOURCE": "openline_web", + "CRM_FORWARD": "Y", + "MAX_CHAT": 4, + "TYPE_MAX_CHAT": "answered_new", + "WORKTIME_ENABLE": "Y", + "WORKTIME_FROM": "09:00", + "WORKTIME_TO": "21:00", + "WORKTIME_TIMEZONE": "Europe/Kaliningrad", + "WORKTIME_DAYOFF": [ + "SA", + "SU" + ], + "WORKTIME_DAYOFF_RULE": "text", + "WORKTIME_DAYOFF_TEXT": "Сейчас линия не работает. Напишите, и мы ответим в рабочее время" + } + } } diff --git a/_assets/simulator/spec/methods/imopenlines.config.delete.json b/_assets/simulator/spec/methods/imopenlines.config.delete.json index 469577d0b..eeee4dd58 100644 --- a/_assets/simulator/spec/methods/imopenlines.config.delete.json +++ b/_assets/simulator/spec/methods/imopenlines.config.delete.json @@ -50,5 +50,8 @@ } ], "page": "/api-reference/imopenlines/openlines/imopenlines-config-delete.html", - "executable": false + "executable": false, + "requestExample": { + "CONFIG_ID": 15 + } } diff --git a/_assets/simulator/spec/methods/imopenlines.config.get.json b/_assets/simulator/spec/methods/imopenlines.config.get.json index f7c6cfbd7..c30710652 100644 --- a/_assets/simulator/spec/methods/imopenlines.config.get.json +++ b/_assets/simulator/spec/methods/imopenlines.config.get.json @@ -232,5 +232,10 @@ } ], "page": "/api-reference/imopenlines/openlines/imopenlines-config-get.html", - "executable": false + "executable": false, + "requestExample": { + "CONFIG_ID": 15, + "WITH_QUEUE": "Y", + "SHOW_OFFLINE": "Y" + } } diff --git a/_assets/simulator/spec/methods/imopenlines.config.list.get.json b/_assets/simulator/spec/methods/imopenlines.config.list.get.json index 5c0e3adcb..5c325ffce 100644 --- a/_assets/simulator/spec/methods/imopenlines.config.list.get.json +++ b/_assets/simulator/spec/methods/imopenlines.config.list.get.json @@ -211,5 +211,26 @@ "LINE_NAME", "QUEUE", "QUEUE_USERS_FIELDS" - ] + ], + "requestExample": { + "PARAMS": { + "select": [ + "ID", + "LINE_NAME", + "ACTIVE" + ], + "order": { + "ID": "ASC" + }, + "filter": { + "ACTIVE": "Y" + }, + "limit": 50, + "offset": 0 + }, + "OPTIONS": { + "QUEUE": "Y", + "CONFIG_QUEUE": "Y" + } + } } diff --git a/_assets/simulator/spec/methods/imopenlines.config.update.json b/_assets/simulator/spec/methods/imopenlines.config.update.json index 2e3639edb..6c56de146 100644 --- a/_assets/simulator/spec/methods/imopenlines.config.update.json +++ b/_assets/simulator/spec/methods/imopenlines.config.update.json @@ -61,5 +61,34 @@ } ], "page": "/api-reference/imopenlines/openlines/imopenlines-config-update.html", - "executable": false + "executable": false, + "requestExample": { + "CONFIG_ID": 15, + "PARAMS": { + "LINE_NAME": "Линия поддержки интернет-магазина (VIP)", + "QUEUE": [ + { + "ENTITY_TYPE": "user", + "ENTITY_ID": "1" + }, + { + "ENTITY_TYPE": "user", + "ENTITY_ID": "15" + }, + { + "ENTITY_TYPE": "user", + "ENTITY_ID": "23" + } + ], + "QUEUE_TYPE": "strictly", + "QUEUE_TIME": 45, + "NO_ANSWER_TIME": 120, + "WELCOME_MESSAGE": "Y", + "WELCOME_MESSAGE_TEXT": "Здравствуйте! Ответим в течение пары минут", + "WORKTIME_ENABLE": "Y", + "WORKTIME_FROM": "09:00", + "WORKTIME_TO": "21:00", + "WORKTIME_TIMEZONE": "Europe/Kaliningrad" + } + } } diff --git a/_assets/simulator/spec/methods/imopenlines.crm.chat.get.json b/_assets/simulator/spec/methods/imopenlines.crm.chat.get.json index f71aadf2c..96475847f 100644 --- a/_assets/simulator/spec/methods/imopenlines.crm.chat.get.json +++ b/_assets/simulator/spec/methods/imopenlines.crm.chat.get.json @@ -88,5 +88,10 @@ "CHAT_ID", "CONNECTOR_ID", "CONNECTOR_TITLE" - ] + ], + "requestExample": { + "CRM_ENTITY_TYPE": "lead", + "CRM_ENTITY": 1205, + "ACTIVE_ONLY": "N" + } } diff --git a/_assets/simulator/spec/methods/imopenlines.crm.chat.getLastId.json b/_assets/simulator/spec/methods/imopenlines.crm.chat.getLastId.json index ff2de98c6..ee9b525e3 100644 --- a/_assets/simulator/spec/methods/imopenlines.crm.chat.getLastId.json +++ b/_assets/simulator/spec/methods/imopenlines.crm.chat.getLastId.json @@ -75,5 +75,9 @@ } ], "page": "/api-reference/imopenlines/openlines/chats/imopenlines-crm-chat-get-last-id.html", - "executable": false + "executable": false, + "requestExample": { + "CRM_ENTITY_TYPE": "lead", + "CRM_ENTITY": 1205 + } } diff --git a/_assets/simulator/spec/methods/imopenlines.crm.chat.user.add.json b/_assets/simulator/spec/methods/imopenlines.crm.chat.user.add.json index bfb0f02b8..ebd45dabb 100644 --- a/_assets/simulator/spec/methods/imopenlines.crm.chat.user.add.json +++ b/_assets/simulator/spec/methods/imopenlines.crm.chat.user.add.json @@ -73,5 +73,11 @@ } }, "page": "/api-reference/imopenlines/openlines/chats/imopenlines-crm-chat-user-add.html", - "executable": false + "executable": false, + "requestExample": { + "CRM_ENTITY_TYPE": "lead", + "CRM_ENTITY": 1205, + "USER_ID": 503, + "CHAT_ID": 1763 + } } diff --git a/_assets/simulator/spec/methods/imopenlines.crm.chat.user.delete.json b/_assets/simulator/spec/methods/imopenlines.crm.chat.user.delete.json index 88744ceea..81a741a20 100644 --- a/_assets/simulator/spec/methods/imopenlines.crm.chat.user.delete.json +++ b/_assets/simulator/spec/methods/imopenlines.crm.chat.user.delete.json @@ -73,5 +73,11 @@ } }, "page": "/api-reference/imopenlines/openlines/chats/imopenlines-crm-chat-user-delete.html", - "executable": false + "executable": false, + "requestExample": { + "CRM_ENTITY_TYPE": "lead", + "CRM_ENTITY": 1205, + "USER_ID": 503, + "CHAT_ID": 1763 + } } diff --git a/_assets/simulator/spec/methods/imopenlines.crm.lead.create.json b/_assets/simulator/spec/methods/imopenlines.crm.lead.create.json index 1176a2f17..aac58a817 100644 --- a/_assets/simulator/spec/methods/imopenlines.crm.lead.create.json +++ b/_assets/simulator/spec/methods/imopenlines.crm.lead.create.json @@ -50,5 +50,8 @@ } ], "page": "/api-reference/imopenlines/openlines/sessions/imopenlines-crm-lead-create.html", - "executable": false + "executable": false, + "requestExample": { + "CHAT_ID": 2043 + } } diff --git a/_assets/simulator/spec/methods/imopenlines.crm.message.add.json b/_assets/simulator/spec/methods/imopenlines.crm.message.add.json index d20389927..8cc496f59 100644 --- a/_assets/simulator/spec/methods/imopenlines.crm.message.add.json +++ b/_assets/simulator/spec/methods/imopenlines.crm.message.add.json @@ -62,5 +62,12 @@ } }, "page": "/api-reference/imopenlines/openlines/messages/imopenlines-crm-message-add.html", - "executable": false + "executable": false, + "requestExample": { + "CRM_ENTITY_TYPE": "lead", + "CRM_ENTITY": 1195, + "USER_ID": 27, + "CHAT_ID": 1341, + "MESSAGE": "Текст сообщения" + } } diff --git a/_assets/simulator/spec/methods/imopenlines.dialog.get.json b/_assets/simulator/spec/methods/imopenlines.dialog.get.json index 60479d2a6..c3c357be1 100644 --- a/_assets/simulator/spec/methods/imopenlines.dialog.get.json +++ b/_assets/simulator/spec/methods/imopenlines.dialog.get.json @@ -150,5 +150,8 @@ } ], "page": "/api-reference/imopenlines/openlines/sessions/imopenlines-dialog-get.html", - "executable": false + "executable": false, + "requestExample": { + "USER_CODE": "livechat|1|1373|211" + } } diff --git a/_assets/simulator/spec/methods/imopenlines.message.quick.save.json b/_assets/simulator/spec/methods/imopenlines.message.quick.save.json index 3269c5bfb..700e2792c 100644 --- a/_assets/simulator/spec/methods/imopenlines.message.quick.save.json +++ b/_assets/simulator/spec/methods/imopenlines.message.quick.save.json @@ -40,5 +40,9 @@ } }, "page": "/api-reference/imopenlines/openlines/messages/imopenlines-message-quick-save.html", - "executable": false + "executable": false, + "requestExample": { + "CHAT_ID": 1331, + "MESSAGE_ID": 83507 + } } diff --git a/_assets/simulator/spec/methods/imopenlines.message.session.start.json b/_assets/simulator/spec/methods/imopenlines.message.session.start.json index 9abf5f620..4621d29f7 100644 --- a/_assets/simulator/spec/methods/imopenlines.message.session.start.json +++ b/_assets/simulator/spec/methods/imopenlines.message.session.start.json @@ -57,5 +57,9 @@ } ], "page": "/api-reference/imopenlines/openlines/sessions/imopenlines-message-session-start.html", - "executable": false + "executable": false, + "requestExample": { + "CHAT_ID": 2043, + "MESSAGE_ID": 18971 + } } diff --git a/_assets/simulator/spec/methods/imopenlines.network.join.json b/_assets/simulator/spec/methods/imopenlines.network.join.json index 9f1873731..2a5ebbee0 100644 --- a/_assets/simulator/spec/methods/imopenlines.network.join.json +++ b/_assets/simulator/spec/methods/imopenlines.network.join.json @@ -50,5 +50,8 @@ } ], "page": "/api-reference/imopenlines/openlines/imopenlines-network-join.html", - "executable": false + "executable": false, + "requestExample": { + "CODE": "ab515f5d85a8b844d484f6ea75a2e494" + } } diff --git a/_assets/simulator/spec/methods/imopenlines.network.message.add.json b/_assets/simulator/spec/methods/imopenlines.network.message.add.json index 28da83189..54c9be113 100644 --- a/_assets/simulator/spec/methods/imopenlines.network.message.add.json +++ b/_assets/simulator/spec/methods/imopenlines.network.message.add.json @@ -94,5 +94,50 @@ } ], "page": "/api-reference/imopenlines/openlines/imopenlines-network-message-add.html", - "executable": false + "executable": false, + "requestExample": { + "CODE": "ab515f5d85a8b844d484f6ea75a2e494", + "USER_ID": 2, + "MESSAGE": "Подготовили материалы по подключению открытых линий", + "ATTACH": { + "ID": 1, + "COLOR_TOKEN": "primary", + "BLOCKS": [ + { + "MESSAGE": "Во вложении отправили чек-лист и схему подключения" + }, + { + "FILE": [ + { + "NAME": "checklist-openlines.pdf", + "LINK": "https://cdn.example.com/docs/checklist-openlines.pdf", + "SIZE": 428736 + } + ] + }, + { + "IMAGE": [ + { + "NAME": "Схема подключения", + "LINK": "https://cdn.example.com/images/openlines-setup.png", + "PREVIEW": "https://cdn.example.com/images/openlines-setup-preview.png", + "WIDTH": 1280, + "HEIGHT": 720 + } + ] + } + ] + }, + "KEYBOARD": { + "BUTTONS": [ + { + "TEXT": "Открыть инструкцию", + "LINK": "https://help.example.com/openlines/setup", + "DISPLAY": "LINE", + "BG_COLOR_TOKEN": "primary" + } + ] + }, + "URL_PREVIEW": "N" + } } diff --git a/_assets/simulator/spec/methods/imopenlines.operator.another.finish.json b/_assets/simulator/spec/methods/imopenlines.operator.another.finish.json index 02069a613..56aba58b1 100644 --- a/_assets/simulator/spec/methods/imopenlines.operator.another.finish.json +++ b/_assets/simulator/spec/methods/imopenlines.operator.another.finish.json @@ -50,5 +50,8 @@ } ], "page": "/api-reference/imopenlines/openlines/operators/imopenlines-operator-another-finish.html", - "executable": false + "executable": false, + "requestExample": { + "CHAT_ID": 2043 + } } diff --git a/_assets/simulator/spec/methods/imopenlines.operator.answer.json b/_assets/simulator/spec/methods/imopenlines.operator.answer.json index c08af0b66..5e8e0ab95 100644 --- a/_assets/simulator/spec/methods/imopenlines.operator.answer.json +++ b/_assets/simulator/spec/methods/imopenlines.operator.answer.json @@ -50,5 +50,8 @@ } ], "page": "/api-reference/imopenlines/openlines/operators/imopenlines-operator-answer.html", - "executable": false + "executable": false, + "requestExample": { + "CHAT_ID": 2043 + } } diff --git a/_assets/simulator/spec/methods/imopenlines.operator.finish.json b/_assets/simulator/spec/methods/imopenlines.operator.finish.json index 4999354dc..30f513dd6 100644 --- a/_assets/simulator/spec/methods/imopenlines.operator.finish.json +++ b/_assets/simulator/spec/methods/imopenlines.operator.finish.json @@ -50,5 +50,8 @@ } ], "page": "/api-reference/imopenlines/openlines/operators/imopenlines-operator-finish.html", - "executable": false + "executable": false, + "requestExample": { + "CHAT_ID": 2043 + } } diff --git a/_assets/simulator/spec/methods/imopenlines.operator.skip.json b/_assets/simulator/spec/methods/imopenlines.operator.skip.json index b65e20b4f..58b428b8c 100644 --- a/_assets/simulator/spec/methods/imopenlines.operator.skip.json +++ b/_assets/simulator/spec/methods/imopenlines.operator.skip.json @@ -50,5 +50,8 @@ } ], "page": "/api-reference/imopenlines/openlines/operators/imopenlines-operator-skip.html", - "executable": false + "executable": false, + "requestExample": { + "CHAT_ID": 2043 + } } diff --git a/_assets/simulator/spec/methods/imopenlines.operator.spam.json b/_assets/simulator/spec/methods/imopenlines.operator.spam.json index 1aa1a7563..5362a8f93 100644 --- a/_assets/simulator/spec/methods/imopenlines.operator.spam.json +++ b/_assets/simulator/spec/methods/imopenlines.operator.spam.json @@ -50,5 +50,8 @@ } ], "page": "/api-reference/imopenlines/openlines/operators/imopenlines-operator-spam.html", - "executable": false + "executable": false, + "requestExample": { + "CHAT_ID": 2043 + } } diff --git a/_assets/simulator/spec/methods/imopenlines.operator.transfer.json b/_assets/simulator/spec/methods/imopenlines.operator.transfer.json index 2e6a5f9b4..350c5dca4 100644 --- a/_assets/simulator/spec/methods/imopenlines.operator.transfer.json +++ b/_assets/simulator/spec/methods/imopenlines.operator.transfer.json @@ -71,5 +71,9 @@ } ], "page": "/api-reference/imopenlines/openlines/operators/imopenlines-operator-transfer.html", - "executable": false + "executable": false, + "requestExample": { + "CHAT_ID": 2043, + "USER_ID": 15 + } } diff --git a/_assets/simulator/spec/methods/imopenlines.session.head.vote.json b/_assets/simulator/spec/methods/imopenlines.session.head.vote.json index 856c580e9..ec3bdad15 100644 --- a/_assets/simulator/spec/methods/imopenlines.session.head.vote.json +++ b/_assets/simulator/spec/methods/imopenlines.session.head.vote.json @@ -64,5 +64,10 @@ } ], "page": "/api-reference/imopenlines/openlines/sessions/imopenlines-session-head-vote.html", - "executable": false + "executable": false, + "requestExample": { + "SESSION_ID": 1743, + "RATING": 5, + "COMMENT": "Отличная обработка" + } } diff --git a/_assets/simulator/spec/methods/imopenlines.session.history.get.json b/_assets/simulator/spec/methods/imopenlines.session.history.get.json index 3d0d2c2dd..53f70aaac 100644 --- a/_assets/simulator/spec/methods/imopenlines.session.history.get.json +++ b/_assets/simulator/spec/methods/imopenlines.session.history.get.json @@ -44,5 +44,8 @@ } ], "page": "/api-reference/imopenlines/openlines/sessions/imopenlines-session-history-get.html", - "executable": false + "executable": false, + "requestExample": { + "SESSION_ID": 321 + } } diff --git a/_assets/simulator/spec/methods/imopenlines.session.intercept.json b/_assets/simulator/spec/methods/imopenlines.session.intercept.json index a0468f8ef..c795abe55 100644 --- a/_assets/simulator/spec/methods/imopenlines.session.intercept.json +++ b/_assets/simulator/spec/methods/imopenlines.session.intercept.json @@ -50,5 +50,8 @@ } ], "page": "/api-reference/imopenlines/openlines/sessions/imopenlines-session-intercept.html", - "executable": false + "executable": false, + "requestExample": { + "CHAT_ID": 2043 + } } diff --git a/_assets/simulator/spec/methods/imopenlines.session.join.json b/_assets/simulator/spec/methods/imopenlines.session.join.json index c56363e3d..0dde95f48 100644 --- a/_assets/simulator/spec/methods/imopenlines.session.join.json +++ b/_assets/simulator/spec/methods/imopenlines.session.join.json @@ -50,5 +50,8 @@ } ], "page": "/api-reference/imopenlines/openlines/sessions/imopenlines-session-join.html", - "executable": false + "executable": false, + "requestExample": { + "CHAT_ID": 2043 + } } diff --git a/_assets/simulator/spec/methods/imopenlines.session.mode.pin.json b/_assets/simulator/spec/methods/imopenlines.session.mode.pin.json index 3a9dbf039..3b7909509 100644 --- a/_assets/simulator/spec/methods/imopenlines.session.mode.pin.json +++ b/_assets/simulator/spec/methods/imopenlines.session.mode.pin.json @@ -57,5 +57,9 @@ } ], "page": "/api-reference/imopenlines/openlines/sessions/imopenlines-session-mode-pin.html", - "executable": false + "executable": false, + "requestExample": { + "CHAT_ID": 2043, + "ACTIVATE": "Y" + } } diff --git a/_assets/simulator/spec/methods/imopenlines.session.mode.silent.json b/_assets/simulator/spec/methods/imopenlines.session.mode.silent.json index 7ef8d33e7..78d562069 100644 --- a/_assets/simulator/spec/methods/imopenlines.session.mode.silent.json +++ b/_assets/simulator/spec/methods/imopenlines.session.mode.silent.json @@ -60,5 +60,9 @@ } ], "page": "/api-reference/imopenlines/openlines/sessions/imopenlines-session-mode-silent.html", - "executable": false + "executable": false, + "requestExample": { + "CHAT_ID": 2043, + "ACTIVATE": "Y" + } } diff --git a/_assets/simulator/spec/methods/imopenlines.session.open.json b/_assets/simulator/spec/methods/imopenlines.session.open.json index d9141caf0..248e2f733 100644 --- a/_assets/simulator/spec/methods/imopenlines.session.open.json +++ b/_assets/simulator/spec/methods/imopenlines.session.open.json @@ -52,5 +52,8 @@ } ], "page": "/api-reference/imopenlines/openlines/sessions/imopenlines-session-open.html", - "executable": false + "executable": false, + "requestExample": { + "USER_CODE": "livechat|22|1761|587" + } } diff --git a/_assets/simulator/spec/methods/imopenlines.session.start.json b/_assets/simulator/spec/methods/imopenlines.session.start.json index a9822615d..388fe5d51 100644 --- a/_assets/simulator/spec/methods/imopenlines.session.start.json +++ b/_assets/simulator/spec/methods/imopenlines.session.start.json @@ -50,5 +50,8 @@ } ], "page": "/api-reference/imopenlines/openlines/sessions/imopenlines-session-start.html", - "executable": false + "executable": false, + "requestExample": { + "CHAT_ID": 2043 + } } diff --git a/_assets/simulator/spec/methods/imopenlines.v2.Operator.list.json b/_assets/simulator/spec/methods/imopenlines.v2.Operator.list.json index 919443693..18422422b 100644 --- a/_assets/simulator/spec/methods/imopenlines.v2.Operator.list.json +++ b/_assets/simulator/spec/methods/imopenlines.v2.Operator.list.json @@ -157,5 +157,10 @@ "maxChat", "status", "userId" - ] + ], + "requestExample": { + "configId": 3, + "status": "online", + "limit": 50 + } } diff --git a/_assets/simulator/spec/methods/imopenlines.v2.Session.Rating.list.json b/_assets/simulator/spec/methods/imopenlines.v2.Session.Rating.list.json index 8a0309356..a661ae347 100644 --- a/_assets/simulator/spec/methods/imopenlines.v2.Session.Rating.list.json +++ b/_assets/simulator/spec/methods/imopenlines.v2.Session.Rating.list.json @@ -189,5 +189,11 @@ "source", "vote", "voteHead" - ] + ], + "requestExample": { + "configId": 3, + "vote": "like", + "dateVoteFrom": "2026-06-01T00:00:00+03:00", + "dateVoteTo": "2026-06-30T23:59:59+03:00" + } } diff --git a/_assets/simulator/spec/methods/imopenlines.v2.Session.Stat.get.json b/_assets/simulator/spec/methods/imopenlines.v2.Session.Stat.get.json index 7851e8f01..9387ba099 100644 --- a/_assets/simulator/spec/methods/imopenlines.v2.Session.Stat.get.json +++ b/_assets/simulator/spec/methods/imopenlines.v2.Session.Stat.get.json @@ -100,5 +100,12 @@ "voteHead", "waitAnswer", "waitClose" - ] + ], + "requestExample": { + "sessionId": [ + 1024, + 1025, + 999999 + ] + } } diff --git a/_assets/simulator/spec/methods/imopenlines.v2.Session.Transfer.list.json b/_assets/simulator/spec/methods/imopenlines.v2.Session.Transfer.list.json index 9e684217b..c122f5560 100644 --- a/_assets/simulator/spec/methods/imopenlines.v2.Session.Transfer.list.json +++ b/_assets/simulator/spec/methods/imopenlines.v2.Session.Transfer.list.json @@ -100,5 +100,11 @@ "toConfigId", "toOperatorId", "type" - ] + ], + "requestExample": { + "sessionId": [ + 1024, + 1025 + ] + } } diff --git a/_assets/simulator/spec/methods/imopenlines.v2.Session.list.json b/_assets/simulator/spec/methods/imopenlines.v2.Session.list.json index 40ce3d1fd..b229901da 100644 --- a/_assets/simulator/spec/methods/imopenlines.v2.Session.list.json +++ b/_assets/simulator/spec/methods/imopenlines.v2.Session.list.json @@ -381,5 +381,12 @@ "voteHead", "waitAnswer", "waitClose" - ] + ], + "requestExample": { + "configId": 3, + "status": "closed", + "dateCreateFrom": "2026-06-01T00:00:00+03:00", + "dateCreateTo": "2026-06-30T23:59:59+03:00", + "limit": 50 + } } diff --git a/_assets/simulator/spec/methods/imopenlines.v2.Stat.get.json b/_assets/simulator/spec/methods/imopenlines.v2.Stat.get.json index 4442d04ab..7ce683d38 100644 --- a/_assets/simulator/spec/methods/imopenlines.v2.Stat.get.json +++ b/_assets/simulator/spec/methods/imopenlines.v2.Stat.get.json @@ -167,5 +167,10 @@ "entityFields": [ "count", "source" - ] + ], + "requestExample": { + "dateFrom": "2026-06-01T00:00:00+03:00", + "dateTo": "2026-06-30T23:59:59+03:00", + "configId": 3 + } } diff --git a/_assets/simulator/spec/methods/landing.block.addcard.json b/_assets/simulator/spec/methods/landing.block.addcard.json index 87f169e23..78ee8b091 100644 --- a/_assets/simulator/spec/methods/landing.block.addcard.json +++ b/_assets/simulator/spec/methods/landing.block.addcard.json @@ -85,5 +85,11 @@ } ], "page": "/api-reference/landing/block/methods/landing-block-add-card.html", - "executable": false + "executable": false, + "requestExample": { + "lid": 351, + "block": 6428, + "selector": ".landing-block-node-menu-list-item@0", + "content": "
  • Услуги
    • " + } } diff --git a/_assets/simulator/spec/methods/landing.block.changeAnchor.json b/_assets/simulator/spec/methods/landing.block.changeAnchor.json index 6076bc7d7..6d4818aa9 100644 --- a/_assets/simulator/spec/methods/landing.block.changeAnchor.json +++ b/_assets/simulator/spec/methods/landing.block.changeAnchor.json @@ -78,5 +78,11 @@ } ], "page": "/api-reference/landing/block/methods/landing-block-change-anchor.html", - "executable": false + "executable": false, + "requestExample": { + "lid": 311, + "block": 6058, + "data": "about-us", + "preventHistory": true + } } diff --git a/_assets/simulator/spec/methods/landing.block.clonecard.json b/_assets/simulator/spec/methods/landing.block.clonecard.json index 99285526d..febbd1b8c 100644 --- a/_assets/simulator/spec/methods/landing.block.clonecard.json +++ b/_assets/simulator/spec/methods/landing.block.clonecard.json @@ -78,5 +78,10 @@ } ], "page": "/api-reference/landing/block/methods/landing-block-clone-card.html", - "executable": false + "executable": false, + "requestExample": { + "lid": 351, + "block": 6428, + "selector": ".landing-block-card@0" + } } diff --git a/_assets/simulator/spec/methods/landing.block.getContentFromRepository.json b/_assets/simulator/spec/methods/landing.block.getContentFromRepository.json index b004e4b31..9e04a6b29 100644 --- a/_assets/simulator/spec/methods/landing.block.getContentFromRepository.json +++ b/_assets/simulator/spec/methods/landing.block.getContentFromRepository.json @@ -50,5 +50,8 @@ } ], "page": "/api-reference/landing/block/methods/landing-block-get-content-from-repository.html", - "executable": false + "executable": false, + "requestExample": { + "code": "01.big_with_text" + } } diff --git a/_assets/simulator/spec/methods/landing.block.getbyid.json b/_assets/simulator/spec/methods/landing.block.getbyid.json index 18e603427..38d24b060 100644 --- a/_assets/simulator/spec/methods/landing.block.getbyid.json +++ b/_assets/simulator/spec/methods/landing.block.getbyid.json @@ -119,5 +119,12 @@ } ], "page": "/api-reference/landing/block/methods/landing-block-get-by-id.html", - "executable": false + "executable": false, + "requestExample": { + "block": 39556, + "params": { + "edit_mode": true, + "get_content": true + } + } } diff --git a/_assets/simulator/spec/methods/landing.block.getcontent.json b/_assets/simulator/spec/methods/landing.block.getcontent.json index 789223183..4f6d316fe 100644 --- a/_assets/simulator/spec/methods/landing.block.getcontent.json +++ b/_assets/simulator/spec/methods/landing.block.getcontent.json @@ -143,5 +143,13 @@ } ], "page": "/api-reference/landing/block/methods/landing-block-get-content.html", - "executable": false + "executable": false, + "requestExample": { + "lid": 4858, + "block": 39556, + "editMode": true, + "params": { + "wrapper_show": false + } + } } diff --git a/_assets/simulator/spec/methods/landing.block.getlist.json b/_assets/simulator/spec/methods/landing.block.getlist.json index 5ae92767c..69928a52d 100644 --- a/_assets/simulator/spec/methods/landing.block.getlist.json +++ b/_assets/simulator/spec/methods/landing.block.getlist.json @@ -121,5 +121,12 @@ } ], "page": "/api-reference/landing/block/methods/landing-block-get-list.html", - "executable": false + "executable": false, + "requestExample": { + "lid": 4858, + "params": { + "edit_mode": true, + "get_content": true + } + } } diff --git a/_assets/simulator/spec/methods/landing.block.getmanifest.json b/_assets/simulator/spec/methods/landing.block.getmanifest.json index 3f12f7bb3..a0aa9c30c 100644 --- a/_assets/simulator/spec/methods/landing.block.getmanifest.json +++ b/_assets/simulator/spec/methods/landing.block.getmanifest.json @@ -188,5 +188,12 @@ } ], "page": "/api-reference/landing/block/methods/landing-block-get-manifest.html", - "executable": false + "executable": false, + "requestExample": { + "lid": 4858, + "block": 39556, + "params": { + "edit_mode": true + } + } } diff --git a/_assets/simulator/spec/methods/landing.block.getmanifestfile.json b/_assets/simulator/spec/methods/landing.block.getmanifestfile.json index e7a3e732f..5261ab4ff 100644 --- a/_assets/simulator/spec/methods/landing.block.getmanifestfile.json +++ b/_assets/simulator/spec/methods/landing.block.getmanifestfile.json @@ -154,5 +154,8 @@ } ], "page": "/api-reference/landing/block/methods/landing-block-get-manifest-file.html", - "executable": false + "executable": false, + "requestExample": { + "code": "01.big_with_text" + } } diff --git a/_assets/simulator/spec/methods/landing.block.getrepository.json b/_assets/simulator/spec/methods/landing.block.getrepository.json index 624c75593..6307a80c4 100644 --- a/_assets/simulator/spec/methods/landing.block.getrepository.json +++ b/_assets/simulator/spec/methods/landing.block.getrepository.json @@ -108,5 +108,8 @@ } ], "page": "/api-reference/landing/block/methods/landing-block-get-repository.html", - "executable": false + "executable": false, + "requestExample": { + "section": "text" + } } diff --git a/_assets/simulator/spec/methods/landing.block.publication.json b/_assets/simulator/spec/methods/landing.block.publication.json new file mode 100644 index 000000000..b8bfacd65 --- /dev/null +++ b/_assets/simulator/spec/methods/landing.block.publication.json @@ -0,0 +1,64 @@ +{ + "$v": 1, + "method": "landing.block.publication", + "scope": "landing", + "kind": "write", + "title": "Опубликовать блок landing.block.publication", + "permissions": "пользователь с правом «публикации» сайта", + "params": [ + { + "name": "scope", + "type": "string", + "base": "string", + "required": false, + "description": "Внутренний скоуп лендингов. Он не связан с REST-скоупом landing в названии метода. Значение scope должно соответствовать типу сайта (подробное описание). Для типов PAGE, STORE и SMN параметр не передают. Для баз знаний, баз знаний групп и главной страницы передают KNOWLEDGE, GROUP и MAINPAGE" + }, + { + "name": "block", + "type": "integer", + "base": "integer", + "required": true, + "description": "Идентификатор блока в черновике страницы. Идентификатор блока можно получить методом landing.block.getlist с параметром params.edit_mode = true. Идентификатор блока из опубликованной версии страницы методу не подходит: такой блок он не найдет и вернет null" + } + ], + "defs": {}, + "requiredConvention": true, + "confidence": "parsed", + "source": { + "file": "api-reference/landing/block/methods/landing-block-publication.md" + }, + "resultExample": { + "result": true, + "time": { + "start": 1789577637, + "finish": 1789577637.917601, + "duration": 0.9176011085510254, + "processing": 0, + "date_start": "2026-09-16T19:53:57+03:00", + "date_finish": "2026-09-16T19:53:57+03:00", + "operating_reset_at": 1789578237, + "operating": 0.18278789520263672 + } + }, + "returns": [ + { + "name": "result", + "type": "boolean", + "base": "boolean", + "required": false, + "description": "Результат публикации блока. Возможные значения: true — блок опубликован, false — у пользователя нет права публикации, null — блок с переданным идентификатором не найден. Значения false и null приходят с HTTP-статусом 200 и без поля error" + }, + { + "name": "time", + "type": "time", + "base": "object", + "required": false, + "description": "Информация о времени выполнения запроса" + } + ], + "page": "/api-reference/landing/block/methods/landing-block-publication.html", + "executable": false, + "requestExample": { + "block": 6058 + } +} diff --git a/_assets/simulator/spec/methods/landing.block.removecard.json b/_assets/simulator/spec/methods/landing.block.removecard.json index 4597f375b..6576074ac 100644 --- a/_assets/simulator/spec/methods/landing.block.removecard.json +++ b/_assets/simulator/spec/methods/landing.block.removecard.json @@ -78,5 +78,10 @@ } ], "page": "/api-reference/landing/block/methods/landing-block-remove-card.html", - "executable": false + "executable": false, + "requestExample": { + "lid": 351, + "block": 6428, + "selector": ".landing-block-card@0" + } } diff --git a/_assets/simulator/spec/methods/landing.block.updatecontent.json b/_assets/simulator/spec/methods/landing.block.updatecontent.json index b0c063b54..3e422ddce 100644 --- a/_assets/simulator/spec/methods/landing.block.updatecontent.json +++ b/_assets/simulator/spec/methods/landing.block.updatecontent.json @@ -85,5 +85,11 @@ } ], "page": "/api-reference/landing/block/methods/landing-block-update-content.html", - "executable": false + "executable": false, + "requestExample": { + "lid": 311, + "block": 6058, + "content": "

    Весенняя акция

    Скидка 15% до конца месяца

    ", + "preventHistory": true + } } diff --git a/_assets/simulator/spec/methods/landing.demos.getList.json b/_assets/simulator/spec/methods/landing.demos.getList.json index b9a42ce44..639cc8549 100644 --- a/_assets/simulator/spec/methods/landing.demos.getList.json +++ b/_assets/simulator/spec/methods/landing.demos.getList.json @@ -112,5 +112,25 @@ } ], "page": "/api-reference/landing/demos/landing-demos-get-list.html", - "executable": false + "executable": false, + "requestExample": { + "params": { + "select": [ + "ID", + "XML_ID", + "TITLE", + "TYPE", + "DATE_MODIFY" + ], + "filter": { + "ACTIVE": "Y" + }, + "order": { + "ID": "DESC" + }, + "group": [ + "TYPE" + ] + } + } } diff --git a/_assets/simulator/spec/methods/landing.demos.getPageList.json b/_assets/simulator/spec/methods/landing.demos.getPageList.json index ff9d8aa5f..b92156319 100644 --- a/_assets/simulator/spec/methods/landing.demos.getPageList.json +++ b/_assets/simulator/spec/methods/landing.demos.getPageList.json @@ -152,5 +152,11 @@ } ], "page": "/api-reference/landing/demos/landing-demos-get-page-list.html", - "executable": false + "executable": false, + "requestExample": { + "type": "page", + "filter": { + "TYPE": "PAGE" + } + } } diff --git a/_assets/simulator/spec/methods/landing.demos.getSiteList.json b/_assets/simulator/spec/methods/landing.demos.getSiteList.json index 73da63ff3..401346dc5 100644 --- a/_assets/simulator/spec/methods/landing.demos.getSiteList.json +++ b/_assets/simulator/spec/methods/landing.demos.getSiteList.json @@ -113,5 +113,11 @@ } ], "page": "/api-reference/landing/demos/landing-demos-get-site-list.html", - "executable": false + "executable": false, + "requestExample": { + "type": "page", + "filter": { + "TYPE": "page" + } + } } diff --git a/_assets/simulator/spec/methods/landing.demos.register.json b/_assets/simulator/spec/methods/landing.demos.register.json index a9d43d34f..2987f0013 100644 --- a/_assets/simulator/spec/methods/landing.demos.register.json +++ b/_assets/simulator/spec/methods/landing.demos.register.json @@ -96,5 +96,50 @@ } ], "page": "/api-reference/landing/demos/landing-demos-register.html", - "executable": false + "executable": false, + "requestExample": { + "data": { + "charset": "UTF-8", + "code": "ftmlt", + "site_code": "/ftmlt/", + "name": "Бизнес", + "description": null, + "type": "page", + "fields": { + "TITLE": "Бизнес", + "LANDING_ID_INDEX": "0", + "LANDING_ID_404": "0", + "ADDITIONAL_FIELDS": {} + }, + "folders": [], + "items": { + "ftmlt": { + "old_id": "16", + "code": "ftmlt", + "name": "Бизнес", + "description": null, + "preview": "", + "preview2x": "", + "preview3x": "", + "preview_url": "", + "show_in_list": "Y", + "type": "page", + "version": 3, + "fields": { + "TITLE": "Бизнес" + }, + "layout": [], + "items": {} + } + }, + "layout": [], + "preview": "", + "preview2x": "", + "preview3x": "", + "preview_url": "", + "show_in_list": "Y", + "syspages": [], + "version": 3 + } + } } diff --git a/_assets/simulator/spec/methods/landing.demos.unregister.json b/_assets/simulator/spec/methods/landing.demos.unregister.json index 8a9081223..30dbed90f 100644 --- a/_assets/simulator/spec/methods/landing.demos.unregister.json +++ b/_assets/simulator/spec/methods/landing.demos.unregister.json @@ -50,5 +50,8 @@ } ], "page": "/api-reference/landing/demos/landing-demos-unregister.html", - "executable": false + "executable": false, + "requestExample": { + "code": "ftmlt" + } } diff --git a/_assets/simulator/spec/methods/landing.landing.add.json b/_assets/simulator/spec/methods/landing.landing.add.json index 13ecd5a02..564d52da2 100644 --- a/_assets/simulator/spec/methods/landing.landing.add.json +++ b/_assets/simulator/spec/methods/landing.landing.add.json @@ -152,5 +152,16 @@ } ], "page": "/api-reference/landing/page/methods/landing-landing-add.html", - "executable": false + "executable": false, + "requestExample": { + "fields": { + "TITLE": "Весенняя акция", + "SITE_ID": 292, + "CODE": "spring-sale", + "DESCRIPTION": "Страница для сезонной акции", + "ADDITIONAL_FIELDS": { + "THEME_CODE": "wedding" + } + } + } } diff --git a/_assets/simulator/spec/methods/landing.landing.addByTemplate.json b/_assets/simulator/spec/methods/landing.landing.addByTemplate.json index 4ab7fda21..3d92d8ebf 100644 --- a/_assets/simulator/spec/methods/landing.landing.addByTemplate.json +++ b/_assets/simulator/spec/methods/landing.landing.addByTemplate.json @@ -152,5 +152,14 @@ } ], "page": "/api-reference/landing/page/methods/landing-landing-add-by-template.html", - "executable": false + "executable": false, + "requestExample": { + "siteId": 157, + "code": "krayt.monotovar@KraytPetShop", + "fields": { + "TITLE": "Весенняя акция", + "DESCRIPTION": "SEO-описание страницы акции", + "FOLDER_ID": 95 + } + } } diff --git a/_assets/simulator/spec/methods/landing.landing.addblock.json b/_assets/simulator/spec/methods/landing.landing.addblock.json index 5ba577909..70883a056 100644 --- a/_assets/simulator/spec/methods/landing.landing.addblock.json +++ b/_assets/simulator/spec/methods/landing.landing.addblock.json @@ -117,5 +117,13 @@ } ], "page": "/api-reference/landing/page/block-methods/landing-landing-add-block.html", - "executable": false + "executable": false, + "requestExample": { + "lid": 351, + "fields": { + "CODE": "02.three_cols_big_1", + "AFTER_ID": 6428, + "ACTIVE": "Y" + } + } } diff --git a/_assets/simulator/spec/methods/landing.landing.copy.json b/_assets/simulator/spec/methods/landing.landing.copy.json index 63b5da065..e3b7faed6 100644 --- a/_assets/simulator/spec/methods/landing.landing.copy.json +++ b/_assets/simulator/spec/methods/landing.landing.copy.json @@ -78,5 +78,10 @@ } ], "page": "/api-reference/landing/page/methods/landing-landing-copy.html", - "executable": false + "executable": false, + "requestExample": { + "lid": 1688, + "toSiteId": 305, + "toFolderId": 95 + } } diff --git a/_assets/simulator/spec/methods/landing.landing.copyblock.json b/_assets/simulator/spec/methods/landing.landing.copyblock.json index 65f08d16e..19aab8f65 100644 --- a/_assets/simulator/spec/methods/landing.landing.copyblock.json +++ b/_assets/simulator/spec/methods/landing.landing.copyblock.json @@ -96,5 +96,13 @@ } ], "page": "/api-reference/landing/page/block-methods/landing-landing-copy-block.html", - "executable": false + "executable": false, + "requestExample": { + "lid": 351, + "block": 6428, + "params": { + "AFTER_ID": 6429, + "RETURN_CONTENT": "Y" + } + } } diff --git a/_assets/simulator/spec/methods/landing.landing.delete.json b/_assets/simulator/spec/methods/landing.landing.delete.json index 183e20e9e..0e9788b39 100644 --- a/_assets/simulator/spec/methods/landing.landing.delete.json +++ b/_assets/simulator/spec/methods/landing.landing.delete.json @@ -57,5 +57,8 @@ } ], "page": "/api-reference/landing/page/methods/landing-landing-delete.html", - "executable": false + "executable": false, + "requestExample": { + "lid": 350 + } } diff --git a/_assets/simulator/spec/methods/landing.landing.deleteblock.json b/_assets/simulator/spec/methods/landing.landing.deleteblock.json index 505f0f58b..5564d3bf9 100644 --- a/_assets/simulator/spec/methods/landing.landing.deleteblock.json +++ b/_assets/simulator/spec/methods/landing.landing.deleteblock.json @@ -64,5 +64,9 @@ } ], "page": "/api-reference/landing/page/block-methods/landing-landing-delete-block.html", - "executable": false + "executable": false, + "requestExample": { + "lid": 351, + "block": 6428 + } } diff --git a/_assets/simulator/spec/methods/landing.landing.downblock.json b/_assets/simulator/spec/methods/landing.landing.downblock.json index a7513d795..c0b5ccb96 100644 --- a/_assets/simulator/spec/methods/landing.landing.downblock.json +++ b/_assets/simulator/spec/methods/landing.landing.downblock.json @@ -71,5 +71,9 @@ } ], "page": "/api-reference/landing/page/block-methods/landing-landing-down-block.html", - "executable": false + "executable": false, + "requestExample": { + "lid": 351, + "block": 6428 + } } diff --git a/_assets/simulator/spec/methods/landing.landing.favoriteBlock.json b/_assets/simulator/spec/methods/landing.landing.favoriteBlock.json index 8c029084f..237bfda31 100644 --- a/_assets/simulator/spec/methods/landing.landing.favoriteBlock.json +++ b/_assets/simulator/spec/methods/landing.landing.favoriteBlock.json @@ -110,5 +110,18 @@ } ], "page": "/api-reference/landing/page/block-methods/landing-landing-favorite-block.html", - "executable": false + "executable": false, + "requestExample": { + "lid": 351, + "block": 6428, + "meta": { + "name": "Блок с преимуществами", + "section": [ + "text", + "features" + ], + "preview": 918273, + "tpl_code": "bitrix24" + } + } } diff --git a/_assets/simulator/spec/methods/landing.landing.getList.json b/_assets/simulator/spec/methods/landing.landing.getList.json index 435fbe896..45aa94b85 100644 --- a/_assets/simulator/spec/methods/landing.landing.getList.json +++ b/_assets/simulator/spec/methods/landing.landing.getList.json @@ -146,5 +146,25 @@ } ], "page": "/api-reference/landing/page/methods/landing-landing-get-list.html", - "executable": false + "executable": false, + "requestExample": { + "params": { + "select": [ + "ID", + "TITLE", + "SITE_ID", + "DATE_MODIFY" + ], + "filter": { + "SITE_ID": 205, + "=DELETED": "N" + }, + "order": { + "ID": "DESC" + }, + "get_urls": true, + "get_preview": true, + "check_area": true + } + } } diff --git a/_assets/simulator/spec/methods/landing.landing.getadditionalfields.json b/_assets/simulator/spec/methods/landing.landing.getadditionalfields.json index 7ae2f784a..576d479d7 100644 --- a/_assets/simulator/spec/methods/landing.landing.getadditionalfields.json +++ b/_assets/simulator/spec/methods/landing.landing.getadditionalfields.json @@ -71,5 +71,8 @@ } ], "page": "/api-reference/landing/page/methods/landing-landing-get-additional-fields.html", - "executable": false + "executable": false, + "requestExample": { + "lid": 349 + } } diff --git a/_assets/simulator/spec/methods/landing.landing.getpreview.json b/_assets/simulator/spec/methods/landing.landing.getpreview.json index 0c273b7bb..4fd4d4272 100644 --- a/_assets/simulator/spec/methods/landing.landing.getpreview.json +++ b/_assets/simulator/spec/methods/landing.landing.getpreview.json @@ -57,5 +57,8 @@ } ], "page": "/api-reference/landing/page/methods/landing-landing-get-preview.html", - "executable": false + "executable": false, + "requestExample": { + "lid": 351 + } } diff --git a/_assets/simulator/spec/methods/landing.landing.getpublicurl.json b/_assets/simulator/spec/methods/landing.landing.getpublicurl.json index 3680798aa..d4f0ffb45 100644 --- a/_assets/simulator/spec/methods/landing.landing.getpublicurl.json +++ b/_assets/simulator/spec/methods/landing.landing.getpublicurl.json @@ -57,5 +57,8 @@ } ], "page": "/api-reference/landing/page/methods/landing-landing-get-public-url.html", - "executable": false + "executable": false, + "requestExample": { + "lid": 351 + } } diff --git a/_assets/simulator/spec/methods/landing.landing.hideblock.json b/_assets/simulator/spec/methods/landing.landing.hideblock.json index 5bdf7d1f3..91baceb50 100644 --- a/_assets/simulator/spec/methods/landing.landing.hideblock.json +++ b/_assets/simulator/spec/methods/landing.landing.hideblock.json @@ -64,5 +64,9 @@ } ], "page": "/api-reference/landing/page/block-methods/landing-landing-hide-block.html", - "executable": false + "executable": false, + "requestExample": { + "lid": 351, + "block": 6428 + } } diff --git a/_assets/simulator/spec/methods/landing.landing.markDelete.json b/_assets/simulator/spec/methods/landing.landing.markDelete.json index 0de3ae22e..8301541e5 100644 --- a/_assets/simulator/spec/methods/landing.landing.markDelete.json +++ b/_assets/simulator/spec/methods/landing.landing.markDelete.json @@ -64,5 +64,8 @@ } ], "page": "/api-reference/landing/page/methods/landing-landing-mark-delete.html", - "executable": false + "executable": false, + "requestExample": { + "lid": 350 + } } diff --git a/_assets/simulator/spec/methods/landing.landing.markUnDelete.json b/_assets/simulator/spec/methods/landing.landing.markUnDelete.json index 030a6cc3f..bf69ad057 100644 --- a/_assets/simulator/spec/methods/landing.landing.markUnDelete.json +++ b/_assets/simulator/spec/methods/landing.landing.markUnDelete.json @@ -6,6 +6,13 @@ "title": "Восстановить страницу из корзины landing.landing.markUnDelete", "permissions": "пользователь с правом «удаления» сайта", "params": [ + { + "name": "scope", + "type": "string", + "base": "string", + "required": false, + "description": "Внутренний скоуп лендингов. Он не связан с REST-скоупом landing в названии метода. Для страниц сайтов типов PAGE, STORE и SMN параметр не нужен. Для страниц сайтов типов GROUP, KNOWLEDGE и MAINPAGE передайте соответствующее значение scope (подробное описание)" + }, { "name": "lid", "type": "integer", @@ -50,5 +57,8 @@ } ], "page": "/api-reference/landing/page/methods/landing-landing-mark-undelete.html", - "executable": false + "executable": false, + "requestExample": { + "lid": 2227 + } } diff --git a/_assets/simulator/spec/methods/landing.landing.markdeletedblock.json b/_assets/simulator/spec/methods/landing.landing.markdeletedblock.json index 0b4330f72..dfa949937 100644 --- a/_assets/simulator/spec/methods/landing.landing.markdeletedblock.json +++ b/_assets/simulator/spec/methods/landing.landing.markdeletedblock.json @@ -78,5 +78,9 @@ } ], "page": "/api-reference/landing/page/block-methods/landing-landing-mark-deleted-block.html", - "executable": false + "executable": false, + "requestExample": { + "lid": 351, + "block": 6428 + } } diff --git a/_assets/simulator/spec/methods/landing.landing.markundeletedblock.json b/_assets/simulator/spec/methods/landing.landing.markundeletedblock.json index 458a22187..86ca75b4d 100644 --- a/_assets/simulator/spec/methods/landing.landing.markundeletedblock.json +++ b/_assets/simulator/spec/methods/landing.landing.markundeletedblock.json @@ -71,5 +71,9 @@ } ], "page": "/api-reference/landing/page/block-methods/landing-landing-mark-undeleted-block.html", - "executable": false + "executable": false, + "requestExample": { + "lid": 627, + "block": 11923 + } } diff --git a/_assets/simulator/spec/methods/landing.landing.move.json b/_assets/simulator/spec/methods/landing.landing.move.json index 42582c8f2..b15e8a3b7 100644 --- a/_assets/simulator/spec/methods/landing.landing.move.json +++ b/_assets/simulator/spec/methods/landing.landing.move.json @@ -71,5 +71,10 @@ } ], "page": "/api-reference/landing/page/methods/landing-landing-move.html", - "executable": false + "executable": false, + "requestExample": { + "lid": 2227, + "toSiteId": 157, + "toFolderId": 95 + } } diff --git a/_assets/simulator/spec/methods/landing.landing.moveblock.json b/_assets/simulator/spec/methods/landing.landing.moveblock.json index a200606c8..f78e176bc 100644 --- a/_assets/simulator/spec/methods/landing.landing.moveblock.json +++ b/_assets/simulator/spec/methods/landing.landing.moveblock.json @@ -143,5 +143,13 @@ } ], "page": "/api-reference/landing/page/block-methods/landing-landing-move-block.html", - "executable": false + "executable": false, + "requestExample": { + "lid": 351, + "block": 26723, + "params": { + "AFTER_ID": 6429, + "RETURN_CONTENT": "Y" + } + } } diff --git a/_assets/simulator/spec/methods/landing.landing.publication.json b/_assets/simulator/spec/methods/landing.landing.publication.json index 644ea8a24..8fe58744f 100644 --- a/_assets/simulator/spec/methods/landing.landing.publication.json +++ b/_assets/simulator/spec/methods/landing.landing.publication.json @@ -57,5 +57,8 @@ } ], "page": "/api-reference/landing/page/methods/landing-landing-publication.html", - "executable": false + "executable": false, + "requestExample": { + "lid": 351 + } } diff --git a/_assets/simulator/spec/methods/landing.landing.removeEntities.json b/_assets/simulator/spec/methods/landing.landing.removeEntities.json index a67970925..ccb750b86 100644 --- a/_assets/simulator/spec/methods/landing.landing.removeEntities.json +++ b/_assets/simulator/spec/methods/landing.landing.removeEntities.json @@ -89,5 +89,24 @@ } ], "page": "/api-reference/landing/page/methods/landing-landing-remove-entities.html", - "executable": false + "executable": false, + "requestExample": { + "lid": 648, + "data": { + "blocks": [ + 12167, + 123 + ], + "images": [ + { + "block": 12269, + "image": 6866 + }, + { + "block": 12268, + "image": 6861 + } + ] + } + } } diff --git a/_assets/simulator/spec/methods/landing.landing.resolveIdByPublicUrl.json b/_assets/simulator/spec/methods/landing.landing.resolveIdByPublicUrl.json index 626b3a65f..076af126f 100644 --- a/_assets/simulator/spec/methods/landing.landing.resolveIdByPublicUrl.json +++ b/_assets/simulator/spec/methods/landing.landing.resolveIdByPublicUrl.json @@ -64,5 +64,9 @@ } ], "page": "/api-reference/landing/page/methods/landing-landing-resolve-id-by-public-url.html", - "executable": false + "executable": false, + "requestExample": { + "landingUrl": "/catalog/sale/", + "siteId": 1817 + } } diff --git a/_assets/simulator/spec/methods/landing.landing.showblock.json b/_assets/simulator/spec/methods/landing.landing.showblock.json index 9ebe06dfd..8cb96ac93 100644 --- a/_assets/simulator/spec/methods/landing.landing.showblock.json +++ b/_assets/simulator/spec/methods/landing.landing.showblock.json @@ -64,5 +64,9 @@ } ], "page": "/api-reference/landing/page/block-methods/landing-landing-show-block.html", - "executable": false + "executable": false, + "requestExample": { + "lid": 351, + "block": 6428 + } } diff --git a/_assets/simulator/spec/methods/landing.landing.unFavoriteBlock.json b/_assets/simulator/spec/methods/landing.landing.unFavoriteBlock.json index 7bac255d9..fd7b5a6d1 100644 --- a/_assets/simulator/spec/methods/landing.landing.unFavoriteBlock.json +++ b/_assets/simulator/spec/methods/landing.landing.unFavoriteBlock.json @@ -50,5 +50,8 @@ } ], "page": "/api-reference/landing/page/block-methods/landing-landing-unfavorite-block.html", - "executable": false + "executable": false, + "requestExample": { + "blockId": 28619 + } } diff --git a/_assets/simulator/spec/methods/landing.landing.unpublic.json b/_assets/simulator/spec/methods/landing.landing.unpublic.json index 046b8d83c..f9a760915 100644 --- a/_assets/simulator/spec/methods/landing.landing.unpublic.json +++ b/_assets/simulator/spec/methods/landing.landing.unpublic.json @@ -57,5 +57,8 @@ } ], "page": "/api-reference/landing/page/methods/landing-landing-unpublic.html", - "executable": false + "executable": false, + "requestExample": { + "lid": 351 + } } diff --git a/_assets/simulator/spec/methods/landing.landing.upblock.json b/_assets/simulator/spec/methods/landing.landing.upblock.json index fe9e68c6b..7d5fe4f21 100644 --- a/_assets/simulator/spec/methods/landing.landing.upblock.json +++ b/_assets/simulator/spec/methods/landing.landing.upblock.json @@ -71,5 +71,9 @@ } ], "page": "/api-reference/landing/page/block-methods/landing-landing-up-block.html", - "executable": false + "executable": false, + "requestExample": { + "lid": 351, + "block": 6428 + } } diff --git a/_assets/simulator/spec/methods/landing.landing.update.json b/_assets/simulator/spec/methods/landing.landing.update.json index 31592aabb..0ab571ca9 100644 --- a/_assets/simulator/spec/methods/landing.landing.update.json +++ b/_assets/simulator/spec/methods/landing.landing.update.json @@ -6,6 +6,13 @@ "title": "Изменить страницу landing.landing.update", "permissions": "пользователь с правом «изменение настроек» сайта. Чтобы удалить страницу или изменить дату ее публикации, дополнительно нужны права «удаление» и «публикация» на сайте", "params": [ + { + "name": "scope", + "type": "string", + "base": "string", + "required": false, + "description": "Внутренний скоуп лендингов. Он не связан с REST-скоупом landing в названии метода. Для страниц сайтов типов PAGE, STORE и SMN параметр не нужен. Для страниц сайтов типов GROUP, KNOWLEDGE и MAINPAGE передайте соответствующее значение scope (подробное описание)" + }, { "name": "lid", "type": "integer", @@ -152,5 +159,14 @@ } ], "page": "/api-reference/landing/page/methods/landing-landing-update.html", - "executable": false + "executable": false, + "requestExample": { + "lid": 349, + "fields": { + "TITLE": "Весенняя акция 2026", + "CODE": "spring-sale-2026", + "DESCRIPTION": "Обновленное описание страницы акции", + "XML_ID": "promo-2026-landing" + } + } } diff --git a/_assets/simulator/spec/methods/landing.repo.bind.json b/_assets/simulator/spec/methods/landing.repo.bind.json new file mode 100644 index 000000000..3cb099bc8 --- /dev/null +++ b/_assets/simulator/spec/methods/landing.repo.bind.json @@ -0,0 +1,86 @@ +{ + "$v": 1, + "method": "landing.repo.bind", + "scope": "landing", + "kind": "write", + "title": "Зарегистрировать место встраивания landing.repo.bind", + "permissions": "пользователь с правом Просмотр в разделе Сайты", + "params": [ + { + "name": "fields", + "type": "object", + "base": "object", + "required": false, + "description": "Параметры места встраивания (подробное описание)", + "ref": "#/defs/fieldsFields" + } + ], + "defs": { + "fieldsFields": { + "dynamic": { + "allowed": false, + "ufAllowed": true, + "note": "Пользовательские поля UF_* в схеме не описаны" + }, + "fields": [ + { + "name": "PLACEMENT", + "type": "string", + "base": "string", + "required": false, + "description": "Код места встраивания. Код зависит от места, где должен появиться пункт приложения: - LANDING_SETTINGS — пункт в меню настроек сайта или страницы - LANDING_BLOCK_ — пункт редактирования блоков с указанным символьным кодом - LANDING_BLOCK_* — пункт редактирования для всех блоков Метод удаляет пробелы по краям значения и приводит код к верхнему регистру" + }, + { + "name": "PLACEMENT_HANDLER", + "type": "string", + "base": "string", + "required": false, + "description": "Полный HTTP- или HTTPS-адрес обработчика места встраивания. Адрес должен содержать протокол и доменное имя" + }, + { + "name": "TITLE", + "type": "string", + "base": "string", + "required": false, + "description": "Название пункта приложения в интерфейсе. По умолчанию — пустая строка" + } + ] + } + }, + "requiredConvention": true, + "confidence": "parsed", + "source": { + "file": "api-reference/landing/embedding/landing-repo-bind.md" + }, + "resultExample": { + "result": true, + "time": { + "start": 1775203200, + "finish": 1775203200.764211, + "duration": 0.7642109394073486, + "processing": 0, + "date_start": "2026-04-03T11:00:00+03:00", + "date_finish": "2026-04-03T11:00:00+03:00", + "operating_reset_at": 1775203800, + "operating": 0 + } + }, + "returns": [ + { + "name": "result", + "type": "boolean", + "base": "boolean", + "required": false, + "description": "Результат регистрации места встраивания. Возвращает true, если запись успешно добавлена" + }, + { + "name": "time", + "type": "time", + "base": "object", + "required": false, + "description": "Информация о времени выполнения запроса" + } + ], + "page": "/api-reference/landing/embedding/landing-repo-bind.html", + "executable": false +} diff --git a/_assets/simulator/spec/methods/landing.repo.checkContent.json b/_assets/simulator/spec/methods/landing.repo.checkContent.json index 86f39070c..64276ede9 100644 --- a/_assets/simulator/spec/methods/landing.repo.checkContent.json +++ b/_assets/simulator/spec/methods/landing.repo.checkContent.json @@ -60,5 +60,9 @@ } ], "page": "/api-reference/landing/user-blocks/landing-repo-check-content.html", - "executable": false + "executable": false, + "requestExample": { + "content": "
    ", + "splitter": "#AAA#" + } } diff --git a/_assets/simulator/spec/methods/landing.repo.getList.json b/_assets/simulator/spec/methods/landing.repo.getList.json index d21d071ae..616595eec 100644 --- a/_assets/simulator/spec/methods/landing.repo.getList.json +++ b/_assets/simulator/spec/methods/landing.repo.getList.json @@ -131,5 +131,23 @@ } ], "page": "/api-reference/landing/user-blocks/landing-repo-get-list.html", - "executable": false + "executable": false, + "requestExample": { + "params": { + "select": [ + "ID", + "NAME", + "DATE_MODIFY" + ], + "filter": { + "ACTIVE": "Y" + }, + "order": { + "ID": "DESC" + }, + "group": [ + "ACTIVE" + ] + } + } } diff --git a/_assets/simulator/spec/methods/landing.repo.register.json b/_assets/simulator/spec/methods/landing.repo.register.json index bd6ae1dab..4a5dbe7d6 100644 --- a/_assets/simulator/spec/methods/landing.repo.register.json +++ b/_assets/simulator/spec/methods/landing.repo.register.json @@ -72,5 +72,26 @@ } ], "page": "/api-reference/landing/user-blocks/landing-repo-register.html", - "executable": false + "executable": false, + "requestExample": { + "code": "myblockx", + "fields": { + "NAME": "Test block", + "DESCRIPTION": "Just try!", + "SECTIONS": "cover,about", + "PREVIEW": "https://www.bitrix24.ru/images/b24_screen.png", + "CONTENT": "
    Test
    " + }, + "manifest": { + "block": { + "name": "Test block" + }, + "nodes": { + ".landing-block-node-text": { + "name": "Text", + "type": "text" + } + } + } + } } diff --git a/_assets/simulator/spec/methods/landing.repo.unregister.json b/_assets/simulator/spec/methods/landing.repo.unregister.json index 296afb723..a483d2b46 100644 --- a/_assets/simulator/spec/methods/landing.repo.unregister.json +++ b/_assets/simulator/spec/methods/landing.repo.unregister.json @@ -50,5 +50,8 @@ } ], "page": "/api-reference/landing/user-blocks/landing-repo-unregister.html", - "executable": false + "executable": false, + "requestExample": { + "code": "myblockx" + } } diff --git a/_assets/simulator/spec/methods/landing.repowidget.debug.json b/_assets/simulator/spec/methods/landing.repowidget.debug.json index 8afe1a2bf..3e518e286 100644 --- a/_assets/simulator/spec/methods/landing.repowidget.debug.json +++ b/_assets/simulator/spec/methods/landing.repowidget.debug.json @@ -3,15 +3,25 @@ "method": "landing.repowidget.debug", "scope": "landing", "kind": "write", - "title": "Включить режим отладки landing.repowidget.debug", + "title": "Включить или выключить режим отладки landing.repowidget.debug", "permissions": "любой пользователь", "params": [ { "name": "enable", "type": "boolean", "base": "boolean", - "required": false, - "description": "Флаг активности режима отладки" + "required": true, + "description": "Режим отладки. Возможные значения: - true — включить - false — выключить В запросе с полями формы передавайте 1 или 0: строка false включит режим", + "values": [ + { + "value": "true", + "title": "включить" + }, + { + "value": "false", + "title": "выключить В запросе с полями формы передавайте 1 или 0: строка false включит реж" + } + ] } ], "defs": {}, @@ -38,7 +48,7 @@ "type": "boolean", "base": "boolean", "required": false, - "description": "В случае успеха — true, в противном случае — ошибка" + "description": "true, если режим отладки установлен в переданное значение" }, { "name": "time", diff --git a/_assets/simulator/spec/methods/landing.repowidget.getlist.json b/_assets/simulator/spec/methods/landing.repowidget.getlist.json index 5066a58e0..2039cc698 100644 --- a/_assets/simulator/spec/methods/landing.repowidget.getlist.json +++ b/_assets/simulator/spec/methods/landing.repowidget.getlist.json @@ -10,8 +10,8 @@ "name": "params", "type": "object", "base": "object", - "required": true, - "description": "Массив полей для получения списка виджетов", + "required": "unknown", + "description": "Параметры выборки (подробное описание). Если не передан, метод вернет все виджеты", "ref": "#/defs/paramsFields" } ], @@ -27,28 +27,28 @@ "name": "select", "type": "array", "base": "array", - "required": false, - "description": "Массив со списком полей, которые необходимо выбрать. Если не передан или передан пустой массив, то будут выбраны все доступные доступные виджеты" + "required": "unknown", + "description": "Массив со списком полей, которые необходимо выбрать. Если не передан, будут выбраны все поля. Поле MANIFEST добавляется к выборке всегда, поэтому при пустом массиве метод вернет только его" }, { "name": "filter", "type": "object", "base": "object", - "required": false, - "description": "Объект для фильтрации выбранных записей в формате {\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}. Возможные значения для field смотрите в таблице ниже. Ключу может быть задан дополнительный префикс, уточняющий поведение фильтра.…" + "required": "unknown", + "description": "Объект для фильтрации выбранных записей в формате {\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}. Возможные значения для field смотрите в таблице ниже. Условие по APP_CODE метод добавляет в фильтр сам. Ключу может быть задан дополнительный префикс, уточняющий поведение фильтра.…" }, { "name": "group", "type": "array", "base": "array", - "required": false, + "required": "unknown", "description": "Массив для группировки виджетов. Группировать можно по полям виджета" }, { "name": "order", "type": "object", "base": "object", - "required": false, + "required": "unknown", "description": "Объект для сортировки выбранных записей в формате {\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}. Возможные значения для field смотрите в таблице ниже. Возможные значения для order: - asc — в порядке возрастания - desc — в порядке убывания", "values": [ { @@ -60,28 +60,100 @@ "title": "в порядке убывания" } ] + }, + { + "name": "limit", + "type": "integer", + "base": "integer", + "required": "unknown", + "description": "Максимальное количество записей в выборке. Ограничение применяется ко всем блокам приложения в репозитории, включая блоки, добавленные методом landing.repo.register. Виджеты Вайба отбираются уже после этого, поэтому при limit: 10 метод может вернуть меньше 10 виджетов" + }, + { + "name": "offset", + "type": "integer", + "base": "integer", + "required": "unknown", + "description": "Сколько записей пропустить от начала выборки. Используется вместе с limit" } ] } }, - "requiredConvention": true, + "requiredConvention": false, "confidence": "parsed", "source": { "file": "api-reference/vibe/landing-repowidget-get-list.md" }, + "resultExample": { + "result": [ + { + "ID": "4", + "XML_ID": "my_widget", + "APP_CODE": "app.code", + "ACTIVE": "Y", + "NAME": "My widget", + "DESCRIPTION": null, + "SECTIONS": "widgets_company_life", + "SITE_TEMPLATE_ID": null, + "PREVIEW": "https://my-app.com/main_preview.jpg", + "MANIFEST": { + "block": { + "type": [ + "vibe" + ], + "subtype": [ + "widgetvue" + ], + "subtype_params": { + "rootNode": ".w-container", + "demoData": { + "desc": "JustSome widget data", + "count": "420" + }, + "handler": "https://my-app.com/main.php", + "style": "https://my-app.com/main.css", + "lang": { + "ru": { + "W_TITLE": "Люди и их возраст", + "W_EMPTY": "Нет людей" + }, + "en": { + "W_TITLE": "Widget title", + "W_EMPTY": "Empty!" + } + } + } + } + }, + "CONTENT": "
    not_var{{desc}}
    ", + "CREATED_BY_ID": "1", + "MODIFIED_BY_ID": "1", + "DATE_CREATE": "10.10.2024 15:55:30", + "DATE_MODIFY": "16.10.2024 16:12:57" + } + ], + "time": { + "start": 1729162340.81773, + "finish": 1729162344.800994, + "duration": 3.9832639694213867, + "processing": 3.8990869522094727, + "date_start": "2024-10-17T15:52:20+05:00", + "date_finish": "2024-10-17T15:52:24+05:00", + "operating": 3.899045944213867 + } + }, "returns": [ { "name": "result", - "type": "object", - "base": "object", - "required": false, - "description": "Массив виджетов. Каждый элемент массива — объект, допустимые поля описаны выше." + "type": "array", + "base": "array", + "required": "unknown", + "description": "Массив виджетов. Каждый элемент массива — объект, допустимые поля описаны выше. Если подходящих виджетов нет, возвращается пустой массив. Если у приложения в репозитории есть и другие блоки, после отбора виджетов нумерация элементов может прерваться. Тогда массив придет в JSON объектом с числовыми ключами, например {\"1\": {...}, \"3\": {...}}.…" }, { "name": "time", "type": "time", "base": "object", - "required": false, + "required": "unknown", "description": "Информация о времени выполнения запроса" } ], diff --git a/_assets/simulator/spec/methods/landing.repowidget.register.json b/_assets/simulator/spec/methods/landing.repowidget.register.json index 02f6c29bc..536759e68 100644 --- a/_assets/simulator/spec/methods/landing.repowidget.register.json +++ b/_assets/simulator/spec/methods/landing.repowidget.register.json @@ -3,22 +3,22 @@ "method": "landing.repowidget.register", "scope": "landing", "kind": "write", - "title": "Добавить виджет на Вайб landing.repowidget.register", - "permissions": "любой пользователь", + "title": "Добавить виджет для Вайба landing.repowidget.register", + "permissions": "любой пользователь при вызове из приложения, при вызове вебхуком — администратор", "params": [ { "name": "code", "type": "string", "base": "string", "required": true, - "description": "Уникальный код виджета. Настоятельно рекомендуется использовать какой-либо уникальный префикс для своих виджетов, чтобы избежать риск совпадения кодов с виджетами других разработчиков" + "description": "Код виджета, уникальный в пределах приложения. Виджеты разных приложений с одинаковым кодом не конфликтуют" }, { "name": "fields", "type": "object", "base": "object", "required": true, - "description": "Значения полей для создания виджета", + "description": "Значения полей для создания виджета (подробное описание)", "ref": "#/defs/fieldsFields" } ], @@ -70,14 +70,14 @@ "type": "object", "base": "object", "required": true, - "description": "Параметры для vue-шаблонизатора. Без них метод вернет ошибку REQUIRED_FIELD_NO_EXISTS" + "description": "Параметры для шаблонизатора Vue" }, { "name": "ACTIVE", "type": "char", "base": "char", "required": false, - "description": "Активность виджета. Принимает значения: - Y - виджет активен и доступен - N - виджет неактивен и недоступен", + "description": "Активность виджета. Принимает значения: - Y — виджет активен и доступен - N — виджет неактивен и недоступен По умолчанию — Y", "flag": true }, { diff --git a/_assets/simulator/spec/methods/landing.repowidget.unregister.json b/_assets/simulator/spec/methods/landing.repowidget.unregister.json index 26cd87870..455c05403 100644 --- a/_assets/simulator/spec/methods/landing.repowidget.unregister.json +++ b/_assets/simulator/spec/methods/landing.repowidget.unregister.json @@ -4,14 +4,14 @@ "scope": "landing", "kind": "write", "title": "Удалить виджет для Вайба landing.repowidget.unregister", - "permissions": "любой пользователь", + "permissions": "любой пользователь при вызове из приложения, при вызове вебхуком — администратор", "params": [ { "name": "code", "type": "string", "base": "string", "required": true, - "description": "Уникальный код удаляемого виджета" + "description": "Уникальный код удаляемого виджета — который передавали в code при регистрации методом landing.repowidget.register. Код можно получить из поля XML_ID в ответе метода landing.repowidget.getlist" } ], "defs": {}, @@ -38,7 +38,7 @@ "type": "boolean", "base": "boolean", "required": false, - "description": "Результат удаления виджета" + "description": "Результат удаления виджета: - true — виджет найден и удален - false — code пустой или виджет с таким кодом не найден" }, { "name": "time", diff --git a/_assets/simulator/spec/methods/landing.role.enable.json b/_assets/simulator/spec/methods/landing.role.enable.json index ac1a88615..aa5d884d4 100644 --- a/_assets/simulator/spec/methods/landing.role.enable.json +++ b/_assets/simulator/spec/methods/landing.role.enable.json @@ -57,5 +57,8 @@ } ], "page": "/api-reference/landing/rights/landing-role-enable.html", - "executable": false + "executable": false, + "requestExample": { + "mode": 1 + } } diff --git a/_assets/simulator/spec/methods/landing.role.getList.json b/_assets/simulator/spec/methods/landing.role.getList.json index 313c745a4..fc332309c 100644 --- a/_assets/simulator/spec/methods/landing.role.getList.json +++ b/_assets/simulator/spec/methods/landing.role.getList.json @@ -61,5 +61,8 @@ } ], "page": "/api-reference/landing/rights/role-model/landing-role-get-list.html", - "executable": false + "executable": false, + "requestExample": { + "scope": "KNOWLEDGE" + } } diff --git a/_assets/simulator/spec/methods/landing.role.getRights.json b/_assets/simulator/spec/methods/landing.role.getRights.json index ecd8b8390..f2ac832ad 100644 --- a/_assets/simulator/spec/methods/landing.role.getRights.json +++ b/_assets/simulator/spec/methods/landing.role.getRights.json @@ -65,5 +65,8 @@ } ], "page": "/api-reference/landing/rights/role-model/landing-role-get-rights.html", - "executable": false + "executable": false, + "requestExample": { + "id": 2 + } } diff --git a/_assets/simulator/spec/methods/landing.role.isEnabled.json b/_assets/simulator/spec/methods/landing.role.isEnabled.json index 6afdad2b4..b07036a2c 100644 --- a/_assets/simulator/spec/methods/landing.role.isEnabled.json +++ b/_assets/simulator/spec/methods/landing.role.isEnabled.json @@ -61,5 +61,6 @@ } ], "page": "/api-reference/landing/rights/landing-role-is-enabled.html", - "executable": false + "executable": false, + "requestExample": {} } diff --git a/_assets/simulator/spec/methods/landing.role.setAccessCodes.json b/_assets/simulator/spec/methods/landing.role.setAccessCodes.json index 98d467984..5db1864ee 100644 --- a/_assets/simulator/spec/methods/landing.role.setAccessCodes.json +++ b/_assets/simulator/spec/methods/landing.role.setAccessCodes.json @@ -68,5 +68,13 @@ } ], "page": "/api-reference/landing/rights/role-model/landing-role-set-access-codes.html", - "executable": false + "executable": false, + "requestExample": { + "id": 11, + "codes": [ + "U45", + "DR7", + "SG3_A" + ] + } } diff --git a/_assets/simulator/spec/methods/landing.site.add.json b/_assets/simulator/spec/methods/landing.site.add.json index afdba75ed..0fac5ed6c 100644 --- a/_assets/simulator/spec/methods/landing.site.add.json +++ b/_assets/simulator/spec/methods/landing.site.add.json @@ -117,5 +117,14 @@ } ], "page": "/api-reference/landing/site/landing-site-add.html", - "executable": false + "executable": false, + "requestExample": { + "scope": "KNOWLEDGE", + "fields": { + "TITLE": "База знаний компании", + "CODE": "", + "TYPE": "KNOWLEDGE", + "DESCRIPTION": "Сайт базы знаний" + } + } } diff --git a/_assets/simulator/spec/methods/landing.site.addFolder.json b/_assets/simulator/spec/methods/landing.site.addFolder.json index a8a66beea..043f87a72 100644 --- a/_assets/simulator/spec/methods/landing.site.addFolder.json +++ b/_assets/simulator/spec/methods/landing.site.addFolder.json @@ -103,5 +103,14 @@ } ], "page": "/api-reference/landing/site/landing-site-add-folder.html", - "executable": false + "executable": false, + "requestExample": { + "siteId": 1817, + "fields": { + "TITLE": "Новая папка", + "CODE": "new-folder", + "ACTIVE": "Y", + "PARENT_ID": 736 + } + } } diff --git a/_assets/simulator/spec/methods/landing.site.bindingToGroup.json b/_assets/simulator/spec/methods/landing.site.bindingToGroup.json index 15c51922a..03a8ef57e 100644 --- a/_assets/simulator/spec/methods/landing.site.bindingToGroup.json +++ b/_assets/simulator/spec/methods/landing.site.bindingToGroup.json @@ -57,5 +57,9 @@ } ], "page": "/api-reference/landing/embedding/knowledge-base/landing-site-binding-to-group.html", - "executable": false + "executable": false, + "requestExample": { + "id": 32, + "groupId": 174 + } } diff --git a/_assets/simulator/spec/methods/landing.site.bindingToMenu.json b/_assets/simulator/spec/methods/landing.site.bindingToMenu.json index 08b1973b7..efadd8f32 100644 --- a/_assets/simulator/spec/methods/landing.site.bindingToMenu.json +++ b/_assets/simulator/spec/methods/landing.site.bindingToMenu.json @@ -57,5 +57,9 @@ } ], "page": "/api-reference/landing/embedding/knowledge-base/landing-site-binding-to-menu.html", - "executable": false + "executable": false, + "requestExample": { + "id": 31, + "menuCode": "crm_switcher:deal" + } } diff --git a/_assets/simulator/spec/methods/landing.site.delete.json b/_assets/simulator/spec/methods/landing.site.delete.json index c6e5d7ebb..eda406965 100644 --- a/_assets/simulator/spec/methods/landing.site.delete.json +++ b/_assets/simulator/spec/methods/landing.site.delete.json @@ -57,5 +57,8 @@ } ], "page": "/api-reference/landing/site/landing-site-delete.html", - "executable": false + "executable": false, + "requestExample": { + "id": 206 + } } diff --git a/_assets/simulator/spec/methods/landing.site.fullExport.json b/_assets/simulator/spec/methods/landing.site.fullExport.json index 381e67845..29c220a19 100644 --- a/_assets/simulator/spec/methods/landing.site.fullExport.json +++ b/_assets/simulator/spec/methods/landing.site.fullExport.json @@ -219,5 +219,15 @@ } ], "page": "/api-reference/landing/site/landing-site-full-export.html", - "executable": false + "executable": false, + "requestExample": { + "id": 326, + "params": { + "edit_mode": "Y", + "code": "myfirstsite2026", + "name": "Сайт автомастерской", + "description": "Сайт для автосервиса", + "preview_url": "https://example.com/previews/myfirstsite2026" + } + } } diff --git a/_assets/simulator/spec/methods/landing.site.getFolders.json b/_assets/simulator/spec/methods/landing.site.getFolders.json index 56befb6c6..0985aed0c 100644 --- a/_assets/simulator/spec/methods/landing.site.getFolders.json +++ b/_assets/simulator/spec/methods/landing.site.getFolders.json @@ -202,5 +202,13 @@ } ], "page": "/api-reference/landing/site/landing-site-get-folders.html", - "executable": false + "executable": false, + "requestExample": { + "siteId": 1817, + "filter": { + "PARENT_ID": 0, + "=DELETED": "N", + "ACTIVE": "Y" + } + } } diff --git a/_assets/simulator/spec/methods/landing.site.getGroupBindings.json b/_assets/simulator/spec/methods/landing.site.getGroupBindings.json index 3bda4c325..efefd4748 100644 --- a/_assets/simulator/spec/methods/landing.site.getGroupBindings.json +++ b/_assets/simulator/spec/methods/landing.site.getGroupBindings.json @@ -65,5 +65,8 @@ } ], "page": "/api-reference/landing/embedding/knowledge-base/landing-site-get-group-bindings.html", - "executable": false + "executable": false, + "requestExample": { + "groupId": 174 + } } diff --git a/_assets/simulator/spec/methods/landing.site.getList.json b/_assets/simulator/spec/methods/landing.site.getList.json index 07ffb5797..fdf887b74 100644 --- a/_assets/simulator/spec/methods/landing.site.getList.json +++ b/_assets/simulator/spec/methods/landing.site.getList.json @@ -126,5 +126,20 @@ } ], "page": "/api-reference/landing/site/landing-site-get-list.html", - "executable": false + "executable": false, + "requestExample": { + "params": { + "select": [ + "ID", + "TITLE", + "TYPE" + ], + "filter": { + "=DELETED": "N" + }, + "order": { + "ID": "DESC" + } + } + } } diff --git a/_assets/simulator/spec/methods/landing.site.getMenuBindings.json b/_assets/simulator/spec/methods/landing.site.getMenuBindings.json index e3035013a..d31c6e27c 100644 --- a/_assets/simulator/spec/methods/landing.site.getMenuBindings.json +++ b/_assets/simulator/spec/methods/landing.site.getMenuBindings.json @@ -58,5 +58,8 @@ } ], "page": "/api-reference/landing/embedding/knowledge-base/landing-site-get-menu-bindings.html", - "executable": false + "executable": false, + "requestExample": { + "menuCode": "crm_switcher:deal" + } } diff --git a/_assets/simulator/spec/methods/landing.site.getPreview.json b/_assets/simulator/spec/methods/landing.site.getPreview.json index ca7530fe8..eb346dc19 100644 --- a/_assets/simulator/spec/methods/landing.site.getPreview.json +++ b/_assets/simulator/spec/methods/landing.site.getPreview.json @@ -57,5 +57,8 @@ } ], "page": "/api-reference/landing/site/landing-site-get-preview.html", - "executable": false + "executable": false, + "requestExample": { + "id": 1817 + } } diff --git a/_assets/simulator/spec/methods/landing.site.getRights.json b/_assets/simulator/spec/methods/landing.site.getRights.json index 102aa008b..f4b7f60ca 100644 --- a/_assets/simulator/spec/methods/landing.site.getRights.json +++ b/_assets/simulator/spec/methods/landing.site.getRights.json @@ -54,5 +54,8 @@ } ], "page": "/api-reference/landing/rights/extended-model/landing-site-get-rights.html", - "executable": false + "executable": false, + "requestExample": { + "id": 645 + } } diff --git a/_assets/simulator/spec/methods/landing.site.getadditionalfields.json b/_assets/simulator/spec/methods/landing.site.getadditionalfields.json index 1573782b6..b816283ce 100644 --- a/_assets/simulator/spec/methods/landing.site.getadditionalfields.json +++ b/_assets/simulator/spec/methods/landing.site.getadditionalfields.json @@ -83,5 +83,8 @@ } ], "page": "/api-reference/landing/site/landing-site-get-additional-fields.html", - "executable": false + "executable": false, + "requestExample": { + "id": 205 + } } diff --git a/_assets/simulator/spec/methods/landing.site.markDelete.json b/_assets/simulator/spec/methods/landing.site.markDelete.json index 7e3ea3df6..aa9e40ef2 100644 --- a/_assets/simulator/spec/methods/landing.site.markDelete.json +++ b/_assets/simulator/spec/methods/landing.site.markDelete.json @@ -64,5 +64,8 @@ } ], "page": "/api-reference/landing/site/landing-site-mark-delete.html", - "executable": false + "executable": false, + "requestExample": { + "id": 143 + } } diff --git a/_assets/simulator/spec/methods/landing.site.markFolderDelete.json b/_assets/simulator/spec/methods/landing.site.markFolderDelete.json index b23a5f5be..04b27cdfa 100644 --- a/_assets/simulator/spec/methods/landing.site.markFolderDelete.json +++ b/_assets/simulator/spec/methods/landing.site.markFolderDelete.json @@ -64,5 +64,8 @@ } ], "page": "/api-reference/landing/site/landing-site-mark-folder-delete.html", - "executable": false + "executable": false, + "requestExample": { + "id": 737 + } } diff --git a/_assets/simulator/spec/methods/landing.site.markFolderUnDelete.json b/_assets/simulator/spec/methods/landing.site.markFolderUnDelete.json index aedd46538..38348578b 100644 --- a/_assets/simulator/spec/methods/landing.site.markFolderUnDelete.json +++ b/_assets/simulator/spec/methods/landing.site.markFolderUnDelete.json @@ -57,5 +57,8 @@ } ], "page": "/api-reference/landing/site/landing-site-mark-folder-undelete.html", - "executable": false + "executable": false, + "requestExample": { + "id": 737 + } } diff --git a/_assets/simulator/spec/methods/landing.site.markUnDelete.json b/_assets/simulator/spec/methods/landing.site.markUnDelete.json index b5ec09653..e3dd076f8 100644 --- a/_assets/simulator/spec/methods/landing.site.markUnDelete.json +++ b/_assets/simulator/spec/methods/landing.site.markUnDelete.json @@ -57,5 +57,8 @@ } ], "page": "/api-reference/landing/site/landing-site-mark-undelete.html", - "executable": false + "executable": false, + "requestExample": { + "id": 157 + } } diff --git a/_assets/simulator/spec/methods/landing.site.publication.json b/_assets/simulator/spec/methods/landing.site.publication.json index d2f9570b0..025bf7534 100644 --- a/_assets/simulator/spec/methods/landing.site.publication.json +++ b/_assets/simulator/spec/methods/landing.site.publication.json @@ -57,5 +57,8 @@ } ], "page": "/api-reference/landing/site/landing-site-publication.html", - "executable": false + "executable": false, + "requestExample": { + "id": 1688 + } } diff --git a/_assets/simulator/spec/methods/landing.site.publicationFolder.json b/_assets/simulator/spec/methods/landing.site.publicationFolder.json index 81a2dae2a..da9270a7a 100644 --- a/_assets/simulator/spec/methods/landing.site.publicationFolder.json +++ b/_assets/simulator/spec/methods/landing.site.publicationFolder.json @@ -64,5 +64,9 @@ } ], "page": "/api-reference/landing/site/landing-site-publication-folder.html", - "executable": false + "executable": false, + "requestExample": { + "folderId": 737, + "mark": true + } } diff --git a/_assets/simulator/spec/methods/landing.site.unPublicFolder.json b/_assets/simulator/spec/methods/landing.site.unPublicFolder.json index 72593bb58..02a6057af 100644 --- a/_assets/simulator/spec/methods/landing.site.unPublicFolder.json +++ b/_assets/simulator/spec/methods/landing.site.unPublicFolder.json @@ -57,5 +57,8 @@ } ], "page": "/api-reference/landing/site/landing-site-unpublic-folder.html", - "executable": false + "executable": false, + "requestExample": { + "folderId": 737 + } } diff --git a/_assets/simulator/spec/methods/landing.site.unbindingFromGroup.json b/_assets/simulator/spec/methods/landing.site.unbindingFromGroup.json index f44d5810e..30e6c5b00 100644 --- a/_assets/simulator/spec/methods/landing.site.unbindingFromGroup.json +++ b/_assets/simulator/spec/methods/landing.site.unbindingFromGroup.json @@ -57,5 +57,9 @@ } ], "page": "/api-reference/landing/embedding/knowledge-base/landing-site-unbinding-from-group.html", - "executable": false + "executable": false, + "requestExample": { + "id": 32, + "groupId": 174 + } } diff --git a/_assets/simulator/spec/methods/landing.site.unbindingFromMenu.json b/_assets/simulator/spec/methods/landing.site.unbindingFromMenu.json index bffab62cb..14c92052c 100644 --- a/_assets/simulator/spec/methods/landing.site.unbindingFromMenu.json +++ b/_assets/simulator/spec/methods/landing.site.unbindingFromMenu.json @@ -57,5 +57,9 @@ } ], "page": "/api-reference/landing/embedding/knowledge-base/landing-site-unbinding-from-menu.html", - "executable": false + "executable": false, + "requestExample": { + "id": 31, + "menuCode": "crm_switcher:deal" + } } diff --git a/_assets/simulator/spec/methods/landing.site.unpublic.json b/_assets/simulator/spec/methods/landing.site.unpublic.json index 2967f38bf..a64e9df54 100644 --- a/_assets/simulator/spec/methods/landing.site.unpublic.json +++ b/_assets/simulator/spec/methods/landing.site.unpublic.json @@ -57,5 +57,8 @@ } ], "page": "/api-reference/landing/site/landing-site-unpublic.html", - "executable": false + "executable": false, + "requestExample": { + "id": 1688 + } } diff --git a/_assets/simulator/spec/methods/landing.site.update.json b/_assets/simulator/spec/methods/landing.site.update.json index 6fbc7edfd..8a890b1b2 100644 --- a/_assets/simulator/spec/methods/landing.site.update.json +++ b/_assets/simulator/spec/methods/landing.site.update.json @@ -138,5 +138,14 @@ } ], "page": "/api-reference/landing/site/landing-site-update.html", - "executable": false + "executable": false, + "requestExample": { + "id": 206, + "fields": { + "TITLE": "Support portal", + "CODE": "support-portal", + "DESCRIPTION": "Обновленное описание сайта", + "LANDING_ID_INDEX": 987 + } + } } diff --git a/_assets/simulator/spec/methods/landing.site.updateFolder.json b/_assets/simulator/spec/methods/landing.site.updateFolder.json index d59a37148..b496dabb0 100644 --- a/_assets/simulator/spec/methods/landing.site.updateFolder.json +++ b/_assets/simulator/spec/methods/landing.site.updateFolder.json @@ -117,5 +117,16 @@ } ], "page": "/api-reference/landing/site/landing-site-update-folder.html", - "executable": false + "executable": false, + "requestExample": { + "siteId": 1817, + "folderId": 736, + "fields": { + "TITLE": "Каталог услуг", + "CODE": "services-catalog", + "PARENT_ID": 0, + "INDEX_ID": 987, + "ACTIVE": "Y" + } + } } diff --git a/_assets/simulator/spec/methods/landing.syspage.deleteForLanding.json b/_assets/simulator/spec/methods/landing.syspage.deleteForLanding.json index a1616ac0a..f795da307 100644 --- a/_assets/simulator/spec/methods/landing.syspage.deleteForLanding.json +++ b/_assets/simulator/spec/methods/landing.syspage.deleteForLanding.json @@ -57,5 +57,8 @@ } ], "page": "/api-reference/landing/page/special-pages/landing-syspage-delete-for-landing.html", - "executable": false + "executable": false, + "requestExample": { + "id": 8593 + } } diff --git a/_assets/simulator/spec/methods/landing.syspage.deleteForSite.json b/_assets/simulator/spec/methods/landing.syspage.deleteForSite.json index f73a43746..50ac9d0e3 100644 --- a/_assets/simulator/spec/methods/landing.syspage.deleteForSite.json +++ b/_assets/simulator/spec/methods/landing.syspage.deleteForSite.json @@ -50,5 +50,8 @@ } ], "page": "/api-reference/landing/page/special-pages/landing-syspage-delete-for-site.html", - "executable": false + "executable": false, + "requestExample": { + "id": 1390 + } } diff --git a/_assets/simulator/spec/methods/landing.syspage.get.json b/_assets/simulator/spec/methods/landing.syspage.get.json index 52c70fc51..30c8d134b 100644 --- a/_assets/simulator/spec/methods/landing.syspage.get.json +++ b/_assets/simulator/spec/methods/landing.syspage.get.json @@ -114,5 +114,9 @@ "LANDING_ID", "TITLE", "TYPE" - ] + ], + "requestExample": { + "id": 1390, + "active": true + } } diff --git a/_assets/simulator/spec/methods/landing.syspage.set.json b/_assets/simulator/spec/methods/landing.syspage.set.json index b355a6c82..84ff74c13 100644 --- a/_assets/simulator/spec/methods/landing.syspage.set.json +++ b/_assets/simulator/spec/methods/landing.syspage.set.json @@ -98,5 +98,10 @@ } ], "page": "/api-reference/landing/page/special-pages/landing-syspage-set.html", - "executable": false + "executable": false, + "requestExample": { + "id": 1390, + "type": "personal", + "lid": 8593 + } } diff --git a/_assets/simulator/spec/methods/landing.template.getLandingRef.json b/_assets/simulator/spec/methods/landing.template.getLandingRef.json index f0606d6e3..2a542e382 100644 --- a/_assets/simulator/spec/methods/landing.template.getLandingRef.json +++ b/_assets/simulator/spec/methods/landing.template.getLandingRef.json @@ -54,5 +54,8 @@ } ], "page": "/api-reference/landing/template/landing-template-get-landing-ref.html", - "executable": false + "executable": false, + "requestExample": { + "id": 557 + } } diff --git a/_assets/simulator/spec/methods/landing.template.getSiteRef.json b/_assets/simulator/spec/methods/landing.template.getSiteRef.json index eeaa04b05..5fb060175 100644 --- a/_assets/simulator/spec/methods/landing.template.getSiteRef.json +++ b/_assets/simulator/spec/methods/landing.template.getSiteRef.json @@ -53,5 +53,8 @@ } ], "page": "/api-reference/landing/template/landing-template-get-site-ref.html", - "executable": false + "executable": false, + "requestExample": { + "id": 157 + } } diff --git a/_assets/simulator/spec/methods/landing.template.getlist.json b/_assets/simulator/spec/methods/landing.template.getlist.json index b72e1e98d..19b02f638 100644 --- a/_assets/simulator/spec/methods/landing.template.getlist.json +++ b/_assets/simulator/spec/methods/landing.template.getlist.json @@ -120,5 +120,26 @@ } ], "page": "/api-reference/landing/template/landing-template-get-list.html", - "executable": false + "executable": false, + "requestExample": { + "params": { + "select": [ + "ID", + "TITLE", + "XML_ID", + "SORT", + "ACTIVE", + "DATE_MODIFY" + ], + "filter": { + "=ACTIVE": "Y" + }, + "order": { + "SORT": "ASC", + "ID": "ASC" + }, + "limit": 2, + "offset": 0 + } + } } diff --git a/_assets/simulator/spec/methods/lists.add.json b/_assets/simulator/spec/methods/lists.add.json index 1392b4f5d..1a9e86b06 100644 --- a/_assets/simulator/spec/methods/lists.add.json +++ b/_assets/simulator/spec/methods/lists.add.json @@ -163,5 +163,30 @@ } ], "page": "/api-reference/lists/lists/lists-add.html", - "executable": false + "executable": false, + "requestExample": { + "IBLOCK_TYPE_ID": "lists", + "IBLOCK_CODE": "my_custom_list", + "FIELDS": { + "NAME": "Мой новый список", + "DESCRIPTION": "Список для отслеживания задач в проекте", + "SORT": 500, + "BIZPROC": "Y" + }, + "MESSAGES": { + "ELEMENTS_NAME": "Задачи", + "ELEMENT_NAME": "Задача", + "ELEMENT_ADD": "Добавить задачу", + "ELEMENT_EDIT": "Изменить задачу", + "ELEMENT_DELETE": "Удалить задачу", + "SECTIONS_NAME": "Разделы", + "SECTION_NAME": "Раздел", + "SECTION_ADD": "Добавить раздел", + "SECTION_EDIT": "Изменить раздел", + "SECTION_DELETE": "Удалить раздел" + }, + "RIGHTS": { + "U1271": "X" + } + } } diff --git a/_assets/simulator/spec/methods/lists.get.json b/_assets/simulator/spec/methods/lists.get.json index d377d8092..d259e4e0e 100644 --- a/_assets/simulator/spec/methods/lists.get.json +++ b/_assets/simulator/spec/methods/lists.get.json @@ -196,5 +196,14 @@ "VERSION", "WORKFLOW", "XML_ID" - ] + ], + "requestExample": { + "IBLOCK_TYPE_ID": "lists_socnet", + "SOCNET_GROUP_ID": 33, + "IBLOCK_ORDER": { + "SORT": "asc", + "NAME": "asc" + }, + "start": 0 + } } diff --git a/_assets/simulator/spec/methods/log.blogcomment.add.json b/_assets/simulator/spec/methods/log.blogcomment.add.json index 24ac51b22..f62438f17 100644 --- a/_assets/simulator/spec/methods/log.blogcomment.add.json +++ b/_assets/simulator/spec/methods/log.blogcomment.add.json @@ -74,5 +74,16 @@ } ], "page": "/api-reference/log/blogcomment/log-blogcomment-add.html", - "executable": false + "executable": false, + "requestExample": { + "POST_ID": 403, + "TEXT": "Комментарий к посту", + "USER_ID": 27, + "FILES": [ + [ + "example.txt", + "SXQncyBhIHRlc3QgZmlsZSBmb3IgQml0cml4IFJlc3QgQVBJLg==" + ] + ] + } } diff --git a/_assets/simulator/spec/methods/log.blogcomment.delete.json b/_assets/simulator/spec/methods/log.blogcomment.delete.json index fa492daa1..244de8023 100644 --- a/_assets/simulator/spec/methods/log.blogcomment.delete.json +++ b/_assets/simulator/spec/methods/log.blogcomment.delete.json @@ -56,5 +56,9 @@ } ], "page": "/api-reference/log/blogcomment/log-blogcomment-delete.html", - "executable": false + "executable": false, + "requestExample": { + "COMMENT_ID": 197, + "USER_ID": 503 + } } diff --git a/_assets/simulator/spec/methods/log.blogcomment.user.get.json b/_assets/simulator/spec/methods/log.blogcomment.user.get.json index 1f1104f31..e0d563290 100644 --- a/_assets/simulator/spec/methods/log.blogcomment.user.get.json +++ b/_assets/simulator/spec/methods/log.blogcomment.user.get.json @@ -109,5 +109,10 @@ "id", "log_id", "text" - ] + ], + "requestExample": { + "USER_ID": 28, + "FIRST_ID": 215, + "LAST_ID": 216 + } } diff --git a/_assets/simulator/spec/methods/log.blogpost.delete.json b/_assets/simulator/spec/methods/log.blogpost.delete.json index eef318dd4..332d455ce 100644 --- a/_assets/simulator/spec/methods/log.blogpost.delete.json +++ b/_assets/simulator/spec/methods/log.blogpost.delete.json @@ -50,5 +50,8 @@ } ], "page": "/api-reference/log/log-blogpost-delete.html", - "executable": false + "executable": false, + "requestExample": { + "POST_ID": 211 + } } diff --git a/_assets/simulator/spec/methods/log.blogpost.get.json b/_assets/simulator/spec/methods/log.blogpost.get.json index 6f7ea49ae..48c626f65 100644 --- a/_assets/simulator/spec/methods/log.blogpost.get.json +++ b/_assets/simulator/spec/methods/log.blogpost.get.json @@ -11,7 +11,7 @@ "type": "integer", "base": "integer", "required": false, - "description": "Фильтрация по идентификатору сообщения. Получить идентификатор можно с помощью метода log.blogpost.get" + "description": "Фильтрация по идентификатору сообщения. Идентификатор указан в поле ID элемента результата метода. Если параметр передан, фильтрация по LOG_RIGHTS игнорируется" }, { "name": "LOG_RIGHTS", @@ -29,35 +29,35 @@ "type": "string", "base": "string", "required": false, - "description": "Нижняя граница периода публикации сообщения в формате ISO 8601. Если указаны LOG_DATE_FROM и LOG_DATE_TO, значение LOG_DATE_FROM не должно быть позже LOG_DATE_TO" + "description": "Нижняя граница периода публикации сообщения в формате ISO 8601. Если указаны LOG_DATE_FROM и LOG_DATE_TO, значение LOG_DATE_FROM не должно быть позже LOG_DATE_TO. Пустая строка не ограничивает выборку" }, { "name": "LOG_DATE_TO", "type": "string", "base": "string", "required": false, - "description": "Верхняя граница периода публикации сообщения в формате ISO 8601. Если значение не указано, верхняя граница периода не применяется" + "description": "Верхняя граница периода публикации сообщения в формате ISO 8601. Если значение не указано или передана пустая строка, верхняя граница периода не применяется" }, { "name": "FIRST_ID", "type": "integer", "base": "integer", "required": false, - "description": "Идентификатор записи Ленты новостей для курсорной навигации вперед. Метод вернет сообщения с идентификаторами больше указанного значения. Если переданы FIRST_ID и LAST_ID, применяется FIRST_ID" + "description": "Идентификатор записи Ленты новостей для курсорной навигации вперед. Метод вернет сообщения с идентификаторами больше указанного значения. Если переданы FIRST_ID и LAST_ID, применяется FIRST_ID. Значение 0 или пустая строка начинает выборку с края списка" }, { "name": "LAST_ID", "type": "integer", "base": "integer", "required": false, - "description": "Идентификатор записи Ленты новостей для курсорной навигации назад. Метод вернет сообщения с идентификаторами меньше указанного значения" + "description": "Идентификатор записи Ленты новостей для курсорной навигации назад. Метод вернет сообщения с идентификаторами меньше указанного значения. Значение 0 или пустая строка начинает выборку с края списка" }, { "name": "LIMIT", "type": "integer", "base": "integer", "required": false, - "description": "Размер страницы в курсорном режиме. Неположительное или нечисловое значение заменяется значением по умолчанию. Максимальное значение — 200" + "description": "Размер страницы в курсорном режиме. По умолчанию — 50. Неположительное или нечисловое значение заменяется значением по умолчанию. Максимальное значение — 200" }, { "name": "start", @@ -73,13 +73,396 @@ "source": { "file": "api-reference/log/log-blogpost-get.md" }, + "resultExample": { + "result": [ + { + "ID": "217", + "BLOG_ID": "299", + "PUBLISH_STATUS": "P", + "TITLE": "Новый регламент", + "AUTHOR_ID": "1269", + "ENABLE_COMMENTS": "Y", + "NUM_COMMENTS": "0", + "CODE": null, + "MICRO": "N", + "DETAIL_TEXT": "С 1 ноября обновляется процесс согласования.", + "DATE_PUBLISH": "2026-03-17T15:29:15+03:00", + "CATEGORY_ID": "9,11,13", + "HAS_SOCNET_ALL": "N", + "HAS_TAGS": "Y", + "HAS_IMAGES": "N", + "HAS_PROPS": "Y", + "HAS_COMMENT_IMAGES": null, + "UF_BLOG_POST_DOC": { + "ID": "1", + "ENTITY_ID": "BLOG_POST", + "FIELD_NAME": "UF_BLOG_POST_DOC", + "USER_TYPE_ID": "file", + "XML_ID": "UF_BLOG_POST_DOC", + "SORT": "100", + "MULTIPLE": "Y", + "MANDATORY": "N", + "SHOW_FILTER": "N", + "SHOW_IN_LIST": "N", + "EDIT_IN_LIST": "Y", + "IS_SEARCHABLE": "Y", + "SETTINGS": { + "SIZE": 20, + "LIST_WIDTH": 0, + "LIST_HEIGHT": 0, + "MAX_SHOW_SIZE": 0, + "MAX_ALLOWED_SIZE": 0, + "EXTENSIONS": [], + "TARGET_BLANK": "Y", + "DEFAULT_VIEW": null + }, + "EDIT_FORM_LABEL": null, + "LIST_COLUMN_LABEL": null, + "LIST_FILTER_LABEL": null, + "ERROR_MESSAGE": null, + "HELP_MESSAGE": null, + "USER_TYPE": { + "USER_TYPE_ID": "file", + "CLASS_NAME": "Bitrix\\Main\\UserField\\Types\\FileType", + "EDIT_CALLBACK": [ + "Bitrix\\Main\\UserField\\Types\\FileType", + "renderEdit" + ], + "VIEW_CALLBACK": [ + "Bitrix\\Main\\UserField\\Types\\FileType", + "renderView" + ], + "USE_FIELD_COMPONENT": true, + "DESCRIPTION": "Файл", + "BASE_TYPE": "file" + }, + "VALUE": false, + "ENTITY_VALUE_ID": 217, + "VALUE_EXISTS": true, + "VALUE_RAW": null, + "CUSTOM_DATA": [] + }, + "UF_BLOG_POST_URL_PRV": { + "ID": "5", + "ENTITY_ID": "BLOG_POST", + "FIELD_NAME": "UF_BLOG_POST_URL_PRV", + "USER_TYPE_ID": "url_preview", + "XML_ID": "UF_BLOG_POST_URL_PRV", + "SORT": "100", + "MULTIPLE": "N", + "MANDATORY": "N", + "SHOW_FILTER": "N", + "SHOW_IN_LIST": "N", + "EDIT_IN_LIST": "Y", + "IS_SEARCHABLE": "Y", + "SETTINGS": [], + "EDIT_FORM_LABEL": null, + "LIST_COLUMN_LABEL": null, + "LIST_FILTER_LABEL": null, + "ERROR_MESSAGE": null, + "HELP_MESSAGE": null, + "USER_TYPE": { + "USER_TYPE_ID": "url_preview", + "CLASS_NAME": "Bitrix\\Main\\UrlPreview\\UrlPreviewUserType", + "DESCRIPTION": "Содержимое ссылки", + "BASE_TYPE": "int" + }, + "VALUE": null, + "ENTITY_VALUE_ID": 217, + "VALUE_EXISTS": true, + "VALUE_RAW": null, + "CUSTOM_DATA": [] + }, + "UF_GRATITUDE": { + "ID": "9", + "ENTITY_ID": "BLOG_POST", + "FIELD_NAME": "UF_GRATITUDE", + "USER_TYPE_ID": "integer", + "XML_ID": "UF_GRATITUDE", + "SORT": "100", + "MULTIPLE": "N", + "MANDATORY": "N", + "SHOW_FILTER": "N", + "SHOW_IN_LIST": "N", + "EDIT_IN_LIST": "Y", + "IS_SEARCHABLE": "N", + "SETTINGS": { + "SIZE": 20, + "MIN_VALUE": 0, + "MAX_VALUE": 0, + "DEFAULT_VALUE": null + }, + "EDIT_FORM_LABEL": null, + "LIST_COLUMN_LABEL": null, + "LIST_FILTER_LABEL": null, + "ERROR_MESSAGE": null, + "HELP_MESSAGE": null, + "USER_TYPE": { + "USER_TYPE_ID": "integer", + "CLASS_NAME": "Bitrix\\Main\\UserField\\Types\\IntegerType", + "EDIT_CALLBACK": [ + "Bitrix\\Main\\UserField\\Types\\IntegerType", + "renderEdit" + ], + "VIEW_CALLBACK": [ + "Bitrix\\Main\\UserField\\Types\\IntegerType", + "renderView" + ], + "USE_FIELD_COMPONENT": true, + "DESCRIPTION": "Целое число", + "BASE_TYPE": "int" + }, + "VALUE": null, + "ENTITY_VALUE_ID": 217, + "VALUE_EXISTS": true, + "VALUE_RAW": null, + "CUSTOM_DATA": [] + }, + "UF_BLOG_POST_FILE": { + "ID": "19", + "ENTITY_ID": "BLOG_POST", + "FIELD_NAME": "UF_BLOG_POST_FILE", + "USER_TYPE_ID": "disk_file", + "XML_ID": "UF_BLOG_POST_FILE", + "SORT": "100", + "MULTIPLE": "Y", + "MANDATORY": "N", + "SHOW_FILTER": "N", + "SHOW_IN_LIST": "N", + "EDIT_IN_LIST": "Y", + "IS_SEARCHABLE": "Y", + "SETTINGS": { + "IBLOCK_ID": null, + "SECTION_ID": null, + "UF_TO_SAVE_ALLOW_EDIT": false + }, + "EDIT_FORM_LABEL": null, + "LIST_COLUMN_LABEL": null, + "LIST_FILTER_LABEL": null, + "ERROR_MESSAGE": null, + "HELP_MESSAGE": null, + "USER_TYPE": { + "USER_TYPE_ID": "disk_file", + "CLASS_NAME": "Bitrix\\Disk\\Uf\\FileUserType", + "DESCRIPTION": "Файл (Диск)", + "BASE_TYPE": "int", + "TAG": [ + "DISK FILE ID", + "DOCUMENT ID" + ] + }, + "VALUE": [ + 505 + ], + "ENTITY_VALUE_ID": 217, + "VALUE_EXISTS": true, + "VALUE_RAW": "a:1:{i:0;i:505;}", + "CUSTOM_DATA": { + "PHOTO_TEMPLATE": "gallery" + } + }, + "UF_BLOG_POST_IMPRTNT": { + "ID": "83", + "ENTITY_ID": "BLOG_POST", + "FIELD_NAME": "UF_BLOG_POST_IMPRTNT", + "USER_TYPE_ID": "integer", + "XML_ID": "UF_BLOG_POST_IMPRTNT", + "SORT": "100", + "MULTIPLE": "N", + "MANDATORY": "N", + "SHOW_FILTER": "N", + "SHOW_IN_LIST": "Y", + "EDIT_IN_LIST": "Y", + "IS_SEARCHABLE": "N", + "SETTINGS": { + "SIZE": 20, + "MIN_VALUE": 0, + "MAX_VALUE": 0, + "DEFAULT_VALUE": null + }, + "EDIT_FORM_LABEL": "Важное сообщение", + "LIST_COLUMN_LABEL": "Важное", + "LIST_FILTER_LABEL": "Важное", + "ERROR_MESSAGE": null, + "HELP_MESSAGE": null, + "USER_TYPE": { + "USER_TYPE_ID": "integer", + "CLASS_NAME": "Bitrix\\Main\\UserField\\Types\\IntegerType", + "EDIT_CALLBACK": [ + "Bitrix\\Main\\UserField\\Types\\IntegerType", + "renderEdit" + ], + "VIEW_CALLBACK": [ + "Bitrix\\Main\\UserField\\Types\\IntegerType", + "renderView" + ], + "USE_FIELD_COMPONENT": true, + "DESCRIPTION": "Целое число", + "BASE_TYPE": "int" + }, + "VALUE": null, + "ENTITY_VALUE_ID": 217, + "VALUE_EXISTS": true, + "VALUE_RAW": null, + "CUSTOM_DATA": [] + }, + "UF_IMPRTANT_DATE_END": { + "ID": "85", + "ENTITY_ID": "BLOG_POST", + "FIELD_NAME": "UF_IMPRTANT_DATE_END", + "USER_TYPE_ID": "datetime", + "XML_ID": "UF_IMPRTANT_DATE_END", + "SORT": "100", + "MULTIPLE": "N", + "MANDATORY": "N", + "SHOW_FILTER": "N", + "SHOW_IN_LIST": "N", + "EDIT_IN_LIST": "Y", + "IS_SEARCHABLE": "N", + "SETTINGS": { + "DEFAULT_VALUE": { + "TYPE": "NONE", + "VALUE": "" + }, + "USE_SECOND": "Y", + "USE_TIMEZONE": "N" + }, + "EDIT_FORM_LABEL": "Срок действия", + "LIST_COLUMN_LABEL": "Срок", + "LIST_FILTER_LABEL": null, + "ERROR_MESSAGE": null, + "HELP_MESSAGE": null, + "USER_TYPE": { + "USER_TYPE_ID": "datetime", + "CLASS_NAME": "Bitrix\\Main\\UserField\\Types\\DateTimeType", + "EDIT_CALLBACK": [ + "Bitrix\\Main\\UserField\\Types\\DateTimeType", + "renderEdit" + ], + "VIEW_CALLBACK": [ + "Bitrix\\Main\\UserField\\Types\\DateTimeType", + "renderView" + ], + "USE_FIELD_COMPONENT": true, + "DESCRIPTION": "Дата со временем", + "BASE_TYPE": "datetime" + }, + "VALUE": "", + "ENTITY_VALUE_ID": 217, + "VALUE_EXISTS": true, + "VALUE_RAW": null, + "CUSTOM_DATA": [] + }, + "UF_BLOG_POST_VOTE": { + "ID": "131", + "ENTITY_ID": "BLOG_POST", + "FIELD_NAME": "UF_BLOG_POST_VOTE", + "USER_TYPE_ID": "vote", + "XML_ID": "UF_BLOG_POST_VOTE", + "SORT": "100", + "MULTIPLE": "N", + "MANDATORY": "N", + "SHOW_FILTER": "N", + "SHOW_IN_LIST": "Y", + "EDIT_IN_LIST": "Y", + "IS_SEARCHABLE": "N", + "SETTINGS": { + "CHANNEL_ID": 1, + "UNIQUE": 8, + "UNIQUE_IP_DELAY": { + "DELAY": "10", + "DELAY_TYPE": "D" + }, + "NOTIFY": "I" + }, + "EDIT_FORM_LABEL": null, + "LIST_COLUMN_LABEL": null, + "LIST_FILTER_LABEL": null, + "ERROR_MESSAGE": null, + "HELP_MESSAGE": null, + "USER_TYPE": { + "USER_TYPE_ID": "vote", + "CLASS_NAME": "Bitrix\\Vote\\Uf\\VoteUserType", + "DESCRIPTION": "Опрос", + "BASE_TYPE": "int" + }, + "VALUE": null, + "ENTITY_VALUE_ID": 217, + "VALUE_EXISTS": true, + "VALUE_RAW": null, + "CUSTOM_DATA": [] + }, + "UF_MAIL_MESSAGE": { + "ID": "439", + "ENTITY_ID": "BLOG_POST", + "FIELD_NAME": "UF_MAIL_MESSAGE", + "USER_TYPE_ID": "mail_message", + "XML_ID": "", + "SORT": "100", + "MULTIPLE": "N", + "MANDATORY": "N", + "SHOW_FILTER": "N", + "SHOW_IN_LIST": "N", + "EDIT_IN_LIST": "Y", + "IS_SEARCHABLE": "N", + "SETTINGS": null, + "EDIT_FORM_LABEL": null, + "LIST_COLUMN_LABEL": null, + "LIST_FILTER_LABEL": null, + "ERROR_MESSAGE": null, + "HELP_MESSAGE": null, + "USER_TYPE": { + "USER_TYPE_ID": "mail_message", + "CLASS_NAME": "Bitrix\\Mail\\MessageUserType", + "DESCRIPTION": "Письмо (email)", + "BASE_TYPE": "int", + "VIEW_CALLBACK": [ + "Bitrix\\Mail\\MessageUserType", + "getPublicView" + ], + "EDIT_CALLBACK": [ + "Bitrix\\Mail\\MessageUserType", + "getPublicEdit" + ], + "onBeforeSave": [ + "Bitrix\\Mail\\MessageUserType", + "onBeforeSave" + ], + "onDelete": [ + "Bitrix\\Mail\\MessageUserType", + "onDelete" + ] + }, + "VALUE": null, + "ENTITY_VALUE_ID": 217, + "VALUE_EXISTS": true, + "VALUE_RAW": null, + "CUSTOM_DATA": [] + }, + "FILES": [ + 505 + ] + } + ], + "total": 1, + "time": { + "start": 1773754540, + "finish": 1773754540.902101, + "duration": 0.9021010398864746, + "processing": 0, + "date_start": "2026-03-17T16:35:40+03:00", + "date_finish": "2026-03-17T16:35:40+03:00", + "operating_reset_at": 1773755140, + "operating": 0 + } + }, "returns": [ { "name": "result", - "type": "array", + "type": "object[]", "base": "array", "required": false, - "description": "Параметры сообщения или список сообщений Ленты новостей. Пустой массив означает, что нет записей, удовлетворяющих фильтру" + "description": "Список сообщений Ленты новостей. Поля каждого элемента перечислены в следующих строках таблицы. Пустой массив означает, что нет записей, удовлетворяющих фильтру" }, { "name": "ID", @@ -293,5 +676,36 @@ } ], "page": "/api-reference/log/log-blogpost-get.html", - "executable": false + "executable": false, + "entityFields": [ + "AUTHOR_ID", + "BLOG_ID", + "CATEGORY_ID", + "CODE", + "DATE_PUBLISH", + "DETAIL_TEXT", + "ENABLE_COMMENTS", + "FILES", + "HAS_COMMENT_IMAGES", + "HAS_IMAGES", + "HAS_PROPS", + "HAS_SOCNET_ALL", + "HAS_TAGS", + "ID", + "MICRO", + "NUM_COMMENTS", + "PUBLISH_STATUS", + "TITLE", + "UF_BLOG_POST_DOC", + "UF_BLOG_POST_FILE", + "UF_BLOG_POST_IMPRTNT", + "UF_BLOG_POST_URL_PRV", + "UF_BLOG_POST_VOTE", + "UF_GRATITUDE", + "UF_IMPRTANT_DATE_END", + "UF_MAIL_MESSAGE" + ], + "requestExample": { + "POST_ID": 217 + } } diff --git a/_assets/simulator/spec/methods/log.blogpost.getusers.important.json b/_assets/simulator/spec/methods/log.blogpost.getusers.important.json index 26afe0118..34c54a00b 100644 --- a/_assets/simulator/spec/methods/log.blogpost.getusers.important.json +++ b/_assets/simulator/spec/methods/log.blogpost.getusers.important.json @@ -53,5 +53,8 @@ } ], "page": "/api-reference/log/log-blogpost-getusers-important.html", - "executable": false + "executable": false, + "requestExample": { + "POST_ID": 221 + } } diff --git a/_assets/simulator/spec/methods/log.blogpost.share.json b/_assets/simulator/spec/methods/log.blogpost.share.json index 8ea122ee3..3d11ca6ee 100644 --- a/_assets/simulator/spec/methods/log.blogpost.share.json +++ b/_assets/simulator/spec/methods/log.blogpost.share.json @@ -68,5 +68,12 @@ } ], "page": "/api-reference/log/log-blogpost-share.html", - "executable": false + "executable": false, + "requestExample": { + "POST_ID": 217, + "DEST": [ + "SG69", + "DR4" + ] + } } diff --git a/_assets/simulator/spec/methods/mail.mailbox.field.get.json b/_assets/simulator/spec/methods/mail.mailbox.field.get.json index 1bd510c19..4ee4e4eae 100644 --- a/_assets/simulator/spec/methods/mail.mailbox.field.get.json +++ b/_assets/simulator/spec/methods/mail.mailbox.field.get.json @@ -79,5 +79,13 @@ "name", "title", "type" - ] + ], + "requestExample": { + "name": "email", + "select": [ + "name", + "type", + "title" + ] + } } diff --git a/_assets/simulator/spec/methods/mail.mailbox.field.list.json b/_assets/simulator/spec/methods/mail.mailbox.field.list.json index 34d500d34..2e549b5f6 100644 --- a/_assets/simulator/spec/methods/mail.mailbox.field.list.json +++ b/_assets/simulator/spec/methods/mail.mailbox.field.list.json @@ -99,5 +99,14 @@ "sortable", "title", "type" - ] + ], + "requestExample": { + "select": [ + "name", + "type", + "title", + "filterable", + "sortable" + ] + } } diff --git a/_assets/simulator/spec/methods/mail.mailbox.get.json b/_assets/simulator/spec/methods/mail.mailbox.get.json index 36b2ac358..d4f724cbb 100644 --- a/_assets/simulator/spec/methods/mail.mailbox.get.json +++ b/_assets/simulator/spec/methods/mail.mailbox.get.json @@ -81,5 +81,14 @@ "id", "name", "senderName" - ] + ], + "requestExample": { + "id": 1, + "select": [ + "id", + "name", + "email", + "senderName" + ] + } } diff --git a/_assets/simulator/spec/methods/mail.mailbox.list.json b/_assets/simulator/spec/methods/mail.mailbox.list.json index f0a18e08a..f09402ecd 100644 --- a/_assets/simulator/spec/methods/mail.mailbox.list.json +++ b/_assets/simulator/spec/methods/mail.mailbox.list.json @@ -125,5 +125,14 @@ "id", "name", "senderName" - ] + ], + "requestExample": { + "name": "work", + "email": "example.com", + "pagination": { + "page": 1, + "limit": 20, + "offset": 0 + } + } } diff --git a/_assets/simulator/spec/methods/mail.mailbox.senders.json b/_assets/simulator/spec/methods/mail.mailbox.senders.json index 6c1f6c167..d433878a7 100644 --- a/_assets/simulator/spec/methods/mail.mailbox.senders.json +++ b/_assets/simulator/spec/methods/mail.mailbox.senders.json @@ -102,5 +102,12 @@ } ], "page": "/api-reference/mail/mailbox/mail-mailbox-senders.html", - "executable": false + "executable": false, + "requestExample": { + "pagination": { + "page": 1, + "limit": 20, + "offset": 0 + } + } } diff --git a/_assets/simulator/spec/methods/mail.message.createcalendarevent.json b/_assets/simulator/spec/methods/mail.message.createcalendarevent.json index f22e102eb..00228055d 100644 --- a/_assets/simulator/spec/methods/mail.message.createcalendarevent.json +++ b/_assets/simulator/spec/methods/mail.message.createcalendarevent.json @@ -103,5 +103,11 @@ } ], "page": "/api-reference/mail/message/mail-message-createcalendarevent.html", - "executable": false + "executable": false, + "requestExample": { + "messageId": 15, + "dateFrom": "2026-04-15 10:00:00", + "dateTo": "2026-04-15 11:00:00", + "name": "Встреча по договору" + } } diff --git a/_assets/simulator/spec/methods/mail.message.createchat.json b/_assets/simulator/spec/methods/mail.message.createchat.json index cba0eda85..a2a22220c 100644 --- a/_assets/simulator/spec/methods/mail.message.createchat.json +++ b/_assets/simulator/spec/methods/mail.message.createchat.json @@ -83,5 +83,8 @@ } ], "page": "/api-reference/mail/message/mail-message-createchat.html", - "executable": false + "executable": false, + "requestExample": { + "messageId": 15 + } } diff --git a/_assets/simulator/spec/methods/mail.message.createcrmactivity.json b/_assets/simulator/spec/methods/mail.message.createcrmactivity.json index db00f0c63..99cca9eef 100644 --- a/_assets/simulator/spec/methods/mail.message.createcrmactivity.json +++ b/_assets/simulator/spec/methods/mail.message.createcrmactivity.json @@ -59,5 +59,8 @@ } ], "page": "/api-reference/mail/message/mail-message-createcrmactivity.html", - "executable": false + "executable": false, + "requestExample": { + "messageId": 15 + } } diff --git a/_assets/simulator/spec/methods/mail.message.createfeedpost.json b/_assets/simulator/spec/methods/mail.message.createfeedpost.json index 349e1da18..8f7f2fb18 100644 --- a/_assets/simulator/spec/methods/mail.message.createfeedpost.json +++ b/_assets/simulator/spec/methods/mail.message.createfeedpost.json @@ -82,5 +82,9 @@ } ], "page": "/api-reference/mail/message/mail-message-createfeedpost.html", - "executable": false + "executable": false, + "requestExample": { + "messageId": 15, + "title": "Обсуждение договора" + } } diff --git a/_assets/simulator/spec/methods/mail.message.createtask.json b/_assets/simulator/spec/methods/mail.message.createtask.json index ac0232e29..4b206c70c 100644 --- a/_assets/simulator/spec/methods/mail.message.createtask.json +++ b/_assets/simulator/spec/methods/mail.message.createtask.json @@ -96,5 +96,10 @@ } ], "page": "/api-reference/mail/message/mail-message-createtask.html", - "executable": false + "executable": false, + "requestExample": { + "messageId": 15, + "title": "Подготовить договор", + "responsibleId": 7 + } } diff --git a/_assets/simulator/spec/methods/mail.message.field.get.json b/_assets/simulator/spec/methods/mail.message.field.get.json index 04122b560..0c1b43b05 100644 --- a/_assets/simulator/spec/methods/mail.message.field.get.json +++ b/_assets/simulator/spec/methods/mail.message.field.get.json @@ -79,5 +79,13 @@ "name", "title", "type" - ] + ], + "requestExample": { + "name": "subject", + "select": [ + "name", + "type", + "title" + ] + } } diff --git a/_assets/simulator/spec/methods/mail.message.field.list.json b/_assets/simulator/spec/methods/mail.message.field.list.json index ac603051b..fd346df1e 100644 --- a/_assets/simulator/spec/methods/mail.message.field.list.json +++ b/_assets/simulator/spec/methods/mail.message.field.list.json @@ -162,5 +162,14 @@ "sortable", "title", "type" - ] + ], + "requestExample": { + "select": [ + "name", + "type", + "title", + "filterable", + "sortable" + ] + } } diff --git a/_assets/simulator/spec/methods/mail.message.forward.json b/_assets/simulator/spec/methods/mail.message.forward.json index 3a39bb020..9e2ed44a1 100644 --- a/_assets/simulator/spec/methods/mail.message.forward.json +++ b/_assets/simulator/spec/methods/mail.message.forward.json @@ -123,5 +123,14 @@ } ], "page": "/api-reference/mail/message/mail-message-forward.html", - "executable": false + "executable": false, + "requestExample": { + "forwardMessageId": 15, + "from": "user@example.com", + "to": [ + "manager@example.com" + ], + "subject": "Fwd: Договор", + "body": "Пересылаю письмо." + } } diff --git a/_assets/simulator/spec/methods/mail.message.get.json b/_assets/simulator/spec/methods/mail.message.get.json index 9564c46c6..07a76880a 100644 --- a/_assets/simulator/spec/methods/mail.message.get.json +++ b/_assets/simulator/spec/methods/mail.message.get.json @@ -99,5 +99,23 @@ "subject", "to", "url" - ] + ], + "requestExample": { + "id": 15, + "select": [ + "id", + "mailboxId", + "mailboxEmail", + "subject", + "from", + "to", + "cc", + "date", + "isSeen", + "hasAttachments", + "url", + "bindings", + "body" + ] + } } diff --git a/_assets/simulator/spec/methods/mail.message.list.json b/_assets/simulator/spec/methods/mail.message.list.json index e1b1a58d4..568152145 100644 --- a/_assets/simulator/spec/methods/mail.message.list.json +++ b/_assets/simulator/spec/methods/mail.message.list.json @@ -261,5 +261,15 @@ "subject", "to", "url" - ] + ], + "requestExample": { + "mailboxId": 1, + "searchQuery": "договор", + "hasAttachments": true, + "pagination": { + "page": 1, + "limit": 20, + "offset": 0 + } + } } diff --git a/_assets/simulator/spec/methods/mail.message.movetofolder.json b/_assets/simulator/spec/methods/mail.message.movetofolder.json index bf39de643..d1af6b115 100644 --- a/_assets/simulator/spec/methods/mail.message.movetofolder.json +++ b/_assets/simulator/spec/methods/mail.message.movetofolder.json @@ -93,5 +93,12 @@ } ], "page": "/api-reference/mail/message/mail-message-movetofolder.html", - "executable": false + "executable": false, + "requestExample": { + "messageIds": [ + 15, + 16 + ], + "action": "spam" + } } diff --git a/_assets/simulator/spec/methods/mail.message.removecrmactivity.json b/_assets/simulator/spec/methods/mail.message.removecrmactivity.json index 09ce04a24..57ab9e95c 100644 --- a/_assets/simulator/spec/methods/mail.message.removecrmactivity.json +++ b/_assets/simulator/spec/methods/mail.message.removecrmactivity.json @@ -50,5 +50,8 @@ } ], "page": "/api-reference/mail/message/mail-message-removecrmactivity.html", - "executable": false + "executable": false, + "requestExample": { + "messageId": 15 + } } diff --git a/_assets/simulator/spec/methods/mail.message.reply.json b/_assets/simulator/spec/methods/mail.message.reply.json index e69f097af..26a536de8 100644 --- a/_assets/simulator/spec/methods/mail.message.reply.json +++ b/_assets/simulator/spec/methods/mail.message.reply.json @@ -123,5 +123,14 @@ } ], "page": "/api-reference/mail/message/mail-message-reply.html", - "executable": false + "executable": false, + "requestExample": { + "replyToMessageId": 15, + "from": "user@example.com", + "to": [ + "client@example.com" + ], + "subject": "Re: Договор", + "body": "Спасибо, получили." + } } diff --git a/_assets/simulator/spec/methods/mail.message.send.json b/_assets/simulator/spec/methods/mail.message.send.json index 672cb09a5..1986b18b2 100644 --- a/_assets/simulator/spec/methods/mail.message.send.json +++ b/_assets/simulator/spec/methods/mail.message.send.json @@ -116,5 +116,13 @@ } ], "page": "/api-reference/mail/message/mail-message-send.html", - "executable": false + "executable": false, + "requestExample": { + "from": "user@example.com", + "to": [ + "client@example.com" + ], + "subject": "Коммерческое предложение", + "body": "Здравствуйте. Отправляю материалы." + } } diff --git a/_assets/simulator/spec/methods/mail.message.thread.json b/_assets/simulator/spec/methods/mail.message.thread.json index b368cf7de..4c9c9b012 100644 --- a/_assets/simulator/spec/methods/mail.message.thread.json +++ b/_assets/simulator/spec/methods/mail.message.thread.json @@ -132,5 +132,9 @@ } ], "page": "/api-reference/mail/message/mail-message-thread.html", - "executable": false + "executable": false, + "requestExample": { + "id": 15, + "limit": 20 + } } diff --git a/_assets/simulator/spec/methods/mail.recipient.field.get.json b/_assets/simulator/spec/methods/mail.recipient.field.get.json index 4029f2911..c50a9f6cc 100644 --- a/_assets/simulator/spec/methods/mail.recipient.field.get.json +++ b/_assets/simulator/spec/methods/mail.recipient.field.get.json @@ -79,5 +79,13 @@ "name", "title", "type" - ] + ], + "requestExample": { + "name": "email", + "select": [ + "name", + "type", + "title" + ] + } } diff --git a/_assets/simulator/spec/methods/mail.recipient.field.list.json b/_assets/simulator/spec/methods/mail.recipient.field.list.json index e2c81674f..cbc0474b1 100644 --- a/_assets/simulator/spec/methods/mail.recipient.field.list.json +++ b/_assets/simulator/spec/methods/mail.recipient.field.list.json @@ -92,5 +92,14 @@ "sortable", "title", "type" - ] + ], + "requestExample": { + "select": [ + "name", + "type", + "title", + "filterable", + "sortable" + ] + } } diff --git a/_assets/simulator/spec/methods/mail.recipient.listcontacts.json b/_assets/simulator/spec/methods/mail.recipient.listcontacts.json index 7b416cdb5..e85d5426c 100644 --- a/_assets/simulator/spec/methods/mail.recipient.listcontacts.json +++ b/_assets/simulator/spec/methods/mail.recipient.listcontacts.json @@ -104,5 +104,13 @@ } ], "page": "/api-reference/mail/recipient/mail-recipient-listcontacts.html", - "executable": false + "executable": false, + "requestExample": { + "query": "client", + "pagination": { + "page": 1, + "limit": 20, + "offset": 0 + } + } } diff --git a/_assets/simulator/spec/methods/mail.recipient.listemployees.json b/_assets/simulator/spec/methods/mail.recipient.listemployees.json index a2b50a776..7b6868009 100644 --- a/_assets/simulator/spec/methods/mail.recipient.listemployees.json +++ b/_assets/simulator/spec/methods/mail.recipient.listemployees.json @@ -104,5 +104,13 @@ } ], "page": "/api-reference/mail/recipient/mail-recipient-listemployees.html", - "executable": false + "executable": false, + "requestExample": { + "query": "Иван", + "pagination": { + "page": 1, + "limit": 20, + "offset": 0 + } + } } diff --git a/_assets/simulator/spec/methods/mailservice.add.json b/_assets/simulator/spec/methods/mailservice.add.json index 3b525f268..d307c25b8 100644 --- a/_assets/simulator/spec/methods/mailservice.add.json +++ b/_assets/simulator/spec/methods/mailservice.add.json @@ -119,5 +119,14 @@ } ], "page": "/api-reference/mailservice/mailservice-add.html", - "executable": false + "executable": false, + "requestExample": { + "NAME": "Мой почтовый сервис", + "ACTIVE": "Y", + "SERVER": "imap.my-mail.ru", + "PORT": 993, + "ENCRYPTION": "Y", + "LINK": "https://mail.my-mail.ru/", + "SORT": 500 + } } diff --git a/_assets/simulator/spec/methods/mailservice.delete.json b/_assets/simulator/spec/methods/mailservice.delete.json index 8432fc33a..5e00beb78 100644 --- a/_assets/simulator/spec/methods/mailservice.delete.json +++ b/_assets/simulator/spec/methods/mailservice.delete.json @@ -50,5 +50,8 @@ } ], "page": "/api-reference/mailservice/mailservice-delete.html", - "executable": false + "executable": false, + "requestExample": { + "ID": 31 + } } diff --git a/_assets/simulator/spec/methods/mailservice.get.json b/_assets/simulator/spec/methods/mailservice.get.json index 7cece6787..6d24896e4 100644 --- a/_assets/simulator/spec/methods/mailservice.get.json +++ b/_assets/simulator/spec/methods/mailservice.get.json @@ -85,5 +85,8 @@ "SMTP_SERVER", "SORT", "UPLOAD_OUTGOING" - ] + ], + "requestExample": { + "ID": 31 + } } diff --git a/_assets/simulator/spec/methods/mailservice.update.json b/_assets/simulator/spec/methods/mailservice.update.json index acd4fc50e..311121d43 100644 --- a/_assets/simulator/spec/methods/mailservice.update.json +++ b/_assets/simulator/spec/methods/mailservice.update.json @@ -126,5 +126,15 @@ } ], "page": "/api-reference/mailservice/mailservice-update.html", - "executable": false + "executable": false, + "requestExample": { + "ID": 31, + "NAME": "Обновленный почтовый сервис", + "ACTIVE": "N", + "SERVER": "imap.my2-mail.ru", + "PORT": 993, + "ENCRYPTION": "Y", + "LINK": "https://mail.my2-mail.ru/", + "SORT": 600 + } } diff --git a/_assets/simulator/spec/methods/main.eventlog.field.get.json b/_assets/simulator/spec/methods/main.eventlog.field.get.json index 27be29323..f90a5bd79 100644 --- a/_assets/simulator/spec/methods/main.eventlog.field.get.json +++ b/_assets/simulator/spec/methods/main.eventlog.field.get.json @@ -95,5 +95,17 @@ "title", "type", "validationRules" - ] + ], + "requestExample": { + "name": "timestampX", + "select": [ + "name", + "type", + "title", + "description", + "filterable", + "sortable", + "multiple" + ] + } } diff --git a/_assets/simulator/spec/methods/main.eventlog.field.list.json b/_assets/simulator/spec/methods/main.eventlog.field.list.json index 55df73492..012c6e6cc 100644 --- a/_assets/simulator/spec/methods/main.eventlog.field.list.json +++ b/_assets/simulator/spec/methods/main.eventlog.field.list.json @@ -190,5 +190,16 @@ "sortable", "title", "type" - ] + ], + "requestExample": { + "select": [ + "name", + "type", + "title", + "description", + "filterable", + "sortable", + "multiple" + ] + } } diff --git a/_assets/simulator/spec/methods/main.eventlog.get.json b/_assets/simulator/spec/methods/main.eventlog.get.json index 005ba7fa7..58890bd59 100644 --- a/_assets/simulator/spec/methods/main.eventlog.get.json +++ b/_assets/simulator/spec/methods/main.eventlog.get.json @@ -190,5 +190,8 @@ "timestampX", "userAgent", "userId" - ] + ], + "requestExample": { + "id": 1250 + } } diff --git a/_assets/simulator/spec/methods/main.eventlog.list.json b/_assets/simulator/spec/methods/main.eventlog.list.json index ed764e720..fb255971e 100644 --- a/_assets/simulator/spec/methods/main.eventlog.list.json +++ b/_assets/simulator/spec/methods/main.eventlog.list.json @@ -189,5 +189,37 @@ } ], "page": "/api-reference/event-log/main-eventlog-list.html", - "executable": false + "executable": false, + "requestExample": { + "select": [ + "id", + "timestampX", + "severity", + "auditTypeId", + "moduleId", + "itemId", + "userId", + "description" + ], + "filter": [ + [ + "timestampX", + ">=", + "2026-01-30T00:00:00+03:00" + ], + [ + "timestampX", + "<", + "2026-01-31T00:00:00+03:00" + ] + ], + "order": { + "id": "ASC" + }, + "pagination": { + "page": 1, + "limit": 20, + "offset": 0 + } + } } diff --git a/_assets/simulator/spec/methods/main.eventlog.tail.json b/_assets/simulator/spec/methods/main.eventlog.tail.json index da76012ca..029dbab10 100644 --- a/_assets/simulator/spec/methods/main.eventlog.tail.json +++ b/_assets/simulator/spec/methods/main.eventlog.tail.json @@ -168,5 +168,23 @@ } ], "page": "/api-reference/event-log/main-eventlog-tail.html", - "executable": false + "executable": false, + "requestExample": { + "select": [ + "id", + "timestampX", + "severity", + "auditTypeId", + "moduleId", + "itemId", + "userId", + "description" + ], + "filter": [], + "cursor": { + "field": "id", + "value": 446313, + "order": "ASC" + } + } } diff --git a/_assets/simulator/spec/methods/method.get.json b/_assets/simulator/spec/methods/method.get.json index af791a6ac..61797e11c 100644 --- a/_assets/simulator/spec/methods/method.get.json +++ b/_assets/simulator/spec/methods/method.get.json @@ -3,19 +3,19 @@ "method": "method.get", "scope": "базовый", "kind": "read", - "title": "Получить список доступных методов method.get", + "title": "Проверить доступность метода method.get", "permissions": "любой пользователь", "params": [ { "name": "name", "type": "string", "base": "string", - "required": false, - "description": "Название метода для проверки в нижнем регистре, например user.get. Если параметр не передан или пуст, метод вернет isExisting и isAvailable со значением false" + "required": "unknown", + "description": "Название метода для проверки, например user.get. Передавайте имя метода в нижнем регистре, даже если в документации метод записан с заглавными буквами: для telephony.externalLine.get и User.Get метод вернет false, для telephony.externalline.get — true. У методов модулей вида crm.item.* и tasks.task.* действие не проверяется: для crm.item.lst и tasks.Task.list метод вернет true.…" } ], "defs": {}, - "requiredConvention": true, + "requiredConvention": false, "confidence": "parsed", "source": { "file": "api-reference/common/system/method-get.md" @@ -38,16 +38,16 @@ "returns": [ { "name": "result", - "type": "array", - "base": "array", - "required": false, - "description": "Возвращаются два параметра: - isExisting => true/false — определяет, существует ли метод именно в этом Битрикс24 - isAvailable => true/false — определяет доступность метода для вызова с текущими доступами (scope) приложения" + "type": "object", + "base": "object", + "required": "unknown", + "description": "Результат проверки (подробное описание)" }, { "name": "time", "type": "time", "base": "object", - "required": false, + "required": "unknown", "description": "Информация о времени выполнения запроса" } ], @@ -56,5 +56,8 @@ "entityFields": [ "isAvailable", "isExisting" - ] + ], + "requestExample": { + "name": "user.get" + } } diff --git a/_assets/simulator/spec/methods/note.collection.add.json b/_assets/simulator/spec/methods/note.collection.add.json index 079d6af0f..5ea2eb3ff 100644 --- a/_assets/simulator/spec/methods/note.collection.add.json +++ b/_assets/simulator/spec/methods/note.collection.add.json @@ -149,5 +149,11 @@ } ], "page": "/api-reference/note/collection/note-collection-add.html", - "executable": false + "executable": false, + "requestExample": { + "fields": { + "name": "Продуктовая документация", + "position": 100 + } + } } diff --git a/_assets/simulator/spec/methods/note.collection.archive.json b/_assets/simulator/spec/methods/note.collection.archive.json index eff0dc5c0..24c88779e 100644 --- a/_assets/simulator/spec/methods/note.collection.archive.json +++ b/_assets/simulator/spec/methods/note.collection.archive.json @@ -59,5 +59,8 @@ } ], "page": "/api-reference/note/collection/note-collection-archive.html", - "executable": false + "executable": false, + "requestExample": { + "id": 42 + } } diff --git a/_assets/simulator/spec/methods/note.collection.delete.json b/_assets/simulator/spec/methods/note.collection.delete.json index a41fe7b4c..fee2627e9 100644 --- a/_assets/simulator/spec/methods/note.collection.delete.json +++ b/_assets/simulator/spec/methods/note.collection.delete.json @@ -59,5 +59,8 @@ } ], "page": "/api-reference/note/collection/note-collection-delete.html", - "executable": false + "executable": false, + "requestExample": { + "id": 42 + } } diff --git a/_assets/simulator/spec/methods/note.collection.field.get.json b/_assets/simulator/spec/methods/note.collection.field.get.json index 1edaf940f..8d7787eee 100644 --- a/_assets/simulator/spec/methods/note.collection.field.get.json +++ b/_assets/simulator/spec/methods/note.collection.field.get.json @@ -79,5 +79,13 @@ "name", "title", "type" - ] + ], + "requestExample": { + "name": "name", + "select": [ + "name", + "type", + "title" + ] + } } diff --git a/_assets/simulator/spec/methods/note.collection.field.list.json b/_assets/simulator/spec/methods/note.collection.field.list.json index d3c8659c2..796afd693 100644 --- a/_assets/simulator/spec/methods/note.collection.field.list.json +++ b/_assets/simulator/spec/methods/note.collection.field.list.json @@ -127,5 +127,14 @@ "sortable", "title", "type" - ] + ], + "requestExample": { + "select": [ + "name", + "type", + "title", + "filterable", + "sortable" + ] + } } diff --git a/_assets/simulator/spec/methods/note.collection.get.json b/_assets/simulator/spec/methods/note.collection.get.json index ce779997a..236e679fd 100644 --- a/_assets/simulator/spec/methods/note.collection.get.json +++ b/_assets/simulator/spec/methods/note.collection.get.json @@ -152,5 +152,8 @@ "position", "updatedAt", "updatedBy" - ] + ], + "requestExample": { + "id": 42 + } } diff --git a/_assets/simulator/spec/methods/note.collection.list.json b/_assets/simulator/spec/methods/note.collection.list.json index acae8d5fc..8c3f38992 100644 --- a/_assets/simulator/spec/methods/note.collection.list.json +++ b/_assets/simulator/spec/methods/note.collection.list.json @@ -197,5 +197,14 @@ "position", "updatedAt", "updatedBy" - ] + ], + "requestExample": { + "pagination": { + "limit": 50, + "afterCursor": { + "position": 100, + "id": 42 + } + } + } } diff --git a/_assets/simulator/spec/methods/note.collection.update.json b/_assets/simulator/spec/methods/note.collection.update.json index 3599eef48..02dd446ee 100644 --- a/_assets/simulator/spec/methods/note.collection.update.json +++ b/_assets/simulator/spec/methods/note.collection.update.json @@ -149,5 +149,11 @@ } ], "page": "/api-reference/note/collection/note-collection-update.html", - "executable": false + "executable": false, + "requestExample": { + "id": 42, + "fields": { + "name": "Документация продукта" + } + } } diff --git a/_assets/simulator/spec/methods/note.document.add.json b/_assets/simulator/spec/methods/note.document.add.json index f6a450995..e97448486 100644 --- a/_assets/simulator/spec/methods/note.document.add.json +++ b/_assets/simulator/spec/methods/note.document.add.json @@ -179,5 +179,13 @@ } ], "page": "/api-reference/note/document/note-document-add.html", - "executable": false + "executable": false, + "requestExample": { + "fields": { + "collectionId": 42, + "title": "Глава 1", + "parentId": 10, + "markdown": "# Глава 1\n\nТекст документа" + } + } } diff --git a/_assets/simulator/spec/methods/note.document.archive.json b/_assets/simulator/spec/methods/note.document.archive.json index 11644a20f..f48f4b9b4 100644 --- a/_assets/simulator/spec/methods/note.document.archive.json +++ b/_assets/simulator/spec/methods/note.document.archive.json @@ -59,5 +59,8 @@ } ], "page": "/api-reference/note/document/note-document-archive.html", - "executable": false + "executable": false, + "requestExample": { + "id": 77 + } } diff --git a/_assets/simulator/spec/methods/note.document.delete.json b/_assets/simulator/spec/methods/note.document.delete.json index 3edc3d28b..e20480723 100644 --- a/_assets/simulator/spec/methods/note.document.delete.json +++ b/_assets/simulator/spec/methods/note.document.delete.json @@ -59,5 +59,8 @@ } ], "page": "/api-reference/note/document/note-document-delete.html", - "executable": false + "executable": false, + "requestExample": { + "id": 77 + } } diff --git a/_assets/simulator/spec/methods/note.document.field.get.json b/_assets/simulator/spec/methods/note.document.field.get.json index ae2c72525..77bb1caf5 100644 --- a/_assets/simulator/spec/methods/note.document.field.get.json +++ b/_assets/simulator/spec/methods/note.document.field.get.json @@ -79,5 +79,13 @@ "name", "title", "type" - ] + ], + "requestExample": { + "name": "title", + "select": [ + "name", + "type", + "title" + ] + } } diff --git a/_assets/simulator/spec/methods/note.document.field.list.json b/_assets/simulator/spec/methods/note.document.field.list.json index fa3d1093c..eeec3c538 100644 --- a/_assets/simulator/spec/methods/note.document.field.list.json +++ b/_assets/simulator/spec/methods/note.document.field.list.json @@ -141,5 +141,14 @@ "sortable", "title", "type" - ] + ], + "requestExample": { + "select": [ + "name", + "type", + "title", + "filterable", + "sortable" + ] + } } diff --git a/_assets/simulator/spec/methods/note.document.get.json b/_assets/simulator/spec/methods/note.document.get.json index 45d8f20c0..0640056bb 100644 --- a/_assets/simulator/spec/methods/note.document.get.json +++ b/_assets/simulator/spec/methods/note.document.get.json @@ -152,5 +152,8 @@ "title", "updatedAt", "updatedBy" - ] + ], + "requestExample": { + "id": 42 + } } diff --git a/_assets/simulator/spec/methods/note.document.search.field.get.json b/_assets/simulator/spec/methods/note.document.search.field.get.json index 777ad2a85..a14736a34 100644 --- a/_assets/simulator/spec/methods/note.document.search.field.get.json +++ b/_assets/simulator/spec/methods/note.document.search.field.get.json @@ -79,5 +79,13 @@ "name", "title", "type" - ] + ], + "requestExample": { + "name": "snippet", + "select": [ + "name", + "type", + "title" + ] + } } diff --git a/_assets/simulator/spec/methods/note.document.search.field.list.json b/_assets/simulator/spec/methods/note.document.search.field.list.json index 12ed09a25..df0e1aeec 100644 --- a/_assets/simulator/spec/methods/note.document.search.field.list.json +++ b/_assets/simulator/spec/methods/note.document.search.field.list.json @@ -113,5 +113,14 @@ "sortable", "title", "type" - ] + ], + "requestExample": { + "select": [ + "name", + "type", + "title", + "filterable", + "sortable" + ] + } } diff --git a/_assets/simulator/spec/methods/note.document.search.list.json b/_assets/simulator/spec/methods/note.document.search.list.json index 207636953..0489f6959 100644 --- a/_assets/simulator/spec/methods/note.document.search.list.json +++ b/_assets/simulator/spec/methods/note.document.search.list.json @@ -176,5 +176,11 @@ "sharedAccess", "snippet", "title" - ] + ], + "requestExample": { + "query": "рецепт борща", + "pagination": { + "limit": 50 + } + } } diff --git a/_assets/simulator/spec/methods/note.document.tree.field.get.json b/_assets/simulator/spec/methods/note.document.tree.field.get.json index 57f20c890..d2437e62b 100644 --- a/_assets/simulator/spec/methods/note.document.tree.field.get.json +++ b/_assets/simulator/spec/methods/note.document.tree.field.get.json @@ -79,5 +79,13 @@ "name", "title", "type" - ] + ], + "requestExample": { + "name": "children", + "select": [ + "name", + "type", + "title" + ] + } } diff --git a/_assets/simulator/spec/methods/note.document.tree.field.list.json b/_assets/simulator/spec/methods/note.document.tree.field.list.json index 82608de0a..babd80be3 100644 --- a/_assets/simulator/spec/methods/note.document.tree.field.list.json +++ b/_assets/simulator/spec/methods/note.document.tree.field.list.json @@ -113,5 +113,14 @@ "sortable", "title", "type" - ] + ], + "requestExample": { + "select": [ + "name", + "type", + "title", + "filterable", + "sortable" + ] + } } diff --git a/_assets/simulator/spec/methods/note.document.tree.list.json b/_assets/simulator/spec/methods/note.document.tree.list.json index 439b1a065..e9cd02f10 100644 --- a/_assets/simulator/spec/methods/note.document.tree.list.json +++ b/_assets/simulator/spec/methods/note.document.tree.list.json @@ -142,5 +142,8 @@ "parentId", "position", "title" - ] + ], + "requestExample": { + "collectionId": 123 + } } diff --git a/_assets/simulator/spec/methods/note.document.update.json b/_assets/simulator/spec/methods/note.document.update.json index e2193aaa7..4bb160c7f 100644 --- a/_assets/simulator/spec/methods/note.document.update.json +++ b/_assets/simulator/spec/methods/note.document.update.json @@ -189,5 +189,13 @@ } ], "page": "/api-reference/note/document/note-document-update.html", - "executable": false + "executable": false, + "requestExample": { + "id": 77, + "fields": { + "title": "Глава 1 (обновлено)", + "markdown": "# Глава 1\n\nОбновленный текст\n\n[[image fileId=5001 width=30.98 align=left]]" + }, + "overwrite": false + } } diff --git a/_assets/simulator/spec/methods/note.file.add.json b/_assets/simulator/spec/methods/note.file.add.json index 468c08c84..7ca9538d9 100644 --- a/_assets/simulator/spec/methods/note.file.add.json +++ b/_assets/simulator/spec/methods/note.file.add.json @@ -130,5 +130,10 @@ } ], "page": "/api-reference/note/file/note-file-add.html", - "executable": false + "executable": false, + "requestExample": { + "documentId": 77, + "fileName": "diagram.png", + "fileContent": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNkYAAAAAYAAjCB0C8AAAAASUVORK5CYII=" + } } diff --git a/_assets/simulator/spec/methods/note.file.field.get.json b/_assets/simulator/spec/methods/note.file.field.get.json index 9f060b930..81c107f30 100644 --- a/_assets/simulator/spec/methods/note.file.field.get.json +++ b/_assets/simulator/spec/methods/note.file.field.get.json @@ -79,5 +79,13 @@ "name", "title", "type" - ] + ], + "requestExample": { + "name": "assetMarkdown", + "select": [ + "name", + "type", + "title" + ] + } } diff --git a/_assets/simulator/spec/methods/note.file.field.list.json b/_assets/simulator/spec/methods/note.file.field.list.json index 7341668fa..dc53b341a 100644 --- a/_assets/simulator/spec/methods/note.file.field.list.json +++ b/_assets/simulator/spec/methods/note.file.field.list.json @@ -120,5 +120,14 @@ "sortable", "title", "type" - ] + ], + "requestExample": { + "select": [ + "name", + "type", + "title", + "filterable", + "sortable" + ] + } } diff --git a/_assets/simulator/spec/methods/note.file.get.json b/_assets/simulator/spec/methods/note.file.get.json index ed675ac23..a09331083 100644 --- a/_assets/simulator/spec/methods/note.file.get.json +++ b/_assets/simulator/spec/methods/note.file.get.json @@ -146,5 +146,9 @@ "mimeType", "name", "size" - ] + ], + "requestExample": { + "id": 5001, + "documentId": 77 + } } diff --git a/_assets/simulator/spec/methods/placement.get.json b/_assets/simulator/spec/methods/placement.get.json index 4848c8dcb..ec5cefb23 100644 --- a/_assets/simulator/spec/methods/placement.get.json +++ b/_assets/simulator/spec/methods/placement.get.json @@ -1,17 +1,21 @@ { "$v": 1, "method": "placement.get", - "scope": null, + "scope": "placement", "kind": "read", "title": "Получить обработчики, зарегистрированные приложением placement.get", "permissions": "администратор", "params": [ { "name": "result", - "type": "boolean", - "base": "boolean", + "type": "array", + "base": "array", "required": "unknown", - "description": "Возвращает список зарегистрированных обработчиков виджетов. Структура каждого элемента соответствует параметрам метода регистрации обработчика" + "description": "Список зарегистрированных обработчиков виджетов (подробное описание). Если приложение не зарегистрировало ни одного обработчика, список пустой", + "dynamic": { + "allowed": true, + "note": "Состав полей не описан подтаблицей на этой странице" + } }, { "name": "time", @@ -34,6 +38,7 @@ "resultExample": { "result": [ { + "id": 41, "placement": "CRM_DEAL_LIST_TOOLBAR", "userId": 0, "handler": "https://myapp.com/?handler=1", @@ -49,6 +54,7 @@ } }, { + "id": 42, "placement": "CRM_DEAL_LIST_TOOLBAR", "userId": 0, "handler": "https://myapp.com/?handler=1", @@ -64,6 +70,7 @@ } }, { + "id": 43, "placement": "IM_CONTEXT_MENU", "userId": 0, "handler": "https://myapp.com/?handler=2", @@ -83,6 +90,7 @@ } }, { + "id": 44, "placement": "PAGE_BACKGROUND_WORKER", "userId": 1, "handler": "https://myapp.com/?handler=3", @@ -114,10 +122,10 @@ "returns": [ { "name": "result", - "type": "boolean", - "base": "boolean", + "type": "array", + "base": "array", "required": "unknown", - "description": "Возвращает список зарегистрированных обработчиков виджетов. Структура каждого элемента соответствует параметрам метода регистрации обработчика" + "description": "Список зарегистрированных обработчиков виджетов (подробное описание). Если приложение не зарегистрировало ни одного обработчика, список пустой" }, { "name": "time", @@ -132,6 +140,7 @@ "entityFields": [ "description", "handler", + "id", "langAll", "options", "placement", diff --git a/_assets/simulator/spec/methods/sale.basketitem.add.json b/_assets/simulator/spec/methods/sale.basketitem.add.json index 532ce7c47..8a77287b1 100644 --- a/_assets/simulator/spec/methods/sale.basketitem.add.json +++ b/_assets/simulator/spec/methods/sale.basketitem.add.json @@ -3,7 +3,7 @@ "method": "sale.basketitem.add", "scope": "sale", "kind": "write", - "title": "Добавить элемент (позицию) в корзину существующего заказа sale.basketitem.add", + "title": "Добавить произвольную позицию в корзину заказа sale.basketitem.add", "permissions": "администратор", "params": [ { @@ -11,7 +11,7 @@ "type": "object", "base": "object", "required": true, - "description": "Значения полей для создания элемента (позиции) корзины в заказе", + "description": "Значения полей позиции корзины (подробное описание)", "ref": "#/defs/fieldsFields" } ], @@ -35,59 +35,42 @@ "type": "integer", "base": "integer", "required": false, - "description": "Положение в списке позиций заказа" + "description": "Положение в списке позиций заказа. По умолчанию 100" }, { - "name": "productid", + "name": "productId", "type": "catalog_product.id", "base": "any", "required": true, - "description": "Идентификатор товара/вариации. Для товаров, которых нет на сайте/портале, может быть равен нулю" + "description": "Идентификатор товара или вариации из каталога. Для произвольной позиции, которой нет в каталоге, передайте 0. Для товара из каталога удобнее метод sale.basketitem.addCatalogProduct" }, { "name": "price", "type": "double", "base": "number", "required": false, - "description": "Цена с учетом наценок и скидок (смотрите поле customPrice ниже). Поле будет заполнено автоматически, если customPrice !== ‘Y’" + "description": "Цена за единицу с учетом наценок и скидок. Если передать price, цена сохранится как указанная вручную: в ответе будет customPrice = Y, а пересчета из каталога не будет. Если не передать, для товара из каталога цена берется из каталога, для произвольной позиции — 0" }, { "name": "basePrice", "type": "double", "base": "number", "required": false, - "description": "Исходная цена без учета наценок и скидок (смотрите поле customPrice ниже). Поле будет заполнено автоматически, если customPrice !== ‘Y’" + "description": "Исходная цена без учета наценок и скидок. Для товара из каталога по умолчанию берется из каталога. У произвольной позиции без basePrice поле равно 0, даже если передан price" }, { "name": "discountPrice", "type": "double", "base": "number", "required": false, - "description": "Величина итоговой скидки или наценки (смотрите поле customPrice ниже). Поле будет заполнено автоматически, если customPrice !== ‘Y’" + "description": "Величина итоговой скидки или наценки. Если передаете price, basePrice и discountPrice сами, соблюдайте условие basePrice = price + discountPrice" }, { "name": "currency", "type": "crm_currency.CURRENCY", "base": "any", "required": true, - "description": "Валюта цены. Должна совпадать с валютой заказа" - }, - { - "name": "customPrice", - "type": "string", - "base": "string", - "required": false, - "description": "Указана ли цена вручную. Возможные значения: - Y — да - N — нет Если указывается значение Y, то данные каталога будут игнорироваться. Необходимо явно задать параметры price, basePrice и discountPrice так, чтобы выполнялось условие basePrice = price + discountPrice", - "values": [ - { - "value": "Y", - "title": "да" - }, - { - "value": "N", - "title": "нет Если указывается значение Y, то данные каталога будут игнорироваться" - } - ] + "description": "Валюта цены. Должна совпадать с валютой заказа, иначе метод вернет ошибку 200140400011. Валюту заказа возвращает метод sale.order.get" }, { "name": "quantity", @@ -101,28 +84,28 @@ "type": "string", "base": "string", "required": false, - "description": "Внешний код позиции корзины" + "description": "Внешний код позиции корзины. Если не передать, Битрикс24 создаст код вида bx_6ab9ff3cc2d0a" }, { "name": "name", "type": "string", "base": "string", "required": true, - "description": "Название товара" + "description": "Название товара. Для произвольной позиции передайте его явно: без name позиция создастся без названия" }, { "name": "weight", - "type": "integer", - "base": "integer", + "type": "double", + "base": "number", "required": true, - "description": "Вес товара" + "description": "Вес товара. Сохраняется в том виде, в котором передан" }, { "name": "dimensions", "type": "string", "base": "string", "required": true, - "description": "Размеры товара (сериализованный массив)" + "description": "Размеры товара — строка с сериализованным PHP-массивом с ключами WIDTH, HEIGHT, LENGTH, например a:3:{s:5:\"WIDTH\";i:100;s:6:\"HEIGHT\";i:200;s:6:\"LENGTH\";i:300;}. Если передать объект, вместо размеров сохранится строка Array" }, { "name": "measureCode", @@ -143,7 +126,7 @@ "type": "string", "base": "string", "required": true, - "description": "Флаг доступности товара. Возможные значения: - Y — да - N — нет", + "description": "Флаг доступности товара. Возможные значения: - Y — да - N — нет У произвольной позиции по умолчанию Y", "values": [ { "value": "Y", @@ -151,7 +134,7 @@ }, { "value": "N", - "title": "нет" + "title": "нет У произвольной позиции по умолчанию Y" } ] }, @@ -160,14 +143,14 @@ "type": "double", "base": "number", "required": true, - "description": "Ставка налога долей от единицы: 0.1 — это 10 %. Для указания ставки «Без НДС» нужно передать пустую строку" + "description": "Ставка налога долей от единицы: 0.1 — это 10 %. Для ставки «Без НДС» передайте пустую строку" }, { "name": "vatIncluded", "type": "string", "base": "string", "required": true, - "description": "Флаг того, включен ли НДС или налог в цену товара. Возможные значения: - Y — да - N — нет", + "description": "Флаг того, включен ли НДС или налог в цену товара. Возможные значения: - Y — да - N — нет У произвольной позиции по умолчанию Y", "values": [ { "value": "Y", @@ -175,7 +158,7 @@ }, { "value": "N", - "title": "нет" + "title": "нет У произвольной позиции по умолчанию Y" } ] }, @@ -204,42 +187,37 @@ "resultExample": { "result": { "basketItem": { - "basePrice": 1000, + "basePrice": 0, "canBuy": "Y", - "catalogXmlId": "FUTURE-ERP-CATALOG", "currency": "RUB", - "customPrice": "N", - "dateInsert": "2024-04-23T15:59:37+02:00", - "dateUpdate": "2024-04-23T15:59:37+02:00", - "dimensions": "a:3:{s:5:\"WIDTH\";N;s:6:\"HEIGHT\";N;s:6:\"LENGTH\";N;}", - "discountPrice": 100, - "id": 6790, - "measureCode": "163", - "measureName": "г", - "name": "Товар", - "orderId": 5147, - "price": 900, - "productId": 1245, - "productXmlId": "1245", + "customPrice": "Y", + "dateInsert": "2026-09-28T08:49:12+03:00", + "dateUpdate": "2026-09-28T08:49:12+03:00", + "id": 1313, + "measureCode": "796", + "measureName": "шт", + "name": "Доставка крупногабаритного груза", + "orderId": 923, + "price": 1500, + "productId": 0, "properties": [], "quantity": 1, "reservations": [], "sort": 100, - "vatIncluded": "N", "vatRate": null, - "weight": 0, - "xmlId": "bx_6627bec8c4fdc" + "xmlId": "bx_6aba0de846c91" } }, "total": 1, "time": { - "start": 1713880776.108755, - "finish": 1713880777.704221, - "duration": 1.595465898513794, - "processing": 0.973701000213623, - "date_start": "2024-04-23T15:59:36+02:00", - "date_finish": "2024-04-23T15:59:37+02:00", - "operating": 0 + "start": 1790578152, + "finish": 1790578153.972347, + "duration": 1.9723470211029053, + "processing": 1, + "date_start": "2026-09-28T09:49:12+03:00", + "date_finish": "2026-09-28T09:49:13+03:00", + "operating_reset_at": 1790578752, + "operating": 1.7863950729370117 } }, "returns": [ @@ -255,7 +233,7 @@ "type": "sale_basket_item", "base": "any", "required": false, - "description": "Объект с данными созданного элемента (позиции) корзины" + "description": "Объект с данными созданной позиции корзины. Основные поля: - id — идентификатор позиции, его передают в sale.basketitem.update, sale.basketitem.get и sale.basketitem.delete - orderId, productId, name, quantity, currency — данные позиции - price, basePrice, discountPrice — цена за единицу, исходная цена и скидка - customPrice — Y, если цена задана вручную, N — если взята из каталога - xmlId — внешн…" }, { "name": "total", diff --git a/_assets/simulator/spec/methods/sale.basketitem.addCatalogProduct.json b/_assets/simulator/spec/methods/sale.basketitem.addCatalogProduct.json index 4dd39fb0d..0a01e537a 100644 --- a/_assets/simulator/spec/methods/sale.basketitem.addCatalogProduct.json +++ b/_assets/simulator/spec/methods/sale.basketitem.addCatalogProduct.json @@ -3,7 +3,7 @@ "method": "sale.basketitem.addCatalogProduct", "scope": "sale", "kind": "write", - "title": "Добавить позицию с товаром или услугой из модуля catalog в корзину существующего заказа sale.basketitem.addCatalogProduct", + "title": "Добавить позицию с товаром из каталога в корзину заказа sale.basketitem.addCatalogProduct", "permissions": "администратор", "params": [ { @@ -11,7 +11,7 @@ "type": "object", "base": "object", "required": true, - "description": "Значения полей для создания элемента (позиции) корзины в заказе", + "description": "Значения полей для создания позиции корзины в заказе (подробное описание)", "ref": "#/defs/fieldsFields" } ], @@ -28,77 +28,49 @@ "type": "sale_order.id", "base": "any", "required": true, - "description": "Идентификатор заказа. Может быть указан только при создании позиции корзины. Должен быть получен ранее методами sale.order.add или sale.order.list" + "description": "Идентификатор заказа. Изменить его после создания позиции нельзя. Получите идентификатор методом sale.order.add или sale.order.list" }, { - "name": "sort", - "type": "integer", - "base": "integer", - "required": false, - "description": "Положение в списке позиций заказа" - }, - { - "name": "productid", + "name": "productId", "type": "catalog_product.id", "base": "any", "required": true, - "description": "Идентификатор товара/вариации" - }, - { - "name": "price", - "type": "double", - "base": "number", - "required": false, - "description": "Цена с учетом наценок и скидок (смотрите поле customPrice ниже). Если не указать, будет рассчитана на основе данных каталога. Поле будет заполнено автоматически, если customPrice !== ‘Y’" - }, - { - "name": "basePrice", - "type": "double", - "base": "number", - "required": false, - "description": "Исходная цена без учета наценок и скидок (смотрите поле customPrice ниже). Если не указать, будет рассчитана на основе данных каталога. Поле будет заполнено автоматически, если customPrice !== ‘Y’" + "description": "Идентификатор товара, услуги или вариации из каталога. Изменить его после создания позиции нельзя. Получите идентификатор методом catalog.product.list" }, { - "name": "discountPrice", + "name": "quantity", "type": "double", "base": "number", - "required": false, - "description": "Величина итоговой скидки или наценки (смотрите поле customPrice ниже). Если не указать, будет рассчитана на основе данных каталога. Поле будет заполнено автоматически, если customPrice !== ‘Y’" + "required": true, + "description": "Количество товара. Передавайте значение больше 0: при 0 метод создаст позицию без цены и названия. Можно передать дробное число, например 1.5" }, { "name": "currency", "type": "crm_currency.CURRENCY", "base": "any", "required": true, - "description": "Валюта цены. Должна совпадать с валютой заказа" + "description": "Валюта цены, например RUB. Должна совпадать с валютой заказа, иначе метод вернет ошибку 200140400011. Изменить ее после создания позиции нельзя" }, { - "name": "customPrice", - "type": "string", - "base": "string", - "required": false, - "description": "Указана ли цена вручную: - Y — цена задана вручную - N — цена получена из каталога товаров По умолчанию значение N. Если указывается значение Y, то данные цены из каталога будут игнорироваться. Необходимо явно задать параметры price, basePrice и discountPrice так, чтобы выполнялось условие basePrice = price + discountPrice" - }, - { - "name": "quantity", + "name": "price", "type": "double", "base": "number", - "required": true, - "description": "Количество товара" + "required": false, + "description": "Цена за единицу с учетом скидок и наценок. Если параметр не передан, цену рассчитает Битрикс24 по данным каталога. Если параметр передан, у позиции будет customPrice = Y. Если у товара в каталоге нет цены, передайте price, иначе метод вернет ошибку 200140400007" }, { - "name": "xmlId", - "type": "string", - "base": "string", + "name": "sort", + "type": "integer", + "base": "integer", "required": false, - "description": "Внешний код позиции корзины" + "description": "Положение в списке позиций заказа. По умолчанию 100" }, { - "name": "name", + "name": "xmlId", "type": "string", "base": "string", - "required": true, - "description": "Название товара" + "required": false, + "description": "Внешний код позиции корзины. Если не передан, Битрикс24 создаст код сам, например bx_662675fba6516" } ] } @@ -111,6 +83,7 @@ "resultExample": { "result": { "basketItem": { + "barcodeMulti": "N", "basePrice": 1234, "canBuy": "Y", "catalogXmlId": "FUTURE-ERP-CATALOG", @@ -163,7 +136,7 @@ "type": "sale_basket_item", "base": "any", "required": false, - "description": "Объект с данными созданного элемента (позиции) корзины" + "description": "Созданная позиция корзины. Ключевые поля: - id — идентификатор позиции, его передают в методы sale.basketitem.updateCatalogProduct, sale.basketitem.get и sale.basketitem.delete - name, measureCode, measureName, catalogXmlId, productXmlId — данные из карточки товара в каталоге - price, basePrice, discountPrice — цена за единицу, цена без скидок и размер скидки - customPrice — Y, если цена задана вр…" }, { "name": "total", @@ -181,5 +154,13 @@ } ], "page": "/api-reference/sale/basket-item/sale-basket-item-add-catalog-product.html", - "executable": false + "executable": false, + "requestExample": { + "fields": { + "orderId": 5147, + "quantity": 1, + "productId": 4347, + "currency": "RUB" + } + } } diff --git a/_assets/simulator/spec/methods/sale.basketitem.delete.json b/_assets/simulator/spec/methods/sale.basketitem.delete.json index 2dd6865ff..8826ffe06 100644 --- a/_assets/simulator/spec/methods/sale.basketitem.delete.json +++ b/_assets/simulator/spec/methods/sale.basketitem.delete.json @@ -3,7 +3,7 @@ "method": "sale.basketitem.delete", "scope": "sale", "kind": "write", - "title": "Удалить элемент (позицию) корзины из заказа sale.basketitem.delete", + "title": "Удалить позицию из корзины заказа sale.basketitem.delete", "permissions": "администратор", "params": [ { @@ -11,7 +11,7 @@ "type": "sale_basket_item.id", "base": "any", "required": true, - "description": "Идентификатор элемента (позиции) корзины. Можно получить методом sale.basketitem.list" + "description": "Идентификатор позиции корзины. Можно получить методом sale.basketitem.list" } ], "defs": {}, @@ -38,7 +38,7 @@ "type": "boolean", "base": "boolean", "required": false, - "description": "Результат удаления элемента корзины" + "description": "Результат удаления позиции корзины. При успешном удалении возвращается true" }, { "name": "time", @@ -49,5 +49,8 @@ } ], "page": "/api-reference/sale/basket-item/sale-basket-item-delete.html", - "executable": false + "executable": false, + "requestExample": { + "id": 6803 + } } diff --git a/_assets/simulator/spec/methods/sale.basketitem.get.json b/_assets/simulator/spec/methods/sale.basketitem.get.json index 75510c37c..6aed6c36f 100644 --- a/_assets/simulator/spec/methods/sale.basketitem.get.json +++ b/_assets/simulator/spec/methods/sale.basketitem.get.json @@ -3,7 +3,7 @@ "method": "sale.basketitem.get", "scope": "sale", "kind": "read", - "title": "Получить информацию об элементе (позиции) корзины заказа sale.basketitem.get", + "title": "Получить позицию корзины sale.basketitem.get", "permissions": "менеджер магазина", "params": [ { @@ -11,7 +11,7 @@ "type": "sale_basket_item.id", "base": "any", "required": true, - "description": "Идентификатор элемента (позиции) корзины. Можно получить методом sale.basketitem.list" + "description": "Идентификатор позиции корзины. Можно получить методом sale.basketitem.list" } ], "defs": {}, @@ -23,6 +23,7 @@ "resultExample": { "result": { "basketItem": { + "barcodeMulti": "N", "basePrice": 1000, "canBuy": "Y", "catalogXmlId": "FUTURE-ERP-CATALOG", @@ -44,6 +45,7 @@ "quantity": 1, "reservations": [], "sort": 100, + "type": null, "vatIncluded": "N", "vatRate": null, "weight": 0, @@ -73,7 +75,7 @@ "type": "sale_basket_item", "base": "any", "required": false, - "description": "Объект с данными элемента (позиции) корзины" + "description": "Объект с данными позиции корзины. Ключевые поля: - id, orderId, productId — идентификаторы позиции, заказа и товара - name, quantity, currency — название товара, количество и валюта позиции - price, basePrice, discountPrice — цена за единицу, цена без скидок и размер скидки - customPrice — Y, если цена задана вручную, N, если рассчитана по каталогу - vatRate, vatIncluded — ставка налога и признак…" }, { "name": "time", @@ -86,6 +88,7 @@ "page": "/api-reference/sale/basket-item/sale-basket-item-get.html", "executable": false, "entityFields": [ + "barcodeMulti", "basePrice", "canBuy", "catalogXmlId", @@ -103,14 +106,17 @@ "price", "productId", "productXmlId", - "productid", "properties", "quantity", "reservations", "sort", + "type", "vatIncluded", "vatRate", "weight", "xmlId" - ] + ], + "requestExample": { + "id": 6801 + } } diff --git a/_assets/simulator/spec/methods/sale.basketitem.getFields.json b/_assets/simulator/spec/methods/sale.basketitem.getFields.json index a6a687670..4ec126a51 100644 --- a/_assets/simulator/spec/methods/sale.basketitem.getFields.json +++ b/_assets/simulator/spec/methods/sale.basketitem.getFields.json @@ -3,7 +3,7 @@ "method": "sale.basketitem.getFields", "scope": "sale", "kind": "read", - "title": "Получить доступные поля элемента (позиции) корзины sale.basketitem.getFields", + "title": "Получить поля позиции корзины sale.basketitem.getFields", "permissions": "менеджер магазина", "params": [ { @@ -46,6 +46,40 @@ "source": { "file": "api-reference/sale/basket-item/sale-basket-item-get-fields.md" }, + "resultExample": { + "result": { + "basketItem": { + "basePrice": { + "isImmutable": false, + "isReadOnly": false, + "isRequired": false, + "type": "double" + }, + "canBuy": { + "isImmutable": false, + "isReadOnly": false, + "isRequired": false, + "type": "char" + }, + "catalogXmlId": { + "isImmutable": true, + "isReadOnly": false, + "isRequired": false, + "type": "string" + } + } + }, + "time": { + "start": 1790578168, + "finish": 1790578168.809518, + "duration": 0.8095180988311768, + "processing": 0, + "date_start": "2026-09-28T09:49:28+03:00", + "date_finish": "2026-09-28T09:49:28+03:00", + "operating_reset_at": 1790578768, + "operating": 0 + } + }, "returns": [ { "name": "result", @@ -70,5 +104,6 @@ } ], "page": "/api-reference/sale/basket-item/sale-basket-item-get-fields.html", - "executable": false + "executable": false, + "requestExample": {} } diff --git a/_assets/simulator/spec/methods/sale.basketitem.getFieldsCatalogProduct.json b/_assets/simulator/spec/methods/sale.basketitem.getFieldsCatalogProduct.json index 41090277b..572d2db99 100644 --- a/_assets/simulator/spec/methods/sale.basketitem.getFieldsCatalogProduct.json +++ b/_assets/simulator/spec/methods/sale.basketitem.getFieldsCatalogProduct.json @@ -3,7 +3,7 @@ "method": "sale.basketitem.getFieldsCatalogProduct", "scope": "sale", "kind": "write", - "title": "Получить доступные поля элемента корзины (товар из каталога) sale.basketitem.getFieldsCatalogProduct", + "title": "Получить поля позиции с товаром из каталога sale.basketitem.getFieldsCatalogProduct", "permissions": "менеджер магазина", "params": [ { @@ -46,6 +46,40 @@ "source": { "file": "api-reference/sale/basket-item/sale-basket-item-get-catalog-product-fields.md" }, + "resultExample": { + "result": { + "basketItem": { + "basePrice": { + "isImmutable": false, + "isReadOnly": true, + "isRequired": false, + "type": "double" + }, + "canBuy": { + "isImmutable": false, + "isReadOnly": true, + "isRequired": false, + "type": "char" + }, + "catalogXmlId": { + "isImmutable": false, + "isReadOnly": true, + "isRequired": false, + "type": "string" + } + } + }, + "time": { + "start": 1790578169, + "finish": 1790578169.100949, + "duration": 0.10094904899597168, + "processing": 0, + "date_start": "2026-09-28T09:49:29+03:00", + "date_finish": "2026-09-28T09:49:29+03:00", + "operating_reset_at": 1790578769, + "operating": 0 + } + }, "returns": [ { "name": "result", @@ -70,5 +104,6 @@ } ], "page": "/api-reference/sale/basket-item/sale-basket-item-get-catalog-product-fields.html", - "executable": false + "executable": false, + "requestExample": {} } diff --git a/_assets/simulator/spec/methods/sale.basketitem.list.json b/_assets/simulator/spec/methods/sale.basketitem.list.json index fabb5ef41..c3beeea74 100644 --- a/_assets/simulator/spec/methods/sale.basketitem.list.json +++ b/_assets/simulator/spec/methods/sale.basketitem.list.json @@ -3,7 +3,7 @@ "method": "sale.basketitem.list", "scope": "sale", "kind": "read", - "title": "Получить список элементов (позиций) корзины sale.basketitem.list", + "title": "Получить список позиций корзины sale.basketitem.list", "permissions": "менеджер магазина", "params": [ { @@ -11,7 +11,7 @@ "type": "array", "base": "array", "required": false, - "description": "Массив со списком полей, которые необходимо выбрать (смотрите поля объекта salebasketitem). Если массив не передан или же передан пустой массив, то будут выбраны все доступные поля торговых каталогов", + "description": "Массив со списком полей, которые необходимо выбрать (смотрите поля объекта salebasketitem). Имена полей передавайте в camelCase, как в ответе: orderId, а не ORDER_ID. Если массив не передан, передан пустой массив или в нем нет ни одного известного поля, то будут выбраны все поля позиции. Неизвестные поля метод пропускает без ошибки.…", "dynamic": { "allowed": true, "note": "Состав полей не описан подтаблицей на этой странице" @@ -22,7 +22,7 @@ "type": "object", "base": "object", "required": false, - "description": "Объект для фильтрации выбранных записей в формате {\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}. Возможные значения для field соответствуют полям объекта salebasketitem. Ключу можно задать дополнительный префикс, уточняющий поведение фильтра.…", + "description": "Объект для фильтрации выбранных записей в формате {\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}. Возможные значения для field соответствуют полям объекта salebasketitem. Условие с неизвестным полем метод пропускает без ошибки, поэтому опечатка в имени поля вернет позиции без фильтрации. В выборку попадают и позиции, которые не входят в заказ: у них orderId равен null.…", "dynamic": { "allowed": true, "note": "Состав полей не описан подтаблицей на этой странице" @@ -33,7 +33,7 @@ "type": "object", "base": "object", "required": false, - "description": "Объект для сортировки выбранных записей в формате {\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}. Возможные значения для field соответствуют полям объекта salebasketitem. Возможные значения для order: - asc — в порядке возрастания - desc — в порядке убывания", + "description": "Объект для сортировки выбранных записей в формате {\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}. Возможные значения для field соответствуют полям объекта salebasketitem. Неизвестные поля метод пропускает без ошибки. Возможные значения для order: - asc — в порядке возрастания - desc — в порядке убывания По умолчанию позиции сортируются по возрастанию id", "values": [ { "value": "asc", @@ -41,7 +41,7 @@ }, { "value": "desc", - "title": "в порядке убывания" + "title": "в порядке убывания По умолчанию позиции сортируются по возрастанию id" } ], "dynamic": { @@ -54,7 +54,7 @@ "type": "integer", "base": "integer", "required": false, - "description": "Параметр используется для управления постраничной навигацией. Размер страницы результатов всегда статичный — 50 записей. Чтобы выбрать вторую страницу результатов, передайте значение 50. Чтобы выбрать третью страницу результатов — значение 100 и так далее. Формула расчета значения параметра start: start = (N-1) * 50, где N — номер нужной страницы" + "description": "Параметр используется для управления постраничной навигацией. Размер страницы результатов всегда статичный — 50 записей. Чтобы выбрать вторую страницу результатов, передайте значение 50. Чтобы выбрать третью страницу результатов — значение 100 и так далее. Формула расчета значения параметра start: start = (N-1) * 50, где N — номер нужной страницы.…" } ], "defs": {}, @@ -77,7 +77,7 @@ { "currency": "RUB", "id": 6791, - "name": "Стул из каталога", + "name": "Подарочная упаковка", "orderId": 5146, "price": 900, "productId": 0 @@ -116,7 +116,14 @@ "type": "sale_basket_item[]", "base": "array", "required": false, - "description": "Массив объектов с информацией о выбранных элементах (позициях) корзины заказов" + "description": "Массив объектов с информацией о выбранных позициях корзины. Набор полей в каждом объекте задает параметр select. Если позиций не найдено, массив пустой" + }, + { + "name": "next", + "type": "integer", + "base": "integer", + "required": false, + "description": "Значение start для следующей страницы. Возвращается, если найдено больше записей, чем на текущей странице" }, { "name": "total", @@ -140,7 +147,6 @@ "canBuy", "catalogXmlId", "currency", - "customPrice", "dimensions", "discountPrice", "id", @@ -151,12 +157,31 @@ "price", "productId", "productXmlId", - "productid", "quantity", "sort", "vatIncluded", "vatRate", "weight", "xmlId" - ] + ], + "requestExample": { + "select": [ + "id", + "orderId", + "productId", + "name", + "price", + "currency" + ], + "filter": { + "@orderId": [ + 5147, + 5146 + ] + }, + "order": { + "id": "desc" + }, + "start": 0 + } } diff --git a/_assets/simulator/spec/methods/sale.basketitem.update.json b/_assets/simulator/spec/methods/sale.basketitem.update.json index d6c839809..26e7a0de2 100644 --- a/_assets/simulator/spec/methods/sale.basketitem.update.json +++ b/_assets/simulator/spec/methods/sale.basketitem.update.json @@ -3,7 +3,7 @@ "method": "sale.basketitem.update", "scope": "sale", "kind": "write", - "title": "Изменить позицию корзины существующего заказа sale.basketitem.update", + "title": "Изменить позицию корзины заказа sale.basketitem.update", "permissions": "администратор", "params": [ { @@ -11,14 +11,14 @@ "type": "sale_basket_item.id", "base": "any", "required": true, - "description": "Идентификатор позиции заказа" + "description": "Идентификатор позиции корзины. Получить идентификаторы позиций можно методом sale.basketitem.list" }, { "name": "fields", "type": "object", "base": "object", "required": true, - "description": "Значения изменяемых полей", + "description": "Значения изменяемых полей (подробное описание)", "ref": "#/defs/fieldsFields" } ], @@ -30,40 +30,40 @@ "note": "Пользовательские поля UF_* в схеме не описаны" }, "fields": [ + { + "name": "quantity", + "type": "double", + "base": "number", + "required": true, + "description": "Количество товара. Передавайте в каждом вызове, даже если количество не меняется, иначе метод вернет ошибку Required fields: quantity. Нулевое, отрицательное или нечисловое значение метод игнорирует без ошибки" + }, { "name": "sort", "type": "integer", "base": "integer", "required": false, - "description": "Положение в списке позиций заказа" + "description": "Положение в списке позиций корзины" }, { "name": "price", "type": "double", "base": "number", "required": false, - "description": "Цена с учетом наценок и скидок" + "description": "Цена с учетом наценок и скидок. Если передать цену, Битрикс24 установит позиции customPrice = Y — цена считается указанной вручную и больше не берется из каталога" }, { "name": "basePrice", "type": "double", "base": "number", "required": false, - "description": "Исходная цена без учета наценок и скидок" + "description": "Исходная цена без учета наценок и скидок. Передавайте вместе с price и discountPrice так, чтобы выполнялось условие basePrice = price + discountPrice" }, { "name": "discountPrice", "type": "double", "base": "number", "required": false, - "description": "Величина итоговой скидки или наценки" - }, - { - "name": "quantity", - "type": "double", - "base": "number", - "required": false, - "description": "Количество товара" + "description": "Величина итоговой скидки или наценки. Для наценки значение отрицательное" }, { "name": "xmlId", @@ -81,17 +81,17 @@ }, { "name": "weight", - "type": "integer", - "base": "integer", + "type": "double", + "base": "number", "required": false, - "description": "Вес товара" + "description": "Вес товара. Позиция из каталога получает значение поля weight товара без пересчета, поэтому передавайте вес в тех же единицах, что в каталоге" }, { "name": "dimensions", "type": "string", "base": "string", "required": false, - "description": "Размеры товара (сериализованный массив)" + "description": "Размеры товара — строка с PHP-сериализованным массивом с ключами WIDTH, HEIGHT и LENGTH, например a:3:{s:5:\"WIDTH\";i:244;s:6:\"HEIGHT\";i:100;s:6:\"LENGTH\";i:31;}. В таком виде размеры хранятся у позиций, добавленных из каталога. Метод не проверяет формат и сохраняет любую строку как есть. Если передать объект вместо строки, сохранится значение Array" }, { "name": "measureCode", @@ -129,7 +129,7 @@ "type": "double", "base": "number", "required": false, - "description": "Ставка налога долей от единицы: 0.1 — это 10 %. Для указания ставки «Без НДС» нужно передать пустую строку" + "description": "Ставка налога долей от единицы: 0.1 — это 10 %. Для ставки «Без НДС» передайте пустую строку, в ответе будет null" }, { "name": "vatIncluded", @@ -147,20 +147,6 @@ "title": "нет" } ] - }, - { - "name": "catalogXmlId", - "type": "string", - "base": "string", - "required": false, - "description": "Внешний код каталога товаров" - }, - { - "name": "productXmlId", - "type": "string", - "base": "string", - "required": false, - "description": "Внешний код товара" } ] } @@ -173,6 +159,7 @@ "resultExample": { "result": { "basketItem": { + "barcodeMulti": "N", "basePrice": 1000, "canBuy": "Y", "catalogXmlId": "", @@ -196,7 +183,7 @@ "sort": 400, "type": null, "vatIncluded": "Y", - "vatRate": 10, + "vatRate": 0.1, "weight": 40, "xmlId": "BasketPositionId" } @@ -225,7 +212,7 @@ "type": "sale_basket_item", "base": "any", "required": false, - "description": "Объект с данными обновленного элемента (позиции) корзины" + "description": "Обновленная позиция корзины. Содержит все поля позиции, а не только измененные. Ключевые поля: - id, orderId, productId — идентификаторы позиции, заказа и товара - name, quantity, currency — название товара, количество и валюта позиции - price, basePrice, discountPrice — цена за единицу, цена без скидок и размер скидки - customPrice — Y, если цена задана вручную, N, если рассчитана по каталогу - w…" }, { "name": "total", @@ -243,5 +230,13 @@ } ], "page": "/api-reference/sale/basket-item/sale-basket-item-update.html", - "executable": false + "executable": false, + "requestExample": { + "id": 6791, + "fields": { + "quantity": 7, + "price": 10, + "discountPrice": 990 + } + } } diff --git a/_assets/simulator/spec/methods/sale.basketitem.updateCatalogProduct.json b/_assets/simulator/spec/methods/sale.basketitem.updateCatalogProduct.json index eb77dc103..a032d7597 100644 --- a/_assets/simulator/spec/methods/sale.basketitem.updateCatalogProduct.json +++ b/_assets/simulator/spec/methods/sale.basketitem.updateCatalogProduct.json @@ -3,7 +3,7 @@ "method": "sale.basketitem.updateCatalogProduct", "scope": "sale", "kind": "write", - "title": "Изменить позицию корзины (товар из каталога) существующего заказа sale.basketitem.updateCatalogProduct", + "title": "Изменить позицию с товаром из каталога sale.basketitem.updateCatalogProduct", "permissions": "администратор", "params": [ { @@ -11,14 +11,14 @@ "type": "sale_basket_item.id", "base": "any", "required": true, - "description": "Идентификатор элемента (позиции) корзины. Может быть получен методами sale.basketitem.addCatalogProduct и sale.basketitem.list" + "description": "Идентификатор позиции корзины. Получить его можно методами sale.basketitem.addCatalogProduct и sale.basketitem.list" }, { "name": "fields", "type": "object", "base": "object", "required": true, - "description": "Объект с изменяемыми полями", + "description": "Объект с изменяемыми полями (подробное описание)", "ref": "#/defs/fieldsFields" } ], @@ -30,6 +30,20 @@ "note": "Пользовательские поля UF_* в схеме не описаны" }, "fields": [ + { + "name": "quantity", + "type": "double", + "base": "number", + "required": true, + "description": "Количество товара, например 4 или 1.5. Передавайте всегда, даже если меняете только другие поля: без него метод вернет ошибку Required fields: quantity. Значение 0, отрицательное число или строку метод пропускает без ошибки, количество остается прежним. Чтобы убрать позицию из заказа, используйте метод sale.basketitem.delete" + }, + { + "name": "price", + "type": "double", + "base": "number", + "required": false, + "description": "Цена за единицу товара. Если не передать, остается текущая цена позиции" + }, { "name": "sort", "type": "integer", @@ -37,13 +51,6 @@ "required": false, "description": "Положение в списке позиций заказа" }, - { - "name": "quantity", - "type": "double", - "base": "number", - "required": true, - "description": "Количество товара" - }, { "name": "xmlId", "type": "string", @@ -62,43 +69,55 @@ "resultExample": { "result": { "basketItem": { - "basePrice": 1234, + "barcodeMulti": "N", + "basePrice": 100, "canBuy": "Y", - "catalogXmlId": "FUTURE-ERP-CATALOG", + "catalogXmlId": "FUTURE-1C-CATALOG", "currency": "RUB", - "customPrice": "N", - "dateInsert": "2024-04-22T16:23:43+02:00", - "dateUpdate": "2024-04-22T16:32:26+02:00", + "customPrice": "Y", + "dateInsert": "2026-09-28T07:46:42+03:00", + "dateUpdate": "2026-09-28T07:46:49+03:00", "dimensions": "a:3:{s:5:\"WIDTH\";N;s:6:\"HEIGHT\";N;s:6:\"LENGTH\";N;}", - "discountPrice": 124, + "discountPrice": 0, "id": 6783, "measureCode": "796", "measureName": "шт", - "name": " Разработка дизайна ", + "name": "Головной товар", "orderId": 5147, - "price": 1110, - "roductid": 4347, - "productXmlId": "4347", + "price": 100, + "productId": 6967, + "productXmlId": "6967", "properties": [], "quantity": 4, - "reservations": [], + "reservations": [ + { + "basketId": 6783, + "dateReserve": "2026-09-28T07:46:42+03:00", + "dateReserveEnd": "2026-10-01T21:00:00+03:00", + "id": 329, + "quantity": 1, + "reservedBy": null, + "storeId": 1 + } + ], "sort": 100, - "type": 2, + "type": null, "vatIncluded": "N", - "vatRate": null, + "vatRate": 0, "weight": 0, - "xmlId": "bx_662672ef370c6" + "xmlId": "bx_6ab9ff420a704" } }, "total": 1, "time": { - "start": 1713796344.951712, - "finish": 1713796346.586924, - "duration": 1.6352121829986572, - "processing": 0.6428370475769043, - "date_start": "2024-04-22T16:32:24+02:00", - "date_finish": "2024-04-22T16:32:26+02:00", - "operating": 0 + "start": 1790574409, + "finish": 1790574410.105003, + "duration": 1.1050031185150146, + "processing": 1, + "date_start": "2026-09-28T08:46:49+03:00", + "date_finish": "2026-09-28T08:46:50+03:00", + "operating_reset_at": 1790575009, + "operating": 0.23203706741333008 } }, "returns": [ @@ -114,7 +133,7 @@ "type": "sale_basket_item", "base": "any", "required": false, - "description": "Объект с данными созданного элемента (позиции) корзины" + "description": "Объект с данными измененной позиции корзины. Основные поля: - id — идентификатор позиции - orderId — идентификатор заказа - productId — идентификатор товара в каталоге - name — название товара из каталога - quantity — количество - price — цена за единицу с учетом скидок и наценок, basePrice — цена без них - customPrice — Y, если цена зафиксирована вручную - currency — валюта цены - properties — св…" }, { "name": "total", @@ -132,5 +151,11 @@ } ], "page": "/api-reference/sale/basket-item/sale-basket-item-update-catalog-product.html", - "executable": false + "executable": false, + "requestExample": { + "id": 6783, + "fields": { + "quantity": 4 + } + } } diff --git a/_assets/simulator/spec/methods/sale.basketproperties.add.json b/_assets/simulator/spec/methods/sale.basketproperties.add.json index 592b0560f..d619e30dc 100644 --- a/_assets/simulator/spec/methods/sale.basketproperties.add.json +++ b/_assets/simulator/spec/methods/sale.basketproperties.add.json @@ -28,7 +28,7 @@ "type": "sale_basket_item.id", "base": "any", "required": true, - "description": "Идентификатор элемента (позиции) корзины заказа. Может быть получен методами sale.basketitem.get или sale.basketitem.list" + "description": "Идентификатор элемента (позиции) корзины заказа. Позиция должна входить в заказ: у нее заполнено поле orderId. Может быть получен методами sale.basketitem.get или sale.basketitem.list" }, { "name": "name", @@ -49,7 +49,7 @@ "type": "string", "base": "string", "required": true, - "description": "Символьный код свойства" + "description": "Символьный код свойства. Битрикс24 не проверяет уникальность кода: повторный вызов с тем же code создаст у позиции второе свойство" }, { "name": "sort", @@ -118,5 +118,13 @@ } ], "page": "/api-reference/sale/basket-properties/sale-basket-properties-add.html", - "executable": false + "executable": false, + "requestExample": { + "fields": { + "basketId": 6806, + "name": "Артикул", + "value": "4653-4877", + "code": "ARTICUL" + } + } } diff --git a/_assets/simulator/spec/methods/sale.basketproperties.delete.json b/_assets/simulator/spec/methods/sale.basketproperties.delete.json index 727f154ed..1f0a151c0 100644 --- a/_assets/simulator/spec/methods/sale.basketproperties.delete.json +++ b/_assets/simulator/spec/methods/sale.basketproperties.delete.json @@ -4,7 +4,7 @@ "scope": "sale", "kind": "write", "title": "Удалить свойство корзины sale.basketproperties.delete", - "permissions": "администратор магазина", + "permissions": "администратор", "params": [ { "name": "id", @@ -49,5 +49,8 @@ } ], "page": "/api-reference/sale/basket-properties/sale-basket-properties-delete.html", - "executable": false + "executable": false, + "requestExample": { + "id": 17 + } } diff --git a/_assets/simulator/spec/methods/sale.basketproperties.get.json b/_assets/simulator/spec/methods/sale.basketproperties.get.json index f11db9ab0..c685035f7 100644 --- a/_assets/simulator/spec/methods/sale.basketproperties.get.json +++ b/_assets/simulator/spec/methods/sale.basketproperties.get.json @@ -75,5 +75,8 @@ "sort", "value", "xmlId" - ] + ], + "requestExample": { + "id": 17 + } } diff --git a/_assets/simulator/spec/methods/sale.basketproperties.getFields.json b/_assets/simulator/spec/methods/sale.basketproperties.getFields.json index ec226d1b1..1f3d8e5ef 100644 --- a/_assets/simulator/spec/methods/sale.basketproperties.getFields.json +++ b/_assets/simulator/spec/methods/sale.basketproperties.getFields.json @@ -4,7 +4,7 @@ "scope": "sale", "kind": "read", "title": "Получить поля элементов свойств корзины sale.basketproperties.getFields", - "permissions": "менеджер магазина", + "permissions": "любой пользователь", "params": [ { "name": "result", @@ -127,5 +127,6 @@ } ], "page": "/api-reference/sale/basket-properties/sale-basket-properties-get-fields.html", - "executable": false + "executable": false, + "requestExample": {} } diff --git a/_assets/simulator/spec/methods/sale.basketproperties.list.json b/_assets/simulator/spec/methods/sale.basketproperties.list.json index abac47419..e40063fad 100644 --- a/_assets/simulator/spec/methods/sale.basketproperties.list.json +++ b/_assets/simulator/spec/methods/sale.basketproperties.list.json @@ -22,7 +22,7 @@ "type": "object", "base": "object", "required": false, - "description": "Объект для фильтрации выбранных свойств корзины в формате {\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}. Возможные значения для field соответствуют полям объекта sale_basket_item_property. Ключу может быть задан дополнительный префикс, уточняющий поведение фильтра.…", + "description": "Объект для фильтрации выбранных свойств корзины в формате {\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}. Если не передать, метод вернет свойства всех позиций корзины. Возможные значения для field соответствуют полям объекта sale_basket_item_property. Ключу может быть задан дополнительный префикс, уточняющий поведение фильтра.…", "dynamic": { "allowed": true, "note": "Состав полей не описан подтаблицей на этой странице" @@ -33,7 +33,7 @@ "type": "object", "base": "object", "required": false, - "description": "Объект для сортировки выбранных групп свойств в формате {\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}. Возможные значения для field соответствуют полям объекта sale_basket_item_property. Возможные значения для order: - asc — в порядке возрастания - desc — в порядке убывания", + "description": "Объект для сортировки выбранных свойств в формате {\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}. Возможные значения для field соответствуют полям объекта sale_basket_item_property. Возможные значения для order: - asc — в порядке возрастания - desc — в порядке убывания Если order не передать, свойства придут по возрастанию id, а не по полю sort.…", "values": [ { "value": "asc", @@ -41,7 +41,7 @@ }, { "value": "desc", - "title": "в порядке убывания" + "title": "в порядке убывания Если order не передать, свойства придут по возрастанию id, а" } ], "dynamic": { @@ -54,7 +54,7 @@ "type": "integer", "base": "integer", "required": false, - "description": "Параметр используется для управления постраничной навигацией. Размер страницы результатов всегда статичный - 50 записей. Чтобы выбрать вторую страницу результатов, необходимо передавать значение - 50. Чтобы выбрать третью страницу результатов значение - 100 и т.д. Формула расчета значения параметра start: start = (N-1) 50, где N – номер нужной страницы" + "description": "Параметр используется для управления постраничной навигацией. Размер страницы результатов всегда статичный - 50 записей. Чтобы выбрать вторую страницу результатов, необходимо передавать значение - 50. Чтобы выбрать третью страницу результатов значение - 100 и т.д. Формула расчета значения параметра start: start = (N-1) 50, где N — номер нужной страницы.…" } ], "defs": {}, @@ -106,7 +106,7 @@ "type": "sale_basket_item_property[]", "base": "array", "required": false, - "description": "Массив объектов с информацией о выбранных свойствах элементов (позиций) корзины в заказах" + "description": "Массив объектов с информацией о выбранных свойствах элементов (позиций) корзины в заказах. Если свойств не найдено, массив пустой" }, { "name": "total", @@ -133,5 +133,21 @@ "sort", "value", "xmlId" - ] + ], + "requestExample": { + "select": [ + "id", + "basketId", + "value", + "name", + "code" + ], + "filter": { + "basketId": 6806 + }, + "order": { + "id": "desc" + }, + "start": 0 + } } diff --git a/_assets/simulator/spec/methods/sale.basketproperties.update.json b/_assets/simulator/spec/methods/sale.basketproperties.update.json index d4193c69d..8565c0a24 100644 --- a/_assets/simulator/spec/methods/sale.basketproperties.update.json +++ b/_assets/simulator/spec/methods/sale.basketproperties.update.json @@ -11,7 +11,7 @@ "type": "sale_basket_item_property.id", "base": "any", "required": true, - "description": "Идентификатор позиции заказа" + "description": "Идентификатор свойства элемента (позиции) корзины. Можно получить методом sale.basketproperties.list" }, { "name": "fields", @@ -34,21 +34,21 @@ "name": "name", "type": "string", "base": "string", - "required": false, + "required": true, "description": "Название свойства" }, { "name": "value", "type": "string", "base": "string", - "required": false, + "required": true, "description": "Значение свойства" }, { "name": "code", "type": "string", "base": "string", - "required": false, + "required": true, "description": "Символьный код свойства" }, { @@ -127,5 +127,13 @@ } ], "page": "/api-reference/sale/basket-properties/sale-basket-properties-update.html", - "executable": false + "executable": false, + "requestExample": { + "id": 17, + "fields": { + "name": "Артикул", + "value": "123-456-789", + "code": "ARTICUL" + } + } } diff --git a/_assets/simulator/spec/methods/sale.businessValuePersonDomain.add.json b/_assets/simulator/spec/methods/sale.businessValuePersonDomain.add.json index c36a01ec4..309a311ef 100644 --- a/_assets/simulator/spec/methods/sale.businessValuePersonDomain.add.json +++ b/_assets/simulator/spec/methods/sale.businessValuePersonDomain.add.json @@ -84,5 +84,11 @@ } ], "page": "/api-reference/sale/business-value-person-domain/sale-business-value-person-domain-add.html", - "executable": false + "executable": false, + "requestExample": { + "fields": { + "personTypeId": 3, + "domain": "I" + } + } } diff --git a/_assets/simulator/spec/methods/sale.businessValuePersonDomain.deleteByFilter.json b/_assets/simulator/spec/methods/sale.businessValuePersonDomain.deleteByFilter.json index cda363f76..07d74862a 100644 --- a/_assets/simulator/spec/methods/sale.businessValuePersonDomain.deleteByFilter.json +++ b/_assets/simulator/spec/methods/sale.businessValuePersonDomain.deleteByFilter.json @@ -73,5 +73,11 @@ } ], "page": "/api-reference/sale/business-value-person-domain/sale-business-value-person-domain-delete-by-filter.html", - "executable": false + "executable": false, + "requestExample": { + "fields": { + "personTypeId": 3, + "domain": "I" + } + } } diff --git a/_assets/simulator/spec/methods/sale.businessValuePersonDomain.getFields.json b/_assets/simulator/spec/methods/sale.businessValuePersonDomain.getFields.json index d64a28f37..b4871fcd3 100644 --- a/_assets/simulator/spec/methods/sale.businessValuePersonDomain.getFields.json +++ b/_assets/simulator/spec/methods/sale.businessValuePersonDomain.getFields.json @@ -97,5 +97,6 @@ } ], "page": "/api-reference/sale/business-value-person-domain/sale-business-value-person-domain-get-fields.html", - "executable": false + "executable": false, + "requestExample": {} } diff --git a/_assets/simulator/spec/methods/sale.businessValuePersonDomain.list.json b/_assets/simulator/spec/methods/sale.businessValuePersonDomain.list.json index ce8225d9d..d54a1079f 100644 --- a/_assets/simulator/spec/methods/sale.businessValuePersonDomain.list.json +++ b/_assets/simulator/spec/methods/sale.businessValuePersonDomain.list.json @@ -120,5 +120,16 @@ "entityFields": [ "domain", "personTypeId" - ] + ], + "requestExample": { + "select": [ + "personTypeId" + ], + "filter": { + "=domain": "I" + }, + "order": { + "personTypeId": "DESC" + } + } } diff --git a/_assets/simulator/spec/methods/sale.cashbox.add.json b/_assets/simulator/spec/methods/sale.cashbox.add.json index 01e5df652..81e9b150c 100644 --- a/_assets/simulator/spec/methods/sale.cashbox.add.json +++ b/_assets/simulator/spec/methods/sale.cashbox.add.json @@ -190,5 +190,28 @@ } ], "page": "/api-reference/sale/cashbox/sale-cashbox-add.html", - "executable": false + "executable": false, + "requestExample": { + "NAME": "Rest-касса", + "REST_CODE": "restcashbox01", + "EMAIL": "user@example.com", + "NUMBER_KKM": "123", + "ACTIVE": "Y", + "SORT": 100, + "OFD": "bx_ofdruofd", + "OFD_SETTINGS": { + "OFD_MODE": { + "IS_TEST": "N" + } + }, + "SETTINGS": { + "AUTH": { + "KEYWORD": "top_secret!", + "PREFERENCE": "SECOND" + }, + "INTERACTION": { + "MODE": "ACTIVE" + } + } + } } diff --git a/_assets/simulator/spec/methods/sale.cashbox.check.apply.json b/_assets/simulator/spec/methods/sale.cashbox.check.apply.json index 67e3014eb..39b7d62ed 100644 --- a/_assets/simulator/spec/methods/sale.cashbox.check.apply.json +++ b/_assets/simulator/spec/methods/sale.cashbox.check.apply.json @@ -99,5 +99,15 @@ } ], "page": "/api-reference/sale/cashbox/sale-cashbox-check-apply.html", - "executable": false + "executable": false, + "requestExample": { + "UUID": "check|example.com|1", + "PRINT_END_TIME": "1609459200", + "REG_NUMBER_KKT": "1234567891011121", + "FISCAL_DOC_ATTR": "1234567890", + "FISCAL_DOC_NUMBER": "12345", + "FISCAL_RECEIPT_NUMBER": "123", + "FN_NUMBER": "1234567891011121", + "SHIFT_NUMBER": "1" + } } diff --git a/_assets/simulator/spec/methods/sale.cashbox.delete.json b/_assets/simulator/spec/methods/sale.cashbox.delete.json index f18fc19da..ec9a9b39e 100644 --- a/_assets/simulator/spec/methods/sale.cashbox.delete.json +++ b/_assets/simulator/spec/methods/sale.cashbox.delete.json @@ -50,5 +50,8 @@ } ], "page": "/api-reference/sale/cashbox/sale-cashbox-delete.html", - "executable": false + "executable": false, + "requestExample": { + "ID": 1 + } } diff --git a/_assets/simulator/spec/methods/sale.cashbox.handler.delete.json b/_assets/simulator/spec/methods/sale.cashbox.handler.delete.json index bfb0007ca..91d26628a 100644 --- a/_assets/simulator/spec/methods/sale.cashbox.handler.delete.json +++ b/_assets/simulator/spec/methods/sale.cashbox.handler.delete.json @@ -50,5 +50,8 @@ } ], "page": "/api-reference/sale/cashbox/sale-cashbox-handler-delete.html", - "executable": false + "executable": false, + "requestExample": { + "ID": 1 + } } diff --git a/_assets/simulator/spec/methods/sale.cashbox.handler.list.json b/_assets/simulator/spec/methods/sale.cashbox.handler.list.json index 641ebf14a..fdf807f86 100644 --- a/_assets/simulator/spec/methods/sale.cashbox.handler.list.json +++ b/_assets/simulator/spec/methods/sale.cashbox.handler.list.json @@ -52,5 +52,6 @@ } ], "page": "/api-reference/sale/cashbox/sale-cashbox-handler-list.html", - "executable": false + "executable": false, + "requestExample": {} } diff --git a/_assets/simulator/spec/methods/sale.cashbox.handler.update.json b/_assets/simulator/spec/methods/sale.cashbox.handler.update.json index 5d1697281..cea1dd253 100644 --- a/_assets/simulator/spec/methods/sale.cashbox.handler.update.json +++ b/_assets/simulator/spec/methods/sale.cashbox.handler.update.json @@ -61,5 +61,57 @@ } ], "page": "/api-reference/sale/cashbox/sale-cashbox-handler-update.html", - "executable": false + "executable": false, + "requestExample": { + "ID": 1, + "FIELDS": { + "NAME": "Моя REST-касса с новым именем", + "SORT": 200, + "SETTINGS": { + "PRINT_URL": "http://setagaya.bx/receipt_print.php", + "CHECK_URL": "http://setagaya.bx/receipt_check.php", + "CONFIG": { + "AUTH": { + "LABEL": "Авторизация", + "ITEMS": { + "LOGIN": { + "TYPE": "STRING", + "REQUIRED": "Y", + "LABEL": "Логин" + }, + "PASSWORD": { + "TYPE": "STRING", + "REQUIRED": "Y", + "LABEL": "Пароль" + } + } + }, + "COMPANY": { + "LABEL": "Данные об организации", + "ITEMS": { + "INN": { + "TYPE": "STRING", + "REQUIRED": "Y", + "LABEL": "ИНН организации" + } + } + }, + "INTERACTION": { + "LABEL": "Настройки взаимодействия с кассой", + "ITEMS": { + "MODE": { + "TYPE": "ENUM", + "LABEL": "Режим работы с кассой", + "OPTIONS": { + "ACTIVE": "боевой", + "TEST": "тестовый" + } + } + } + } + }, + "SUPPORTS_FFD105": "N" + } + } + } } diff --git a/_assets/simulator/spec/methods/sale.cashbox.list.json b/_assets/simulator/spec/methods/sale.cashbox.list.json index 08a30a6c0..a9feeadb3 100644 --- a/_assets/simulator/spec/methods/sale.cashbox.list.json +++ b/_assets/simulator/spec/methods/sale.cashbox.list.json @@ -115,5 +115,18 @@ "OFD", "SORT", "USE_OFFLINE" - ] + ], + "requestExample": { + "SELECT": [ + "ID", + "NAME" + ], + "FILTER": { + "=NAME": "Моя Rest-касса", + ">ID": 9 + }, + "ORDER": { + "ID": "DESC" + } + } } diff --git a/_assets/simulator/spec/methods/sale.cashbox.update.json b/_assets/simulator/spec/methods/sale.cashbox.update.json index a6bcfc0e0..fc851af87 100644 --- a/_assets/simulator/spec/methods/sale.cashbox.update.json +++ b/_assets/simulator/spec/methods/sale.cashbox.update.json @@ -151,5 +151,11 @@ } ], "page": "/api-reference/sale/cashbox/sale-cashbox-update.html", - "executable": false + "executable": false, + "requestExample": { + "ID": 1, + "FIELDS": { + "NAME": "Новое имя" + } + } } diff --git a/_assets/simulator/spec/methods/sale.delivery.add.json b/_assets/simulator/spec/methods/sale.delivery.add.json index 0b90614ad..0346be6fc 100644 --- a/_assets/simulator/spec/methods/sale.delivery.add.json +++ b/_assets/simulator/spec/methods/sale.delivery.add.json @@ -179,5 +179,40 @@ } ], "page": "/api-reference/sale/delivery/delivery/sale-delivery-add.html", - "executable": false + "executable": false, + "requestExample": { + "REST_CODE": "uber", + "NAME": "Uber Taxi", + "CURRENCY": "RUB", + "DESCRIPTION": "Uber Taxi Description", + "SORT": "500", + "ACTIVE": "Y", + "CONFIG": [ + { + "CODE": "SETTING_1", + "VALUE": "SETTING_1 string value" + }, + { + "CODE": "SETTING_2", + "VALUE": "Y" + }, + { + "CODE": "SETTING_3", + "VALUE": 199.99 + }, + { + "CODE": "SETTING_4", + "VALUE": "Option3Code" + }, + { + "CODE": "SETTING_5", + "VALUE": "10.04.2024" + }, + { + "CODE": "SETTING_6", + "VALUE": "0000144961" + } + ], + "LOGOTYPE": "iVBORw0KGgoAAAANSUhEUgAAAMgAAADIBAMAAABfdrOtAAAAG1BMVEX37ff/­///58fn9+v3+/P779vv8+Pz47/j68/oDfe+3AAAACXBIWXMAAA7EAAAOxAGV­Kw4bAAABrUlEQVR4nO3UT0/CMBjH8ccx2I56IFynkHg1SgxHHCocSfQFGKP3­+e++xL1wn7bPUCAeKF5Mvp+EluX3ZN3ariIAAAAAAAAAAAAAAAAA/q2TwrXZ­ib94LTbj5GdgVbtKxhdXS+2uL270ajQbL9fz4WzcXwVWtbNeIdmt3qSQtwdJ­Ssku1/NHkfdVEKriHFey0G4haS3+ty4ZtEGoipMW+VS7T2m0zc+28tICq4rT­qXtuJV7kWdvsUJtuoc1Hm08ssKo4B1Wn1i6tJu5qrj9dA8lWEzOQEFhV3CCN­Tph2naJ0V+eu0SV+ry3WWQqBVcUNsgiP16ndS4SnzuffL5LWEgKrihqje7Y9­iDTN6mZ38geDNNX2dEm338b5XPafrmRuj/dj4fULfGoXeFTJ/guvayybW1i3­Vl7aM7h+3y2c+y07FfeZjaT9GHVrNYXPG/fkIbCqCPf+9d1WKiWtJSyP21r+­FaTrZ8+CULW7XliCUe0PyIUdkD29qQzdv7A0FoSq3R0fqaU78d0hPtw86hMX­99vAqqJlp757/W3vhMCqAAAAAAAAAAAAAAAAAPxbX82/SILlk9xf­AAAAAElFTkSuQmCC" + } } diff --git a/_assets/simulator/spec/methods/sale.delivery.config.get.json b/_assets/simulator/spec/methods/sale.delivery.config.get.json index 38cb0f3ef..c922d60e1 100644 --- a/_assets/simulator/spec/methods/sale.delivery.config.get.json +++ b/_assets/simulator/spec/methods/sale.delivery.config.get.json @@ -77,5 +77,8 @@ "entityFields": [ "CODE", "VALUE" - ] + ], + "requestExample": { + "ID": 196 + } } diff --git a/_assets/simulator/spec/methods/sale.delivery.config.update.json b/_assets/simulator/spec/methods/sale.delivery.config.update.json index 94fa990da..ad8f8d92c 100644 --- a/_assets/simulator/spec/methods/sale.delivery.config.update.json +++ b/_assets/simulator/spec/methods/sale.delivery.config.update.json @@ -80,5 +80,34 @@ } ], "page": "/api-reference/sale/delivery/delivery/sale-delivery-config-update.html", - "executable": false + "executable": false, + "requestExample": { + "ID": 196, + "CONFIG": [ + { + "CODE": "SETTING_1", + "VALUE": "New SETTING_1 string value" + }, + { + "CODE": "SETTING_2", + "VALUE": "N" + }, + { + "CODE": "SETTING_3", + "VALUE": 999.99 + }, + { + "CODE": "SETTING_4", + "VALUE": "Option2Code" + }, + { + "CODE": "SETTING_5", + "VALUE": "25.03.2023" + }, + { + "CODE": "SETTING_6", + "VALUE": "0000144962" + } + ] + } } diff --git a/_assets/simulator/spec/methods/sale.delivery.delete.json b/_assets/simulator/spec/methods/sale.delivery.delete.json index d2154314d..a0a6f44cd 100644 --- a/_assets/simulator/spec/methods/sale.delivery.delete.json +++ b/_assets/simulator/spec/methods/sale.delivery.delete.json @@ -48,5 +48,8 @@ } ], "page": "/api-reference/sale/delivery/delivery/sale-delivery-delete.html", - "executable": false + "executable": false, + "requestExample": { + "ID": 196 + } } diff --git a/_assets/simulator/spec/methods/sale.delivery.extra.service.add.json b/_assets/simulator/spec/methods/sale.delivery.extra.service.add.json index e972e795e..e9d66875a 100644 --- a/_assets/simulator/spec/methods/sale.delivery.extra.service.add.json +++ b/_assets/simulator/spec/methods/sale.delivery.extra.service.add.json @@ -160,5 +160,26 @@ } ], "page": "/api-reference/sale/delivery/extra-service/sale-delivery-extra-service-add.html", - "executable": false + "executable": false, + "requestExample": { + "DELIVERY_ID": 198, + "ACTIVE": "Y", + "CODE": "cargo_type", + "NAME": "Cargo Type", + "DESCRIPTION": "Cargo Type Description", + "TYPE": "enum", + "SORT": 100, + "ITEMS": [ + { + "TITLE": "Small Package(s)", + "CODE": "small_package", + "PRICE": 129.99 + }, + { + "TITLE": "Documents", + "CODE": "documents", + "PRICE": 69.99 + } + ] + } } diff --git a/_assets/simulator/spec/methods/sale.delivery.extra.service.delete.json b/_assets/simulator/spec/methods/sale.delivery.extra.service.delete.json index c73a10125..87e5269fb 100644 --- a/_assets/simulator/spec/methods/sale.delivery.extra.service.delete.json +++ b/_assets/simulator/spec/methods/sale.delivery.extra.service.delete.json @@ -48,5 +48,8 @@ } ], "page": "/api-reference/sale/delivery/extra-service/sale-delivery-extra-service-delete.html", - "executable": false + "executable": false, + "requestExample": { + "ID": 134 + } } diff --git a/_assets/simulator/spec/methods/sale.delivery.extra.service.get.json b/_assets/simulator/spec/methods/sale.delivery.extra.service.get.json index 263a09913..7f98c67a0 100644 --- a/_assets/simulator/spec/methods/sale.delivery.extra.service.get.json +++ b/_assets/simulator/spec/methods/sale.delivery.extra.service.get.json @@ -95,5 +95,8 @@ "PRICE", "SORT", "TYPE" - ] + ], + "requestExample": { + "DELIVERY_ID": 198 + } } diff --git a/_assets/simulator/spec/methods/sale.delivery.extra.service.update.json b/_assets/simulator/spec/methods/sale.delivery.extra.service.update.json index 6a7e71571..e38c1384b 100644 --- a/_assets/simulator/spec/methods/sale.delivery.extra.service.update.json +++ b/_assets/simulator/spec/methods/sale.delivery.extra.service.update.json @@ -139,5 +139,14 @@ } ], "page": "/api-reference/sale/delivery/extra-service/sale-delivery-extra-service-update.html", - "executable": false + "executable": false, + "requestExample": { + "ID": 128, + "ACTIVE": "N", + "CODE": "door_delivery", + "NAME": "Door Delivery New Name", + "DESCRIPTION": "Door Delivery New Description", + "SORT": 200, + "PRICE": 399.99 + } } diff --git a/_assets/simulator/spec/methods/sale.delivery.getlist.json b/_assets/simulator/spec/methods/sale.delivery.getlist.json index a34015202..18fa8c38c 100644 --- a/_assets/simulator/spec/methods/sale.delivery.getlist.json +++ b/_assets/simulator/spec/methods/sale.delivery.getlist.json @@ -112,5 +112,27 @@ } ], "page": "/api-reference/sale/delivery/delivery/sale-delivery-get-list.html", - "executable": false + "executable": false, + "requestExample": { + "SELECT": [ + "ID", + "PARENT_ID", + "NAME", + "ACTIVE", + "DESCRIPTION", + "SORT", + "CURRENCY" + ], + "FILTER": { + "@ID": [ + 196, + 197, + 198 + ] + }, + "ORDER": { + "SORT": "ASC", + "ID": "DESC" + } + } } diff --git a/_assets/simulator/spec/methods/sale.delivery.handler.delete.json b/_assets/simulator/spec/methods/sale.delivery.handler.delete.json index 9a77be8c4..dafc69dbd 100644 --- a/_assets/simulator/spec/methods/sale.delivery.handler.delete.json +++ b/_assets/simulator/spec/methods/sale.delivery.handler.delete.json @@ -48,5 +48,8 @@ } ], "page": "/api-reference/sale/delivery/handler/sale-delivery-handler-delete.html", - "executable": false + "executable": false, + "requestExample": { + "ID": 14 + } } diff --git a/_assets/simulator/spec/methods/sale.delivery.handler.list.json b/_assets/simulator/spec/methods/sale.delivery.handler.list.json index ec2ae62f6..07d11386f 100644 --- a/_assets/simulator/spec/methods/sale.delivery.handler.list.json +++ b/_assets/simulator/spec/methods/sale.delivery.handler.list.json @@ -11,7 +11,7 @@ "type": "sale_delivery_handler[]", "base": "array", "required": "unknown", - "description": "Массив объектов с информацией о выбранных обработчиках служб доставки", + "description": "Массив объектов с информацией об обработчиках служб доставки. Если обработчики не зарегистрированы, метод возвращает пустой массив", "dynamic": { "allowed": true, "note": "Состав полей не описан подтаблицей на этой странице" @@ -38,10 +38,10 @@ "resultExample": { "result": [ { - "ID": "14", + "ID": 14, "NAME": "Uber", "CODE": "uber", - "SORT": "250", + "SORT": 250, "DESCRIPTION": "Uber Description", "SETTINGS": { "CALCULATE_URL": "http://gateway.bx/calculate.php", @@ -117,7 +117,7 @@ "type": "sale_delivery_handler[]", "base": "array", "required": "unknown", - "description": "Массив объектов с информацией о выбранных обработчиках служб доставки" + "description": "Массив объектов с информацией об обработчиках служб доставки. Если обработчики не зарегистрированы, метод возвращает пустой массив" }, { "name": "time", @@ -137,5 +137,6 @@ "PROFILES", "SETTINGS", "SORT" - ] + ], + "requestExample": {} } diff --git a/_assets/simulator/spec/methods/sale.delivery.handler.update.json b/_assets/simulator/spec/methods/sale.delivery.handler.update.json index e0199d894..1c9a818b9 100644 --- a/_assets/simulator/spec/methods/sale.delivery.handler.update.json +++ b/_assets/simulator/spec/methods/sale.delivery.handler.update.json @@ -177,5 +177,69 @@ } ], "page": "/api-reference/sale/delivery/handler/sale-delivery-handler-update.html", - "executable": false + "executable": false, + "requestExample": { + "ID": 14, + "CODE": "uber", + "NAME": "New Uber", + "DESCRIPTION": "New Uber Description", + "SORT": 300, + "SETTINGS": { + "CALCULATE_URL": "https://gateway.bx/calculate.php", + "CREATE_DELIVERY_REQUEST_URL": "https://gateway.bx/create_delivery_request.php", + "CANCEL_DELIVERY_REQUEST_URL": "https://gateway.bx/cancel_delivery_request.php", + "HAS_CALLBACK_TRACKING_SUPPORT": "N", + "CONFIG": [ + { + "TYPE": "STRING", + "CODE": "SETTING_1", + "NAME": "String Example" + }, + { + "TYPE": "Y/N", + "CODE": "SETTING_2", + "NAME": "Checkbox Example" + }, + { + "TYPE": "NUMBER", + "CODE": "SETTING_3", + "NAME": "Number Example" + }, + { + "TYPE": "ENUM", + "CODE": "SETTING_4", + "NAME": "Enum Example", + "OPTIONS": { + "Option1Code": "Option1Value", + "Option2Code": "Option2Value", + "Option3Code": "Option3Value", + "Option4Code": "Option4Value", + "Option5Code": "Option5Value" + } + }, + { + "TYPE": "DATE", + "CODE": "SETTING_5", + "NAME": "Date Example" + }, + { + "TYPE": "LOCATION", + "CODE": "SETTING_6", + "NAME": "Location Example" + } + ] + }, + "PROFILES": [ + { + "NAME": "New Taxi", + "CODE": "TAXI", + "DESCRIPTION": "New Taxi Delivery" + }, + { + "NAME": "New Cargo", + "CODE": "CARGO", + "DESCRIPTION": "New Cargo Delivery" + } + ] + } } diff --git a/_assets/simulator/spec/methods/sale.delivery.request.delete.json b/_assets/simulator/spec/methods/sale.delivery.request.delete.json index 37c0720c6..914e27a0c 100644 --- a/_assets/simulator/spec/methods/sale.delivery.request.delete.json +++ b/_assets/simulator/spec/methods/sale.delivery.request.delete.json @@ -55,5 +55,9 @@ } ], "page": "/api-reference/sale/delivery/delivery-request/sale-delivery-request-delete.html", - "executable": false + "executable": false, + "requestExample": { + "DELIVERY_ID": 225, + "REQUEST_ID": "4757aca4931a4f029f49c0db4374d13d" + } } diff --git a/_assets/simulator/spec/methods/sale.delivery.request.sendmessage.json b/_assets/simulator/spec/methods/sale.delivery.request.sendmessage.json index c338395d7..450f9716b 100644 --- a/_assets/simulator/spec/methods/sale.delivery.request.sendmessage.json +++ b/_assets/simulator/spec/methods/sale.delivery.request.sendmessage.json @@ -118,5 +118,21 @@ } ], "page": "/api-reference/sale/delivery/delivery-request/sale-delivery-request-send-message.html", - "executable": false + "executable": false, + "requestExample": { + "DELIVERY_ID": 225, + "REQUEST_ID": "4757aca4931a4f029f49c0db4374d13d", + "ADDRESSEE": "MANAGER", + "MESSAGE": { + "SUBJECT": "Your order is on its way", + "BODY": "Estimated delivery price: #MONEY#", + "MONEY_VALUES": { + "#MONEY#": 351.2 + }, + "STATUS": { + "MESSAGE": "Success", + "SEMANTIC": "success" + } + } + } } diff --git a/_assets/simulator/spec/methods/sale.delivery.request.update.json b/_assets/simulator/spec/methods/sale.delivery.request.update.json index bc92a5fb2..9e4d52895 100644 --- a/_assets/simulator/spec/methods/sale.delivery.request.update.json +++ b/_assets/simulator/spec/methods/sale.delivery.request.update.json @@ -169,5 +169,34 @@ } ], "page": "/api-reference/sale/delivery/delivery-request/sale-delivery-request-update.html", - "executable": false + "executable": false, + "requestExample": { + "DELIVERY_ID": 225, + "REQUEST_ID": "4757aca4931a4f029f49c0db4374d13d", + "STATUS": { + "TEXT": "Performer found", + "SEMANTIC": "process" + }, + "PROPERTIES": [ + { + "NAME": "Car", + "VALUE": "Gray Skoda Octavia, a777zn" + }, + { + "NAME": "Driver", + "VALUE": "John Smith" + }, + { + "NAME": "Phone Number", + "VALUE": "+11111111111", + "TAGS": [ + "phone" + ] + }, + { + "NAME": "Something else", + "VALUE": "Some value" + } + ] + } } diff --git a/_assets/simulator/spec/methods/sale.order.add.json b/_assets/simulator/spec/methods/sale.order.add.json index da1769d1d..9287baa0f 100644 --- a/_assets/simulator/spec/methods/sale.order.add.json +++ b/_assets/simulator/spec/methods/sale.order.add.json @@ -11,7 +11,7 @@ "type": "object", "base": "object", "required": true, - "description": "Значения полей для создания заказа", + "description": "Значения полей для создания заказа (подробное описание)", "ref": "#/defs/fieldsFields" } ], @@ -28,28 +28,28 @@ "type": "string", "base": "string", "required": true, - "description": "Идентификатор сайта, на котором будет использоваться данный тип плательщика. Имеет постоянное значение 's1'" + "description": "Идентификатор сайта, к которому относится заказ. В облачном Битрикс24 передавайте s1. После создания заказа поле изменить нельзя" }, { "name": "personTypeId", "type": "sale_person_type.id", "base": "any", "required": true, - "description": "Идентификатор типа плательщика" + "description": "Идентификатор типа плательщика, например физического или юридического лица. Получите его методом sale.persontype.list. Метод не проверяет, что такой тип плательщика существует. После создания заказа поле изменить нельзя" }, { "name": "currency", "type": "string", "base": "string", "required": true, - "description": "Валюта. Список валют можно получить через метод crm.currency.list" + "description": "Код валюты, например RUB. Получите список валют методом crm.currency.list. После создания заказа поле изменить нельзя" }, { "name": "price", "type": "double", "base": "number", "required": false, - "description": "Цена" + "description": "Сумма заказа с учетом доставки" }, { "name": "discountValue", @@ -63,7 +63,7 @@ "type": "sale_status.id", "base": "any", "required": false, - "description": "Идентификатор статуса заказа" + "description": "Идентификатор статуса заказа. Получите список статусов методом sale.status.list. Если не передать поле, заказ получит начальный статус N" }, { "name": "empStatusId", @@ -84,7 +84,7 @@ "type": "string", "base": "string", "required": false, - "description": "Флаг маркировки. Признак того, является ли отгрузка отмеченной как проблемная. Значение Y ставится автоматически, если при сохранении произошла ошибка. - Y — да - N — нет По умолчанию устанавливается N" + "description": "Признак того, что заказ отмечен как проблемный. Битрикс24 ставит Y автоматически, если при сохранении заказа возникло предупреждение. Причину он записывает в поле reasonMarked. - Y — да - N — нет По умолчанию устанавливается N" }, { "name": "empMarkedId", @@ -98,7 +98,7 @@ "type": "string", "base": "string", "required": false, - "description": "Причина, по которой заказ был промаркирован" + "description": "Причина, по которой заказ отмечен как проблемный" }, { "name": "userDescription", @@ -121,6 +121,13 @@ "required": false, "description": "Комментарий менеджера к заказу" }, + { + "name": "companyId", + "type": "integer", + "base": "integer", + "required": false, + "description": "Идентификатор компании из модуля «Интернет-магазин»" + }, { "name": "responsibleId", "type": "user.id", @@ -130,15 +137,15 @@ }, { "name": "recurringId", - "type": "integer", - "base": "integer", + "type": "string", + "base": "string", "required": false, "description": "Идентификатор продления подписки" }, { "name": "lockedBy", - "type": "user.id", - "base": "any", + "type": "string", + "base": "string", "required": false, "description": "Актуально только для коробочной версии. Идентификатор пользователя, заблокировавшего заказ. Заказ блокируется в административной панели, когда пользователь открывает детальную карточку заказа" }, @@ -147,7 +154,7 @@ "type": "string", "base": "string", "required": false, - "description": "Устаревший. Флаг пересчёта. - Y — да - N — нет По умолчанию устанавливается Y" + "description": "Устаревший. Флаг пересчета. - Y — да - N — нет По умолчанию устанавливается Y" }, { "name": "affiliateId", @@ -161,7 +168,7 @@ "type": "string", "base": "string", "required": false, - "description": "Обновлён ли через 1С. - Y — да - N — нет По умолчанию устанавливается N" + "description": "Обновлен ли заказ через 1С. - Y — да - N — нет По умолчанию устанавливается N" }, { "name": "orderTopic", @@ -189,7 +196,7 @@ "type": "string", "base": "string", "required": false, - "description": "Версия в 1с" + "description": "Версия в 1С" }, { "name": "externalOrder", @@ -224,7 +231,7 @@ "type": "user.id", "base": "any", "required": false, - "description": "Идентификатор клиента" + "description": "Идентификатор покупателя. После создания заказа поле изменить нельзя" } ] } @@ -237,57 +244,68 @@ "resultExample": { "result": { "order": { - "accountNumber": "455", - "additionalInfo": "", - "affiliateId": 1, - "canceled": "Y", - "clients": [], - "comments": "", - "companyId": 1, + "accountNumber": "971", + "canceled": "N", + "clients": [ + { + "entityId": 2819, + "entityTypeId": 3, + "id": 1717, + "isPrimary": "Y", + "orderId": 971 + } + ], + "comments": "Заказ из интеграции с сайтом", "currency": "RUB", - "dateCanceled": "2024-04-12T13:50:21+03:00", - "dateInsert": "2024-03-01T13:00:00+03:00", - "dateMarked": "2024-04-12T13:50:21+03:00", - "dateStatus": "2024-04-12T13:50:21+03:00", - "dateUpdate": "2024-04-12T13:50:21+03:00", + "dateInsert": "2026-09-28T08:02:16+03:00", + "dateStatus": "2026-09-28T08:02:15+03:00", + "dateUpdate": "2026-09-28T08:02:16+03:00", "deducted": "N", - "discountValue": 10, - "empCanceledId": 1, - "empMarkedId": 1, "empStatusId": 1, - "externalOrder": "N", - "id": 299, - "id1c": "", + "id": 971, "lid": "s1", - "lockedBy": "1", - "marked": "Y", - "orderTopic": "", "payed": "N", "personTypeId": 1, "personTypeXmlId": "", - "price": 100, - "reasonCanceled": "", - "reasonMarked": "", - "recountFlag": "N", - "recurringId": "1", - "requisiteLink": [], + "propertyValues": [ + { + "code": "EMAIL", + "id": 11287, + "name": "E-Mail", + "orderPropsId": 41, + "orderPropsXmlId": "bx_60b605ba1d082" + }, + { + "code": "FIO", + "id": 11289, + "name": "Ф.И.О.", + "orderPropsId": 39, + "orderPropsXmlId": "bx_609bec7cc794c" + } + ], + "requisiteLink": { + "mcBankDetailId": 0, + "mcRequisiteId": 0, + "requisiteId": 467 + }, "responsibleId": 1, "statusId": "N", "statusXmlId": "", "updated1c": "N", - "userDescription": "", + "userDescription": "Позвоните перед доставкой", "userId": 1, - "version1c": "", - "xmlId": "" + "xmlId": "bx_6aba02e7a86af" } }, "time": { - "start": 1712922620.724857, - "finish": 1712922623.393783, - "duration": 2.6689260005950928, - "processing": 2.210068941116333, - "date_start": "2024-04-12T14:50:20+03:00", - "date_finish": "2024-04-12T14:50:23+03:00" + "start": 1790575335, + "finish": 1790575336.454058, + "duration": 1.4540579319000244, + "processing": 1, + "date_start": "2026-09-28T09:02:15+03:00", + "date_finish": "2026-09-28T09:02:16+03:00", + "operating_reset_at": 1790575935, + "operating": 0.7697091102600098 } }, "returns": [ @@ -296,14 +314,7 @@ "type": "object", "base": "object", "required": false, - "description": "Корневой элемент ответа" - }, - { - "name": "order", - "type": "sale_order", - "base": "any", - "required": false, - "description": "Объект с информацией о добавленном заказе" + "description": "Корневой элемент ответа (подробное описание)" }, { "name": "time", @@ -314,5 +325,17 @@ } ], "page": "/api-reference/sale/order/sale-order-add.html", - "executable": false + "executable": false, + "requestExample": { + "fields": { + "lid": "s1", + "personTypeId": 1, + "currency": "RUB", + "statusId": "N", + "userId": 1, + "responsibleId": 1, + "userDescription": "Позвоните перед доставкой", + "comments": "Заказ из интеграции с сайтом" + } + } } diff --git a/_assets/simulator/spec/methods/sale.order.delete.json b/_assets/simulator/spec/methods/sale.order.delete.json index 7de79729a..498a2b67d 100644 --- a/_assets/simulator/spec/methods/sale.order.delete.json +++ b/_assets/simulator/spec/methods/sale.order.delete.json @@ -3,7 +3,7 @@ "method": "sale.order.delete", "scope": "sale", "kind": "write", - "title": "Удалить заказ и связанные объекты sale.order.delete", + "title": "Удалить заказ sale.order.delete", "permissions": "администратор", "params": [ { @@ -11,7 +11,7 @@ "type": "sale_order.id", "base": "any", "required": true, - "description": "Идентификатор заказа" + "description": "Идентификатор заказа, который нужно удалить. Его возвращают методы sale.order.add и sale.order.list" } ], "defs": {}, @@ -37,7 +37,7 @@ "type": "boolean", "base": "boolean", "required": false, - "description": "Результат удаления заказа" + "description": "true, если заказ удален" }, { "name": "time", @@ -48,5 +48,8 @@ } ], "page": "/api-reference/sale/order/sale-order-delete.html", - "executable": false + "executable": false, + "requestExample": { + "id": 5 + } } diff --git a/_assets/simulator/spec/methods/sale.order.get.json b/_assets/simulator/spec/methods/sale.order.get.json index 49fd0e7fb..442301625 100644 --- a/_assets/simulator/spec/methods/sale.order.get.json +++ b/_assets/simulator/spec/methods/sale.order.get.json @@ -11,7 +11,7 @@ "type": "sale_order.id", "base": "any", "required": true, - "description": "Идентификатор заказа" + "description": "Идентификатор заказа. Его возвращают методы sale.order.add и sale.order.list. Не путайте с номером заказа accountNumber" } ], "defs": {}, @@ -336,14 +336,7 @@ "type": "object", "base": "object", "required": false, - "description": "Корневой элемент ответа" - }, - { - "name": "order", - "type": "sale_order", - "base": "any", - "required": false, - "description": "Информация о заказе" + "description": "Корневой элемент ответа (подробное описание)" }, { "name": "time", @@ -406,5 +399,8 @@ "version", "version1c", "xmlId" - ] + ], + "requestExample": { + "id": 236 + } } diff --git a/_assets/simulator/spec/methods/sale.order.getfields.json b/_assets/simulator/spec/methods/sale.order.getfields.json index 88c8b5100..c540b124f 100644 --- a/_assets/simulator/spec/methods/sale.order.getfields.json +++ b/_assets/simulator/spec/methods/sale.order.getfields.json @@ -1,9 +1,9 @@ { "$v": 1, - "method": "sale.order.getfields", + "method": "sale.order.getFields", "scope": "sale", "kind": "read", - "title": "Получить поля заказа sale.order.getfields", + "title": "Получить поля заказа sale.order.getFields", "permissions": "администратор", "params": [ { @@ -11,18 +11,7 @@ "type": "object", "base": "object", "required": "unknown", - "description": "Корневой элемент ответа", - "dynamic": { - "allowed": true, - "note": "Состав полей не описан подтаблицей на этой странице" - } - }, - { - "name": "order", - "type": "object", - "base": "object", - "required": "unknown", - "description": "Объект в формате {\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}. Где field — идентификатор поля объекта saleorder, а value — объект типа restfielddescription", + "description": "Корневой элемент ответа (подробное описание)", "dynamic": { "allowed": true, "note": "Состав полей не описан подтаблицей на этой странице" @@ -324,14 +313,7 @@ "type": "object", "base": "object", "required": "unknown", - "description": "Корневой элемент ответа" - }, - { - "name": "order", - "type": "object", - "base": "object", - "required": "unknown", - "description": "Объект в формате {\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}. Где field — идентификатор поля объекта saleorder, а value — объект типа restfielddescription" + "description": "Корневой элемент ответа (подробное описание)" }, { "name": "time", @@ -342,5 +324,6 @@ } ], "page": "/api-reference/sale/order/sale-order-get-fields.html", - "executable": false + "executable": false, + "requestExample": {} } diff --git a/_assets/simulator/spec/methods/sale.order.list.json b/_assets/simulator/spec/methods/sale.order.list.json index 9bb6f1e99..a8d3dfa9e 100644 --- a/_assets/simulator/spec/methods/sale.order.list.json +++ b/_assets/simulator/spec/methods/sale.order.list.json @@ -11,7 +11,7 @@ "type": "array", "base": "array", "required": "unknown", - "description": "Массив содержит список полей, которые необходимо выбрать (смотрите поля объекта saleorder). Если не передан или передан пустой массив, то будут выбраны все доступные поля заказов.", + "description": "Поля заказа, которые нужно вернуть. Имена полей — в объекте saleorder. Если параметр не передан, массив пуст или в нем нет ни одного существующего поля, метод вернет все поля заказа", "dynamic": { "allowed": true, "note": "Состав полей не описан подтаблицей на этой странице" @@ -22,7 +22,7 @@ "type": "object", "base": "object", "required": "unknown", - "description": "Объект для фильтрации выбранных заказов в формате {\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}. Возможные значения для field соответствуют полям объекта saleorder. Ключу может быть задан дополнительный префикс, уточняющий поведение фильтра.…", + "description": "Условия отбора заказов в формате {\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}, где field — поле объекта saleorder. К ключу можно добавить префикс, который задает условие сравнения: - = — равно, используется по умолчанию - != или ! — не равно - >= — больше либо равно - > — больше - <= — меньше либо равно - < — меньше - @ — входит в список, значение — массив - !@ — не входит в список, значение —…", "dynamic": { "allowed": true, "note": "Состав полей не описан подтаблицей на этой странице" @@ -33,17 +33,7 @@ "type": "object", "base": "object", "required": "unknown", - "description": "Объект для сортировки выбранных заказов в формате {\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}. Возможные значения для field соответствуют полям объекта saleorder. Возможные значения для order: - asc — в порядке возрастания - desc — в порядке убывания", - "values": [ - { - "value": "asc", - "title": "в порядке возрастания" - }, - { - "value": "desc", - "title": "в порядке убывания" - } - ], + "description": "Порядок сортировки в формате {\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}, где field — поле объекта saleorder, а order — направление: - asc — по возрастанию - desc — по убыванию Если параметр не передан, заказы идут по возрастанию id", "dynamic": { "allowed": true, "note": "Состав полей не описан подтаблицей на этой странице" @@ -54,7 +44,7 @@ "type": "integer", "base": "integer", "required": "unknown", - "description": "Параметр используется для управления постраничной навигацией. Размер страницы результатов всегда статичный: 50 записей. Чтобы выбрать вторую страницу результатов необходимо передавать значение 50. Чтобы выбрать третью страницу результатов значение — 100 и так далее. Формула расчета значения параметра start: start = (N-1) * 50, где N — номер нужной страницы" + "description": "Смещение для постраничной навигации. На странице до 50 заказов, размер страницы изменить нельзя. Значение считается по формуле start = (N-1) * 50, где N — номер страницы. Для второй страницы передайте 50. По умолчанию 0" } ], "defs": {}, @@ -63,27 +53,65 @@ "source": { "file": "api-reference/sale/order/sale-order-list.md" }, + "resultExample": { + "result": { + "orders": [ + { + "accountNumber": "923", + "currency": "RUB", + "dateInsert": "2026-09-23T09:06:07+03:00", + "id": 923, + "payed": "N", + "price": 300, + "statusId": "N", + "userId": 1 + }, + { + "accountNumber": "909", + "currency": "RUB", + "dateInsert": "2026-09-04T23:03:40+03:00", + "id": 909, + "payed": "N", + "price": 100.5, + "statusId": "N", + "userId": 1295 + } + ] + }, + "next": 50, + "total": 189, + "time": { + "start": 1790576208, + "finish": 1790576208.881895, + "duration": 0.8818950653076172, + "processing": 0, + "date_start": "2026-09-28T09:16:48+03:00", + "date_finish": "2026-09-28T09:16:48+03:00", + "operating_reset_at": 1790576808, + "operating": 0 + } + }, "returns": [ { "name": "result", "type": "object", "base": "object", "required": "unknown", - "description": "Корневой элемент ответа" + "description": "Корневой элемент ответа (подробное описание)" }, { - "name": "orders", - "type": "sale_order[]", - "base": "array", + "name": "total", + "type": "integer", + "base": "integer", "required": "unknown", - "description": "Массив объектов с информацией о выбранных заказах" + "description": "Общее количество заказов, подходящих под фильтр" }, { - "name": "total", + "name": "next", "type": "integer", "base": "integer", "required": "unknown", - "description": "Общее количество найденных записей" + "description": "Значение start для следующей страницы. Приходит, только если после текущей страницы есть еще заказы" }, { "name": "time", @@ -96,10 +124,12 @@ "page": "/api-reference/sale/order/sale-order-list.html", "executable": false, "entityFields": [ + "accountNumber", "additionalInfo", "affiliateId", "canceled", "comments", + "companyId", "currency", "dateInsert", "discountValue", @@ -107,11 +137,13 @@ "empMarkedId", "empStatusId", "externalOrder", + "id", "id1c", "lid", "lockedBy", "marked", "orderTopic", + "payed", "personTypeId", "price", "reasonCanceled", @@ -125,5 +157,29 @@ "userId", "version1c", "xmlId" - ] + ], + "requestExample": { + "select": [ + "id", + "accountNumber", + "statusId", + "price", + "currency", + "payed", + "dateInsert", + "userId" + ], + "filter": { + "quantity": 2 + }, + "order": { + "quantity": "desc" + } + } } diff --git a/_assets/simulator/spec/methods/sale.paymentitembasket.update.json b/_assets/simulator/spec/methods/sale.paymentitembasket.update.json index 9ab29e930..d2566e484 100644 --- a/_assets/simulator/spec/methods/sale.paymentitembasket.update.json +++ b/_assets/simulator/spec/methods/sale.paymentitembasket.update.json @@ -96,5 +96,12 @@ } ], "page": "/api-reference/sale/payment-item-basket/sale-payment-item-basket-update.html", - "executable": false + "executable": false, + "requestExample": { + "id": 1186, + "fields": { + "quantity": 1, + "xmlId": "myNewXmlId" + } + } } diff --git a/_assets/simulator/spec/methods/sale.paysystem.add.json b/_assets/simulator/spec/methods/sale.paysystem.add.json index a3bf2b002..9696a07ca 100644 --- a/_assets/simulator/spec/methods/sale.paysystem.add.json +++ b/_assets/simulator/spec/methods/sale.paysystem.add.json @@ -137,5 +137,30 @@ } ], "page": "/api-reference/pay-system/sale-pay-system-add.html", - "executable": false + "executable": false, + "requestExample": { + "NAME": "Оплата картой", + "DESCRIPTION": "Легко оплачивайте покупки картой.", + "XML_ID": "my_ps_id", + "PERSON_TYPE_ID": 1, + "BX_REST_HANDLER": "resthandlercode", + "ACTIVE": "Y", + "ENTITY_REGISTRY_TYPE": "ORDER", + "LOGOTYPE": "/* base64 image */", + "NEW_WINDOW": "N", + "SETTINGS": { + "REST_SERVICE_ID": { + "TYPE": "VALUE", + "VALUE": "SERVICE ID VALUE" + }, + "REST_SERVICE_KEY": { + "TYPE": "VALUE", + "VALUE": "KEY ID VALUE" + }, + "PAYMENT_ID": { + "TYPE": "PAYMENT", + "VALUE": "ACCOUNT_NUMBER" + } + } + } } diff --git a/_assets/simulator/spec/methods/sale.paysystem.delete.json b/_assets/simulator/spec/methods/sale.paysystem.delete.json index 6955dfbc5..a3f49555a 100644 --- a/_assets/simulator/spec/methods/sale.paysystem.delete.json +++ b/_assets/simulator/spec/methods/sale.paysystem.delete.json @@ -50,5 +50,8 @@ } ], "page": "/api-reference/pay-system/sale-pay-system-delete.html", - "executable": false + "executable": false, + "requestExample": { + "ID": 1 + } } diff --git a/_assets/simulator/spec/methods/sale.paysystem.handler.delete.json b/_assets/simulator/spec/methods/sale.paysystem.handler.delete.json index 3c4ee8fba..6e3afe8da 100644 --- a/_assets/simulator/spec/methods/sale.paysystem.handler.delete.json +++ b/_assets/simulator/spec/methods/sale.paysystem.handler.delete.json @@ -50,5 +50,8 @@ } ], "page": "/api-reference/pay-system/sale-pay-system-handler-delete.html", - "executable": false + "executable": false, + "requestExample": { + "ID": 1 + } } diff --git a/_assets/simulator/spec/methods/sale.paysystem.list.json b/_assets/simulator/spec/methods/sale.paysystem.list.json index 2e1dd3eb4..865d4b38a 100644 --- a/_assets/simulator/spec/methods/sale.paysystem.list.json +++ b/_assets/simulator/spec/methods/sale.paysystem.list.json @@ -166,5 +166,44 @@ "SORT", "TARIFF", "XML_ID" - ] + ], + "requestExample": { + "SELECT": [ + "ID", + "PERSON_TYPE_ID", + "NAME", + "PSA_NAME", + "SORT", + "DESCRIPTION", + "ACTION_FILE", + "RESULT_FILE", + "NEW_WINDOW", + "TARIF", + "PS_MODE", + "HAVE_PAYMENT", + "HAVE_ACTION", + "HAVE_RESULT", + "HAVE_PREPAY", + "HAVE_PRICE", + "HAVE_RESULT_RECEIVE", + "ENCODING", + "ACTIVE", + "ALLOW_EDIT_PAYMENT", + "IS_CASH", + "AUTO_CHANGE_1C", + "CAN_PRINT_CHECK", + "ENTITY_REGISTRY_TYPE", + "XML_ID" + ], + "FILTER": { + "@ID": [ + 117, + 118 + ] + }, + "ORDER": { + "SORT": "ASC", + "ID": "DESC" + } + } } diff --git a/_assets/simulator/spec/methods/sale.paysystem.pay.invoice.json b/_assets/simulator/spec/methods/sale.paysystem.pay.invoice.json index 15889e826..092505726 100644 --- a/_assets/simulator/spec/methods/sale.paysystem.pay.invoice.json +++ b/_assets/simulator/spec/methods/sale.paysystem.pay.invoice.json @@ -64,5 +64,9 @@ } ], "page": "/api-reference/pay-system/outdated/sale-pay-system-pay-invoice.html", - "executable": false + "executable": false, + "requestExample": { + "INVOICE_ID": 2, + "PAY_SYSTEM_ID": 31 + } } diff --git a/_assets/simulator/spec/methods/sale.paysystem.pay.payment.json b/_assets/simulator/spec/methods/sale.paysystem.pay.payment.json index 90f03c488..60ae1354e 100644 --- a/_assets/simulator/spec/methods/sale.paysystem.pay.payment.json +++ b/_assets/simulator/spec/methods/sale.paysystem.pay.payment.json @@ -57,5 +57,9 @@ } ], "page": "/api-reference/pay-system/sale-pay-system-pay-payment.html", - "executable": false + "executable": false, + "requestExample": { + "PAYMENT_ID": 1, + "PAY_SYSTEM_ID": 1 + } } diff --git a/_assets/simulator/spec/methods/sale.paysystem.settings.get.json b/_assets/simulator/spec/methods/sale.paysystem.settings.get.json index 09696f312..de768631f 100644 --- a/_assets/simulator/spec/methods/sale.paysystem.settings.get.json +++ b/_assets/simulator/spec/methods/sale.paysystem.settings.get.json @@ -66,5 +66,9 @@ "PS_WORK_MODE_IFRAME", "REST_SERVICE_ID_IFRAME", "REST_SERVICE_KEY_IFRAME" - ] + ], + "requestExample": { + "ID": 11, + "PERSON_TYPE_ID": 1 + } } diff --git a/_assets/simulator/spec/methods/sale.paysystem.settings.invoice.get.json b/_assets/simulator/spec/methods/sale.paysystem.settings.invoice.get.json index 6f76b25f9..3241022eb 100644 --- a/_assets/simulator/spec/methods/sale.paysystem.settings.invoice.get.json +++ b/_assets/simulator/spec/methods/sale.paysystem.settings.invoice.get.json @@ -73,5 +73,9 @@ "PS_WORK_MODE_IFRAME", "REST_SERVICE_ID_IFRAME", "REST_SERVICE_KEY_IFRAME" - ] + ], + "requestExample": { + "INVOICE_ID": 10, + "PAY_SYSTEM_ID": 11 + } } diff --git a/_assets/simulator/spec/methods/sale.paysystem.settings.payment.get.json b/_assets/simulator/spec/methods/sale.paysystem.settings.payment.get.json index 9ef03ca67..44b5d9acd 100644 --- a/_assets/simulator/spec/methods/sale.paysystem.settings.payment.get.json +++ b/_assets/simulator/spec/methods/sale.paysystem.settings.payment.get.json @@ -66,5 +66,9 @@ "PS_WORK_MODE_IFRAME", "REST_SERVICE_ID_IFRAME", "REST_SERVICE_KEY_IFRAME" - ] + ], + "requestExample": { + "PAYMENT_ID": 10, + "PAY_SYSTEM_ID": 11 + } } diff --git a/_assets/simulator/spec/methods/sale.paysystem.update.json b/_assets/simulator/spec/methods/sale.paysystem.update.json index 89faa0ef9..78850a644 100644 --- a/_assets/simulator/spec/methods/sale.paysystem.update.json +++ b/_assets/simulator/spec/methods/sale.paysystem.update.json @@ -144,5 +144,17 @@ } ], "page": "/api-reference/pay-system/sale-pay-system-update.html", - "executable": false + "executable": false, + "requestExample": { + "ID": 12, + "FIELDS": { + "NAME": "Новое название платёжной системы", + "DESCRIPTION": "Новое описание платёжной системы", + "PERSON_TYPE_ID": 1, + "BX_REST_HANDLER": "resthandlercode", + "ACTIVE": "Y", + "NEW_WINDOW": "N", + "LOGOTYPE": "/* base64 image */" + } + } } diff --git a/_assets/simulator/spec/methods/sale.persontype.add.json b/_assets/simulator/spec/methods/sale.persontype.add.json index bd2870ebe..61cc7bc41 100644 --- a/_assets/simulator/spec/methods/sale.persontype.add.json +++ b/_assets/simulator/spec/methods/sale.persontype.add.json @@ -111,5 +111,14 @@ } ], "page": "/api-reference/sale/person-type/sale-person-type-add.html", - "executable": false + "executable": false, + "requestExample": { + "fields": { + "name": "Физическое лицо", + "sort": "100", + "active": "Y", + "code": "MY_CRM_COMPANY", + "xmlId": "myXmlId" + } + } } diff --git a/_assets/simulator/spec/methods/sale.persontype.delete.json b/_assets/simulator/spec/methods/sale.persontype.delete.json index 143e865a5..d19e1190d 100644 --- a/_assets/simulator/spec/methods/sale.persontype.delete.json +++ b/_assets/simulator/spec/methods/sale.persontype.delete.json @@ -49,5 +49,8 @@ } ], "page": "/api-reference/sale/person-type/sale-person-type-delete.html", - "executable": false + "executable": false, + "requestExample": { + "id": 5 + } } diff --git a/_assets/simulator/spec/methods/sale.persontype.getFields.json b/_assets/simulator/spec/methods/sale.persontype.getFields.json index da5279991..21ac94356 100644 --- a/_assets/simulator/spec/methods/sale.persontype.getFields.json +++ b/_assets/simulator/spec/methods/sale.persontype.getFields.json @@ -121,5 +121,6 @@ } ], "page": "/api-reference/sale/person-type/sale-person-type-get-fields.html", - "executable": false + "executable": false, + "requestExample": {} } diff --git a/_assets/simulator/spec/methods/sale.persontype.list.json b/_assets/simulator/spec/methods/sale.persontype.list.json index 993d533a1..78a6ea0b7 100644 --- a/_assets/simulator/spec/methods/sale.persontype.list.json +++ b/_assets/simulator/spec/methods/sale.persontype.list.json @@ -130,5 +130,18 @@ "name", "sort", "xmlId" - ] + ], + "requestExample": { + "select": [ + "id", + "name", + "sort" + ], + "filter": { + "<=sort": 100 + }, + "order": { + "sort": "DESC" + } + } } diff --git a/_assets/simulator/spec/methods/sale.persontype.update.json b/_assets/simulator/spec/methods/sale.persontype.update.json index 70125ac9e..4fbb4822c 100644 --- a/_assets/simulator/spec/methods/sale.persontype.update.json +++ b/_assets/simulator/spec/methods/sale.persontype.update.json @@ -118,5 +118,11 @@ } ], "page": "/api-reference/sale/person-type/sale-person-type-update.html", - "executable": false + "executable": false, + "requestExample": { + "id": 12, + "fields": { + "name": "Юр. лицо" + } + } } diff --git a/_assets/simulator/spec/methods/sale.property.delete.json b/_assets/simulator/spec/methods/sale.property.delete.json index ac5c0cd4d..802f6bc55 100644 --- a/_assets/simulator/spec/methods/sale.property.delete.json +++ b/_assets/simulator/spec/methods/sale.property.delete.json @@ -48,5 +48,8 @@ } ], "page": "/api-reference/sale/property/sale-property-delete.html", - "executable": false + "executable": false, + "requestExample": { + "id": 57 + } } diff --git a/_assets/simulator/spec/methods/sale.property.get.json b/_assets/simulator/spec/methods/sale.property.get.json index 1efe6caaa..8d789f040 100644 --- a/_assets/simulator/spec/methods/sale.property.get.json +++ b/_assets/simulator/spec/methods/sale.property.get.json @@ -116,5 +116,8 @@ "userProps", "util", "xmlId" - ] + ], + "requestExample": { + "id": 22 + } } diff --git a/_assets/simulator/spec/methods/sale.property.getfieldsbytype.json b/_assets/simulator/spec/methods/sale.property.getfieldsbytype.json index 19f8fbe04..7fd6ffb2e 100644 --- a/_assets/simulator/spec/methods/sale.property.getfieldsbytype.json +++ b/_assets/simulator/spec/methods/sale.property.getfieldsbytype.json @@ -180,5 +180,8 @@ } ], "page": "/api-reference/sale/property/sale-property-get-fields-by-type.html", - "executable": false + "executable": false, + "requestExample": { + "type": "NUMBER" + } } diff --git a/_assets/simulator/spec/methods/sale.property.list.json b/_assets/simulator/spec/methods/sale.property.list.json index 52fb6ee99..c5e7879c2 100644 --- a/_assets/simulator/spec/methods/sale.property.list.json +++ b/_assets/simulator/spec/methods/sale.property.list.json @@ -229,5 +229,44 @@ "userProps", "util", "xmlId" - ] + ], + "requestExample": { + "select": [ + "id", + "active", + "code", + "defaultValue", + "description", + "inputFieldLocation", + "isAddress", + "isAddressFrom", + "isAddressTo", + "isEmail", + "isFiltered", + "isLocation", + "isLocation4tax", + "isPayer", + "isPhone", + "isProfileName", + "isZip", + "multiple", + "name", + "personTypeId", + "propsGroupId", + "required", + "settings", + "sort", + "type", + "userProps", + "util", + "xmlId" + ], + "filter": { + "@type": "STRING", + "%code": "EMAIL" + }, + "order": { + "id": "desc" + } + } } diff --git a/_assets/simulator/spec/methods/sale.propertyRelation.add.json b/_assets/simulator/spec/methods/sale.propertyRelation.add.json index 5200ab7a0..dfc4be9e9 100644 --- a/_assets/simulator/spec/methods/sale.propertyRelation.add.json +++ b/_assets/simulator/spec/methods/sale.propertyRelation.add.json @@ -93,5 +93,12 @@ } ], "page": "/api-reference/sale/property-relation/sale-property-relation-add.html", - "executable": false + "executable": false, + "requestExample": { + "fields": { + "entityId": 6, + "entityType": "D", + "propertyId": 40 + } + } } diff --git a/_assets/simulator/spec/methods/sale.propertyRelation.deleteByFilter.json b/_assets/simulator/spec/methods/sale.propertyRelation.deleteByFilter.json index 50edbcead..53ec4f398 100644 --- a/_assets/simulator/spec/methods/sale.propertyRelation.deleteByFilter.json +++ b/_assets/simulator/spec/methods/sale.propertyRelation.deleteByFilter.json @@ -80,5 +80,12 @@ } ], "page": "/api-reference/sale/property-relation/sale-property-relation-delete-by-filter.html", - "executable": false + "executable": false, + "requestExample": { + "fields": { + "entityId": 6, + "entityType": "D", + "propertyId": 40 + } + } } diff --git a/_assets/simulator/spec/methods/sale.propertyRelation.getFields.json b/_assets/simulator/spec/methods/sale.propertyRelation.getFields.json index cf57dbca1..736458351 100644 --- a/_assets/simulator/spec/methods/sale.propertyRelation.getFields.json +++ b/_assets/simulator/spec/methods/sale.propertyRelation.getFields.json @@ -102,5 +102,6 @@ } ], "page": "/api-reference/sale/property-relation/sale-property-relation-get-fields.html", - "executable": false + "executable": false, + "requestExample": {} } diff --git a/_assets/simulator/spec/methods/sale.propertyRelation.list.json b/_assets/simulator/spec/methods/sale.propertyRelation.list.json index f7b242bf5..48b92a2e5 100644 --- a/_assets/simulator/spec/methods/sale.propertyRelation.list.json +++ b/_assets/simulator/spec/methods/sale.propertyRelation.list.json @@ -99,5 +99,18 @@ "entityId", "entityType", "propertyId" - ] + ], + "requestExample": { + "select": [ + "entityId", + "entityType", + "propertyId" + ], + "filter": { + "entityId": 6 + }, + "order": { + "entityId": "asc" + } + } } diff --git a/_assets/simulator/spec/methods/sale.propertygroup.add.json b/_assets/simulator/spec/methods/sale.propertygroup.add.json index 8e9c4a3ab..9adf9d096 100644 --- a/_assets/simulator/spec/methods/sale.propertygroup.add.json +++ b/_assets/simulator/spec/methods/sale.propertygroup.add.json @@ -94,5 +94,12 @@ } ], "page": "/api-reference/sale/property-group/sale-property-group-add.html", - "executable": false + "executable": false, + "requestExample": { + "fields": { + "personTypeId": 3, + "name": "Новая группа свойств", + "sort": 100 + } + } } diff --git a/_assets/simulator/spec/methods/sale.propertygroup.delete.json b/_assets/simulator/spec/methods/sale.propertygroup.delete.json index 67452b720..d9fbaeec9 100644 --- a/_assets/simulator/spec/methods/sale.propertygroup.delete.json +++ b/_assets/simulator/spec/methods/sale.propertygroup.delete.json @@ -48,5 +48,8 @@ } ], "page": "/api-reference/sale/property-group/sale-property-group-delete.html", - "executable": false + "executable": false, + "requestExample": { + "id": 15 + } } diff --git a/_assets/simulator/spec/methods/sale.propertygroup.get.json b/_assets/simulator/spec/methods/sale.propertygroup.get.json index fc3065865..6bec06229 100644 --- a/_assets/simulator/spec/methods/sale.propertygroup.get.json +++ b/_assets/simulator/spec/methods/sale.propertygroup.get.json @@ -68,5 +68,8 @@ "name", "personTypeId", "sort" - ] + ], + "requestExample": { + "id": 10 + } } diff --git a/_assets/simulator/spec/methods/sale.propertygroup.getFields.json b/_assets/simulator/spec/methods/sale.propertygroup.getFields.json index 8202bc1e5..db000f5e9 100644 --- a/_assets/simulator/spec/methods/sale.propertygroup.getFields.json +++ b/_assets/simulator/spec/methods/sale.propertygroup.getFields.json @@ -108,5 +108,6 @@ } ], "page": "/api-reference/sale/property-group/sale-property-group-get-fields.html", - "executable": false + "executable": false, + "requestExample": {} } diff --git a/_assets/simulator/spec/methods/sale.propertygroup.list.json b/_assets/simulator/spec/methods/sale.propertygroup.list.json index f50691852..84d00a44f 100644 --- a/_assets/simulator/spec/methods/sale.propertygroup.list.json +++ b/_assets/simulator/spec/methods/sale.propertygroup.list.json @@ -113,5 +113,20 @@ "name", "personTypeId", "sort" - ] + ], + "requestExample": { + "select": [ + "id", + "name", + "personTypeId", + "sort" + ], + "filter": { + ">=id": 14 + }, + "order": { + "name": "asc", + "id": "desc" + } + } } diff --git a/_assets/simulator/spec/methods/sale.propertygroup.update.json b/_assets/simulator/spec/methods/sale.propertygroup.update.json index 09c1d44ac..119c5fc5c 100644 --- a/_assets/simulator/spec/methods/sale.propertygroup.update.json +++ b/_assets/simulator/spec/methods/sale.propertygroup.update.json @@ -73,5 +73,13 @@ } ], "page": "/api-reference/sale/property-group/sale-property-group-update.html", - "executable": false + "executable": false, + "requestExample": { + "id": 10, + "fields": { + "personTypeId": 3, + "name": "Обновленная группа свойств", + "sort": 100 + } + } } diff --git a/_assets/simulator/spec/methods/sale.propertyvalue.delete.json b/_assets/simulator/spec/methods/sale.propertyvalue.delete.json index 8e5cd8212..41c6f7055 100644 --- a/_assets/simulator/spec/methods/sale.propertyvalue.delete.json +++ b/_assets/simulator/spec/methods/sale.propertyvalue.delete.json @@ -48,5 +48,8 @@ } ], "page": "/api-reference/sale/property-value/sale-property-value-delete.html", - "executable": false + "executable": false, + "requestExample": { + "id": 5 + } } diff --git a/_assets/simulator/spec/methods/sale.propertyvalue.get.json b/_assets/simulator/spec/methods/sale.propertyvalue.get.json index c489ad768..4f0489ae5 100644 --- a/_assets/simulator/spec/methods/sale.propertyvalue.get.json +++ b/_assets/simulator/spec/methods/sale.propertyvalue.get.json @@ -70,5 +70,8 @@ "name", "orderPropsId", "value" - ] + ], + "requestExample": { + "id": 13176 + } } diff --git a/_assets/simulator/spec/methods/sale.propertyvalue.getfields.json b/_assets/simulator/spec/methods/sale.propertyvalue.getfields.json index 148b4b5e4..11e0367c3 100644 --- a/_assets/simulator/spec/methods/sale.propertyvalue.getfields.json +++ b/_assets/simulator/spec/methods/sale.propertyvalue.getfields.json @@ -126,5 +126,6 @@ } ], "page": "/api-reference/sale/property-value/sale-property-value-get-fields.html", - "executable": false + "executable": false, + "requestExample": {} } diff --git a/_assets/simulator/spec/methods/sale.propertyvalue.list.json b/_assets/simulator/spec/methods/sale.propertyvalue.list.json index 95a0fa1cc..7b54d7b68 100644 --- a/_assets/simulator/spec/methods/sale.propertyvalue.list.json +++ b/_assets/simulator/spec/methods/sale.propertyvalue.list.json @@ -183,5 +183,24 @@ "orderPropsId", "orderPropsXmlId", "value" - ] + ], + "requestExample": { + "select": [ + "code", + "id", + "name", + "orderId", + "orderPropsId", + "orderPropsXmlId", + "value" + ], + "filter": { + "=code": "FIO", + "%value": "Борис", + ">orderId": 1600 + }, + "order": { + "orderId": "desc" + } + } } diff --git a/_assets/simulator/spec/methods/sale.propertyvalue.modify.json b/_assets/simulator/spec/methods/sale.propertyvalue.modify.json index c39e22580..9b13aac42 100644 --- a/_assets/simulator/spec/methods/sale.propertyvalue.modify.json +++ b/_assets/simulator/spec/methods/sale.propertyvalue.modify.json @@ -165,5 +165,50 @@ } ], "page": "/api-reference/sale/property-value/sale-property-value-modify.html", - "executable": false + "executable": false, + "requestExample": { + "fields": { + "order": { + "id": 2066, + "propertyValues": [ + { + "orderPropsId": 20, + "value": "John Smith" + }, + { + "orderPropsId": 21, + "value": "johnsmith@example.com" + }, + { + "orderPropsId": 22, + "value": "+10907996161" + }, + { + "orderPropsId": 25, + "value": "0000073738" + }, + { + "orderPropsId": 26, + "value": "900 S Holland Ave, Springfield, MO 65806, United States" + }, + { + "orderPropsId": 51, + "value": "17.04.2024" + }, + { + "orderPropsId": 52, + "value": "Y" + }, + { + "orderPropsId": 53, + "value": "948" + }, + { + "orderPropsId": 54, + "value": "10" + } + ] + } + } + } } diff --git a/_assets/simulator/spec/methods/sale.propertyvariant.add.json b/_assets/simulator/spec/methods/sale.propertyvariant.add.json index 567d826a8..245cd372c 100644 --- a/_assets/simulator/spec/methods/sale.propertyvariant.add.json +++ b/_assets/simulator/spec/methods/sale.propertyvariant.add.json @@ -110,5 +110,14 @@ } ], "page": "/api-reference/sale/property-variant/sale-property-variant-add.html", - "executable": false + "executable": false, + "requestExample": { + "fields": { + "name": "Красный", + "orderPropsId": 49, + "value": "red", + "sort": 10, + "description": "Описание значения для красного цвета" + } + } } diff --git a/_assets/simulator/spec/methods/sale.propertyvariant.delete.json b/_assets/simulator/spec/methods/sale.propertyvariant.delete.json index a99096e1b..eab632906 100644 --- a/_assets/simulator/spec/methods/sale.propertyvariant.delete.json +++ b/_assets/simulator/spec/methods/sale.propertyvariant.delete.json @@ -48,5 +48,8 @@ } ], "page": "/api-reference/sale/property-variant/sale-property-variant-delete.html", - "executable": false + "executable": false, + "requestExample": { + "id": 5 + } } diff --git a/_assets/simulator/spec/methods/sale.propertyvariant.get.json b/_assets/simulator/spec/methods/sale.propertyvariant.get.json index 7c632c967..a9ff61a32 100644 --- a/_assets/simulator/spec/methods/sale.propertyvariant.get.json +++ b/_assets/simulator/spec/methods/sale.propertyvariant.get.json @@ -72,5 +72,8 @@ "orderPropsId", "sort", "value" - ] + ], + "requestExample": { + "id": 6 + } } diff --git a/_assets/simulator/spec/methods/sale.propertyvariant.getFields.json b/_assets/simulator/spec/methods/sale.propertyvariant.getFields.json index 643c16a3f..43847bb8e 100644 --- a/_assets/simulator/spec/methods/sale.propertyvariant.getFields.json +++ b/_assets/simulator/spec/methods/sale.propertyvariant.getFields.json @@ -126,5 +126,6 @@ } ], "page": "/api-reference/sale/property-variant/sale-property-variant-get-fields.html", - "executable": false + "executable": false, + "requestExample": {} } diff --git a/_assets/simulator/spec/methods/sale.propertyvariant.list.json b/_assets/simulator/spec/methods/sale.propertyvariant.list.json index ee5e8f530..b2148614e 100644 --- a/_assets/simulator/spec/methods/sale.propertyvariant.list.json +++ b/_assets/simulator/spec/methods/sale.propertyvariant.list.json @@ -127,5 +127,20 @@ "orderPropsId", "sort", "value" - ] + ], + "requestExample": { + "select": [ + "id", + "name", + "orderPropsId", + "value" + ], + "filter": { + ">=id": 5 + }, + "order": { + "orderPropsId": "desc", + "id": "asc" + } + } } diff --git a/_assets/simulator/spec/methods/sale.propertyvariant.update.json b/_assets/simulator/spec/methods/sale.propertyvariant.update.json index 90aa9bae6..8dc85327e 100644 --- a/_assets/simulator/spec/methods/sale.propertyvariant.update.json +++ b/_assets/simulator/spec/methods/sale.propertyvariant.update.json @@ -110,5 +110,14 @@ } ], "page": "/api-reference/sale/property-variant/sale-property-variant-update.html", - "executable": false + "executable": false, + "requestExample": { + "id": 5, + "fields": { + "name": "Красный", + "value": "red", + "sort": 10, + "description": "Новое описание значения для красного цвета" + } + } } diff --git a/_assets/simulator/spec/methods/sale.shipment.add.json b/_assets/simulator/spec/methods/sale.shipment.add.json index 73ec3d71c..3eaafcab8 100644 --- a/_assets/simulator/spec/methods/sale.shipment.add.json +++ b/_assets/simulator/spec/methods/sale.shipment.add.json @@ -211,5 +211,21 @@ } ], "page": "/api-reference/sale/shipment/sale-shipment-add.html", - "executable": false + "executable": false, + "requestExample": { + "fields": { + "orderId": 2068, + "allowDelivery": "Y", + "deducted": "Y", + "deliveryId": 2, + "statusId": "DN", + "deliveryDocDate": "2024-02-13T14:05:48", + "deliveryDocNum": "DocumentNumber123456", + "trackingNumber": "trackingNumber", + "basePriceDelivery": 999.99, + "comments": "My comment for manager", + "responsibleId": 25, + "xmlId": "myXmlId" + } + } } diff --git a/_assets/simulator/spec/methods/sale.shipment.delete.json b/_assets/simulator/spec/methods/sale.shipment.delete.json index ce09886be..df81c3a02 100644 --- a/_assets/simulator/spec/methods/sale.shipment.delete.json +++ b/_assets/simulator/spec/methods/sale.shipment.delete.json @@ -48,5 +48,8 @@ } ], "page": "/api-reference/sale/shipment/sale-shipment-delete.html", - "executable": false + "executable": false, + "requestExample": { + "id": 2461 + } } diff --git a/_assets/simulator/spec/methods/sale.shipment.get.json b/_assets/simulator/spec/methods/sale.shipment.get.json index cbd37a099..0b6c69625 100644 --- a/_assets/simulator/spec/methods/sale.shipment.get.json +++ b/_assets/simulator/spec/methods/sale.shipment.get.json @@ -162,5 +162,8 @@ "updated1c", "version1c", "xmlId" - ] + ], + "requestExample": { + "id": 2465 + } } diff --git a/_assets/simulator/spec/methods/sale.shipment.getFields.json b/_assets/simulator/spec/methods/sale.shipment.getFields.json index 7dc8d8532..9a11e9bec 100644 --- a/_assets/simulator/spec/methods/sale.shipment.getFields.json +++ b/_assets/simulator/spec/methods/sale.shipment.getFields.json @@ -354,5 +354,6 @@ } ], "page": "/api-reference/sale/shipment/sale-shipment-get-fields.html", - "executable": false + "executable": false, + "requestExample": {} } diff --git a/_assets/simulator/spec/methods/sale.shipment.list.json b/_assets/simulator/spec/methods/sale.shipment.list.json index 28d0370db..8d8cf3eff 100644 --- a/_assets/simulator/spec/methods/sale.shipment.list.json +++ b/_assets/simulator/spec/methods/sale.shipment.list.json @@ -250,5 +250,64 @@ "updated1c", "version1c", "xmlId" - ] + ], + "requestExample": { + "select": [ + "id", + "accountNumber", + "allowDelivery", + "basePriceDelivery", + "canceled", + "comments", + "companyId", + "currency", + "customPriceDelivery", + "dateAllowDelivery", + "dateCanceled", + "dateDeducted", + "dateInsert", + "dateMarked", + "dateResponsibleId", + "deducted", + "deliveryDocDate", + "deliveryDocNum", + "deliveryId", + "deliveryName", + "deliveryXmlId", + "discountPrice", + "empAllowDeliveryId", + "empCanceledId", + "empDeductedId", + "empMarkedId", + "empResponsibleId", + "externalDelivery", + "id1c", + "marked", + "orderId", + "priceDelivery", + "reasonMarked", + "reasonUndoDeducted", + "responsibleId", + "statusId", + "statusXmlId", + "system", + "trackingDescription", + "trackingLastCheck", + "trackingNumber", + "trackingStatus", + "updated1c", + "version1c", + "xmlId" + ], + "filter": { + "@orderId": [ + 2069, + 2070 + ], + ">=id": 2464 + }, + "order": { + "id": "desc" + } + } } diff --git a/_assets/simulator/spec/methods/sale.shipment.update.json b/_assets/simulator/spec/methods/sale.shipment.update.json index a68fa9ad6..44f041bc3 100644 --- a/_assets/simulator/spec/methods/sale.shipment.update.json +++ b/_assets/simulator/spec/methods/sale.shipment.update.json @@ -233,5 +233,21 @@ } ], "page": "/api-reference/sale/shipment/sale-shipment-update.html", - "executable": false + "executable": false, + "requestExample": { + "id": 2452, + "fields": { + "allowDelivery": "N", + "deducted": "N", + "deliveryId": 3, + "statusId": "DD", + "deliveryDocDate": "2024-02-13T15:05:49", + "deliveryDocNum": "MyDocumentNumber", + "trackingNumber": "MyTrackingNumber", + "basePriceDelivery": 1999.99, + "comments": "My new comment for manager", + "responsibleId": 1, + "xmlId": "myNewXmlId" + } + } } diff --git a/_assets/simulator/spec/methods/sale.shipmentitem.add.json b/_assets/simulator/spec/methods/sale.shipmentitem.add.json index 2d9af01a8..fbe46901d 100644 --- a/_assets/simulator/spec/methods/sale.shipmentitem.add.json +++ b/_assets/simulator/spec/methods/sale.shipmentitem.add.json @@ -104,5 +104,12 @@ } ], "page": "/api-reference/sale/shipment-item/sale-shipment-item-add.html", - "executable": false + "executable": false, + "requestExample": { + "fields": { + "orderDeliveryId": 33, + "basketId": 18, + "quantity": 1 + } + } } diff --git a/_assets/simulator/spec/methods/sale.shipmentitem.delete.json b/_assets/simulator/spec/methods/sale.shipmentitem.delete.json index 4ea17dca8..d0c85e939 100644 --- a/_assets/simulator/spec/methods/sale.shipmentitem.delete.json +++ b/_assets/simulator/spec/methods/sale.shipmentitem.delete.json @@ -48,5 +48,8 @@ } ], "page": "/api-reference/sale/shipment-item/sale-shipment-item-delete.html", - "executable": false + "executable": false, + "requestExample": { + "id": 5 + } } diff --git a/_assets/simulator/spec/methods/sale.shipmentitem.get.json b/_assets/simulator/spec/methods/sale.shipmentitem.get.json index b20363f31..7fd97f629 100644 --- a/_assets/simulator/spec/methods/sale.shipmentitem.get.json +++ b/_assets/simulator/spec/methods/sale.shipmentitem.get.json @@ -74,5 +74,8 @@ "quantity", "reservedQuantity", "xmlId" - ] + ], + "requestExample": { + "id": 7 + } } diff --git a/_assets/simulator/spec/methods/sale.shipmentitem.getFields.json b/_assets/simulator/spec/methods/sale.shipmentitem.getFields.json index 26c1b1768..2b54d083d 100644 --- a/_assets/simulator/spec/methods/sale.shipmentitem.getFields.json +++ b/_assets/simulator/spec/methods/sale.shipmentitem.getFields.json @@ -126,5 +126,6 @@ } ], "page": "/api-reference/sale/shipment-item/sale-shipment-item-get-fields.html", - "executable": false + "executable": false, + "requestExample": {} } diff --git a/_assets/simulator/spec/methods/sale.shipmentitem.list.json b/_assets/simulator/spec/methods/sale.shipmentitem.list.json index 39a530ffe..9f6e22f2d 100644 --- a/_assets/simulator/spec/methods/sale.shipmentitem.list.json +++ b/_assets/simulator/spec/methods/sale.shipmentitem.list.json @@ -136,5 +136,27 @@ "quantity", "reservedQuantity", "xmlId" - ] + ], + "requestExample": { + "select": [ + "id", + "orderDeliveryId", + "basketId", + "quantity", + "xmlId", + "dateInsert", + "reservedQuantity" + ], + "filter": { + "=POST_DATE": "2025-01-01" + } + } } diff --git a/_assets/simulator/spec/methods/task.commentitem.update.json b/_assets/simulator/spec/methods/task.commentitem.update.json index 98e1d426e..3752f0622 100644 --- a/_assets/simulator/spec/methods/task.commentitem.update.json +++ b/_assets/simulator/spec/methods/task.commentitem.update.json @@ -92,5 +92,15 @@ } ], "page": "/api-reference/tasks/comment-item/task-comment-item-update.html", - "executable": false + "executable": false, + "requestExample": { + "TASKID": 8017, + "ITEMID": 3167, + "FIELDS": { + "POST_MESSAGE": "Комментарий обновлен", + "UF_FORUM_MESSAGE_DOC": [ + "n4755" + ] + } + } } diff --git a/_assets/simulator/spec/methods/task.dependence.add.json b/_assets/simulator/spec/methods/task.dependence.add.json index 169e7cc70..536364298 100644 --- a/_assets/simulator/spec/methods/task.dependence.add.json +++ b/_assets/simulator/spec/methods/task.dependence.add.json @@ -51,5 +51,10 @@ } ], "page": "/api-reference/tasks/task-dependence-add.html", - "executable": false + "executable": false, + "requestExample": { + "taskIdFrom": 100, + "taskIdTo": 101, + "linkType": 0 + } } diff --git a/_assets/simulator/spec/methods/task.dependence.delete.json b/_assets/simulator/spec/methods/task.dependence.delete.json index 97ef27a20..5ce9674d7 100644 --- a/_assets/simulator/spec/methods/task.dependence.delete.json +++ b/_assets/simulator/spec/methods/task.dependence.delete.json @@ -44,5 +44,9 @@ } ], "page": "/api-reference/tasks/task-dependence-delete.html", - "executable": false + "executable": false, + "requestExample": { + "taskIdFrom": 100, + "taskIdTo": 101 + } } diff --git a/_assets/simulator/spec/methods/task.elapseditem.add.json b/_assets/simulator/spec/methods/task.elapseditem.add.json index e543376ca..fb69d5d88 100644 --- a/_assets/simulator/spec/methods/task.elapseditem.add.json +++ b/_assets/simulator/spec/methods/task.elapseditem.add.json @@ -4,7 +4,7 @@ "scope": "task", "kind": "write", "title": "Добавить запись о затраченном времени task.elapseditem.add", - "permissions": "любой пользователь", + "permissions": "пользователь с правом учета затраченного времени в задаче", "params": [ { "name": "TASKID", @@ -18,7 +18,7 @@ "type": "object", "base": "object", "required": true, - "description": "Объект, содержащий записи о пользователе, времени и комментарии (подробное описание приведено ниже) в виде структуры:", + "description": "Поля записи о затраченном времени (подробное описание)", "ref": "#/defs/ARFIELDSFields" } ], @@ -41,7 +41,7 @@ "name": "COMMENT_TEXT", "type": "string", "base": "string", - "required": true, + "required": false, "description": "Текст комментария" }, { @@ -49,7 +49,35 @@ "type": "integer", "base": "integer", "required": false, - "description": "Идентификатор пользователя" + "description": "Идентификатор автора записи. По умолчанию — идентификатор текущего пользователя. Передать идентификатор другого пользователя нельзя" + }, + { + "name": "CREATED_DATE", + "type": "datetime", + "base": "datetime", + "required": false, + "description": "Дата создания записи. По умолчанию — текущие дата и время" + }, + { + "name": "DATE_START", + "type": "datetime", + "base": "datetime", + "required": false, + "description": "Дата и время начала учета" + }, + { + "name": "DATE_STOP", + "type": "datetime", + "base": "datetime", + "required": false, + "description": "Дата и время завершения учета" + }, + { + "name": "SOURCE", + "type": "integer", + "base": "integer", + "required": false, + "description": "Источник записи. Метод всегда сохраняет значение 2 — запись добавлена вручную. Переданное значение заменяется на 2" } ] } @@ -87,5 +115,12 @@ } ], "page": "/api-reference/tasks/elapsed-item/task-elapsed-item-add.html", - "executable": false + "executable": false, + "requestExample": { + "TASKID": 691, + "ARFIELDS": { + "SECONDS": 113, + "COMMENT_TEXT": "текст комментария" + } + } } diff --git a/_assets/simulator/spec/methods/task.elapseditem.delete.json b/_assets/simulator/spec/methods/task.elapseditem.delete.json index 2d9202941..ef2a869bf 100644 --- a/_assets/simulator/spec/methods/task.elapseditem.delete.json +++ b/_assets/simulator/spec/methods/task.elapseditem.delete.json @@ -4,7 +4,7 @@ "scope": "task", "kind": "write", "title": "Удалить запись о затраченном времени task.elapseditem.delete", - "permissions": "любой пользователь", + "permissions": "автор записи или администратор с доступом к задаче", "params": [ { "name": "TASKID", @@ -38,6 +38,26 @@ "date_finish": "2024-04-03T12:50:17+03:00" } }, + "returns": [ + { + "name": "result", + "type": "null", + "base": "any", + "required": false, + "description": "Возвращает null, если запись успешно удалена" + }, + { + "name": "time", + "type": "time", + "base": "object", + "required": false, + "description": "Информация о времени выполнения запроса" + } + ], "page": "/api-reference/tasks/elapsed-item/task-elapsed-item-delete.html", - "executable": false + "executable": false, + "requestExample": { + "TASKID": 691, + "ITEMID": 5 + } } diff --git a/_assets/simulator/spec/methods/task.elapseditem.get.json b/_assets/simulator/spec/methods/task.elapseditem.get.json index 1dc8d4bf2..427fcb004 100644 --- a/_assets/simulator/spec/methods/task.elapseditem.get.json +++ b/_assets/simulator/spec/methods/task.elapseditem.get.json @@ -4,7 +4,7 @@ "scope": "task", "kind": "read", "title": "Получить запись о затраченном времени по идентификатору task.elapseditem.get", - "permissions": "любой пользователь", + "permissions": "пользователь с доступом на чтение задачи", "params": [ { "name": "TASKID", @@ -28,20 +28,18 @@ "file": "api-reference/tasks/elapsed-item/task-elapsed-item-get.md" }, "resultExample": { - "result": [ - { - "ID": "1", - "TASK_ID": "691", - "USER_ID": "1", - "COMMENT_TEXT": "1", - "SECONDS": "3600", - "MINUTES": "60", - "SOURCE": "2", - "CREATED_DATE": "2024-05-16T10:33:00+02:00", - "DATE_START": "2024-05-16T10:33:15+02:00", - "DATE_STOP": "2024-05-16T10:33:15+02:00" - } - ], + "result": { + "ID": "1", + "TASK_ID": "691", + "USER_ID": "1", + "COMMENT_TEXT": "1", + "SECONDS": "3600", + "MINUTES": "60", + "SOURCE": "2", + "CREATED_DATE": "2024-05-16T10:33:00+02:00", + "DATE_START": "2024-05-16T10:33:15+02:00", + "DATE_STOP": "2024-05-16T10:33:15+02:00" + }, "time": { "start": 1712137817.343984, "finish": 1712137817.605804, @@ -57,7 +55,7 @@ "type": "object", "base": "object", "required": false, - "description": "Информация о записи о затраченном времени" + "description": "Информация о записи о затраченном времени (подробное описание)" }, { "name": "time", @@ -80,5 +78,9 @@ "SOURCE", "TASK_ID", "USER_ID" - ] + ], + "requestExample": { + "TASKID": 691, + "ITEMID": 1 + } } diff --git a/_assets/simulator/spec/methods/task.elapseditem.getlist.json b/_assets/simulator/spec/methods/task.elapseditem.getlist.json index c9f61a27a..b5277ecf2 100644 --- a/_assets/simulator/spec/methods/task.elapseditem.getlist.json +++ b/_assets/simulator/spec/methods/task.elapseditem.getlist.json @@ -4,7 +4,7 @@ "scope": "task", "kind": "read", "title": "Получить список записей о затраченном времени task.elapseditem.getlist", - "permissions": "любой пользователь", + "permissions": "пользователь с доступом на чтение задачи", "params": [ { "name": "taskId", @@ -18,7 +18,7 @@ "type": "object", "base": "object", "required": "unknown", - "description": "Объект для сортировки результата (подробное описание приведено ниже)", + "description": "Объект для сортировки результата (подробное описание)", "ref": "#/defs/orderFields" }, { @@ -26,7 +26,7 @@ "type": "object", "base": "object", "required": "unknown", - "description": "Объект для фильтрации результата (подробное описание приведено ниже)", + "description": "Объект для фильтрации результата (подробное описание)", "ref": "#/defs/filterFields" }, { @@ -34,22 +34,16 @@ "type": "array", "base": "array", "required": "unknown", - "description": "Массив полей записей, которые будут возвращены методом. Можно указать только те поля, которые необходимы. Если в массиве присутствует значение \"*\", то будут возвращены все доступные поля. По умолчанию будут возвращены все поля основной таблицы запроса", - "dynamic": { - "allowed": true, - "note": "Состав полей не описан подтаблицей на этой странице" - } + "description": "Массив полей записей, которые будут возвращены методом (подробное описание) Если параметр не передан, метод возвращает все поля основной таблицы запроса. Чтобы явно вернуть все доступные поля, передайте значение *", + "ref": "#/defs/selectFields" }, { "name": "params", "type": "object", "base": "object", "required": "unknown", - "description": "Объект для опций вызова. Элементом является объект NAV_PARAMS вида {'опция вызова': 'значение' [, ...]} (подробное описание приведено ниже) в виде структуры", - "dynamic": { - "allowed": true, - "note": "Состав полей не описан подтаблицей на этой странице" - } + "description": "Объект для опций вызова (подробное описание)", + "ref": "#/defs/paramsFields" } ], "defs": { @@ -67,6 +61,13 @@ "required": "unknown", "description": "Идентификатор записи о затраченном времени. Может принимать значения: - asc — по возрастанию - desc — по убыванию" }, + { + "name": "TASK_ID", + "type": "string", + "base": "string", + "required": "unknown", + "description": "Идентификатор задачи. Может принимать значения: - asc — по возрастанию - desc — по убыванию" + }, { "name": "USER_ID", "type": "string", @@ -125,6 +126,13 @@ "required": "unknown", "description": "Идентификатор записи о затраченном времени" }, + { + "name": "TASK_ID", + "type": "integer", + "base": "integer", + "required": "unknown", + "description": "Идентификатор задачи" + }, { "name": "USER_ID", "type": "integer", @@ -140,6 +148,101 @@ "description": "Дата создания записи" } ] + }, + "selectFields": { + "dynamic": { + "allowed": false, + "ufAllowed": true, + "note": "Пользовательские поля UF_* в схеме не описаны" + }, + "fields": [ + { + "name": "ID", + "type": "string", + "base": "string", + "required": "unknown", + "description": "Идентификатор записи о затраченном времени" + }, + { + "name": "TASK_ID", + "type": "string", + "base": "string", + "required": "unknown", + "description": "Идентификатор задачи" + }, + { + "name": "USER_ID", + "type": "string", + "base": "string", + "required": "unknown", + "description": "Идентификатор автора записи" + }, + { + "name": "COMMENT_TEXT", + "type": "string", + "base": "string", + "required": "unknown", + "description": "Комментарий" + }, + { + "name": "SECONDS", + "type": "string", + "base": "string", + "required": "unknown", + "description": "Затраченное время в секундах" + }, + { + "name": "MINUTES", + "type": "string", + "base": "string", + "required": "unknown", + "description": "Затраченное время в минутах" + }, + { + "name": "SOURCE", + "type": "string", + "base": "string", + "required": "unknown", + "description": "Источник записи" + }, + { + "name": "CREATED_DATE", + "type": "string", + "base": "string", + "required": "unknown", + "description": "Дата создания записи" + }, + { + "name": "DATE_START", + "type": "string", + "base": "string", + "required": "unknown", + "description": "Дата и время начала учета" + }, + { + "name": "DATE_STOP", + "type": "string", + "base": "string", + "required": "unknown", + "description": "Дата и время завершения учета" + } + ] + }, + "paramsFields": { + "dynamic": { + "allowed": false, + "ufAllowed": true, + "note": "Пользовательские поля UF_* в схеме не описаны" + }, + "fields": [ + { + "name": "NAV_PARAMS", + "type": "object", + "base": "object", + "required": "unknown", + "description": "Настройки постраничной навигации (подробное описание)" + } + ] } }, "requiredConvention": false, @@ -186,7 +289,7 @@ "type": "array", "base": "array", "required": "unknown", - "description": "Массив объектов с информацией о записях о затраченном времени по задаче" + "description": "Массив объектов с информацией о записях о затраченном времени по задаче (подробное описание)" }, { "name": "total", diff --git a/_assets/simulator/spec/methods/task.elapseditem.getmanifest.json b/_assets/simulator/spec/methods/task.elapseditem.getmanifest.json index 56d958e2e..0ed542403 100644 --- a/_assets/simulator/spec/methods/task.elapseditem.getmanifest.json +++ b/_assets/simulator/spec/methods/task.elapseditem.getmanifest.json @@ -11,7 +11,7 @@ "type": "object", "base": "object", "required": "unknown", - "description": "Описание методов task.elapseditem.*", + "description": "Описание методов task.elapseditem.* (подробное описание)", "dynamic": { "allowed": true, "note": "Состав полей не описан подтаблицей на этой странице" @@ -310,7 +310,7 @@ "type": "object", "base": "object", "required": "unknown", - "description": "Описание методов task.elapseditem.*" + "description": "Описание методов task.elapseditem.* (подробное описание)" }, { "name": "time", @@ -321,5 +321,6 @@ } ], "page": "/api-reference/tasks/elapsed-item/task-elapsed-item-get-manifest.html", - "executable": false + "executable": false, + "requestExample": {} } diff --git a/_assets/simulator/spec/methods/task.elapseditem.isactionallowed.json b/_assets/simulator/spec/methods/task.elapseditem.isactionallowed.json index 91c6d332d..bce4f58e3 100644 --- a/_assets/simulator/spec/methods/task.elapseditem.isactionallowed.json +++ b/_assets/simulator/spec/methods/task.elapseditem.isactionallowed.json @@ -4,8 +4,15 @@ "scope": "task", "kind": "write", "title": "Проверить разрешение действия task.elapseditem.isactionallowed", - "permissions": "любой пользователь", + "permissions": "зависит от проверяемого действия и прав пользователя на задачу", "params": [ + { + "name": "TASKID", + "type": "integer", + "base": "integer", + "required": true, + "description": "Идентификатор задачи. Идентификатор задачи можно получить при создании новой задачи или методом получения списка задач" + }, { "name": "ITEMID", "type": "integer", @@ -55,5 +62,10 @@ } ], "page": "/api-reference/tasks/elapsed-item/task-elapsed-item-is-action-allowed.html", - "executable": false + "executable": false, + "requestExample": { + "TASKID": 691, + "ITEMID": 5, + "ACTIONID": 1 + } } diff --git a/_assets/simulator/spec/methods/task.elapseditem.update.json b/_assets/simulator/spec/methods/task.elapseditem.update.json index 2f10d1399..5c1a8d4f9 100644 --- a/_assets/simulator/spec/methods/task.elapseditem.update.json +++ b/_assets/simulator/spec/methods/task.elapseditem.update.json @@ -4,7 +4,7 @@ "scope": "task", "kind": "write", "title": "Изменить запись о затраченном времени task.elapseditem.update", - "permissions": "любой пользователь", + "permissions": "автор записи или администратор с доступом к задаче", "params": [ { "name": "TASKID", @@ -25,7 +25,7 @@ "type": "object", "base": "object", "required": true, - "description": "Объект, содержащий записи о пользователе, времени и комментарии (подробное описание приведено ниже) в виде структуры:", + "description": "Изменяемые поля записи (подробное описание)", "ref": "#/defs/ARFIELDSFields" } ], @@ -48,15 +48,15 @@ "name": "COMMENT_TEXT", "type": "string", "base": "string", - "required": true, + "required": false, "description": "Текст комментария" }, { - "name": "USER_ID", - "type": "integer", - "base": "integer", + "name": "CREATED_DATE", + "type": "datetime", + "base": "datetime", "required": false, - "description": "Идентификатор пользователя" + "description": "Дата создания записи" } ] } @@ -77,6 +77,30 @@ "date_finish": "2024-04-03T12:50:17+03:00" } }, + "returns": [ + { + "name": "result", + "type": "null", + "base": "any", + "required": false, + "description": "Возвращает null, если запись успешно изменена" + }, + { + "name": "time", + "type": "time", + "base": "object", + "required": false, + "description": "Информация о времени выполнения запроса" + } + ], "page": "/api-reference/tasks/elapsed-item/task-elapsed-item-update.html", - "executable": false + "executable": false, + "requestExample": { + "TASKID": 691, + "ITEMID": 5, + "ARFIELDS": { + "SECONDS": 113, + "COMMENT_TEXT": "текст комментария" + } + } } diff --git a/_assets/simulator/spec/methods/task.item.addtofavorite.json b/_assets/simulator/spec/methods/task.item.addtofavorite.json index ca8ba393d..0b1ba74b1 100644 --- a/_assets/simulator/spec/methods/task.item.addtofavorite.json +++ b/_assets/simulator/spec/methods/task.item.addtofavorite.json @@ -38,5 +38,11 @@ "successor": "tasks.task.favorite.add" }, "page": "/api-reference/tasks/deprecated/task-item/task-item-add-to-favourite.html", - "executable": false + "executable": false, + "requestExample": { + "TASK_ID": 10, + "PARAMS": { + "AFFECT_CHILDREN": "Y" + } + } } diff --git a/_assets/simulator/spec/methods/task.item.approve.json b/_assets/simulator/spec/methods/task.item.approve.json index 8aca09bb9..d59159a3e 100644 --- a/_assets/simulator/spec/methods/task.item.approve.json +++ b/_assets/simulator/spec/methods/task.item.approve.json @@ -24,5 +24,8 @@ "successor": "tasks.task.approve" }, "page": "/api-reference/tasks/deprecated/task-item/task-item-approve.html", - "executable": false + "executable": false, + "requestExample": { + "TASKID": 13 + } } diff --git a/_assets/simulator/spec/methods/task.item.complete.json b/_assets/simulator/spec/methods/task.item.complete.json index 568a33318..39735db67 100644 --- a/_assets/simulator/spec/methods/task.item.complete.json +++ b/_assets/simulator/spec/methods/task.item.complete.json @@ -24,5 +24,8 @@ "successor": "tasks.task.complete" }, "page": "/api-reference/tasks/deprecated/task-item/task-item-complete.html", - "executable": false + "executable": false, + "requestExample": { + "TASKID": 13 + } } diff --git a/_assets/simulator/spec/methods/task.item.defer.json b/_assets/simulator/spec/methods/task.item.defer.json index e7b791404..cc9702bd9 100644 --- a/_assets/simulator/spec/methods/task.item.defer.json +++ b/_assets/simulator/spec/methods/task.item.defer.json @@ -24,5 +24,8 @@ "successor": "tasks.task.defer" }, "page": "/api-reference/tasks/deprecated/task-item/task-item-defer.html", - "executable": false + "executable": false, + "requestExample": { + "TASKID": 13 + } } diff --git a/_assets/simulator/spec/methods/task.item.delegate.json b/_assets/simulator/spec/methods/task.item.delegate.json index 7f1ff7eae..881e76ca5 100644 --- a/_assets/simulator/spec/methods/task.item.delegate.json +++ b/_assets/simulator/spec/methods/task.item.delegate.json @@ -31,5 +31,9 @@ "successor": "tasks.task.delegate" }, "page": "/api-reference/tasks/deprecated/task-item/task-item-delegate.html", - "executable": false + "executable": false, + "requestExample": { + "TASKID": 13, + "USERID": 3 + } } diff --git a/_assets/simulator/spec/methods/task.item.delete.json b/_assets/simulator/spec/methods/task.item.delete.json index 279331455..3ebd4e679 100644 --- a/_assets/simulator/spec/methods/task.item.delete.json +++ b/_assets/simulator/spec/methods/task.item.delete.json @@ -24,5 +24,8 @@ "successor": "tasks.task.delete" }, "page": "/api-reference/tasks/deprecated/task-item/task-item-delete.html", - "executable": false + "executable": false, + "requestExample": { + "TASKID": 13 + } } diff --git a/_assets/simulator/spec/methods/task.item.deletefile.json b/_assets/simulator/spec/methods/task.item.deletefile.json index cb75c8d51..c61ecfff6 100644 --- a/_assets/simulator/spec/methods/task.item.deletefile.json +++ b/_assets/simulator/spec/methods/task.item.deletefile.json @@ -38,5 +38,9 @@ "successor": "tasks.task.update" }, "page": "/api-reference/tasks/deprecated/task-item/task-item-delete-file.html", - "executable": false + "executable": false, + "requestExample": { + "TASK_ID": 3, + "ATTACHMENT_ID": 28 + } } diff --git a/_assets/simulator/spec/methods/task.item.deletefromfavorite.json b/_assets/simulator/spec/methods/task.item.deletefromfavorite.json index cd95700dd..1cc05d49a 100644 --- a/_assets/simulator/spec/methods/task.item.deletefromfavorite.json +++ b/_assets/simulator/spec/methods/task.item.deletefromfavorite.json @@ -38,5 +38,11 @@ "successor": "tasks.task.favorite.remove" }, "page": "/api-reference/tasks/deprecated/task-item/task-item-delete-from-favorite.html", - "executable": false + "executable": false, + "requestExample": { + "TASK_ID": 10, + "PARAMS": { + "AFFECT_CHILDREN": "Y" + } + } } diff --git a/_assets/simulator/spec/methods/task.item.disapprove.json b/_assets/simulator/spec/methods/task.item.disapprove.json index fd33ce261..4c7884fe7 100644 --- a/_assets/simulator/spec/methods/task.item.disapprove.json +++ b/_assets/simulator/spec/methods/task.item.disapprove.json @@ -24,5 +24,8 @@ "successor": "tasks.task.disapprove" }, "page": "/api-reference/tasks/deprecated/task-item/task-item-disapprove.html", - "executable": false + "executable": false, + "requestExample": { + "TASKID": 13 + } } diff --git a/_assets/simulator/spec/methods/task.item.getallowedactions.json b/_assets/simulator/spec/methods/task.item.getallowedactions.json index 5a6a70c0d..b555e1982 100644 --- a/_assets/simulator/spec/methods/task.item.getallowedactions.json +++ b/_assets/simulator/spec/methods/task.item.getallowedactions.json @@ -24,5 +24,8 @@ "successor": "tasks.task.getAccess" }, "page": "/api-reference/tasks/deprecated/task-item/task-item-get-allowed-actions.html", - "executable": false + "executable": false, + "requestExample": { + "TASKID": 13 + } } diff --git a/_assets/simulator/spec/methods/task.item.getallowedtaskactionsasstrings.json b/_assets/simulator/spec/methods/task.item.getallowedtaskactionsasstrings.json index 9d0207a9f..6b3172082 100644 --- a/_assets/simulator/spec/methods/task.item.getallowedtaskactionsasstrings.json +++ b/_assets/simulator/spec/methods/task.item.getallowedtaskactionsasstrings.json @@ -24,5 +24,8 @@ "successor": "tasks.task.getAccess" }, "page": "/api-reference/tasks/deprecated/task-item/task-item-get-allowed-task-actions-as-strings.html", - "executable": false + "executable": false, + "requestExample": { + "TASKID": 13 + } } diff --git a/_assets/simulator/spec/methods/task.item.getdata.json b/_assets/simulator/spec/methods/task.item.getdata.json index 6090874ac..7506fc9ad 100644 --- a/_assets/simulator/spec/methods/task.item.getdata.json +++ b/_assets/simulator/spec/methods/task.item.getdata.json @@ -24,5 +24,8 @@ "successor": "tasks.task.get" }, "page": "/api-reference/tasks/deprecated/task-item/task-item-get-data.html", - "executable": false + "executable": false, + "requestExample": { + "TASKID": 2 + } } diff --git a/_assets/simulator/spec/methods/task.item.getdependson.json b/_assets/simulator/spec/methods/task.item.getdependson.json index 15f9a6d03..5abf19dd9 100644 --- a/_assets/simulator/spec/methods/task.item.getdependson.json +++ b/_assets/simulator/spec/methods/task.item.getdependson.json @@ -24,5 +24,8 @@ "successor": "tasks.task.get" }, "page": "/api-reference/tasks/deprecated/task-item/task-item-get-dependson.html", - "executable": false + "executable": false, + "requestExample": { + "TASKID": 13 + } } diff --git a/_assets/simulator/spec/methods/task.item.list.json b/_assets/simulator/spec/methods/task.item.list.json index bc2bfa2de..8235b7966 100644 --- a/_assets/simulator/spec/methods/task.item.list.json +++ b/_assets/simulator/spec/methods/task.item.list.json @@ -61,5 +61,6 @@ "successor": "tasks.task.list" }, "page": "/api-reference/tasks/deprecated/task-item/task-item-list.html", - "executable": false + "executable": false, + "requestExample": {} } diff --git a/_assets/simulator/spec/methods/task.item.userfield.add.json b/_assets/simulator/spec/methods/task.item.userfield.add.json index 53fad77c1..080313922 100644 --- a/_assets/simulator/spec/methods/task.item.userfield.add.json +++ b/_assets/simulator/spec/methods/task.item.userfield.add.json @@ -144,5 +144,24 @@ } ], "page": "/api-reference/tasks/user-field/task-item-user-field-add.html", - "executable": false + "executable": false, + "requestExample": { + "PARAMS": { + "USER_TYPE_ID": "string", + "FIELD_NAME": "UF_TASK_CLIENT_REQUEST", + "XML_ID": "UF_TASK_CLIENT_REQUEST", + "EDIT_FORM_LABEL": { + "ru": "Запрос клиента", + "en": "Client request" + }, + "LABEL": "Запрос клиента", + "SORT": 220, + "MULTIPLE": "N", + "MANDATORY": "Y", + "SETTINGS": { + "DEFAULT_VALUE": "Уточнить цель и ожидаемый результат", + "ROWS": 10 + } + } + } } diff --git a/_assets/simulator/spec/methods/task.item.userfield.delete.json b/_assets/simulator/spec/methods/task.item.userfield.delete.json index 2113ddd43..82a5fe2b3 100644 --- a/_assets/simulator/spec/methods/task.item.userfield.delete.json +++ b/_assets/simulator/spec/methods/task.item.userfield.delete.json @@ -50,5 +50,8 @@ } ], "page": "/api-reference/tasks/user-field/task-item-user-field-delete.html", - "executable": false + "executable": false, + "requestExample": { + "ID": 1325 + } } diff --git a/_assets/simulator/spec/methods/task.item.userfield.get.json b/_assets/simulator/spec/methods/task.item.userfield.get.json index e3499c9ff..2e6c756b5 100644 --- a/_assets/simulator/spec/methods/task.item.userfield.get.json +++ b/_assets/simulator/spec/methods/task.item.userfield.get.json @@ -44,5 +44,8 @@ } ], "page": "/api-reference/tasks/user-field/task-item-user-field-get.html", - "executable": false + "executable": false, + "requestExample": { + "ID": 1325 + } } diff --git a/_assets/simulator/spec/methods/task.item.userfield.getlist.json b/_assets/simulator/spec/methods/task.item.userfield.getlist.json index 4475ad2fb..8c66710f8 100644 --- a/_assets/simulator/spec/methods/task.item.userfield.getlist.json +++ b/_assets/simulator/spec/methods/task.item.userfield.getlist.json @@ -216,5 +216,10 @@ } ], "page": "/api-reference/tasks/user-field/task-item-user-field-get-list.html", - "executable": false + "executable": false, + "requestExample": { + "ORDER": { + "SORT": "ASC" + } + } } diff --git a/_assets/simulator/spec/methods/task.item.userfield.update.json b/_assets/simulator/spec/methods/task.item.userfield.update.json index ab84c7c02..0290be8a6 100644 --- a/_assets/simulator/spec/methods/task.item.userfield.update.json +++ b/_assets/simulator/spec/methods/task.item.userfield.update.json @@ -137,5 +137,15 @@ } ], "page": "/api-reference/tasks/user-field/task-item-user-field-update.html", - "executable": false + "executable": false, + "requestExample": { + "ID": 1325, + "DATA": { + "EDIT_FORM_LABEL": { + "ru": "Описание запроса клиента", + "en": "Description of client request" + }, + "MANDATORY": "N" + } + } } diff --git a/_assets/simulator/spec/methods/task.items.getlist.json b/_assets/simulator/spec/methods/task.items.getlist.json index ae9c384ed..86dfd7372 100644 --- a/_assets/simulator/spec/methods/task.items.getlist.json +++ b/_assets/simulator/spec/methods/task.items.getlist.json @@ -61,5 +61,6 @@ "successor": "tasks.task.list" }, "page": "/api-reference/tasks/deprecated/task-items-get-list.html", - "executable": false + "executable": false, + "requestExample": {} } diff --git a/_assets/simulator/spec/methods/task.planner.getlist.json b/_assets/simulator/spec/methods/task.planner.getlist.json index 5a9389c61..6c18e95ef 100644 --- a/_assets/simulator/spec/methods/task.planner.getlist.json +++ b/_assets/simulator/spec/methods/task.planner.getlist.json @@ -70,5 +70,6 @@ } ], "page": "/api-reference/tasks/planner/task-planner-get-list.html", - "executable": false + "executable": false, + "requestExample": {} } diff --git a/_assets/simulator/spec/methods/task.stages.add.json b/_assets/simulator/spec/methods/task.stages.add.json index 34697afcd..4fdc2609a 100644 --- a/_assets/simulator/spec/methods/task.stages.add.json +++ b/_assets/simulator/spec/methods/task.stages.add.json @@ -79,5 +79,14 @@ } ], "page": "/api-reference/tasks/stages/task-stages-add.html", - "executable": false + "executable": false, + "requestExample": { + "fields": { + "TITLE": "Название стадии", + "COLOR": "#FFAAEE", + "AFTER_ID": 1, + "ENTITY_ID": 1 + }, + "isAdmin": false + } } diff --git a/_assets/simulator/spec/methods/task.stages.canmovetask.json b/_assets/simulator/spec/methods/task.stages.canmovetask.json index 20ca753ca..b0e2235d7 100644 --- a/_assets/simulator/spec/methods/task.stages.canmovetask.json +++ b/_assets/simulator/spec/methods/task.stages.canmovetask.json @@ -40,5 +40,9 @@ } ], "page": "/api-reference/tasks/stages/task-stages-can-move-task.html", - "executable": false + "executable": false, + "requestExample": { + "entityId": 1, + "entityType": "U" + } } diff --git a/_assets/simulator/spec/methods/task.stages.delete.json b/_assets/simulator/spec/methods/task.stages.delete.json index f598e692f..ca796487e 100644 --- a/_assets/simulator/spec/methods/task.stages.delete.json +++ b/_assets/simulator/spec/methods/task.stages.delete.json @@ -40,5 +40,8 @@ } ], "page": "/api-reference/tasks/stages/task-stages-delete.html", - "executable": false + "executable": false, + "requestExample": { + "id": 5 + } } diff --git a/_assets/simulator/spec/methods/task.stages.get.json b/_assets/simulator/spec/methods/task.stages.get.json index c919c8b35..64a44c144 100644 --- a/_assets/simulator/spec/methods/task.stages.get.json +++ b/_assets/simulator/spec/methods/task.stages.get.json @@ -69,5 +69,8 @@ "TITLE", "TO_UPDATE", "TO_UPDATE_ACCESS" - ] + ], + "requestExample": { + "entityId": 0 + } } diff --git a/_assets/simulator/spec/methods/task.stages.movetask.json b/_assets/simulator/spec/methods/task.stages.movetask.json index 853149bfa..db52de1fd 100644 --- a/_assets/simulator/spec/methods/task.stages.movetask.json +++ b/_assets/simulator/spec/methods/task.stages.movetask.json @@ -54,5 +54,11 @@ } ], "page": "/api-reference/tasks/stages/task-stages-move-task.html", - "executable": false + "executable": false, + "requestExample": { + "id": 1, + "stageId": 2, + "before": 3, + "after": 4 + } } diff --git a/_assets/simulator/spec/methods/tasks.api.scrum.backlog.add.json b/_assets/simulator/spec/methods/tasks.api.scrum.backlog.add.json index e50ca9bb2..81d91949d 100644 --- a/_assets/simulator/spec/methods/tasks.api.scrum.backlog.add.json +++ b/_assets/simulator/spec/methods/tasks.api.scrum.backlog.add.json @@ -69,5 +69,11 @@ } }, "page": "/api-reference/sonet-group/scrum/backlog/tasks-api-scrum-backlog-add.html", - "executable": false + "executable": false, + "requestExample": { + "fields": { + "groupId": 1, + "createdBy": 1 + } + } } diff --git a/_assets/simulator/spec/methods/tasks.api.scrum.backlog.delete.json b/_assets/simulator/spec/methods/tasks.api.scrum.backlog.delete.json index f8cf452cc..11954e3df 100644 --- a/_assets/simulator/spec/methods/tasks.api.scrum.backlog.delete.json +++ b/_assets/simulator/spec/methods/tasks.api.scrum.backlog.delete.json @@ -32,5 +32,8 @@ } }, "page": "/api-reference/sonet-group/scrum/backlog/tasks-api-scrum-backlog-delete.html", - "executable": false + "executable": false, + "requestExample": { + "id": 1 + } } diff --git a/_assets/simulator/spec/methods/tasks.api.scrum.backlog.get.json b/_assets/simulator/spec/methods/tasks.api.scrum.backlog.get.json index 687fc3194..aabcaf8b3 100644 --- a/_assets/simulator/spec/methods/tasks.api.scrum.backlog.get.json +++ b/_assets/simulator/spec/methods/tasks.api.scrum.backlog.get.json @@ -43,5 +43,8 @@ "groupId", "id", "modifiedBy" - ] + ], + "requestExample": { + "id": 125 + } } diff --git a/_assets/simulator/spec/methods/tasks.api.scrum.backlog.getFields.json b/_assets/simulator/spec/methods/tasks.api.scrum.backlog.getFields.json index 13f34da8a..8498ff306 100644 --- a/_assets/simulator/spec/methods/tasks.api.scrum.backlog.getFields.json +++ b/_assets/simulator/spec/methods/tasks.api.scrum.backlog.getFields.json @@ -58,5 +58,6 @@ } }, "page": "/api-reference/sonet-group/scrum/backlog/tasks-api-scrum-backlog-get-fields.html", - "executable": false + "executable": false, + "requestExample": {} } diff --git a/_assets/simulator/spec/methods/tasks.api.scrum.backlog.update.json b/_assets/simulator/spec/methods/tasks.api.scrum.backlog.update.json index 8064fe362..3642f1a8e 100644 --- a/_assets/simulator/spec/methods/tasks.api.scrum.backlog.update.json +++ b/_assets/simulator/spec/methods/tasks.api.scrum.backlog.update.json @@ -76,5 +76,12 @@ } }, "page": "/api-reference/sonet-group/scrum/backlog/tasks-api-scrum-backlog-update.html", - "executable": false + "executable": false, + "requestExample": { + "id": 1, + "fields": { + "groupId": 125, + "createdBy": 6 + } + } } diff --git a/_assets/simulator/spec/methods/tasks.api.scrum.epic.add.json b/_assets/simulator/spec/methods/tasks.api.scrum.epic.add.json index 6d77f9f3f..464096760 100644 --- a/_assets/simulator/spec/methods/tasks.api.scrum.epic.add.json +++ b/_assets/simulator/spec/methods/tasks.api.scrum.epic.add.json @@ -11,7 +11,7 @@ "type": "object", "base": "object", "required": true, - "description": "Значения полей (подробное описание приведено ниже) для добавления нового эпика в виде структуры:", + "description": "Значения полей нового эпика (подробное описание) в виде структуры:", "ref": "#/defs/fieldsFields" } ], @@ -28,7 +28,7 @@ "type": "string", "base": "string", "required": true, - "description": "Название эпика" + "description": "Название эпика, до 255 символов" }, { "name": "description", @@ -42,35 +42,28 @@ "type": "integer", "base": "integer", "required": true, - "description": "Идентификатор группы (скрама), к которой относится эпик" + "description": "Идентификатор Скрама, в котором создается эпик. Получить идентификатор можно методом socialnetwork.api.workgroup.list" }, { "name": "color", "type": "string", "base": "string", "required": false, - "description": "Цвет эпика" + "description": "Цвет эпика, например #69dafc, до 18 символов. Формат цвета метод не проверяет и сохраняет строку как есть" }, { "name": "files", "type": "array", "base": "array", "required": false, - "description": "Массив файлов, привязанных к эпику. В files можно передать массив значений с идентификаторами файлов, указав префикс n для каждого идентификатора" + "description": "Массив идентификаторов файлов Диска. Перед каждым идентификатором укажите префикс n, например [\"n428\", \"n345\"]" }, { "name": "createdBy", "type": "integer", "base": "integer", "required": false, - "description": "Кем создан" - }, - { - "name": "modifiedBy", - "type": "integer", - "base": "integer", - "required": false, - "description": "Кем изменен" + "description": "Идентификатор пользователя, который будет указан создателем эпика. По умолчанию — текущий пользователь" } ] } @@ -81,14 +74,54 @@ "file": "api-reference/sonet-group/scrum/epic/tasks-api-scrum-epic-add.md" }, "resultExample": { - "id": 4, - "groupId": 1, - "name": "Epic 1", - "description": "Description text", - "createdBy": 1, - "modifiedBy": 1, - "color": "#69dafc" + "result": { + "id": 4, + "groupId": 1, + "name": "Epic 1", + "description": "Description text", + "createdBy": 1, + "modifiedBy": 0, + "color": "#69dafc" + }, + "time": { + "start": 1790262925, + "finish": 1790262925.771081, + "duration": 0.7710809707641602, + "processing": 0, + "date_start": "2026-09-24T18:15:25+03:00", + "date_finish": "2026-09-24T18:15:25+03:00", + "operating_reset_at": 1790263525, + "operating": 0 + } }, + "returns": [ + { + "name": "result", + "type": "object", + "base": "object", + "required": false, + "description": "Данные созданного эпика (подробное описание)" + }, + { + "name": "time", + "type": "time", + "base": "object", + "required": false, + "description": "Информация о времени выполнения запроса" + } + ], "page": "/api-reference/sonet-group/scrum/epic/tasks-api-scrum-epic-add.html", - "executable": false + "executable": false, + "requestExample": { + "fields": { + "name": "Epic 1", + "groupId": 1, + "description": "Description text", + "color": "#69dafc", + "files": [ + "n428", + "n345" + ] + } + } } diff --git a/_assets/simulator/spec/methods/tasks.api.scrum.epic.delete.json b/_assets/simulator/spec/methods/tasks.api.scrum.epic.delete.json index c49de44db..c3715979d 100644 --- a/_assets/simulator/spec/methods/tasks.api.scrum.epic.delete.json +++ b/_assets/simulator/spec/methods/tasks.api.scrum.epic.delete.json @@ -21,9 +21,37 @@ "file": "api-reference/sonet-group/scrum/epic/tasks-api-scrum-epic-delete.md" }, "resultExample": { - "error": 0, - "error_description": "Epic not found" + "result": [], + "time": { + "start": 1790263165, + "finish": 1790263165.067531, + "duration": 0.06753110885620117, + "processing": 0, + "date_start": "2026-09-24T18:19:25+03:00", + "date_finish": "2026-09-24T18:19:25+03:00", + "operating_reset_at": 1790263765, + "operating": 0 + } }, + "returns": [ + { + "name": "result", + "type": "array", + "base": "array", + "required": false, + "description": "Пустой массив — эпик удален" + }, + { + "name": "time", + "type": "time", + "base": "object", + "required": false, + "description": "Информация о времени выполнения запроса" + } + ], "page": "/api-reference/sonet-group/scrum/epic/tasks-api-scrum-epic-delete.html", - "executable": false + "executable": false, + "requestExample": { + "id": 1 + } } diff --git a/_assets/simulator/spec/methods/tasks.api.scrum.epic.get.json b/_assets/simulator/spec/methods/tasks.api.scrum.epic.get.json index 67ca13d42..81424ed89 100644 --- a/_assets/simulator/spec/methods/tasks.api.scrum.epic.get.json +++ b/_assets/simulator/spec/methods/tasks.api.scrum.epic.get.json @@ -12,6 +12,13 @@ "base": "integer", "required": true, "description": "Идентификатор эпика. Получить идентификаторы эпиков можно методом tasks.api.scrum.epic.list" + }, + { + "name": "withFiles", + "type": "boolean", + "base": "boolean", + "required": false, + "description": "Вернуть ли файлы эпика в поле files. По умолчанию true. Чтобы получить эпик без файлов, передайте false или 0" } ], "defs": {}, @@ -21,117 +28,114 @@ "file": "api-reference/sonet-group/scrum/epic/tasks-api-scrum-epic-get.md" }, "resultExample": { - "id": 1, - "groupId": 143, - "name": "эпик", - "description": "", - "createdBy": 1, - "modifiedBy": 0, - "color": "#69dafc", - "files": { - "ID": "136", - "ENTITY_ID": "TASKS_SCRUM_EPIC", - "FIELD_NAME": "UF_SCRUM_EPIC_FILES", - "USER_TYPE_ID": "disk_file", - "XML_ID": null, - "SORT": "100", - "MULTIPLE": "Y", - "MANDATORY": "N", - "SHOW_FILTER": "N", - "SHOW_IN_LIST": "N", - "EDIT_IN_LIST": "N", - "IS_SEARCHABLE": "N", - "SETTINGS": { - "IBLOCK_ID": null, - "SECTION_ID": null, - "UF_TO_SAVE_ALLOW_EDIT": false - }, - "USER_TYPE": { + "result": { + "id": 2, + "groupId": 2, + "name": "Регистрация пользователей", + "description": "Форма входа, регистрация и восстановление пароля", + "createdBy": 1, + "modifiedBy": 1, + "color": "#69dafc", + "files": { + "ID": "60", + "ENTITY_ID": "TASKS_SCRUM_EPIC", + "FIELD_NAME": "UF_SCRUM_EPIC_FILES", "USER_TYPE_ID": "disk_file", - "CLASS_NAME": "Bitrix\\Disk\\Uf\\FileUserType", - "DESCRIPTION": "Файл (Диск)", - "BASE_TYPE": "int", - "TAG": [ - "DISK FILE ID", - "DOCUMENT ID" - ] - }, - "VALUE": [], - "ENTITY_VALUE_ID": 1, - "CUSTOM_DATA": { - "PHOTO_TEMPLATE": "" - }, - "EDIT_FORM_LABEL": "UF_SCRUM_EPIC_FILES", - "TAG": "DOCUMENT ID" + "XML_ID": null, + "SORT": "100", + "MULTIPLE": "Y", + "MANDATORY": "N", + "SHOW_FILTER": "N", + "SHOW_IN_LIST": "N", + "EDIT_IN_LIST": "N", + "IS_SEARCHABLE": "N", + "SETTINGS": { + "IBLOCK_ID": null, + "SECTION_ID": null, + "UF_TO_SAVE_ALLOW_EDIT": false + }, + "USER_TYPE": { + "USER_TYPE_ID": "disk_file", + "CLASS_NAME": "Bitrix\\Disk\\Uf\\FileUserType", + "DESCRIPTION": "Файл (Диск)", + "BASE_TYPE": "int", + "TAG": [ + "DISK FILE ID", + "DOCUMENT ID" + ] + }, + "VALUE": [ + 6 + ], + "ENTITY_VALUE_ID": 2, + "VALUE_EXISTS": true, + "VALUE_RAW": "a:1:{i:0;i:6;}", + "CUSTOM_DATA": { + "PHOTO_TEMPLATE": "" + }, + "EDIT_FORM_LABEL": "UF_SCRUM_EPIC_FILES", + "TAG": "DOCUMENT ID" + } + }, + "time": { + "start": 1790263942, + "finish": 1790263942.418237, + "duration": 0.4182369709014893, + "processing": 0, + "date_start": "2026-09-24T18:32:22+03:00", + "date_finish": "2026-09-24T18:32:22+03:00", + "operating_reset_at": 1790264542, + "operating": 0 } }, "returns": [ { - "name": "id", - "type": "integer", - "base": "integer", - "required": false, - "description": "Идентификатор эпика" - }, - { - "name": "groupId", - "type": "integer", - "base": "integer", - "required": false, - "description": "Идентификатор группы (скрама), к которой привязан эпик" - }, - { - "name": "name", - "type": "string", - "base": "string", - "required": false, - "description": "Название эпика" - }, - { - "name": "description", - "type": "string", - "base": "string", - "required": false, - "description": "Описание эпика" - }, - { - "name": "createdBy", - "type": "integer", - "base": "integer", - "required": false, - "description": "Идентификатор пользователя, создавшего эпик" - }, - { - "name": "modifiedBy", - "type": "integer", - "base": "integer", - "required": false, - "description": "Идентификатор пользователя, который последним изменял эпик" - }, - { - "name": "color", - "type": "string", - "base": "string", + "name": "result", + "type": "object", + "base": "object", "required": false, - "description": "Цвет эпика в формате HEX" + "description": "Данные эпика (подробное описание)" }, { - "name": "files", - "type": "object", + "name": "time", + "type": "time", "base": "object", "required": false, - "description": "Объект с данными обо всех файлах, прикрепленных к эпику" + "description": "Информация о времени выполнения запроса" } ], "page": "/api-reference/sonet-group/scrum/epic/tasks-api-scrum-epic-get.html", "executable": false, "entityFields": [ + "CUSTOM_DATA", + "EDIT_FORM_LABEL", + "EDIT_IN_LIST", + "ENTITY_ID", + "ENTITY_VALUE_ID", + "FIELD_NAME", + "ID", + "IS_SEARCHABLE", + "MANDATORY", + "MULTIPLE", + "SETTINGS", + "SHOW_FILTER", + "SHOW_IN_LIST", + "SORT", + "TAG", + "USER_TYPE", + "USER_TYPE_ID", + "VALUE", + "VALUE_EXISTS", + "VALUE_RAW", + "XML_ID", "color", "createdBy", "description", "files", "groupId", - "modifiedBy", "name" - ] + ], + "requestExample": { + "id": 1 + } } diff --git a/_assets/simulator/spec/methods/tasks.api.scrum.epic.getFields.json b/_assets/simulator/spec/methods/tasks.api.scrum.epic.getFields.json index 362eace9d..d9f95a5ed 100644 --- a/_assets/simulator/spec/methods/tasks.api.scrum.epic.getFields.json +++ b/_assets/simulator/spec/methods/tasks.api.scrum.epic.getFields.json @@ -7,57 +7,26 @@ "permissions": "любой пользователь", "params": [ { - "name": "name", - "type": "string", - "base": "string", + "name": "result", + "type": "object", + "base": "object", "required": "unknown", - "description": "Название эпика" - }, - { - "name": "description", - "type": "string", - "base": "string", - "required": "unknown", - "description": "Описание эпика" - }, - { - "name": "groupId", - "type": "integer", - "base": "integer", - "required": "unknown", - "description": "Идентификатор группы (скрама), к которой относится эпик" - }, - { - "name": "color", - "type": "string", - "base": "string", - "required": "unknown", - "description": "Цвет эпика" - }, - { - "name": "files", - "type": "array", - "base": "array", - "required": "unknown", - "description": "Массив файлов, привязанных к эпику", + "description": "Объект с ключом fields (подробное описание)", "dynamic": { "allowed": true, "note": "Состав полей не описан подтаблицей на этой странице" } }, { - "name": "createdBy", - "type": "integer", - "base": "integer", + "name": "time", + "type": "time", + "base": "object", "required": "unknown", - "description": "Кем создана" - }, - { - "name": "modifiedBy", - "type": "integer", - "base": "integer", - "required": "unknown", - "description": "Кем изменена" + "description": "Информация о времени выполнения запроса", + "dynamic": { + "allowed": true, + "note": "Состав полей не описан подтаблицей на этой странице" + } } ], "defs": {}, @@ -67,30 +36,59 @@ "file": "api-reference/sonet-group/scrum/epic/tasks-api-scrum-epic-get-fields.md" }, "resultExample": { - "fields": { - "name": { - "type": "string" - }, - "description": { - "type": "string" - }, - "groupId": { - "type": "integer" - }, - "color": { - "type": "string" - }, - "files": { - "type": "array" - }, - "createdBy": { - "type": "integer" - }, - "modifiedBy": { - "type": "integer" + "result": { + "fields": { + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "groupId": { + "type": "integer" + }, + "color": { + "type": "string" + }, + "files": { + "type": "array" + }, + "createdBy": { + "type": "integer" + }, + "modifiedBy": { + "type": "integer" + } } + }, + "time": { + "start": 1790262925, + "finish": 1790262925.771081, + "duration": 0.7710809707641602, + "processing": 0, + "date_start": "2026-09-24T18:15:25+03:00", + "date_finish": "2026-09-24T18:15:25+03:00", + "operating_reset_at": 1790263525, + "operating": 0 } }, + "returns": [ + { + "name": "result", + "type": "object", + "base": "object", + "required": "unknown", + "description": "Объект с ключом fields (подробное описание)" + }, + { + "name": "time", + "type": "time", + "base": "object", + "required": "unknown", + "description": "Информация о времени выполнения запроса" + } + ], "page": "/api-reference/sonet-group/scrum/epic/tasks-api-scrum-epic-get-fields.html", - "executable": false + "executable": false, + "requestExample": {} } diff --git a/_assets/simulator/spec/methods/tasks.api.scrum.epic.list.json b/_assets/simulator/spec/methods/tasks.api.scrum.epic.list.json index 65b64feb8..4f3dd8f48 100644 --- a/_assets/simulator/spec/methods/tasks.api.scrum.epic.list.json +++ b/_assets/simulator/spec/methods/tasks.api.scrum.epic.list.json @@ -5,123 +5,50 @@ "kind": "read", "title": "Получить список эпиков tasks.api.scrum.epic.list", "permissions": "любой пользователь", - "params": [ - { - "name": "order", - "type": "array", - "base": "array", - "required": "unknown", - "description": "Массив для сортировки результата вида {'поле_сортировки': 'направление сортировки' [, ...]}. Направление сортировки может принимать значения: - asc — по возрастанию - desc — по убыванию Возможные значения элементов массива соответствуют полям ответа tasks.api.scrum.epic.add", - "dynamic": { - "allowed": true, - "note": "Состав полей не описан подтаблицей на этой странице" - } - }, - { - "name": "filter", - "type": "array", - "base": "array", - "required": "unknown", - "description": "Массив вида {'фильтруемое_поле': 'значение фильтра' [, ...]}. Ключу может быть задан дополнительный префикс, уточняющий поведение фильтра. Возможные значения префикса: - = — равно (работает и с массивами) - % — LIKE, поиск по подстроке. Символ % в значении фильтра передавать не нужно.…", - "dynamic": { - "allowed": true, - "note": "Состав полей не описан подтаблицей на этой странице" - } - }, - { - "name": "select", - "type": "array", - "base": "array", - "required": "unknown", - "description": "Массив полей записей, которые будут возвращены методом. Возможные значения элементов массива соответствуют полям ответа tasks.api.scrum.epic.add. Можно указать только те поля, которые необходимы. Если в массиве присутствует значение \"*\", то будут возвращены все доступные поля. Значение по умолчанию — пустой массив array(). Это означает, что будут возвращены все поля основной таблицы запроса", - "dynamic": { - "allowed": true, - "note": "Состав полей не описан подтаблицей на этой странице" - } - }, - { - "name": "start", - "type": "integer", - "base": "integer", - "required": "unknown", - "description": "Номер страницы вывода. Работает для https запросов. Размер страницы результатов всегда статичный: 50 записей. Чтобы выбрать вторую страницу результатов необходимо передавать значение 50. Чтобы выбрать третью страницу результатов значение — 100 и так далее. Формула расчета значения параметра start: start = (N-1) * 50, где N — номер нужной страницы" - } - ], + "params": [], "defs": {}, "requiredConvention": false, "confidence": "parsed", "source": { "file": "api-reference/sonet-group/scrum/epic/tasks-api-scrum-epic-list.md" }, - "resultExample": [ - { - "id": 1, - "groupId": 143, - "name": "эпик", - "description": "", - "createdBy": 1, - "modifiedBy": 0, - "color": "#69dafc" - }, - { - "id": 3, - "groupId": 143, - "name": "эпик2", - "description": "new epic", - "createdBy": 3, - "modifiedBy": 5, - "color": "#69dagc" + "resultExample": { + "result": [ + { + "id": 12, + "groupId": 0, + "name": "Новый эпик", + "description": "", + "createdBy": 1, + "modifiedBy": 3, + "color": "#69dafc" + } + ], + "time": { + "start": 1790263004, + "finish": 1790263004.141055, + "duration": 0.14105510711669922, + "processing": 0, + "date_start": "2026-09-24T18:16:44+03:00", + "date_finish": "2026-09-24T18:16:44+03:00", + "operating_reset_at": 1790263604, + "operating": 0 } - ], + }, "returns": [ { - "name": "id", - "type": "integer", - "base": "integer", - "required": "unknown", - "description": "Идентификатор эпика" - }, - { - "name": "groupId", - "type": "integer", - "base": "integer", - "required": "unknown", - "description": "Идентификатор группы (скрама), к которой привязан эпик" - }, - { - "name": "name", - "type": "string", - "base": "string", - "required": "unknown", - "description": "Название эпика" - }, - { - "name": "description", - "type": "string", - "base": "string", - "required": "unknown", - "description": "Описание эпика" - }, - { - "name": "createdBy", - "type": "integer", - "base": "integer", - "required": "unknown", - "description": "Идентификатор пользователя, создавшего эпик" - }, - { - "name": "modifiedBy", - "type": "integer", - "base": "integer", + "name": "result", + "type": "object[]", + "base": "array", "required": "unknown", - "description": "Идентификатор пользователя, который последним изменял эпик" + "description": "Массив эпиков (подробное описание)" }, { - "name": "color", - "type": "string", - "base": "string", + "name": "time", + "type": "time", + "base": "object", "required": "unknown", - "description": "Цвет эпика в формате HEX" + "description": "Информация о времени выполнения запроса" } ], "page": "/api-reference/sonet-group/scrum/epic/tasks-api-scrum-epic-list.html", @@ -132,6 +59,7 @@ "description", "files", "groupId", + "id", "modifiedBy", "name" ] diff --git a/_assets/simulator/spec/methods/tasks.api.scrum.epic.update.json b/_assets/simulator/spec/methods/tasks.api.scrum.epic.update.json index a8c52db2a..2436d6b03 100644 --- a/_assets/simulator/spec/methods/tasks.api.scrum.epic.update.json +++ b/_assets/simulator/spec/methods/tasks.api.scrum.epic.update.json @@ -15,10 +15,10 @@ }, { "name": "fields", - "type": "array", - "base": "array", + "type": "object", + "base": "object", "required": true, - "description": "Значения полей (подробное описание приведено ниже) для добавления нового эпика в виде структуры:", + "description": "Поля эпика, которые нужно изменить (подробное описание), в виде структуры:", "ref": "#/defs/fieldsFields" } ], @@ -34,8 +34,8 @@ "name": "name", "type": "string", "base": "string", - "required": true, - "description": "Название эпика" + "required": false, + "description": "Название эпика, до 255 символов. Пустую строку метод не сохраняет" }, { "name": "description", @@ -48,22 +48,36 @@ "name": "groupId", "type": "integer", "base": "integer", - "required": true, - "description": "Идентификатор группы (скрама), к которой относится эпик" + "required": false, + "description": "Идентификатор Скрама, в который нужно перенести эпик. Нужен доступ к задачам обеих групп" }, { "name": "color", "type": "string", "base": "string", "required": false, - "description": "Цвет эпика" + "description": "Цвет эпика, например #bbecf1, до 18 символов" }, { "name": "files", "type": "array", "base": "array", "required": false, - "description": "Массив файлов, привязанных к эпику. В files можно передать массив значений с идентификаторами файлов, указав префикс n для каждого идентификатора. Если передать пустой массив — файлы удалятся" + "description": "Массив идентификаторов файлов Диска с префиксом n, например [\"n429\"]. Новые файлы добавляются к уже прикрепленным. Если передать пустой массив, метод открепит от эпика все файлы. Идентификатор без префикса n метод пропускает без ошибки" + }, + { + "name": "createdBy", + "type": "integer", + "base": "integer", + "required": false, + "description": "Идентификатор пользователя, который будет указан создателем эпика" + }, + { + "name": "modifiedBy", + "type": "integer", + "base": "integer", + "required": false, + "description": "Идентификатор пользователя, который будет указан последним изменившим эпик. По умолчанию — текущий пользователь" } ] } @@ -74,65 +88,54 @@ "file": "api-reference/sonet-group/scrum/epic/tasks-api-scrum-epic-update.md" }, "resultExample": { - "id": 1, - "groupId": 143, - "name": "Updated epic name", - "description": "Updated description text", - "createdBy": 1, - "modifiedBy": 1, - "color": "#bbecf1" + "result": { + "id": 1, + "groupId": 143, + "name": "Updated epic name", + "description": "Updated description text", + "createdBy": 1, + "modifiedBy": 1, + "color": "#bbecf1" + }, + "time": { + "start": 1790263154, + "finish": 1790263154.532794, + "duration": 0.5327939987182617, + "processing": 0, + "date_start": "2026-09-24T18:19:14+03:00", + "date_finish": "2026-09-24T18:19:14+03:00", + "operating_reset_at": 1790263754, + "operating": 0 + } }, "returns": [ { - "name": "id", - "type": "integer", - "base": "integer", - "required": false, - "description": "Идентификатор эпика" - }, - { - "name": "groupId", - "type": "integer", - "base": "integer", - "required": false, - "description": "Идентификатор группы (скрама), к которой привязан эпик" - }, - { - "name": "name", - "type": "string", - "base": "string", + "name": "result", + "type": "object", + "base": "object", "required": false, - "description": "Название эпика" + "description": "Данные эпика после изменения (подробное описание)" }, { - "name": "description", - "type": "string", - "base": "string", + "name": "time", + "type": "time", + "base": "object", "required": false, - "description": "Описание эпика" - }, - { - "name": "createdBy", - "type": "integer", - "base": "integer", - "required": false, - "description": "Идентификатор пользователя, создавшего эпик" - }, - { - "name": "modifiedBy", - "type": "integer", - "base": "integer", - "required": false, - "description": "Идентификатор пользователя, который последним изменял эпик" - }, - { - "name": "color", - "type": "string", - "base": "string", - "required": false, - "description": "Цвет эпика" + "description": "Информация о времени выполнения запроса" } ], "page": "/api-reference/sonet-group/scrum/epic/tasks-api-scrum-epic-update.html", - "executable": false + "executable": false, + "requestExample": { + "id": 1, + "fields": { + "name": "Updated epic name", + "description": "Updated description text", + "color": "#bbecf1", + "files": [ + "n429", + "n243" + ] + } + } } diff --git a/_assets/simulator/spec/methods/tasks.api.scrum.kanban.addStage.json b/_assets/simulator/spec/methods/tasks.api.scrum.kanban.addStage.json index 8ff57a0e8..4df7a5d7e 100644 --- a/_assets/simulator/spec/methods/tasks.api.scrum.kanban.addStage.json +++ b/_assets/simulator/spec/methods/tasks.api.scrum.kanban.addStage.json @@ -4,7 +4,7 @@ "scope": "task", "kind": "write", "title": "Создать стадию канбана Скрама tasks.api.scrum.kanban.addStage", - "permissions": "любой пользователь", + "permissions": "пользователь с правом редактирования задач группы Скрама", "params": [ { "name": "fields", @@ -42,21 +42,21 @@ "type": "string", "base": "string", "required": false, - "description": "Тип стадии канбана. Возможные значения: NEW, WORK, FINISH" + "description": "Тип стадии канбана. Возможные значения: NEW, WORK, FINISH По умолчанию — WORK" }, { "name": "sort", "type": "integer", "base": "integer", "required": false, - "description": "Порядок сортировки. Значение поля должно быть кратно 100" + "description": "Порядок сортировки. Стадии выводятся по возрастанию значения По умолчанию — 100" }, { "name": "color", "type": "string", "base": "string", "required": false, - "description": "Цвет стадии канбана" + "description": "Цвет стадии канбана в виде шестизначного HEX-кода без символа #. По умолчанию — 00C4FB" } ] } @@ -77,6 +77,31 @@ "date_finish": "2024-04-03T12:50:17+03:00" } }, + "returns": [ + { + "name": "result", + "type": "integer", + "base": "integer", + "required": false, + "description": "Идентификатор созданной стадии канбана" + }, + { + "name": "time", + "type": "time", + "base": "object", + "required": false, + "description": "Информация о времени выполнения запроса" + } + ], "page": "/api-reference/sonet-group/scrum/kanban/tasks-api-scrum-kanban-add-stage.html", - "executable": false + "executable": false, + "requestExample": { + "fields": { + "sprintId": 1, + "name": "Первая стадия", + "type": "NEW", + "color": "00C4FB", + "sort": 100 + } + } } diff --git a/_assets/simulator/spec/methods/tasks.api.scrum.kanban.addTask.json b/_assets/simulator/spec/methods/tasks.api.scrum.kanban.addTask.json index f2c59a56b..89f5dc3bf 100644 --- a/_assets/simulator/spec/methods/tasks.api.scrum.kanban.addTask.json +++ b/_assets/simulator/spec/methods/tasks.api.scrum.kanban.addTask.json @@ -4,7 +4,7 @@ "scope": "task", "kind": "write", "title": "Добавить задачу в канбан Скрама tasks.api.scrum.kanban.addTask", - "permissions": "любой пользователь", + "permissions": "пользователь с правом редактирования задач группы Скрама", "params": [ { "name": "sprintId", @@ -45,6 +45,27 @@ "date_finish": "2024-04-03T12:50:17+03:00" } }, + "returns": [ + { + "name": "result", + "type": "boolean", + "base": "boolean", + "required": false, + "description": "Возвращает true, если задача успешно добавлена в стадию канбана" + }, + { + "name": "time", + "type": "time", + "base": "object", + "required": false, + "description": "Информация о времени выполнения запроса" + } + ], "page": "/api-reference/sonet-group/scrum/kanban/tasks-api-scrum-kanban-add-task.html", - "executable": false + "executable": false, + "requestExample": { + "sprintId": 5, + "taskId": 751, + "stageId": 58 + } } diff --git a/_assets/simulator/spec/methods/tasks.api.scrum.kanban.deleteStage.json b/_assets/simulator/spec/methods/tasks.api.scrum.kanban.deleteStage.json index fb1b9ce90..e8c7ec9c9 100644 --- a/_assets/simulator/spec/methods/tasks.api.scrum.kanban.deleteStage.json +++ b/_assets/simulator/spec/methods/tasks.api.scrum.kanban.deleteStage.json @@ -4,7 +4,7 @@ "scope": "task", "kind": "write", "title": "Удалить стадию tasks.api.scrum.kanban.deleteStage", - "permissions": "любой пользователь", + "permissions": "пользователь с правом редактирования задач группы Скрама", "params": [ { "name": "stageId", @@ -31,6 +31,25 @@ "date_finish": "2024-04-03T12:50:17+03:00" } }, + "returns": [ + { + "name": "result", + "type": "boolean", + "base": "boolean", + "required": false, + "description": "Возвращает true, если стадия успешно удалена" + }, + { + "name": "time", + "type": "time", + "base": "object", + "required": false, + "description": "Информация о времени выполнения запроса" + } + ], "page": "/api-reference/sonet-group/scrum/kanban/tasks-api-scrum-kanban-delete-stage.html", - "executable": false + "executable": false, + "requestExample": { + "stageId": 65 + } } diff --git a/_assets/simulator/spec/methods/tasks.api.scrum.kanban.deleteTask.json b/_assets/simulator/spec/methods/tasks.api.scrum.kanban.deleteTask.json index 48e24aa2f..1df4e85ea 100644 --- a/_assets/simulator/spec/methods/tasks.api.scrum.kanban.deleteTask.json +++ b/_assets/simulator/spec/methods/tasks.api.scrum.kanban.deleteTask.json @@ -4,7 +4,7 @@ "scope": "task", "kind": "write", "title": "Удалить задачу из канбана Скрама tasks.api.scrum.kanban.deleteTask", - "permissions": "любой пользователь", + "permissions": "пользователь с правом редактирования задач группы Скрама", "params": [ { "name": "sprintId", @@ -38,6 +38,26 @@ "date_finish": "2024-04-03T12:50:17+03:00" } }, + "returns": [ + { + "name": "result", + "type": "boolean", + "base": "boolean", + "required": false, + "description": "Возвращает true, если задача успешно удалена из канбана" + }, + { + "name": "time", + "type": "time", + "base": "object", + "required": false, + "description": "Информация о времени выполнения запроса" + } + ], "page": "/api-reference/sonet-group/scrum/kanban/tasks-api-scrum-kanban-delete-task.html", - "executable": false + "executable": false, + "requestExample": { + "sprintId": 5, + "taskId": 751 + } } diff --git a/_assets/simulator/spec/methods/tasks.api.scrum.kanban.getFields.json b/_assets/simulator/spec/methods/tasks.api.scrum.kanban.getFields.json new file mode 100644 index 000000000..a1d2eb418 --- /dev/null +++ b/_assets/simulator/spec/methods/tasks.api.scrum.kanban.getFields.json @@ -0,0 +1,174 @@ +{ + "$v": 1, + "method": "tasks.api.scrum.kanban.getFields", + "scope": "task", + "kind": "read", + "title": "Получить список доступных полей стадии канбана tasks.api.scrum.kanban.getFields", + "permissions": "любой пользователь", + "params": [ + { + "name": "result", + "type": "object", + "base": "object", + "required": "unknown", + "description": "Корневой элемент ответа", + "dynamic": { + "allowed": true, + "note": "Состав полей не описан подтаблицей на этой странице" + } + }, + { + "name": "result.fields", + "type": "object", + "base": "object", + "required": "unknown", + "description": "Описание доступных полей стадии канбана", + "dynamic": { + "allowed": true, + "note": "Состав полей не описан подтаблицей на этой странице" + } + }, + { + "name": "result.fields.name.type", + "type": "string", + "base": "string", + "required": "unknown", + "description": "Тип поля name: string" + }, + { + "name": "result.fields.sort.type", + "type": "string", + "base": "string", + "required": "unknown", + "description": "Тип поля sort: integer" + }, + { + "name": "result.fields.type.type", + "type": "string", + "base": "string", + "required": "unknown", + "description": "Тип поля type: string" + }, + { + "name": "result.fields.sprintId.type", + "type": "string", + "base": "string", + "required": "unknown", + "description": "Тип поля sprintId: integer" + }, + { + "name": "result.fields.color.type", + "type": "string", + "base": "string", + "required": "unknown", + "description": "Тип поля color: string" + }, + { + "name": "time", + "type": "time", + "base": "object", + "required": "unknown", + "description": "Информация о времени выполнения запроса", + "dynamic": { + "allowed": true, + "note": "Состав полей не описан подтаблицей на этой странице" + } + } + ], + "defs": {}, + "requiredConvention": false, + "confidence": "parsed", + "source": { + "file": "api-reference/sonet-group/scrum/kanban/tasks-api-scrum-kanban-get-fields.md" + }, + "resultExample": { + "result": { + "fields": { + "name": { + "type": "string" + }, + "sort": { + "type": "integer" + }, + "type": { + "type": "string" + }, + "sprintId": { + "type": "integer" + }, + "color": { + "type": "string" + } + } + }, + "time": { + "start": 1712137817.343984, + "finish": 1712137817.605804, + "duration": 0.26182007789611816, + "processing": 0.018325090408325195, + "date_start": "2024-04-03T12:50:17+03:00", + "date_finish": "2024-04-03T12:50:17+03:00" + } + }, + "returns": [ + { + "name": "result", + "type": "object", + "base": "object", + "required": "unknown", + "description": "Корневой элемент ответа" + }, + { + "name": "result.fields", + "type": "object", + "base": "object", + "required": "unknown", + "description": "Описание доступных полей стадии канбана" + }, + { + "name": "result.fields.name.type", + "type": "string", + "base": "string", + "required": "unknown", + "description": "Тип поля name: string" + }, + { + "name": "result.fields.sort.type", + "type": "string", + "base": "string", + "required": "unknown", + "description": "Тип поля sort: integer" + }, + { + "name": "result.fields.type.type", + "type": "string", + "base": "string", + "required": "unknown", + "description": "Тип поля type: string" + }, + { + "name": "result.fields.sprintId.type", + "type": "string", + "base": "string", + "required": "unknown", + "description": "Тип поля sprintId: integer" + }, + { + "name": "result.fields.color.type", + "type": "string", + "base": "string", + "required": "unknown", + "description": "Тип поля color: string" + }, + { + "name": "time", + "type": "time", + "base": "object", + "required": "unknown", + "description": "Информация о времени выполнения запроса" + } + ], + "page": "/api-reference/sonet-group/scrum/kanban/tasks-api-scrum-kanban-get-fields.html", + "executable": false, + "requestExample": {} +} diff --git a/_assets/simulator/spec/methods/tasks.api.scrum.kanban.getStages.json b/_assets/simulator/spec/methods/tasks.api.scrum.kanban.getStages.json index c978a9e32..d56ae1bb8 100644 --- a/_assets/simulator/spec/methods/tasks.api.scrum.kanban.getStages.json +++ b/_assets/simulator/spec/methods/tasks.api.scrum.kanban.getStages.json @@ -4,7 +4,7 @@ "scope": "task", "kind": "write", "title": "Получить стадии канбана по идентификатору спринта tasks.api.scrum.kanban.getStages", - "permissions": "любой пользователь", + "permissions": "пользователь с правом просмотра задач группы Скрама", "params": [ { "name": "sprintId", @@ -58,41 +58,23 @@ }, "returns": [ { - "name": "id", - "type": "integer", - "base": "integer", - "required": true, - "description": "Идентификатор стадии" - }, - { - "name": "name", - "type": "string", - "base": "string", - "required": true, - "description": "Название стадии канбана" - }, - { - "name": "type", - "type": "string", - "base": "string", - "required": false, - "description": "Тип стадии канбана. Возможные значения: NEW, WORK, FINISH" - }, - { - "name": "sort", - "type": "integer", - "base": "integer", + "name": "result", + "type": "array", + "base": "array", "required": false, - "description": "Порядок сортировки" + "description": "Массив стадий канбана. Структура каждой стадии описана ниже" }, { - "name": "color", - "type": "string", - "base": "string", + "name": "time", + "type": "time", + "base": "object", "required": false, - "description": "Цвет стадии канбана" + "description": "Информация о времени выполнения запроса" } ], "page": "/api-reference/sonet-group/scrum/kanban/tasks-api-scrum-kanban-get-stages.html", - "executable": false + "executable": false, + "requestExample": { + "sprintId": 5 + } } diff --git a/_assets/simulator/spec/methods/tasks.api.scrum.kanban.updateStage.json b/_assets/simulator/spec/methods/tasks.api.scrum.kanban.updateStage.json index 0f2394bef..ccb204fc6 100644 --- a/_assets/simulator/spec/methods/tasks.api.scrum.kanban.updateStage.json +++ b/_assets/simulator/spec/methods/tasks.api.scrum.kanban.updateStage.json @@ -4,7 +4,7 @@ "scope": "task", "kind": "write", "title": "Обновить стадию канбана Скрама tasks.api.scrum.kanban.updateStage", - "permissions": "любой пользователь", + "permissions": "пользователь с правом редактирования задач группы Скрама", "params": [ { "name": "stageId", @@ -56,14 +56,14 @@ "type": "integer", "base": "integer", "required": false, - "description": "Порядок сортировки. Значение поля должно быть кратно 100" + "description": "Порядок сортировки. Стадии выводятся по возрастанию значения" }, { "name": "color", "type": "string", "base": "string", "required": false, - "description": "Цвет стадии канбана" + "description": "Цвет стадии канбана в виде шестизначного HEX-кода без символа #, например 00C4FB" } ] } @@ -84,6 +84,31 @@ "date_finish": "2024-04-03T12:50:17+03:00" } }, + "returns": [ + { + "name": "result", + "type": "boolean", + "base": "boolean", + "required": false, + "description": "Возвращает true, если стадия успешно изменена" + }, + { + "name": "time", + "type": "time", + "base": "object", + "required": false, + "description": "Информация о времени выполнения запроса" + } + ], "page": "/api-reference/sonet-group/scrum/kanban/tasks-api-scrum-kanban-update-stage.html", - "executable": false + "executable": false, + "requestExample": { + "stageId": 65, + "fields": { + "name": "Обновленная стадия", + "type": "WORK", + "color": "00C4FB", + "sort": 100 + } + } } diff --git a/_assets/simulator/spec/methods/tasks.api.scrum.sprint.add.json b/_assets/simulator/spec/methods/tasks.api.scrum.sprint.add.json index fe83d4eab..4b5cce69b 100644 --- a/_assets/simulator/spec/methods/tasks.api.scrum.sprint.add.json +++ b/_assets/simulator/spec/methods/tasks.api.scrum.sprint.add.json @@ -11,7 +11,7 @@ "type": "object", "base": "object", "required": true, - "description": "Объект с данными спринта", + "description": "Объект с данными спринта (подробное описание)", "ref": "#/defs/fieldsFields" } ], @@ -28,7 +28,7 @@ "type": "integer", "base": "integer", "required": true, - "description": "Идентификатор группы (Скрама), к которой относится спринт. Идентификатор можно получить методом tasks.api.scrum.sprint.get для уже существующего спринта" + "description": "Идентификатор группы (Скрама), к которой относится спринт. Идентификатор можно получить методом socialnetwork.api.workgroup.list. Группа является Скрамом, если у нее заполнено поле SCRUM_MASTER_ID" }, { "name": "name", @@ -37,33 +37,61 @@ "required": true, "description": "Название спринта" }, + { + "name": "createdBy", + "type": "integer", + "base": "integer", + "required": true, + "description": "Идентификатор пользователя, который создает спринт. Идентификатор можно получить методом user.get" + }, + { + "name": "modifiedBy", + "type": "integer", + "base": "integer", + "required": false, + "description": "Идентификатор пользователя, который последним изменил спринт" + }, { "name": "sort", "type": "integer", "base": "integer", "required": false, - "description": "Сортировка" + "description": "Порядок сортировки спринта. По умолчанию 0" }, { "name": "dateStart", "type": "string", "base": "string", - "required": false, + "required": true, "description": "Дата начала спринта. Доступные форматы: ISO 8601, timestamp" }, { "name": "dateEnd", "type": "string", "base": "string", - "required": false, - "description": "Дата окончания спринта. Доступные форматы: ISO 8601, timestamp" + "required": true, + "description": "Дата окончания спринта. Доступные форматы: ISO 8601, timestamp. Метод не проверяет формат дат: строку, которая не является датой, он запишет как 1970-01-01" }, { "name": "status", "type": "string", "base": "string", - "required": false, - "description": "Статус спринта. Доступные значения: active, planned, completed" + "required": true, + "description": "Статус спринта. Доступные значения: - planned — запланирован - active — активен. В Скраме может быть только один активный спринт - completed — завершен Чтобы создать спринт и затем запустить его методом tasks.api.scrum.sprint.start, передайте planned", + "values": [ + { + "value": "planned", + "title": "запланирован" + }, + { + "value": "active", + "title": "активен" + }, + { + "value": "completed", + "title": "завершен Чтобы создать спринт и затем запустить его методом tasks.api.scrum.spri" + } + ] } ] } @@ -86,6 +114,16 @@ "dateStart": "2021-11-22T00:00:00+02:00", "dateEnd": "2021-11-29T00:00:00+02:00", "status": "planned" + }, + "time": { + "start": 1790580587, + "finish": 1790580587.569156, + "duration": 0.5691559314727783, + "processing": 0, + "date_start": "2026-09-28T10:29:47+03:00", + "date_finish": "2026-09-28T10:29:47+03:00", + "operating_reset_at": 1790581187, + "operating": 0 } }, "returns": [ @@ -94,86 +132,27 @@ "type": "object", "base": "object", "required": false, - "description": "Объект, содержащий данные о спринте" - }, - { - "name": "id", - "type": "integer", - "base": "integer", - "required": false, - "description": "Идентификатор спринта" - }, - { - "name": "groupId", - "type": "integer", - "base": "integer", - "required": false, - "description": "Идентификатор группы (Cкрама), к которой относится спринт" - }, - { - "name": "entityType", - "type": "string", - "base": "string", - "required": false, - "description": "Тип сущности (в данном случае sprint)" - }, - { - "name": "name", - "type": "string", - "base": "string", - "required": false, - "description": "Название спринта" - }, - { - "name": "goal", - "type": "string", - "base": "string", - "required": false, - "description": "Цель спринта. Устанавливается только в интерфейсе при запуске спринта" - }, - { - "name": "sort", - "type": "integer", - "base": "integer", - "required": false, - "description": "Сортировка" - }, - { - "name": "createdBy", - "type": "integer", - "base": "integer", - "required": false, - "description": "Идентификатор пользователя, создавшего спринт" - }, - { - "name": "modifiedBy", - "type": "integer", - "base": "integer", - "required": false, - "description": "Идентификатор пользователя, изменившего спринт" + "description": "Данные спринта (подробное описание)" }, { - "name": "dateStart", - "type": "string", - "base": "string", - "required": false, - "description": "Дата начала спринта в формате ISO 8601" - }, - { - "name": "dateEnd", - "type": "string", - "base": "string", - "required": false, - "description": "Дата окончания спринта в формате ISO 8601" - }, - { - "name": "status", - "type": "string", - "base": "string", + "name": "time", + "type": "time", + "base": "object", "required": false, - "description": "Статус спринта" + "description": "Информация о времени выполнения запроса" } ], "page": "/api-reference/sonet-group/scrum/sprint/tasks-api-scrum-sprint-add.html", - "executable": false + "executable": false, + "requestExample": { + "fields": { + "name": "Sprint 1", + "groupId": 1, + "createdBy": 1, + "sort": 1, + "status": "planned", + "dateStart": "2021-11-22T00:00:00+02:00", + "dateEnd": "2021-11-29T00:00:00+02:00" + } + } } diff --git a/_assets/simulator/spec/methods/tasks.api.scrum.sprint.complete.json b/_assets/simulator/spec/methods/tasks.api.scrum.sprint.complete.json index 6b114639c..b948258f5 100644 --- a/_assets/simulator/spec/methods/tasks.api.scrum.sprint.complete.json +++ b/_assets/simulator/spec/methods/tasks.api.scrum.sprint.complete.json @@ -4,14 +4,14 @@ "scope": "task", "kind": "write", "title": "Завершить активный спринт выбранного Скрама tasks.api.scrum.sprint.complete", - "permissions": "любой пользователь", + "permissions": "владелец или модератор Скрама, администратор Битрикс24", "params": [ { "name": "id", "type": "integer", "base": "integer", "required": true, - "description": "Идентификатор группы с активным спринтом" + "description": "Идентификатор Скрама — группы с активным спринтом. Это не идентификатор спринта. Идентификатор можно получить методом socialnetwork.api.workgroup.list" } ], "defs": {}, @@ -23,7 +23,7 @@ "resultExample": { "result": { "id": 1, - "groupId": 143, + "groupId": 1, "entityType": "sprint", "name": "Спринт 1", "goal": "Цель", @@ -33,6 +33,16 @@ "dateStart": "2024-07-19T15:03:01+00:00", "dateEnd": "2024-08-02T15:03:01+00:00", "status": "completed" + }, + "time": { + "start": 1790580587, + "finish": 1790580587.569156, + "duration": 0.5691559314727783, + "processing": 0, + "date_start": "2026-09-28T10:29:47+03:00", + "date_finish": "2026-09-28T10:29:47+03:00", + "operating_reset_at": 1790581187, + "operating": 0 } }, "returns": [ @@ -41,86 +51,19 @@ "type": "object", "base": "object", "required": false, - "description": "Объект, содержащий данные о спринте" - }, - { - "name": "id", - "type": "integer", - "base": "integer", - "required": false, - "description": "Идентификатор спринта" - }, - { - "name": "groupId", - "type": "integer", - "base": "integer", - "required": false, - "description": "Идентификатор группы (Скрама), к которой относится спринт" - }, - { - "name": "entityType", - "type": "string", - "base": "string", - "required": false, - "description": "Тип сущности (в данном случае sprint)" + "description": "Данные спринта (подробное описание)" }, { - "name": "name", - "type": "string", - "base": "string", - "required": false, - "description": "Название спринта" - }, - { - "name": "goal", - "type": "string", - "base": "string", - "required": false, - "description": "Цель спринта. Устанавливается только в интерфейсе при запуске спринта" - }, - { - "name": "sort", - "type": "integer", - "base": "integer", - "required": false, - "description": "Сортировка" - }, - { - "name": "createdBy", - "type": "integer", - "base": "integer", - "required": false, - "description": "Идентификатор пользователя, создавшего спринт" - }, - { - "name": "modifiedBy", - "type": "integer", - "base": "integer", - "required": false, - "description": "Идентификатор пользователя, изменившего спринт" - }, - { - "name": "dateStart", - "type": "string", - "base": "string", - "required": false, - "description": "Дата начала спринта в формате ISO 8601" - }, - { - "name": "dateEnd", - "type": "string", - "base": "string", - "required": false, - "description": "Дата окончания спринта в формате ISO 8601" - }, - { - "name": "status", - "type": "string", - "base": "string", + "name": "time", + "type": "time", + "base": "object", "required": false, - "description": "Статус спринта" + "description": "Информация о времени выполнения запроса" } ], "page": "/api-reference/sonet-group/scrum/sprint/tasks-api-scrum-sprint-complete.html", - "executable": false + "executable": false, + "requestExample": { + "id": 1 + } } diff --git a/_assets/simulator/spec/methods/tasks.api.scrum.sprint.delete.json b/_assets/simulator/spec/methods/tasks.api.scrum.sprint.delete.json index 11dd26a09..c85d55fac 100644 --- a/_assets/simulator/spec/methods/tasks.api.scrum.sprint.delete.json +++ b/_assets/simulator/spec/methods/tasks.api.scrum.sprint.delete.json @@ -11,7 +11,7 @@ "type": "integer", "base": "integer", "required": true, - "description": "Идентификатор спринта" + "description": "Идентификатор спринта. Идентификатор можно получить методом tasks.api.scrum.sprint.list" } ], "defs": {}, @@ -21,8 +21,37 @@ "file": "api-reference/sonet-group/scrum/sprint/tasks-api-scrum-sprint-delete.md" }, "resultExample": { - "result": [] + "result": [], + "time": { + "start": 1790580587, + "finish": 1790580587.569156, + "duration": 0.5691559314727783, + "processing": 0, + "date_start": "2026-09-28T10:29:47+03:00", + "date_finish": "2026-09-28T10:29:47+03:00", + "operating_reset_at": 1790581187, + "operating": 0 + } }, + "returns": [ + { + "name": "result", + "type": "array", + "base": "array", + "required": false, + "description": "Пустой массив при успешном удалении" + }, + { + "name": "time", + "type": "time", + "base": "object", + "required": false, + "description": "Информация о времени выполнения запроса" + } + ], "page": "/api-reference/sonet-group/scrum/sprint/tasks-api-scrum-sprint-delete.html", - "executable": false + "executable": false, + "requestExample": { + "id": 1 + } } diff --git a/_assets/simulator/spec/methods/tasks.api.scrum.sprint.get.json b/_assets/simulator/spec/methods/tasks.api.scrum.sprint.get.json index dd7bc3dc7..4f6275c2c 100644 --- a/_assets/simulator/spec/methods/tasks.api.scrum.sprint.get.json +++ b/_assets/simulator/spec/methods/tasks.api.scrum.sprint.get.json @@ -3,11 +3,11 @@ "method": "tasks.api.scrum.sprint.get", "scope": "task", "kind": "read", - "title": "Получить поля спринта по его идентификатору tasks.api.scrum.sprint.get", - "permissions": "любой пользователь", + "title": "Получить спринт по идентификатору tasks.api.scrum.sprint.get", + "permissions": "любой пользователь, имеющий доступ к Скраму", "params": [ { - "name": "sprintId", + "name": "id", "type": "integer", "base": "integer", "required": true, @@ -33,6 +33,16 @@ "dateStart": "2024-07-19T15:03:01+00:00", "dateEnd": "2024-08-02T15:03:01+00:00", "status": "planned" + }, + "time": { + "start": 1790580587, + "finish": 1790580587.569156, + "duration": 0.5691559314727783, + "processing": 0, + "date_start": "2026-09-28T10:29:47+03:00", + "date_finish": "2026-09-28T10:29:47+03:00", + "operating_reset_at": 1790581187, + "operating": 0 } }, "returns": [ @@ -41,84 +51,14 @@ "type": "object", "base": "object", "required": false, - "description": "Объект, содержащий данные о спринте" - }, - { - "name": "id", - "type": "integer", - "base": "integer", - "required": false, - "description": "Идентификатор спринта" + "description": "Данные спринта (подробное описание)" }, { - "name": "groupId", - "type": "integer", - "base": "integer", - "required": false, - "description": "Идентификатор группы (Скрама), к которой относится спринт" - }, - { - "name": "entityType", - "type": "string", - "base": "string", - "required": false, - "description": "Тип сущности (в данном случае sprint)" - }, - { - "name": "name", - "type": "string", - "base": "string", - "required": false, - "description": "Название спринта" - }, - { - "name": "goal", - "type": "string", - "base": "string", - "required": false, - "description": "Цель спринта. Устанавливается только в интерфейсе при запуске спринта" - }, - { - "name": "sort", - "type": "integer", - "base": "integer", - "required": false, - "description": "Сортировка" - }, - { - "name": "createdBy", - "type": "integer", - "base": "integer", - "required": false, - "description": "Идентификатор пользователя, создавшего спринт" - }, - { - "name": "modifiedBy", - "type": "integer", - "base": "integer", - "required": false, - "description": "Идентификатор пользователя, изменившего спринт" - }, - { - "name": "dateStart", - "type": "string", - "base": "string", - "required": false, - "description": "Дата начала спринта в формате ISO 8601" - }, - { - "name": "dateEnd", - "type": "string", - "base": "string", - "required": false, - "description": "Дата окончания спринта в формате ISO 8601" - }, - { - "name": "status", - "type": "string", - "base": "string", + "name": "time", + "type": "time", + "base": "object", "required": false, - "description": "Статус спринта" + "description": "Информация о времени выполнения запроса" } ], "page": "/api-reference/sonet-group/scrum/sprint/tasks-api-scrum-sprint-get.html", @@ -135,5 +75,8 @@ "name", "sort", "status" - ] + ], + "requestExample": { + "id": 2 + } } diff --git a/_assets/simulator/spec/methods/tasks.api.scrum.sprint.getFields.json b/_assets/simulator/spec/methods/tasks.api.scrum.sprint.getFields.json index caede7743..492a0355d 100644 --- a/_assets/simulator/spec/methods/tasks.api.scrum.sprint.getFields.json +++ b/_assets/simulator/spec/methods/tasks.api.scrum.sprint.getFields.json @@ -7,60 +7,26 @@ "permissions": "любой пользователь", "params": [ { - "name": "groupId", - "type": "integer", - "base": "integer", - "required": "unknown", - "description": "Идентификатор группы (Скрама), к которой относится спринт" - }, - { - "name": "name", - "type": "string", - "base": "string", - "required": "unknown", - "description": "Название спринта" - }, - { - "name": "sort", - "type": "integer", - "base": "integer", - "required": "unknown", - "description": "Сортировка" - }, - { - "name": "createdBy", - "type": "integer", - "base": "integer", - "required": "unknown", - "description": "Идентификатор пользователя, создавшего спринт" - }, - { - "name": "modifiedBy", - "type": "integer", - "base": "integer", - "required": "unknown", - "description": "Идентификатор пользователя, изменившего спринт" - }, - { - "name": "dateStart", - "type": "string", - "base": "string", - "required": "unknown", - "description": "Дата начала спринта в формате ISO 8601" - }, - { - "name": "dateEnd", - "type": "string", - "base": "string", - "required": "unknown", - "description": "Дата окончания спринта в формате ISO 8601" + "name": "result", + "type": "object", + "base": "object", + "required": "unknown", + "description": "Объект с ключом fields (подробное описание)", + "dynamic": { + "allowed": true, + "note": "Состав полей не описан подтаблицей на этой странице" + } }, { - "name": "status", - "type": "string", - "base": "string", + "name": "time", + "type": "time", + "base": "object", "required": "unknown", - "description": "Статус спринта" + "description": "Информация о времени выполнения запроса", + "dynamic": { + "allowed": true, + "note": "Состав полей не описан подтаблицей на этой странице" + } } ], "defs": {}, @@ -97,66 +63,35 @@ "type": "string" } } + }, + "time": { + "start": 1790580587, + "finish": 1790580587.569156, + "duration": 0.5691559314727783, + "processing": 0, + "date_start": "2026-09-28T10:29:47+03:00", + "date_finish": "2026-09-28T10:29:47+03:00", + "operating_reset_at": 1790581187, + "operating": 0 } }, "returns": [ { - "name": "groupId", - "type": "integer", - "base": "integer", - "required": "unknown", - "description": "Идентификатор группы (Скрама), к которой относится спринт" - }, - { - "name": "name", - "type": "string", - "base": "string", - "required": "unknown", - "description": "Название спринта" - }, - { - "name": "sort", - "type": "integer", - "base": "integer", - "required": "unknown", - "description": "Сортировка" - }, - { - "name": "createdBy", - "type": "integer", - "base": "integer", - "required": "unknown", - "description": "Идентификатор пользователя, создавшего спринт" - }, - { - "name": "modifiedBy", - "type": "integer", - "base": "integer", - "required": "unknown", - "description": "Идентификатор пользователя, изменившего спринт" - }, - { - "name": "dateStart", - "type": "string", - "base": "string", - "required": "unknown", - "description": "Дата начала спринта в формате ISO 8601" - }, - { - "name": "dateEnd", - "type": "string", - "base": "string", + "name": "result", + "type": "object", + "base": "object", "required": "unknown", - "description": "Дата окончания спринта в формате ISO 8601" + "description": "Объект с ключом fields (подробное описание)" }, { - "name": "status", - "type": "string", - "base": "string", + "name": "time", + "type": "time", + "base": "object", "required": "unknown", - "description": "Статус спринта" + "description": "Информация о времени выполнения запроса" } ], "page": "/api-reference/sonet-group/scrum/sprint/tasks-api-scrum-sprint-get-fields.html", - "executable": false + "executable": false, + "requestExample": {} } diff --git a/_assets/simulator/spec/methods/tasks.api.scrum.sprint.list.json b/_assets/simulator/spec/methods/tasks.api.scrum.sprint.list.json index 3d343e576..1572455b7 100644 --- a/_assets/simulator/spec/methods/tasks.api.scrum.sprint.list.json +++ b/_assets/simulator/spec/methods/tasks.api.scrum.sprint.list.json @@ -10,8 +10,8 @@ "name": "order", "type": "object", "base": "object", - "required": "unknown", - "description": "Объект для сортировки результата. Объект вида {'поле_сортировки': 'направление сортировки' [, ...]}. Доступные поля описаны в таблице ниже. Направление сортировки может принимать значения: - asc — по возрастанию - desc — по убыванию", + "required": false, + "description": "Объект вида {'поле_сортировки': 'направление_сортировки' [, ...]}, например {\"ID\": \"desc\"}. Направление сортировки может принимать значения: - asc — по возрастанию - desc — по убыванию", "dynamic": { "allowed": true, "note": "Состав полей не описан подтаблицей на этой странице" @@ -21,8 +21,8 @@ "name": "filter", "type": "object", "base": "object", - "required": "unknown", - "description": "Объект вида {'фильтруемое_поле': 'значение фильтра' [, ...]}. Доступные поля описаны в таблице ниже", + "required": false, + "description": "Объект вида {'фильтруемое_поле': 'значение фильтра' [, ...]}, например {\"GROUP_ID\": 1, \"STATUS\": \"active\"}. Перед именем поля можно указать оператор: - > и < — больше и меньше - >= и <= — больше или равно, меньше или равно - ! — не равно - % — содержит подстроку Например, {\">ID\": 20} или {\"%NAME\": \"Спринт\"}.…", "dynamic": { "allowed": true, "note": "Состав полей не описан подтаблицей на этой странице" @@ -30,10 +30,10 @@ }, { "name": "select", - "type": "object", - "base": "object", - "required": "unknown", - "description": "Массив полей записей, которые будут возвращены методом. Можно указать только те поля, которые необходимы. Если в массиве присутствует значение \"*\", то будут возвращены все доступные поля. Значение по умолчанию — пустой массив array(). В этом случае будут возвращены все поля основной таблицы запроса", + "type": "array", + "base": "array", + "required": false, + "description": "Массив полей, которые нужно заполнить в ответе, например [\"ID\", \"NAME\", \"STATUS\"]. Если в массиве есть значение \"*\" или массив не передан, заполняются все поля. Ответ всегда содержит полный набор ключей спринта. Поля, которых нет в select, возвращаются с пустыми значениями: 0 для чисел и \"\" для строк", "dynamic": { "allowed": true, "note": "Состав полей не описан подтаблицей на этой странице" @@ -43,138 +43,78 @@ "name": "start", "type": "integer", "base": "integer", - "required": "unknown", - "description": "Номер страницы вывода. Работает для https запросов" + "required": false, + "description": "Смещение для постраничной навигации. Метод возвращает до 50 спринтов за вызов. Чтобы получить следующую страницу, увеличьте start на 50. Ответ не содержит полей total и next: если пришло меньше 50 спринтов, это последняя страница" } ], "defs": {}, - "requiredConvention": false, + "requiredConvention": true, "confidence": "parsed", "source": { "file": "api-reference/sonet-group/scrum/sprint/tasks-api-scrum-sprint-list.md" }, - "resultExample": [ - { - "id": 2, - "groupId": 143, - "entityType": "sprint", - "name": "Спринт 1", - "goal": "", - "sort": 1, - "createdBy": 1, - "modifiedBy": 1, - "dateStart": "2024-07-19T15:03:01+00:00", - "dateEnd": "2024-08-02T15:03:01+00:00", - "status": "planned" - }, - { - "id": 3, - "groupId": 1, - "entityType": "sprint", - "name": "Sprint 1", - "goal": "", - "sort": 1, - "createdBy": 1, - "modifiedBy": 1, - "dateStart": "2021-11-21T22:00:00+00:00", - "dateEnd": "2021-11-28T22:00:00+00:00", - "status": "planned" + "resultExample": { + "result": [ + { + "id": 3, + "groupId": 1, + "entityType": "sprint", + "name": "Sprint 1", + "goal": "", + "sort": 1, + "createdBy": 1, + "modifiedBy": 1, + "dateStart": "2021-11-21T22:00:00+00:00", + "dateEnd": "2021-11-28T22:00:00+00:00", + "status": "active" + } + ], + "time": { + "start": 1790580587, + "finish": 1790580587.569156, + "duration": 0.5691559314727783, + "processing": 0, + "date_start": "2026-09-28T10:29:47+03:00", + "date_finish": "2026-09-28T10:29:47+03:00", + "operating_reset_at": 1790581187, + "operating": 0 } - ], + }, "returns": [ { "name": "result", - "type": "object", - "base": "object", - "required": "unknown", - "description": "Объект, содержащий данные о спринте" - }, - { - "name": "id", - "type": "integer", - "base": "integer", - "required": "unknown", - "description": "Идентификатор спринта" - }, - { - "name": "groupId", - "type": "integer", - "base": "integer", - "required": "unknown", - "description": "Идентификатор группы (Скрама), к которой относится спринт" - }, - { - "name": "entityType", - "type": "string", - "base": "string", - "required": "unknown", - "description": "Тип сущности (в данном случае sprint)" - }, - { - "name": "name", - "type": "string", - "base": "string", - "required": "unknown", - "description": "Название спринта" + "type": "array", + "base": "array", + "required": false, + "description": "Массив спринтов. Если под фильтр не подошел ни один спринт, метод возвращает пустой массив, а не ошибку. Поля элемента массива (подробное описание)" }, { - "name": "goal", - "type": "string", - "base": "string", - "required": "unknown", - "description": "Цель спринта. Устанавливается только в интерфейсе при запуске спринта" - }, - { - "name": "sort", - "type": "integer", - "base": "integer", - "required": "unknown", - "description": "Сортировка" - }, - { - "name": "createdBy", - "type": "integer", - "base": "integer", - "required": "unknown", - "description": "Идентификатор пользователя, создавшего спринт" - }, - { - "name": "modifiedBy", - "type": "integer", - "base": "integer", - "required": "unknown", - "description": "Идентификатор пользователя, изменившего спринт" - }, - { - "name": "dateStart", - "type": "string", - "base": "string", - "required": "unknown", - "description": "Дата начала спринта в формате ISO 8601" - }, - { - "name": "dateEnd", - "type": "string", - "base": "string", - "required": "unknown", - "description": "Дата окончания спринта в формате ISO 8601" - }, - { - "name": "status", - "type": "string", - "base": "string", - "required": "unknown", - "description": "Статус спринта" + "name": "time", + "type": "time", + "base": "object", + "required": false, + "description": "Информация о времени выполнения запроса" } ], "page": "/api-reference/sonet-group/scrum/sprint/tasks-api-scrum-sprint-list.html", "executable": false, "entityFields": [ + "createdBy", "dateEnd", "dateStart", + "entityType", + "goal", "groupId", + "id", + "modifiedBy", "name", "sort", "status" - ] + ], + "requestExample": { + "filter": { + "GROUP_ID": 1, + "STATUS": "active" + } + } } diff --git a/_assets/simulator/spec/methods/tasks.api.scrum.sprint.start.json b/_assets/simulator/spec/methods/tasks.api.scrum.sprint.start.json index e6811f65c..f29c002af 100644 --- a/_assets/simulator/spec/methods/tasks.api.scrum.sprint.start.json +++ b/_assets/simulator/spec/methods/tasks.api.scrum.sprint.start.json @@ -4,14 +4,14 @@ "scope": "task", "kind": "write", "title": "Запустить спринт tasks.api.scrum.sprint.start", - "permissions": "любой пользователь", + "permissions": "владелец или модератор Скрама, администратор Битрикс24", "params": [ { "name": "id", "type": "integer", "base": "integer", "required": true, - "description": "Идентификатор спринта" + "description": "Идентификатор спринта. Идентификатор можно получить методом tasks.api.scrum.sprint.list с фильтром {\"GROUP_ID\": <идентификатор Скрама>, \"STATUS\": \"planned\"}" } ], "defs": {}, @@ -26,13 +26,23 @@ "groupId": 143, "entityType": "sprint", "name": "Спринт 1", - "goal": "Цель спринта", + "goal": "", "sort": 1, "createdBy": 1, "modifiedBy": 1, "dateStart": "2024-07-19T15:03:01+00:00", "dateEnd": "2024-08-02T15:03:01+00:00", "status": "active" + }, + "time": { + "start": 1790580587, + "finish": 1790580587.569156, + "duration": 0.5691559314727783, + "processing": 0, + "date_start": "2026-09-28T10:29:47+03:00", + "date_finish": "2026-09-28T10:29:47+03:00", + "operating_reset_at": 1790581187, + "operating": 0 } }, "returns": [ @@ -41,86 +51,19 @@ "type": "object", "base": "object", "required": false, - "description": "Объект, содержащий данные о спринте" - }, - { - "name": "id", - "type": "integer", - "base": "integer", - "required": false, - "description": "Идентификатор спринта" - }, - { - "name": "groupId", - "type": "integer", - "base": "integer", - "required": false, - "description": "Идентификатор группы (Скрама), к которой относится спринт" - }, - { - "name": "entityType", - "type": "string", - "base": "string", - "required": false, - "description": "Тип сущности (в данном случае sprint)" + "description": "Данные спринта (подробное описание)" }, { - "name": "name", - "type": "string", - "base": "string", - "required": false, - "description": "Название спринта" - }, - { - "name": "goal", - "type": "string", - "base": "string", - "required": false, - "description": "Цель спринта. Уустанавливается только в интерфейсе при запуске спринта" - }, - { - "name": "sort", - "type": "integer", - "base": "integer", - "required": false, - "description": "Сортировка" - }, - { - "name": "createdBy", - "type": "integer", - "base": "integer", - "required": false, - "description": "Идентификатор пользователя, создавшего спринт" - }, - { - "name": "modifiedBy", - "type": "integer", - "base": "integer", - "required": false, - "description": "Идентификатор пользователя, изменившего спринт" - }, - { - "name": "dateStart", - "type": "string", - "base": "string", - "required": false, - "description": "Дата начала спринта в формате ISO 8601" - }, - { - "name": "dateEnd", - "type": "string", - "base": "string", - "required": false, - "description": "Дата окончания спринта в формате ISO 8601" - }, - { - "name": "status", - "type": "string", - "base": "string", + "name": "time", + "type": "time", + "base": "object", "required": false, - "description": "Статус спринта" + "description": "Информация о времени выполнения запроса" } ], "page": "/api-reference/sonet-group/scrum/sprint/tasks-api-scrum-sprint-start.html", - "executable": false + "executable": false, + "requestExample": { + "id": 2 + } } diff --git a/_assets/simulator/spec/methods/tasks.api.scrum.sprint.update.json b/_assets/simulator/spec/methods/tasks.api.scrum.sprint.update.json index b2c8d38ee..0e2c485b7 100644 --- a/_assets/simulator/spec/methods/tasks.api.scrum.sprint.update.json +++ b/_assets/simulator/spec/methods/tasks.api.scrum.sprint.update.json @@ -11,14 +11,14 @@ "type": "integer", "base": "integer", "required": true, - "description": "Идентификатор спринта" + "description": "Идентификатор спринта. Идентификатор можно получить методом tasks.api.scrum.sprint.list" }, { "name": "fields", "type": "object", "base": "object", "required": true, - "description": "Объект с данными спринта", + "description": "Объект с данными спринта (подробное описание)", "ref": "#/defs/fieldsFields" } ], @@ -35,7 +35,7 @@ "type": "integer", "base": "integer", "required": false, - "description": "Идентификатор группы (Скрама), к которой относится спринт. Идентификатор можно получить методом tasks.api.scrum.sprint.get для уже существующего спринта" + "description": "Идентификатор группы (Скрама), к которой относится спринт. Идентификатор можно получить методом socialnetwork.api.workgroup.list. Группа является Скрамом, если у нее заполнено поле SCRUM_MASTER_ID. Другой groupId переносит спринт в другой Скрам. Перенести можно только спринт без задач" }, { "name": "name", @@ -44,12 +44,26 @@ "required": false, "description": "Название спринта" }, + { + "name": "createdBy", + "type": "integer", + "base": "integer", + "required": false, + "description": "Идентификатор пользователя, создавшего спринт. Идентификатор можно получить методом user.get" + }, + { + "name": "modifiedBy", + "type": "integer", + "base": "integer", + "required": false, + "description": "Идентификатор пользователя, изменившего спринт" + }, { "name": "sort", "type": "integer", "base": "integer", "required": false, - "description": "Сортировка" + "description": "Порядок сортировки спринта" }, { "name": "dateStart", @@ -70,7 +84,21 @@ "type": "string", "base": "string", "required": false, - "description": "Статус спринта. Доступные значения: active, planned, completed" + "description": "Статус спринта. Доступные значения: - planned — запланирован - active — активен. В Скраме может быть только один активный спринт - completed — завершен Чтобы запустить или завершить спринт, используйте методы tasks.api.scrum.sprint.start и tasks.api.scrum.sprint.complete", + "values": [ + { + "value": "planned", + "title": "запланирован" + }, + { + "value": "active", + "title": "активен" + }, + { + "value": "completed", + "title": "завершен Чтобы запустить или завершить спринт, используйте методы tasks.api.scru" + } + ] } ] } @@ -93,6 +121,16 @@ "dateStart": "2021-11-22T00:00:00+02:00", "dateEnd": "2021-11-29T00:00:00+02:00", "status": "planned" + }, + "time": { + "start": 1790580587, + "finish": 1790580587.569156, + "duration": 0.5691559314727783, + "processing": 0, + "date_start": "2026-09-28T10:29:47+03:00", + "date_finish": "2026-09-28T10:29:47+03:00", + "operating_reset_at": 1790581187, + "operating": 0 } }, "returns": [ @@ -101,86 +139,25 @@ "type": "object", "base": "object", "required": false, - "description": "Объект, содержащий данные о спринте" + "description": "Данные спринта (подробное описание)" }, { - "name": "id", - "type": "integer", - "base": "integer", - "required": false, - "description": "Идентификатор спринта" - }, - { - "name": "groupId", - "type": "integer", - "base": "integer", - "required": false, - "description": "Идентификатор группы (Скрама), к которой относится спринт" - }, - { - "name": "entityType", - "type": "string", - "base": "string", - "required": false, - "description": "Тип сущности (в данном случае sprint)" - }, - { - "name": "name", - "type": "string", - "base": "string", - "required": false, - "description": "Название спринта" - }, - { - "name": "goal", - "type": "string", - "base": "string", - "required": false, - "description": "Цель спринта. Устанавливается только в интерфейсе при запуске спринта" - }, - { - "name": "sort", - "type": "integer", - "base": "integer", - "required": false, - "description": "Сортировка" - }, - { - "name": "createdBy", - "type": "integer", - "base": "integer", - "required": false, - "description": "Идентификатор пользователя, создавшего спринт" - }, - { - "name": "modifiedBy", - "type": "integer", - "base": "integer", - "required": false, - "description": "Идентификатор пользователя, изменившего спринт" - }, - { - "name": "dateStart", - "type": "string", - "base": "string", - "required": false, - "description": "Дата начала спринта в формате ISO 8601" - }, - { - "name": "dateEnd", - "type": "string", - "base": "string", - "required": false, - "description": "Дата окончания спринта в формате ISO 8601" - }, - { - "name": "status", - "type": "string", - "base": "string", + "name": "time", + "type": "time", + "base": "object", "required": false, - "description": "Статус спринта" + "description": "Информация о времени выполнения запроса" } ], "page": "/api-reference/sonet-group/scrum/sprint/tasks-api-scrum-sprint-update.html", - "executable": false + "executable": false, + "requestExample": { + "id": 2, + "fields": { + "name": "Sprint 2", + "groupId": 1, + "dateStart": "2021-11-22T00:00:00+02:00", + "dateEnd": "2021-11-29T00:00:00+02:00" + } + } } diff --git a/_assets/simulator/spec/methods/tasks.api.scrum.task.get.json b/_assets/simulator/spec/methods/tasks.api.scrum.task.get.json index d38b2537d..2f260e624 100644 --- a/_assets/simulator/spec/methods/tasks.api.scrum.task.get.json +++ b/_assets/simulator/spec/methods/tasks.api.scrum.task.get.json @@ -3,7 +3,7 @@ "method": "tasks.api.scrum.task.get", "scope": "task", "kind": "read", - "title": "Получить поля задачи Скрама по id tasks.api.scrum.task.get", + "title": "Получить поля задачи Скрама по идентификатору tasks.api.scrum.task.get", "permissions": "любой пользователь, имеющий доступ к Скраму", "params": [ { @@ -26,8 +26,10 @@ "storyPoints": "2", "epicId": 4, "sort": 1, + "sortFloat": 1, "createdBy": 1, - "modifiedBy": 1 + "modifiedBy": 1, + "groupId": 7 }, "time": { "start": 1721402687.900315, @@ -45,54 +47,12 @@ "type": "object", "base": "object", "required": false, - "description": "Объект с данными задачи" - }, - { - "name": "entityId", - "type": "integer", - "base": "integer", - "required": false, - "description": "Идентификатор бэклога или спринта" - }, - { - "name": "storyPoints", - "type": "string", - "base": "string", - "required": false, - "description": "Количество стори поинтов. Тип данных — строка, так как стори поинтом необязательно будет число" - }, - { - "name": "epicId", - "type": "integer", - "base": "integer", - "required": false, - "description": "Идентификатор эпика" - }, - { - "name": "sort", - "type": "integer", - "base": "integer", - "required": false, - "description": "Сортировка" - }, - { - "name": "createdBy", - "type": "integer", - "base": "integer", - "required": false, - "description": "Идентификатор пользователя, создавшего задачу" - }, - { - "name": "modifiedBy", - "type": "integer", - "base": "integer", - "required": false, - "description": "Идентификатор пользователя, который последним изменял задачу" + "description": "Объект с данными задачи Скрама (подробное описание)" }, { "name": "time", - "type": "array", - "base": "array", + "type": "time", + "base": "object", "required": false, "description": "Информация о времени выполнения запроса" } @@ -103,8 +63,13 @@ "createdBy", "entityId", "epicId", + "groupId", "modifiedBy", "sort", + "sortFloat", "storyPoints" - ] + ], + "requestExample": { + "id": 1 + } } diff --git a/_assets/simulator/spec/methods/tasks.api.scrum.task.getFields.json b/_assets/simulator/spec/methods/tasks.api.scrum.task.getFields.json index 117304880..96974dff3 100644 --- a/_assets/simulator/spec/methods/tasks.api.scrum.task.getFields.json +++ b/_assets/simulator/spec/methods/tasks.api.scrum.task.getFields.json @@ -7,46 +7,15 @@ "permissions": "любой пользователь", "params": [ { - "name": "entityId", - "type": "integer", - "base": "integer", + "name": "result", + "type": "object", + "base": "object", "required": "unknown", - "description": "Идентификатор бэклога или спринта" - }, - { - "name": "storyPoints", - "type": "string", - "base": "string", - "required": "unknown", - "description": "Стори Поинты (относительная оценка сложности задачи). Может иметь строковое значение" - }, - { - "name": "epicId", - "type": "integer", - "base": "integer", - "required": "unknown", - "description": "Идентификатор эпика" - }, - { - "name": "sort", - "type": "integer", - "base": "integer", - "required": "unknown", - "description": "Сортировка" - }, - { - "name": "createdBy", - "type": "integer", - "base": "integer", - "required": "unknown", - "description": "Кем создана задача" - }, - { - "name": "modifiedBy", - "type": "integer", - "base": "integer", - "required": "unknown", - "description": "Кем изменена задача" + "description": "Корневой элемент ответа (подробное описание)", + "dynamic": { + "allowed": true, + "note": "Состав полей не описан подтаблицей на этой странице" + } } ], "defs": {}, @@ -56,27 +25,42 @@ "file": "api-reference/sonet-group/scrum/task/tasks-api-scrum-task-get-fields.md" }, "resultExample": { - "fields": { - "entityId": { - "type": "integer" - }, - "storyPoints": { - "type": "string" - }, - "epicId": { - "type": "integer" - }, - "sort": { - "type": "integer" - }, - "createdBy": { - "type": "integer" - }, - "modifiedBy": { - "type": "integer" + "result": { + "fields": { + "entityId": { + "type": "integer" + }, + "storyPoints": { + "type": "string" + }, + "epicId": { + "type": "integer" + }, + "sort": { + "type": "integer" + }, + "sortFloat": { + "type": "float" + }, + "createdBy": { + "type": "integer" + }, + "modifiedBy": { + "type": "integer" + } } } }, + "returns": [ + { + "name": "result", + "type": "object", + "base": "object", + "required": "unknown", + "description": "Корневой элемент ответа (подробное описание)" + } + ], "page": "/api-reference/sonet-group/scrum/task/tasks-api-scrum-task-get-fields.html", - "executable": false + "executable": false, + "requestExample": {} } diff --git a/_assets/simulator/spec/methods/tasks.api.scrum.task.update.json b/_assets/simulator/spec/methods/tasks.api.scrum.task.update.json index bf7183c46..5d99c5fb5 100644 --- a/_assets/simulator/spec/methods/tasks.api.scrum.task.update.json +++ b/_assets/simulator/spec/methods/tasks.api.scrum.task.update.json @@ -4,7 +4,7 @@ "scope": "task", "kind": "write", "title": "Создать или обновить задачу Скрама tasks.api.scrum.task.update", - "permissions": "любой пользователь, имеющий доступ к Скраму", + "permissions": "пользователь с правами на изменение задачи и Скрама", "params": [ { "name": "id", @@ -35,7 +35,7 @@ "type": "integer", "base": "integer", "required": false, - "description": "Идентификатор бэклога или спринта. Если значение не указано, Битрикс24 автоматически добавит задачу в бэклог Скрама, если он существует" + "description": "Идентификатор бэклога или спринта. Параметр обязателен при добавлении задачи в Скрам. Для существующей задачи Скрама параметр можно не передавать, если не нужно перемещать ее между бэклогом и спринтами" }, { "name": "storyPoints", @@ -57,6 +57,27 @@ "base": "integer", "required": false, "description": "Сортировка" + }, + { + "name": "sortFloat", + "type": "float", + "base": "number", + "required": false, + "description": "Значение сортировки с дробной частью" + }, + { + "name": "createdBy", + "type": "integer", + "base": "integer", + "required": false, + "description": "Идентификатор пользователя, который создал запись задачи в Скраме" + }, + { + "name": "modifiedBy", + "type": "integer", + "base": "integer", + "required": false, + "description": "Идентификатор пользователя, который изменил запись задачи в Скраме" } ] } @@ -67,33 +88,41 @@ "file": "api-reference/sonet-group/scrum/task/tasks-api-scrum-task-update.md" }, "resultExample": { - "status": "success", - "data": true, - "errors": [] + "result": true, + "time": { + "start": 1721402687.900315, + "finish": 1721402694.313811, + "duration": 6.413496017456055, + "processing": 6.387248992919922, + "date_start": "2024-07-19T15:24:47+00:00", + "date_finish": "2024-07-19T15:24:54+00:00", + "operating": 6.387217998504639 + } }, "returns": [ { - "name": "status", - "type": "string", - "base": "string", - "required": false, - "description": "Статус ответа. Возможные значения: - success - error" - }, - { - "name": "data", + "name": "result", "type": "boolean", "base": "boolean", "required": false, - "description": "Возвращает: - true — в случае успеха - null — в случае ошибки" + "description": "Возвращает true, если задача Скрама создана или обновлена" }, { - "name": "errors", - "type": "array", - "base": "array", + "name": "time", + "type": "time", + "base": "object", "required": false, - "description": "Массив ошибок" + "description": "Информация о времени выполнения запроса" } ], "page": "/api-reference/sonet-group/scrum/task/tasks-api-scrum-task-update.html", - "executable": false + "executable": false, + "requestExample": { + "id": 1, + "fields": { + "epicId": 1, + "storyPoints": "8", + "entityId": 2 + } + } } diff --git a/_assets/simulator/spec/methods/tasks.flow.Flow.activate.json b/_assets/simulator/spec/methods/tasks.flow.Flow.activate.json index 4bdbc7df9..e8acbb2b1 100644 --- a/_assets/simulator/spec/methods/tasks.flow.Flow.activate.json +++ b/_assets/simulator/spec/methods/tasks.flow.Flow.activate.json @@ -33,5 +33,8 @@ } ], "page": "/api-reference/tasks/flow/tasks-flow-flow-activate.html", - "executable": false + "executable": false, + "requestExample": { + "flowId": 517 + } } diff --git a/_assets/simulator/spec/methods/tasks.flow.Flow.create.json b/_assets/simulator/spec/methods/tasks.flow.Flow.create.json index c4f7caf04..23351fec7 100644 --- a/_assets/simulator/spec/methods/tasks.flow.Flow.create.json +++ b/_assets/simulator/spec/methods/tasks.flow.Flow.create.json @@ -364,5 +364,27 @@ } ], "page": "/api-reference/tasks/flow/tasks-flow-flow-create.html", - "executable": false + "executable": false, + "requestExample": { + "flowData": { + "name": "Unique Flow Name", + "description": "Описание потока", + "plannedCompletionTime": 7200, + "distributionType": "manually", + "responsibleList": [ + [ + "user", + "3" + ] + ], + "taskCreators": [ + [ + "meta-user", + "all-users" + ] + ], + "matchWorkTime": 1, + "notifyAtHalfTime": 0 + } + } } diff --git a/_assets/simulator/spec/methods/tasks.flow.Flow.get.json b/_assets/simulator/spec/methods/tasks.flow.Flow.get.json index 4ce8017e6..20e4c9589 100644 --- a/_assets/simulator/spec/methods/tasks.flow.Flow.get.json +++ b/_assets/simulator/spec/methods/tasks.flow.Flow.get.json @@ -241,5 +241,8 @@ } ], "page": "/api-reference/tasks/flow/tasks-flow-flow-get.html", - "executable": false + "executable": false, + "requestExample": { + "flowId": 517 + } } diff --git a/_assets/simulator/spec/methods/tasks.flow.Flow.pin.json b/_assets/simulator/spec/methods/tasks.flow.Flow.pin.json index dafdf6055..1877e452e 100644 --- a/_assets/simulator/spec/methods/tasks.flow.Flow.pin.json +++ b/_assets/simulator/spec/methods/tasks.flow.Flow.pin.json @@ -43,5 +43,8 @@ } ], "page": "/api-reference/tasks/flow/tasks-flow-flow-pin.html", - "executable": false + "executable": false, + "requestExample": { + "flowId": 517 + } } diff --git a/_assets/simulator/spec/methods/tasks.flow.Flow.update.json b/_assets/simulator/spec/methods/tasks.flow.Flow.update.json index 492800bc1..9cf5ab14c 100644 --- a/_assets/simulator/spec/methods/tasks.flow.Flow.update.json +++ b/_assets/simulator/spec/methods/tasks.flow.Flow.update.json @@ -371,5 +371,28 @@ } ], "page": "/api-reference/tasks/flow/tasks-flow-flow-update.html", - "executable": false + "executable": false, + "requestExample": { + "flowData": { + "id": 517, + "name": "Updated Flow Name", + "description": "Updated description", + "plannedCompletionTime": 7200, + "distributionType": "manually", + "responsibleList": [ + [ + "user", + "3" + ] + ], + "taskCreators": [ + [ + "meta-user", + "all-users" + ] + ], + "matchWorkTime": 1, + "notifyAtHalfTime": 0 + } + } } diff --git a/_assets/simulator/spec/methods/tasks.task.access.field.get.json b/_assets/simulator/spec/methods/tasks.task.access.field.get.json index 61f8fedc2..955355d28 100644 --- a/_assets/simulator/spec/methods/tasks.task.access.field.get.json +++ b/_assets/simulator/spec/methods/tasks.task.access.field.get.json @@ -95,5 +95,17 @@ "title", "type", "validationRules" - ] + ], + "requestExample": { + "name": "id", + "select": [ + "name", + "type", + "title", + "description", + "filterable", + "sortable", + "multiple" + ] + } } diff --git a/_assets/simulator/spec/methods/tasks.task.access.field.list.json b/_assets/simulator/spec/methods/tasks.task.access.field.list.json index a8a400607..7a3d6d651 100644 --- a/_assets/simulator/spec/methods/tasks.task.access.field.list.json +++ b/_assets/simulator/spec/methods/tasks.task.access.field.list.json @@ -90,5 +90,16 @@ "title", "type", "validationRules" - ] + ], + "requestExample": { + "select": [ + "name", + "type", + "title", + "description", + "filterable", + "sortable", + "multiple" + ] + } } diff --git a/_assets/simulator/spec/methods/tasks.task.access.get.json b/_assets/simulator/spec/methods/tasks.task.access.get.json index 3f1da8b32..9be8cdee5 100644 --- a/_assets/simulator/spec/methods/tasks.task.access.get.json +++ b/_assets/simulator/spec/methods/tasks.task.access.get.json @@ -143,5 +143,8 @@ "take", "timeTracking", "watch" - ] + ], + "requestExample": { + "id": 8017 + } } diff --git a/_assets/simulator/spec/methods/tasks.task.add.json b/_assets/simulator/spec/methods/tasks.task.add.json index 3776d9c72..8490dd93a 100644 --- a/_assets/simulator/spec/methods/tasks.task.add.json +++ b/_assets/simulator/spec/methods/tasks.task.add.json @@ -191,5 +191,23 @@ } ], "page": "/api-reference/tasks/tasks-task-add.html", - "executable": false + "executable": false, + "requestExample": { + "fields": { + "TITLE": "Название задачи", + "DEADLINE": "2025-12-31T23:59:59", + "CREATED_BY": 456, + "RESPONSIBLE_ID": 123, + "UF_CRM_TASK": [ + "L_4", + "C_7", + "CO_5", + "D_10" + ], + "UF_TASK_WEBDAV_FILES": [ + "n12345", + "n67890" + ] + } + } } diff --git a/_assets/simulator/spec/methods/tasks.task.approve.json b/_assets/simulator/spec/methods/tasks.task.approve.json index 42d99d347..41ce1803d 100644 --- a/_assets/simulator/spec/methods/tasks.task.approve.json +++ b/_assets/simulator/spec/methods/tasks.task.approve.json @@ -372,5 +372,8 @@ } ], "page": "/api-reference/tasks/tasks-task-approve.html", - "executable": false + "executable": false, + "requestExample": { + "taskId": 8017 + } } diff --git a/_assets/simulator/spec/methods/tasks.task.chat.message.field.get.json b/_assets/simulator/spec/methods/tasks.task.chat.message.field.get.json index 74fa24fdd..c4b627ec8 100644 --- a/_assets/simulator/spec/methods/tasks.task.chat.message.field.get.json +++ b/_assets/simulator/spec/methods/tasks.task.chat.message.field.get.json @@ -87,5 +87,17 @@ "sortable", "title", "type" - ] + ], + "requestExample": { + "name": "taskId", + "select": [ + "name", + "type", + "title", + "description", + "filterable", + "sortable", + "multiple" + ] + } } diff --git a/_assets/simulator/spec/methods/tasks.task.chat.message.field.list.json b/_assets/simulator/spec/methods/tasks.task.chat.message.field.list.json index 6b4199088..7262e0b38 100644 --- a/_assets/simulator/spec/methods/tasks.task.chat.message.field.list.json +++ b/_assets/simulator/spec/methods/tasks.task.chat.message.field.list.json @@ -100,5 +100,16 @@ "sortable", "title", "type" - ] + ], + "requestExample": { + "select": [ + "name", + "type", + "title", + "description", + "filterable", + "sortable", + "multiple" + ] + } } diff --git a/_assets/simulator/spec/methods/tasks.task.chat.message.send.json b/_assets/simulator/spec/methods/tasks.task.chat.message.send.json index c33bcfe5b..5f84e63b2 100644 --- a/_assets/simulator/spec/methods/tasks.task.chat.message.send.json +++ b/_assets/simulator/spec/methods/tasks.task.chat.message.send.json @@ -76,5 +76,11 @@ } ], "page": "/api-reference/tasks/tasks-task-chat-message-send.html", - "executable": false + "executable": false, + "requestExample": { + "fields": { + "taskId": 51, + "text": "Сообщение из внешней системы" + } + } } diff --git a/_assets/simulator/spec/methods/tasks.task.complete.json b/_assets/simulator/spec/methods/tasks.task.complete.json index 7d2f9c2e8..b006ce65b 100644 --- a/_assets/simulator/spec/methods/tasks.task.complete.json +++ b/_assets/simulator/spec/methods/tasks.task.complete.json @@ -398,5 +398,8 @@ } ], "page": "/api-reference/tasks/status/tasks-task-complete.html", - "executable": false + "executable": false, + "requestExample": { + "taskId": 1 + } } diff --git a/_assets/simulator/spec/methods/tasks.task.counters.get.json b/_assets/simulator/spec/methods/tasks.task.counters.get.json index 0dadc15ff..497a6009d 100644 --- a/_assets/simulator/spec/methods/tasks.task.counters.get.json +++ b/_assets/simulator/spec/methods/tasks.task.counters.get.json @@ -85,5 +85,10 @@ "entityFields": [ "code", "counter" - ] + ], + "requestExample": { + "userId": 547, + "groupId": 0, + "type": "view_all" + } } diff --git a/_assets/simulator/spec/methods/tasks.task.defer.json b/_assets/simulator/spec/methods/tasks.task.defer.json index 02cf253be..2e3b9a4d4 100644 --- a/_assets/simulator/spec/methods/tasks.task.defer.json +++ b/_assets/simulator/spec/methods/tasks.task.defer.json @@ -398,5 +398,8 @@ } ], "page": "/api-reference/tasks/status/tasks-task-defer.html", - "executable": false + "executable": false, + "requestExample": { + "taskId": 1 + } } diff --git a/_assets/simulator/spec/methods/tasks.task.delegate.json b/_assets/simulator/spec/methods/tasks.task.delegate.json index afe375c3d..e69b7a412 100644 --- a/_assets/simulator/spec/methods/tasks.task.delegate.json +++ b/_assets/simulator/spec/methods/tasks.task.delegate.json @@ -397,5 +397,9 @@ } ], "page": "/api-reference/tasks/tasks-task-delegate.html", - "executable": false + "executable": false, + "requestExample": { + "taskId": 8017, + "userId": 547 + } } diff --git a/_assets/simulator/spec/methods/tasks.task.delete.json b/_assets/simulator/spec/methods/tasks.task.delete.json index 6499e1935..1d57c4720 100644 --- a/_assets/simulator/spec/methods/tasks.task.delete.json +++ b/_assets/simulator/spec/methods/tasks.task.delete.json @@ -59,5 +59,8 @@ } ], "page": "/api-reference/tasks/tasks-task-delete.html", - "executable": false + "executable": false, + "requestExample": { + "taskId": 8131 + } } diff --git a/_assets/simulator/spec/methods/tasks.task.disapprove.json b/_assets/simulator/spec/methods/tasks.task.disapprove.json index d115dcfd8..be4236aac 100644 --- a/_assets/simulator/spec/methods/tasks.task.disapprove.json +++ b/_assets/simulator/spec/methods/tasks.task.disapprove.json @@ -372,5 +372,8 @@ } ], "page": "/api-reference/tasks/tasks-task-disapprove.html", - "executable": false + "executable": false, + "requestExample": { + "taskId": 8017 + } } diff --git a/_assets/simulator/spec/methods/tasks.task.favorite.add.json b/_assets/simulator/spec/methods/tasks.task.favorite.add.json index 9d3bf6cd3..8f1cb85ed 100644 --- a/_assets/simulator/spec/methods/tasks.task.favorite.add.json +++ b/_assets/simulator/spec/methods/tasks.task.favorite.add.json @@ -50,5 +50,8 @@ } ], "page": "/api-reference/tasks/user-actions/tasks-task-favorite-add.html", - "executable": false + "executable": false, + "requestExample": { + "taskId": 119 + } } diff --git a/_assets/simulator/spec/methods/tasks.task.favorite.remove.json b/_assets/simulator/spec/methods/tasks.task.favorite.remove.json index c16ca0824..bbb9a251e 100644 --- a/_assets/simulator/spec/methods/tasks.task.favorite.remove.json +++ b/_assets/simulator/spec/methods/tasks.task.favorite.remove.json @@ -50,5 +50,8 @@ } ], "page": "/api-reference/tasks/user-actions/tasks-task-favorite-remove.html", - "executable": false + "executable": false, + "requestExample": { + "taskId": 119 + } } diff --git a/_assets/simulator/spec/methods/tasks.task.field.get.json b/_assets/simulator/spec/methods/tasks.task.field.get.json index e8a087cec..5f2e358f9 100644 --- a/_assets/simulator/spec/methods/tasks.task.field.get.json +++ b/_assets/simulator/spec/methods/tasks.task.field.get.json @@ -95,5 +95,17 @@ "title", "type", "validationRules" - ] + ], + "requestExample": { + "name": "id", + "select": [ + "name", + "type", + "title", + "description", + "filterable", + "sortable", + "multiple" + ] + } } diff --git a/_assets/simulator/spec/methods/tasks.task.field.list.json b/_assets/simulator/spec/methods/tasks.task.field.list.json index 40b99de04..decdab0bd 100644 --- a/_assets/simulator/spec/methods/tasks.task.field.list.json +++ b/_assets/simulator/spec/methods/tasks.task.field.list.json @@ -48,5 +48,16 @@ } ], "page": "/api-reference/tasks/tasks-task-field-list.html", - "executable": false + "executable": false, + "requestExample": { + "select": [ + "name", + "type", + "title", + "description", + "filterable", + "sortable", + "multiple" + ] + } } diff --git a/_assets/simulator/spec/methods/tasks.task.file.attach.json b/_assets/simulator/spec/methods/tasks.task.file.attach.json index 9454814b2..858ac1650 100644 --- a/_assets/simulator/spec/methods/tasks.task.file.attach.json +++ b/_assets/simulator/spec/methods/tasks.task.file.attach.json @@ -63,5 +63,12 @@ } ], "page": "/api-reference/tasks/tasks-task-file-attach.html", - "executable": false + "executable": false, + "requestExample": { + "taskId": 8017, + "fileIds": [ + 1065, + 1077 + ] + } } diff --git a/_assets/simulator/spec/methods/tasks.task.file.field.get.json b/_assets/simulator/spec/methods/tasks.task.file.field.get.json index 0254ab780..c1da5fd7c 100644 --- a/_assets/simulator/spec/methods/tasks.task.file.field.get.json +++ b/_assets/simulator/spec/methods/tasks.task.file.field.get.json @@ -87,5 +87,17 @@ "sortable", "title", "type" - ] + ], + "requestExample": { + "name": "taskId", + "select": [ + "name", + "type", + "title", + "description", + "filterable", + "sortable", + "multiple" + ] + } } diff --git a/_assets/simulator/spec/methods/tasks.task.file.field.list.json b/_assets/simulator/spec/methods/tasks.task.file.field.list.json index ea297d022..ef9c4ed73 100644 --- a/_assets/simulator/spec/methods/tasks.task.file.field.list.json +++ b/_assets/simulator/spec/methods/tasks.task.file.field.list.json @@ -91,5 +91,16 @@ "sortable", "title", "type" - ] + ], + "requestExample": { + "select": [ + "name", + "type", + "title", + "description", + "filterable", + "sortable", + "multiple" + ] + } } diff --git a/_assets/simulator/spec/methods/tasks.task.files.attach.json b/_assets/simulator/spec/methods/tasks.task.files.attach.json index ab76b396e..0f960e335 100644 --- a/_assets/simulator/spec/methods/tasks.task.files.attach.json +++ b/_assets/simulator/spec/methods/tasks.task.files.attach.json @@ -66,5 +66,9 @@ } ], "page": "/api-reference/tasks/tasks-task-files-attach.html", - "executable": false + "executable": false, + "requestExample": { + "taskId": 8017, + "fileId": 1065 + } } diff --git a/_assets/simulator/spec/methods/tasks.task.gantt.link.list.json b/_assets/simulator/spec/methods/tasks.task.gantt.link.list.json index 02fd688f9..c30e9f3e7 100644 --- a/_assets/simulator/spec/methods/tasks.task.gantt.link.list.json +++ b/_assets/simulator/spec/methods/tasks.task.gantt.link.list.json @@ -91,5 +91,21 @@ "dependentId", "taskId", "type" - ] + ], + "requestExample": { + "filter": [ + "taskId", + 101 + ], + "select": [ + "taskId", + "dependentId", + "type", + "creatorId" + ], + "pagination": { + "limit": 10, + "offset": 0 + } + } } diff --git a/_assets/simulator/spec/methods/tasks.task.get.json b/_assets/simulator/spec/methods/tasks.task.get.json index 84d531c2a..d92d3e74a 100644 --- a/_assets/simulator/spec/methods/tasks.task.get.json +++ b/_assets/simulator/spec/methods/tasks.task.get.json @@ -212,5 +212,37 @@ "ufTaskWebdavFiles", "viewedDate", "xmlId" - ] + ], + "requestExample": { + "taskId": 8017, + "select": [ + "ID", + "TITLE", + "DESCRIPTION", + "CREATED_BY", + "RESPONSIBLE_ID", + "DEADLINE", + "UF_CRM_TASK", + "UF_TASK_WEBDAV_FILES" + ] + }, + "datasetHint": { + "entity": "tasks", + "count": 30, + "idFrom": 100, + "idTo": 129, + "runnableExample": { + "taskId": 100, + "select": [ + "ID", + "TITLE", + "DESCRIPTION", + "CREATED_BY", + "RESPONSIBLE_ID", + "DEADLINE", + "UF_CRM_TASK", + "UF_TASK_WEBDAV_FILES" + ] + } + } } diff --git a/_assets/simulator/spec/methods/tasks.task.getFields.json b/_assets/simulator/spec/methods/tasks.task.getFields.json index 68e6cf2c1..2c71967d5 100644 --- a/_assets/simulator/spec/methods/tasks.task.getFields.json +++ b/_assets/simulator/spec/methods/tasks.task.getFields.json @@ -447,5 +447,6 @@ } ], "page": "/api-reference/tasks/tasks-task-get-fields.html", - "executable": false + "executable": false, + "requestExample": {} } diff --git a/_assets/simulator/spec/methods/tasks.task.getaccess.json b/_assets/simulator/spec/methods/tasks.task.getaccess.json index e5d8db69e..643a3f34e 100644 --- a/_assets/simulator/spec/methods/tasks.task.getaccess.json +++ b/_assets/simulator/spec/methods/tasks.task.getaccess.json @@ -55,5 +55,12 @@ } ], "page": "/api-reference/tasks/tasks-task-get-access.html", - "executable": false + "executable": false, + "requestExample": { + "taskId": 8017, + "users": [ + 503, + 547 + ] + } } diff --git a/_assets/simulator/spec/methods/tasks.task.history.list.json b/_assets/simulator/spec/methods/tasks.task.history.list.json index b7041d945..e56991e11 100644 --- a/_assets/simulator/spec/methods/tasks.task.history.list.json +++ b/_assets/simulator/spec/methods/tasks.task.history.list.json @@ -59,5 +59,14 @@ } ], "page": "/api-reference/tasks/tasks-task-history-list.html", - "executable": false + "executable": false, + "requestExample": { + "taskId": 8137, + "filter": { + "FIELD": "COMMENT" + }, + "order": { + "createdDate": "ASC" + } + } } diff --git a/_assets/simulator/spec/methods/tasks.task.list.json b/_assets/simulator/spec/methods/tasks.task.list.json index e8f2229d4..b0b98751e 100644 --- a/_assets/simulator/spec/methods/tasks.task.list.json +++ b/_assets/simulator/spec/methods/tasks.task.list.json @@ -267,5 +267,12 @@ "ufTaskWebdavFiles", "viewedDate", "xmlId" - ] + ], + "datasetHint": { + "entity": "tasks", + "count": 30, + "idFrom": 100, + "idTo": 129, + "runnableExample": {} + } } diff --git a/_assets/simulator/spec/methods/tasks.task.mute.json b/_assets/simulator/spec/methods/tasks.task.mute.json index 50a0db8c8..56876ef51 100644 --- a/_assets/simulator/spec/methods/tasks.task.mute.json +++ b/_assets/simulator/spec/methods/tasks.task.mute.json @@ -398,5 +398,8 @@ } ], "page": "/api-reference/tasks/user-actions/tasks-task-mute.html", - "executable": false + "executable": false, + "requestExample": { + "id": 8017 + } } diff --git a/_assets/simulator/spec/methods/tasks.task.pause.json b/_assets/simulator/spec/methods/tasks.task.pause.json index ea59546a8..f0c214534 100644 --- a/_assets/simulator/spec/methods/tasks.task.pause.json +++ b/_assets/simulator/spec/methods/tasks.task.pause.json @@ -398,5 +398,8 @@ } ], "page": "/api-reference/tasks/status/tasks-task-pause.html", - "executable": false + "executable": false, + "requestExample": { + "taskId": 1 + } } diff --git a/_assets/simulator/spec/methods/tasks.task.pin.json b/_assets/simulator/spec/methods/tasks.task.pin.json index d4ae71b8a..9b42c861c 100644 --- a/_assets/simulator/spec/methods/tasks.task.pin.json +++ b/_assets/simulator/spec/methods/tasks.task.pin.json @@ -192,5 +192,8 @@ } ], "page": "/api-reference/tasks/user-actions/tasks-task-pin.html", - "executable": false + "executable": false, + "requestExample": { + "id": 3897 + } } diff --git a/_assets/simulator/spec/methods/tasks.task.renew.json b/_assets/simulator/spec/methods/tasks.task.renew.json index a28cd29a0..8fb9e0f13 100644 --- a/_assets/simulator/spec/methods/tasks.task.renew.json +++ b/_assets/simulator/spec/methods/tasks.task.renew.json @@ -398,5 +398,8 @@ } ], "page": "/api-reference/tasks/status/tasks-task-renew.html", - "executable": false + "executable": false, + "requestExample": { + "taskId": 1 + } } diff --git a/_assets/simulator/spec/methods/tasks.task.result.add.json b/_assets/simulator/spec/methods/tasks.task.result.add.json index 49e728849..8ccb396c5 100644 --- a/_assets/simulator/spec/methods/tasks.task.result.add.json +++ b/_assets/simulator/spec/methods/tasks.task.result.add.json @@ -98,5 +98,11 @@ } ], "page": "/api-reference/tasks/result/tasks-task-result-add.html", - "executable": false + "executable": false, + "requestExample": { + "fields": { + "taskId": 51, + "text": "Работа по задаче выполнена" + } + } } diff --git a/_assets/simulator/spec/methods/tasks.task.result.addFromComment.json b/_assets/simulator/spec/methods/tasks.task.result.addFromComment.json index 02050339e..5cc05d87a 100644 --- a/_assets/simulator/spec/methods/tasks.task.result.addFromComment.json +++ b/_assets/simulator/spec/methods/tasks.task.result.addFromComment.json @@ -141,5 +141,8 @@ } ], "page": "/api-reference/tasks/result/tasks-task-result-add-from-comment.html", - "executable": false + "executable": false, + "requestExample": { + "commentId": 3199 + } } diff --git a/_assets/simulator/spec/methods/tasks.task.result.addfromchatmessage.json b/_assets/simulator/spec/methods/tasks.task.result.addfromchatmessage.json index b1b263bbb..647d976ec 100644 --- a/_assets/simulator/spec/methods/tasks.task.result.addfromchatmessage.json +++ b/_assets/simulator/spec/methods/tasks.task.result.addfromchatmessage.json @@ -91,5 +91,10 @@ } ], "page": "/api-reference/tasks/result/tasks-task-result-addfromchatmessage.html", - "executable": false + "executable": false, + "requestExample": { + "fields": { + "messageId": 335 + } + } } diff --git a/_assets/simulator/spec/methods/tasks.task.result.delete.json b/_assets/simulator/spec/methods/tasks.task.result.delete.json index deba8dcb5..f56cb2dbd 100644 --- a/_assets/simulator/spec/methods/tasks.task.result.delete.json +++ b/_assets/simulator/spec/methods/tasks.task.result.delete.json @@ -52,5 +52,8 @@ } ], "page": "/api-reference/tasks/result/tasks-task-result-delete.html", - "executable": false + "executable": false, + "requestExample": { + "id": 17 + } } diff --git a/_assets/simulator/spec/methods/tasks.task.result.deleteFromComment.json b/_assets/simulator/spec/methods/tasks.task.result.deleteFromComment.json index 9be3d57f3..17ffe396c 100644 --- a/_assets/simulator/spec/methods/tasks.task.result.deleteFromComment.json +++ b/_assets/simulator/spec/methods/tasks.task.result.deleteFromComment.json @@ -50,5 +50,8 @@ } ], "page": "/api-reference/tasks/result/tasks-task-result-delete-from-comment.html", - "executable": false + "executable": false, + "requestExample": { + "commentId": 3199 + } } diff --git a/_assets/simulator/spec/methods/tasks.task.result.list.json b/_assets/simulator/spec/methods/tasks.task.result.list.json index f587ff354..918aed1b5 100644 --- a/_assets/simulator/spec/methods/tasks.task.result.list.json +++ b/_assets/simulator/spec/methods/tasks.task.result.list.json @@ -173,5 +173,8 @@ "taskId", "text", "updatedAt" - ] + ], + "requestExample": { + "taskId": 8017 + } } diff --git a/_assets/simulator/spec/methods/tasks.task.result.update.json b/_assets/simulator/spec/methods/tasks.task.result.update.json index be0d9a8f4..2bb22f003 100644 --- a/_assets/simulator/spec/methods/tasks.task.result.update.json +++ b/_assets/simulator/spec/methods/tasks.task.result.update.json @@ -98,5 +98,11 @@ } ], "page": "/api-reference/tasks/result/tasks-task-result-update.html", - "executable": false + "executable": false, + "requestExample": { + "id": 17, + "fields": { + "text": "Работа по задаче выполнена и проверена" + } + } } diff --git a/_assets/simulator/spec/methods/tasks.task.start.json b/_assets/simulator/spec/methods/tasks.task.start.json index df755db28..622b2b5b0 100644 --- a/_assets/simulator/spec/methods/tasks.task.start.json +++ b/_assets/simulator/spec/methods/tasks.task.start.json @@ -398,5 +398,8 @@ } ], "page": "/api-reference/tasks/status/tasks-task-start.html", - "executable": false + "executable": false, + "requestExample": { + "taskId": 1 + } } diff --git a/_assets/simulator/spec/methods/tasks.task.startwatch.json b/_assets/simulator/spec/methods/tasks.task.startwatch.json index d0701d215..ace6a0be1 100644 --- a/_assets/simulator/spec/methods/tasks.task.startwatch.json +++ b/_assets/simulator/spec/methods/tasks.task.startwatch.json @@ -406,5 +406,8 @@ } ], "page": "/api-reference/tasks/user-actions/tasks-task-start-watch.html", - "executable": false + "executable": false, + "requestExample": { + "taskId": 8017 + } } diff --git a/_assets/simulator/spec/methods/tasks.task.stopwatch.json b/_assets/simulator/spec/methods/tasks.task.stopwatch.json index 0a2785497..45ce76a5a 100644 --- a/_assets/simulator/spec/methods/tasks.task.stopwatch.json +++ b/_assets/simulator/spec/methods/tasks.task.stopwatch.json @@ -398,5 +398,8 @@ } ], "page": "/api-reference/tasks/user-actions/tasks-task-stop-watch.html", - "executable": false + "executable": false, + "requestExample": { + "taskId": 8017 + } } diff --git a/_assets/simulator/spec/methods/tasks.task.unmute.json b/_assets/simulator/spec/methods/tasks.task.unmute.json index 92d00ca4e..f4a64ca68 100644 --- a/_assets/simulator/spec/methods/tasks.task.unmute.json +++ b/_assets/simulator/spec/methods/tasks.task.unmute.json @@ -398,5 +398,8 @@ } ], "page": "/api-reference/tasks/user-actions/tasks-task-unmute.html", - "executable": false + "executable": false, + "requestExample": { + "id": 8017 + } } diff --git a/_assets/simulator/spec/methods/tasks.task.unpin.json b/_assets/simulator/spec/methods/tasks.task.unpin.json index 7e043c388..c359e713d 100644 --- a/_assets/simulator/spec/methods/tasks.task.unpin.json +++ b/_assets/simulator/spec/methods/tasks.task.unpin.json @@ -192,5 +192,8 @@ } ], "page": "/api-reference/tasks/user-actions/tasks-task-unpin.html", - "executable": false + "executable": false, + "requestExample": { + "id": 3897 + } } diff --git a/_assets/simulator/spec/methods/tasks.task.update.json b/_assets/simulator/spec/methods/tasks.task.update.json index 2e09374b6..44029ba69 100644 --- a/_assets/simulator/spec/methods/tasks.task.update.json +++ b/_assets/simulator/spec/methods/tasks.task.update.json @@ -226,5 +226,21 @@ } ], "page": "/api-reference/tasks/tasks-task-update.html", - "executable": false + "executable": false, + "requestExample": { + "taskId": 11, + "fields": { + "UF_CRM_TASK": [ + "L_4", + "C_7", + "CO_5", + "D_10" + ], + "UF_TASK_WEBDAV_FILES": [ + "n12345", + "n67890" + ], + "RESPONSIBLE_ID": 123 + } + } } diff --git a/_assets/simulator/spec/methods/tasks.template.add.json b/_assets/simulator/spec/methods/tasks.template.add.json index 3f906a46a..3ff78bfff 100644 --- a/_assets/simulator/spec/methods/tasks.template.add.json +++ b/_assets/simulator/spec/methods/tasks.template.add.json @@ -54,5 +54,32 @@ } ], "page": "/api-reference/tasks/template/tasks-template-add.html", - "executable": false + "executable": false, + "requestExample": { + "fields": { + "PARENT_ID": 8131, + "TITLE": "Подготовка еженедельного статуса по проекту", + "DESCRIPTION": "Шаблон задачи для подготовки и согласования еженедельного статуса по проекту с командой и руководителем", + "PRIORITY": 2, + "CREATED_BY": 101, + "RESPONSIBLE_ID": 102, + "REPLICATE": "Y", + "START_DATE_PLAN_AFTER": "32400", + "END_DATE_PLAN_AFTER": "97200", + "REPLICATE_PARAMS": { + "PERIOD": "weekly", + "EVERY_WEEK": 1, + "WEEK_DAYS": [ + 2 + ], + "TIME": "11:00", + "REPEAT_TILL": "endless", + "START_DATE": "16.03.2026 00:00:00" + }, + "UF_CRM_TASK": [ + "L_1179", + "D_1833" + ] + } + } } diff --git a/_assets/simulator/spec/methods/tasks.template.checklist.add.json b/_assets/simulator/spec/methods/tasks.template.checklist.add.json index cf904e8e3..303e0cd54 100644 --- a/_assets/simulator/spec/methods/tasks.template.checklist.add.json +++ b/_assets/simulator/spec/methods/tasks.template.checklist.add.json @@ -153,5 +153,20 @@ } ], "page": "/api-reference/tasks/template/checklist/tasks-template-checklist-add.html", - "executable": false + "executable": false, + "requestExample": { + "templateId": 139, + "fields": { + "TITLE": "4. Подготовить дашборд", + "PARENT_ID": 23, + "SORT_INDEX": 200, + "IS_COMPLETE": "N", + "IS_IMPORTANT": "Y", + "MEMBERS": { + "547": { + "TYPE": "A" + } + } + } + } } diff --git a/_assets/simulator/spec/methods/tasks.template.checklist.addAttachmentByContent.json b/_assets/simulator/spec/methods/tasks.template.checklist.addAttachmentByContent.json index b278a9bdb..a0b5bc653 100644 --- a/_assets/simulator/spec/methods/tasks.template.checklist.addAttachmentByContent.json +++ b/_assets/simulator/spec/methods/tasks.template.checklist.addAttachmentByContent.json @@ -117,5 +117,13 @@ } ], "page": "/api-reference/tasks/template/checklist/tasks-template-checklist-add-attachment-by-content.html", - "executable": false + "executable": false, + "requestExample": { + "templateId": 139, + "checkListItemId": 37, + "attachmentParameters": { + "NAME": "dashboard-note.txt", + "CONTENT": "RGFzaGJvYXJkIG5vdGU=" + } + } } diff --git a/_assets/simulator/spec/methods/tasks.template.checklist.addAttachmentsFromDisk.json b/_assets/simulator/spec/methods/tasks.template.checklist.addAttachmentsFromDisk.json index a5af0279c..856ef0f94 100644 --- a/_assets/simulator/spec/methods/tasks.template.checklist.addAttachmentsFromDisk.json +++ b/_assets/simulator/spec/methods/tasks.template.checklist.addAttachmentsFromDisk.json @@ -99,5 +99,13 @@ } ], "page": "/api-reference/tasks/template/checklist/tasks-template-checklist-add-attachments-from-disk.html", - "executable": false + "executable": false, + "requestExample": { + "templateId": 139, + "checkListItemId": 37, + "filesIds": [ + "n5065", + "n5067" + ] + } } diff --git a/_assets/simulator/spec/methods/tasks.template.checklist.complete.json b/_assets/simulator/spec/methods/tasks.template.checklist.complete.json index 6bf551415..6182da812 100644 --- a/_assets/simulator/spec/methods/tasks.template.checklist.complete.json +++ b/_assets/simulator/spec/methods/tasks.template.checklist.complete.json @@ -75,5 +75,9 @@ } ], "page": "/api-reference/tasks/template/checklist/tasks-template-checklist-complete.html", - "executable": false + "executable": false, + "requestExample": { + "templateId": 139, + "checkListItemId": 27 + } } diff --git a/_assets/simulator/spec/methods/tasks.template.checklist.delete.json b/_assets/simulator/spec/methods/tasks.template.checklist.delete.json index 46c533b7b..e6fe3aa8d 100644 --- a/_assets/simulator/spec/methods/tasks.template.checklist.delete.json +++ b/_assets/simulator/spec/methods/tasks.template.checklist.delete.json @@ -57,5 +57,9 @@ } ], "page": "/api-reference/tasks/template/checklist/tasks-template-checklist-delete.html", - "executable": false + "executable": false, + "requestExample": { + "templateId": 139, + "checkListItemId": 29 + } } diff --git a/_assets/simulator/spec/methods/tasks.template.checklist.get.json b/_assets/simulator/spec/methods/tasks.template.checklist.get.json index 17ea88577..a42c0a54c 100644 --- a/_assets/simulator/spec/methods/tasks.template.checklist.get.json +++ b/_assets/simulator/spec/methods/tasks.template.checklist.get.json @@ -111,5 +111,9 @@ "templateId", "title", "userId" - ] + ], + "requestExample": { + "templateId": 139, + "checkListItemId": 37 + } } diff --git a/_assets/simulator/spec/methods/tasks.template.checklist.list.json b/_assets/simulator/spec/methods/tasks.template.checklist.list.json index e73712e97..aa916ec0f 100644 --- a/_assets/simulator/spec/methods/tasks.template.checklist.list.json +++ b/_assets/simulator/spec/methods/tasks.template.checklist.list.json @@ -134,5 +134,25 @@ "PARENT_ID", "SORT_INDEX", "TITLE" - ] + ], + "requestExample": { + "templateId": 139, + "filter": { + "IS_COMPLETE": "N", + "IS_IMPORTANT": "N" + }, + "select": [ + "ID", + "TEMPLATE_ID", + "PARENT_ID", + "TITLE", + "SORT_INDEX", + "IS_COMPLETE", + "IS_IMPORTANT" + ], + "order": { + "SORT_INDEX": "asc", + "ID": "desc" + } + } } diff --git a/_assets/simulator/spec/methods/tasks.template.checklist.moveAfter.json b/_assets/simulator/spec/methods/tasks.template.checklist.moveAfter.json index 56f36942f..750433032 100644 --- a/_assets/simulator/spec/methods/tasks.template.checklist.moveAfter.json +++ b/_assets/simulator/spec/methods/tasks.template.checklist.moveAfter.json @@ -82,5 +82,10 @@ } ], "page": "/api-reference/tasks/template/checklist/tasks-template-checklist-move-after.html", - "executable": false + "executable": false, + "requestExample": { + "templateId": 139, + "checkListItemId": 25, + "afterItemId": 29 + } } diff --git a/_assets/simulator/spec/methods/tasks.template.checklist.moveBefore.json b/_assets/simulator/spec/methods/tasks.template.checklist.moveBefore.json index 79ae43b67..854c4bf32 100644 --- a/_assets/simulator/spec/methods/tasks.template.checklist.moveBefore.json +++ b/_assets/simulator/spec/methods/tasks.template.checklist.moveBefore.json @@ -95,5 +95,10 @@ } ], "page": "/api-reference/tasks/template/checklist/tasks-template-checklist-move-before.html", - "executable": false + "executable": false, + "requestExample": { + "templateId": 139, + "checkListItemId": 37, + "beforeItemId": 29 + } } diff --git a/_assets/simulator/spec/methods/tasks.template.checklist.removeAttachments.json b/_assets/simulator/spec/methods/tasks.template.checklist.removeAttachments.json index af48694d6..88121f712 100644 --- a/_assets/simulator/spec/methods/tasks.template.checklist.removeAttachments.json +++ b/_assets/simulator/spec/methods/tasks.template.checklist.removeAttachments.json @@ -96,5 +96,13 @@ } ], "page": "/api-reference/tasks/template/checklist/tasks-template-checklist-remove-attachments.html", - "executable": false + "executable": false, + "requestExample": { + "templateId": 139, + "checkListItemId": 37, + "attachmentsIds": [ + 1119, + 1121 + ] + } } diff --git a/_assets/simulator/spec/methods/tasks.template.checklist.renew.json b/_assets/simulator/spec/methods/tasks.template.checklist.renew.json index 8d2911a86..7b1237f00 100644 --- a/_assets/simulator/spec/methods/tasks.template.checklist.renew.json +++ b/_assets/simulator/spec/methods/tasks.template.checklist.renew.json @@ -75,5 +75,9 @@ } ], "page": "/api-reference/tasks/template/checklist/tasks-template-checklist-renew.html", - "executable": false + "executable": false, + "requestExample": { + "templateId": 139, + "checkListItemId": 27 + } } diff --git a/_assets/simulator/spec/methods/tasks.template.checklist.update.json b/_assets/simulator/spec/methods/tasks.template.checklist.update.json index 836859983..3195340e4 100644 --- a/_assets/simulator/spec/methods/tasks.template.checklist.update.json +++ b/_assets/simulator/spec/methods/tasks.template.checklist.update.json @@ -165,5 +165,12 @@ } ], "page": "/api-reference/tasks/template/checklist/tasks-template-checklist-update.html", - "executable": false + "executable": false, + "requestExample": { + "templateId": 139, + "checkListItemId": 37, + "fields": { + "TITLE": "4. Подготовить дашборд и отправить ссылку" + } + } } diff --git a/_assets/simulator/spec/methods/tasks.template.delete.json b/_assets/simulator/spec/methods/tasks.template.delete.json index 1409e29e4..b5ddedb1a 100644 --- a/_assets/simulator/spec/methods/tasks.template.delete.json +++ b/_assets/simulator/spec/methods/tasks.template.delete.json @@ -50,5 +50,8 @@ } ], "page": "/api-reference/tasks/template/tasks-template-delete.html", - "executable": false + "executable": false, + "requestExample": { + "templateId": 123 + } } diff --git a/_assets/simulator/spec/methods/tasks.template.fields.json b/_assets/simulator/spec/methods/tasks.template.fields.json index 44f2b5d62..ad239edb8 100644 --- a/_assets/simulator/spec/methods/tasks.template.fields.json +++ b/_assets/simulator/spec/methods/tasks.template.fields.json @@ -248,5 +248,6 @@ } ], "page": "/api-reference/tasks/template/tasks-template-fields.html", - "executable": false + "executable": false, + "requestExample": {} } diff --git a/_assets/simulator/spec/methods/tasks.template.get.json b/_assets/simulator/spec/methods/tasks.template.get.json index a101593b2..a748cda61 100644 --- a/_assets/simulator/spec/methods/tasks.template.get.json +++ b/_assets/simulator/spec/methods/tasks.template.get.json @@ -131,5 +131,8 @@ } ], "page": "/api-reference/tasks/template/tasks-template-get.html", - "executable": false + "executable": false, + "requestExample": { + "templateId": 139 + } } diff --git a/_assets/simulator/spec/methods/tasks.template.update.json b/_assets/simulator/spec/methods/tasks.template.update.json index 690866ab5..f97a1f6ac 100644 --- a/_assets/simulator/spec/methods/tasks.template.update.json +++ b/_assets/simulator/spec/methods/tasks.template.update.json @@ -61,5 +61,19 @@ } ], "page": "/api-reference/tasks/template/tasks-template-update.html", - "executable": false + "executable": false, + "requestExample": { + "templateId": 139, + "fields": { + "TITLE": "Подготовка еженедельного статуса по проекту и согласование", + "DESCRIPTION": "Обновленный шаблон задачи для подготовки еженедельного статуса по проекту и финального согласования перед отправкой", + "PRIORITY": 1, + "TASK_CONTROL": "Y", + "ADD_IN_REPORT": "Y", + "UF_CRM_TASK": [ + "L_1179", + "D_1833" + ] + } + } } diff --git a/_assets/simulator/spec/methods/telephony.call.attachTranscription.json b/_assets/simulator/spec/methods/telephony.call.attachTranscription.json index 463ad9b61..a22a4c4cd 100644 --- a/_assets/simulator/spec/methods/telephony.call.attachTranscription.json +++ b/_assets/simulator/spec/methods/telephony.call.attachTranscription.json @@ -129,5 +129,22 @@ } ], "page": "/api-reference/telephony/telephony-call-attach-transcription.html", - "executable": false + "executable": false, + "requestExample": { + "CALL_ID": "externalCall.716f1cb73def9700a23842adf9c4c568.1773130779", + "MESSAGES": [ + { + "SIDE": "User", + "START_TIME": 1, + "STOP_TIME": 3, + "MESSAGE": "Добрый день" + }, + { + "SIDE": "Client", + "START_TIME": 4, + "STOP_TIME": 7, + "MESSAGE": "Здравствуйте" + } + ] + } } diff --git a/_assets/simulator/spec/methods/telephony.externalCall.attachRecord.json b/_assets/simulator/spec/methods/telephony.externalCall.attachRecord.json index c5fc2ac30..b420be981 100644 --- a/_assets/simulator/spec/methods/telephony.externalCall.attachRecord.json +++ b/_assets/simulator/spec/methods/telephony.externalCall.attachRecord.json @@ -94,5 +94,10 @@ } ], "page": "/api-reference/telephony/telephony-external-call-attach-record.html", - "executable": false + "executable": false, + "requestExample": { + "CALL_ID": "externalCall.716f1cb73def9700a23842adf9c4c568.1773130779", + "FILENAME": "call-001.mp3", + "FILE_CONTENT": "SUQzAwAAAAAiVVRJVDI...AAAAAAAAAAAAP8=" + } } diff --git a/_assets/simulator/spec/methods/telephony.externalCall.searchCrmEntities.json b/_assets/simulator/spec/methods/telephony.externalCall.searchCrmEntities.json index 4100e2967..b1c570592 100644 --- a/_assets/simulator/spec/methods/telephony.externalCall.searchCrmEntities.json +++ b/_assets/simulator/spec/methods/telephony.externalCall.searchCrmEntities.json @@ -75,7 +75,7 @@ "type": "string", "base": "string", "required": false, - "description": "Тип объекта CRM. Возможные значения: - CONTACT — контакт - LEAD — лид - COMPANY — компания", + "description": "Тип объекта CRM. Возможные значения: - CONTACT — контакт - LEAD — доступный текущему пользователю активный лид - COMPANY — компания", "values": [ { "value": "CONTACT", @@ -83,7 +83,7 @@ }, { "value": "LEAD", - "title": "лид" + "title": "доступный текущему пользователю активный лид" }, { "value": "COMPANY", @@ -128,5 +128,8 @@ } ], "page": "/api-reference/telephony/telephony-external-call-search-crm-entities.html", - "executable": false + "executable": false, + "requestExample": { + "PHONE_NUMBER": "79062195047" + } } diff --git a/_assets/simulator/spec/methods/timeman.close.json b/_assets/simulator/spec/methods/timeman.close.json index a0e2b80c9..8b8937680 100644 --- a/_assets/simulator/spec/methods/timeman.close.json +++ b/_assets/simulator/spec/methods/timeman.close.json @@ -190,5 +190,12 @@ } ], "page": "/api-reference/timeman/base/timeman-close.html", - "executable": false + "executable": false, + "requestExample": { + "USER_ID": 503, + "TIME": "2025-03-27T17:00:01+00:00", + "REPORT": "Забыла закрыть рабочий день", + "LAT": 53.548841, + "LON": 9.987274 + } } diff --git a/_assets/simulator/spec/methods/timeman.networkrange.check.json b/_assets/simulator/spec/methods/timeman.networkrange.check.json index f0a219902..88a095b4d 100644 --- a/_assets/simulator/spec/methods/timeman.networkrange.check.json +++ b/_assets/simulator/spec/methods/timeman.networkrange.check.json @@ -75,5 +75,8 @@ } ], "page": "/api-reference/timeman/networkrange/timeman-networkrange-check.html", - "executable": false + "executable": false, + "requestExample": { + "IP": "10.10.255.255" + } } diff --git a/_assets/simulator/spec/methods/timeman.networkrange.get.json b/_assets/simulator/spec/methods/timeman.networkrange.get.json index b8de57b8e..9c218ab9b 100644 --- a/_assets/simulator/spec/methods/timeman.networkrange.get.json +++ b/_assets/simulator/spec/methods/timeman.networkrange.get.json @@ -82,5 +82,6 @@ "entityFields": [ "ip_range", "name" - ] + ], + "requestExample": {} } diff --git a/_assets/simulator/spec/methods/timeman.open.json b/_assets/simulator/spec/methods/timeman.open.json index 229fba762..a8fd0b5b3 100644 --- a/_assets/simulator/spec/methods/timeman.open.json +++ b/_assets/simulator/spec/methods/timeman.open.json @@ -190,5 +190,12 @@ } ], "page": "/api-reference/timeman/base/timeman-open.html", - "executable": false + "executable": false, + "requestExample": { + "USER_ID": 503, + "TIME": "2025-03-27T08:00:01+00:00", + "REPORT": "Забыла открыть рабочий день", + "LAT": 53.548841, + "LON": 9.987274 + } } diff --git a/_assets/simulator/spec/methods/timeman.pause.json b/_assets/simulator/spec/methods/timeman.pause.json index 6dde636a9..8ae554fbd 100644 --- a/_assets/simulator/spec/methods/timeman.pause.json +++ b/_assets/simulator/spec/methods/timeman.pause.json @@ -162,5 +162,8 @@ } ], "page": "/api-reference/timeman/base/timeman-pause.html", - "executable": false + "executable": false, + "requestExample": { + "USER_ID": 503 + } } diff --git a/_assets/simulator/spec/methods/timeman.record.field.get.json b/_assets/simulator/spec/methods/timeman.record.field.get.json index 5cea43030..06d7aaa0e 100644 --- a/_assets/simulator/spec/methods/timeman.record.field.get.json +++ b/_assets/simulator/spec/methods/timeman.record.field.get.json @@ -83,5 +83,15 @@ "sortable", "title", "type" - ] + ], + "requestExample": { + "name": "startTime", + "select": [ + "name", + "type", + "title", + "filterable", + "sortable" + ] + } } diff --git a/_assets/simulator/spec/methods/timeman.record.field.list.json b/_assets/simulator/spec/methods/timeman.record.field.list.json index 608fc4197..59f36f48a 100644 --- a/_assets/simulator/spec/methods/timeman.record.field.list.json +++ b/_assets/simulator/spec/methods/timeman.record.field.list.json @@ -127,5 +127,14 @@ "sortable", "title", "type" - ] + ], + "requestExample": { + "select": [ + "name", + "type", + "title", + "filterable", + "sortable" + ] + } } diff --git a/_assets/simulator/spec/methods/timeman.record.list.json b/_assets/simulator/spec/methods/timeman.record.list.json index b059a5973..de78e0dca 100644 --- a/_assets/simulator/spec/methods/timeman.record.list.json +++ b/_assets/simulator/spec/methods/timeman.record.list.json @@ -139,5 +139,35 @@ "endTime", "id", "startTime" - ] + ], + "requestExample": { + "filter": [ + [ + "userId", + 1 + ], + [ + "startTime", + "between", + [ + "2026-06-01T00:00:00+03:00", + "2026-06-30T23:59:59+03:00" + ] + ] + ], + "select": [ + "id", + "startTime", + "endTime", + "duration" + ], + "order": { + "startTime": "DESC" + }, + "pagination": { + "page": 1, + "limit": 50, + "offset": 0 + } + } } diff --git a/_assets/simulator/spec/methods/timeman.schedule.get.json b/_assets/simulator/spec/methods/timeman.schedule.get.json index 4d2c50ade..ac0174dc5 100644 --- a/_assets/simulator/spec/methods/timeman.schedule.get.json +++ b/_assets/simulator/spec/methods/timeman.schedule.get.json @@ -281,5 +281,8 @@ "executable": false, "entityFields": [ "START_WEEK_DAY" - ] + ], + "requestExample": { + "id": 1 + } } diff --git a/_assets/simulator/spec/methods/timeman.settings.json b/_assets/simulator/spec/methods/timeman.settings.json index b3d92df8b..3e31f15af 100644 --- a/_assets/simulator/spec/methods/timeman.settings.json +++ b/_assets/simulator/spec/methods/timeman.settings.json @@ -107,5 +107,8 @@ } ], "page": "/api-reference/timeman/base/timeman-settings.html", - "executable": false + "executable": false, + "requestExample": { + "USER_ID": 503 + } } diff --git a/_assets/simulator/spec/methods/timeman.status.json b/_assets/simulator/spec/methods/timeman.status.json index 8819d6732..3be5b868f 100644 --- a/_assets/simulator/spec/methods/timeman.status.json +++ b/_assets/simulator/spec/methods/timeman.status.json @@ -163,5 +163,8 @@ } ], "page": "/api-reference/timeman/base/timeman-status.html", - "executable": false + "executable": false, + "requestExample": { + "USER_ID": 503 + } } diff --git a/_assets/simulator/spec/methods/timeman.timecontrol.report.add.json b/_assets/simulator/spec/methods/timeman.timecontrol.report.add.json index 760ea3f2b..36003ba8d 100644 --- a/_assets/simulator/spec/methods/timeman.timecontrol.report.add.json +++ b/_assets/simulator/spec/methods/timeman.timecontrol.report.add.json @@ -78,5 +78,11 @@ } ], "page": "/api-reference/timeman/timecontrol/timeman-timecontrol-report-add.html", - "executable": false + "executable": false, + "requestExample": { + "REPORT_ID": 123, + "TEXT": "Работал над проектом", + "TYPE": "WORK", + "CALENDAR": "Y" + } } diff --git a/_assets/simulator/spec/methods/timeman.timecontrol.reports.get.json b/_assets/simulator/spec/methods/timeman.timecontrol.reports.get.json index 282a035ff..96bef19b6 100644 --- a/_assets/simulator/spec/methods/timeman.timecontrol.reports.get.json +++ b/_assets/simulator/spec/methods/timeman.timecontrol.reports.get.json @@ -107,5 +107,12 @@ } ], "page": "/api-reference/timeman/timecontrol/timeman-timecontrol-reports-get.html", - "executable": false + "executable": false, + "requestExample": { + "USER_ID": 3, + "MONTH": 5, + "YEAR": 2025, + "IDLE_MINUTES": 15, + "WORKDAY_HOURS": 8 + } } diff --git a/_assets/simulator/spec/methods/timeman.timecontrol.reports.users.get.json b/_assets/simulator/spec/methods/timeman.timecontrol.reports.users.get.json index 9d1cfc49c..b1878f4ab 100644 --- a/_assets/simulator/spec/methods/timeman.timecontrol.reports.users.get.json +++ b/_assets/simulator/spec/methods/timeman.timecontrol.reports.users.get.json @@ -127,5 +127,8 @@ "name", "personal_gender", "work_position" - ] + ], + "requestExample": { + "DEPARTMENT_ID": 15 + } } diff --git a/_assets/simulator/spec/methods/timeman.timecontrol.settings.set.json b/_assets/simulator/spec/methods/timeman.timecontrol.settings.set.json index e0d98428f..479cc5b94 100644 --- a/_assets/simulator/spec/methods/timeman.timecontrol.settings.set.json +++ b/_assets/simulator/spec/methods/timeman.timecontrol.settings.set.json @@ -174,5 +174,15 @@ } ], "page": "/api-reference/timeman/timecontrol/timeman-timecontrol-settings-set.html", - "executable": false + "executable": false, + "requestExample": { + "ACTIVE": true, + "MINIMUM_IDLE_FOR_REPORT": 15, + "REGISTER_OFFLINE": true, + "REGISTER_IDLE": true, + "REGISTER_DESKTOP": true, + "REPORT_REQUEST_TYPE": "all", + "REPORT_SIMPLE_TYPE": "all", + "REPORT_FULL_TYPE": "all" + } } diff --git a/_assets/simulator/spec/methods/user.access.json b/_assets/simulator/spec/methods/user.access.json index 4821d255c..8952ab96a 100644 --- a/_assets/simulator/spec/methods/user.access.json +++ b/_assets/simulator/spec/methods/user.access.json @@ -3,15 +3,15 @@ "method": "user.access", "scope": "базовый", "kind": "write", - "title": "Определить набор прав пользователя user.access", + "title": "Проверить коды доступа пользователя user.access", "permissions": "любой пользователь", "params": [ { "name": "ACCESS", - "type": "array", + "type": "string[]", "base": "array", - "required": true, - "description": "Список кодов доступа, которые нужно проверить. Форматы кодов: - U — пользователь, например U1 - G — группа пользователей, например G2 - AU — все авторизованные пользователи Названия кодов получает метод access.name", + "required": "unknown", + "description": "Список кодов доступа, которые нужно проверить, например [\"D1\", \"SG1_K\"]. Один код можно передать строкой, например \"D1\". Форматы кодов: - U — пользователь, например U1 - G — группа пользователей, например G1. Код G2 — «Все посетители», с ним метод всегда возвращает true - AU — все авторизованные пользователи.…", "dynamic": { "allowed": true, "note": "Состав полей не описан подтаблицей на этой странице" @@ -19,7 +19,7 @@ } ], "defs": {}, - "requiredConvention": true, + "requiredConvention": false, "confidence": "parsed", "source": { "file": "api-reference/common/users/user-access.md" @@ -41,17 +41,23 @@ "name": "result", "type": "boolean", "base": "boolean", - "required": false, - "description": "Возвращается true, если текущий пользователь обладает хотя бы одним из перечисленных в параметре ACCESS кодов доступа или правами на управление настройками приложений, false — в противном случае" + "required": "unknown", + "description": "Возвращается true, если текущий пользователь обладает хотя бы одним из перечисленных в параметре ACCESS кодов доступа или является администратором Битрикс24, false — в противном случае" }, { "name": "time", "type": "time", "base": "object", - "required": false, + "required": "unknown", "description": "Информация о времени выполнения запроса" } ], "page": "/api-reference/common/users/user-access.html", - "executable": false + "executable": false, + "requestExample": { + "ACCESS": [ + "D1", + "SG1_K" + ] + } } diff --git a/_assets/simulator/spec/methods/user.admin.json b/_assets/simulator/spec/methods/user.admin.json new file mode 100644 index 000000000..971a4d2fe --- /dev/null +++ b/_assets/simulator/spec/methods/user.admin.json @@ -0,0 +1,65 @@ +{ + "$v": 1, + "method": "user.admin", + "scope": "базовый", + "kind": "write", + "title": "Проверить права администратора user.admin", + "permissions": "любой пользователь", + "params": [ + { + "name": "result", + "type": "boolean", + "base": "boolean", + "required": "unknown", + "description": "Возвращается true, если текущий пользователь — администратор Битрикс24, false — в противном случае" + }, + { + "name": "time", + "type": "time", + "base": "object", + "required": "unknown", + "description": "Информация о времени выполнения запроса", + "dynamic": { + "allowed": true, + "note": "Состав полей не описан подтаблицей на этой странице" + } + } + ], + "defs": {}, + "requiredConvention": false, + "confidence": "parsed", + "source": { + "file": "api-reference/common/users/user-admin.md" + }, + "resultExample": { + "result": true, + "time": { + "start": 1721998816.3694, + "finish": 1721998816.43663, + "duration": 0.0672309398651123, + "processing": 0.000064849853515625, + "date_start": "2024-07-26T13:00:16+00:00", + "date_finish": "2024-07-26T13:00:16+00:00", + "operating": 0 + } + }, + "returns": [ + { + "name": "result", + "type": "boolean", + "base": "boolean", + "required": "unknown", + "description": "Возвращается true, если текущий пользователь — администратор Битрикс24, false — в противном случае" + }, + { + "name": "time", + "type": "time", + "base": "object", + "required": "unknown", + "description": "Информация о времени выполнения запроса" + } + ], + "page": "/api-reference/common/users/user-admin.html", + "executable": false, + "requestExample": {} +} diff --git a/_assets/simulator/spec/methods/user.get.json b/_assets/simulator/spec/methods/user.get.json index ae030c352..07965ab45 100644 --- a/_assets/simulator/spec/methods/user.get.json +++ b/_assets/simulator/spec/methods/user.get.json @@ -11,7 +11,7 @@ "type": "string", "base": "string", "required": false, - "description": "Поле, по которому сортируются результаты. Сортировка работает по всем полям из user.add" + "description": "Поле, по которому сортируются результаты. Сортировка работает по всем полям из user.add. По умолчанию метод сортирует пользователей по возрастанию ID. Если sort или order переданы не строкой, метод также применяет сортировку по умолчанию" }, { "name": "order", @@ -174,5 +174,18 @@ "USER_TYPE", "WORK_PHONE", "WORK_POSITION" - ] + ], + "datasetHint": { + "entity": "users", + "count": 6, + "ids": [ + "1", + "6", + "9", + "12", + "15", + "21" + ], + "runnableExample": {} + } } diff --git a/_assets/simulator/spec/methods/user.option.get.json b/_assets/simulator/spec/methods/user.option.get.json index d58a8404a..061c49a63 100644 --- a/_assets/simulator/spec/methods/user.option.get.json +++ b/_assets/simulator/spec/methods/user.option.get.json @@ -3,8 +3,8 @@ "method": "user.option.get", "scope": "базовый", "kind": "read", - "title": "Получить пользовательские данные, привязанные к приложению user.option.get", - "permissions": "любой пользователь", + "title": "Получить настройки пользователя user.option.get", + "permissions": "любой авторизованный пользователь в контексте приложения", "params": [ { "name": "option", @@ -41,7 +41,7 @@ "type": "object", "base": "object", "required": false, - "description": "Зависит от параметра option: - параметр не передан — объект, где ключ это название настройки, а значение это сохраненное значение. Если настроек нет, объект пустой - параметр передан — сохраненное значение ключа - параметр передан, но такого ключа нет — null" + "description": "Зависит от параметра option: - параметр не передан — объект, где ключ — название настройки, значение — сохраненное значение. Если настроек нет, возвращается пустой массив [] - параметр передан — сохраненное значение ключа: строка, целое или дробное число, логическое значение, массив или объект - параметр передан, но такого ключа нет — null Значение возвращается в том виде, в каком его сохранил use…" }, { "name": "time", diff --git a/_assets/simulator/spec/methods/user.option.set.json b/_assets/simulator/spec/methods/user.option.set.json index e8fb4863d..b8b5f9ab1 100644 --- a/_assets/simulator/spec/methods/user.option.set.json +++ b/_assets/simulator/spec/methods/user.option.set.json @@ -3,15 +3,15 @@ "method": "user.option.set", "scope": "базовый", "kind": "write", - "title": "Привязать данные к пользователю и приложению user.option.set", - "permissions": "любой пользователь", + "title": "Сохранить настройки пользователя user.option.set", + "permissions": "любой авторизованный пользователь в контексте приложения", "params": [ { "name": "options", - "type": "array", - "base": "array", - "required": true, - "description": "Массив, где ключ — название сохраняемого свойства, а значение — значение свойства. Если передать значение с новым ключом, то метод его запишет, а если существующее — обновит", + "type": "object", + "base": "object", + "required": false, + "description": "Объект настроек: ключ — название настройки, значение — ее значение. Передавайте options объектом. Не используйте ключи next и total: при чтении всех настроек REST API вернет их не в result, а в корне ответа. Перезаписываются только переданные ключи, остальные сохраненные настройки не меняются.…", "dynamic": { "allowed": true, "note": "Состав полей не описан подтаблицей на этой странице" diff --git a/_assets/simulator/spec/methods/user.search.json b/_assets/simulator/spec/methods/user.search.json index 6ff1a0665..837467d56 100644 --- a/_assets/simulator/spec/methods/user.search.json +++ b/_assets/simulator/spec/methods/user.search.json @@ -8,31 +8,32 @@ "params": [ { "name": "FILTER", - "type": "string", - "base": "string", + "type": "object", + "base": "object", "required": false, - "description": "Массив может содержать поля в любом сочетании: - NAME — имя - LAST_NAME — фамилия - WORK_POSITION — должность - UF_DEPARTMENT_NAME — название подразделения - USER_TYPE — тип пользователя. Может принимать следующие значения: - employee — сотрудник - extranet — пользователь экстранета - email — почтовый пользователь Или FIND — поле, которое будет искать во всех перечисленных полях.…" + "description": "Объект с полями поиска (подробное описание)", + "ref": "#/defs/FILTERFields" }, { "name": "sort", "type": "string", "base": "string", "required": false, - "description": "Поле, по которому сортируются результаты. Сортировка работает по всем полям из user.add" + "description": "Поле, по которому сортируются результаты. Сортировка работает по всем полям из user.add. По умолчанию — ID" }, { "name": "order", "type": "string", "base": "string", "required": false, - "description": "Направление сортировки: - ASC — по возрастанию - DESC — по убыванию" + "description": "Направление сортировки: - ASC — по возрастанию - DESC — по убыванию По умолчанию — ASC" }, { "name": "ADMIN_MODE", "type": "boolean", "base": "boolean", "required": false, - "description": "Ключ для работы в режиме администратора. Служит для получения данных о любых пользователях" + "description": "Включает режим администратора для получения данных о пользователях. Параметр действует, только если запрос выполняет администратор. По умолчанию — false" }, { "name": "select", @@ -50,10 +51,83 @@ "type": "integer", "base": "integer", "required": false, - "description": "Параметр используется для управления постраничной навигацией. Размер страницы результатов всегда статичный: 50 записей. Чтобы выбрать вторую страницу результатов, необходимо передавать значение 50. Чтобы выбрать третью страницу результатов — значение 100 и так далее. Формула расчета значения параметра start: start = (N-1) * 50, где N — номер нужной страницы" + "description": "Параметр используется для управления постраничной навигацией. Размер страницы результатов всегда статичный: 50 записей. Чтобы выбрать вторую страницу результатов, необходимо передавать значение 50. Чтобы выбрать третью страницу результатов — значение 100 и так далее. Формула расчета значения параметра start: start = (N - 1) * 50, где N — номер нужной страницы. По умолчанию — 0" } ], - "defs": {}, + "defs": { + "FILTERFields": { + "dynamic": { + "allowed": false, + "ufAllowed": true, + "note": "Пользовательские поля UF_* в схеме не описаны" + }, + "fields": [ + { + "name": "FIND", + "type": "string", + "base": "string", + "required": false, + "description": "Строка для поиска одновременно по имени, фамилии, отчеству, должности и названию подразделения" + }, + { + "name": "NAME", + "type": "string", + "base": "string", + "required": false, + "description": "Имя пользователя" + }, + { + "name": "LAST_NAME", + "type": "string", + "base": "string", + "required": false, + "description": "Фамилия пользователя" + }, + { + "name": "SECOND_NAME", + "type": "string", + "base": "string", + "required": false, + "description": "Отчество пользователя" + }, + { + "name": "WORK_POSITION", + "type": "string", + "base": "string", + "required": false, + "description": "Должность пользователя" + }, + { + "name": "UF_DEPARTMENT_NAME", + "type": "string", + "base": "string", + "required": false, + "description": "Название подразделения" + }, + { + "name": "USER_TYPE", + "type": "string", + "base": "string", + "required": false, + "description": "Тип пользователя. Возможные значения: - employee — сотрудник - extranet — пользователь экстранета - email — почтовый пользователь", + "values": [ + { + "value": "employee", + "title": "сотрудник" + }, + { + "value": "extranet", + "title": "пользователь экстранета" + }, + { + "value": "email", + "title": "почтовый пользователь" + } + ] + } + ] + } + }, "requiredConvention": true, "confidence": "parsed", "source": { @@ -61,32 +135,6 @@ }, "resultExample": { "result": [ - { - "ID": "1", - "ACTIVE": true, - "NAME": "Вадим", - "LAST_NAME": "Валеев", - "SECOND_NAME": "", - "EMAIL": "v.r.valeev@bitrix.com", - "LAST_LOGIN": "2024-07-25T13:06:54+00:00", - "DATE_REGISTER": "2024-07-15T00:00:00+00:00", - "TIME_ZONE": "", - "IS_ONLINE": "Y", - "TIMESTAMP_X": {}, - "LAST_ACTIVITY_DATE": {}, - "PERSONAL_GENDER": "", - "PERSONAL_WWW": "", - "PERSONAL_BIRTHDAY": "2018-07-14T00:00:00+00:00", - "PERSONAL_MOBILE": "", - "PERSONAL_CITY": "", - "WORK_PHONE": "", - "WORK_POSITION": "", - "UF_EMPLOYMENT_DATE": "", - "UF_DEPARTMENT": [ - 1 - ], - "USER_TYPE": "employee" - }, { "ID": "3", "ACTIVE": true, @@ -108,7 +156,7 @@ "USER_TYPE": "employee" } ], - "total": 2, + "total": 1, "time": { "start": 1721913235.39648, "finish": 1721913235.45078, @@ -122,10 +170,10 @@ "returns": [ { "name": "result", - "type": "object", - "base": "object", + "type": "object[]", + "base": "array", "required": false, - "description": "Корневой элемент ответа, который содержит отфильтрованный список пользователей" + "description": "Массив пользователей, которые соответствуют условиям поиска (подробное описание). Набор полей зависит от скоупа и параметра select" }, { "name": "total", @@ -134,6 +182,13 @@ "required": false, "description": "Общее количество найденных записей" }, + { + "name": "next", + "type": "integer", + "base": "integer", + "required": false, + "description": "Смещение следующей страницы. Поле отсутствует, если получена последняя страница" + }, { "name": "time", "type": "time", @@ -143,5 +198,10 @@ } ], "page": "/api-reference/user/user-search.html", - "executable": false + "executable": false, + "requestExample": { + "FILTER": { + "FIND": "Иван" + } + } } diff --git a/_assets/simulator/spec/methods/user.update.json b/_assets/simulator/spec/methods/user.update.json index 2b9e1e751..fc7c4353c 100644 --- a/_assets/simulator/spec/methods/user.update.json +++ b/_assets/simulator/spec/methods/user.update.json @@ -424,5 +424,10 @@ } ], "page": "/api-reference/user/user-update.html", - "executable": false + "executable": false, + "requestExample": { + "ID": 1, + "NAME": "Administrator", + "LAST_NAME": "SomeLastName" + } } diff --git a/_assets/simulator/spec/methods/user.userfield.delete.json b/_assets/simulator/spec/methods/user.userfield.delete.json index 27d4c7e61..39a30ba38 100644 --- a/_assets/simulator/spec/methods/user.userfield.delete.json +++ b/_assets/simulator/spec/methods/user.userfield.delete.json @@ -49,5 +49,8 @@ } ], "page": "/api-reference/user/userfields/user-userfield-delete.html", - "executable": false + "executable": false, + "requestExample": { + "id": 123 + } } diff --git a/_assets/simulator/spec/methods/user.userfield.list.json b/_assets/simulator/spec/methods/user.userfield.list.json index 447bd2f2f..ccabcb7f4 100644 --- a/_assets/simulator/spec/methods/user.userfield.list.json +++ b/_assets/simulator/spec/methods/user.userfield.list.json @@ -8,8 +8,8 @@ "params": [ { "name": "order", - "type": "string", - "base": "string", + "type": "array", + "base": "array", "required": "unknown", "description": "Сортировка выбранных пользовательских полей в формате {\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}. Возможные значения для field_N: - ID — идентификатор пользовательского поля - FIELD_NAME — название поля - USER_TYPE_ID — тип данных поля - XML_ID — внешний код - SORT — порядок сортировки поля - MULTIPLE — возможность ввода нескольких значений - MANDATORY — обязательность заполнения - SHOW_FILT…", "values": [ @@ -41,7 +41,11 @@ "value": "MANDATORY", "title": "обязательность заполнения - SHOW_FILT…" } - ] + ], + "dynamic": { + "allowed": true, + "note": "Состав полей не описан подтаблицей на этой странице" + } }, { "name": "filter", @@ -138,10 +142,10 @@ "returns": [ { "name": "result", - "type": "object", - "base": "object", + "type": "array", + "base": "array", "required": "unknown", - "description": "Корневой элемент ответа" + "description": "Массив объектов с описанием пользовательских полей" }, { "name": "total", @@ -181,5 +185,13 @@ "SORT", "USER_TYPE_ID", "XML_ID" - ] + ], + "requestExample": { + "order": { + "id": "desc" + }, + "filter": { + "id": 13 + } + } } diff --git a/_assets/simulator/spec/methods/user.userfield.update.json b/_assets/simulator/spec/methods/user.userfield.update.json index 5447e9a29..6acfeb3d2 100644 --- a/_assets/simulator/spec/methods/user.userfield.update.json +++ b/_assets/simulator/spec/methods/user.userfield.update.json @@ -181,5 +181,13 @@ } ], "page": "/api-reference/user/userfields/user-userfield-update.html", - "executable": false + "executable": false, + "requestExample": { + "id": 42, + "fields": { + "SORT": 150, + "LIST_FILTER_LABEL": "New Title", + "LIST_COLUMN_LABEL": "New List Title" + } + } } diff --git a/_assets/simulator/spec/methods/userconsent.agreement.list.json b/_assets/simulator/spec/methods/userconsent.agreement.list.json index 2b0bee0aa..0f71bbcd3 100644 --- a/_assets/simulator/spec/methods/userconsent.agreement.list.json +++ b/_assets/simulator/spec/methods/userconsent.agreement.list.json @@ -244,5 +244,6 @@ "ID", "LANGUAGE_ID", "NAME" - ] + ], + "requestExample": {} } diff --git a/_assets/simulator/spec/methods/userconsent.agreement.text.json b/_assets/simulator/spec/methods/userconsent.agreement.text.json index e19106f84..1b7b4cffe 100644 --- a/_assets/simulator/spec/methods/userconsent.agreement.text.json +++ b/_assets/simulator/spec/methods/userconsent.agreement.text.json @@ -78,5 +78,18 @@ } ], "page": "/api-reference/user-consent/user-consent-agreement-text.html", - "executable": false + "executable": false, + "requestExample": { + "id": 19, + "replace": { + "button_caption": "Я согласен", + "fields": { + "COMPANY_NAME": "ООО Пример", + "COMPANY_ADDRESS": "г. Москва, ул. Примерная, д. 1", + "PURPOSES": "Обработка персональных данных для улучшения сервиса", + "THIRD_PARTIES": "Партнеры компании для аналитики", + "EMAIL": "info@example.com" + } + } + } } diff --git a/_assets/simulator/spec/methods/userconsent.consent.add.json b/_assets/simulator/spec/methods/userconsent.consent.add.json index aab293660..e42a2a507 100644 --- a/_assets/simulator/spec/methods/userconsent.consent.add.json +++ b/_assets/simulator/spec/methods/userconsent.consent.add.json @@ -85,5 +85,13 @@ } ], "page": "/api-reference/user-consent/user-consent-consent-add.html", - "executable": false + "executable": false, + "requestExample": { + "AGREEMENT_ID": 19, + "USER_ID": 123, + "IP": "192.168.1.100", + "URL": "https://example.com/contact-form", + "ORIGIN_ID": "my_contact_form", + "ORIGINATOR_ID": "user@example.com" + } } diff --git a/_assets/simulator/spec/methods/userfieldconfig.delete.json b/_assets/simulator/spec/methods/userfieldconfig.delete.json index 7740df6e8..7d9b04e4d 100644 --- a/_assets/simulator/spec/methods/userfieldconfig.delete.json +++ b/_assets/simulator/spec/methods/userfieldconfig.delete.json @@ -56,5 +56,9 @@ } ], "page": "/api-reference/crm/universal/userfieldconfig/userfieldconfig-delete.html", - "executable": false + "executable": false, + "requestExample": { + "moduleId": "crm", + "id": 6953 + } } diff --git a/_assets/simulator/spec/methods/userfieldconfig.get.json b/_assets/simulator/spec/methods/userfieldconfig.get.json index c2ae0c58d..da0b4f7ec 100644 --- a/_assets/simulator/spec/methods/userfieldconfig.get.json +++ b/_assets/simulator/spec/methods/userfieldconfig.get.json @@ -142,5 +142,9 @@ "sort", "userTypeId", "xmlId" - ] + ], + "requestExample": { + "moduleId": "crm", + "id": 7095 + } } diff --git a/_assets/simulator/spec/methods/userfieldconfig.getTypes.json b/_assets/simulator/spec/methods/userfieldconfig.getTypes.json index 55088bb9a..353385df2 100644 --- a/_assets/simulator/spec/methods/userfieldconfig.getTypes.json +++ b/_assets/simulator/spec/methods/userfieldconfig.getTypes.json @@ -121,5 +121,8 @@ } ], "page": "/api-reference/crm/universal/userfieldconfig/userfieldconfig-get-types.html", - "executable": false + "executable": false, + "requestExample": { + "moduleId": "crm" + } } diff --git a/_assets/simulator/spec/methods/userfieldconfig.update.json b/_assets/simulator/spec/methods/userfieldconfig.update.json index dce2f4bdb..0fd5f1f6d 100644 --- a/_assets/simulator/spec/methods/userfieldconfig.update.json +++ b/_assets/simulator/spec/methods/userfieldconfig.update.json @@ -208,5 +208,16 @@ } ], "page": "/api-reference/crm/universal/userfieldconfig/userfieldconfig-update.html", - "executable": false + "executable": false, + "requestExample": { + "moduleId": "crm", + "id": 7095, + "field": { + "mandatory": "Y", + "editFormLabel": { + "ru": "Список характеристик (обновлено)", + "en": "List of characteristics (updated)" + } + } + } } diff --git a/_assets/simulator/spec/methods/userfieldtype.add.json b/_assets/simulator/spec/methods/userfieldtype.add.json index dc3e6cbdf..41c033512 100644 --- a/_assets/simulator/spec/methods/userfieldtype.add.json +++ b/_assets/simulator/spec/methods/userfieldtype.add.json @@ -11,35 +11,46 @@ "type": "string", "base": "string", "required": true, - "description": "Строковый код типа" + "description": "Код типа. Метод приводит его к нижнему регистру. Код должен быть уникальным среди типов всех приложений Битрикс24: если он уже занят, метод вернет ошибку Handler already binded. Полный код типа rest__ должен укладываться в 50 символов. Метод примет и более длинный код, но у созданного поля код типа обрежется до 50 символов, и Битрикс24 не найдет тип" }, { "name": "HANDLER", "type": "string", "base": "string", "required": true, - "description": "Адрес обработчика пользовательского типа" + "description": "Адрес обработчика, который Битрикс24 загрузит в поле. Он должен начинаться с http:// или https://, а имя хоста — содержать точку. У каждого типа приложения должен быть свой адрес: если адрес уже занят, метод вернет ошибку Handler already binded. Для Битрикс24 по HTTPS используйте адрес с HTTPS, иначе браузер не загрузит содержимое поля" }, { "name": "TITLE", "type": "string", "base": "string", "required": false, - "description": "Текстовое название типа. Будет выводиться в административном интерфейсе настройки пользовательских полей" + "description": "Название типа до 255 символов. Выводится в административном интерфейсе настройки пользовательских полей. Если не передать, названием станет код типа" }, { "name": "DESCRIPTION", "type": "string", "base": "string", "required": false, - "description": "Текстовое описание типа. Будет выводиться в административном интерфейсе настройки пользовательских полей" + "description": "Описание типа до 255 символов. Выводится в административном интерфейсе настройки пользовательских полей" }, { "name": "OPTIONS", - "type": "array", - "base": "array", + "type": "object", + "base": "object", + "required": false, + "description": "Дополнительные настройки. Сейчас доступен один ключ: height — высота поля в пикселях, целое число. По умолчанию — 0: поле получит стандартную высоту, в карточке CRM это 200 пикселей", + "dynamic": { + "allowed": true, + "note": "Состав полей не описан подтаблицей на этой странице" + } + }, + { + "name": "LANG_ALL", + "type": "object", + "base": "object", "required": false, - "description": "Дополнительные настройки. На данный момент доступен один ключ: height — указывает высоту пользовательского поля в пикселях. Применится любое положительное значение. По умолчанию — 0. Если указано 0, то будет использована стандартная высота для отображения этого виджета", + "description": "Название и описание типа для разных языков. Ключ объекта — двухбуквенный код языка, например ru или en. Значение — объект со строковыми полями TITLE и DESCRIPTION до 255 символов. Если передан непустой LANG_ALL, метод не учитывает параметры TITLE и DESCRIPTION.…", "dynamic": { "allowed": true, "note": "Состав полей не описан подтаблицей на этой странице" diff --git a/_assets/simulator/spec/methods/userfieldtype.delete.json b/_assets/simulator/spec/methods/userfieldtype.delete.json index 0ff30f290..b8919b124 100644 --- a/_assets/simulator/spec/methods/userfieldtype.delete.json +++ b/_assets/simulator/spec/methods/userfieldtype.delete.json @@ -11,7 +11,7 @@ "type": "string", "base": "string", "required": true, - "description": "Строковый код типа" + "description": "Код типа, который приложение передало в userfieldtype.add. Регистр не важен. Получить коды можно методом userfieldtype.list" } ], "defs": {}, diff --git a/_assets/simulator/spec/methods/userfieldtype.list.json b/_assets/simulator/spec/methods/userfieldtype.list.json new file mode 100644 index 000000000..60fe582cf --- /dev/null +++ b/_assets/simulator/spec/methods/userfieldtype.list.json @@ -0,0 +1,93 @@ +{ + "$v": 1, + "method": "userfieldtype.list", + "scope": "placement", + "kind": "read", + "title": "Получить список зарегистрированных типов пользовательских полей userfieldtype.list", + "permissions": "администратор", + "params": [ + { + "name": "start", + "type": "integer", + "base": "integer", + "required": "unknown", + "description": "Смещение для постраничной навигации. Метод возвращает не более 50 записей за вызов. Чтобы получить следующую страницу, передайте значение next из предыдущего ответа: для второй страницы это 50, для третьей — 100. Подробнее — в статье Особенности списочных методов" + } + ], + "defs": {}, + "requiredConvention": false, + "confidence": "parsed", + "source": { + "file": "api-reference/widgets/user-field/userfieldtype-list.md" + }, + "resultExample": { + "result": [ + { + "USER_TYPE_ID": "my_custom_type_2", + "HANDLER": "http://test.com/test2.php", + "TITLE": "test title 2", + "DESCRIPTION": "test desc 2" + }, + { + "USER_TYPE_ID": "my_custom_type_1", + "HANDLER": "http://test.com/test1.php", + "TITLE": "test title 1", + "DESCRIPTION": "test desc 1" + }, + { + "USER_TYPE_ID": "test_user_type", + "HANDLER": "http://test.com/test.php", + "TITLE": "test title", + "DESCRIPTION": "test desc" + } + ], + "total": 3, + "time": { + "start": 1724423274.842117, + "finish": 1724423275.558021, + "duration": 0.7159039974212646, + "processing": 0.0018908977508544922, + "date_start": "2024-08-23T16:27:54+02:00", + "date_finish": "2024-08-23T16:27:55+02:00", + "operating": 0 + } + }, + "returns": [ + { + "name": "result", + "type": "array", + "base": "array", + "required": "unknown", + "description": "Список зарегистрированных типов пользовательских полей (подробное описание). Если приложение не зарегистрировало ни одного типа, список пустой" + }, + { + "name": "next", + "type": "integer", + "base": "integer", + "required": "unknown", + "description": "Смещение для следующей страницы. Передайте значение в параметр start, чтобы получить следующие 50 записей. Ключ есть в ответе, только если записи остались" + }, + { + "name": "total", + "type": "integer", + "base": "integer", + "required": "unknown", + "description": "Общее количество типов, которые зарегистрировало приложение" + }, + { + "name": "time", + "type": "time", + "base": "object", + "required": "unknown", + "description": "Информация о времени выполнения запроса" + } + ], + "page": "/api-reference/widgets/user-field/userfieldtype-list.html", + "executable": false, + "entityFields": [ + "DESCRIPTION", + "HANDLER", + "TITLE", + "USER_TYPE_ID" + ] +} diff --git a/_assets/simulator/spec/methods/vote.AttachedVote.vote.json b/_assets/simulator/spec/methods/vote.AttachedVote.vote.json index 9d79e4f10..f4a2f414c 100644 --- a/_assets/simulator/spec/methods/vote.AttachedVote.vote.json +++ b/_assets/simulator/spec/methods/vote.AttachedVote.vote.json @@ -18,7 +18,7 @@ "type": "object", "base": "object", "required": true, - "description": "Данные голоса в формате: Ключ - ID вопроса, значение - массив ID выбранных ответов. Получить ID вопроса и ответов можно методами vote.AttachedVote.get или vote.AttachedVote.getMany. Несколько вопросов в одном голосовании доступно в постах ленты, в сообщении чата в опросе доступен только один вопрос", + "description": "Данные голоса в формате: Ключ — ID вопроса, значение — массив ID выбранных ответов. Получить ID вопроса и ответов можно методами vote.AttachedVote.get или vote.AttachedVote.getMany. Несколько вопросов в одном голосовании доступно в постах ленты, в сообщении чата в опросе доступен только один вопрос", "dynamic": { "allowed": true, "note": "Состав полей не описан подтаблицей на этой странице" diff --git a/_assets/simulator/spec/methods/voximplant.callback.start.json b/_assets/simulator/spec/methods/voximplant.callback.start.json index 10d6ea6a7..87c26eb4a 100644 --- a/_assets/simulator/spec/methods/voximplant.callback.start.json +++ b/_assets/simulator/spec/methods/voximplant.callback.start.json @@ -88,5 +88,11 @@ } ], "page": "/api-reference/telephony/voximplant/voximplant-callback-start.html", - "executable": false + "executable": false, + "requestExample": { + "FROM_LINE": "reg151083", + "TO_NUMBER": "79991234567", + "TEXT_TO_PRONOUNCE": "Вам поступил запрос на обратный звонок", + "VOICE": "ruinternalfemale" + } } diff --git a/_assets/simulator/spec/methods/voximplant.infocall.startwithsound.json b/_assets/simulator/spec/methods/voximplant.infocall.startwithsound.json index cd0e0eac4..0991cbec6 100644 --- a/_assets/simulator/spec/methods/voximplant.infocall.startwithsound.json +++ b/_assets/simulator/spec/methods/voximplant.infocall.startwithsound.json @@ -81,5 +81,10 @@ } ], "page": "/api-reference/telephony/voximplant/voximplant-infocall-start-with-sound.html", - "executable": false + "executable": false, + "requestExample": { + "FROM_LINE": "reg151083", + "TO_NUMBER": "79991234567", + "URL": "https://example.com/sound/notice.mp3" + } } diff --git a/_assets/simulator/spec/methods/voximplant.infocall.startwithtext.json b/_assets/simulator/spec/methods/voximplant.infocall.startwithtext.json index 45972af33..df2ef8629 100644 --- a/_assets/simulator/spec/methods/voximplant.infocall.startwithtext.json +++ b/_assets/simulator/spec/methods/voximplant.infocall.startwithtext.json @@ -88,5 +88,10 @@ } ], "page": "/api-reference/telephony/voximplant/voximplant-infocall-start-with-text.html", - "executable": false + "executable": false, + "requestExample": { + "FROM_LINE": "reg151083", + "TO_NUMBER": "79991234567", + "TEXT_TO_PRONOUNCE": "Добрый день. Напоминаем о записи" + } } diff --git a/_assets/simulator/spec/methods/voximplant.line.get.json b/_assets/simulator/spec/methods/voximplant.line.get.json index b8e0a4258..4178bbba0 100644 --- a/_assets/simulator/spec/methods/voximplant.line.get.json +++ b/_assets/simulator/spec/methods/voximplant.line.get.json @@ -78,5 +78,6 @@ "reg151085", "sip11", "sip7" - ] + ], + "requestExample": {} } diff --git a/_assets/simulator/spec/methods/voximplant.line.outgoing.get.json b/_assets/simulator/spec/methods/voximplant.line.outgoing.get.json index d33cc86c7..0ba553ef3 100644 --- a/_assets/simulator/spec/methods/voximplant.line.outgoing.get.json +++ b/_assets/simulator/spec/methods/voximplant.line.outgoing.get.json @@ -61,5 +61,6 @@ } ], "page": "/api-reference/telephony/voximplant/lines/voximplant-line-outgoing-get.html", - "executable": false + "executable": false, + "requestExample": {} } diff --git a/_assets/simulator/spec/methods/voximplant.line.outgoing.set.json b/_assets/simulator/spec/methods/voximplant.line.outgoing.set.json index bf4281dc8..2cb99c499 100644 --- a/_assets/simulator/spec/methods/voximplant.line.outgoing.set.json +++ b/_assets/simulator/spec/methods/voximplant.line.outgoing.set.json @@ -50,5 +50,8 @@ } ], "page": "/api-reference/telephony/voximplant/lines/voximplant-line-outgoing-set.html", - "executable": false + "executable": false, + "requestExample": { + "LINE_ID": "reg150907" + } } diff --git a/_assets/simulator/spec/methods/voximplant.line.outgoing.sip.set.json b/_assets/simulator/spec/methods/voximplant.line.outgoing.sip.set.json index 6e1b308d1..d26e3d4e5 100644 --- a/_assets/simulator/spec/methods/voximplant.line.outgoing.sip.set.json +++ b/_assets/simulator/spec/methods/voximplant.line.outgoing.sip.set.json @@ -50,5 +50,8 @@ } ], "page": "/api-reference/telephony/voximplant/lines/voximplant-line-outgoing-sip-set.html", - "executable": false + "executable": false, + "requestExample": { + "CONFIG_ID": 9 + } } diff --git a/_assets/simulator/spec/methods/voximplant.sip.add.json b/_assets/simulator/spec/methods/voximplant.sip.add.json index 595982b25..cea1ad5ac 100644 --- a/_assets/simulator/spec/methods/voximplant.sip.add.json +++ b/_assets/simulator/spec/methods/voximplant.sip.add.json @@ -222,5 +222,12 @@ } ], "page": "/api-reference/telephony/voximplant/sip/voximplant-sip-add.html", - "executable": false + "executable": false, + "requestExample": { + "TYPE": "cloud", + "TITLE": "SIP line 1", + "SERVER": "sip.provider.com", + "LOGIN": "sip_user", + "PASSWORD": "secret" + } } diff --git a/_assets/simulator/spec/methods/voximplant.sip.connector.status.json b/_assets/simulator/spec/methods/voximplant.sip.connector.status.json index d0c04158b..12c21a6e8 100644 --- a/_assets/simulator/spec/methods/voximplant.sip.connector.status.json +++ b/_assets/simulator/spec/methods/voximplant.sip.connector.status.json @@ -110,5 +110,6 @@ } ], "page": "/api-reference/telephony/voximplant/sip/voximplant-sip-connector-status.html", - "executable": false + "executable": false, + "requestExample": {} } diff --git a/_assets/simulator/spec/methods/voximplant.sip.delete.json b/_assets/simulator/spec/methods/voximplant.sip.delete.json index 703b8bf94..53cb2d964 100644 --- a/_assets/simulator/spec/methods/voximplant.sip.delete.json +++ b/_assets/simulator/spec/methods/voximplant.sip.delete.json @@ -50,5 +50,8 @@ } ], "page": "/api-reference/telephony/voximplant/sip/voximplant-sip-delete.html", - "executable": false + "executable": false, + "requestExample": { + "CONFIG_ID": 5 + } } diff --git a/_assets/simulator/spec/methods/voximplant.sip.get.json b/_assets/simulator/spec/methods/voximplant.sip.get.json index 5ea4d0579..1f777581a 100644 --- a/_assets/simulator/spec/methods/voximplant.sip.get.json +++ b/_assets/simulator/spec/methods/voximplant.sip.get.json @@ -163,5 +163,16 @@ "SERVER", "TITLE", "TYPE" - ] + ], + "requestExample": { + "FILTER": { + "CONFIG_ID": [ + 3, + 7, + 9 + ] + }, + "SORT": "CONFIG_ID", + "ORDER": "ASC" + } } diff --git a/_assets/simulator/spec/methods/voximplant.sip.status.json b/_assets/simulator/spec/methods/voximplant.sip.status.json index 9c4e028e0..2e88e5805 100644 --- a/_assets/simulator/spec/methods/voximplant.sip.status.json +++ b/_assets/simulator/spec/methods/voximplant.sip.status.json @@ -109,5 +109,8 @@ } ], "page": "/api-reference/telephony/voximplant/sip/voximplant-sip-status.html", - "executable": false + "executable": false, + "requestExample": { + "REG_ID": 150907 + } } diff --git a/_assets/simulator/spec/methods/voximplant.sip.update.json b/_assets/simulator/spec/methods/voximplant.sip.update.json index 22603556a..1f3650e4d 100644 --- a/_assets/simulator/spec/methods/voximplant.sip.update.json +++ b/_assets/simulator/spec/methods/voximplant.sip.update.json @@ -78,5 +78,9 @@ } ], "page": "/api-reference/telephony/voximplant/sip/voximplant-sip-update.html", - "executable": false + "executable": false, + "requestExample": { + "CONFIG_ID": 5, + "TITLE": "SIP line 1 (updated)" + } } diff --git a/_assets/simulator/spec/methods/voximplant.statistic.get.json b/_assets/simulator/spec/methods/voximplant.statistic.get.json index 39f5fcd14..03fb438b8 100644 --- a/_assets/simulator/spec/methods/voximplant.statistic.get.json +++ b/_assets/simulator/spec/methods/voximplant.statistic.get.json @@ -194,5 +194,16 @@ "SESSION_ID", "TRANSCRIPT_ID", "TRANSCRIPT_PENDING" - ] + ], + "requestExample": { + "FILTER": { + "ID": [ + 1, + 7 + ], + ">=CALL_START_DATE": "2025-01-01T00:00:00+03:00" + }, + "SORT": "ID", + "ORDER": "ASC" + } } diff --git a/_assets/simulator/spec/methods/voximplant.tts.voices.get.json b/_assets/simulator/spec/methods/voximplant.tts.voices.get.json index 845c2e7b6..efecf0cc8 100644 --- a/_assets/simulator/spec/methods/voximplant.tts.voices.get.json +++ b/_assets/simulator/spec/methods/voximplant.tts.voices.get.json @@ -152,5 +152,6 @@ "usenglishmale", "usspanishfemale", "usspanishmale" - ] + ], + "requestExample": {} } diff --git a/_assets/simulator/spec/methods/voximplant.url.get.json b/_assets/simulator/spec/methods/voximplant.url.get.json index 0a7f50d3c..f2423c22b 100644 --- a/_assets/simulator/spec/methods/voximplant.url.get.json +++ b/_assets/simulator/spec/methods/voximplant.url.get.json @@ -132,5 +132,6 @@ "detail_statistics", "edit_config", "lines" - ] + ], + "requestExample": {} } diff --git a/_assets/simulator/spec/methods/voximplant.user.activatePhone.json b/_assets/simulator/spec/methods/voximplant.user.activatePhone.json index 51ac0de8e..df4485779 100644 --- a/_assets/simulator/spec/methods/voximplant.user.activatePhone.json +++ b/_assets/simulator/spec/methods/voximplant.user.activatePhone.json @@ -50,5 +50,8 @@ } ], "page": "/api-reference/telephony/voximplant/users/voximplant-user-activate-phone.html", - "executable": false + "executable": false, + "requestExample": { + "USER_ID": 1269 + } } diff --git a/_assets/simulator/spec/methods/voximplant.user.deactivatePhone.json b/_assets/simulator/spec/methods/voximplant.user.deactivatePhone.json new file mode 100644 index 000000000..e32d908ad --- /dev/null +++ b/_assets/simulator/spec/methods/voximplant.user.deactivatePhone.json @@ -0,0 +1,57 @@ +{ + "$v": 1, + "method": "voximplant.user.deactivatePhone", + "scope": "telephony", + "kind": "write", + "title": "Деактивировать SIP-аппарат пользователя voximplant.user.deactivatePhone", + "permissions": "пользователь с правом Настройки пользователя — Изменение", + "params": [ + { + "name": "USER_ID", + "type": "integer", + "base": "integer", + "required": true, + "description": "Идентификатор пользователя, у которого нужно деактивировать SIP-аппарат. Получить идентификатор можно методом user.get" + } + ], + "defs": {}, + "requiredConvention": true, + "confidence": "parsed", + "source": { + "file": "api-reference/telephony/voximplant/users/voximplant-user-deactivate-phone.md" + }, + "resultExample": { + "result": 1, + "time": { + "start": 1773666334, + "finish": 1773666335.198412, + "duration": 1.1984119415283203, + "processing": 1, + "date_start": "2026-03-16T16:05:34+03:00", + "date_finish": "2026-03-16T16:05:35+03:00", + "operating_reset_at": 1773666934, + "operating": 0.4791221618652344 + } + }, + "returns": [ + { + "name": "result", + "type": "integer", + "base": "integer", + "required": false, + "description": "Результат выполнения метода. 1 — запрос на деактивацию SIP-аппарата выполнен" + }, + { + "name": "time", + "type": "time", + "base": "object", + "required": false, + "description": "Информация о времени выполнения запроса" + } + ], + "page": "/api-reference/telephony/voximplant/users/voximplant-user-deactivate-phone.html", + "executable": false, + "requestExample": { + "USER_ID": 1269 + } +} diff --git a/_assets/simulator/spec/methods/voximplant.user.get.json b/_assets/simulator/spec/methods/voximplant.user.get.json index 47e0c458e..4771e507d 100644 --- a/_assets/simulator/spec/methods/voximplant.user.get.json +++ b/_assets/simulator/spec/methods/voximplant.user.get.json @@ -59,8 +59,8 @@ "returns": [ { "name": "result", - "type": "object", - "base": "object", + "type": "object[]", + "base": "array", "required": false, "description": "Массив настроек пользователей" }, @@ -76,7 +76,7 @@ "type": "string", "base": "string", "required": false, - "description": "Номер исходящей линии по умолчанию" + "description": "Номер исходящей линии по умолчанию. Может быть null" }, { "name": "PHONE_ENABLED", @@ -114,14 +114,14 @@ "type": "string", "base": "string", "required": false, - "description": "Пароль для подключения SIP-аппарата" + "description": "Пароль для подключения SIP-аппарата. Может быть null" }, { "name": "INNER_NUMBER", "type": "string", "base": "string", "required": false, - "description": "Внутренний номер пользователя" + "description": "Внутренний номер пользователя. Может быть null" }, { "name": "time", @@ -141,5 +141,11 @@ "SIP_LOGIN", "SIP_PASSWORD", "SIP_SERVER" - ] + ], + "requestExample": { + "USER_ID": [ + 1269, + 1271 + ] + } } diff --git a/_assets/simulator/spec/pages.json b/_assets/simulator/spec/pages.json index 579dac8dd..ddc071516 100644 --- a/_assets/simulator/spec/pages.json +++ b/_assets/simulator/spec/pages.json @@ -1 +1 @@ -{"/api-reference/ai/ai-engine-list":"ai.engine.list","/api-reference/ai/ai-engine-register":"ai.engine.register","/api-reference/ai/ai-engine-unregister":"ai.engine.unregister","/api-reference/biconnector/connector/biconnector-connector-add":"biconnector.connector.add","/api-reference/biconnector/connector/biconnector-connector-delete":"biconnector.connector.delete","/api-reference/biconnector/connector/biconnector-connector-fields":"biconnector.connector.fields","/api-reference/biconnector/connector/biconnector-connector-get":"biconnector.connector.get","/api-reference/biconnector/connector/biconnector-connector-list":"biconnector.connector.list","/api-reference/biconnector/connector/biconnector-connector-update":"biconnector.connector.update","/api-reference/biconnector/dataset/biconnector-dataset-add":"biconnector.dataset.add","/api-reference/biconnector/dataset/biconnector-dataset-delete":"biconnector.dataset.delete","/api-reference/biconnector/dataset/biconnector-dataset-fields-update":"biconnector.dataset.fields.update","/api-reference/biconnector/dataset/biconnector-dataset-fields":"biconnector.dataset.fields","/api-reference/biconnector/dataset/biconnector-dataset-get":"biconnector.dataset.get","/api-reference/biconnector/dataset/biconnector-dataset-list":"biconnector.dataset.list","/api-reference/biconnector/dataset/biconnector-dataset-update":"biconnector.dataset.update","/api-reference/biconnector/source/biconnector-source-add":"biconnector.source.add","/api-reference/biconnector/source/biconnector-source-delete":"biconnector.source.delete","/api-reference/biconnector/source/biconnector-source-fields":"biconnector.source.fields","/api-reference/biconnector/source/biconnector-source-get":"biconnector.source.get","/api-reference/biconnector/source/biconnector-source-list":"biconnector.source.list","/api-reference/biconnector/source/biconnector-source-update":"biconnector.source.update","/api-reference/bizproc/bizproc-activity/bizproc-activity-add":"bizproc.activity.add","/api-reference/bizproc/bizproc-activity/bizproc-activity-delete":"bizproc.activity.delete","/api-reference/bizproc/bizproc-activity/bizproc-activity-list":"bizproc.activity.list","/api-reference/bizproc/bizproc-activity/bizproc-activity-log":"bizproc.activity.log","/api-reference/bizproc/bizproc-activity/bizproc-activity-update":"bizproc.activity.update","/api-reference/bizproc/bizproc-robot/bizproc-event-send":"bizproc.event.send","/api-reference/bizproc/bizproc-robot/bizproc-robot-add":"bizproc.robot.add","/api-reference/bizproc/bizproc-robot/bizproc-robot-delete":"bizproc.robot.delete","/api-reference/bizproc/bizproc-robot/bizproc-robot-list":"bizproc.robot.list","/api-reference/bizproc/bizproc-robot/bizproc-robot-update":"bizproc.robot.update","/api-reference/bizproc/bizproc-task/bizproc-task-complete":"bizproc.task.complete","/api-reference/bizproc/bizproc-task/bizproc-task-delegate":"bizproc.task.delegate","/api-reference/bizproc/bizproc-task/bizproc-task-list":"bizproc.task.list","/api-reference/bizproc/bizproc-workflow-instances":"bizproc.workflow.instances","/api-reference/bizproc/bizproc-workflow-kill":"bizproc.workflow.kill","/api-reference/bizproc/bizproc-workflow-start":"bizproc.workflow.start","/api-reference/bizproc/bizproc-workflow-terminate":"bizproc.workflow.terminate","/api-reference/bizproc/template/bizproc-workflow-template-add":"bizproc.workflow.template.add","/api-reference/bizproc/template/bizproc-workflow-template-delete":"bizproc.workflow.template.delete","/api-reference/bizproc/template/bizproc-workflow-template-list":"bizproc.workflow.template.list","/api-reference/bizproc/template/bizproc-workflow-template-update":"bizproc.workflow.template.update","/api-reference/booking/booking-v1-clienttype-list":"booking.v1.clienttype.list","/api-reference/booking/booking/booking-v1-booking-add":"booking.v1.booking.add","/api-reference/booking/booking/booking-v1-booking-createfromwaitlist":"booking.v1.booking.createfromwaitlist","/api-reference/booking/booking/booking-v1-booking-delete":"booking.v1.booking.delete","/api-reference/booking/booking/booking-v1-booking-get":"booking.v1.booking.get","/api-reference/booking/booking/booking-v1-booking-list":"booking.v1.booking.list","/api-reference/booking/booking/booking-v1-booking-update":"booking.v1.booking.update","/api-reference/booking/booking/client/booking-v1-booking-client-list":"booking.v1.booking.client.list","/api-reference/booking/booking/client/booking-v1-booking-client-set":"booking.v1.booking.client.set","/api-reference/booking/booking/client/booking-v1-booking-client-unset":"booking.v1.booking.client.unset","/api-reference/booking/booking/external-data/booking-v1-booking-externaldata-list":"booking.v1.booking.externalData.list","/api-reference/booking/booking/external-data/booking-v1-booking-externaldata-set":"booking.v1.booking.externalData.set","/api-reference/booking/booking/external-data/booking-v1-booking-externaldata-unset":"booking.v1.booking.externalData.unset","/api-reference/booking/resource/booking-v1-resource-add":"booking.v1.resource.add","/api-reference/booking/resource/booking-v1-resource-delete":"booking.v1.resource.delete","/api-reference/booking/resource/booking-v1-resource-get":"booking.v1.resource.get","/api-reference/booking/resource/booking-v1-resource-list":"booking.v1.resource.list","/api-reference/booking/resource/booking-v1-resource-update":"booking.v1.resource.update","/api-reference/booking/resource/resource-type/booking-v1-resourcetype-add":"booking.v1.resourceType.add","/api-reference/booking/resource/resource-type/booking-v1-resourcetype-delete":"booking.v1.resourceType.delete","/api-reference/booking/resource/resource-type/booking-v1-resourcetype-get":"booking.v1.resourceType.get","/api-reference/booking/resource/resource-type/booking-v1-resourcetype-list":"booking.v1.resourceType.list","/api-reference/booking/resource/resource-type/booking-v1-resourcetype-update":"booking.v1.resourceType.update","/api-reference/booking/resource/slots/booking-v1-resource-slots-list":"booking.v1.resource.slots.list","/api-reference/booking/resource/slots/booking-v1-resource-slots-set":"booking.v1.resource.slots.set","/api-reference/booking/resource/slots/booking-v1-resource-slots-unset":"booking.v1.resource.slots.unset","/api-reference/booking/waitlist/booking-v1-waitlist-add":"booking.v1.waitlist.add","/api-reference/booking/waitlist/booking-v1-waitlist-createfrombooking":"booking.v1.waitlist.createfrombooking","/api-reference/booking/waitlist/booking-v1-waitlist-delete":"booking.v1.waitlist.delete","/api-reference/booking/waitlist/booking-v1-waitlist-get":"booking.v1.waitlist.get","/api-reference/booking/waitlist/booking-v1-waitlist-list":"booking.v1.waitlist.list","/api-reference/booking/waitlist/booking-v1-waitlist-update":"booking.v1.waitlist.update","/api-reference/booking/waitlist/client/booking-v1-waitlist-client-list":"booking.v1.waitlist.client.list","/api-reference/booking/waitlist/client/booking-v1-waitlist-client-set":"booking.v1.waitlist.client.set","/api-reference/booking/waitlist/client/booking-v1-waitlist-client-unset":"booking.v1.waitlist.client.unset","/api-reference/booking/waitlist/external-data/booking-v1-waitlist-externaldata-list":"booking.v1.waitlist.externalData.list","/api-reference/booking/waitlist/external-data/booking-v1-waitlist-externaldata-set":"booking.v1.waitlist.externalData.set","/api-reference/booking/waitlist/external-data/booking-v1-waitlist-externaldata-unset":"booking.v1.waitlist.externalData.unset","/api-reference/calendar/calendar-event/calendar-accessibility-get":"calendar.accessibility.get","/api-reference/calendar/calendar-event/calendar-event-add":"calendar.event.add","/api-reference/calendar/calendar-event/calendar-event-delete":"calendar.event.delete","/api-reference/calendar/calendar-event/calendar-event-get-by-id":"calendar.event.getbyid","/api-reference/calendar/calendar-event/calendar-event-get-nearest":"calendar.event.get.nearest","/api-reference/calendar/calendar-event/calendar-event-get":"calendar.event.get","/api-reference/calendar/calendar-event/calendar-event-update":"calendar.event.update","/api-reference/calendar/calendar-event/calendar-meeting-status-get":"calendar.meeting.status.get","/api-reference/calendar/calendar-event/calendar-meeting-status-set":"calendar.meeting.status.set","/api-reference/calendar/calendar-section-add":"calendar.section.add","/api-reference/calendar/calendar-section-delete":"calendar.section.delete","/api-reference/calendar/calendar-section-get":"calendar.section.get","/api-reference/calendar/calendar-section-update":"calendar.section.update","/api-reference/calendar/calendar-user-settings-set":"calendar.user.settings.set","/api-reference/calendar/resource/calendar-resource-add":"calendar.resource.add","/api-reference/calendar/resource/calendar-resource-booking-list":"calendar.resource.booking.list","/api-reference/calendar/resource/calendar-resource-delete":"calendar.resource.delete","/api-reference/calendar/resource/calendar-resource-update":"calendar.resource.update","/api-reference/catalog/catalog/catalog-catalog-get":"catalog.catalog.get","/api-reference/catalog/catalog/catalog-catalog-is-offers":"catalog.catalog.isOffers","/api-reference/catalog/catalog/catalog-catalog-list":"catalog.catalog.list","/api-reference/catalog/document/catalog-document-add":"catalog.document.add","/api-reference/catalog/document/catalog-document-cancel-list":"catalog.document.cancelList","/api-reference/catalog/document/catalog-document-cancel":"catalog.document.cancel","/api-reference/catalog/document/catalog-document-conduct-list":"catalog.document.conductList","/api-reference/catalog/document/catalog-document-conduct":"catalog.document.conduct","/api-reference/catalog/document/catalog-document-delete-list":"catalog.document.deleteList","/api-reference/catalog/document/catalog-document-delete":"catalog.document.delete","/api-reference/catalog/document/catalog-document-get-fields":"catalog.document.getFields","/api-reference/catalog/document/catalog-document-list":"catalog.document.list","/api-reference/catalog/document/catalog-document-mode-status":"catalog.document.mode.status","/api-reference/catalog/document/catalog-document-update":"catalog.document.update","/api-reference/catalog/document/document-element/catalog-document-element-add":"catalog.document.element.add","/api-reference/catalog/document/document-element/catalog-document-element-delete":"catalog.document.element.delete","/api-reference/catalog/document/document-element/catalog-document-element-get-fields":"catalog.document.element.getFields","/api-reference/catalog/document/document-element/catalog-document-element-list":"catalog.document.element.list","/api-reference/catalog/document/document-element/catalog-document-element-update":"catalog.document.element.update","/api-reference/catalog/document/outdated/catalog-document-confirm":"catalog.document.confirm","/api-reference/catalog/document/outdated/catalog-document-element-fields":"catalog.document.element.fields","/api-reference/catalog/document/outdated/catalog-document-fields":"catalog.document.fields","/api-reference/catalog/document/outdated/catalog-document-unconfirm":"catalog.document.unconfirm","/api-reference/catalog/documentcontractor/catalog-documentcontractor-add":"catalog.documentcontractor.add","/api-reference/catalog/documentcontractor/catalog-documentcontractor-delete":"catalog.documentcontractor.delete","/api-reference/catalog/documentcontractor/catalog-documentcontractor-get-fields":"catalog.documentcontractor.getFields","/api-reference/catalog/documentcontractor/catalog-documentcontractor-list":"catalog.documentcontractor.list","/api-reference/catalog/enum/catalog-enum-get-round-types":"catalog.enum.getRoundTypes","/api-reference/catalog/enum/catalog-enum-get-store-document-types":"catalog.enum.getStoreDocumentTypes","/api-reference/catalog/extra/catalog-extra-get":"catalog.extra.get","/api-reference/catalog/extra/catalog-extra-list":"catalog.extra.list","/api-reference/catalog/measure/catalog-measure-add":"catalog.measure.add","/api-reference/catalog/measure/catalog-measure-delete":"catalog.measure.delete","/api-reference/catalog/measure/catalog-measure-get":"catalog.measure.get","/api-reference/catalog/measure/catalog-measure-list":"catalog.measure.list","/api-reference/catalog/measure/catalog-measure-update":"catalog.measure.update","/api-reference/catalog/price-type/catalog-price-type-add":"catalog.priceType.add","/api-reference/catalog/price-type/catalog-price-type-delete":"catalog.priceType.delete","/api-reference/catalog/price-type/catalog-price-type-get":"catalog.priceType.get","/api-reference/catalog/price-type/catalog-price-type-list":"catalog.priceType.list","/api-reference/catalog/price-type/catalog-price-type-update":"catalog.priceType.update","/api-reference/catalog/price-type/price-type-group/catalog-price-type-group-add":"catalog.priceTypeGroup.add","/api-reference/catalog/price-type/price-type-group/catalog-price-type-group-delete":"catalog.priceTypeGroup.delete","/api-reference/catalog/price-type/price-type-group/catalog-price-type-group-get-fields":"catalog.priceTypeGroup.getFields","/api-reference/catalog/price-type/price-type-group/catalog-price-type-group-list":"catalog.priceTypeGroup.list","/api-reference/catalog/price-type/price-type-lang/catalog-price-type-lang-add":"catalog.priceTypeLang.add","/api-reference/catalog/price-type/price-type-lang/catalog-price-type-lang-delete":"catalog.priceTypeLang.delete","/api-reference/catalog/price-type/price-type-lang/catalog-price-type-lang-get-languages":"catalog.priceTypeLang.getLanguages","/api-reference/catalog/price-type/price-type-lang/catalog-price-type-lang-get":"catalog.priceTypeLang.get","/api-reference/catalog/price-type/price-type-lang/catalog-price-type-lang-list":"catalog.priceTypeLang.list","/api-reference/catalog/price-type/price-type-lang/catalog-price-type-lang-update":"catalog.priceTypeLang.update","/api-reference/catalog/price/catalog-price-add":"catalog.price.add","/api-reference/catalog/price/catalog-price-delete":"catalog.price.delete","/api-reference/catalog/price/catalog-price-get-fields":"catalog.price.getFields","/api-reference/catalog/price/catalog-price-get":"catalog.price.get","/api-reference/catalog/price/catalog-price-list":"catalog.price.list","/api-reference/catalog/price/catalog-price-modify":"catalog.price.modify","/api-reference/catalog/price/catalog-price-update":"catalog.price.update","/api-reference/catalog/product-image/catalog-product-image-add":"catalog.productImage.add","/api-reference/catalog/product-image/catalog-product-image-delete":"catalog.productImage.delete","/api-reference/catalog/product-image/catalog-product-image-get":"catalog.productImage.get","/api-reference/catalog/product-image/catalog-product-image-list":"catalog.productImage.list","/api-reference/catalog/product-property-enum/catalog-product-property-enum-add":"catalog.productPropertyEnum.add","/api-reference/catalog/product-property-enum/catalog-product-property-enum-delete":"catalog.productPropertyEnum.delete","/api-reference/catalog/product-property-enum/catalog-product-property-enum-get-fields":"catalog.productPropertyEnum.getFields","/api-reference/catalog/product-property-enum/catalog-product-property-enum-get":"catalog.productPropertyEnum.get","/api-reference/catalog/product-property-enum/catalog-product-property-enum-list":"catalog.productPropertyEnum.list","/api-reference/catalog/product-property-enum/catalog-product-property-enum-update":"catalog.productPropertyEnum.update","/api-reference/catalog/product-property-feature/catalog-product-property-feature-add":"catalog.productPropertyFeature.add","/api-reference/catalog/product-property-feature/catalog-product-property-feature-get-available-features-by-property":"catalog.productPropertyFeature.getAvailableFeaturesByProperty","/api-reference/catalog/product-property-feature/catalog-product-property-feature-get-fields":"catalog.productPropertyFeature.getFields","/api-reference/catalog/product-property-feature/catalog-product-property-feature-get":"catalog.productPropertyFeature.get","/api-reference/catalog/product-property-feature/catalog-product-property-feature-list":"catalog.productPropertyFeature.list","/api-reference/catalog/product-property-feature/catalog-product-property-feature-update":"catalog.productPropertyFeature.update","/api-reference/catalog/product-property-section/catalog-product-property-section-get":"catalog.productPropertySection.get","/api-reference/catalog/product-property-section/catalog-product-property-section-list":"catalog.productPropertySection.list","/api-reference/catalog/product-property-section/catalog-product-property-section-set":"catalog.productPropertySection.set","/api-reference/catalog/product-property/catalog-product-property-add":"catalog.productProperty.add","/api-reference/catalog/product-property/catalog-product-property-delete":"catalog.productProperty.delete","/api-reference/catalog/product-property/catalog-product-property-get-fields":"catalog.productProperty.getFields","/api-reference/catalog/product-property/catalog-product-property-get":"catalog.productProperty.get","/api-reference/catalog/product-property/catalog-product-property-list":"catalog.productProperty.list","/api-reference/catalog/product-property/catalog-product-property-update":"catalog.productProperty.update","/api-reference/catalog/product/catalog-product-add":"catalog.product.add","/api-reference/catalog/product/catalog-product-delete":"catalog.product.delete","/api-reference/catalog/product/catalog-product-download":"catalog.product.download","/api-reference/catalog/product/catalog-product-get-fields-by-filter":"catalog.product.getFieldsByFilter","/api-reference/catalog/product/catalog-product-get":"catalog.product.get","/api-reference/catalog/product/catalog-product-list":"catalog.product.list","/api-reference/catalog/product/catalog-product-update":"catalog.product.update","/api-reference/catalog/product/offer/catalog-product-offer-add":"catalog.product.offer.add","/api-reference/catalog/product/offer/catalog-product-offer-delete":"catalog.product.offer.delete","/api-reference/catalog/product/offer/catalog-product-offer-download":"catalog.product.offer.download","/api-reference/catalog/product/offer/catalog-product-offer-get-fields-by-filter":"catalog.product.offer.getFieldsByFilter","/api-reference/catalog/product/offer/catalog-product-offer-get":"catalog.product.offer.get","/api-reference/catalog/product/offer/catalog-product-offer-list":"catalog.product.offer.list","/api-reference/catalog/product/offer/catalog-product-offer-update":"catalog.product.offer.update","/api-reference/catalog/product/service/catalog-product-service-add":"catalog.product.service.add","/api-reference/catalog/product/service/catalog-product-service-delete":"catalog.product.service.delete","/api-reference/catalog/product/service/catalog-product-service-download":"catalog.product.service.download","/api-reference/catalog/product/service/catalog-product-service-get-fields-by-filter":"catalog.product.service.getFieldsByFilter","/api-reference/catalog/product/service/catalog-product-service-get":"catalog.product.service.get","/api-reference/catalog/product/service/catalog-product-service-list":"catalog.product.service.list","/api-reference/catalog/product/service/catalog-product-service-update":"catalog.product.service.update","/api-reference/catalog/product/sku/catalog-product-sku-add":"catalog.product.sku.add","/api-reference/catalog/product/sku/catalog-product-sku-delete":"catalog.product.sku.delete","/api-reference/catalog/product/sku/catalog-product-sku-download":"catalog.product.sku.download","/api-reference/catalog/product/sku/catalog-product-sku-get-fields-by-filter":"catalog.product.sku.getFieldsByFilter","/api-reference/catalog/product/sku/catalog-product-sku-get":"catalog.product.sku.get","/api-reference/catalog/product/sku/catalog-product-sku-list":"catalog.product.sku.list","/api-reference/catalog/product/sku/catalog-product-sku-update":"catalog.product.sku.update","/api-reference/catalog/ratio/catalog-ratio-get":"catalog.ratio.get","/api-reference/catalog/ratio/catalog-ratio-list":"catalog.ratio.list","/api-reference/catalog/rounding-rule/catalog-rounding-rule-add":"catalog.roundingRule.add","/api-reference/catalog/rounding-rule/catalog-rounding-rule-delete":"catalog.roundingRule.delete","/api-reference/catalog/rounding-rule/catalog-rounding-rule-get":"catalog.roundingRule.get","/api-reference/catalog/rounding-rule/catalog-rounding-rule-list":"catalog.roundingRule.list","/api-reference/catalog/rounding-rule/catalog-rounding-rule-update":"catalog.roundingRule.update","/api-reference/catalog/section/catalog-section-add":"catalog.section.add","/api-reference/catalog/section/catalog-section-delete":"catalog.section.delete","/api-reference/catalog/section/catalog-section-get":"catalog.section.get","/api-reference/catalog/section/catalog-section-list":"catalog.section.list","/api-reference/catalog/section/catalog-section-update":"catalog.section.update","/api-reference/catalog/store-product/catalog-store-product-get-fields":"catalog.storeproduct.getFields","/api-reference/catalog/store-product/catalog-store-product-get":"catalog.storeproduct.get","/api-reference/catalog/store-product/catalog-store-product-list":"catalog.storeproduct.list","/api-reference/catalog/store/catalog-store-add":"catalog.store.add","/api-reference/catalog/store/catalog-store-delete":"catalog.store.delete","/api-reference/catalog/store/catalog-store-get":"catalog.store.get","/api-reference/catalog/store/catalog-store-list":"catalog.store.list","/api-reference/catalog/store/catalog-store-update":"catalog.store.update","/api-reference/catalog/userfield-document/catalog-userfield-document-list":"catalog.userfield.document.list","/api-reference/catalog/userfield-document/catalog-userfield-document-update":"catalog.userfield.document.update","/api-reference/catalog/vat/catalog-vat-add":"catalog.vat.add","/api-reference/catalog/vat/catalog-vat-delete":"catalog.vat.delete","/api-reference/catalog/vat/catalog-vat-get":"catalog.vat.get","/api-reference/catalog/vat/catalog-vat-list":"catalog.vat.list","/api-reference/catalog/vat/catalog-vat-update":"catalog.vat.update","/api-reference/chat-bots/chat-bots-v2/im.v2/events/event-get":"im.v2.Event.get","/api-reference/chat-bots/chat-bots-v2/im.v2/events/event-subscribe":"im.v2.Event.subscribe","/api-reference/chat-bots/chat-bots-v2/im.v2/events/event-unsubscribe":"im.v2.Event.unsubscribe","/api-reference/chat-bots/chat-bots-v2/im.v2/files/file-download":"im.v2.File.download","/api-reference/chat-bots/chat-bots-v2/im.v2/files/file-upload":"im.v2.File.upload","/api-reference/chat-bots/chat-bots-v2/imbot.v2/bots/bot-get":"imbot.v2.Bot.get","/api-reference/chat-bots/chat-bots-v2/imbot.v2/bots/bot-list":"imbot.v2.Bot.list","/api-reference/chat-bots/chat-bots-v2/imbot.v2/bots/bot-register":"imbot.v2.Bot.register","/api-reference/chat-bots/chat-bots-v2/imbot.v2/bots/bot-unregister":"imbot.v2.Bot.unregister","/api-reference/chat-bots/chat-bots-v2/imbot.v2/bots/bot-update":"imbot.v2.Bot.update","/api-reference/chat-bots/chat-bots-v2/imbot.v2/chats/chat-add":"imbot.v2.Chat.add","/api-reference/chat-bots/chat-bots-v2/imbot.v2/chats/chat-get":"imbot.v2.Chat.get","/api-reference/chat-bots/chat-bots-v2/imbot.v2/chats/chat-leave":"imbot.v2.Chat.leave","/api-reference/chat-bots/chat-bots-v2/imbot.v2/chats/chat-manager-add":"imbot.v2.Chat.Manager.add","/api-reference/chat-bots/chat-bots-v2/imbot.v2/chats/chat-manager-delete":"imbot.v2.Chat.Manager.delete","/api-reference/chat-bots/chat-bots-v2/imbot.v2/chats/chat-set-owner":"imbot.v2.Chat.setOwner","/api-reference/chat-bots/chat-bots-v2/imbot.v2/chats/chat-update":"imbot.v2.Chat.update","/api-reference/chat-bots/chat-bots-v2/imbot.v2/chats/chat-user-add":"imbot.v2.Chat.User.add","/api-reference/chat-bots/chat-bots-v2/imbot.v2/chats/chat-user-delete":"imbot.v2.Chat.User.delete","/api-reference/chat-bots/chat-bots-v2/imbot.v2/chats/chat-user-list":"imbot.v2.Chat.User.list","/api-reference/chat-bots/chat-bots-v2/imbot.v2/commands/command-answer":"imbot.v2.Command.answer","/api-reference/chat-bots/chat-bots-v2/imbot.v2/commands/command-list":"imbot.v2.Command.list","/api-reference/chat-bots/chat-bots-v2/imbot.v2/commands/command-register":"imbot.v2.Command.register","/api-reference/chat-bots/chat-bots-v2/imbot.v2/commands/command-unregister":"imbot.v2.Command.unregister","/api-reference/chat-bots/chat-bots-v2/imbot.v2/commands/command-update":"imbot.v2.Command.update","/api-reference/chat-bots/chat-bots-v2/imbot.v2/events/event-get":"imbot.v2.Event.get","/api-reference/chat-bots/chat-bots-v2/imbot.v2/files/file-download":"imbot.v2.File.download","/api-reference/chat-bots/chat-bots-v2/imbot.v2/files/file-upload":"imbot.v2.File.upload","/api-reference/chat-bots/chat-bots-v2/imbot.v2/messages/chat-message-delete":"imbot.v2.Chat.Message.delete","/api-reference/chat-bots/chat-bots-v2/imbot.v2/messages/chat-message-get-context":"imbot.v2.Chat.Message.getContext","/api-reference/chat-bots/chat-bots-v2/imbot.v2/messages/chat-message-get":"imbot.v2.Chat.Message.get","/api-reference/chat-bots/chat-bots-v2/imbot.v2/messages/chat-message-reaction-add":"imbot.v2.Chat.Message.Reaction.add","/api-reference/chat-bots/chat-bots-v2/imbot.v2/messages/chat-message-reaction-delete":"imbot.v2.Chat.Message.Reaction.delete","/api-reference/chat-bots/chat-bots-v2/imbot.v2/messages/chat-message-read":"imbot.v2.Chat.Message.read","/api-reference/chat-bots/chat-bots-v2/imbot.v2/messages/chat-message-send":"imbot.v2.Chat.Message.send","/api-reference/chat-bots/chat-bots-v2/imbot.v2/messages/chat-message-update":"imbot.v2.Chat.Message.update","/api-reference/chat-bots/chat-bots-v2/imbot.v2/revision-get":"imbot.v2.Revision.get","/api-reference/chat-bots/chat-bots-v2/imbot.v2/ui/chat-input-action-notify":"imbot.v2.Chat.InputAction.notify","/api-reference/chat-bots/chat-bots-v2/imbot.v2/ui/chat-text-field-enabled":"imbot.v2.Chat.TextField.enabled","/api-reference/chat-bots/outdated/bots/imbot-register":"imbot.register","/api-reference/chat-bots/outdated/bots/imbot-unregister":"imbot.unregister","/api-reference/chat-bots/outdated/bots/imbot-update":"imbot.update","/api-reference/chat-bots/outdated/chats/imbot-chat-add":"imbot.chat.add","/api-reference/chat-bots/outdated/chats/imbot-chat-get":"imbot.chat.get","/api-reference/chat-bots/outdated/chats/imbot-chat-leave":"imbot.chat.leave","/api-reference/chat-bots/outdated/chats/imbot-chat-send-typing":"imbot.chat.sendTyping","/api-reference/chat-bots/outdated/chats/imbot-chat-set-manager":"imbot.chat.setManager","/api-reference/chat-bots/outdated/chats/imbot-chat-set-owner":"imbot.chat.setOwner","/api-reference/chat-bots/outdated/chats/imbot-chat-update-avatar":"imbot.chat.updateAvatar","/api-reference/chat-bots/outdated/chats/imbot-chat-update-color":"imbot.chat.updateColor","/api-reference/chat-bots/outdated/chats/imbot-chat-update-title":"imbot.chat.updateTitle","/api-reference/chat-bots/outdated/chats/imbot-chat-user-add":"imbot.chat.user.add","/api-reference/chat-bots/outdated/chats/imbot-chat-user-delete":"imbot.chat.user.delete","/api-reference/chat-bots/outdated/chats/imbot-chat-user-list":"imbot.chat.user.list","/api-reference/chat-bots/outdated/chats/imbot-dialog-get":"imbot.dialog.get","/api-reference/chat-bots/outdated/commands/imbot-command-answer":"imbot.command.answer","/api-reference/chat-bots/outdated/commands/imbot-command-register":"imbot.command.register","/api-reference/chat-bots/outdated/commands/imbot-command-unregister":"imbot.command.unregister","/api-reference/chat-bots/outdated/commands/imbot-command-update":"imbot.command.update","/api-reference/chat-bots/outdated/messages/imbot-message-add":"imbot.message.add","/api-reference/chat-bots/outdated/messages/imbot-message-delete":"imbot.message.delete","/api-reference/chat-bots/outdated/messages/imbot-message-like":"imbot.message.like","/api-reference/chat-bots/outdated/messages/imbot-message-update":"imbot.message.update","/api-reference/chats/chat-update/im-chat-set-owner":"im.chat.setOwner","/api-reference/chats/chat-update/im-chat-update-avatar":"im.chat.updateAvatar","/api-reference/chats/chat-update/im-chat-update-color":"im.chat.updateColor","/api-reference/chats/chat-update/im-chat-update-title":"im.chat.updateTitle","/api-reference/chats/chat-users/im-chat-leave":"im.chat.leave","/api-reference/chats/chat-users/im-chat-user-add":"im.chat.user.add","/api-reference/chats/chat-users/im-chat-user-delete":"im.chat.user.delete","/api-reference/chats/chat-users/im-chat-user-list":"im.chat.user.list","/api-reference/chats/chat-users/im-dialog-users-list":"im.dialog.users.list","/api-reference/chats/departments/im-department-colleagues-list":"im.department.colleagues.list","/api-reference/chats/departments/im-department-employees-get":"im.department.employees.get","/api-reference/chats/departments/im-department-get":"im.department.get","/api-reference/chats/departments/im-department-managers-get":"im.department.managers.get","/api-reference/chats/files/im-disk-file-commit":"im.disk.file.commit","/api-reference/chats/files/im-disk-file-delete":"im.disk.file.delete","/api-reference/chats/files/im-disk-file-save":"im.disk.file.save","/api-reference/chats/files/im-disk-folder-get":"im.disk.folder.get","/api-reference/chats/im-chat-add":"im.chat.add","/api-reference/chats/im-chat-get":"im.chat.get","/api-reference/chats/im-counters-get":"im.counters.get","/api-reference/chats/im-dialog-get":"im.dialog.get","/api-reference/chats/im-recent-get":"im.recent.get","/api-reference/chats/im-recent-list":"im.recent.list","/api-reference/chats/im-revision-get":"im.revision.get","/api-reference/chats/messages/im-dialog-messages-get":"im.dialog.messages.get","/api-reference/chats/messages/im-dialog-messages-search":"im.dialog.messages.search","/api-reference/chats/messages/im-dialog-read":"im.dialog.read","/api-reference/chats/messages/im-dialog-unread":"im.dialog.unread","/api-reference/chats/messages/im-dialog-writing":"im.dialog.writing","/api-reference/chats/messages/im-message-add":"im.message.add","/api-reference/chats/messages/im-message-command":"im.message.command","/api-reference/chats/messages/im-message-delete":"im.message.delete","/api-reference/chats/messages/im-message-like":"im.message.like","/api-reference/chats/messages/im-message-share":"im.message.share","/api-reference/chats/messages/im-message-update":"im.message.update","/api-reference/chats/notifications/im-notify-answer":"im.notify.answer","/api-reference/chats/notifications/im-notify-confirm":"im.notify.confirm","/api-reference/chats/notifications/im-notify-delete":"im.notify.delete","/api-reference/chats/notifications/im-notify-get":"im.notify.get","/api-reference/chats/notifications/im-notify-history-search":"im.notify.history.search","/api-reference/chats/notifications/im-notify-personal-add":"im.notify.personal.add","/api-reference/chats/notifications/im-notify-read-all":"im.notify.read.all","/api-reference/chats/notifications/im-notify-read-list":"im.notify.read.list","/api-reference/chats/notifications/im-notify-read":"im.notify.read","/api-reference/chats/notifications/im-notify-schema-get":"im.notify.schema.get","/api-reference/chats/notifications/im-notify-system-add":"im.notify.system.add","/api-reference/chats/notifications/im-notify":"im.notify","/api-reference/chats/outdated/create-app/imbot-app-unregister":"imbot.app.unregister","/api-reference/chats/outdated/create-app/imbot-app-update":"imbot.app.update","/api-reference/chats/search/im-search-chat-list":"im.search.chat.list","/api-reference/chats/search/im-search-department-list":"im.search.department.list","/api-reference/chats/search/im-search-last-add":"im.search.last.add","/api-reference/chats/search/im-search-last-delete":"im.search.last.delete","/api-reference/chats/search/im-search-last-get":"im.search.last.get","/api-reference/chats/search/im-search-user-list":"im.search.user.list","/api-reference/chats/special-operations/im-chat-mute":"im.chat.mute","/api-reference/chats/special-operations/im-dialog-read-all":"im.dialog.read.all","/api-reference/chats/special-operations/im-recent-hide":"im.recent.hide","/api-reference/chats/special-operations/im-recent-pin":"im.recent.pin","/api-reference/chats/special-operations/im-recent-unread":"im.recent.unread","/api-reference/chats/users/im-user-get":"im.user.get","/api-reference/chats/users/im-user-list-get":"im.user.list.get","/api-reference/chats/users/im-user-status-get":"im.user.status.get","/api-reference/chats/users/im-user-status-idle-end":"im.user.status.idle.end","/api-reference/chats/users/im-user-status-idle-start":"im.user.status.idle.start","/api-reference/chats/users/im-user-status-set":"im.user.status.set","/api-reference/common/settings/app-option-get":"app.option.get","/api-reference/common/settings/app-option-set":"app.option.set","/api-reference/common/settings/user-option-get":"user.option.get","/api-reference/common/settings/user-option-set":"user.option.set","/api-reference/common/system/access-name":"access.name","/api-reference/common/system/feature-get":"feature.get","/api-reference/common/system/method-get":"method.get","/api-reference/common/users/user-access":"user.access","/api-reference/crm/automated-solution/crm-automated-solution-add":"crm.automatedsolution.add","/api-reference/crm/automated-solution/crm-automated-solution-delete":"crm.automatedsolution.delete","/api-reference/crm/automated-solution/crm-automated-solution-get":"crm.automatedsolution.get","/api-reference/crm/automated-solution/crm-automated-solution-list":"crm.automatedsolution.list","/api-reference/crm/automated-solution/crm-automated-solution-update":"crm.automatedsolution.update","/api-reference/crm/automation/crm-automation-trigger":"crm.automation.trigger","/api-reference/crm/automation/triggers/crm-automation-trigger-add":"crm.automation.trigger.add","/api-reference/crm/automation/triggers/crm-automation-trigger-delete":"crm.automation.trigger.delete","/api-reference/crm/automation/triggers/crm-automation-trigger-execute":"crm.automation.trigger.execute","/api-reference/crm/auxiliary/enum/crm-enum-address-type":"crm.enum.addresstype","/api-reference/crm/auxiliary/enum/crm-enum-fields":"crm.enum.fields","/api-reference/crm/auxiliary/enum/crm-enum-get-order-owner-types":"crm.enum.getorderownertypes","/api-reference/crm/auxiliary/enum/crm-enum-owner-type":"crm.enum.ownertype","/api-reference/crm/auxiliary/enum/crm-enum-settings-mode":"crm.enum.settings.mode","/api-reference/crm/auxiliary/enum/outdated/crm-enum-activity-direction":"crm.enum.activitydirection","/api-reference/crm/auxiliary/enum/outdated/crm-enum-activity-notify-type":"crm.enum.activitynotifytype","/api-reference/crm/auxiliary/enum/outdated/crm-enum-activity-priority":"crm.enum.activitypriority","/api-reference/crm/auxiliary/enum/outdated/crm-enum-activity-status":"crm.enum.activitystatus","/api-reference/crm/auxiliary/enum/outdated/crm-enum-activity-type":"crm.enum.activitytype","/api-reference/crm/auxiliary/enum/outdated/crm-enum-content-type":"crm.enum.contenttype","/api-reference/crm/auxiliary/multifield/crm-multifield-fields":"crm.multifield.fields","/api-reference/crm/call-list/crm-calllist-add":"crm.calllist.add","/api-reference/crm/call-list/crm-calllist-get":"crm.calllist.get","/api-reference/crm/call-list/crm-calllist-items-get":"crm.calllist.items.get","/api-reference/crm/call-list/crm-calllist-list":"crm.calllist.list","/api-reference/crm/call-list/crm-calllist-statuslist":"crm.calllist.statuslist","/api-reference/crm/call-list/crm-calllist-update":"crm.calllist.update","/api-reference/crm/companies/contacts/crm-company-contact-add":"crm.company.contact.add","/api-reference/crm/companies/contacts/crm-company-contact-delete":"crm.company.contact.delete","/api-reference/crm/companies/contacts/crm-company-contact-fields":"crm.company.contact.fields","/api-reference/crm/companies/contacts/crm-company-contact-items-delete":"crm.company.contact.items.delete","/api-reference/crm/companies/contacts/crm-company-contact-items-get":"crm.company.contact.items.get","/api-reference/crm/companies/contacts/crm-company-contact-items-set":"crm.company.contact.items.set","/api-reference/crm/companies/crm-company-add":"crm.company.add","/api-reference/crm/companies/crm-company-delete":"crm.company.delete","/api-reference/crm/companies/crm-company-fields":"crm.company.fields","/api-reference/crm/companies/crm-company-get":"crm.company.get","/api-reference/crm/companies/crm-company-list":"crm.company.list","/api-reference/crm/companies/crm-company-update":"crm.company.update","/api-reference/crm/companies/custom-form/crm-company-details-configuration-force-common-scope-for-all":"crm.company.details.configuration.forceCommonScopeForAll","/api-reference/crm/companies/custom-form/crm-company-details-configuration-get":"crm.company.details.configuration.get","/api-reference/crm/companies/custom-form/crm-company-details-configuration-reset":"crm.company.details.configuration.reset","/api-reference/crm/companies/custom-form/crm-company-details-configuration-set":"crm.company.details.configuration.set","/api-reference/crm/companies/userfields/crm-company-userfield-add":"crm.company.userfield.add","/api-reference/crm/companies/userfields/crm-company-userfield-delete":"crm.company.userfield.delete","/api-reference/crm/companies/userfields/crm-company-userfield-get":"crm.company.userfield.get","/api-reference/crm/companies/userfields/crm-company-userfield-list":"crm.company.userfield.list","/api-reference/crm/companies/userfields/crm-company-userfield-update":"crm.company.userfield.update","/api-reference/crm/contacts/company/crm-contact-company-add":"crm.contact.company.add","/api-reference/crm/contacts/company/crm-contact-company-delete":"crm.contact.company.delete","/api-reference/crm/contacts/company/crm-contact-company-items-delete":"crm.contact.company.items.delete","/api-reference/crm/contacts/company/crm-contact-company-items-get":"crm.contact.company.items.get","/api-reference/crm/contacts/company/crm-contact-company-items-set":"crm.contact.company.items.set","/api-reference/crm/contacts/crm-contact-add":"crm.contact.add","/api-reference/crm/contacts/crm-contact-delete":"crm.contact.delete","/api-reference/crm/contacts/crm-contact-get":"crm.contact.get","/api-reference/crm/contacts/crm-contact-list":"crm.contact.list","/api-reference/crm/contacts/crm-contact-update":"crm.contact.update","/api-reference/crm/contacts/custom-form/crm-contact-details-configuration-get":"crm.contact.details.configuration.get","/api-reference/crm/contacts/custom-form/crm-contact-details-configuration-reset":"crm.contact.details.configuration.reset","/api-reference/crm/contacts/custom-form/crm-contact-details-configuration-set":"crm.contact.details.configuration.set","/api-reference/crm/contacts/userfield/crm-contact-userfield-add":"crm.contact.userfield.add","/api-reference/crm/contacts/userfield/crm-contact-userfield-delete":"crm.contact.userfield.delete","/api-reference/crm/contacts/userfield/crm-contact-userfield-get":"crm.contact.userfield.get","/api-reference/crm/contacts/userfield/crm-contact-userfield-list":"crm.contact.userfield.list","/api-reference/crm/contacts/userfield/crm-contact-userfield-update":"crm.contact.userfield.update","/api-reference/crm/crm-settings-mode-get":"crm.settings.mode.get","/api-reference/crm/crm-stage-history-list":"crm.stagehistory.list","/api-reference/crm/currency/crm-currency-add":"crm.currency.add","/api-reference/crm/currency/crm-currency-base-set":"crm.currency.base.set","/api-reference/crm/currency/crm-currency-delete":"crm.currency.delete","/api-reference/crm/currency/crm-currency-get":"crm.currency.get","/api-reference/crm/currency/crm-currency-list":"crm.currency.list","/api-reference/crm/currency/crm-currency-update":"crm.currency.update","/api-reference/crm/currency/localizations/crm-currency-localizations-delete":"crm.currency.localizations.delete","/api-reference/crm/currency/localizations/crm-currency-localizations-get":"crm.currency.localizations.get","/api-reference/crm/currency/localizations/crm-currency-localizations-set":"crm.currency.localizations.set","/api-reference/crm/deals/contacts/crm-deal-contact-add":"crm.deal.contact.add","/api-reference/crm/deals/contacts/crm-deal-contact-delete":"crm.deal.contact.delete","/api-reference/crm/deals/contacts/crm-deal-contact-fields":"crm.deal.contact.fields","/api-reference/crm/deals/contacts/crm-deal-contact-items-delete":"crm.deal.contact.items.delete","/api-reference/crm/deals/contacts/crm-deal-contact-items-get":"crm.deal.contact.items.get","/api-reference/crm/deals/contacts/crm-deal-contact-items-set":"crm.deal.contact.items.set","/api-reference/crm/deals/crm-deal-add":"crm.deal.add","/api-reference/crm/deals/crm-deal-delete":"crm.deal.delete","/api-reference/crm/deals/crm-deal-fields":"crm.deal.fields","/api-reference/crm/deals/crm-deal-get":"crm.deal.get","/api-reference/crm/deals/crm-deal-list":"crm.deal.list","/api-reference/crm/deals/crm-deal-update":"crm.deal.update","/api-reference/crm/deals/custom-form/crm-deal-details-configuration-force-common-scope-for-all":"crm.deal.details.configuration.forceCommonScopeForAll","/api-reference/crm/deals/custom-form/crm-deal-details-configuration-get":"crm.deal.details.configuration.get","/api-reference/crm/deals/custom-form/crm-deal-details-configuration-reset":"crm.deal.details.configuration.reset","/api-reference/crm/deals/custom-form/crm-deal-details-configuration-set":"crm.deal.details.configuration.set","/api-reference/crm/deals/recurring-deals/crm-deal-recurring-add":"crm.deal.recurring.add","/api-reference/crm/deals/recurring-deals/crm-deal-recurring-delete":"crm.deal.recurring.delete","/api-reference/crm/deals/recurring-deals/crm-deal-recurring-expose":"crm.deal.recurring.expose","/api-reference/crm/deals/recurring-deals/crm-deal-recurring-fields":"crm.deal.recurring.fields","/api-reference/crm/deals/recurring-deals/crm-deal-recurring-get":"crm.deal.recurring.get","/api-reference/crm/deals/recurring-deals/crm-deal-recurring-list":"crm.deal.recurring.list","/api-reference/crm/deals/recurring-deals/crm-deal-recurring-update":"crm.deal.recurring.update","/api-reference/crm/deals/user-defined-fields/crm-deal-userfield-add":"crm.deal.userfield.add","/api-reference/crm/deals/user-defined-fields/crm-deal-userfield-delete":"crm.deal.userfield.delete","/api-reference/crm/deals/user-defined-fields/crm-deal-userfield-get":"crm.deal.userfield.get","/api-reference/crm/deals/user-defined-fields/crm-deal-userfield-list":"crm.deal.userfield.list","/api-reference/crm/deals/user-defined-fields/crm-deal-userfield-update":"crm.deal.userfield.update","/api-reference/crm/document-generator/documents/crm-document-generator-document-add":"crm.documentgenerator.document.add","/api-reference/crm/document-generator/documents/crm-document-generator-document-delete":"crm.documentgenerator.document.delete","/api-reference/crm/document-generator/documents/crm-document-generator-document-enable-public-url":"crm.documentgenerator.document.enablepublicurl","/api-reference/crm/document-generator/documents/crm-document-generator-document-get-fields":"crm.documentgenerator.document.getfields","/api-reference/crm/document-generator/documents/crm-document-generator-document-get":"crm.documentgenerator.document.get","/api-reference/crm/document-generator/documents/crm-document-generator-document-list":"crm.documentgenerator.document.list","/api-reference/crm/document-generator/documents/crm-document-generator-document-update":"crm.documentgenerator.document.update","/api-reference/crm/document-generator/documents/crm-document-generator-document-upload":"crm.documentgenerator.document.upload","/api-reference/crm/document-generator/numerator/crm-document-generator-numerator-add":"crm.documentgenerator.numerator.add","/api-reference/crm/document-generator/numerator/crm-document-generator-numerator-delete":"crm.documentgenerator.numerator.delete","/api-reference/crm/document-generator/numerator/crm-document-generator-numerator-get":"crm.documentgenerator.numerator.get","/api-reference/crm/document-generator/numerator/crm-document-generator-numerator-list":"crm.documentgenerator.numerator.list","/api-reference/crm/document-generator/numerator/crm-document-generator-numerator-update":"crm.documentgenerator.numerator.update","/api-reference/crm/document-generator/templates/crm-document-generator-template-add":"crm.documentgenerator.template.add","/api-reference/crm/document-generator/templates/crm-document-generator-template-delete":"crm.documentgenerator.template.delete","/api-reference/crm/document-generator/templates/crm-document-generator-template-get-fields":"crm.documentgenerator.template.getfields","/api-reference/crm/document-generator/templates/crm-document-generator-template-get":"crm.documentgenerator.template.get","/api-reference/crm/document-generator/templates/crm-document-generator-template-list":"crm.documentgenerator.template.list","/api-reference/crm/document-generator/templates/crm-document-generator-template-update":"crm.documentgenerator.template.update","/api-reference/crm/duplicates/crm-duplicate-find-by-comm":"crm.duplicate.findbycomm","/api-reference/crm/duplicates/crm-entity-merge-batch":"crm.entity.mergeBatch","/api-reference/crm/duplicates/volatile-type/crm-duplicate-volatile-type-fields":"crm.duplicate.volatileType.fields","/api-reference/crm/duplicates/volatile-type/crm-duplicate-volatile-type-list":"crm.duplicate.volatileType.list","/api-reference/crm/duplicates/volatile-type/crm-duplicate-volatile-type-register":"crm.duplicate.volatileType.register","/api-reference/crm/duplicates/volatile-type/crm-duplicate-volatile-type-unregister":"crm.duplicate.volatileType.unregister","/api-reference/crm/leads/crm-lead-add":"crm.lead.add","/api-reference/crm/leads/crm-lead-delete":"crm.lead.delete","/api-reference/crm/leads/crm-lead-fields":"crm.lead.fields","/api-reference/crm/leads/crm-lead-get":"crm.lead.get","/api-reference/crm/leads/crm-lead-list":"crm.lead.list","/api-reference/crm/leads/crm-lead-productrows-get":"crm.lead.productrows.get","/api-reference/crm/leads/crm-lead-productrows-set":"crm.lead.productrows.set","/api-reference/crm/leads/crm-lead-update":"crm.lead.update","/api-reference/crm/leads/custom-form/crm-lead-details-configuration-force-common-scope-for-all":"crm.lead.details.configuration.forceCommonScopeForAll","/api-reference/crm/leads/custom-form/crm-lead-details-configuration-get":"crm.lead.details.configuration.get","/api-reference/crm/leads/custom-form/crm-lead-details-configuration-reset":"crm.lead.details.configuration.reset","/api-reference/crm/leads/custom-form/crm-lead-details-configuration-set":"crm.lead.details.configuration.set","/api-reference/crm/leads/management-communication/crm-lead-contact-add":"crm.lead.contact.add","/api-reference/crm/leads/management-communication/crm-lead-contact-delete":"crm.lead.contact.delete","/api-reference/crm/leads/management-communication/crm-lead-contact-items-delete":"crm.lead.contact.items.delete","/api-reference/crm/leads/management-communication/crm-lead-contact-items-get":"crm.lead.contact.items.get","/api-reference/crm/leads/management-communication/crm-lead-contact-items-set":"crm.lead.contact.items.set","/api-reference/crm/leads/userfield/crm-lead-userfield-add":"crm.lead.userfield.add","/api-reference/crm/leads/userfield/crm-lead-userfield-delete":"crm.lead.userfield.delete","/api-reference/crm/leads/userfield/crm-lead-userfield-get":"crm.lead.userfield.get","/api-reference/crm/leads/userfield/crm-lead-userfield-list":"crm.lead.userfield.list","/api-reference/crm/leads/userfield/crm-lead-userfield-update":"crm.lead.userfield.update","/api-reference/crm/outdated/catalog/crm-catalog-get":"crm.catalog.get","/api-reference/crm/outdated/category-old/crm-deal-category-add":"crm.dealcategory.add","/api-reference/crm/outdated/category-old/crm-deal-category-default-set":"crm.dealcategory.default.set","/api-reference/crm/outdated/category-old/crm-deal-category-delete":"crm.dealcategory.delete","/api-reference/crm/outdated/category-old/crm-deal-category-get":"crm.dealcategory.get","/api-reference/crm/outdated/category-old/crm-deal-category-stage-list":"crm.dealcategory.stage.list","/api-reference/crm/outdated/category-old/crm-deal-category-update":"crm.dealcategory.update","/api-reference/crm/outdated/invoice-status-old/crm-invoice-status-add":"crm.invoice.status.add","/api-reference/crm/outdated/invoice-status-old/crm-invoice-status-delete":"crm.invoice.status.delete","/api-reference/crm/outdated/invoice-status-old/crm-invoice-status-get":"crm.invoice.status.get","/api-reference/crm/outdated/invoice-status-old/crm-invoice-status-update":"crm.invoice.status.update","/api-reference/crm/outdated/invoice/crm-invoice-add":"crm.invoice.add","/api-reference/crm/outdated/invoice/crm-invoice-delete":"crm.invoice.delete","/api-reference/crm/outdated/invoice/crm-invoice-get-external-link":"crm.invoice.getexternallink","/api-reference/crm/outdated/invoice/crm-invoice-get":"crm.invoice.get","/api-reference/crm/outdated/invoice/crm-invoice-list":"crm.invoice.list","/api-reference/crm/outdated/invoice/crm-invoice-recurring-add":"crm.invoice.recurring.add","/api-reference/crm/outdated/invoice/crm-invoice-recurring-delete":"crm.invoice.recurring.delete","/api-reference/crm/outdated/invoice/crm-invoice-recurring-expose":"crm.invoice.recurring.expose","/api-reference/crm/outdated/invoice/crm-invoice-recurring-get":"crm.invoice.recurring.get","/api-reference/crm/outdated/invoice/crm-invoice-recurring-update":"crm.invoice.recurring.update","/api-reference/crm/outdated/invoice/crm-invoice-update":"crm.invoice.update","/api-reference/crm/outdated/invoice/crm-invoice-user-field-add":"crm.invoice.userfield.add","/api-reference/crm/outdated/invoice/crm-invoice-user-field-delete":"crm.invoice.userfield.delete","/api-reference/crm/outdated/invoice/crm-invoice-user-field-get":"crm.invoice.userfield.get","/api-reference/crm/outdated/invoice/crm-invoice-user-field-list":"crm.invoice.userfield.list","/api-reference/crm/outdated/invoice/crm-invoice-user-field-update":"crm.invoice.userfield.update","/api-reference/crm/outdated/measure/crm-measure-add":"crm.measure.add","/api-reference/crm/outdated/measure/crm-measure-delete":"crm.measure.delete","/api-reference/crm/outdated/measure/crm-measure-get":"crm.measure.get","/api-reference/crm/outdated/measure/crm-measure-update":"crm.measure.update","/api-reference/crm/outdated/product-section/crm-product-section-add":"crm.productsection.add","/api-reference/crm/outdated/product-section/crm-product-section-delete":"crm.productsection.delete","/api-reference/crm/outdated/product-section/crm-product-section-get":"crm.productsection.get","/api-reference/crm/outdated/product-section/crm-product-section-list":"crm.productsection.list","/api-reference/crm/outdated/product-section/crm-product-section-update":"crm.productsection.update","/api-reference/crm/outdated/products/crm-product-add":"crm.product.add","/api-reference/crm/outdated/products/crm-product-delete":"crm.product.delete","/api-reference/crm/outdated/products/crm-product-get":"crm.product.get","/api-reference/crm/outdated/products/crm-product-property-add":"crm.product.property.add","/api-reference/crm/outdated/products/crm-product-property-delete":"crm.product.property.delete","/api-reference/crm/outdated/products/crm-product-property-get":"crm.product.property.get","/api-reference/crm/outdated/products/crm-product-property-list":"crm.product.property.list","/api-reference/crm/outdated/products/crm-product-property-settings-fields":"crm.product.property.settings.fields","/api-reference/crm/outdated/products/crm-product-property-update":"crm.product.property.update","/api-reference/crm/outdated/products/crm-product-update":"crm.product.update","/api-reference/crm/outdated/vat/crm-vat-add":"crm.vat.add","/api-reference/crm/outdated/vat/crm-vat-delete":"crm.vat.delete","/api-reference/crm/outdated/vat/crm-vat-fields":"crm.vat.fields","/api-reference/crm/outdated/vat/crm-vat-get":"crm.vat.get","/api-reference/crm/outdated/vat/crm-vat-list":"crm.vat.list","/api-reference/crm/outdated/vat/crm-vat-update":"crm.vat.update","/api-reference/crm/quote/contacts/crm-quote-contact-add":"crm.quote.contact.add","/api-reference/crm/quote/contacts/crm-quote-contact-delete":"crm.quote.contact.delete","/api-reference/crm/quote/contacts/crm-quote-contact-fields":"crm.quote.contact.fields","/api-reference/crm/quote/contacts/crm-quote-contact-items-delete":"crm.quote.contact.items.delete","/api-reference/crm/quote/contacts/crm-quote-contact-items-get":"crm.quote.contact.items.get","/api-reference/crm/quote/contacts/crm-quote-contact-items-set":"crm.quote.contact.items.set","/api-reference/crm/quote/crm-quote-add":"crm.quote.add","/api-reference/crm/quote/crm-quote-delete":"crm.quote.delete","/api-reference/crm/quote/crm-quote-fields":"crm.quote.fields","/api-reference/crm/quote/crm-quote-get":"crm.quote.get","/api-reference/crm/quote/crm-quote-list":"crm.quote.list","/api-reference/crm/quote/crm-quote-product-rows-get":"crm.quote.productrows.get","/api-reference/crm/quote/crm-quote-product-rows-set":"crm.quote.productrows.set","/api-reference/crm/quote/crm-quote-update":"crm.quote.update","/api-reference/crm/quote/user-field/crm-quote-user-field-add":"crm.quote.userfield.add","/api-reference/crm/quote/user-field/crm-quote-user-field-delete":"crm.quote.userfield.delete","/api-reference/crm/quote/user-field/crm-quote-user-field-get":"crm.quote.userfield.get","/api-reference/crm/quote/user-field/crm-quote-user-field-list":"crm.quote.userfield.list","/api-reference/crm/quote/user-field/crm-quote-user-field-update":"crm.quote.userfield.update","/api-reference/crm/requisites/addresses/crm-address-add":"crm.address.add","/api-reference/crm/requisites/addresses/crm-address-delete":"crm.address.delete","/api-reference/crm/requisites/addresses/crm-address-list":"crm.address.list","/api-reference/crm/requisites/addresses/crm-address-update":"crm.address.update","/api-reference/crm/requisites/bank-detail/crm-requisite-bank-detail-add":"crm.requisite.bankdetail.add","/api-reference/crm/requisites/bank-detail/crm-requisite-bank-detail-delete":"crm.requisite.bankdetail.delete","/api-reference/crm/requisites/bank-detail/crm-requisite-bank-detail-get":"crm.requisite.bankdetail.get","/api-reference/crm/requisites/bank-detail/crm-requisite-bank-detail-list":"crm.requisite.bankdetail.list","/api-reference/crm/requisites/bank-detail/crm-requisite-bank-detail-update":"crm.requisite.bankdetail.update","/api-reference/crm/requisites/links/crm-requisite-link-get":"crm.requisite.link.get","/api-reference/crm/requisites/links/crm-requisite-link-list":"crm.requisite.link.list","/api-reference/crm/requisites/links/crm-requisite-link-register":"crm.requisite.link.register","/api-reference/crm/requisites/links/crm-requisite-link-unregister":"crm.requisite.link.unregister","/api-reference/crm/requisites/presets/crm-requisite-preset-add":"crm.requisite.preset.add","/api-reference/crm/requisites/presets/crm-requisite-preset-delete":"crm.requisite.preset.delete","/api-reference/crm/requisites/presets/crm-requisite-preset-get":"crm.requisite.preset.get","/api-reference/crm/requisites/presets/crm-requisite-preset-list":"crm.requisite.preset.list","/api-reference/crm/requisites/presets/crm-requisite-preset-update":"crm.requisite.preset.update","/api-reference/crm/requisites/presets/fields/crm-requisite-preset-field-add":"crm.requisite.preset.field.add","/api-reference/crm/requisites/presets/fields/crm-requisite-preset-field-available-to-add":"crm.requisite.preset.field.availabletoadd","/api-reference/crm/requisites/presets/fields/crm-requisite-preset-field-delete":"crm.requisite.preset.field.delete","/api-reference/crm/requisites/presets/fields/crm-requisite-preset-field-get":"crm.requisite.preset.field.get","/api-reference/crm/requisites/presets/fields/crm-requisite-preset-field-list":"crm.requisite.preset.field.list","/api-reference/crm/requisites/presets/fields/crm-requisite-preset-field-update":"crm.requisite.preset.field.update","/api-reference/crm/requisites/universal/crm-requisite-add":"crm.requisite.add","/api-reference/crm/requisites/universal/crm-requisite-delete":"crm.requisite.delete","/api-reference/crm/requisites/universal/crm-requisite-get":"crm.requisite.get","/api-reference/crm/requisites/universal/crm-requisite-list":"crm.requisite.list","/api-reference/crm/requisites/universal/crm-requisite-update":"crm.requisite.update","/api-reference/crm/requisites/user-fields/crm-requisite-userfield-add":"crm.requisite.userfield.add","/api-reference/crm/requisites/user-fields/crm-requisite-userfield-delete":"crm.requisite.userfield.delete","/api-reference/crm/requisites/user-fields/crm-requisite-userfield-get":"crm.requisite.userfield.get","/api-reference/crm/requisites/user-fields/crm-requisite-userfield-list":"crm.requisite.userfield.list","/api-reference/crm/requisites/user-fields/crm-requisite-userfield-update":"crm.requisite.userfield.update","/api-reference/crm/status/crm-status-add":"crm.status.add","/api-reference/crm/status/crm-status-delete":"crm.status.delete","/api-reference/crm/status/crm-status-entity-items":"crm.status.entity.items","/api-reference/crm/status/crm-status-entity-types":"crm.status.entity.types","/api-reference/crm/status/crm-status-fields":"crm.status.fields","/api-reference/crm/status/crm-status-get":"crm.status.get","/api-reference/crm/status/crm-status-list":"crm.status.list","/api-reference/crm/status/crm-status-update":"crm.status.update","/api-reference/crm/timeline/actions/crm-timeline-item-pin":"crm.timeline.item.pin","/api-reference/crm/timeline/actions/crm-timeline-item-unpin":"crm.timeline.item.unpin","/api-reference/crm/timeline/activities/activity-base/crm-activity-add":"crm.activity.add","/api-reference/crm/timeline/activities/activity-base/crm-activity-call-get-transcript":"crm.activity.call.getTranscript","/api-reference/crm/timeline/activities/activity-base/crm-activity-communication-fields":"crm.activity.communication.fields","/api-reference/crm/timeline/activities/activity-base/crm-activity-delete":"crm.activity.delete","/api-reference/crm/timeline/activities/activity-base/crm-activity-fields":"crm.activity.fields","/api-reference/crm/timeline/activities/activity-base/crm-activity-get":"crm.activity.get","/api-reference/crm/timeline/activities/activity-base/crm-activity-list":"crm.activity.list","/api-reference/crm/timeline/activities/activity-base/crm-activity-update":"crm.activity.update","/api-reference/crm/timeline/activities/binding/crm-activity-binding-add":"crm.activity.binding.add","/api-reference/crm/timeline/activities/binding/crm-activity-binding-delete":"crm.activity.binding.delete","/api-reference/crm/timeline/activities/binding/crm-activity-binding-list":"crm.activity.binding.list","/api-reference/crm/timeline/activities/binding/crm-activity-binding-move":"crm.activity.binding.move","/api-reference/crm/timeline/activities/configurable/badges/crm-activity-badge-add":"crm.activity.badge.add","/api-reference/crm/timeline/activities/configurable/badges/crm-activity-badge-delete":"crm.activity.badge.delete","/api-reference/crm/timeline/activities/configurable/badges/crm-activity-badge-get":"crm.activity.badge.get","/api-reference/crm/timeline/activities/configurable/badges/crm-activity-badge-list":"crm.activity.badge.list","/api-reference/crm/timeline/activities/configurable/crm-activity-configurable-add":"crm.activity.configurable.add","/api-reference/crm/timeline/activities/configurable/crm-activity-configurable-get":"crm.activity.configurable.get","/api-reference/crm/timeline/activities/configurable/crm-activity-configurable-update":"crm.activity.configurable.update","/api-reference/crm/timeline/activities/layout-blocks/crm-activity-layout-blocks-delete":"crm.activity.layout.blocks.delete","/api-reference/crm/timeline/activities/layout-blocks/crm-activity-layout-blocks-get":"crm.activity.layout.blocks.get","/api-reference/crm/timeline/activities/layout-blocks/crm-activity-layout-blocks-set":"crm.activity.layout.blocks.set","/api-reference/crm/timeline/activities/todo/crm-activity-todo-add":"crm.activity.todo.add","/api-reference/crm/timeline/activities/todo/crm-activity-todo-update-color":"crm.activity.todo.updateColor","/api-reference/crm/timeline/activities/todo/crm-activity-todo-update-deadline":"crm.activity.todo.updateDeadline","/api-reference/crm/timeline/activities/todo/crm-activity-todo-update-description":"crm.activity.todo.updateDescription","/api-reference/crm/timeline/activities/todo/crm-activity-todo-update-responsible-user":"crm.activity.todo.updateResponsibleUser","/api-reference/crm/timeline/activities/todo/crm-activity-todo-update":"crm.activity.todo.update","/api-reference/crm/timeline/activities/types/crm-activity-type-add":"crm.activity.type.add","/api-reference/crm/timeline/activities/types/crm-activity-type-delete":"crm.activity.type.delete","/api-reference/crm/timeline/activities/types/crm-activity-type-list":"crm.activity.type.list","/api-reference/crm/timeline/bindings/crm-timeline-bindings-bind":"crm.timeline.bindings.bind","/api-reference/crm/timeline/bindings/crm-timeline-bindings-list":"crm.timeline.bindings.list","/api-reference/crm/timeline/bindings/crm-timeline-bindings-unbind":"crm.timeline.bindings.unbind","/api-reference/crm/timeline/comments/crm-timeline-comment-add":"crm.timeline.comment.add","/api-reference/crm/timeline/comments/crm-timeline-comment-delete":"crm.timeline.comment.delete","/api-reference/crm/timeline/comments/crm-timeline-comment-get":"crm.timeline.comment.get","/api-reference/crm/timeline/comments/crm-timeline-comment-list":"crm.timeline.comment.list","/api-reference/crm/timeline/comments/crm-timeline-comment-update":"crm.timeline.comment.update","/api-reference/crm/timeline/layout-blocks/crm-timeline-layout-blocks-delete":"crm.timeline.layout.blocks.delete","/api-reference/crm/timeline/layout-blocks/crm-timeline-layout-blocks-get":"crm.timeline.layout.blocks.get","/api-reference/crm/timeline/layout-blocks/crm-timeline-layout-blocks-set":"crm.timeline.layout.blocks.set","/api-reference/crm/timeline/logmessage/crm-timeline-logmessage-add":"crm.timeline.logmessage.add","/api-reference/crm/timeline/logmessage/crm-timeline-logmessage-delete":"crm.timeline.logmessage.delete","/api-reference/crm/timeline/logmessage/crm-timeline-logmessage-get":"crm.timeline.logmessage.get","/api-reference/crm/timeline/logmessage/crm-timeline-logmessage-list":"crm.timeline.logmessage.list","/api-reference/crm/timeline/logmessage/icons/crm-timeline-icon-add":"crm.timeline.icon.add","/api-reference/crm/timeline/logmessage/icons/crm-timeline-icon-delete":"crm.timeline.icon.delete","/api-reference/crm/timeline/logmessage/icons/crm-timeline-icon-get":"crm.timeline.icon.get","/api-reference/crm/timeline/logmessage/logo/crm-timeline-logo-add":"crm.timeline.logo.add","/api-reference/crm/timeline/logmessage/logo/crm-timeline-logo-delete":"crm.timeline.logo.delete","/api-reference/crm/timeline/logmessage/logo/crm-timeline-logo-get":"crm.timeline.logo.get","/api-reference/crm/timeline/note/crm-timeline-note-delete":"crm.timeline.note.delete","/api-reference/crm/timeline/note/crm-timeline-note-get":"crm.timeline.note.get","/api-reference/crm/timeline/note/crm-timeline-note-save":"crm.timeline.note.save","/api-reference/crm/tracking/crm-tracking-trace-add":"crm.tracking.trace.add","/api-reference/crm/tracking/crm-tracking-trace-delete":"crm.tracking.trace.delete","/api-reference/crm/universal/category/crm-category-add":"crm.category.add","/api-reference/crm/universal/category/crm-category-delete":"crm.category.delete","/api-reference/crm/universal/category/crm-category-fields":"crm.category.fields","/api-reference/crm/universal/category/crm-category-get":"crm.category.get","/api-reference/crm/universal/category/crm-category-list":"crm.category.list","/api-reference/crm/universal/category/crm-category-update":"crm.category.update","/api-reference/crm/universal/crm-item-add":"crm.item.add","/api-reference/crm/universal/crm-item-delete":"crm.item.delete","/api-reference/crm/universal/crm-item-fields":"crm.item.fields","/api-reference/crm/universal/crm-item-get":"crm.item.get","/api-reference/crm/universal/crm-item-list":"crm.item.list","/api-reference/crm/universal/crm-item-update":"crm.item.update","/api-reference/crm/universal/delivery/crm-item-delivery-get":"crm.item.delivery.get","/api-reference/crm/universal/delivery/crm-item-delivery-list":"crm.item.delivery.list","/api-reference/crm/universal/import/crm-item-batch-import":"crm.item.batchImport","/api-reference/crm/universal/import/crm-item-import":"crm.item.import","/api-reference/crm/universal/item-details-configuration/crm-item-details-configuration-forceCommonScopeForAll":"crm.item.details.configuration.forceCommonScopeForAll","/api-reference/crm/universal/item-details-configuration/crm-item-details-configuration-get":"crm.item.details.configuration.get","/api-reference/crm/universal/item-details-configuration/crm-item-details-configuration-reset":"crm.item.details.configuration.reset","/api-reference/crm/universal/item-details-configuration/crm-item-details-configuration-set":"crm.item.details.configuration.set","/api-reference/crm/universal/order-entity/crm-order-entity-add":"crm.orderentity.add","/api-reference/crm/universal/order-entity/crm-order-entity-delete-by-filter":"crm.orderentity.deleteByFilter","/api-reference/crm/universal/order-entity/crm-order-entity-list":"crm.orderentity.list","/api-reference/crm/universal/payment/crm-item-payment-add":"crm.item.payment.add","/api-reference/crm/universal/payment/crm-item-payment-delete":"crm.item.payment.delete","/api-reference/crm/universal/payment/crm-item-payment-get":"crm.item.payment.get","/api-reference/crm/universal/payment/crm-item-payment-list":"crm.item.payment.list","/api-reference/crm/universal/payment/crm-item-payment-pay":"crm.item.payment.pay","/api-reference/crm/universal/payment/crm-item-payment-unpay":"crm.item.payment.unpay","/api-reference/crm/universal/payment/crm-item-payment-update":"crm.item.payment.update","/api-reference/crm/universal/payment/delivery-in-payment/crm-item-payment-delivery-add":"crm.item.payment.delivery.add","/api-reference/crm/universal/payment/delivery-in-payment/crm-item-payment-delivery-delete":"crm.item.payment.delivery.delete","/api-reference/crm/universal/payment/delivery-in-payment/crm-item-payment-delivery-list":"crm.item.payment.delivery.list","/api-reference/crm/universal/payment/delivery-in-payment/crm-item-payment-delivery-set-delivery":"crm.item.payment.delivery.setDelivery","/api-reference/crm/universal/payment/products-in-payment/crm-item-payment-product-add":"crm.item.payment.product.add","/api-reference/crm/universal/payment/products-in-payment/crm-item-payment-product-delete":"crm.item.payment.product.delete","/api-reference/crm/universal/payment/products-in-payment/crm-item-payment-product-list":"crm.item.payment.product.list","/api-reference/crm/universal/payment/products-in-payment/crm-item-payment-product-set-quantity":"crm.item.payment.product.setQuantity","/api-reference/crm/universal/payment/salescenter-payment-get-public-url":"salescenter.payment.getPublicUrl","/api-reference/crm/universal/product-rows/crm-item-productrow-add":"crm.item.productrow.add","/api-reference/crm/universal/product-rows/crm-item-productrow-delete":"crm.item.productrow.delete","/api-reference/crm/universal/product-rows/crm-item-productrow-get-available-for-payment":"crm.item.productrow.getAvailableForPayment","/api-reference/crm/universal/product-rows/crm-item-productrow-get":"crm.item.productrow.get","/api-reference/crm/universal/product-rows/crm-item-productrow-list":"crm.item.productrow.list","/api-reference/crm/universal/product-rows/crm-item-productrow-set":"crm.item.productrow.set","/api-reference/crm/universal/product-rows/crm-item-productrow-update":"crm.item.productrow.update","/api-reference/crm/universal/user-defined-fields/crm-userfield-enumeration-fields":"crm.userfield.enumeration.fields","/api-reference/crm/universal/user-defined-fields/crm-userfield-fields":"crm.userfield.fields","/api-reference/crm/universal/user-defined-fields/crm-userfield-settings-fields":"crm.userfield.settings.fields","/api-reference/crm/universal/user-defined-fields/crm-userfield-types":"crm.userfield.types","/api-reference/crm/universal/user-defined-object-types/crm-type-add":"crm.type.add","/api-reference/crm/universal/user-defined-object-types/crm-type-delete":"crm.type.delete","/api-reference/crm/universal/user-defined-object-types/crm-type-get-by-entity-type-id":"crm.type.getByEntityTypeId","/api-reference/crm/universal/user-defined-object-types/crm-type-get":"crm.type.get","/api-reference/crm/universal/user-defined-object-types/crm-type-list":"crm.type.list","/api-reference/crm/universal/user-defined-object-types/crm-type-update":"crm.type.update","/api-reference/crm/universal/userfieldconfig/userfieldconfig-add":"userfieldconfig.add","/api-reference/crm/universal/userfieldconfig/userfieldconfig-delete":"userfieldconfig.delete","/api-reference/crm/universal/userfieldconfig/userfieldconfig-get-types":"userfieldconfig.getTypes","/api-reference/crm/universal/userfieldconfig/userfieldconfig-get":"userfieldconfig.get","/api-reference/crm/universal/userfieldconfig/userfieldconfig-list":"userfieldconfig.list","/api-reference/crm/universal/userfieldconfig/userfieldconfig-update":"userfieldconfig.update","/api-reference/departments/department-add":"department.add","/api-reference/departments/department-delete":"department.delete","/api-reference/departments/department-get":"department.get","/api-reference/departments/department-update":"department.update","/api-reference/departments/employee/humanresources-employee-count":"humanresources.employee.count","/api-reference/departments/employee/humanresources-employee-field-get":"humanresources.employee.field.get","/api-reference/departments/employee/humanresources-employee-field-list":"humanresources.employee.field.list","/api-reference/departments/employee/humanresources-employee-multidepartment":"humanresources.employee.multidepartment","/api-reference/departments/employee/humanresources-employee-search":"humanresources.employee.search","/api-reference/departments/employee/humanresources-employee-subordinates":"humanresources.employee.subordinates","/api-reference/departments/node-communication/humanresources-node-communication-edit":"humanresources.node.communication.edit","/api-reference/departments/node-communication/humanresources-node-communication-list":"humanresources.node.communication.list","/api-reference/departments/node-member/humanresources-node-member-add":"humanresources.node.member.add","/api-reference/departments/node-member/humanresources-node-member-field-get":"humanresources.node.member.field.get","/api-reference/departments/node-member/humanresources-node-member-field-list":"humanresources.node.member.field.list","/api-reference/departments/node-member/humanresources-node-member-move":"humanresources.node.member.move","/api-reference/departments/node-member/humanresources-node-member-remove":"humanresources.node.member.remove","/api-reference/departments/node-member/humanresources-node-member-set":"humanresources.node.member.set","/api-reference/departments/node/humanresources-node-add":"humanresources.node.add","/api-reference/departments/node/humanresources-node-children":"humanresources.node.children","/api-reference/departments/node/humanresources-node-count":"humanresources.node.count","/api-reference/departments/node/humanresources-node-edit":"humanresources.node.edit","/api-reference/departments/node/humanresources-node-field-get":"humanresources.node.field.get","/api-reference/departments/node/humanresources-node-field-list":"humanresources.node.field.list","/api-reference/departments/node/humanresources-node-get":"humanresources.node.get","/api-reference/departments/node/humanresources-node-list":"humanresources.node.list","/api-reference/departments/node/humanresources-node-move":"humanresources.node.move","/api-reference/departments/node/humanresources-node-search":"humanresources.node.search","/api-reference/disk/attached-object/disk-attached-object-get":"disk.attachedObject.get","/api-reference/disk/file/disk-file-copy-to":"disk.file.copyTo","/api-reference/disk/file/disk-file-delete":"disk.file.delete","/api-reference/disk/file/disk-file-get-external-link":"disk.file.getExternalLink","/api-reference/disk/file/disk-file-get-fields":"disk.file.getFields","/api-reference/disk/file/disk-file-get-versions":"disk.file.getVersions","/api-reference/disk/file/disk-file-get":"disk.file.get","/api-reference/disk/file/disk-file-mark-deleted":"disk.file.markDeleted","/api-reference/disk/file/disk-file-move-to":"disk.file.moveTo","/api-reference/disk/file/disk-file-rename":"disk.file.rename","/api-reference/disk/file/disk-file-restore-from-version":"disk.file.restoreFromVersion","/api-reference/disk/file/disk-file-restore":"disk.file.restore","/api-reference/disk/file/disk-file-search":"disk.file.search","/api-reference/disk/file/disk-file-upload-version":"disk.file.uploadVersion","/api-reference/disk/folder/disk-folder-add-subfolder":"disk.folder.addSubFolder","/api-reference/disk/folder/disk-folder-copy-to":"disk.folder.copyTo","/api-reference/disk/folder/disk-folder-delete-tree":"disk.folder.deleteTree","/api-reference/disk/folder/disk-folder-get-children":"disk.folder.getChildren","/api-reference/disk/folder/disk-folder-get-external-link":"disk.folder.getExternalLink","/api-reference/disk/folder/disk-folder-get-fields":"disk.folder.getFields","/api-reference/disk/folder/disk-folder-get":"disk.folder.get","/api-reference/disk/folder/disk-folder-mark-deleted":"disk.folder.markDeleted","/api-reference/disk/folder/disk-folder-move-to":"disk.folder.moveTo","/api-reference/disk/folder/disk-folder-rename":"disk.folder.rename","/api-reference/disk/folder/disk-folder-restore":"disk.folder.restore","/api-reference/disk/folder/disk-folder-share-to-user":"disk.folder.shareToUser","/api-reference/disk/folder/disk-folder-upload-file":"disk.folder.uploadFile","/api-reference/disk/rights/disk-rights-get-tasks":"disk.rights.getTasks","/api-reference/disk/storage/disk-storage-add-folder":"disk.storage.addFolder","/api-reference/disk/storage/disk-storage-get-children":"disk.storage.getChildren","/api-reference/disk/storage/disk-storage-get-fields":"disk.storage.getFields","/api-reference/disk/storage/disk-storage-get-for-app":"disk.storage.getForApp","/api-reference/disk/storage/disk-storage-get-list":"disk.storage.getList","/api-reference/disk/storage/disk-storage-get-types":"disk.storage.getTypes","/api-reference/disk/storage/disk-storage-get":"disk.storage.get","/api-reference/disk/storage/disk-storage-rename":"disk.storage.rename","/api-reference/disk/storage/disk-storage-upload-file":"disk.storage.uploadFile","/api-reference/disk/version/disk-version-get":"disk.version.get","/api-reference/document-generator/document-generator-document-add":"documentgenerator.document.add","/api-reference/document-generator/document-generator-document-delete":"documentgenerator.document.delete","/api-reference/document-generator/document-generator-document-enable-public-url":"documentgenerator.document.enablepublicurl","/api-reference/document-generator/document-generator-document-get-fields":"documentgenerator.document.getfields","/api-reference/document-generator/document-generator-document-get":"documentgenerator.document.get","/api-reference/document-generator/document-generator-document-list":"documentgenerator.document.list","/api-reference/document-generator/document-generator-document-update":"documentgenerator.document.update","/api-reference/document-generator/numerators/document-generator-numerator-add":"documentgenerator.numerator.add","/api-reference/document-generator/numerators/document-generator-numerator-delete":"documentgenerator.numerator.delete","/api-reference/document-generator/numerators/document-generator-numerator-get":"documentgenerator.numerator.get","/api-reference/document-generator/numerators/document-generator-numerator-list":"documentgenerator.numerator.list","/api-reference/document-generator/numerators/document-generator-numerator-update":"documentgenerator.numerator.update","/api-reference/document-generator/region/document-generator-region-add":"documentgenerator.region.add","/api-reference/document-generator/region/document-generator-region-delete":"documentgenerator.region.delete","/api-reference/document-generator/region/document-generator-region-get":"documentgenerator.region.get","/api-reference/document-generator/region/document-generator-region-list":"documentgenerator.region.list","/api-reference/document-generator/region/document-generator-region-update":"documentgenerator.region.update","/api-reference/document-generator/role/document-generator-role-add":"documentgenerator.role.add","/api-reference/document-generator/role/document-generator-role-delete":"documentgenerator.role.delete","/api-reference/document-generator/role/document-generator-role-fill-accesses":"documentgenerator.role.fillaccesses","/api-reference/document-generator/role/document-generator-role-get":"documentgenerator.role.get","/api-reference/document-generator/role/document-generator-role-list":"documentgenerator.role.list","/api-reference/document-generator/role/document-generator-role-update":"documentgenerator.role.update","/api-reference/document-generator/templates/document-generator-template-add":"documentgenerator.template.add","/api-reference/document-generator/templates/document-generator-template-delete":"documentgenerator.template.delete","/api-reference/document-generator/templates/document-generator-template-get-fields":"documentgenerator.template.getfields","/api-reference/document-generator/templates/document-generator-template-get":"documentgenerator.template.get","/api-reference/document-generator/templates/document-generator-template-list":"documentgenerator.template.list","/api-reference/document-generator/templates/document-generator-template-update":"documentgenerator.template.update","/api-reference/entity/entities/entity-add":"entity.add","/api-reference/entity/entities/entity-delete":"entity.delete","/api-reference/entity/entities/entity-get":"entity.get","/api-reference/entity/entities/entity-rights":"entity.rights","/api-reference/entity/entities/entity-update":"entity.update","/api-reference/entity/items/entity-item-add":"entity.item.add","/api-reference/entity/items/entity-item-delete":"entity.item.delete","/api-reference/entity/items/entity-item-get":"entity.item.get","/api-reference/entity/items/entity-item-update":"entity.item.update","/api-reference/entity/items/properties/entity-item-property-add":"entity.item.property.add","/api-reference/entity/items/properties/entity-item-property-delete":"entity.item.property.delete","/api-reference/entity/items/properties/entity-item-property-get":"entity.item.property.get","/api-reference/entity/items/properties/entity-item-property-update":"entity.item.property.update","/api-reference/entity/sections/entity-section-add":"entity.section.add","/api-reference/entity/sections/entity-section-delete":"entity.section.delete","/api-reference/entity/sections/entity-section-get":"entity.section.get","/api-reference/entity/sections/entity-section-update":"entity.section.update","/api-reference/event-log/main-eventlog-field-get":"main.eventlog.field.get","/api-reference/event-log/main-eventlog-field-list":"main.eventlog.field.list","/api-reference/event-log/main-eventlog-get":"main.eventlog.get","/api-reference/event-log/main-eventlog-list":"main.eventlog.list","/api-reference/event-log/main-eventlog-tail":"main.eventlog.tail","/api-reference/events/event-bind":"event.bind","/api-reference/events/event-offline-clear":"event.offline.clear","/api-reference/events/event-offline-error":"event.offline.error","/api-reference/events/event-offline-get":"event.offline.get","/api-reference/events/event-offline-list":"event.offline.list","/api-reference/events/event-unbind":"event.unbind","/api-reference/imopenlines/imconnector/imconnector-activate":"imconnector.activate","/api-reference/imopenlines/imconnector/imconnector-chat-name-set":"imconnector.chat.name.set","/api-reference/imopenlines/imconnector/imconnector-connector-data-set":"imconnector.connector.data.set","/api-reference/imopenlines/imconnector/imconnector-delete-messages":"imconnector.delete.messages","/api-reference/imopenlines/imconnector/imconnector-list":"imconnector.list","/api-reference/imopenlines/imconnector/imconnector-register":"imconnector.register","/api-reference/imopenlines/imconnector/imconnector-send-messages":"imconnector.send.messages","/api-reference/imopenlines/imconnector/imconnector-send-status-delivery":"imconnector.send.status.delivery","/api-reference/imopenlines/imconnector/imconnector-send-status-reading":"imconnector.send.status.reading","/api-reference/imopenlines/imconnector/imconnector-status":"imconnector.status","/api-reference/imopenlines/imconnector/imconnector-unregister":"imconnector.unregister","/api-reference/imopenlines/imconnector/imconnector-update-messages":"imconnector.update.messages","/api-reference/imopenlines/openlines/chat-bots/imopenlines-bot-session-finish":"imopenlines.bot.session.finish","/api-reference/imopenlines/openlines/chat-bots/imopenlines-bot-session-message-send":"imopenlines.bot.session.message.send","/api-reference/imopenlines/openlines/chat-bots/imopenlines-bot-session-operator":"imopenlines.bot.session.operator","/api-reference/imopenlines/openlines/chat-bots/imopenlines-bot-session-transfer":"imopenlines.bot.session.transfer","/api-reference/imopenlines/openlines/chats/imopenlines-crm-chat-get-last-id":"imopenlines.crm.chat.getLastId","/api-reference/imopenlines/openlines/chats/imopenlines-crm-chat-get":"imopenlines.crm.chat.get","/api-reference/imopenlines/openlines/chats/imopenlines-crm-chat-user-add":"imopenlines.crm.chat.user.add","/api-reference/imopenlines/openlines/chats/imopenlines-crm-chat-user-delete":"imopenlines.crm.chat.user.delete","/api-reference/imopenlines/openlines/imopenlines-config-add":"imopenlines.config.add","/api-reference/imopenlines/openlines/imopenlines-config-delete":"imopenlines.config.delete","/api-reference/imopenlines/openlines/imopenlines-config-get":"imopenlines.config.get","/api-reference/imopenlines/openlines/imopenlines-config-list-get":"imopenlines.config.list.get","/api-reference/imopenlines/openlines/imopenlines-config-path-get":"imopenlines.config.path.get","/api-reference/imopenlines/openlines/imopenlines-config-update":"imopenlines.config.update","/api-reference/imopenlines/openlines/imopenlines-network-join":"imopenlines.network.join","/api-reference/imopenlines/openlines/imopenlines-network-message-add":"imopenlines.network.message.add","/api-reference/imopenlines/openlines/imopenlines-revision-get":"imopenlines.revision.get","/api-reference/imopenlines/openlines/messages/imopenlines-crm-message-add":"imopenlines.crm.message.add","/api-reference/imopenlines/openlines/messages/imopenlines-message-quick-save":"imopenlines.message.quick.save","/api-reference/imopenlines/openlines/operators/imopenlines-operator-another-finish":"imopenlines.operator.another.finish","/api-reference/imopenlines/openlines/operators/imopenlines-operator-answer":"imopenlines.operator.answer","/api-reference/imopenlines/openlines/operators/imopenlines-operator-finish":"imopenlines.operator.finish","/api-reference/imopenlines/openlines/operators/imopenlines-operator-skip":"imopenlines.operator.skip","/api-reference/imopenlines/openlines/operators/imopenlines-operator-spam":"imopenlines.operator.spam","/api-reference/imopenlines/openlines/operators/imopenlines-operator-transfer":"imopenlines.operator.transfer","/api-reference/imopenlines/openlines/sessions/imopenlines-crm-lead-create":"imopenlines.crm.lead.create","/api-reference/imopenlines/openlines/sessions/imopenlines-dialog-get":"imopenlines.dialog.get","/api-reference/imopenlines/openlines/sessions/imopenlines-message-session-start":"imopenlines.message.session.start","/api-reference/imopenlines/openlines/sessions/imopenlines-session-head-vote":"imopenlines.session.head.vote","/api-reference/imopenlines/openlines/sessions/imopenlines-session-history-get":"imopenlines.session.history.get","/api-reference/imopenlines/openlines/sessions/imopenlines-session-intercept":"imopenlines.session.intercept","/api-reference/imopenlines/openlines/sessions/imopenlines-session-join":"imopenlines.session.join","/api-reference/imopenlines/openlines/sessions/imopenlines-session-mode-pin-all":"imopenlines.session.mode.pinAll","/api-reference/imopenlines/openlines/sessions/imopenlines-session-mode-pin":"imopenlines.session.mode.pin","/api-reference/imopenlines/openlines/sessions/imopenlines-session-mode-silent":"imopenlines.session.mode.silent","/api-reference/imopenlines/openlines/sessions/imopenlines-session-mode-unpin-all":"imopenlines.session.mode.unpinAll","/api-reference/imopenlines/openlines/sessions/imopenlines-session-open":"imopenlines.session.open","/api-reference/imopenlines/openlines/sessions/imopenlines-session-start":"imopenlines.session.start","/api-reference/imopenlines/statistics/imopenlines-v2-operator-list":"imopenlines.v2.Operator.list","/api-reference/imopenlines/statistics/imopenlines-v2-session-list":"imopenlines.v2.Session.list","/api-reference/imopenlines/statistics/imopenlines-v2-session-rating-list":"imopenlines.v2.Session.Rating.list","/api-reference/imopenlines/statistics/imopenlines-v2-session-stat-get":"imopenlines.v2.Session.Stat.get","/api-reference/imopenlines/statistics/imopenlines-v2-session-transfer-list":"imopenlines.v2.Session.Transfer.list","/api-reference/imopenlines/statistics/imopenlines-v2-stat-get":"imopenlines.v2.Stat.get","/api-reference/landing/block/methods/landing-block-add-card":"landing.block.addcard","/api-reference/landing/block/methods/landing-block-change-anchor":"landing.block.changeAnchor","/api-reference/landing/block/methods/landing-block-change-node-name":"landing.block.changeNodeName","/api-reference/landing/block/methods/landing-block-clone-card":"landing.block.clonecard","/api-reference/landing/block/methods/landing-block-get-by-id":"landing.block.getbyid","/api-reference/landing/block/methods/landing-block-get-content-from-repository":"landing.block.getContentFromRepository","/api-reference/landing/block/methods/landing-block-get-content":"landing.block.getcontent","/api-reference/landing/block/methods/landing-block-get-list":"landing.block.getlist","/api-reference/landing/block/methods/landing-block-get-manifest-file":"landing.block.getmanifestfile","/api-reference/landing/block/methods/landing-block-get-manifest":"landing.block.getmanifest","/api-reference/landing/block/methods/landing-block-get-repository":"landing.block.getrepository","/api-reference/landing/block/methods/landing-block-remove-card":"landing.block.removecard","/api-reference/landing/block/methods/landing-block-update-attrs":"landing.block.updateattrs","/api-reference/landing/block/methods/landing-block-update-cards":"landing.block.updateCards","/api-reference/landing/block/methods/landing-block-update-content":"landing.block.updatecontent","/api-reference/landing/block/methods/landing-block-update-nodes":"landing.block.updatenodes","/api-reference/landing/block/methods/landing-block-update-styles":"landing.block.updateStyles","/api-reference/landing/block/methods/landing-block-upload-file":"landing.block.uploadfile","/api-reference/landing/demos/landing-demos-get-list":"landing.demos.getList","/api-reference/landing/demos/landing-demos-get-page-list":"landing.demos.getPageList","/api-reference/landing/demos/landing-demos-get-site-list":"landing.demos.getSiteList","/api-reference/landing/demos/landing-demos-register":"landing.demos.register","/api-reference/landing/demos/landing-demos-unregister":"landing.demos.unregister","/api-reference/landing/embedding/knowledge-base/landing-site-binding-to-group":"landing.site.bindingToGroup","/api-reference/landing/embedding/knowledge-base/landing-site-binding-to-menu":"landing.site.bindingToMenu","/api-reference/landing/embedding/knowledge-base/landing-site-get-group-bindings":"landing.site.getGroupBindings","/api-reference/landing/embedding/knowledge-base/landing-site-get-menu-bindings":"landing.site.getMenuBindings","/api-reference/landing/embedding/knowledge-base/landing-site-unbinding-from-group":"landing.site.unbindingFromGroup","/api-reference/landing/embedding/knowledge-base/landing-site-unbinding-from-menu":"landing.site.unbindingFromMenu","/api-reference/landing/embedding/landing-repo-unbind":"landing.repo.unbind","/api-reference/landing/page/block-methods/landing-landing-add-block":"landing.landing.addblock","/api-reference/landing/page/block-methods/landing-landing-copy-block":"landing.landing.copyblock","/api-reference/landing/page/block-methods/landing-landing-delete-block":"landing.landing.deleteblock","/api-reference/landing/page/block-methods/landing-landing-down-block":"landing.landing.downblock","/api-reference/landing/page/block-methods/landing-landing-favorite-block":"landing.landing.favoriteBlock","/api-reference/landing/page/block-methods/landing-landing-hide-block":"landing.landing.hideblock","/api-reference/landing/page/block-methods/landing-landing-mark-deleted-block":"landing.landing.markdeletedblock","/api-reference/landing/page/block-methods/landing-landing-mark-undeleted-block":"landing.landing.markundeletedblock","/api-reference/landing/page/block-methods/landing-landing-move-block":"landing.landing.moveblock","/api-reference/landing/page/block-methods/landing-landing-show-block":"landing.landing.showblock","/api-reference/landing/page/block-methods/landing-landing-unfavorite-block":"landing.landing.unFavoriteBlock","/api-reference/landing/page/block-methods/landing-landing-up-block":"landing.landing.upblock","/api-reference/landing/page/methods/landing-landing-add-by-template":"landing.landing.addByTemplate","/api-reference/landing/page/methods/landing-landing-add":"landing.landing.add","/api-reference/landing/page/methods/landing-landing-copy":"landing.landing.copy","/api-reference/landing/page/methods/landing-landing-delete":"landing.landing.delete","/api-reference/landing/page/methods/landing-landing-get-additional-fields":"landing.landing.getadditionalfields","/api-reference/landing/page/methods/landing-landing-get-list":"landing.landing.getList","/api-reference/landing/page/methods/landing-landing-get-preview":"landing.landing.getpreview","/api-reference/landing/page/methods/landing-landing-get-public-url":"landing.landing.getpublicurl","/api-reference/landing/page/methods/landing-landing-mark-delete":"landing.landing.markDelete","/api-reference/landing/page/methods/landing-landing-mark-undelete":"landing.landing.markUnDelete","/api-reference/landing/page/methods/landing-landing-move":"landing.landing.move","/api-reference/landing/page/methods/landing-landing-publication":"landing.landing.publication","/api-reference/landing/page/methods/landing-landing-remove-entities":"landing.landing.removeEntities","/api-reference/landing/page/methods/landing-landing-resolve-id-by-public-url":"landing.landing.resolveIdByPublicUrl","/api-reference/landing/page/methods/landing-landing-unpublic":"landing.landing.unpublic","/api-reference/landing/page/methods/landing-landing-update":"landing.landing.update","/api-reference/landing/page/special-pages/landing-syspage-delete-for-landing":"landing.syspage.deleteForLanding","/api-reference/landing/page/special-pages/landing-syspage-delete-for-site":"landing.syspage.deleteForSite","/api-reference/landing/page/special-pages/landing-syspage-get-special-page":"landing.syspage.getSpecialPage","/api-reference/landing/page/special-pages/landing-syspage-get":"landing.syspage.get","/api-reference/landing/page/special-pages/landing-syspage-set":"landing.syspage.set","/api-reference/landing/rights/extended-model/landing-site-get-rights":"landing.site.getRights","/api-reference/landing/rights/extended-model/landing-site-set-rights":"landing.site.setRights","/api-reference/landing/rights/landing-role-enable":"landing.role.enable","/api-reference/landing/rights/landing-role-is-enabled":"landing.role.isEnabled","/api-reference/landing/rights/role-model/landing-role-get-list":"landing.role.getList","/api-reference/landing/rights/role-model/landing-role-get-rights":"landing.role.getRights","/api-reference/landing/rights/role-model/landing-role-set-access-codes":"landing.role.setAccessCodes","/api-reference/landing/rights/role-model/landing-role-set-rights":"landing.role.setRights","/api-reference/landing/site/landing-site-add-folder":"landing.site.addFolder","/api-reference/landing/site/landing-site-add":"landing.site.add","/api-reference/landing/site/landing-site-delete":"landing.site.delete","/api-reference/landing/site/landing-site-full-export":"landing.site.fullExport","/api-reference/landing/site/landing-site-get-additional-fields":"landing.site.getadditionalfields","/api-reference/landing/site/landing-site-get-folders":"landing.site.getFolders","/api-reference/landing/site/landing-site-get-list":"landing.site.getList","/api-reference/landing/site/landing-site-get-preview":"landing.site.getPreview","/api-reference/landing/site/landing-site-get-public-url":"landing.site.getPublicUrl","/api-reference/landing/site/landing-site-mark-delete":"landing.site.markDelete","/api-reference/landing/site/landing-site-mark-folder-delete":"landing.site.markFolderDelete","/api-reference/landing/site/landing-site-mark-folder-undelete":"landing.site.markFolderUnDelete","/api-reference/landing/site/landing-site-mark-undelete":"landing.site.markUnDelete","/api-reference/landing/site/landing-site-publication-folder":"landing.site.publicationFolder","/api-reference/landing/site/landing-site-publication":"landing.site.publication","/api-reference/landing/site/landing-site-unpublic-folder":"landing.site.unPublicFolder","/api-reference/landing/site/landing-site-unpublic":"landing.site.unpublic","/api-reference/landing/site/landing-site-update-folder":"landing.site.updateFolder","/api-reference/landing/site/landing-site-update":"landing.site.update","/api-reference/landing/template/landing-template-get-landing-ref":"landing.template.getLandingRef","/api-reference/landing/template/landing-template-get-list":"landing.template.getlist","/api-reference/landing/template/landing-template-get-site-ref":"landing.template.getSiteRef","/api-reference/landing/template/landing-template-set-landing-ref":"landing.template.setLandingRef","/api-reference/landing/template/landing-template-set-site-ref":"landing.template.setSiteRef","/api-reference/landing/user-blocks/landing-repo-check-content":"landing.repo.checkContent","/api-reference/landing/user-blocks/landing-repo-get-list":"landing.repo.getList","/api-reference/landing/user-blocks/landing-repo-register":"landing.repo.register","/api-reference/landing/user-blocks/landing-repo-unregister":"landing.repo.unregister","/api-reference/lists/elements/lists-element-add":"lists.element.add","/api-reference/lists/elements/lists-element-delete":"lists.element.delete","/api-reference/lists/elements/lists-element-get-file-url":"lists.element.get.file.url","/api-reference/lists/elements/lists-element-get":"lists.element.get","/api-reference/lists/elements/lists-element-update":"lists.element.update","/api-reference/lists/fields/lists-field-add":"lists.field.add","/api-reference/lists/fields/lists-field-delete":"lists.field.delete","/api-reference/lists/fields/lists-field-get":"lists.field.get","/api-reference/lists/fields/lists-field-type-get":"lists.field.type.get","/api-reference/lists/fields/lists-field-update":"lists.field.update","/api-reference/lists/lists/lists-add":"lists.add","/api-reference/lists/lists/lists-delete":"lists.delete","/api-reference/lists/lists/lists-get-iblock-type-id":"lists.get.iblock.type.id","/api-reference/lists/lists/lists-get":"lists.get","/api-reference/lists/lists/lists-update":"lists.update","/api-reference/lists/sections/lists-section-add":"lists.section.add","/api-reference/lists/sections/lists-section-delete":"lists.section.delete","/api-reference/lists/sections/lists-section-get":"lists.section.get","/api-reference/lists/sections/lists-section-update":"lists.section.update","/api-reference/log/blogcomment/log-blogcomment-add":"log.blogcomment.add","/api-reference/log/blogcomment/log-blogcomment-delete":"log.blogcomment.delete","/api-reference/log/blogcomment/log-blogcomment-user-get":"log.blogcomment.user.get","/api-reference/log/log-blogpost-add":"log.blogpost.add","/api-reference/log/log-blogpost-delete":"log.blogpost.delete","/api-reference/log/log-blogpost-get":"log.blogpost.get","/api-reference/log/log-blogpost-getusers-important":"log.blogpost.getusers.important","/api-reference/log/log-blogpost-share":"log.blogpost.share","/api-reference/log/log-blogpost-update":"log.blogpost.update","/api-reference/mail/mailbox/mail-mailbox-field-get":"mail.mailbox.field.get","/api-reference/mail/mailbox/mail-mailbox-field-list":"mail.mailbox.field.list","/api-reference/mail/mailbox/mail-mailbox-get":"mail.mailbox.get","/api-reference/mail/mailbox/mail-mailbox-list":"mail.mailbox.list","/api-reference/mail/mailbox/mail-mailbox-senders":"mail.mailbox.senders","/api-reference/mail/message/mail-message-createcalendarevent":"mail.message.createcalendarevent","/api-reference/mail/message/mail-message-createchat":"mail.message.createchat","/api-reference/mail/message/mail-message-createcrmactivity":"mail.message.createcrmactivity","/api-reference/mail/message/mail-message-createfeedpost":"mail.message.createfeedpost","/api-reference/mail/message/mail-message-createtask":"mail.message.createtask","/api-reference/mail/message/mail-message-field-get":"mail.message.field.get","/api-reference/mail/message/mail-message-field-list":"mail.message.field.list","/api-reference/mail/message/mail-message-forward":"mail.message.forward","/api-reference/mail/message/mail-message-get":"mail.message.get","/api-reference/mail/message/mail-message-list":"mail.message.list","/api-reference/mail/message/mail-message-movetofolder":"mail.message.movetofolder","/api-reference/mail/message/mail-message-removecrmactivity":"mail.message.removecrmactivity","/api-reference/mail/message/mail-message-reply":"mail.message.reply","/api-reference/mail/message/mail-message-send":"mail.message.send","/api-reference/mail/message/mail-message-thread":"mail.message.thread","/api-reference/mail/recipient/mail-recipient-field-get":"mail.recipient.field.get","/api-reference/mail/recipient/mail-recipient-field-list":"mail.recipient.field.list","/api-reference/mail/recipient/mail-recipient-listcontacts":"mail.recipient.listcontacts","/api-reference/mail/recipient/mail-recipient-listemployees":"mail.recipient.listemployees","/api-reference/mailservice/mailservice-add":"mailservice.add","/api-reference/mailservice/mailservice-delete":"mailservice.delete","/api-reference/mailservice/mailservice-fields":"mailservice.fields","/api-reference/mailservice/mailservice-get":"mailservice.get","/api-reference/mailservice/mailservice-list":"mailservice.list","/api-reference/mailservice/mailservice-update":"mailservice.update","/api-reference/messageservice/messageservice-message-status-update":"messageservice.message.status.update","/api-reference/messageservice/messageservice-sender-add":"messageservice.sender.add","/api-reference/messageservice/messageservice-sender-delete":"messageservice.sender.delete","/api-reference/messageservice/messageservice-sender-list":"messageservice.sender.list","/api-reference/messageservice/messageservice-sender-update":"messageservice.sender.update","/api-reference/note/collection/note-collection-add":"note.collection.add","/api-reference/note/collection/note-collection-archive":"note.collection.archive","/api-reference/note/collection/note-collection-delete":"note.collection.delete","/api-reference/note/collection/note-collection-field-get":"note.collection.field.get","/api-reference/note/collection/note-collection-field-list":"note.collection.field.list","/api-reference/note/collection/note-collection-get":"note.collection.get","/api-reference/note/collection/note-collection-list":"note.collection.list","/api-reference/note/collection/note-collection-update":"note.collection.update","/api-reference/note/document/note-document-add":"note.document.add","/api-reference/note/document/note-document-archive":"note.document.archive","/api-reference/note/document/note-document-delete":"note.document.delete","/api-reference/note/document/note-document-field-get":"note.document.field.get","/api-reference/note/document/note-document-field-list":"note.document.field.list","/api-reference/note/document/note-document-get":"note.document.get","/api-reference/note/document/note-document-search-field-get":"note.document.search.field.get","/api-reference/note/document/note-document-search-field-list":"note.document.search.field.list","/api-reference/note/document/note-document-search-list":"note.document.search.list","/api-reference/note/document/note-document-tree-field-get":"note.document.tree.field.get","/api-reference/note/document/note-document-tree-field-list":"note.document.tree.field.list","/api-reference/note/document/note-document-tree-list":"note.document.tree.list","/api-reference/note/document/note-document-update":"note.document.update","/api-reference/note/file/note-file-add":"note.file.add","/api-reference/note/file/note-file-field-get":"note.file.field.get","/api-reference/note/file/note-file-field-list":"note.file.field.list","/api-reference/note/file/note-file-get":"note.file.get","/api-reference/outdated/rpa/comment/rpa-comment-delete":"rpa.comment.delete","/api-reference/outdated/rpa/comment/rpa-comment-update":"rpa.comment.update","/api-reference/outdated/rpa/fields/rpa-fields-get-settings":"rpa.fields.getSettings","/api-reference/outdated/rpa/fields/rpa-fields-set-settings":"rpa.fields.setSettings","/api-reference/outdated/rpa/fields/rpa-fields-set-visibility-settings":"rpa.fields.setVisibilitySettings","/api-reference/outdated/rpa/item/rpa-item-add":"rpa.item.add","/api-reference/outdated/rpa/item/rpa-item-delete":"rpa.item.delete","/api-reference/outdated/rpa/item/rpa-item-get-tasks":"rpa.item.getTasks","/api-reference/outdated/rpa/item/rpa-item-list":"rpa.item.list","/api-reference/outdated/rpa/item/rpa-item-update":"rpa.item.update","/api-reference/outdated/rpa/stage/rpa-stage-add":"rpa.stage.add","/api-reference/outdated/rpa/stage/rpa-stage-delete":"rpa.stage.delete","/api-reference/outdated/rpa/stage/rpa-stage-list-for-type":"rpa.stage.listForType","/api-reference/outdated/rpa/stage/rpa-stage-update":"rpa.stage.update","/api-reference/outdated/rpa/task/rpa-task-add-user":"rpa.task.addUser","/api-reference/outdated/rpa/task/rpa-task-delete":"rpa.task.delete","/api-reference/outdated/rpa/timeline/rpa-timeline-add":"rpa.timeline.add","/api-reference/outdated/rpa/timeline/rpa-timeline-delete":"rpa.timeline.delete","/api-reference/outdated/rpa/timeline/rpa-timeline-list-for-item":"rpa.timeline.listForItem","/api-reference/outdated/rpa/timeline/rpa-timeline-update-is-fixed":"rpa.timeline.updateIsFixed","/api-reference/outdated/rpa/timeline/rpa-timeline-update":"rpa.timeline.update","/api-reference/outdated/rpa/type/rpa-type-add":"rpa.type.add","/api-reference/outdated/rpa/type/rpa-type-delete":"rpa.type.delete","/api-reference/outdated/rpa/type/rpa-type-get":"rpa.type.get","/api-reference/outdated/rpa/type/rpa-type-list":"rpa.type.list","/api-reference/outdated/rpa/type/rpa-type-update":"rpa.type.update","/api-reference/pay-system/outdated/sale-pay-system-pay-invoice":"sale.paysystem.pay.invoice","/api-reference/pay-system/outdated/sale-pay-system-settings-invoice-get":"sale.paysystem.settings.invoice.get","/api-reference/pay-system/sale-pay-system-add":"sale.paysystem.add","/api-reference/pay-system/sale-pay-system-delete":"sale.paysystem.delete","/api-reference/pay-system/sale-pay-system-handler-add":"sale.paysystem.handler.add","/api-reference/pay-system/sale-pay-system-handler-delete":"sale.paysystem.handler.delete","/api-reference/pay-system/sale-pay-system-handler-update":"sale.paysystem.handler.update","/api-reference/pay-system/sale-pay-system-list":"sale.paysystem.list","/api-reference/pay-system/sale-pay-system-pay-payment":"sale.paysystem.pay.payment","/api-reference/pay-system/sale-pay-system-settings-get":"sale.paysystem.settings.get","/api-reference/pay-system/sale-pay-system-settings-payment-get":"sale.paysystem.settings.payment.get","/api-reference/pay-system/sale-pay-system-settings-update":"sale.paysystem.settings.update","/api-reference/pay-system/sale-pay-system-update":"sale.paysystem.update","/api-reference/sale/basket-item/sale-basket-item-add-catalog-product":"sale.basketitem.addCatalogProduct","/api-reference/sale/basket-item/sale-basket-item-add":"sale.basketitem.add","/api-reference/sale/basket-item/sale-basket-item-delete":"sale.basketitem.delete","/api-reference/sale/basket-item/sale-basket-item-get-catalog-product-fields":"sale.basketitem.getFieldsCatalogProduct","/api-reference/sale/basket-item/sale-basket-item-get-fields":"sale.basketitem.getFields","/api-reference/sale/basket-item/sale-basket-item-get":"sale.basketitem.get","/api-reference/sale/basket-item/sale-basket-item-list":"sale.basketitem.list","/api-reference/sale/basket-item/sale-basket-item-update-catalog-product":"sale.basketitem.updateCatalogProduct","/api-reference/sale/basket-item/sale-basket-item-update":"sale.basketitem.update","/api-reference/sale/basket-properties/sale-basket-properties-add":"sale.basketproperties.add","/api-reference/sale/basket-properties/sale-basket-properties-delete":"sale.basketproperties.delete","/api-reference/sale/basket-properties/sale-basket-properties-get-fields":"sale.basketproperties.getFields","/api-reference/sale/basket-properties/sale-basket-properties-get":"sale.basketproperties.get","/api-reference/sale/basket-properties/sale-basket-properties-list":"sale.basketproperties.list","/api-reference/sale/basket-properties/sale-basket-properties-update":"sale.basketproperties.update","/api-reference/sale/business-value-person-domain/sale-business-value-person-domain-add":"sale.businessValuePersonDomain.add","/api-reference/sale/business-value-person-domain/sale-business-value-person-domain-delete-by-filter":"sale.businessValuePersonDomain.deleteByFilter","/api-reference/sale/business-value-person-domain/sale-business-value-person-domain-get-fields":"sale.businessValuePersonDomain.getFields","/api-reference/sale/business-value-person-domain/sale-business-value-person-domain-list":"sale.businessValuePersonDomain.list","/api-reference/sale/cashbox/sale-cashbox-add":"sale.cashbox.add","/api-reference/sale/cashbox/sale-cashbox-check-apply":"sale.cashbox.check.apply","/api-reference/sale/cashbox/sale-cashbox-delete":"sale.cashbox.delete","/api-reference/sale/cashbox/sale-cashbox-handler-add":"sale.cashbox.handler.add","/api-reference/sale/cashbox/sale-cashbox-handler-delete":"sale.cashbox.handler.delete","/api-reference/sale/cashbox/sale-cashbox-handler-list":"sale.cashbox.handler.list","/api-reference/sale/cashbox/sale-cashbox-handler-update":"sale.cashbox.handler.update","/api-reference/sale/cashbox/sale-cashbox-list":"sale.cashbox.list","/api-reference/sale/cashbox/sale-cashbox-update":"sale.cashbox.update","/api-reference/sale/delivery/delivery-request/sale-delivery-request-delete":"sale.delivery.request.delete","/api-reference/sale/delivery/delivery-request/sale-delivery-request-send-message":"sale.delivery.request.sendmessage","/api-reference/sale/delivery/delivery-request/sale-delivery-request-update":"sale.delivery.request.update","/api-reference/sale/delivery/delivery/sale-delivery-add":"sale.delivery.add","/api-reference/sale/delivery/delivery/sale-delivery-config-get":"sale.delivery.config.get","/api-reference/sale/delivery/delivery/sale-delivery-config-update":"sale.delivery.config.update","/api-reference/sale/delivery/delivery/sale-delivery-delete":"sale.delivery.delete","/api-reference/sale/delivery/delivery/sale-delivery-get-list":"sale.delivery.getlist","/api-reference/sale/delivery/delivery/sale-delivery-update":"sale.delivery.update","/api-reference/sale/delivery/extra-service/sale-delivery-extra-service-add":"sale.delivery.extra.service.add","/api-reference/sale/delivery/extra-service/sale-delivery-extra-service-delete":"sale.delivery.extra.service.delete","/api-reference/sale/delivery/extra-service/sale-delivery-extra-service-get":"sale.delivery.extra.service.get","/api-reference/sale/delivery/extra-service/sale-delivery-extra-service-update":"sale.delivery.extra.service.update","/api-reference/sale/delivery/handler/sale-delivery-handler-add":"sale.delivery.handler.add","/api-reference/sale/delivery/handler/sale-delivery-handler-delete":"sale.delivery.handler.delete","/api-reference/sale/delivery/handler/sale-delivery-handler-list":"sale.delivery.handler.list","/api-reference/sale/delivery/handler/sale-delivery-handler-update":"sale.delivery.handler.update","/api-reference/sale/order/sale-order-add":"sale.order.add","/api-reference/sale/order/sale-order-delete":"sale.order.delete","/api-reference/sale/order/sale-order-get-fields":"sale.order.getfields","/api-reference/sale/order/sale-order-get":"sale.order.get","/api-reference/sale/order/sale-order-list":"sale.order.list","/api-reference/sale/order/sale-order-update":"sale.order.update","/api-reference/sale/payment-item-basket/sale-payment-item-basket-add":"sale.paymentitembasket.add","/api-reference/sale/payment-item-basket/sale-payment-item-basket-delete":"sale.paymentitembasket.delete","/api-reference/sale/payment-item-basket/sale-payment-item-basket-get-fields":"sale.paymentitembasket.getfields","/api-reference/sale/payment-item-basket/sale-payment-item-basket-get":"sale.paymentitembasket.get","/api-reference/sale/payment-item-basket/sale-payment-item-basket-list":"sale.paymentitembasket.list","/api-reference/sale/payment-item-basket/sale-payment-item-basket-update":"sale.paymentitembasket.update","/api-reference/sale/payment-item-shipment/sale-payment-item-shipment-add":"sale.paymentItemShipment.add","/api-reference/sale/payment-item-shipment/sale-payment-item-shipment-delete":"sale.paymentItemShipment.delete","/api-reference/sale/payment-item-shipment/sale-payment-item-shipment-get-fields":"sale.paymentItemShipment.getFields","/api-reference/sale/payment-item-shipment/sale-payment-item-shipment-get":"sale.paymentItemShipment.get","/api-reference/sale/payment-item-shipment/sale-payment-item-shipment-list":"sale.paymentItemShipment.list","/api-reference/sale/payment-item-shipment/sale-payment-item-shipment-update":"sale.paymentItemShipment.update","/api-reference/sale/payment/sale-payment-add":"sale.payment.add","/api-reference/sale/payment/sale-payment-delete":"sale.payment.delete","/api-reference/sale/payment/sale-payment-get-fields":"sale.payment.getFields","/api-reference/sale/payment/sale-payment-get":"sale.payment.get","/api-reference/sale/payment/sale-payment-list":"sale.payment.list","/api-reference/sale/payment/sale-payment-update":"sale.payment.update","/api-reference/sale/person-type/sale-person-type-add":"sale.persontype.add","/api-reference/sale/person-type/sale-person-type-delete":"sale.persontype.delete","/api-reference/sale/person-type/sale-person-type-get-fields":"sale.persontype.getFields","/api-reference/sale/person-type/sale-person-type-get":"sale.persontype.get","/api-reference/sale/person-type/sale-person-type-list":"sale.persontype.list","/api-reference/sale/person-type/sale-person-type-update":"sale.persontype.update","/api-reference/sale/property-group/sale-property-group-add":"sale.propertygroup.add","/api-reference/sale/property-group/sale-property-group-delete":"sale.propertygroup.delete","/api-reference/sale/property-group/sale-property-group-get-fields":"sale.propertygroup.getFields","/api-reference/sale/property-group/sale-property-group-get":"sale.propertygroup.get","/api-reference/sale/property-group/sale-property-group-list":"sale.propertygroup.list","/api-reference/sale/property-group/sale-property-group-update":"sale.propertygroup.update","/api-reference/sale/property-relation/sale-property-relation-add":"sale.propertyRelation.add","/api-reference/sale/property-relation/sale-property-relation-delete-by-filter":"sale.propertyRelation.deleteByFilter","/api-reference/sale/property-relation/sale-property-relation-get-fields":"sale.propertyRelation.getFields","/api-reference/sale/property-relation/sale-property-relation-list":"sale.propertyRelation.list","/api-reference/sale/property-value/sale-property-value-delete":"sale.propertyvalue.delete","/api-reference/sale/property-value/sale-property-value-get-fields":"sale.propertyvalue.getfields","/api-reference/sale/property-value/sale-property-value-get":"sale.propertyvalue.get","/api-reference/sale/property-value/sale-property-value-list":"sale.propertyvalue.list","/api-reference/sale/property-value/sale-property-value-modify":"sale.propertyvalue.modify","/api-reference/sale/property-variant/sale-property-variant-add":"sale.propertyvariant.add","/api-reference/sale/property-variant/sale-property-variant-delete":"sale.propertyvariant.delete","/api-reference/sale/property-variant/sale-property-variant-get-fields":"sale.propertyvariant.getFields","/api-reference/sale/property-variant/sale-property-variant-get":"sale.propertyvariant.get","/api-reference/sale/property-variant/sale-property-variant-list":"sale.propertyvariant.list","/api-reference/sale/property-variant/sale-property-variant-update":"sale.propertyvariant.update","/api-reference/sale/property/sale-property-add":"sale.property.add","/api-reference/sale/property/sale-property-delete":"sale.property.delete","/api-reference/sale/property/sale-property-get-fields-by-type":"sale.property.getfieldsbytype","/api-reference/sale/property/sale-property-get":"sale.property.get","/api-reference/sale/property/sale-property-list":"sale.property.list","/api-reference/sale/property/sale-property-update":"sale.property.update","/api-reference/sale/shipment-item/sale-shipment-item-add":"sale.shipmentitem.add","/api-reference/sale/shipment-item/sale-shipment-item-delete":"sale.shipmentitem.delete","/api-reference/sale/shipment-item/sale-shipment-item-get-fields":"sale.shipmentitem.getFields","/api-reference/sale/shipment-item/sale-shipment-item-get":"sale.shipmentitem.get","/api-reference/sale/shipment-item/sale-shipment-item-list":"sale.shipmentitem.list","/api-reference/sale/shipment-item/sale-shipment-item-update":"sale.shipmentitem.update","/api-reference/sale/shipment-property-value/sale-shipment-property-value-get-fields":"sale.shipmentpropertyvalue.getFields","/api-reference/sale/shipment-property-value/sale-shipment-property-value-get":"sale.shipmentpropertyvalue.get","/api-reference/sale/shipment-property-value/sale-shipment-property-value-list":"sale.shipmentpropertyvalue.list","/api-reference/sale/shipment-property-value/sale-shipment-property-value-modify":"sale.shipmentpropertyvalue.modify","/api-reference/sale/shipment-property-value/sale-shipment-propertyvalue-delete":"sale.shipmentpropertyvalue.delete","/api-reference/sale/shipment-property/sale-shipment-property-add":"sale.shipmentproperty.add","/api-reference/sale/shipment-property/sale-shipment-property-delete":"sale.shipmentproperty.delete","/api-reference/sale/shipment-property/sale-shipment-property-get-fields-by-type":"sale.shipmentproperty.getfieldsbytype","/api-reference/sale/shipment-property/sale-shipment-property-get":"sale.shipmentproperty.get","/api-reference/sale/shipment-property/sale-shipment-property-list":"sale.shipmentproperty.list","/api-reference/sale/shipment-property/sale-shipment-property-update":"sale.shipmentproperty.update","/api-reference/sale/shipment/sale-shipment-add":"sale.shipment.add","/api-reference/sale/shipment/sale-shipment-delete":"sale.shipment.delete","/api-reference/sale/shipment/sale-shipment-get-fields":"sale.shipment.getFields","/api-reference/sale/shipment/sale-shipment-get":"sale.shipment.get","/api-reference/sale/shipment/sale-shipment-list":"sale.shipment.list","/api-reference/sale/shipment/sale-shipment-update":"sale.shipment.update","/api-reference/sale/status-lang/sale-status-lang-add":"sale.statusLang.add","/api-reference/sale/status-lang/sale-status-lang-delete-by-filter":"sale.statusLang.deleteByFilter","/api-reference/sale/status-lang/sale-status-lang-get-fields":"sale.statusLang.getFields","/api-reference/sale/status-lang/sale-status-lang-get-list-langs":"sale.statusLang.getListLangs","/api-reference/sale/status-lang/sale-status-lang-list":"sale.statusLang.list","/api-reference/sale/status/sale-status-add":"sale.status.add","/api-reference/sale/status/sale-status-delete":"sale.status.delete","/api-reference/sale/status/sale-status-get-fields":"sale.status.getFields","/api-reference/sale/status/sale-status-get":"sale.status.get","/api-reference/sale/status/sale-status-list":"sale.status.list","/api-reference/sale/status/sale-status-update":"sale.status.update","/api-reference/sale/trade-binding/sale-trade-binding-list":"sale.tradeBinding.list","/api-reference/sale/trade-platform/sale-trade-platform-get-fields":"sale.tradePlatform.getFields","/api-reference/sale/trade-platform/sale-trade-platform-list":"sale.tradePlatform.list","/api-reference/sign/hcm-link/humanresources-hcmlink-company-add":"humanresources.hcmlink.company.add","/api-reference/sign/hcm-link/humanresources-hcmlink-company-delete":"humanresources.hcmlink.company.delete","/api-reference/sign/hcm-link/humanresources-hcmlink-company-list":"humanresources.hcmlink.company.list","/api-reference/sign/hcm-link/humanresources-hcmlink-company-update":"humanresources.hcmlink.company.update","/api-reference/sign/hcm-link/humanresources-hcmlink-company-user-list":"humanresources.hcmlink.company.user.list","/api-reference/sign/hcm-link/humanresources-hcmlink-employee-list":"humanresources.hcmlink.employee.list","/api-reference/sign/hcm-link/humanresources-hcmlink-employee-set":"humanresources.hcmlink.employee.set","/api-reference/sign/hcm-link/humanresources-hcmlink-field-value-set":"humanresources.hcmlink.field.value.set","/api-reference/sign/hcm-link/humanresources-hcmlink-job-status-get":"humanresources.hcmlink.job.status.get","/api-reference/sign/hcm-link/humanresources-hcmlink-job-update":"humanresources.hcmlink.job.update","/api-reference/sign/sign-b2e-company-provider-list":"sign.b2e.company.provider.list","/api-reference/sign/sign-b2e-document-get":"sign.b2e.document.get","/api-reference/sign/sign-b2e-document-send":"sign.b2e.document.send","/api-reference/sign/sign-b2e-hcmlink-document-get":"sign.b2e.hcmlink.document.get","/api-reference/sign/sign-b2e-mysafe-tail":"sign.b2e.mysafe.tail","/api-reference/sign/sign-b2e-personal-tail":"sign.b2e.personal.tail","/api-reference/sonet-group/members/sonet-group-user-add":"sonet_group.user.add","/api-reference/sonet-group/members/sonet-group-user-delete":"sonet_group.user.delete","/api-reference/sonet-group/members/sonet-group-user-get":"sonet_group.user.get","/api-reference/sonet-group/members/sonet-group-user-invite":"sonet_group.user.invite","/api-reference/sonet-group/members/sonet-group-user-request":"sonet_group.user.request","/api-reference/sonet-group/members/sonet-group-user-update":"sonet_group.user.update","/api-reference/sonet-group/scrum/backlog/tasks-api-scrum-backlog-add":"tasks.api.scrum.backlog.add","/api-reference/sonet-group/scrum/backlog/tasks-api-scrum-backlog-delete":"tasks.api.scrum.backlog.delete","/api-reference/sonet-group/scrum/backlog/tasks-api-scrum-backlog-get-fields":"tasks.api.scrum.backlog.getFields","/api-reference/sonet-group/scrum/backlog/tasks-api-scrum-backlog-get":"tasks.api.scrum.backlog.get","/api-reference/sonet-group/scrum/backlog/tasks-api-scrum-backlog-update":"tasks.api.scrum.backlog.update","/api-reference/sonet-group/scrum/epic/tasks-api-scrum-epic-add":"tasks.api.scrum.epic.add","/api-reference/sonet-group/scrum/epic/tasks-api-scrum-epic-delete":"tasks.api.scrum.epic.delete","/api-reference/sonet-group/scrum/epic/tasks-api-scrum-epic-get-fields":"tasks.api.scrum.epic.getFields","/api-reference/sonet-group/scrum/epic/tasks-api-scrum-epic-get":"tasks.api.scrum.epic.get","/api-reference/sonet-group/scrum/epic/tasks-api-scrum-epic-list":"tasks.api.scrum.epic.list","/api-reference/sonet-group/scrum/epic/tasks-api-scrum-epic-update":"tasks.api.scrum.epic.update","/api-reference/sonet-group/scrum/kanban/tasks-api-scrum-kanban-add-stage":"tasks.api.scrum.kanban.addStage","/api-reference/sonet-group/scrum/kanban/tasks-api-scrum-kanban-add-task":"tasks.api.scrum.kanban.addTask","/api-reference/sonet-group/scrum/kanban/tasks-api-scrum-kanban-delete-stage":"tasks.api.scrum.kanban.deleteStage","/api-reference/sonet-group/scrum/kanban/tasks-api-scrum-kanban-delete-task":"tasks.api.scrum.kanban.deleteTask","/api-reference/sonet-group/scrum/kanban/tasks-api-scrum-kanban-get-stages":"tasks.api.scrum.kanban.getStages","/api-reference/sonet-group/scrum/kanban/tasks-api-scrum-kanban-update-stage":"tasks.api.scrum.kanban.updateStage","/api-reference/sonet-group/scrum/sprint/tasks-api-scrum-sprint-add":"tasks.api.scrum.sprint.add","/api-reference/sonet-group/scrum/sprint/tasks-api-scrum-sprint-complete":"tasks.api.scrum.sprint.complete","/api-reference/sonet-group/scrum/sprint/tasks-api-scrum-sprint-delete":"tasks.api.scrum.sprint.delete","/api-reference/sonet-group/scrum/sprint/tasks-api-scrum-sprint-get-fields":"tasks.api.scrum.sprint.getFields","/api-reference/sonet-group/scrum/sprint/tasks-api-scrum-sprint-get":"tasks.api.scrum.sprint.get","/api-reference/sonet-group/scrum/sprint/tasks-api-scrum-sprint-list":"tasks.api.scrum.sprint.list","/api-reference/sonet-group/scrum/sprint/tasks-api-scrum-sprint-start":"tasks.api.scrum.sprint.start","/api-reference/sonet-group/scrum/sprint/tasks-api-scrum-sprint-update":"tasks.api.scrum.sprint.update","/api-reference/sonet-group/scrum/task/tasks-api-scrum-task-get-fields":"tasks.api.scrum.task.getFields","/api-reference/sonet-group/scrum/task/tasks-api-scrum-task-get":"tasks.api.scrum.task.get","/api-reference/sonet-group/scrum/task/tasks-api-scrum-task-update":"tasks.api.scrum.task.update","/api-reference/sonet-group/socialnetwork-api-workgroup-get":"socialnetwork.api.workgroup.get","/api-reference/sonet-group/socialnetwork-api-workgroup-list":"socialnetwork.api.workgroup.list","/api-reference/sonet-group/sonet-group-create":"sonet_group.create","/api-reference/sonet-group/sonet-group-delete":"sonet_group.delete","/api-reference/sonet-group/sonet-group-feature-access":"sonet_group.feature.access","/api-reference/sonet-group/sonet-group-get":"sonet_group.get","/api-reference/sonet-group/sonet-group-setowner":"sonet_group.setowner","/api-reference/sonet-group/sonet-group-update":"sonet_group.update","/api-reference/sonet-group/sonet-group-user-groups":"sonet_group.user.groups","/api-reference/tasks/checklist-item/task-checklist-item-add":"task.checklistitem.add","/api-reference/tasks/checklist-item/task-checklist-item-complete":"task.checklistitem.complete","/api-reference/tasks/checklist-item/task-checklist-item-delete":"task.checklistitem.delete","/api-reference/tasks/checklist-item/task-checklist-item-get-list":"task.checklistitem.getlist","/api-reference/tasks/checklist-item/task-checklist-item-get-manifest":"task.checklistitem.getmanifest","/api-reference/tasks/checklist-item/task-checklist-item-get":"task.checklistitem.get","/api-reference/tasks/checklist-item/task-checklist-item-is-action-allowed":"task.checklistitem.isactionallowed","/api-reference/tasks/checklist-item/task-checklist-item-move-after-item":"task.checklistitem.moveafteritem","/api-reference/tasks/checklist-item/task-checklist-item-renew":"task.checklistitem.renew","/api-reference/tasks/checklist-item/task-checklist-item-update":"task.checklistitem.update","/api-reference/tasks/comment-item/task-comment-item-add":"task.commentitem.add","/api-reference/tasks/comment-item/task-comment-item-delete":"task.commentitem.delete","/api-reference/tasks/comment-item/task-comment-item-get-list":"task.commentitem.getlist","/api-reference/tasks/comment-item/task-comment-item-get":"task.commentitem.get","/api-reference/tasks/comment-item/task-comment-item-update":"task.commentitem.update","/api-reference/tasks/deprecated/task-comment-add":"task.comment.add","/api-reference/tasks/deprecated/task-item/task-item-add-file":"task.item.addfile","/api-reference/tasks/deprecated/task-item/task-item-add-to-favourite":"task.item.addtofavorite","/api-reference/tasks/deprecated/task-item/task-item-add":"task.item.add","/api-reference/tasks/deprecated/task-item/task-item-approve":"task.item.approve","/api-reference/tasks/deprecated/task-item/task-item-complete":"task.item.complete","/api-reference/tasks/deprecated/task-item/task-item-defer":"task.item.defer","/api-reference/tasks/deprecated/task-item/task-item-delegate":"task.item.delegate","/api-reference/tasks/deprecated/task-item/task-item-delete-file":"task.item.deletefile","/api-reference/tasks/deprecated/task-item/task-item-delete-from-favorite":"task.item.deletefromfavorite","/api-reference/tasks/deprecated/task-item/task-item-delete":"task.item.delete","/api-reference/tasks/deprecated/task-item/task-item-disapprove":"task.item.disapprove","/api-reference/tasks/deprecated/task-item/task-item-get-allowed-actions":"task.item.getallowedactions","/api-reference/tasks/deprecated/task-item/task-item-get-allowed-task-actions-as-strings":"task.item.getallowedtaskactionsasstrings","/api-reference/tasks/deprecated/task-item/task-item-get-data":"task.item.getdata","/api-reference/tasks/deprecated/task-item/task-item-get-dependson":"task.item.getdependson","/api-reference/tasks/deprecated/task-item/task-item-get-description":"task.item.getdescription","/api-reference/tasks/deprecated/task-item/task-item-get-files":"task.item.getfiles","/api-reference/tasks/deprecated/task-item/task-item-is-action-allowed":"task.item.isactionallowed","/api-reference/tasks/deprecated/task-item/task-item-list":"task.item.list","/api-reference/tasks/deprecated/task-item/task-item-renew":"task.item.renew","/api-reference/tasks/deprecated/task-item/task-item-start-execution":"task.item.startexecution","/api-reference/tasks/deprecated/task-item/task-item-update":"task.item.update","/api-reference/tasks/deprecated/task-item/task-log-item-list":"task.logitem.list","/api-reference/tasks/deprecated/task-items-get-list":"task.items.getlist","/api-reference/tasks/elapsed-item/task-elapsed-item-add":"task.elapseditem.add","/api-reference/tasks/elapsed-item/task-elapsed-item-delete":"task.elapseditem.delete","/api-reference/tasks/elapsed-item/task-elapsed-item-get-list":"task.elapseditem.getlist","/api-reference/tasks/elapsed-item/task-elapsed-item-get-manifest":"task.elapseditem.getmanifest","/api-reference/tasks/elapsed-item/task-elapsed-item-get":"task.elapseditem.get","/api-reference/tasks/elapsed-item/task-elapsed-item-is-action-allowed":"task.elapseditem.isactionallowed","/api-reference/tasks/elapsed-item/task-elapsed-item-update":"task.elapseditem.update","/api-reference/tasks/flow/tasks-flow-flow-activate":"tasks.flow.Flow.activate","/api-reference/tasks/flow/tasks-flow-flow-create":"tasks.flow.Flow.create","/api-reference/tasks/flow/tasks-flow-flow-delete":"tasks.flow.Flow.delete","/api-reference/tasks/flow/tasks-flow-flow-get":"tasks.flow.Flow.get","/api-reference/tasks/flow/tasks-flow-flow-is-exists":"tasks.flow.Flow.isExists","/api-reference/tasks/flow/tasks-flow-flow-pin":"tasks.flow.Flow.pin","/api-reference/tasks/flow/tasks-flow-flow-update":"tasks.flow.Flow.update","/api-reference/tasks/planner/task-planner-get-list":"task.planner.getlist","/api-reference/tasks/result/tasks-task-result-add-from-comment":"tasks.task.result.addFromComment","/api-reference/tasks/result/tasks-task-result-add":"tasks.task.result.add","/api-reference/tasks/result/tasks-task-result-addfromchatmessage":"tasks.task.result.addfromchatmessage","/api-reference/tasks/result/tasks-task-result-delete-from-comment":"tasks.task.result.deleteFromComment","/api-reference/tasks/result/tasks-task-result-delete":"tasks.task.result.delete","/api-reference/tasks/result/tasks-task-result-list":"tasks.task.result.list","/api-reference/tasks/result/tasks-task-result-update":"tasks.task.result.update","/api-reference/tasks/stages/task-stages-add":"task.stages.add","/api-reference/tasks/stages/task-stages-can-move-task":"task.stages.canmovetask","/api-reference/tasks/stages/task-stages-delete":"task.stages.delete","/api-reference/tasks/stages/task-stages-get":"task.stages.get","/api-reference/tasks/stages/task-stages-move-task":"task.stages.movetask","/api-reference/tasks/stages/task-stages-update":"task.stages.update","/api-reference/tasks/status/tasks-task-complete":"tasks.task.complete","/api-reference/tasks/status/tasks-task-defer":"tasks.task.defer","/api-reference/tasks/status/tasks-task-pause":"tasks.task.pause","/api-reference/tasks/status/tasks-task-renew":"tasks.task.renew","/api-reference/tasks/status/tasks-task-start":"tasks.task.start","/api-reference/tasks/task-dependence-add":"task.dependence.add","/api-reference/tasks/task-dependence-delete":"task.dependence.delete","/api-reference/tasks/tasks-task-access-field-get":"tasks.task.access.field.get","/api-reference/tasks/tasks-task-access-field-list":"tasks.task.access.field.list","/api-reference/tasks/tasks-task-access-get":"tasks.task.access.get","/api-reference/tasks/tasks-task-add":"tasks.task.add","/api-reference/tasks/tasks-task-approve":"tasks.task.approve","/api-reference/tasks/tasks-task-chat-message-field-get":"tasks.task.chat.message.field.get","/api-reference/tasks/tasks-task-chat-message-field-list":"tasks.task.chat.message.field.list","/api-reference/tasks/tasks-task-chat-message-send":"tasks.task.chat.message.send","/api-reference/tasks/tasks-task-counters-get":"tasks.task.counters.get","/api-reference/tasks/tasks-task-delegate":"tasks.task.delegate","/api-reference/tasks/tasks-task-delete":"tasks.task.delete","/api-reference/tasks/tasks-task-disapprove":"tasks.task.disapprove","/api-reference/tasks/tasks-task-field-get":"tasks.task.field.get","/api-reference/tasks/tasks-task-field-list":"tasks.task.field.list","/api-reference/tasks/tasks-task-file-attach":"tasks.task.file.attach","/api-reference/tasks/tasks-task-file-field-get":"tasks.task.file.field.get","/api-reference/tasks/tasks-task-file-field-list":"tasks.task.file.field.list","/api-reference/tasks/tasks-task-files-attach":"tasks.task.files.attach","/api-reference/tasks/tasks-task-gantt-link-list":"tasks.task.gantt.link.list","/api-reference/tasks/tasks-task-get-access":"tasks.task.getaccess","/api-reference/tasks/tasks-task-get-fields":"tasks.task.getFields","/api-reference/tasks/tasks-task-get":"tasks.task.get","/api-reference/tasks/tasks-task-history-list":"tasks.task.history.list","/api-reference/tasks/tasks-task-list":"tasks.task.list","/api-reference/tasks/tasks-task-update":"tasks.task.update","/api-reference/tasks/template/checklist/tasks-template-checklist-add-attachment-by-content":"tasks.template.checklist.addAttachmentByContent","/api-reference/tasks/template/checklist/tasks-template-checklist-add-attachments-from-disk":"tasks.template.checklist.addAttachmentsFromDisk","/api-reference/tasks/template/checklist/tasks-template-checklist-add":"tasks.template.checklist.add","/api-reference/tasks/template/checklist/tasks-template-checklist-complete":"tasks.template.checklist.complete","/api-reference/tasks/template/checklist/tasks-template-checklist-delete":"tasks.template.checklist.delete","/api-reference/tasks/template/checklist/tasks-template-checklist-get":"tasks.template.checklist.get","/api-reference/tasks/template/checklist/tasks-template-checklist-list":"tasks.template.checklist.list","/api-reference/tasks/template/checklist/tasks-template-checklist-move-after":"tasks.template.checklist.moveAfter","/api-reference/tasks/template/checklist/tasks-template-checklist-move-before":"tasks.template.checklist.moveBefore","/api-reference/tasks/template/checklist/tasks-template-checklist-remove-attachments":"tasks.template.checklist.removeAttachments","/api-reference/tasks/template/checklist/tasks-template-checklist-renew":"tasks.template.checklist.renew","/api-reference/tasks/template/checklist/tasks-template-checklist-update":"tasks.template.checklist.update","/api-reference/tasks/template/tasks-template-add":"tasks.template.add","/api-reference/tasks/template/tasks-template-delete":"tasks.template.delete","/api-reference/tasks/template/tasks-template-fields":"tasks.template.fields","/api-reference/tasks/template/tasks-template-get":"tasks.template.get","/api-reference/tasks/template/tasks-template-update":"tasks.template.update","/api-reference/tasks/user-actions/tasks-task-favorite-add":"tasks.task.favorite.add","/api-reference/tasks/user-actions/tasks-task-favorite-remove":"tasks.task.favorite.remove","/api-reference/tasks/user-actions/tasks-task-mute":"tasks.task.mute","/api-reference/tasks/user-actions/tasks-task-pin":"tasks.task.pin","/api-reference/tasks/user-actions/tasks-task-start-watch":"tasks.task.startwatch","/api-reference/tasks/user-actions/tasks-task-stop-watch":"tasks.task.stopwatch","/api-reference/tasks/user-actions/tasks-task-unmute":"tasks.task.unmute","/api-reference/tasks/user-actions/tasks-task-unpin":"tasks.task.unpin","/api-reference/tasks/user-field/task-item-user-field-add":"task.item.userfield.add","/api-reference/tasks/user-field/task-item-user-field-delete":"task.item.userfield.delete","/api-reference/tasks/user-field/task-item-user-field-get-fields":"task.item.userfield.getfields","/api-reference/tasks/user-field/task-item-user-field-get-list":"task.item.userfield.getlist","/api-reference/tasks/user-field/task-item-user-field-get-types":"task.item.userfield.gettypes","/api-reference/tasks/user-field/task-item-user-field-get":"task.item.userfield.get","/api-reference/tasks/user-field/task-item-user-field-update":"task.item.userfield.update","/api-reference/telephony/follow-up/call-followup-field-get":"call.followup.field.get","/api-reference/telephony/follow-up/call-followup-field-list":"call.followup.field.list","/api-reference/telephony/follow-up/call-followup-get":"call.followup.get","/api-reference/telephony/follow-up/call-followup-list":"call.followup.list","/api-reference/telephony/telephony-call-attach-transcription":"telephony.call.attachTranscription","/api-reference/telephony/telephony-external-call-attach-record":"telephony.externalCall.attachRecord","/api-reference/telephony/telephony-external-call-finish":"telephony.externalCall.finish","/api-reference/telephony/telephony-external-call-hide":"telephony.externalCall.hide","/api-reference/telephony/telephony-external-call-register":"telephony.externalCall.register","/api-reference/telephony/telephony-external-call-search-crm-entities":"telephony.externalCall.searchCrmEntities","/api-reference/telephony/telephony-external-call-show":"telephony.externalCall.show","/api-reference/telephony/telephony-external-line-add":"telephony.externalLine.add","/api-reference/telephony/telephony-external-line-delete":"telephony.externalLine.delete","/api-reference/telephony/telephony-external-line-get":"telephony.externalLine.get","/api-reference/telephony/telephony-external-line-update":"telephony.externalLine.update","/api-reference/telephony/voximplant/lines/voximplant-line-get":"voximplant.line.get","/api-reference/telephony/voximplant/lines/voximplant-line-outgoing-get":"voximplant.line.outgoing.get","/api-reference/telephony/voximplant/lines/voximplant-line-outgoing-set":"voximplant.line.outgoing.set","/api-reference/telephony/voximplant/lines/voximplant-line-outgoing-sip-set":"voximplant.line.outgoing.sip.set","/api-reference/telephony/voximplant/sip/voximplant-sip-add":"voximplant.sip.add","/api-reference/telephony/voximplant/sip/voximplant-sip-connector-status":"voximplant.sip.connector.status","/api-reference/telephony/voximplant/sip/voximplant-sip-delete":"voximplant.sip.delete","/api-reference/telephony/voximplant/sip/voximplant-sip-get":"voximplant.sip.get","/api-reference/telephony/voximplant/sip/voximplant-sip-status":"voximplant.sip.status","/api-reference/telephony/voximplant/sip/voximplant-sip-update":"voximplant.sip.update","/api-reference/telephony/voximplant/users/voximplant-user-activate-phone":"voximplant.user.activatePhone","/api-reference/telephony/voximplant/users/voximplant-user-get":"voximplant.user.get","/api-reference/telephony/voximplant/voximplant-callback-start":"voximplant.callback.start","/api-reference/telephony/voximplant/voximplant-infocall-start-with-sound":"voximplant.infocall.startwithsound","/api-reference/telephony/voximplant/voximplant-infocall-start-with-text":"voximplant.infocall.startwithtext","/api-reference/telephony/voximplant/voximplant-statistic-get":"voximplant.statistic.get","/api-reference/telephony/voximplant/voximplant-tts-voices-get":"voximplant.tts.voices.get","/api-reference/telephony/voximplant/voximplant-url-get":"voximplant.url.get","/api-reference/timeman/base/timeman-close":"timeman.close","/api-reference/timeman/base/timeman-open":"timeman.open","/api-reference/timeman/base/timeman-pause":"timeman.pause","/api-reference/timeman/base/timeman-settings":"timeman.settings","/api-reference/timeman/base/timeman-status":"timeman.status","/api-reference/timeman/networkrange/timeman-networkrange-check":"timeman.networkrange.check","/api-reference/timeman/networkrange/timeman-networkrange-get":"timeman.networkrange.get","/api-reference/timeman/networkrange/timeman-networkrange-set":"timeman.networkrange.set","/api-reference/timeman/record/timeman-record-field-get":"timeman.record.field.get","/api-reference/timeman/record/timeman-record-field-list":"timeman.record.field.list","/api-reference/timeman/record/timeman-record-list":"timeman.record.list","/api-reference/timeman/schedule/timeman-schedule-get":"timeman.schedule.get","/api-reference/timeman/timecontrol/timeman-timecontrol-report-add":"timeman.timecontrol.report.add","/api-reference/timeman/timecontrol/timeman-timecontrol-reports-get":"timeman.timecontrol.reports.get","/api-reference/timeman/timecontrol/timeman-timecontrol-reports-settings-get":"timeman.timecontrol.reports.settings.get","/api-reference/timeman/timecontrol/timeman-timecontrol-reports-users-get":"timeman.timecontrol.reports.users.get","/api-reference/timeman/timecontrol/timeman-timecontrol-settings-get":"timeman.timecontrol.settings.get","/api-reference/timeman/timecontrol/timeman-timecontrol-settings-set":"timeman.timecontrol.settings.set","/api-reference/user-consent/user-consent-agreement-list":"userconsent.agreement.list","/api-reference/user-consent/user-consent-agreement-text":"userconsent.agreement.text","/api-reference/user-consent/user-consent-consent-add":"userconsent.consent.add","/api-reference/user/user-add":"user.add","/api-reference/user/user-get":"user.get","/api-reference/user/user-search":"user.search","/api-reference/user/user-update":"user.update","/api-reference/user/userfields/user-userfield-add":"user.userfield.add","/api-reference/user/userfields/user-userfield-delete":"user.userfield.delete","/api-reference/user/userfields/user-userfield-list":"user.userfield.list","/api-reference/user/userfields/user-userfield-update":"user.userfield.update","/api-reference/vibe/landing-repowidget-debug":"landing.repowidget.debug","/api-reference/vibe/landing-repowidget-get-list":"landing.repowidget.getlist","/api-reference/vibe/landing-repowidget-register":"landing.repowidget.register","/api-reference/vibe/landing-repowidget-unregister":"landing.repowidget.unregister","/api-reference/vote/vote.attachedvote.download":"vote.AttachedVote.download","/api-reference/vote/vote.attachedvote.get":"vote.AttachedVote.get","/api-reference/vote/vote.attachedvote.getAnswerVoted":"vote.AttachedVote.getAnswerVoted","/api-reference/vote/vote.attachedvote.getMany":"vote.AttachedVote.getMany","/api-reference/vote/vote.attachedvote.getWithVoted":"vote.AttachedVote.getWithVoted","/api-reference/vote/vote.attachedvote.recall":"vote.AttachedVote.recall","/api-reference/vote/vote.attachedvote.resume":"vote.AttachedVote.resume","/api-reference/vote/vote.attachedvote.stop":"vote.AttachedVote.stop","/api-reference/vote/vote.attachedvote.vote":"vote.AttachedVote.vote","/api-reference/vote/vote.integration.im.send":"vote.Integration.Im.send","/api-reference/widgets/placement-get":"placement.get","/api-reference/widgets/placement-list":"placement.list","/api-reference/widgets/placement-unbind":"placement.unbind","/api-reference/widgets/user-field/userfieldtype-add":"userfieldtype.add","/api-reference/widgets/user-field/userfieldtype-delete":"userfieldtype.delete","/api-reference/widgets/user-field/userfieldtype-update":"userfieldtype.update"} +{"/api-reference/ai/ai-engine-list":"ai.engine.list","/api-reference/ai/ai-engine-register":"ai.engine.register","/api-reference/ai/ai-engine-unregister":"ai.engine.unregister","/api-reference/biconnector/connector/biconnector-connector-add":"biconnector.connector.add","/api-reference/biconnector/connector/biconnector-connector-delete":"biconnector.connector.delete","/api-reference/biconnector/connector/biconnector-connector-fields":"biconnector.connector.fields","/api-reference/biconnector/connector/biconnector-connector-get":"biconnector.connector.get","/api-reference/biconnector/connector/biconnector-connector-list":"biconnector.connector.list","/api-reference/biconnector/connector/biconnector-connector-update":"biconnector.connector.update","/api-reference/biconnector/dataset/biconnector-dataset-add":"biconnector.dataset.add","/api-reference/biconnector/dataset/biconnector-dataset-delete":"biconnector.dataset.delete","/api-reference/biconnector/dataset/biconnector-dataset-fields-update":"biconnector.dataset.fields.update","/api-reference/biconnector/dataset/biconnector-dataset-fields":"biconnector.dataset.fields","/api-reference/biconnector/dataset/biconnector-dataset-get":"biconnector.dataset.get","/api-reference/biconnector/dataset/biconnector-dataset-list":"biconnector.dataset.list","/api-reference/biconnector/dataset/biconnector-dataset-update":"biconnector.dataset.update","/api-reference/biconnector/source/biconnector-source-add":"biconnector.source.add","/api-reference/biconnector/source/biconnector-source-delete":"biconnector.source.delete","/api-reference/biconnector/source/biconnector-source-fields":"biconnector.source.fields","/api-reference/biconnector/source/biconnector-source-get":"biconnector.source.get","/api-reference/biconnector/source/biconnector-source-list":"biconnector.source.list","/api-reference/biconnector/source/biconnector-source-update":"biconnector.source.update","/api-reference/biconnector/table/biconnector-table-add":"biconnector.table.add","/api-reference/biconnector/table/biconnector-table-delete":"biconnector.table.delete","/api-reference/biconnector/table/biconnector-table-fields-update":"biconnector.table.fields.update","/api-reference/biconnector/table/biconnector-table-fields":"biconnector.table.fields","/api-reference/biconnector/table/biconnector-table-get":"biconnector.table.get","/api-reference/biconnector/table/biconnector-table-list":"biconnector.table.list","/api-reference/biconnector/table/biconnector-table-update":"biconnector.table.update","/api-reference/bizproc/bizproc-activity/bizproc-activity-add":"bizproc.activity.add","/api-reference/bizproc/bizproc-activity/bizproc-activity-delete":"bizproc.activity.delete","/api-reference/bizproc/bizproc-activity/bizproc-activity-list":"bizproc.activity.list","/api-reference/bizproc/bizproc-activity/bizproc-activity-log":"bizproc.activity.log","/api-reference/bizproc/bizproc-activity/bizproc-activity-update":"bizproc.activity.update","/api-reference/bizproc/bizproc-robot/bizproc-event-send":"bizproc.event.send","/api-reference/bizproc/bizproc-robot/bizproc-robot-add":"bizproc.robot.add","/api-reference/bizproc/bizproc-robot/bizproc-robot-delete":"bizproc.robot.delete","/api-reference/bizproc/bizproc-robot/bizproc-robot-list":"bizproc.robot.list","/api-reference/bizproc/bizproc-robot/bizproc-robot-update":"bizproc.robot.update","/api-reference/bizproc/bizproc-task/bizproc-task-complete":"bizproc.task.complete","/api-reference/bizproc/bizproc-task/bizproc-task-delegate":"bizproc.task.delegate","/api-reference/bizproc/bizproc-task/bizproc-task-list":"bizproc.task.list","/api-reference/bizproc/bizproc-workflow-instances":"bizproc.workflow.instances","/api-reference/bizproc/bizproc-workflow-kill":"bizproc.workflow.kill","/api-reference/bizproc/bizproc-workflow-start":"bizproc.workflow.start","/api-reference/bizproc/bizproc-workflow-terminate":"bizproc.workflow.terminate","/api-reference/bizproc/template/bizproc-workflow-template-add":"bizproc.workflow.template.add","/api-reference/bizproc/template/bizproc-workflow-template-delete":"bizproc.workflow.template.delete","/api-reference/bizproc/template/bizproc-workflow-template-list":"bizproc.workflow.template.list","/api-reference/bizproc/template/bizproc-workflow-template-update":"bizproc.workflow.template.update","/api-reference/booking/booking-v1-clienttype-list":"booking.v1.clienttype.list","/api-reference/booking/booking/booking-v1-booking-add":"booking.v1.booking.add","/api-reference/booking/booking/booking-v1-booking-createfromwaitlist":"booking.v1.booking.createfromwaitlist","/api-reference/booking/booking/booking-v1-booking-delete":"booking.v1.booking.delete","/api-reference/booking/booking/booking-v1-booking-get":"booking.v1.booking.get","/api-reference/booking/booking/booking-v1-booking-list":"booking.v1.booking.list","/api-reference/booking/booking/booking-v1-booking-update":"booking.v1.booking.update","/api-reference/booking/booking/client/booking-v1-booking-client-list":"booking.v1.booking.client.list","/api-reference/booking/booking/client/booking-v1-booking-client-set":"booking.v1.booking.client.set","/api-reference/booking/booking/client/booking-v1-booking-client-unset":"booking.v1.booking.client.unset","/api-reference/booking/booking/external-data/booking-v1-booking-externaldata-list":"booking.v1.booking.externalData.list","/api-reference/booking/booking/external-data/booking-v1-booking-externaldata-set":"booking.v1.booking.externalData.set","/api-reference/booking/booking/external-data/booking-v1-booking-externaldata-unset":"booking.v1.booking.externalData.unset","/api-reference/booking/resource/booking-v1-resource-add":"booking.v1.resource.add","/api-reference/booking/resource/booking-v1-resource-delete":"booking.v1.resource.delete","/api-reference/booking/resource/booking-v1-resource-get":"booking.v1.resource.get","/api-reference/booking/resource/booking-v1-resource-list":"booking.v1.resource.list","/api-reference/booking/resource/booking-v1-resource-update":"booking.v1.resource.update","/api-reference/booking/resource/resource-type/booking-v1-resourcetype-add":"booking.v1.resourceType.add","/api-reference/booking/resource/resource-type/booking-v1-resourcetype-delete":"booking.v1.resourceType.delete","/api-reference/booking/resource/resource-type/booking-v1-resourcetype-get":"booking.v1.resourceType.get","/api-reference/booking/resource/resource-type/booking-v1-resourcetype-list":"booking.v1.resourceType.list","/api-reference/booking/resource/resource-type/booking-v1-resourcetype-update":"booking.v1.resourceType.update","/api-reference/booking/resource/slots/booking-v1-resource-slots-list":"booking.v1.resource.slots.list","/api-reference/booking/resource/slots/booking-v1-resource-slots-set":"booking.v1.resource.slots.set","/api-reference/booking/resource/slots/booking-v1-resource-slots-unset":"booking.v1.resource.slots.unset","/api-reference/booking/waitlist/booking-v1-waitlist-add":"booking.v1.waitlist.add","/api-reference/booking/waitlist/booking-v1-waitlist-createfrombooking":"booking.v1.waitlist.createfrombooking","/api-reference/booking/waitlist/booking-v1-waitlist-delete":"booking.v1.waitlist.delete","/api-reference/booking/waitlist/booking-v1-waitlist-get":"booking.v1.waitlist.get","/api-reference/booking/waitlist/booking-v1-waitlist-list":"booking.v1.waitlist.list","/api-reference/booking/waitlist/booking-v1-waitlist-update":"booking.v1.waitlist.update","/api-reference/booking/waitlist/client/booking-v1-waitlist-client-list":"booking.v1.waitlist.client.list","/api-reference/booking/waitlist/client/booking-v1-waitlist-client-set":"booking.v1.waitlist.client.set","/api-reference/booking/waitlist/client/booking-v1-waitlist-client-unset":"booking.v1.waitlist.client.unset","/api-reference/booking/waitlist/external-data/booking-v1-waitlist-externaldata-list":"booking.v1.waitlist.externalData.list","/api-reference/booking/waitlist/external-data/booking-v1-waitlist-externaldata-set":"booking.v1.waitlist.externalData.set","/api-reference/booking/waitlist/external-data/booking-v1-waitlist-externaldata-unset":"booking.v1.waitlist.externalData.unset","/api-reference/calendar/calendar-event/calendar-accessibility-get":"calendar.accessibility.get","/api-reference/calendar/calendar-event/calendar-event-add":"calendar.event.add","/api-reference/calendar/calendar-event/calendar-event-delete":"calendar.event.delete","/api-reference/calendar/calendar-event/calendar-event-get-by-id":"calendar.event.getbyid","/api-reference/calendar/calendar-event/calendar-event-get-nearest":"calendar.event.get.nearest","/api-reference/calendar/calendar-event/calendar-event-get":"calendar.event.get","/api-reference/calendar/calendar-event/calendar-event-update":"calendar.event.update","/api-reference/calendar/calendar-event/calendar-meeting-status-get":"calendar.meeting.status.get","/api-reference/calendar/calendar-event/calendar-meeting-status-set":"calendar.meeting.status.set","/api-reference/calendar/calendar-section-add":"calendar.section.add","/api-reference/calendar/calendar-section-delete":"calendar.section.delete","/api-reference/calendar/calendar-section-get":"calendar.section.get","/api-reference/calendar/calendar-section-update":"calendar.section.update","/api-reference/calendar/calendar-user-settings-set":"calendar.user.settings.set","/api-reference/calendar/resource/calendar-resource-add":"calendar.resource.add","/api-reference/calendar/resource/calendar-resource-booking-list":"calendar.resource.booking.list","/api-reference/calendar/resource/calendar-resource-delete":"calendar.resource.delete","/api-reference/calendar/resource/calendar-resource-update":"calendar.resource.update","/api-reference/catalog/catalog/catalog-catalog-get":"catalog.catalog.get","/api-reference/catalog/catalog/catalog-catalog-is-offers":"catalog.catalog.isOffers","/api-reference/catalog/catalog/catalog-catalog-list":"catalog.catalog.list","/api-reference/catalog/document/catalog-document-add":"catalog.document.add","/api-reference/catalog/document/catalog-document-cancel-list":"catalog.document.cancelList","/api-reference/catalog/document/catalog-document-cancel":"catalog.document.cancel","/api-reference/catalog/document/catalog-document-conduct-list":"catalog.document.conductList","/api-reference/catalog/document/catalog-document-conduct":"catalog.document.conduct","/api-reference/catalog/document/catalog-document-delete-list":"catalog.document.deleteList","/api-reference/catalog/document/catalog-document-delete":"catalog.document.delete","/api-reference/catalog/document/catalog-document-get-fields":"catalog.document.getFields","/api-reference/catalog/document/catalog-document-list":"catalog.document.list","/api-reference/catalog/document/catalog-document-mode-status":"catalog.document.mode.status","/api-reference/catalog/document/catalog-document-update":"catalog.document.update","/api-reference/catalog/document/document-element/catalog-document-element-add":"catalog.document.element.add","/api-reference/catalog/document/document-element/catalog-document-element-delete":"catalog.document.element.delete","/api-reference/catalog/document/document-element/catalog-document-element-get-fields":"catalog.document.element.getFields","/api-reference/catalog/document/document-element/catalog-document-element-list":"catalog.document.element.list","/api-reference/catalog/document/document-element/catalog-document-element-update":"catalog.document.element.update","/api-reference/catalog/document/outdated/catalog-document-confirm":"catalog.document.confirm","/api-reference/catalog/document/outdated/catalog-document-element-fields":"catalog.document.element.fields","/api-reference/catalog/document/outdated/catalog-document-fields":"catalog.document.fields","/api-reference/catalog/document/outdated/catalog-document-unconfirm":"catalog.document.unconfirm","/api-reference/catalog/documentcontractor/catalog-documentcontractor-add":"catalog.documentcontractor.add","/api-reference/catalog/documentcontractor/catalog-documentcontractor-delete":"catalog.documentcontractor.delete","/api-reference/catalog/documentcontractor/catalog-documentcontractor-get-fields":"catalog.documentcontractor.getFields","/api-reference/catalog/documentcontractor/catalog-documentcontractor-list":"catalog.documentcontractor.list","/api-reference/catalog/enum/catalog-enum-get-round-types":"catalog.enum.getRoundTypes","/api-reference/catalog/enum/catalog-enum-get-store-document-types":"catalog.enum.getStoreDocumentTypes","/api-reference/catalog/extra/catalog-extra-get":"catalog.extra.get","/api-reference/catalog/extra/catalog-extra-list":"catalog.extra.list","/api-reference/catalog/measure/catalog-measure-add":"catalog.measure.add","/api-reference/catalog/measure/catalog-measure-delete":"catalog.measure.delete","/api-reference/catalog/measure/catalog-measure-get":"catalog.measure.get","/api-reference/catalog/measure/catalog-measure-list":"catalog.measure.list","/api-reference/catalog/measure/catalog-measure-update":"catalog.measure.update","/api-reference/catalog/price-type/catalog-price-type-add":"catalog.priceType.add","/api-reference/catalog/price-type/catalog-price-type-delete":"catalog.priceType.delete","/api-reference/catalog/price-type/catalog-price-type-get":"catalog.priceType.get","/api-reference/catalog/price-type/catalog-price-type-list":"catalog.priceType.list","/api-reference/catalog/price-type/catalog-price-type-update":"catalog.priceType.update","/api-reference/catalog/price-type/price-type-group/catalog-price-type-group-add":"catalog.priceTypeGroup.add","/api-reference/catalog/price-type/price-type-group/catalog-price-type-group-delete":"catalog.priceTypeGroup.delete","/api-reference/catalog/price-type/price-type-group/catalog-price-type-group-get-fields":"catalog.priceTypeGroup.getFields","/api-reference/catalog/price-type/price-type-group/catalog-price-type-group-list":"catalog.priceTypeGroup.list","/api-reference/catalog/price-type/price-type-lang/catalog-price-type-lang-add":"catalog.priceTypeLang.add","/api-reference/catalog/price-type/price-type-lang/catalog-price-type-lang-delete":"catalog.priceTypeLang.delete","/api-reference/catalog/price-type/price-type-lang/catalog-price-type-lang-get-languages":"catalog.priceTypeLang.getLanguages","/api-reference/catalog/price-type/price-type-lang/catalog-price-type-lang-get":"catalog.priceTypeLang.get","/api-reference/catalog/price-type/price-type-lang/catalog-price-type-lang-list":"catalog.priceTypeLang.list","/api-reference/catalog/price-type/price-type-lang/catalog-price-type-lang-update":"catalog.priceTypeLang.update","/api-reference/catalog/price/catalog-price-add":"catalog.price.add","/api-reference/catalog/price/catalog-price-delete":"catalog.price.delete","/api-reference/catalog/price/catalog-price-get-fields":"catalog.price.getFields","/api-reference/catalog/price/catalog-price-get":"catalog.price.get","/api-reference/catalog/price/catalog-price-list":"catalog.price.list","/api-reference/catalog/price/catalog-price-modify":"catalog.price.modify","/api-reference/catalog/price/catalog-price-update":"catalog.price.update","/api-reference/catalog/product-image/catalog-product-image-add":"catalog.productImage.add","/api-reference/catalog/product-image/catalog-product-image-delete":"catalog.productImage.delete","/api-reference/catalog/product-image/catalog-product-image-get":"catalog.productImage.get","/api-reference/catalog/product-image/catalog-product-image-list":"catalog.productImage.list","/api-reference/catalog/product-property-enum/catalog-product-property-enum-add":"catalog.productPropertyEnum.add","/api-reference/catalog/product-property-enum/catalog-product-property-enum-delete":"catalog.productPropertyEnum.delete","/api-reference/catalog/product-property-enum/catalog-product-property-enum-get-fields":"catalog.productPropertyEnum.getFields","/api-reference/catalog/product-property-enum/catalog-product-property-enum-get":"catalog.productPropertyEnum.get","/api-reference/catalog/product-property-enum/catalog-product-property-enum-list":"catalog.productPropertyEnum.list","/api-reference/catalog/product-property-enum/catalog-product-property-enum-update":"catalog.productPropertyEnum.update","/api-reference/catalog/product-property-feature/catalog-product-property-feature-add":"catalog.productPropertyFeature.add","/api-reference/catalog/product-property-feature/catalog-product-property-feature-get-available-features-by-property":"catalog.productPropertyFeature.getAvailableFeaturesByProperty","/api-reference/catalog/product-property-feature/catalog-product-property-feature-get-fields":"catalog.productPropertyFeature.getFields","/api-reference/catalog/product-property-feature/catalog-product-property-feature-get":"catalog.productPropertyFeature.get","/api-reference/catalog/product-property-feature/catalog-product-property-feature-list":"catalog.productPropertyFeature.list","/api-reference/catalog/product-property-feature/catalog-product-property-feature-update":"catalog.productPropertyFeature.update","/api-reference/catalog/product-property-section/catalog-product-property-section-get":"catalog.productPropertySection.get","/api-reference/catalog/product-property-section/catalog-product-property-section-list":"catalog.productPropertySection.list","/api-reference/catalog/product-property-section/catalog-product-property-section-set":"catalog.productPropertySection.set","/api-reference/catalog/product-property/catalog-product-property-add":"catalog.productProperty.add","/api-reference/catalog/product-property/catalog-product-property-delete":"catalog.productProperty.delete","/api-reference/catalog/product-property/catalog-product-property-get-fields":"catalog.productProperty.getFields","/api-reference/catalog/product-property/catalog-product-property-get":"catalog.productProperty.get","/api-reference/catalog/product-property/catalog-product-property-list":"catalog.productProperty.list","/api-reference/catalog/product-property/catalog-product-property-update":"catalog.productProperty.update","/api-reference/catalog/product/catalog-product-add":"catalog.product.add","/api-reference/catalog/product/catalog-product-delete":"catalog.product.delete","/api-reference/catalog/product/catalog-product-download":"catalog.product.download","/api-reference/catalog/product/catalog-product-get-fields-by-filter":"catalog.product.getFieldsByFilter","/api-reference/catalog/product/catalog-product-get":"catalog.product.get","/api-reference/catalog/product/catalog-product-list":"catalog.product.list","/api-reference/catalog/product/catalog-product-update":"catalog.product.update","/api-reference/catalog/product/offer/catalog-product-offer-add":"catalog.product.offer.add","/api-reference/catalog/product/offer/catalog-product-offer-delete":"catalog.product.offer.delete","/api-reference/catalog/product/offer/catalog-product-offer-download":"catalog.product.offer.download","/api-reference/catalog/product/offer/catalog-product-offer-get-fields-by-filter":"catalog.product.offer.getFieldsByFilter","/api-reference/catalog/product/offer/catalog-product-offer-get":"catalog.product.offer.get","/api-reference/catalog/product/offer/catalog-product-offer-list":"catalog.product.offer.list","/api-reference/catalog/product/offer/catalog-product-offer-update":"catalog.product.offer.update","/api-reference/catalog/product/service/catalog-product-service-add":"catalog.product.service.add","/api-reference/catalog/product/service/catalog-product-service-delete":"catalog.product.service.delete","/api-reference/catalog/product/service/catalog-product-service-download":"catalog.product.service.download","/api-reference/catalog/product/service/catalog-product-service-get-fields-by-filter":"catalog.product.service.getFieldsByFilter","/api-reference/catalog/product/service/catalog-product-service-get":"catalog.product.service.get","/api-reference/catalog/product/service/catalog-product-service-list":"catalog.product.service.list","/api-reference/catalog/product/service/catalog-product-service-update":"catalog.product.service.update","/api-reference/catalog/product/sku/catalog-product-sku-add":"catalog.product.sku.add","/api-reference/catalog/product/sku/catalog-product-sku-delete":"catalog.product.sku.delete","/api-reference/catalog/product/sku/catalog-product-sku-download":"catalog.product.sku.download","/api-reference/catalog/product/sku/catalog-product-sku-get-fields-by-filter":"catalog.product.sku.getFieldsByFilter","/api-reference/catalog/product/sku/catalog-product-sku-get":"catalog.product.sku.get","/api-reference/catalog/product/sku/catalog-product-sku-list":"catalog.product.sku.list","/api-reference/catalog/product/sku/catalog-product-sku-update":"catalog.product.sku.update","/api-reference/catalog/ratio/catalog-ratio-get":"catalog.ratio.get","/api-reference/catalog/ratio/catalog-ratio-list":"catalog.ratio.list","/api-reference/catalog/rounding-rule/catalog-rounding-rule-add":"catalog.roundingRule.add","/api-reference/catalog/rounding-rule/catalog-rounding-rule-delete":"catalog.roundingRule.delete","/api-reference/catalog/rounding-rule/catalog-rounding-rule-get":"catalog.roundingRule.get","/api-reference/catalog/rounding-rule/catalog-rounding-rule-list":"catalog.roundingRule.list","/api-reference/catalog/rounding-rule/catalog-rounding-rule-update":"catalog.roundingRule.update","/api-reference/catalog/section/catalog-section-add":"catalog.section.add","/api-reference/catalog/section/catalog-section-delete":"catalog.section.delete","/api-reference/catalog/section/catalog-section-get":"catalog.section.get","/api-reference/catalog/section/catalog-section-list":"catalog.section.list","/api-reference/catalog/section/catalog-section-update":"catalog.section.update","/api-reference/catalog/store-product/catalog-store-product-get-fields":"catalog.storeproduct.getFields","/api-reference/catalog/store-product/catalog-store-product-get":"catalog.storeproduct.get","/api-reference/catalog/store-product/catalog-store-product-list":"catalog.storeproduct.list","/api-reference/catalog/store/catalog-store-add":"catalog.store.add","/api-reference/catalog/store/catalog-store-delete":"catalog.store.delete","/api-reference/catalog/store/catalog-store-get":"catalog.store.get","/api-reference/catalog/store/catalog-store-list":"catalog.store.list","/api-reference/catalog/store/catalog-store-update":"catalog.store.update","/api-reference/catalog/userfield-document/catalog-userfield-document-list":"catalog.userfield.document.list","/api-reference/catalog/userfield-document/catalog-userfield-document-update":"catalog.userfield.document.update","/api-reference/catalog/vat/catalog-vat-add":"catalog.vat.add","/api-reference/catalog/vat/catalog-vat-delete":"catalog.vat.delete","/api-reference/catalog/vat/catalog-vat-get":"catalog.vat.get","/api-reference/catalog/vat/catalog-vat-list":"catalog.vat.list","/api-reference/catalog/vat/catalog-vat-update":"catalog.vat.update","/api-reference/chat-bots/chat-bots-v2/im.v2/events/event-get":"im.v2.Event.get","/api-reference/chat-bots/chat-bots-v2/im.v2/events/event-subscribe":"im.v2.Event.subscribe","/api-reference/chat-bots/chat-bots-v2/im.v2/events/event-unsubscribe":"im.v2.Event.unsubscribe","/api-reference/chat-bots/chat-bots-v2/im.v2/files/file-download":"im.v2.File.download","/api-reference/chat-bots/chat-bots-v2/im.v2/files/file-upload":"im.v2.File.upload","/api-reference/chat-bots/chat-bots-v2/imbot.v2/bots/bot-get":"imbot.v2.Bot.get","/api-reference/chat-bots/chat-bots-v2/imbot.v2/bots/bot-list":"imbot.v2.Bot.list","/api-reference/chat-bots/chat-bots-v2/imbot.v2/bots/bot-register":"imbot.v2.Bot.register","/api-reference/chat-bots/chat-bots-v2/imbot.v2/bots/bot-unregister":"imbot.v2.Bot.unregister","/api-reference/chat-bots/chat-bots-v2/imbot.v2/bots/bot-update":"imbot.v2.Bot.update","/api-reference/chat-bots/chat-bots-v2/imbot.v2/chats/chat-add":"imbot.v2.Chat.add","/api-reference/chat-bots/chat-bots-v2/imbot.v2/chats/chat-get":"imbot.v2.Chat.get","/api-reference/chat-bots/chat-bots-v2/imbot.v2/chats/chat-leave":"imbot.v2.Chat.leave","/api-reference/chat-bots/chat-bots-v2/imbot.v2/chats/chat-manager-add":"imbot.v2.Chat.Manager.add","/api-reference/chat-bots/chat-bots-v2/imbot.v2/chats/chat-manager-delete":"imbot.v2.Chat.Manager.delete","/api-reference/chat-bots/chat-bots-v2/imbot.v2/chats/chat-set-owner":"imbot.v2.Chat.setOwner","/api-reference/chat-bots/chat-bots-v2/imbot.v2/chats/chat-update":"imbot.v2.Chat.update","/api-reference/chat-bots/chat-bots-v2/imbot.v2/chats/chat-user-add":"imbot.v2.Chat.User.add","/api-reference/chat-bots/chat-bots-v2/imbot.v2/chats/chat-user-delete":"imbot.v2.Chat.User.delete","/api-reference/chat-bots/chat-bots-v2/imbot.v2/chats/chat-user-list":"imbot.v2.Chat.User.list","/api-reference/chat-bots/chat-bots-v2/imbot.v2/commands/command-answer":"imbot.v2.Command.answer","/api-reference/chat-bots/chat-bots-v2/imbot.v2/commands/command-list":"imbot.v2.Command.list","/api-reference/chat-bots/chat-bots-v2/imbot.v2/commands/command-register":"imbot.v2.Command.register","/api-reference/chat-bots/chat-bots-v2/imbot.v2/commands/command-unregister":"imbot.v2.Command.unregister","/api-reference/chat-bots/chat-bots-v2/imbot.v2/commands/command-update":"imbot.v2.Command.update","/api-reference/chat-bots/chat-bots-v2/imbot.v2/events/event-get":"imbot.v2.Event.get","/api-reference/chat-bots/chat-bots-v2/imbot.v2/files/file-download":"imbot.v2.File.download","/api-reference/chat-bots/chat-bots-v2/imbot.v2/files/file-upload":"imbot.v2.File.upload","/api-reference/chat-bots/chat-bots-v2/imbot.v2/messages/chat-message-delete":"imbot.v2.Chat.Message.delete","/api-reference/chat-bots/chat-bots-v2/imbot.v2/messages/chat-message-get-context":"imbot.v2.Chat.Message.getContext","/api-reference/chat-bots/chat-bots-v2/imbot.v2/messages/chat-message-get":"imbot.v2.Chat.Message.get","/api-reference/chat-bots/chat-bots-v2/imbot.v2/messages/chat-message-reaction-add":"imbot.v2.Chat.Message.Reaction.add","/api-reference/chat-bots/chat-bots-v2/imbot.v2/messages/chat-message-reaction-delete":"imbot.v2.Chat.Message.Reaction.delete","/api-reference/chat-bots/chat-bots-v2/imbot.v2/messages/chat-message-read":"imbot.v2.Chat.Message.read","/api-reference/chat-bots/chat-bots-v2/imbot.v2/messages/chat-message-send":"imbot.v2.Chat.Message.send","/api-reference/chat-bots/chat-bots-v2/imbot.v2/messages/chat-message-update":"imbot.v2.Chat.Message.update","/api-reference/chat-bots/chat-bots-v2/imbot.v2/revision-get":"imbot.v2.Revision.get","/api-reference/chat-bots/chat-bots-v2/imbot.v2/ui/chat-input-action-notify":"imbot.v2.Chat.InputAction.notify","/api-reference/chat-bots/chat-bots-v2/imbot.v2/ui/chat-text-field-enabled":"imbot.v2.Chat.TextField.enabled","/api-reference/chat-bots/outdated/bots/imbot-register":"imbot.register","/api-reference/chat-bots/outdated/bots/imbot-unregister":"imbot.unregister","/api-reference/chat-bots/outdated/bots/imbot-update":"imbot.update","/api-reference/chat-bots/outdated/chats/imbot-chat-add":"imbot.chat.add","/api-reference/chat-bots/outdated/chats/imbot-chat-get":"imbot.chat.get","/api-reference/chat-bots/outdated/chats/imbot-chat-leave":"imbot.chat.leave","/api-reference/chat-bots/outdated/chats/imbot-chat-send-typing":"imbot.chat.sendTyping","/api-reference/chat-bots/outdated/chats/imbot-chat-set-manager":"imbot.chat.setManager","/api-reference/chat-bots/outdated/chats/imbot-chat-set-owner":"imbot.chat.setOwner","/api-reference/chat-bots/outdated/chats/imbot-chat-update-avatar":"imbot.chat.updateAvatar","/api-reference/chat-bots/outdated/chats/imbot-chat-update-color":"imbot.chat.updateColor","/api-reference/chat-bots/outdated/chats/imbot-chat-update-title":"imbot.chat.updateTitle","/api-reference/chat-bots/outdated/chats/imbot-chat-user-add":"imbot.chat.user.add","/api-reference/chat-bots/outdated/chats/imbot-chat-user-delete":"imbot.chat.user.delete","/api-reference/chat-bots/outdated/chats/imbot-chat-user-list":"imbot.chat.user.list","/api-reference/chat-bots/outdated/chats/imbot-dialog-get":"imbot.dialog.get","/api-reference/chat-bots/outdated/commands/imbot-command-answer":"imbot.command.answer","/api-reference/chat-bots/outdated/commands/imbot-command-register":"imbot.command.register","/api-reference/chat-bots/outdated/commands/imbot-command-unregister":"imbot.command.unregister","/api-reference/chat-bots/outdated/commands/imbot-command-update":"imbot.command.update","/api-reference/chat-bots/outdated/messages/imbot-message-add":"imbot.message.add","/api-reference/chat-bots/outdated/messages/imbot-message-delete":"imbot.message.delete","/api-reference/chat-bots/outdated/messages/imbot-message-like":"imbot.message.like","/api-reference/chat-bots/outdated/messages/imbot-message-update":"imbot.message.update","/api-reference/chats/chat-update/im-chat-set-owner":"im.chat.setOwner","/api-reference/chats/chat-update/im-chat-update-avatar":"im.chat.updateAvatar","/api-reference/chats/chat-update/im-chat-update-color":"im.chat.updateColor","/api-reference/chats/chat-update/im-chat-update-title":"im.chat.updateTitle","/api-reference/chats/chat-users/im-chat-leave":"im.chat.leave","/api-reference/chats/chat-users/im-chat-user-add":"im.chat.user.add","/api-reference/chats/chat-users/im-chat-user-delete":"im.chat.user.delete","/api-reference/chats/chat-users/im-chat-user-list":"im.chat.user.list","/api-reference/chats/chat-users/im-dialog-users-list":"im.dialog.users.list","/api-reference/chats/departments/im-department-colleagues-list":"im.department.colleagues.list","/api-reference/chats/departments/im-department-employees-get":"im.department.employees.get","/api-reference/chats/departments/im-department-get":"im.department.get","/api-reference/chats/departments/im-department-managers-get":"im.department.managers.get","/api-reference/chats/files/im-disk-file-commit":"im.disk.file.commit","/api-reference/chats/files/im-disk-file-delete":"im.disk.file.delete","/api-reference/chats/files/im-disk-file-save":"im.disk.file.save","/api-reference/chats/files/im-disk-folder-get":"im.disk.folder.get","/api-reference/chats/im-chat-add":"im.chat.add","/api-reference/chats/im-chat-get":"im.chat.get","/api-reference/chats/im-counters-get":"im.counters.get","/api-reference/chats/im-dialog-get":"im.dialog.get","/api-reference/chats/im-recent-get":"im.recent.get","/api-reference/chats/im-recent-list":"im.recent.list","/api-reference/chats/im-revision-get":"im.revision.get","/api-reference/chats/messages/im-dialog-messages-get":"im.dialog.messages.get","/api-reference/chats/messages/im-dialog-messages-search":"im.dialog.messages.search","/api-reference/chats/messages/im-dialog-read":"im.dialog.read","/api-reference/chats/messages/im-dialog-unread":"im.dialog.unread","/api-reference/chats/messages/im-dialog-writing":"im.dialog.writing","/api-reference/chats/messages/im-message-add":"im.message.add","/api-reference/chats/messages/im-message-command":"im.message.command","/api-reference/chats/messages/im-message-delete":"im.message.delete","/api-reference/chats/messages/im-message-like":"im.message.like","/api-reference/chats/messages/im-message-share":"im.message.share","/api-reference/chats/messages/im-message-update":"im.message.update","/api-reference/chats/notifications/im-notify-answer":"im.notify.answer","/api-reference/chats/notifications/im-notify-confirm":"im.notify.confirm","/api-reference/chats/notifications/im-notify-delete":"im.notify.delete","/api-reference/chats/notifications/im-notify-get":"im.notify.get","/api-reference/chats/notifications/im-notify-history-search":"im.notify.history.search","/api-reference/chats/notifications/im-notify-personal-add":"im.notify.personal.add","/api-reference/chats/notifications/im-notify-read-all":"im.notify.read.all","/api-reference/chats/notifications/im-notify-read-list":"im.notify.read.list","/api-reference/chats/notifications/im-notify-read":"im.notify.read","/api-reference/chats/notifications/im-notify-schema-get":"im.notify.schema.get","/api-reference/chats/notifications/im-notify-system-add":"im.notify.system.add","/api-reference/chats/notifications/im-notify":"im.notify","/api-reference/chats/outdated/create-app/imbot-app-unregister":"imbot.app.unregister","/api-reference/chats/outdated/create-app/imbot-app-update":"imbot.app.update","/api-reference/chats/search/im-search-chat-list":"im.search.chat.list","/api-reference/chats/search/im-search-department-list":"im.search.department.list","/api-reference/chats/search/im-search-last-add":"im.search.last.add","/api-reference/chats/search/im-search-last-delete":"im.search.last.delete","/api-reference/chats/search/im-search-last-get":"im.search.last.get","/api-reference/chats/search/im-search-user-list":"im.search.user.list","/api-reference/chats/special-operations/im-chat-mute":"im.chat.mute","/api-reference/chats/special-operations/im-dialog-read-all":"im.dialog.read.all","/api-reference/chats/special-operations/im-recent-hide":"im.recent.hide","/api-reference/chats/special-operations/im-recent-pin":"im.recent.pin","/api-reference/chats/special-operations/im-recent-unread":"im.recent.unread","/api-reference/chats/users/im-user-get":"im.user.get","/api-reference/chats/users/im-user-list-get":"im.user.list.get","/api-reference/chats/users/im-user-status-get":"im.user.status.get","/api-reference/chats/users/im-user-status-idle-end":"im.user.status.idle.end","/api-reference/chats/users/im-user-status-idle-start":"im.user.status.idle.start","/api-reference/chats/users/im-user-status-set":"im.user.status.set","/api-reference/common/settings/app-option-get":"app.option.get","/api-reference/common/settings/app-option-set":"app.option.set","/api-reference/common/settings/user-option-get":"user.option.get","/api-reference/common/settings/user-option-set":"user.option.set","/api-reference/common/system/access-name":"access.name","/api-reference/common/system/app-info":"app.info","/api-reference/common/system/feature-get":"feature.get","/api-reference/common/system/method-get":"method.get","/api-reference/common/system/server-time":"server.time","/api-reference/common/users/user-access":"user.access","/api-reference/common/users/user-admin":"user.admin","/api-reference/crm/automated-solution/crm-automated-solution-add":"crm.automatedsolution.add","/api-reference/crm/automated-solution/crm-automated-solution-delete":"crm.automatedsolution.delete","/api-reference/crm/automated-solution/crm-automated-solution-fields":"crm.automatedsolution.fields","/api-reference/crm/automated-solution/crm-automated-solution-get":"crm.automatedsolution.get","/api-reference/crm/automated-solution/crm-automated-solution-list":"crm.automatedsolution.list","/api-reference/crm/automated-solution/crm-automated-solution-update":"crm.automatedsolution.update","/api-reference/crm/automation/crm-automation-trigger":"crm.automation.trigger","/api-reference/crm/automation/triggers/crm-automation-trigger-add":"crm.automation.trigger.add","/api-reference/crm/automation/triggers/crm-automation-trigger-delete":"crm.automation.trigger.delete","/api-reference/crm/automation/triggers/crm-automation-trigger-execute":"crm.automation.trigger.execute","/api-reference/crm/auxiliary/enum/crm-enum-address-type":"crm.enum.addresstype","/api-reference/crm/auxiliary/enum/crm-enum-fields":"crm.enum.fields","/api-reference/crm/auxiliary/enum/crm-enum-get-order-owner-types":"crm.enum.getorderownertypes","/api-reference/crm/auxiliary/enum/crm-enum-owner-type":"crm.enum.ownertype","/api-reference/crm/auxiliary/enum/crm-enum-settings-mode":"crm.enum.settings.mode","/api-reference/crm/auxiliary/enum/outdated/crm-enum-activity-direction":"crm.enum.activitydirection","/api-reference/crm/auxiliary/enum/outdated/crm-enum-activity-notify-type":"crm.enum.activitynotifytype","/api-reference/crm/auxiliary/enum/outdated/crm-enum-activity-priority":"crm.enum.activitypriority","/api-reference/crm/auxiliary/enum/outdated/crm-enum-activity-status":"crm.enum.activitystatus","/api-reference/crm/auxiliary/enum/outdated/crm-enum-activity-type":"crm.enum.activitytype","/api-reference/crm/auxiliary/enum/outdated/crm-enum-content-type":"crm.enum.contenttype","/api-reference/crm/auxiliary/multifield/crm-multifield-fields":"crm.multifield.fields","/api-reference/crm/call-list/crm-calllist-add":"crm.calllist.add","/api-reference/crm/call-list/crm-calllist-get":"crm.calllist.get","/api-reference/crm/call-list/crm-calllist-items-get":"crm.calllist.items.get","/api-reference/crm/call-list/crm-calllist-list":"crm.calllist.list","/api-reference/crm/call-list/crm-calllist-statuslist":"crm.calllist.statuslist","/api-reference/crm/call-list/crm-calllist-update":"crm.calllist.update","/api-reference/crm/companies/contacts/crm-company-contact-add":"crm.company.contact.add","/api-reference/crm/companies/contacts/crm-company-contact-delete":"crm.company.contact.delete","/api-reference/crm/companies/contacts/crm-company-contact-fields":"crm.company.contact.fields","/api-reference/crm/companies/contacts/crm-company-contact-items-delete":"crm.company.contact.items.delete","/api-reference/crm/companies/contacts/crm-company-contact-items-get":"crm.company.contact.items.get","/api-reference/crm/companies/contacts/crm-company-contact-items-set":"crm.company.contact.items.set","/api-reference/crm/companies/crm-company-add":"crm.company.add","/api-reference/crm/companies/crm-company-delete":"crm.company.delete","/api-reference/crm/companies/crm-company-fields":"crm.company.fields","/api-reference/crm/companies/crm-company-get":"crm.company.get","/api-reference/crm/companies/crm-company-list":"crm.company.list","/api-reference/crm/companies/crm-company-update":"crm.company.update","/api-reference/crm/companies/custom-form/crm-company-details-configuration-force-common-scope-for-all":"crm.company.details.configuration.forceCommonScopeForAll","/api-reference/crm/companies/custom-form/crm-company-details-configuration-get":"crm.company.details.configuration.get","/api-reference/crm/companies/custom-form/crm-company-details-configuration-reset":"crm.company.details.configuration.reset","/api-reference/crm/companies/custom-form/crm-company-details-configuration-set":"crm.company.details.configuration.set","/api-reference/crm/companies/userfields/crm-company-userfield-add":"crm.company.userfield.add","/api-reference/crm/companies/userfields/crm-company-userfield-delete":"crm.company.userfield.delete","/api-reference/crm/companies/userfields/crm-company-userfield-get":"crm.company.userfield.get","/api-reference/crm/companies/userfields/crm-company-userfield-list":"crm.company.userfield.list","/api-reference/crm/companies/userfields/crm-company-userfield-update":"crm.company.userfield.update","/api-reference/crm/contacts/company/crm-contact-company-add":"crm.contact.company.add","/api-reference/crm/contacts/company/crm-contact-company-delete":"crm.contact.company.delete","/api-reference/crm/contacts/company/crm-contact-company-items-delete":"crm.contact.company.items.delete","/api-reference/crm/contacts/company/crm-contact-company-items-get":"crm.contact.company.items.get","/api-reference/crm/contacts/company/crm-contact-company-items-set":"crm.contact.company.items.set","/api-reference/crm/contacts/crm-contact-add":"crm.contact.add","/api-reference/crm/contacts/crm-contact-delete":"crm.contact.delete","/api-reference/crm/contacts/crm-contact-get":"crm.contact.get","/api-reference/crm/contacts/crm-contact-list":"crm.contact.list","/api-reference/crm/contacts/crm-contact-update":"crm.contact.update","/api-reference/crm/contacts/custom-form/crm-contact-details-configuration-get":"crm.contact.details.configuration.get","/api-reference/crm/contacts/custom-form/crm-contact-details-configuration-reset":"crm.contact.details.configuration.reset","/api-reference/crm/contacts/custom-form/crm-contact-details-configuration-set":"crm.contact.details.configuration.set","/api-reference/crm/contacts/userfield/crm-contact-userfield-add":"crm.contact.userfield.add","/api-reference/crm/contacts/userfield/crm-contact-userfield-delete":"crm.contact.userfield.delete","/api-reference/crm/contacts/userfield/crm-contact-userfield-get":"crm.contact.userfield.get","/api-reference/crm/contacts/userfield/crm-contact-userfield-list":"crm.contact.userfield.list","/api-reference/crm/contacts/userfield/crm-contact-userfield-update":"crm.contact.userfield.update","/api-reference/crm/crm-settings-mode-get":"crm.settings.mode.get","/api-reference/crm/crm-stage-history-list":"crm.stagehistory.list","/api-reference/crm/currency/crm-currency-add":"crm.currency.add","/api-reference/crm/currency/crm-currency-base-set":"crm.currency.base.set","/api-reference/crm/currency/crm-currency-delete":"crm.currency.delete","/api-reference/crm/currency/crm-currency-get":"crm.currency.get","/api-reference/crm/currency/crm-currency-list":"crm.currency.list","/api-reference/crm/currency/crm-currency-update":"crm.currency.update","/api-reference/crm/currency/localizations/crm-currency-localizations-delete":"crm.currency.localizations.delete","/api-reference/crm/currency/localizations/crm-currency-localizations-get":"crm.currency.localizations.get","/api-reference/crm/currency/localizations/crm-currency-localizations-set":"crm.currency.localizations.set","/api-reference/crm/deals/contacts/crm-deal-contact-add":"crm.deal.contact.add","/api-reference/crm/deals/contacts/crm-deal-contact-delete":"crm.deal.contact.delete","/api-reference/crm/deals/contacts/crm-deal-contact-fields":"crm.deal.contact.fields","/api-reference/crm/deals/contacts/crm-deal-contact-items-delete":"crm.deal.contact.items.delete","/api-reference/crm/deals/contacts/crm-deal-contact-items-get":"crm.deal.contact.items.get","/api-reference/crm/deals/contacts/crm-deal-contact-items-set":"crm.deal.contact.items.set","/api-reference/crm/deals/crm-deal-add":"crm.deal.add","/api-reference/crm/deals/crm-deal-delete":"crm.deal.delete","/api-reference/crm/deals/crm-deal-fields":"crm.deal.fields","/api-reference/crm/deals/crm-deal-get":"crm.deal.get","/api-reference/crm/deals/crm-deal-list":"crm.deal.list","/api-reference/crm/deals/crm-deal-update":"crm.deal.update","/api-reference/crm/deals/custom-form/crm-deal-details-configuration-force-common-scope-for-all":"crm.deal.details.configuration.forceCommonScopeForAll","/api-reference/crm/deals/custom-form/crm-deal-details-configuration-get":"crm.deal.details.configuration.get","/api-reference/crm/deals/custom-form/crm-deal-details-configuration-reset":"crm.deal.details.configuration.reset","/api-reference/crm/deals/custom-form/crm-deal-details-configuration-set":"crm.deal.details.configuration.set","/api-reference/crm/deals/recurring-deals/crm-deal-recurring-add":"crm.deal.recurring.add","/api-reference/crm/deals/recurring-deals/crm-deal-recurring-delete":"crm.deal.recurring.delete","/api-reference/crm/deals/recurring-deals/crm-deal-recurring-expose":"crm.deal.recurring.expose","/api-reference/crm/deals/recurring-deals/crm-deal-recurring-fields":"crm.deal.recurring.fields","/api-reference/crm/deals/recurring-deals/crm-deal-recurring-get":"crm.deal.recurring.get","/api-reference/crm/deals/recurring-deals/crm-deal-recurring-list":"crm.deal.recurring.list","/api-reference/crm/deals/recurring-deals/crm-deal-recurring-update":"crm.deal.recurring.update","/api-reference/crm/deals/user-defined-fields/crm-deal-userfield-add":"crm.deal.userfield.add","/api-reference/crm/deals/user-defined-fields/crm-deal-userfield-delete":"crm.deal.userfield.delete","/api-reference/crm/deals/user-defined-fields/crm-deal-userfield-get":"crm.deal.userfield.get","/api-reference/crm/deals/user-defined-fields/crm-deal-userfield-list":"crm.deal.userfield.list","/api-reference/crm/deals/user-defined-fields/crm-deal-userfield-update":"crm.deal.userfield.update","/api-reference/crm/document-generator/documents/crm-document-generator-document-add":"crm.documentgenerator.document.add","/api-reference/crm/document-generator/documents/crm-document-generator-document-delete":"crm.documentgenerator.document.delete","/api-reference/crm/document-generator/documents/crm-document-generator-document-enable-public-url":"crm.documentgenerator.document.enablepublicurl","/api-reference/crm/document-generator/documents/crm-document-generator-document-get-fields":"crm.documentgenerator.document.getfields","/api-reference/crm/document-generator/documents/crm-document-generator-document-get":"crm.documentgenerator.document.get","/api-reference/crm/document-generator/documents/crm-document-generator-document-list":"crm.documentgenerator.document.list","/api-reference/crm/document-generator/documents/crm-document-generator-document-update":"crm.documentgenerator.document.update","/api-reference/crm/document-generator/documents/crm-document-generator-document-upload":"crm.documentgenerator.document.upload","/api-reference/crm/document-generator/numerator/crm-document-generator-numerator-add":"crm.documentgenerator.numerator.add","/api-reference/crm/document-generator/numerator/crm-document-generator-numerator-delete":"crm.documentgenerator.numerator.delete","/api-reference/crm/document-generator/numerator/crm-document-generator-numerator-get":"crm.documentgenerator.numerator.get","/api-reference/crm/document-generator/numerator/crm-document-generator-numerator-list":"crm.documentgenerator.numerator.list","/api-reference/crm/document-generator/numerator/crm-document-generator-numerator-update":"crm.documentgenerator.numerator.update","/api-reference/crm/document-generator/templates/crm-document-generator-template-add":"crm.documentgenerator.template.add","/api-reference/crm/document-generator/templates/crm-document-generator-template-delete":"crm.documentgenerator.template.delete","/api-reference/crm/document-generator/templates/crm-document-generator-template-get-fields":"crm.documentgenerator.template.getfields","/api-reference/crm/document-generator/templates/crm-document-generator-template-get":"crm.documentgenerator.template.get","/api-reference/crm/document-generator/templates/crm-document-generator-template-list":"crm.documentgenerator.template.list","/api-reference/crm/document-generator/templates/crm-document-generator-template-update":"crm.documentgenerator.template.update","/api-reference/crm/duplicates/crm-duplicate-find-by-comm":"crm.duplicate.findbycomm","/api-reference/crm/duplicates/crm-entity-merge-batch":"crm.entity.mergeBatch","/api-reference/crm/duplicates/volatile-type/crm-duplicate-volatile-type-fields":"crm.duplicate.volatileType.fields","/api-reference/crm/duplicates/volatile-type/crm-duplicate-volatile-type-list":"crm.duplicate.volatileType.list","/api-reference/crm/duplicates/volatile-type/crm-duplicate-volatile-type-register":"crm.duplicate.volatileType.register","/api-reference/crm/duplicates/volatile-type/crm-duplicate-volatile-type-unregister":"crm.duplicate.volatileType.unregister","/api-reference/crm/leads/crm-lead-add":"crm.lead.add","/api-reference/crm/leads/crm-lead-delete":"crm.lead.delete","/api-reference/crm/leads/crm-lead-fields":"crm.lead.fields","/api-reference/crm/leads/crm-lead-get":"crm.lead.get","/api-reference/crm/leads/crm-lead-list":"crm.lead.list","/api-reference/crm/leads/crm-lead-productrows-get":"crm.lead.productrows.get","/api-reference/crm/leads/crm-lead-productrows-set":"crm.lead.productrows.set","/api-reference/crm/leads/crm-lead-update":"crm.lead.update","/api-reference/crm/leads/custom-form/crm-lead-details-configuration-force-common-scope-for-all":"crm.lead.details.configuration.forceCommonScopeForAll","/api-reference/crm/leads/custom-form/crm-lead-details-configuration-get":"crm.lead.details.configuration.get","/api-reference/crm/leads/custom-form/crm-lead-details-configuration-reset":"crm.lead.details.configuration.reset","/api-reference/crm/leads/custom-form/crm-lead-details-configuration-set":"crm.lead.details.configuration.set","/api-reference/crm/leads/management-communication/crm-lead-contact-add":"crm.lead.contact.add","/api-reference/crm/leads/management-communication/crm-lead-contact-delete":"crm.lead.contact.delete","/api-reference/crm/leads/management-communication/crm-lead-contact-items-delete":"crm.lead.contact.items.delete","/api-reference/crm/leads/management-communication/crm-lead-contact-items-get":"crm.lead.contact.items.get","/api-reference/crm/leads/management-communication/crm-lead-contact-items-set":"crm.lead.contact.items.set","/api-reference/crm/leads/userfield/crm-lead-userfield-add":"crm.lead.userfield.add","/api-reference/crm/leads/userfield/crm-lead-userfield-delete":"crm.lead.userfield.delete","/api-reference/crm/leads/userfield/crm-lead-userfield-get":"crm.lead.userfield.get","/api-reference/crm/leads/userfield/crm-lead-userfield-list":"crm.lead.userfield.list","/api-reference/crm/leads/userfield/crm-lead-userfield-update":"crm.lead.userfield.update","/api-reference/crm/outdated/catalog/crm-catalog-get":"crm.catalog.get","/api-reference/crm/outdated/category-old/crm-deal-category-add":"crm.dealcategory.add","/api-reference/crm/outdated/category-old/crm-deal-category-default-set":"crm.dealcategory.default.set","/api-reference/crm/outdated/category-old/crm-deal-category-delete":"crm.dealcategory.delete","/api-reference/crm/outdated/category-old/crm-deal-category-get":"crm.dealcategory.get","/api-reference/crm/outdated/category-old/crm-deal-category-stage-list":"crm.dealcategory.stage.list","/api-reference/crm/outdated/category-old/crm-deal-category-update":"crm.dealcategory.update","/api-reference/crm/outdated/invoice-status-old/crm-invoice-status-add":"crm.invoice.status.add","/api-reference/crm/outdated/invoice-status-old/crm-invoice-status-delete":"crm.invoice.status.delete","/api-reference/crm/outdated/invoice-status-old/crm-invoice-status-get":"crm.invoice.status.get","/api-reference/crm/outdated/invoice-status-old/crm-invoice-status-update":"crm.invoice.status.update","/api-reference/crm/outdated/invoice/crm-invoice-add":"crm.invoice.add","/api-reference/crm/outdated/invoice/crm-invoice-delete":"crm.invoice.delete","/api-reference/crm/outdated/invoice/crm-invoice-get-external-link":"crm.invoice.getexternallink","/api-reference/crm/outdated/invoice/crm-invoice-get":"crm.invoice.get","/api-reference/crm/outdated/invoice/crm-invoice-list":"crm.invoice.list","/api-reference/crm/outdated/invoice/crm-invoice-recurring-add":"crm.invoice.recurring.add","/api-reference/crm/outdated/invoice/crm-invoice-recurring-delete":"crm.invoice.recurring.delete","/api-reference/crm/outdated/invoice/crm-invoice-recurring-expose":"crm.invoice.recurring.expose","/api-reference/crm/outdated/invoice/crm-invoice-recurring-get":"crm.invoice.recurring.get","/api-reference/crm/outdated/invoice/crm-invoice-recurring-update":"crm.invoice.recurring.update","/api-reference/crm/outdated/invoice/crm-invoice-update":"crm.invoice.update","/api-reference/crm/outdated/invoice/crm-invoice-user-field-add":"crm.invoice.userfield.add","/api-reference/crm/outdated/invoice/crm-invoice-user-field-delete":"crm.invoice.userfield.delete","/api-reference/crm/outdated/invoice/crm-invoice-user-field-get":"crm.invoice.userfield.get","/api-reference/crm/outdated/invoice/crm-invoice-user-field-list":"crm.invoice.userfield.list","/api-reference/crm/outdated/invoice/crm-invoice-user-field-update":"crm.invoice.userfield.update","/api-reference/crm/outdated/measure/crm-measure-add":"crm.measure.add","/api-reference/crm/outdated/measure/crm-measure-delete":"crm.measure.delete","/api-reference/crm/outdated/measure/crm-measure-get":"crm.measure.get","/api-reference/crm/outdated/measure/crm-measure-update":"crm.measure.update","/api-reference/crm/outdated/product-section/crm-product-section-add":"crm.productsection.add","/api-reference/crm/outdated/product-section/crm-product-section-delete":"crm.productsection.delete","/api-reference/crm/outdated/product-section/crm-product-section-get":"crm.productsection.get","/api-reference/crm/outdated/product-section/crm-product-section-list":"crm.productsection.list","/api-reference/crm/outdated/product-section/crm-product-section-update":"crm.productsection.update","/api-reference/crm/outdated/products/crm-product-add":"crm.product.add","/api-reference/crm/outdated/products/crm-product-delete":"crm.product.delete","/api-reference/crm/outdated/products/crm-product-get":"crm.product.get","/api-reference/crm/outdated/products/crm-product-property-add":"crm.product.property.add","/api-reference/crm/outdated/products/crm-product-property-delete":"crm.product.property.delete","/api-reference/crm/outdated/products/crm-product-property-get":"crm.product.property.get","/api-reference/crm/outdated/products/crm-product-property-list":"crm.product.property.list","/api-reference/crm/outdated/products/crm-product-property-settings-fields":"crm.product.property.settings.fields","/api-reference/crm/outdated/products/crm-product-property-update":"crm.product.property.update","/api-reference/crm/outdated/products/crm-product-update":"crm.product.update","/api-reference/crm/outdated/vat/crm-vat-add":"crm.vat.add","/api-reference/crm/outdated/vat/crm-vat-delete":"crm.vat.delete","/api-reference/crm/outdated/vat/crm-vat-fields":"crm.vat.fields","/api-reference/crm/outdated/vat/crm-vat-get":"crm.vat.get","/api-reference/crm/outdated/vat/crm-vat-list":"crm.vat.list","/api-reference/crm/outdated/vat/crm-vat-update":"crm.vat.update","/api-reference/crm/quote/contacts/crm-quote-contact-add":"crm.quote.contact.add","/api-reference/crm/quote/contacts/crm-quote-contact-delete":"crm.quote.contact.delete","/api-reference/crm/quote/contacts/crm-quote-contact-fields":"crm.quote.contact.fields","/api-reference/crm/quote/contacts/crm-quote-contact-items-delete":"crm.quote.contact.items.delete","/api-reference/crm/quote/contacts/crm-quote-contact-items-get":"crm.quote.contact.items.get","/api-reference/crm/quote/contacts/crm-quote-contact-items-set":"crm.quote.contact.items.set","/api-reference/crm/quote/crm-quote-add":"crm.quote.add","/api-reference/crm/quote/crm-quote-delete":"crm.quote.delete","/api-reference/crm/quote/crm-quote-fields":"crm.quote.fields","/api-reference/crm/quote/crm-quote-get":"crm.quote.get","/api-reference/crm/quote/crm-quote-list":"crm.quote.list","/api-reference/crm/quote/crm-quote-product-rows-get":"crm.quote.productrows.get","/api-reference/crm/quote/crm-quote-product-rows-set":"crm.quote.productrows.set","/api-reference/crm/quote/crm-quote-update":"crm.quote.update","/api-reference/crm/quote/user-field/crm-quote-user-field-add":"crm.quote.userfield.add","/api-reference/crm/quote/user-field/crm-quote-user-field-delete":"crm.quote.userfield.delete","/api-reference/crm/quote/user-field/crm-quote-user-field-get":"crm.quote.userfield.get","/api-reference/crm/quote/user-field/crm-quote-user-field-list":"crm.quote.userfield.list","/api-reference/crm/quote/user-field/crm-quote-user-field-update":"crm.quote.userfield.update","/api-reference/crm/requisites/addresses/crm-address-add":"crm.address.add","/api-reference/crm/requisites/addresses/crm-address-delete":"crm.address.delete","/api-reference/crm/requisites/addresses/crm-address-list":"crm.address.list","/api-reference/crm/requisites/addresses/crm-address-update":"crm.address.update","/api-reference/crm/requisites/bank-detail/crm-requisite-bank-detail-add":"crm.requisite.bankdetail.add","/api-reference/crm/requisites/bank-detail/crm-requisite-bank-detail-delete":"crm.requisite.bankdetail.delete","/api-reference/crm/requisites/bank-detail/crm-requisite-bank-detail-get":"crm.requisite.bankdetail.get","/api-reference/crm/requisites/bank-detail/crm-requisite-bank-detail-list":"crm.requisite.bankdetail.list","/api-reference/crm/requisites/bank-detail/crm-requisite-bank-detail-update":"crm.requisite.bankdetail.update","/api-reference/crm/requisites/links/crm-requisite-link-get":"crm.requisite.link.get","/api-reference/crm/requisites/links/crm-requisite-link-list":"crm.requisite.link.list","/api-reference/crm/requisites/links/crm-requisite-link-register":"crm.requisite.link.register","/api-reference/crm/requisites/links/crm-requisite-link-unregister":"crm.requisite.link.unregister","/api-reference/crm/requisites/presets/crm-requisite-preset-add":"crm.requisite.preset.add","/api-reference/crm/requisites/presets/crm-requisite-preset-delete":"crm.requisite.preset.delete","/api-reference/crm/requisites/presets/crm-requisite-preset-get":"crm.requisite.preset.get","/api-reference/crm/requisites/presets/crm-requisite-preset-list":"crm.requisite.preset.list","/api-reference/crm/requisites/presets/crm-requisite-preset-update":"crm.requisite.preset.update","/api-reference/crm/requisites/presets/fields/crm-requisite-preset-field-add":"crm.requisite.preset.field.add","/api-reference/crm/requisites/presets/fields/crm-requisite-preset-field-available-to-add":"crm.requisite.preset.field.availabletoadd","/api-reference/crm/requisites/presets/fields/crm-requisite-preset-field-delete":"crm.requisite.preset.field.delete","/api-reference/crm/requisites/presets/fields/crm-requisite-preset-field-get":"crm.requisite.preset.field.get","/api-reference/crm/requisites/presets/fields/crm-requisite-preset-field-list":"crm.requisite.preset.field.list","/api-reference/crm/requisites/presets/fields/crm-requisite-preset-field-update":"crm.requisite.preset.field.update","/api-reference/crm/requisites/universal/crm-requisite-add":"crm.requisite.add","/api-reference/crm/requisites/universal/crm-requisite-delete":"crm.requisite.delete","/api-reference/crm/requisites/universal/crm-requisite-get":"crm.requisite.get","/api-reference/crm/requisites/universal/crm-requisite-list":"crm.requisite.list","/api-reference/crm/requisites/universal/crm-requisite-update":"crm.requisite.update","/api-reference/crm/requisites/user-fields/crm-requisite-userfield-add":"crm.requisite.userfield.add","/api-reference/crm/requisites/user-fields/crm-requisite-userfield-delete":"crm.requisite.userfield.delete","/api-reference/crm/requisites/user-fields/crm-requisite-userfield-get":"crm.requisite.userfield.get","/api-reference/crm/requisites/user-fields/crm-requisite-userfield-list":"crm.requisite.userfield.list","/api-reference/crm/requisites/user-fields/crm-requisite-userfield-update":"crm.requisite.userfield.update","/api-reference/crm/status/crm-status-add":"crm.status.add","/api-reference/crm/status/crm-status-delete":"crm.status.delete","/api-reference/crm/status/crm-status-entity-items":"crm.status.entity.items","/api-reference/crm/status/crm-status-entity-types":"crm.status.entity.types","/api-reference/crm/status/crm-status-fields":"crm.status.fields","/api-reference/crm/status/crm-status-get":"crm.status.get","/api-reference/crm/status/crm-status-list":"crm.status.list","/api-reference/crm/status/crm-status-update":"crm.status.update","/api-reference/crm/timeline/actions/crm-timeline-item-pin":"crm.timeline.item.pin","/api-reference/crm/timeline/actions/crm-timeline-item-unpin":"crm.timeline.item.unpin","/api-reference/crm/timeline/activities/activity-base/crm-activity-add":"crm.activity.add","/api-reference/crm/timeline/activities/activity-base/crm-activity-call-get-transcript":"crm.activity.call.getTranscript","/api-reference/crm/timeline/activities/activity-base/crm-activity-communication-fields":"crm.activity.communication.fields","/api-reference/crm/timeline/activities/activity-base/crm-activity-delete":"crm.activity.delete","/api-reference/crm/timeline/activities/activity-base/crm-activity-fields":"crm.activity.fields","/api-reference/crm/timeline/activities/activity-base/crm-activity-get":"crm.activity.get","/api-reference/crm/timeline/activities/activity-base/crm-activity-list":"crm.activity.list","/api-reference/crm/timeline/activities/activity-base/crm-activity-update":"crm.activity.update","/api-reference/crm/timeline/activities/binding/crm-activity-binding-add":"crm.activity.binding.add","/api-reference/crm/timeline/activities/binding/crm-activity-binding-delete":"crm.activity.binding.delete","/api-reference/crm/timeline/activities/binding/crm-activity-binding-list":"crm.activity.binding.list","/api-reference/crm/timeline/activities/binding/crm-activity-binding-move":"crm.activity.binding.move","/api-reference/crm/timeline/activities/configurable/badges/crm-activity-badge-add":"crm.activity.badge.add","/api-reference/crm/timeline/activities/configurable/badges/crm-activity-badge-delete":"crm.activity.badge.delete","/api-reference/crm/timeline/activities/configurable/badges/crm-activity-badge-get":"crm.activity.badge.get","/api-reference/crm/timeline/activities/configurable/badges/crm-activity-badge-list":"crm.activity.badge.list","/api-reference/crm/timeline/activities/configurable/crm-activity-configurable-add":"crm.activity.configurable.add","/api-reference/crm/timeline/activities/configurable/crm-activity-configurable-get":"crm.activity.configurable.get","/api-reference/crm/timeline/activities/configurable/crm-activity-configurable-update":"crm.activity.configurable.update","/api-reference/crm/timeline/activities/layout-blocks/crm-activity-layout-blocks-delete":"crm.activity.layout.blocks.delete","/api-reference/crm/timeline/activities/layout-blocks/crm-activity-layout-blocks-get":"crm.activity.layout.blocks.get","/api-reference/crm/timeline/activities/layout-blocks/crm-activity-layout-blocks-set":"crm.activity.layout.blocks.set","/api-reference/crm/timeline/activities/todo/crm-activity-todo-add":"crm.activity.todo.add","/api-reference/crm/timeline/activities/todo/crm-activity-todo-update-color":"crm.activity.todo.updateColor","/api-reference/crm/timeline/activities/todo/crm-activity-todo-update-deadline":"crm.activity.todo.updateDeadline","/api-reference/crm/timeline/activities/todo/crm-activity-todo-update-description":"crm.activity.todo.updateDescription","/api-reference/crm/timeline/activities/todo/crm-activity-todo-update-responsible-user":"crm.activity.todo.updateResponsibleUser","/api-reference/crm/timeline/activities/todo/crm-activity-todo-update":"crm.activity.todo.update","/api-reference/crm/timeline/activities/types/crm-activity-type-add":"crm.activity.type.add","/api-reference/crm/timeline/activities/types/crm-activity-type-delete":"crm.activity.type.delete","/api-reference/crm/timeline/activities/types/crm-activity-type-list":"crm.activity.type.list","/api-reference/crm/timeline/bindings/crm-timeline-bindings-bind":"crm.timeline.bindings.bind","/api-reference/crm/timeline/bindings/crm-timeline-bindings-fields":"crm.timeline.bindings.fields","/api-reference/crm/timeline/bindings/crm-timeline-bindings-list":"crm.timeline.bindings.list","/api-reference/crm/timeline/bindings/crm-timeline-bindings-unbind":"crm.timeline.bindings.unbind","/api-reference/crm/timeline/comments/crm-timeline-comment-add":"crm.timeline.comment.add","/api-reference/crm/timeline/comments/crm-timeline-comment-delete":"crm.timeline.comment.delete","/api-reference/crm/timeline/comments/crm-timeline-comment-get":"crm.timeline.comment.get","/api-reference/crm/timeline/comments/crm-timeline-comment-list":"crm.timeline.comment.list","/api-reference/crm/timeline/comments/crm-timeline-comment-update":"crm.timeline.comment.update","/api-reference/crm/timeline/layout-blocks/crm-timeline-layout-blocks-delete":"crm.timeline.layout.blocks.delete","/api-reference/crm/timeline/layout-blocks/crm-timeline-layout-blocks-get":"crm.timeline.layout.blocks.get","/api-reference/crm/timeline/layout-blocks/crm-timeline-layout-blocks-set":"crm.timeline.layout.blocks.set","/api-reference/crm/timeline/logmessage/crm-timeline-logmessage-add":"crm.timeline.logmessage.add","/api-reference/crm/timeline/logmessage/crm-timeline-logmessage-delete":"crm.timeline.logmessage.delete","/api-reference/crm/timeline/logmessage/crm-timeline-logmessage-get":"crm.timeline.logmessage.get","/api-reference/crm/timeline/logmessage/crm-timeline-logmessage-list":"crm.timeline.logmessage.list","/api-reference/crm/timeline/logmessage/icons/crm-timeline-icon-add":"crm.timeline.icon.add","/api-reference/crm/timeline/logmessage/icons/crm-timeline-icon-delete":"crm.timeline.icon.delete","/api-reference/crm/timeline/logmessage/icons/crm-timeline-icon-get":"crm.timeline.icon.get","/api-reference/crm/timeline/logmessage/logo/crm-timeline-logo-add":"crm.timeline.logo.add","/api-reference/crm/timeline/logmessage/logo/crm-timeline-logo-delete":"crm.timeline.logo.delete","/api-reference/crm/timeline/logmessage/logo/crm-timeline-logo-get":"crm.timeline.logo.get","/api-reference/crm/timeline/note/crm-timeline-note-delete":"crm.timeline.note.delete","/api-reference/crm/timeline/note/crm-timeline-note-get":"crm.timeline.note.get","/api-reference/crm/timeline/note/crm-timeline-note-save":"crm.timeline.note.save","/api-reference/crm/tracking/crm-tracking-trace-add":"crm.tracking.trace.add","/api-reference/crm/tracking/crm-tracking-trace-delete":"crm.tracking.trace.delete","/api-reference/crm/universal/category/crm-category-add":"crm.category.add","/api-reference/crm/universal/category/crm-category-delete":"crm.category.delete","/api-reference/crm/universal/category/crm-category-fields":"crm.category.fields","/api-reference/crm/universal/category/crm-category-get":"crm.category.get","/api-reference/crm/universal/category/crm-category-list":"crm.category.list","/api-reference/crm/universal/category/crm-category-update":"crm.category.update","/api-reference/crm/universal/crm-item-add":"crm.item.add","/api-reference/crm/universal/crm-item-delete":"crm.item.delete","/api-reference/crm/universal/crm-item-fields":"crm.item.fields","/api-reference/crm/universal/crm-item-get":"crm.item.get","/api-reference/crm/universal/crm-item-list":"crm.item.list","/api-reference/crm/universal/crm-item-update":"crm.item.update","/api-reference/crm/universal/delivery/crm-item-delivery-get":"crm.item.delivery.get","/api-reference/crm/universal/delivery/crm-item-delivery-list":"crm.item.delivery.list","/api-reference/crm/universal/import/crm-item-batch-import":"crm.item.batchImport","/api-reference/crm/universal/import/crm-item-import":"crm.item.import","/api-reference/crm/universal/item-details-configuration/crm-item-details-configuration-forceCommonScopeForAll":"crm.item.details.configuration.forceCommonScopeForAll","/api-reference/crm/universal/item-details-configuration/crm-item-details-configuration-get":"crm.item.details.configuration.get","/api-reference/crm/universal/item-details-configuration/crm-item-details-configuration-reset":"crm.item.details.configuration.reset","/api-reference/crm/universal/item-details-configuration/crm-item-details-configuration-set":"crm.item.details.configuration.set","/api-reference/crm/universal/order-entity/crm-order-entity-add":"crm.orderentity.add","/api-reference/crm/universal/order-entity/crm-order-entity-delete-by-filter":"crm.orderentity.deleteByFilter","/api-reference/crm/universal/order-entity/crm-order-entity-list":"crm.orderentity.list","/api-reference/crm/universal/payment/crm-item-payment-add":"crm.item.payment.add","/api-reference/crm/universal/payment/crm-item-payment-delete":"crm.item.payment.delete","/api-reference/crm/universal/payment/crm-item-payment-get":"crm.item.payment.get","/api-reference/crm/universal/payment/crm-item-payment-list":"crm.item.payment.list","/api-reference/crm/universal/payment/crm-item-payment-pay":"crm.item.payment.pay","/api-reference/crm/universal/payment/crm-item-payment-unpay":"crm.item.payment.unpay","/api-reference/crm/universal/payment/crm-item-payment-update":"crm.item.payment.update","/api-reference/crm/universal/payment/delivery-in-payment/crm-item-payment-delivery-add":"crm.item.payment.delivery.add","/api-reference/crm/universal/payment/delivery-in-payment/crm-item-payment-delivery-delete":"crm.item.payment.delivery.delete","/api-reference/crm/universal/payment/delivery-in-payment/crm-item-payment-delivery-list":"crm.item.payment.delivery.list","/api-reference/crm/universal/payment/delivery-in-payment/crm-item-payment-delivery-set-delivery":"crm.item.payment.delivery.setDelivery","/api-reference/crm/universal/payment/products-in-payment/crm-item-payment-product-add":"crm.item.payment.product.add","/api-reference/crm/universal/payment/products-in-payment/crm-item-payment-product-delete":"crm.item.payment.product.delete","/api-reference/crm/universal/payment/products-in-payment/crm-item-payment-product-list":"crm.item.payment.product.list","/api-reference/crm/universal/payment/products-in-payment/crm-item-payment-product-set-quantity":"crm.item.payment.product.setQuantity","/api-reference/crm/universal/payment/salescenter-payment-get-public-url":"salescenter.payment.getPublicUrl","/api-reference/crm/universal/product-rows/crm-item-productrow-add":"crm.item.productrow.add","/api-reference/crm/universal/product-rows/crm-item-productrow-delete":"crm.item.productrow.delete","/api-reference/crm/universal/product-rows/crm-item-productrow-fields":"crm.item.productrow.fields","/api-reference/crm/universal/product-rows/crm-item-productrow-get-available-for-payment":"crm.item.productrow.getAvailableForPayment","/api-reference/crm/universal/product-rows/crm-item-productrow-get":"crm.item.productrow.get","/api-reference/crm/universal/product-rows/crm-item-productrow-list":"crm.item.productrow.list","/api-reference/crm/universal/product-rows/crm-item-productrow-set":"crm.item.productrow.set","/api-reference/crm/universal/product-rows/crm-item-productrow-update":"crm.item.productrow.update","/api-reference/crm/universal/user-defined-fields/crm-userfield-enumeration-fields":"crm.userfield.enumeration.fields","/api-reference/crm/universal/user-defined-fields/crm-userfield-fields":"crm.userfield.fields","/api-reference/crm/universal/user-defined-fields/crm-userfield-settings-fields":"crm.userfield.settings.fields","/api-reference/crm/universal/user-defined-fields/crm-userfield-types":"crm.userfield.types","/api-reference/crm/universal/user-defined-object-types/crm-type-add":"crm.type.add","/api-reference/crm/universal/user-defined-object-types/crm-type-delete":"crm.type.delete","/api-reference/crm/universal/user-defined-object-types/crm-type-get-by-entity-type-id":"crm.type.getByEntityTypeId","/api-reference/crm/universal/user-defined-object-types/crm-type-get":"crm.type.get","/api-reference/crm/universal/user-defined-object-types/crm-type-list":"crm.type.list","/api-reference/crm/universal/user-defined-object-types/crm-type-update":"crm.type.update","/api-reference/crm/universal/userfieldconfig/userfieldconfig-add":"userfieldconfig.add","/api-reference/crm/universal/userfieldconfig/userfieldconfig-delete":"userfieldconfig.delete","/api-reference/crm/universal/userfieldconfig/userfieldconfig-get-types":"userfieldconfig.getTypes","/api-reference/crm/universal/userfieldconfig/userfieldconfig-get":"userfieldconfig.get","/api-reference/crm/universal/userfieldconfig/userfieldconfig-list":"userfieldconfig.list","/api-reference/crm/universal/userfieldconfig/userfieldconfig-update":"userfieldconfig.update","/api-reference/departments/department-add":"department.add","/api-reference/departments/department-delete":"department.delete","/api-reference/departments/department-get":"department.get","/api-reference/departments/department-update":"department.update","/api-reference/departments/employee/humanresources-employee-count":"humanresources.employee.count","/api-reference/departments/employee/humanresources-employee-field-get":"humanresources.employee.field.get","/api-reference/departments/employee/humanresources-employee-field-list":"humanresources.employee.field.list","/api-reference/departments/employee/humanresources-employee-multidepartment":"humanresources.employee.multidepartment","/api-reference/departments/employee/humanresources-employee-search":"humanresources.employee.search","/api-reference/departments/employee/humanresources-employee-subordinates":"humanresources.employee.subordinates","/api-reference/departments/node-communication/humanresources-node-communication-edit":"humanresources.node.communication.edit","/api-reference/departments/node-communication/humanresources-node-communication-list":"humanresources.node.communication.list","/api-reference/departments/node-member/humanresources-node-member-add":"humanresources.node.member.add","/api-reference/departments/node-member/humanresources-node-member-field-get":"humanresources.node.member.field.get","/api-reference/departments/node-member/humanresources-node-member-field-list":"humanresources.node.member.field.list","/api-reference/departments/node-member/humanresources-node-member-move":"humanresources.node.member.move","/api-reference/departments/node-member/humanresources-node-member-remove":"humanresources.node.member.remove","/api-reference/departments/node-member/humanresources-node-member-set":"humanresources.node.member.set","/api-reference/departments/node/humanresources-node-add":"humanresources.node.add","/api-reference/departments/node/humanresources-node-children":"humanresources.node.children","/api-reference/departments/node/humanresources-node-count":"humanresources.node.count","/api-reference/departments/node/humanresources-node-edit":"humanresources.node.edit","/api-reference/departments/node/humanresources-node-field-get":"humanresources.node.field.get","/api-reference/departments/node/humanresources-node-field-list":"humanresources.node.field.list","/api-reference/departments/node/humanresources-node-get":"humanresources.node.get","/api-reference/departments/node/humanresources-node-list":"humanresources.node.list","/api-reference/departments/node/humanresources-node-move":"humanresources.node.move","/api-reference/departments/node/humanresources-node-search":"humanresources.node.search","/api-reference/disk/attached-object/disk-attached-object-get":"disk.attachedObject.get","/api-reference/disk/file/disk-file-copy-to":"disk.file.copyTo","/api-reference/disk/file/disk-file-delete":"disk.file.delete","/api-reference/disk/file/disk-file-get-external-link":"disk.file.getExternalLink","/api-reference/disk/file/disk-file-get-fields":"disk.file.getFields","/api-reference/disk/file/disk-file-get-versions":"disk.file.getVersions","/api-reference/disk/file/disk-file-get":"disk.file.get","/api-reference/disk/file/disk-file-mark-deleted":"disk.file.markDeleted","/api-reference/disk/file/disk-file-move-to":"disk.file.moveTo","/api-reference/disk/file/disk-file-rename":"disk.file.rename","/api-reference/disk/file/disk-file-restore-from-version":"disk.file.restoreFromVersion","/api-reference/disk/file/disk-file-restore":"disk.file.restore","/api-reference/disk/file/disk-file-search":"disk.file.search","/api-reference/disk/file/disk-file-upload-version":"disk.file.uploadVersion","/api-reference/disk/folder/disk-folder-add-subfolder":"disk.folder.addSubFolder","/api-reference/disk/folder/disk-folder-copy-to":"disk.folder.copyTo","/api-reference/disk/folder/disk-folder-delete-tree":"disk.folder.deleteTree","/api-reference/disk/folder/disk-folder-get-children":"disk.folder.getChildren","/api-reference/disk/folder/disk-folder-get-external-link":"disk.folder.getExternalLink","/api-reference/disk/folder/disk-folder-get-fields":"disk.folder.getFields","/api-reference/disk/folder/disk-folder-get":"disk.folder.get","/api-reference/disk/folder/disk-folder-mark-deleted":"disk.folder.markDeleted","/api-reference/disk/folder/disk-folder-move-to":"disk.folder.moveTo","/api-reference/disk/folder/disk-folder-rename":"disk.folder.rename","/api-reference/disk/folder/disk-folder-restore":"disk.folder.restore","/api-reference/disk/folder/disk-folder-share-to-user":"disk.folder.shareToUser","/api-reference/disk/folder/disk-folder-upload-file":"disk.folder.uploadFile","/api-reference/disk/rights/disk-rights-get-tasks":"disk.rights.getTasks","/api-reference/disk/storage/disk-storage-add-folder":"disk.storage.addFolder","/api-reference/disk/storage/disk-storage-get-children":"disk.storage.getChildren","/api-reference/disk/storage/disk-storage-get-fields":"disk.storage.getFields","/api-reference/disk/storage/disk-storage-get-for-app":"disk.storage.getForApp","/api-reference/disk/storage/disk-storage-get-list":"disk.storage.getList","/api-reference/disk/storage/disk-storage-get-types":"disk.storage.getTypes","/api-reference/disk/storage/disk-storage-get":"disk.storage.get","/api-reference/disk/storage/disk-storage-rename":"disk.storage.rename","/api-reference/disk/storage/disk-storage-upload-file":"disk.storage.uploadFile","/api-reference/disk/version/disk-version-get":"disk.version.get","/api-reference/document-generator/document-generator-document-add":"documentgenerator.document.add","/api-reference/document-generator/document-generator-document-delete":"documentgenerator.document.delete","/api-reference/document-generator/document-generator-document-enable-public-url":"documentgenerator.document.enablepublicurl","/api-reference/document-generator/document-generator-document-get-fields":"documentgenerator.document.getfields","/api-reference/document-generator/document-generator-document-get":"documentgenerator.document.get","/api-reference/document-generator/document-generator-document-list":"documentgenerator.document.list","/api-reference/document-generator/document-generator-document-update":"documentgenerator.document.update","/api-reference/document-generator/numerators/document-generator-numerator-add":"documentgenerator.numerator.add","/api-reference/document-generator/numerators/document-generator-numerator-delete":"documentgenerator.numerator.delete","/api-reference/document-generator/numerators/document-generator-numerator-get":"documentgenerator.numerator.get","/api-reference/document-generator/numerators/document-generator-numerator-list":"documentgenerator.numerator.list","/api-reference/document-generator/numerators/document-generator-numerator-update":"documentgenerator.numerator.update","/api-reference/document-generator/region/document-generator-region-add":"documentgenerator.region.add","/api-reference/document-generator/region/document-generator-region-delete":"documentgenerator.region.delete","/api-reference/document-generator/region/document-generator-region-get":"documentgenerator.region.get","/api-reference/document-generator/region/document-generator-region-list":"documentgenerator.region.list","/api-reference/document-generator/region/document-generator-region-update":"documentgenerator.region.update","/api-reference/document-generator/role/document-generator-role-add":"documentgenerator.role.add","/api-reference/document-generator/role/document-generator-role-delete":"documentgenerator.role.delete","/api-reference/document-generator/role/document-generator-role-fill-accesses":"documentgenerator.role.fillaccesses","/api-reference/document-generator/role/document-generator-role-get":"documentgenerator.role.get","/api-reference/document-generator/role/document-generator-role-list":"documentgenerator.role.list","/api-reference/document-generator/role/document-generator-role-update":"documentgenerator.role.update","/api-reference/document-generator/templates/document-generator-template-add":"documentgenerator.template.add","/api-reference/document-generator/templates/document-generator-template-delete":"documentgenerator.template.delete","/api-reference/document-generator/templates/document-generator-template-get-fields":"documentgenerator.template.getfields","/api-reference/document-generator/templates/document-generator-template-get":"documentgenerator.template.get","/api-reference/document-generator/templates/document-generator-template-list":"documentgenerator.template.list","/api-reference/document-generator/templates/document-generator-template-update":"documentgenerator.template.update","/api-reference/entity/entities/entity-add":"entity.add","/api-reference/entity/entities/entity-delete":"entity.delete","/api-reference/entity/entities/entity-get":"entity.get","/api-reference/entity/entities/entity-rights":"entity.rights","/api-reference/entity/entities/entity-update":"entity.update","/api-reference/entity/items/entity-item-add":"entity.item.add","/api-reference/entity/items/entity-item-delete":"entity.item.delete","/api-reference/entity/items/entity-item-get":"entity.item.get","/api-reference/entity/items/entity-item-update":"entity.item.update","/api-reference/entity/items/properties/entity-item-property-add":"entity.item.property.add","/api-reference/entity/items/properties/entity-item-property-delete":"entity.item.property.delete","/api-reference/entity/items/properties/entity-item-property-get":"entity.item.property.get","/api-reference/entity/items/properties/entity-item-property-update":"entity.item.property.update","/api-reference/entity/sections/entity-section-add":"entity.section.add","/api-reference/entity/sections/entity-section-delete":"entity.section.delete","/api-reference/entity/sections/entity-section-get":"entity.section.get","/api-reference/entity/sections/entity-section-update":"entity.section.update","/api-reference/event-log/main-eventlog-field-get":"main.eventlog.field.get","/api-reference/event-log/main-eventlog-field-list":"main.eventlog.field.list","/api-reference/event-log/main-eventlog-get":"main.eventlog.get","/api-reference/event-log/main-eventlog-list":"main.eventlog.list","/api-reference/event-log/main-eventlog-tail":"main.eventlog.tail","/api-reference/events/event-bind":"event.bind","/api-reference/events/event-offline-clear":"event.offline.clear","/api-reference/events/event-offline-error":"event.offline.error","/api-reference/events/event-offline-get":"event.offline.get","/api-reference/events/event-offline-list":"event.offline.list","/api-reference/events/event-unbind":"event.unbind","/api-reference/imopenlines/imconnector/imconnector-activate":"imconnector.activate","/api-reference/imopenlines/imconnector/imconnector-chat-name-set":"imconnector.chat.name.set","/api-reference/imopenlines/imconnector/imconnector-connector-data-set":"imconnector.connector.data.set","/api-reference/imopenlines/imconnector/imconnector-delete-messages":"imconnector.delete.messages","/api-reference/imopenlines/imconnector/imconnector-list":"imconnector.list","/api-reference/imopenlines/imconnector/imconnector-register":"imconnector.register","/api-reference/imopenlines/imconnector/imconnector-send-messages":"imconnector.send.messages","/api-reference/imopenlines/imconnector/imconnector-send-status-delivery":"imconnector.send.status.delivery","/api-reference/imopenlines/imconnector/imconnector-send-status-reading":"imconnector.send.status.reading","/api-reference/imopenlines/imconnector/imconnector-status":"imconnector.status","/api-reference/imopenlines/imconnector/imconnector-unregister":"imconnector.unregister","/api-reference/imopenlines/imconnector/imconnector-update-messages":"imconnector.update.messages","/api-reference/imopenlines/openlines/chat-bots/imopenlines-bot-session-finish":"imopenlines.bot.session.finish","/api-reference/imopenlines/openlines/chat-bots/imopenlines-bot-session-message-send":"imopenlines.bot.session.message.send","/api-reference/imopenlines/openlines/chat-bots/imopenlines-bot-session-operator":"imopenlines.bot.session.operator","/api-reference/imopenlines/openlines/chat-bots/imopenlines-bot-session-transfer":"imopenlines.bot.session.transfer","/api-reference/imopenlines/openlines/chats/imopenlines-crm-chat-get-last-id":"imopenlines.crm.chat.getLastId","/api-reference/imopenlines/openlines/chats/imopenlines-crm-chat-get":"imopenlines.crm.chat.get","/api-reference/imopenlines/openlines/chats/imopenlines-crm-chat-user-add":"imopenlines.crm.chat.user.add","/api-reference/imopenlines/openlines/chats/imopenlines-crm-chat-user-delete":"imopenlines.crm.chat.user.delete","/api-reference/imopenlines/openlines/imopenlines-config-add":"imopenlines.config.add","/api-reference/imopenlines/openlines/imopenlines-config-delete":"imopenlines.config.delete","/api-reference/imopenlines/openlines/imopenlines-config-get":"imopenlines.config.get","/api-reference/imopenlines/openlines/imopenlines-config-list-get":"imopenlines.config.list.get","/api-reference/imopenlines/openlines/imopenlines-config-path-get":"imopenlines.config.path.get","/api-reference/imopenlines/openlines/imopenlines-config-update":"imopenlines.config.update","/api-reference/imopenlines/openlines/imopenlines-network-join":"imopenlines.network.join","/api-reference/imopenlines/openlines/imopenlines-network-message-add":"imopenlines.network.message.add","/api-reference/imopenlines/openlines/imopenlines-revision-get":"imopenlines.revision.get","/api-reference/imopenlines/openlines/messages/imopenlines-crm-message-add":"imopenlines.crm.message.add","/api-reference/imopenlines/openlines/messages/imopenlines-message-quick-save":"imopenlines.message.quick.save","/api-reference/imopenlines/openlines/operators/imopenlines-operator-another-finish":"imopenlines.operator.another.finish","/api-reference/imopenlines/openlines/operators/imopenlines-operator-answer":"imopenlines.operator.answer","/api-reference/imopenlines/openlines/operators/imopenlines-operator-finish":"imopenlines.operator.finish","/api-reference/imopenlines/openlines/operators/imopenlines-operator-skip":"imopenlines.operator.skip","/api-reference/imopenlines/openlines/operators/imopenlines-operator-spam":"imopenlines.operator.spam","/api-reference/imopenlines/openlines/operators/imopenlines-operator-transfer":"imopenlines.operator.transfer","/api-reference/imopenlines/openlines/sessions/imopenlines-crm-lead-create":"imopenlines.crm.lead.create","/api-reference/imopenlines/openlines/sessions/imopenlines-dialog-get":"imopenlines.dialog.get","/api-reference/imopenlines/openlines/sessions/imopenlines-message-session-start":"imopenlines.message.session.start","/api-reference/imopenlines/openlines/sessions/imopenlines-session-head-vote":"imopenlines.session.head.vote","/api-reference/imopenlines/openlines/sessions/imopenlines-session-history-get":"imopenlines.session.history.get","/api-reference/imopenlines/openlines/sessions/imopenlines-session-intercept":"imopenlines.session.intercept","/api-reference/imopenlines/openlines/sessions/imopenlines-session-join":"imopenlines.session.join","/api-reference/imopenlines/openlines/sessions/imopenlines-session-mode-pin-all":"imopenlines.session.mode.pinAll","/api-reference/imopenlines/openlines/sessions/imopenlines-session-mode-pin":"imopenlines.session.mode.pin","/api-reference/imopenlines/openlines/sessions/imopenlines-session-mode-silent":"imopenlines.session.mode.silent","/api-reference/imopenlines/openlines/sessions/imopenlines-session-mode-unpin-all":"imopenlines.session.mode.unpinAll","/api-reference/imopenlines/openlines/sessions/imopenlines-session-open":"imopenlines.session.open","/api-reference/imopenlines/openlines/sessions/imopenlines-session-start":"imopenlines.session.start","/api-reference/imopenlines/statistics/imopenlines-v2-operator-list":"imopenlines.v2.Operator.list","/api-reference/imopenlines/statistics/imopenlines-v2-session-list":"imopenlines.v2.Session.list","/api-reference/imopenlines/statistics/imopenlines-v2-session-rating-list":"imopenlines.v2.Session.Rating.list","/api-reference/imopenlines/statistics/imopenlines-v2-session-stat-get":"imopenlines.v2.Session.Stat.get","/api-reference/imopenlines/statistics/imopenlines-v2-session-transfer-list":"imopenlines.v2.Session.Transfer.list","/api-reference/imopenlines/statistics/imopenlines-v2-stat-get":"imopenlines.v2.Stat.get","/api-reference/landing/block/methods/landing-block-add-card":"landing.block.addcard","/api-reference/landing/block/methods/landing-block-change-anchor":"landing.block.changeAnchor","/api-reference/landing/block/methods/landing-block-change-node-name":"landing.block.changeNodeName","/api-reference/landing/block/methods/landing-block-clone-card":"landing.block.clonecard","/api-reference/landing/block/methods/landing-block-get-by-id":"landing.block.getbyid","/api-reference/landing/block/methods/landing-block-get-content-from-repository":"landing.block.getContentFromRepository","/api-reference/landing/block/methods/landing-block-get-content":"landing.block.getcontent","/api-reference/landing/block/methods/landing-block-get-list":"landing.block.getlist","/api-reference/landing/block/methods/landing-block-get-manifest-file":"landing.block.getmanifestfile","/api-reference/landing/block/methods/landing-block-get-manifest":"landing.block.getmanifest","/api-reference/landing/block/methods/landing-block-get-repository":"landing.block.getrepository","/api-reference/landing/block/methods/landing-block-publication":"landing.block.publication","/api-reference/landing/block/methods/landing-block-remove-card":"landing.block.removecard","/api-reference/landing/block/methods/landing-block-update-attrs":"landing.block.updateattrs","/api-reference/landing/block/methods/landing-block-update-cards":"landing.block.updateCards","/api-reference/landing/block/methods/landing-block-update-content":"landing.block.updatecontent","/api-reference/landing/block/methods/landing-block-update-nodes":"landing.block.updatenodes","/api-reference/landing/block/methods/landing-block-update-styles":"landing.block.updateStyles","/api-reference/landing/block/methods/landing-block-upload-file":"landing.block.uploadfile","/api-reference/landing/demos/landing-demos-get-list":"landing.demos.getList","/api-reference/landing/demos/landing-demos-get-page-list":"landing.demos.getPageList","/api-reference/landing/demos/landing-demos-get-site-list":"landing.demos.getSiteList","/api-reference/landing/demos/landing-demos-register":"landing.demos.register","/api-reference/landing/demos/landing-demos-unregister":"landing.demos.unregister","/api-reference/landing/embedding/knowledge-base/landing-site-binding-to-group":"landing.site.bindingToGroup","/api-reference/landing/embedding/knowledge-base/landing-site-binding-to-menu":"landing.site.bindingToMenu","/api-reference/landing/embedding/knowledge-base/landing-site-get-group-bindings":"landing.site.getGroupBindings","/api-reference/landing/embedding/knowledge-base/landing-site-get-menu-bindings":"landing.site.getMenuBindings","/api-reference/landing/embedding/knowledge-base/landing-site-unbinding-from-group":"landing.site.unbindingFromGroup","/api-reference/landing/embedding/knowledge-base/landing-site-unbinding-from-menu":"landing.site.unbindingFromMenu","/api-reference/landing/embedding/landing-repo-bind":"landing.repo.bind","/api-reference/landing/embedding/landing-repo-unbind":"landing.repo.unbind","/api-reference/landing/page/block-methods/landing-landing-add-block":"landing.landing.addblock","/api-reference/landing/page/block-methods/landing-landing-copy-block":"landing.landing.copyblock","/api-reference/landing/page/block-methods/landing-landing-delete-block":"landing.landing.deleteblock","/api-reference/landing/page/block-methods/landing-landing-down-block":"landing.landing.downblock","/api-reference/landing/page/block-methods/landing-landing-favorite-block":"landing.landing.favoriteBlock","/api-reference/landing/page/block-methods/landing-landing-hide-block":"landing.landing.hideblock","/api-reference/landing/page/block-methods/landing-landing-mark-deleted-block":"landing.landing.markdeletedblock","/api-reference/landing/page/block-methods/landing-landing-mark-undeleted-block":"landing.landing.markundeletedblock","/api-reference/landing/page/block-methods/landing-landing-move-block":"landing.landing.moveblock","/api-reference/landing/page/block-methods/landing-landing-show-block":"landing.landing.showblock","/api-reference/landing/page/block-methods/landing-landing-unfavorite-block":"landing.landing.unFavoriteBlock","/api-reference/landing/page/block-methods/landing-landing-up-block":"landing.landing.upblock","/api-reference/landing/page/methods/landing-landing-add-by-template":"landing.landing.addByTemplate","/api-reference/landing/page/methods/landing-landing-add":"landing.landing.add","/api-reference/landing/page/methods/landing-landing-copy":"landing.landing.copy","/api-reference/landing/page/methods/landing-landing-delete":"landing.landing.delete","/api-reference/landing/page/methods/landing-landing-get-additional-fields":"landing.landing.getadditionalfields","/api-reference/landing/page/methods/landing-landing-get-list":"landing.landing.getList","/api-reference/landing/page/methods/landing-landing-get-preview":"landing.landing.getpreview","/api-reference/landing/page/methods/landing-landing-get-public-url":"landing.landing.getpublicurl","/api-reference/landing/page/methods/landing-landing-mark-delete":"landing.landing.markDelete","/api-reference/landing/page/methods/landing-landing-mark-undelete":"landing.landing.markUnDelete","/api-reference/landing/page/methods/landing-landing-move":"landing.landing.move","/api-reference/landing/page/methods/landing-landing-publication":"landing.landing.publication","/api-reference/landing/page/methods/landing-landing-remove-entities":"landing.landing.removeEntities","/api-reference/landing/page/methods/landing-landing-resolve-id-by-public-url":"landing.landing.resolveIdByPublicUrl","/api-reference/landing/page/methods/landing-landing-unpublic":"landing.landing.unpublic","/api-reference/landing/page/methods/landing-landing-update":"landing.landing.update","/api-reference/landing/page/special-pages/landing-syspage-delete-for-landing":"landing.syspage.deleteForLanding","/api-reference/landing/page/special-pages/landing-syspage-delete-for-site":"landing.syspage.deleteForSite","/api-reference/landing/page/special-pages/landing-syspage-get-special-page":"landing.syspage.getSpecialPage","/api-reference/landing/page/special-pages/landing-syspage-get":"landing.syspage.get","/api-reference/landing/page/special-pages/landing-syspage-set":"landing.syspage.set","/api-reference/landing/rights/extended-model/landing-site-get-rights":"landing.site.getRights","/api-reference/landing/rights/extended-model/landing-site-set-rights":"landing.site.setRights","/api-reference/landing/rights/landing-role-enable":"landing.role.enable","/api-reference/landing/rights/landing-role-is-enabled":"landing.role.isEnabled","/api-reference/landing/rights/role-model/landing-role-get-list":"landing.role.getList","/api-reference/landing/rights/role-model/landing-role-get-rights":"landing.role.getRights","/api-reference/landing/rights/role-model/landing-role-set-access-codes":"landing.role.setAccessCodes","/api-reference/landing/rights/role-model/landing-role-set-rights":"landing.role.setRights","/api-reference/landing/site/landing-site-add-folder":"landing.site.addFolder","/api-reference/landing/site/landing-site-add":"landing.site.add","/api-reference/landing/site/landing-site-delete":"landing.site.delete","/api-reference/landing/site/landing-site-full-export":"landing.site.fullExport","/api-reference/landing/site/landing-site-get-additional-fields":"landing.site.getadditionalfields","/api-reference/landing/site/landing-site-get-folders":"landing.site.getFolders","/api-reference/landing/site/landing-site-get-list":"landing.site.getList","/api-reference/landing/site/landing-site-get-preview":"landing.site.getPreview","/api-reference/landing/site/landing-site-get-public-url":"landing.site.getPublicUrl","/api-reference/landing/site/landing-site-mark-delete":"landing.site.markDelete","/api-reference/landing/site/landing-site-mark-folder-delete":"landing.site.markFolderDelete","/api-reference/landing/site/landing-site-mark-folder-undelete":"landing.site.markFolderUnDelete","/api-reference/landing/site/landing-site-mark-undelete":"landing.site.markUnDelete","/api-reference/landing/site/landing-site-publication-folder":"landing.site.publicationFolder","/api-reference/landing/site/landing-site-publication":"landing.site.publication","/api-reference/landing/site/landing-site-unpublic-folder":"landing.site.unPublicFolder","/api-reference/landing/site/landing-site-unpublic":"landing.site.unpublic","/api-reference/landing/site/landing-site-update-folder":"landing.site.updateFolder","/api-reference/landing/site/landing-site-update":"landing.site.update","/api-reference/landing/template/landing-template-get-landing-ref":"landing.template.getLandingRef","/api-reference/landing/template/landing-template-get-list":"landing.template.getlist","/api-reference/landing/template/landing-template-get-site-ref":"landing.template.getSiteRef","/api-reference/landing/template/landing-template-set-landing-ref":"landing.template.setLandingRef","/api-reference/landing/template/landing-template-set-site-ref":"landing.template.setSiteRef","/api-reference/landing/user-blocks/landing-repo-check-content":"landing.repo.checkContent","/api-reference/landing/user-blocks/landing-repo-get-list":"landing.repo.getList","/api-reference/landing/user-blocks/landing-repo-register":"landing.repo.register","/api-reference/landing/user-blocks/landing-repo-unregister":"landing.repo.unregister","/api-reference/lists/elements/lists-element-add":"lists.element.add","/api-reference/lists/elements/lists-element-delete":"lists.element.delete","/api-reference/lists/elements/lists-element-get-file-url":"lists.element.get.file.url","/api-reference/lists/elements/lists-element-get":"lists.element.get","/api-reference/lists/elements/lists-element-update":"lists.element.update","/api-reference/lists/fields/lists-field-add":"lists.field.add","/api-reference/lists/fields/lists-field-delete":"lists.field.delete","/api-reference/lists/fields/lists-field-get":"lists.field.get","/api-reference/lists/fields/lists-field-type-get":"lists.field.type.get","/api-reference/lists/fields/lists-field-update":"lists.field.update","/api-reference/lists/lists/lists-add":"lists.add","/api-reference/lists/lists/lists-delete":"lists.delete","/api-reference/lists/lists/lists-get-iblock-type-id":"lists.get.iblock.type.id","/api-reference/lists/lists/lists-get":"lists.get","/api-reference/lists/lists/lists-update":"lists.update","/api-reference/lists/sections/lists-section-add":"lists.section.add","/api-reference/lists/sections/lists-section-delete":"lists.section.delete","/api-reference/lists/sections/lists-section-get":"lists.section.get","/api-reference/lists/sections/lists-section-update":"lists.section.update","/api-reference/log/blogcomment/log-blogcomment-add":"log.blogcomment.add","/api-reference/log/blogcomment/log-blogcomment-delete":"log.blogcomment.delete","/api-reference/log/blogcomment/log-blogcomment-user-get":"log.blogcomment.user.get","/api-reference/log/log-blogpost-add":"log.blogpost.add","/api-reference/log/log-blogpost-delete":"log.blogpost.delete","/api-reference/log/log-blogpost-get":"log.blogpost.get","/api-reference/log/log-blogpost-getusers-important":"log.blogpost.getusers.important","/api-reference/log/log-blogpost-share":"log.blogpost.share","/api-reference/log/log-blogpost-update":"log.blogpost.update","/api-reference/mail/mailbox/mail-mailbox-field-get":"mail.mailbox.field.get","/api-reference/mail/mailbox/mail-mailbox-field-list":"mail.mailbox.field.list","/api-reference/mail/mailbox/mail-mailbox-get":"mail.mailbox.get","/api-reference/mail/mailbox/mail-mailbox-list":"mail.mailbox.list","/api-reference/mail/mailbox/mail-mailbox-senders":"mail.mailbox.senders","/api-reference/mail/message/mail-message-createcalendarevent":"mail.message.createcalendarevent","/api-reference/mail/message/mail-message-createchat":"mail.message.createchat","/api-reference/mail/message/mail-message-createcrmactivity":"mail.message.createcrmactivity","/api-reference/mail/message/mail-message-createfeedpost":"mail.message.createfeedpost","/api-reference/mail/message/mail-message-createtask":"mail.message.createtask","/api-reference/mail/message/mail-message-field-get":"mail.message.field.get","/api-reference/mail/message/mail-message-field-list":"mail.message.field.list","/api-reference/mail/message/mail-message-forward":"mail.message.forward","/api-reference/mail/message/mail-message-get":"mail.message.get","/api-reference/mail/message/mail-message-list":"mail.message.list","/api-reference/mail/message/mail-message-movetofolder":"mail.message.movetofolder","/api-reference/mail/message/mail-message-removecrmactivity":"mail.message.removecrmactivity","/api-reference/mail/message/mail-message-reply":"mail.message.reply","/api-reference/mail/message/mail-message-send":"mail.message.send","/api-reference/mail/message/mail-message-thread":"mail.message.thread","/api-reference/mail/recipient/mail-recipient-field-get":"mail.recipient.field.get","/api-reference/mail/recipient/mail-recipient-field-list":"mail.recipient.field.list","/api-reference/mail/recipient/mail-recipient-listcontacts":"mail.recipient.listcontacts","/api-reference/mail/recipient/mail-recipient-listemployees":"mail.recipient.listemployees","/api-reference/mailservice/mailservice-add":"mailservice.add","/api-reference/mailservice/mailservice-delete":"mailservice.delete","/api-reference/mailservice/mailservice-fields":"mailservice.fields","/api-reference/mailservice/mailservice-get":"mailservice.get","/api-reference/mailservice/mailservice-list":"mailservice.list","/api-reference/mailservice/mailservice-update":"mailservice.update","/api-reference/messageservice/messageservice-message-status-update":"messageservice.message.status.update","/api-reference/messageservice/messageservice-sender-add":"messageservice.sender.add","/api-reference/messageservice/messageservice-sender-delete":"messageservice.sender.delete","/api-reference/messageservice/messageservice-sender-list":"messageservice.sender.list","/api-reference/messageservice/messageservice-sender-update":"messageservice.sender.update","/api-reference/note/collection/note-collection-add":"note.collection.add","/api-reference/note/collection/note-collection-archive":"note.collection.archive","/api-reference/note/collection/note-collection-delete":"note.collection.delete","/api-reference/note/collection/note-collection-field-get":"note.collection.field.get","/api-reference/note/collection/note-collection-field-list":"note.collection.field.list","/api-reference/note/collection/note-collection-get":"note.collection.get","/api-reference/note/collection/note-collection-list":"note.collection.list","/api-reference/note/collection/note-collection-update":"note.collection.update","/api-reference/note/document/note-document-add":"note.document.add","/api-reference/note/document/note-document-archive":"note.document.archive","/api-reference/note/document/note-document-delete":"note.document.delete","/api-reference/note/document/note-document-field-get":"note.document.field.get","/api-reference/note/document/note-document-field-list":"note.document.field.list","/api-reference/note/document/note-document-get":"note.document.get","/api-reference/note/document/note-document-search-field-get":"note.document.search.field.get","/api-reference/note/document/note-document-search-field-list":"note.document.search.field.list","/api-reference/note/document/note-document-search-list":"note.document.search.list","/api-reference/note/document/note-document-tree-field-get":"note.document.tree.field.get","/api-reference/note/document/note-document-tree-field-list":"note.document.tree.field.list","/api-reference/note/document/note-document-tree-list":"note.document.tree.list","/api-reference/note/document/note-document-update":"note.document.update","/api-reference/note/file/note-file-add":"note.file.add","/api-reference/note/file/note-file-field-get":"note.file.field.get","/api-reference/note/file/note-file-field-list":"note.file.field.list","/api-reference/note/file/note-file-get":"note.file.get","/api-reference/outdated/rpa/comment/rpa-comment-delete":"rpa.comment.delete","/api-reference/outdated/rpa/comment/rpa-comment-update":"rpa.comment.update","/api-reference/outdated/rpa/fields/rpa-fields-get-settings":"rpa.fields.getSettings","/api-reference/outdated/rpa/fields/rpa-fields-set-settings":"rpa.fields.setSettings","/api-reference/outdated/rpa/fields/rpa-fields-set-visibility-settings":"rpa.fields.setVisibilitySettings","/api-reference/outdated/rpa/item/rpa-item-add":"rpa.item.add","/api-reference/outdated/rpa/item/rpa-item-delete":"rpa.item.delete","/api-reference/outdated/rpa/item/rpa-item-get-tasks":"rpa.item.getTasks","/api-reference/outdated/rpa/item/rpa-item-list":"rpa.item.list","/api-reference/outdated/rpa/item/rpa-item-update":"rpa.item.update","/api-reference/outdated/rpa/stage/rpa-stage-add":"rpa.stage.add","/api-reference/outdated/rpa/stage/rpa-stage-delete":"rpa.stage.delete","/api-reference/outdated/rpa/stage/rpa-stage-list-for-type":"rpa.stage.listForType","/api-reference/outdated/rpa/stage/rpa-stage-update":"rpa.stage.update","/api-reference/outdated/rpa/task/rpa-task-add-user":"rpa.task.addUser","/api-reference/outdated/rpa/task/rpa-task-delete":"rpa.task.delete","/api-reference/outdated/rpa/timeline/rpa-timeline-add":"rpa.timeline.add","/api-reference/outdated/rpa/timeline/rpa-timeline-delete":"rpa.timeline.delete","/api-reference/outdated/rpa/timeline/rpa-timeline-list-for-item":"rpa.timeline.listForItem","/api-reference/outdated/rpa/timeline/rpa-timeline-update-is-fixed":"rpa.timeline.updateIsFixed","/api-reference/outdated/rpa/timeline/rpa-timeline-update":"rpa.timeline.update","/api-reference/outdated/rpa/type/rpa-type-add":"rpa.type.add","/api-reference/outdated/rpa/type/rpa-type-delete":"rpa.type.delete","/api-reference/outdated/rpa/type/rpa-type-get":"rpa.type.get","/api-reference/outdated/rpa/type/rpa-type-list":"rpa.type.list","/api-reference/outdated/rpa/type/rpa-type-update":"rpa.type.update","/api-reference/pay-system/outdated/sale-pay-system-pay-invoice":"sale.paysystem.pay.invoice","/api-reference/pay-system/outdated/sale-pay-system-settings-invoice-get":"sale.paysystem.settings.invoice.get","/api-reference/pay-system/sale-pay-system-add":"sale.paysystem.add","/api-reference/pay-system/sale-pay-system-delete":"sale.paysystem.delete","/api-reference/pay-system/sale-pay-system-handler-add":"sale.paysystem.handler.add","/api-reference/pay-system/sale-pay-system-handler-delete":"sale.paysystem.handler.delete","/api-reference/pay-system/sale-pay-system-handler-update":"sale.paysystem.handler.update","/api-reference/pay-system/sale-pay-system-list":"sale.paysystem.list","/api-reference/pay-system/sale-pay-system-pay-payment":"sale.paysystem.pay.payment","/api-reference/pay-system/sale-pay-system-settings-get":"sale.paysystem.settings.get","/api-reference/pay-system/sale-pay-system-settings-payment-get":"sale.paysystem.settings.payment.get","/api-reference/pay-system/sale-pay-system-settings-update":"sale.paysystem.settings.update","/api-reference/pay-system/sale-pay-system-update":"sale.paysystem.update","/api-reference/sale/basket-item/sale-basket-item-add-catalog-product":"sale.basketitem.addCatalogProduct","/api-reference/sale/basket-item/sale-basket-item-add":"sale.basketitem.add","/api-reference/sale/basket-item/sale-basket-item-delete":"sale.basketitem.delete","/api-reference/sale/basket-item/sale-basket-item-get-catalog-product-fields":"sale.basketitem.getFieldsCatalogProduct","/api-reference/sale/basket-item/sale-basket-item-get-fields":"sale.basketitem.getFields","/api-reference/sale/basket-item/sale-basket-item-get":"sale.basketitem.get","/api-reference/sale/basket-item/sale-basket-item-list":"sale.basketitem.list","/api-reference/sale/basket-item/sale-basket-item-update-catalog-product":"sale.basketitem.updateCatalogProduct","/api-reference/sale/basket-item/sale-basket-item-update":"sale.basketitem.update","/api-reference/sale/basket-properties/sale-basket-properties-add":"sale.basketproperties.add","/api-reference/sale/basket-properties/sale-basket-properties-delete":"sale.basketproperties.delete","/api-reference/sale/basket-properties/sale-basket-properties-get-fields":"sale.basketproperties.getFields","/api-reference/sale/basket-properties/sale-basket-properties-get":"sale.basketproperties.get","/api-reference/sale/basket-properties/sale-basket-properties-list":"sale.basketproperties.list","/api-reference/sale/basket-properties/sale-basket-properties-update":"sale.basketproperties.update","/api-reference/sale/business-value-person-domain/sale-business-value-person-domain-add":"sale.businessValuePersonDomain.add","/api-reference/sale/business-value-person-domain/sale-business-value-person-domain-delete-by-filter":"sale.businessValuePersonDomain.deleteByFilter","/api-reference/sale/business-value-person-domain/sale-business-value-person-domain-get-fields":"sale.businessValuePersonDomain.getFields","/api-reference/sale/business-value-person-domain/sale-business-value-person-domain-list":"sale.businessValuePersonDomain.list","/api-reference/sale/cashbox/sale-cashbox-add":"sale.cashbox.add","/api-reference/sale/cashbox/sale-cashbox-check-apply":"sale.cashbox.check.apply","/api-reference/sale/cashbox/sale-cashbox-delete":"sale.cashbox.delete","/api-reference/sale/cashbox/sale-cashbox-handler-add":"sale.cashbox.handler.add","/api-reference/sale/cashbox/sale-cashbox-handler-delete":"sale.cashbox.handler.delete","/api-reference/sale/cashbox/sale-cashbox-handler-list":"sale.cashbox.handler.list","/api-reference/sale/cashbox/sale-cashbox-handler-update":"sale.cashbox.handler.update","/api-reference/sale/cashbox/sale-cashbox-list":"sale.cashbox.list","/api-reference/sale/cashbox/sale-cashbox-update":"sale.cashbox.update","/api-reference/sale/delivery/delivery-request/sale-delivery-request-delete":"sale.delivery.request.delete","/api-reference/sale/delivery/delivery-request/sale-delivery-request-send-message":"sale.delivery.request.sendmessage","/api-reference/sale/delivery/delivery-request/sale-delivery-request-update":"sale.delivery.request.update","/api-reference/sale/delivery/delivery/sale-delivery-add":"sale.delivery.add","/api-reference/sale/delivery/delivery/sale-delivery-config-get":"sale.delivery.config.get","/api-reference/sale/delivery/delivery/sale-delivery-config-update":"sale.delivery.config.update","/api-reference/sale/delivery/delivery/sale-delivery-delete":"sale.delivery.delete","/api-reference/sale/delivery/delivery/sale-delivery-get-list":"sale.delivery.getlist","/api-reference/sale/delivery/delivery/sale-delivery-update":"sale.delivery.update","/api-reference/sale/delivery/extra-service/sale-delivery-extra-service-add":"sale.delivery.extra.service.add","/api-reference/sale/delivery/extra-service/sale-delivery-extra-service-delete":"sale.delivery.extra.service.delete","/api-reference/sale/delivery/extra-service/sale-delivery-extra-service-get":"sale.delivery.extra.service.get","/api-reference/sale/delivery/extra-service/sale-delivery-extra-service-update":"sale.delivery.extra.service.update","/api-reference/sale/delivery/handler/sale-delivery-handler-add":"sale.delivery.handler.add","/api-reference/sale/delivery/handler/sale-delivery-handler-delete":"sale.delivery.handler.delete","/api-reference/sale/delivery/handler/sale-delivery-handler-list":"sale.delivery.handler.list","/api-reference/sale/delivery/handler/sale-delivery-handler-update":"sale.delivery.handler.update","/api-reference/sale/order/sale-order-add":"sale.order.add","/api-reference/sale/order/sale-order-delete":"sale.order.delete","/api-reference/sale/order/sale-order-get-fields":"sale.order.getFields","/api-reference/sale/order/sale-order-get":"sale.order.get","/api-reference/sale/order/sale-order-list":"sale.order.list","/api-reference/sale/order/sale-order-update":"sale.order.update","/api-reference/sale/payment-item-basket/sale-payment-item-basket-add":"sale.paymentitembasket.add","/api-reference/sale/payment-item-basket/sale-payment-item-basket-delete":"sale.paymentitembasket.delete","/api-reference/sale/payment-item-basket/sale-payment-item-basket-get-fields":"sale.paymentitembasket.getfields","/api-reference/sale/payment-item-basket/sale-payment-item-basket-get":"sale.paymentitembasket.get","/api-reference/sale/payment-item-basket/sale-payment-item-basket-list":"sale.paymentitembasket.list","/api-reference/sale/payment-item-basket/sale-payment-item-basket-update":"sale.paymentitembasket.update","/api-reference/sale/payment-item-shipment/sale-payment-item-shipment-add":"sale.paymentItemShipment.add","/api-reference/sale/payment-item-shipment/sale-payment-item-shipment-delete":"sale.paymentItemShipment.delete","/api-reference/sale/payment-item-shipment/sale-payment-item-shipment-get-fields":"sale.paymentItemShipment.getFields","/api-reference/sale/payment-item-shipment/sale-payment-item-shipment-get":"sale.paymentItemShipment.get","/api-reference/sale/payment-item-shipment/sale-payment-item-shipment-list":"sale.paymentItemShipment.list","/api-reference/sale/payment-item-shipment/sale-payment-item-shipment-update":"sale.paymentItemShipment.update","/api-reference/sale/payment/sale-payment-add":"sale.payment.add","/api-reference/sale/payment/sale-payment-delete":"sale.payment.delete","/api-reference/sale/payment/sale-payment-get-fields":"sale.payment.getFields","/api-reference/sale/payment/sale-payment-get":"sale.payment.get","/api-reference/sale/payment/sale-payment-list":"sale.payment.list","/api-reference/sale/payment/sale-payment-update":"sale.payment.update","/api-reference/sale/person-type/sale-person-type-add":"sale.persontype.add","/api-reference/sale/person-type/sale-person-type-delete":"sale.persontype.delete","/api-reference/sale/person-type/sale-person-type-get-fields":"sale.persontype.getFields","/api-reference/sale/person-type/sale-person-type-get":"sale.persontype.get","/api-reference/sale/person-type/sale-person-type-list":"sale.persontype.list","/api-reference/sale/person-type/sale-person-type-update":"sale.persontype.update","/api-reference/sale/property-group/sale-property-group-add":"sale.propertygroup.add","/api-reference/sale/property-group/sale-property-group-delete":"sale.propertygroup.delete","/api-reference/sale/property-group/sale-property-group-get-fields":"sale.propertygroup.getFields","/api-reference/sale/property-group/sale-property-group-get":"sale.propertygroup.get","/api-reference/sale/property-group/sale-property-group-list":"sale.propertygroup.list","/api-reference/sale/property-group/sale-property-group-update":"sale.propertygroup.update","/api-reference/sale/property-relation/sale-property-relation-add":"sale.propertyRelation.add","/api-reference/sale/property-relation/sale-property-relation-delete-by-filter":"sale.propertyRelation.deleteByFilter","/api-reference/sale/property-relation/sale-property-relation-get-fields":"sale.propertyRelation.getFields","/api-reference/sale/property-relation/sale-property-relation-list":"sale.propertyRelation.list","/api-reference/sale/property-value/sale-property-value-delete":"sale.propertyvalue.delete","/api-reference/sale/property-value/sale-property-value-get-fields":"sale.propertyvalue.getfields","/api-reference/sale/property-value/sale-property-value-get":"sale.propertyvalue.get","/api-reference/sale/property-value/sale-property-value-list":"sale.propertyvalue.list","/api-reference/sale/property-value/sale-property-value-modify":"sale.propertyvalue.modify","/api-reference/sale/property-variant/sale-property-variant-add":"sale.propertyvariant.add","/api-reference/sale/property-variant/sale-property-variant-delete":"sale.propertyvariant.delete","/api-reference/sale/property-variant/sale-property-variant-get-fields":"sale.propertyvariant.getFields","/api-reference/sale/property-variant/sale-property-variant-get":"sale.propertyvariant.get","/api-reference/sale/property-variant/sale-property-variant-list":"sale.propertyvariant.list","/api-reference/sale/property-variant/sale-property-variant-update":"sale.propertyvariant.update","/api-reference/sale/property/sale-property-add":"sale.property.add","/api-reference/sale/property/sale-property-delete":"sale.property.delete","/api-reference/sale/property/sale-property-get-fields-by-type":"sale.property.getfieldsbytype","/api-reference/sale/property/sale-property-get":"sale.property.get","/api-reference/sale/property/sale-property-list":"sale.property.list","/api-reference/sale/property/sale-property-update":"sale.property.update","/api-reference/sale/shipment-item/sale-shipment-item-add":"sale.shipmentitem.add","/api-reference/sale/shipment-item/sale-shipment-item-delete":"sale.shipmentitem.delete","/api-reference/sale/shipment-item/sale-shipment-item-get-fields":"sale.shipmentitem.getFields","/api-reference/sale/shipment-item/sale-shipment-item-get":"sale.shipmentitem.get","/api-reference/sale/shipment-item/sale-shipment-item-list":"sale.shipmentitem.list","/api-reference/sale/shipment-item/sale-shipment-item-update":"sale.shipmentitem.update","/api-reference/sale/shipment-property-value/sale-shipment-property-value-get-fields":"sale.shipmentpropertyvalue.getFields","/api-reference/sale/shipment-property-value/sale-shipment-property-value-get":"sale.shipmentpropertyvalue.get","/api-reference/sale/shipment-property-value/sale-shipment-property-value-list":"sale.shipmentpropertyvalue.list","/api-reference/sale/shipment-property-value/sale-shipment-property-value-modify":"sale.shipmentpropertyvalue.modify","/api-reference/sale/shipment-property-value/sale-shipment-propertyvalue-delete":"sale.shipmentpropertyvalue.delete","/api-reference/sale/shipment-property/sale-shipment-property-add":"sale.shipmentproperty.add","/api-reference/sale/shipment-property/sale-shipment-property-delete":"sale.shipmentproperty.delete","/api-reference/sale/shipment-property/sale-shipment-property-get-fields-by-type":"sale.shipmentproperty.getfieldsbytype","/api-reference/sale/shipment-property/sale-shipment-property-get":"sale.shipmentproperty.get","/api-reference/sale/shipment-property/sale-shipment-property-list":"sale.shipmentproperty.list","/api-reference/sale/shipment-property/sale-shipment-property-update":"sale.shipmentproperty.update","/api-reference/sale/shipment/sale-shipment-add":"sale.shipment.add","/api-reference/sale/shipment/sale-shipment-delete":"sale.shipment.delete","/api-reference/sale/shipment/sale-shipment-get-fields":"sale.shipment.getFields","/api-reference/sale/shipment/sale-shipment-get":"sale.shipment.get","/api-reference/sale/shipment/sale-shipment-list":"sale.shipment.list","/api-reference/sale/shipment/sale-shipment-update":"sale.shipment.update","/api-reference/sale/status-lang/sale-status-lang-add":"sale.statusLang.add","/api-reference/sale/status-lang/sale-status-lang-delete-by-filter":"sale.statusLang.deleteByFilter","/api-reference/sale/status-lang/sale-status-lang-get-fields":"sale.statusLang.getFields","/api-reference/sale/status-lang/sale-status-lang-get-list-langs":"sale.statusLang.getListLangs","/api-reference/sale/status-lang/sale-status-lang-list":"sale.statusLang.list","/api-reference/sale/status/sale-status-add":"sale.status.add","/api-reference/sale/status/sale-status-delete":"sale.status.delete","/api-reference/sale/status/sale-status-get-fields":"sale.status.getFields","/api-reference/sale/status/sale-status-get":"sale.status.get","/api-reference/sale/status/sale-status-list":"sale.status.list","/api-reference/sale/status/sale-status-update":"sale.status.update","/api-reference/sale/trade-binding/sale-trade-binding-get-fields":"sale.tradeBinding.getFields","/api-reference/sale/trade-binding/sale-trade-binding-list":"sale.tradeBinding.list","/api-reference/sale/trade-platform/sale-trade-platform-get-fields":"sale.tradePlatform.getFields","/api-reference/sale/trade-platform/sale-trade-platform-list":"sale.tradePlatform.list","/api-reference/sign/hcm-link/humanresources-hcmlink-company-add":"humanresources.hcmlink.company.add","/api-reference/sign/hcm-link/humanresources-hcmlink-company-delete":"humanresources.hcmlink.company.delete","/api-reference/sign/hcm-link/humanresources-hcmlink-company-list":"humanresources.hcmlink.company.list","/api-reference/sign/hcm-link/humanresources-hcmlink-company-update":"humanresources.hcmlink.company.update","/api-reference/sign/hcm-link/humanresources-hcmlink-company-user-list":"humanresources.hcmlink.company.user.list","/api-reference/sign/hcm-link/humanresources-hcmlink-employee-list":"humanresources.hcmlink.employee.list","/api-reference/sign/hcm-link/humanresources-hcmlink-employee-set":"humanresources.hcmlink.employee.set","/api-reference/sign/hcm-link/humanresources-hcmlink-field-value-set":"humanresources.hcmlink.field.value.set","/api-reference/sign/hcm-link/humanresources-hcmlink-job-status-get":"humanresources.hcmlink.job.status.get","/api-reference/sign/hcm-link/humanresources-hcmlink-job-update":"humanresources.hcmlink.job.update","/api-reference/sign/sign-b2e-company-provider-list":"sign.b2e.company.provider.list","/api-reference/sign/sign-b2e-document-get":"sign.b2e.document.get","/api-reference/sign/sign-b2e-document-send":"sign.b2e.document.send","/api-reference/sign/sign-b2e-hcmlink-document-get":"sign.b2e.hcmlink.document.get","/api-reference/sign/sign-b2e-mysafe-tail":"sign.b2e.mysafe.tail","/api-reference/sign/sign-b2e-personal-tail":"sign.b2e.personal.tail","/api-reference/sonet-group/members/sonet-group-user-add":"sonet_group.user.add","/api-reference/sonet-group/members/sonet-group-user-delete":"sonet_group.user.delete","/api-reference/sonet-group/members/sonet-group-user-get":"sonet_group.user.get","/api-reference/sonet-group/members/sonet-group-user-invite":"sonet_group.user.invite","/api-reference/sonet-group/members/sonet-group-user-request":"sonet_group.user.request","/api-reference/sonet-group/members/sonet-group-user-update":"sonet_group.user.update","/api-reference/sonet-group/scrum/backlog/tasks-api-scrum-backlog-add":"tasks.api.scrum.backlog.add","/api-reference/sonet-group/scrum/backlog/tasks-api-scrum-backlog-delete":"tasks.api.scrum.backlog.delete","/api-reference/sonet-group/scrum/backlog/tasks-api-scrum-backlog-get-fields":"tasks.api.scrum.backlog.getFields","/api-reference/sonet-group/scrum/backlog/tasks-api-scrum-backlog-get":"tasks.api.scrum.backlog.get","/api-reference/sonet-group/scrum/backlog/tasks-api-scrum-backlog-update":"tasks.api.scrum.backlog.update","/api-reference/sonet-group/scrum/epic/tasks-api-scrum-epic-add":"tasks.api.scrum.epic.add","/api-reference/sonet-group/scrum/epic/tasks-api-scrum-epic-delete":"tasks.api.scrum.epic.delete","/api-reference/sonet-group/scrum/epic/tasks-api-scrum-epic-get-fields":"tasks.api.scrum.epic.getFields","/api-reference/sonet-group/scrum/epic/tasks-api-scrum-epic-get":"tasks.api.scrum.epic.get","/api-reference/sonet-group/scrum/epic/tasks-api-scrum-epic-list":"tasks.api.scrum.epic.list","/api-reference/sonet-group/scrum/epic/tasks-api-scrum-epic-update":"tasks.api.scrum.epic.update","/api-reference/sonet-group/scrum/kanban/tasks-api-scrum-kanban-add-stage":"tasks.api.scrum.kanban.addStage","/api-reference/sonet-group/scrum/kanban/tasks-api-scrum-kanban-add-task":"tasks.api.scrum.kanban.addTask","/api-reference/sonet-group/scrum/kanban/tasks-api-scrum-kanban-delete-stage":"tasks.api.scrum.kanban.deleteStage","/api-reference/sonet-group/scrum/kanban/tasks-api-scrum-kanban-delete-task":"tasks.api.scrum.kanban.deleteTask","/api-reference/sonet-group/scrum/kanban/tasks-api-scrum-kanban-get-fields":"tasks.api.scrum.kanban.getFields","/api-reference/sonet-group/scrum/kanban/tasks-api-scrum-kanban-get-stages":"tasks.api.scrum.kanban.getStages","/api-reference/sonet-group/scrum/kanban/tasks-api-scrum-kanban-update-stage":"tasks.api.scrum.kanban.updateStage","/api-reference/sonet-group/scrum/sprint/tasks-api-scrum-sprint-add":"tasks.api.scrum.sprint.add","/api-reference/sonet-group/scrum/sprint/tasks-api-scrum-sprint-complete":"tasks.api.scrum.sprint.complete","/api-reference/sonet-group/scrum/sprint/tasks-api-scrum-sprint-delete":"tasks.api.scrum.sprint.delete","/api-reference/sonet-group/scrum/sprint/tasks-api-scrum-sprint-get-fields":"tasks.api.scrum.sprint.getFields","/api-reference/sonet-group/scrum/sprint/tasks-api-scrum-sprint-get":"tasks.api.scrum.sprint.get","/api-reference/sonet-group/scrum/sprint/tasks-api-scrum-sprint-list":"tasks.api.scrum.sprint.list","/api-reference/sonet-group/scrum/sprint/tasks-api-scrum-sprint-start":"tasks.api.scrum.sprint.start","/api-reference/sonet-group/scrum/sprint/tasks-api-scrum-sprint-update":"tasks.api.scrum.sprint.update","/api-reference/sonet-group/scrum/task/tasks-api-scrum-task-get-fields":"tasks.api.scrum.task.getFields","/api-reference/sonet-group/scrum/task/tasks-api-scrum-task-get":"tasks.api.scrum.task.get","/api-reference/sonet-group/scrum/task/tasks-api-scrum-task-update":"tasks.api.scrum.task.update","/api-reference/sonet-group/socialnetwork-api-workgroup-get":"socialnetwork.api.workgroup.get","/api-reference/sonet-group/socialnetwork-api-workgroup-list":"socialnetwork.api.workgroup.list","/api-reference/sonet-group/sonet-group-create":"sonet_group.create","/api-reference/sonet-group/sonet-group-delete":"sonet_group.delete","/api-reference/sonet-group/sonet-group-feature-access":"sonet_group.feature.access","/api-reference/sonet-group/sonet-group-get":"sonet_group.get","/api-reference/sonet-group/sonet-group-setowner":"sonet_group.setowner","/api-reference/sonet-group/sonet-group-update":"sonet_group.update","/api-reference/sonet-group/sonet-group-user-groups":"sonet_group.user.groups","/api-reference/tasks/checklist-item/task-checklist-item-add":"task.checklistitem.add","/api-reference/tasks/checklist-item/task-checklist-item-complete":"task.checklistitem.complete","/api-reference/tasks/checklist-item/task-checklist-item-delete":"task.checklistitem.delete","/api-reference/tasks/checklist-item/task-checklist-item-get-list":"task.checklistitem.getlist","/api-reference/tasks/checklist-item/task-checklist-item-get-manifest":"task.checklistitem.getmanifest","/api-reference/tasks/checklist-item/task-checklist-item-get":"task.checklistitem.get","/api-reference/tasks/checklist-item/task-checklist-item-is-action-allowed":"task.checklistitem.isactionallowed","/api-reference/tasks/checklist-item/task-checklist-item-move-after-item":"task.checklistitem.moveafteritem","/api-reference/tasks/checklist-item/task-checklist-item-renew":"task.checklistitem.renew","/api-reference/tasks/checklist-item/task-checklist-item-update":"task.checklistitem.update","/api-reference/tasks/comment-item/task-comment-item-add":"task.commentitem.add","/api-reference/tasks/comment-item/task-comment-item-delete":"task.commentitem.delete","/api-reference/tasks/comment-item/task-comment-item-get-list":"task.commentitem.getlist","/api-reference/tasks/comment-item/task-comment-item-get":"task.commentitem.get","/api-reference/tasks/comment-item/task-comment-item-update":"task.commentitem.update","/api-reference/tasks/deprecated/task-comment-add":"task.comment.add","/api-reference/tasks/deprecated/task-item/task-item-add-file":"task.item.addfile","/api-reference/tasks/deprecated/task-item/task-item-add-to-favourite":"task.item.addtofavorite","/api-reference/tasks/deprecated/task-item/task-item-add":"task.item.add","/api-reference/tasks/deprecated/task-item/task-item-approve":"task.item.approve","/api-reference/tasks/deprecated/task-item/task-item-complete":"task.item.complete","/api-reference/tasks/deprecated/task-item/task-item-defer":"task.item.defer","/api-reference/tasks/deprecated/task-item/task-item-delegate":"task.item.delegate","/api-reference/tasks/deprecated/task-item/task-item-delete-file":"task.item.deletefile","/api-reference/tasks/deprecated/task-item/task-item-delete-from-favorite":"task.item.deletefromfavorite","/api-reference/tasks/deprecated/task-item/task-item-delete":"task.item.delete","/api-reference/tasks/deprecated/task-item/task-item-disapprove":"task.item.disapprove","/api-reference/tasks/deprecated/task-item/task-item-get-allowed-actions":"task.item.getallowedactions","/api-reference/tasks/deprecated/task-item/task-item-get-allowed-task-actions-as-strings":"task.item.getallowedtaskactionsasstrings","/api-reference/tasks/deprecated/task-item/task-item-get-data":"task.item.getdata","/api-reference/tasks/deprecated/task-item/task-item-get-dependson":"task.item.getdependson","/api-reference/tasks/deprecated/task-item/task-item-get-description":"task.item.getdescription","/api-reference/tasks/deprecated/task-item/task-item-get-files":"task.item.getfiles","/api-reference/tasks/deprecated/task-item/task-item-is-action-allowed":"task.item.isactionallowed","/api-reference/tasks/deprecated/task-item/task-item-list":"task.item.list","/api-reference/tasks/deprecated/task-item/task-item-renew":"task.item.renew","/api-reference/tasks/deprecated/task-item/task-item-start-execution":"task.item.startexecution","/api-reference/tasks/deprecated/task-item/task-item-update":"task.item.update","/api-reference/tasks/deprecated/task-item/task-log-item-list":"task.logitem.list","/api-reference/tasks/deprecated/task-items-get-list":"task.items.getlist","/api-reference/tasks/elapsed-item/task-elapsed-item-add":"task.elapseditem.add","/api-reference/tasks/elapsed-item/task-elapsed-item-delete":"task.elapseditem.delete","/api-reference/tasks/elapsed-item/task-elapsed-item-get-list":"task.elapseditem.getlist","/api-reference/tasks/elapsed-item/task-elapsed-item-get-manifest":"task.elapseditem.getmanifest","/api-reference/tasks/elapsed-item/task-elapsed-item-get":"task.elapseditem.get","/api-reference/tasks/elapsed-item/task-elapsed-item-is-action-allowed":"task.elapseditem.isactionallowed","/api-reference/tasks/elapsed-item/task-elapsed-item-update":"task.elapseditem.update","/api-reference/tasks/flow/tasks-flow-flow-activate":"tasks.flow.Flow.activate","/api-reference/tasks/flow/tasks-flow-flow-create":"tasks.flow.Flow.create","/api-reference/tasks/flow/tasks-flow-flow-delete":"tasks.flow.Flow.delete","/api-reference/tasks/flow/tasks-flow-flow-get":"tasks.flow.Flow.get","/api-reference/tasks/flow/tasks-flow-flow-is-exists":"tasks.flow.Flow.isExists","/api-reference/tasks/flow/tasks-flow-flow-pin":"tasks.flow.Flow.pin","/api-reference/tasks/flow/tasks-flow-flow-update":"tasks.flow.Flow.update","/api-reference/tasks/planner/task-planner-get-list":"task.planner.getlist","/api-reference/tasks/result/tasks-task-result-add-from-comment":"tasks.task.result.addFromComment","/api-reference/tasks/result/tasks-task-result-add":"tasks.task.result.add","/api-reference/tasks/result/tasks-task-result-addfromchatmessage":"tasks.task.result.addfromchatmessage","/api-reference/tasks/result/tasks-task-result-delete-from-comment":"tasks.task.result.deleteFromComment","/api-reference/tasks/result/tasks-task-result-delete":"tasks.task.result.delete","/api-reference/tasks/result/tasks-task-result-list":"tasks.task.result.list","/api-reference/tasks/result/tasks-task-result-update":"tasks.task.result.update","/api-reference/tasks/stages/task-stages-add":"task.stages.add","/api-reference/tasks/stages/task-stages-can-move-task":"task.stages.canmovetask","/api-reference/tasks/stages/task-stages-delete":"task.stages.delete","/api-reference/tasks/stages/task-stages-get":"task.stages.get","/api-reference/tasks/stages/task-stages-move-task":"task.stages.movetask","/api-reference/tasks/stages/task-stages-update":"task.stages.update","/api-reference/tasks/status/tasks-task-complete":"tasks.task.complete","/api-reference/tasks/status/tasks-task-defer":"tasks.task.defer","/api-reference/tasks/status/tasks-task-pause":"tasks.task.pause","/api-reference/tasks/status/tasks-task-renew":"tasks.task.renew","/api-reference/tasks/status/tasks-task-start":"tasks.task.start","/api-reference/tasks/task-dependence-add":"task.dependence.add","/api-reference/tasks/task-dependence-delete":"task.dependence.delete","/api-reference/tasks/tasks-task-access-field-get":"tasks.task.access.field.get","/api-reference/tasks/tasks-task-access-field-list":"tasks.task.access.field.list","/api-reference/tasks/tasks-task-access-get":"tasks.task.access.get","/api-reference/tasks/tasks-task-add":"tasks.task.add","/api-reference/tasks/tasks-task-approve":"tasks.task.approve","/api-reference/tasks/tasks-task-chat-message-field-get":"tasks.task.chat.message.field.get","/api-reference/tasks/tasks-task-chat-message-field-list":"tasks.task.chat.message.field.list","/api-reference/tasks/tasks-task-chat-message-send":"tasks.task.chat.message.send","/api-reference/tasks/tasks-task-counters-get":"tasks.task.counters.get","/api-reference/tasks/tasks-task-delegate":"tasks.task.delegate","/api-reference/tasks/tasks-task-delete":"tasks.task.delete","/api-reference/tasks/tasks-task-disapprove":"tasks.task.disapprove","/api-reference/tasks/tasks-task-field-get":"tasks.task.field.get","/api-reference/tasks/tasks-task-field-list":"tasks.task.field.list","/api-reference/tasks/tasks-task-file-attach":"tasks.task.file.attach","/api-reference/tasks/tasks-task-file-field-get":"tasks.task.file.field.get","/api-reference/tasks/tasks-task-file-field-list":"tasks.task.file.field.list","/api-reference/tasks/tasks-task-files-attach":"tasks.task.files.attach","/api-reference/tasks/tasks-task-gantt-link-list":"tasks.task.gantt.link.list","/api-reference/tasks/tasks-task-get-access":"tasks.task.getaccess","/api-reference/tasks/tasks-task-get-fields":"tasks.task.getFields","/api-reference/tasks/tasks-task-get":"tasks.task.get","/api-reference/tasks/tasks-task-history-list":"tasks.task.history.list","/api-reference/tasks/tasks-task-list":"tasks.task.list","/api-reference/tasks/tasks-task-update":"tasks.task.update","/api-reference/tasks/template/checklist/tasks-template-checklist-add-attachment-by-content":"tasks.template.checklist.addAttachmentByContent","/api-reference/tasks/template/checklist/tasks-template-checklist-add-attachments-from-disk":"tasks.template.checklist.addAttachmentsFromDisk","/api-reference/tasks/template/checklist/tasks-template-checklist-add":"tasks.template.checklist.add","/api-reference/tasks/template/checklist/tasks-template-checklist-complete":"tasks.template.checklist.complete","/api-reference/tasks/template/checklist/tasks-template-checklist-delete":"tasks.template.checklist.delete","/api-reference/tasks/template/checklist/tasks-template-checklist-get":"tasks.template.checklist.get","/api-reference/tasks/template/checklist/tasks-template-checklist-list":"tasks.template.checklist.list","/api-reference/tasks/template/checklist/tasks-template-checklist-move-after":"tasks.template.checklist.moveAfter","/api-reference/tasks/template/checklist/tasks-template-checklist-move-before":"tasks.template.checklist.moveBefore","/api-reference/tasks/template/checklist/tasks-template-checklist-remove-attachments":"tasks.template.checklist.removeAttachments","/api-reference/tasks/template/checklist/tasks-template-checklist-renew":"tasks.template.checklist.renew","/api-reference/tasks/template/checklist/tasks-template-checklist-update":"tasks.template.checklist.update","/api-reference/tasks/template/tasks-template-add":"tasks.template.add","/api-reference/tasks/template/tasks-template-delete":"tasks.template.delete","/api-reference/tasks/template/tasks-template-fields":"tasks.template.fields","/api-reference/tasks/template/tasks-template-get":"tasks.template.get","/api-reference/tasks/template/tasks-template-update":"tasks.template.update","/api-reference/tasks/user-actions/tasks-task-favorite-add":"tasks.task.favorite.add","/api-reference/tasks/user-actions/tasks-task-favorite-remove":"tasks.task.favorite.remove","/api-reference/tasks/user-actions/tasks-task-mute":"tasks.task.mute","/api-reference/tasks/user-actions/tasks-task-pin":"tasks.task.pin","/api-reference/tasks/user-actions/tasks-task-start-watch":"tasks.task.startwatch","/api-reference/tasks/user-actions/tasks-task-stop-watch":"tasks.task.stopwatch","/api-reference/tasks/user-actions/tasks-task-unmute":"tasks.task.unmute","/api-reference/tasks/user-actions/tasks-task-unpin":"tasks.task.unpin","/api-reference/tasks/user-field/task-item-user-field-add":"task.item.userfield.add","/api-reference/tasks/user-field/task-item-user-field-delete":"task.item.userfield.delete","/api-reference/tasks/user-field/task-item-user-field-get-fields":"task.item.userfield.getfields","/api-reference/tasks/user-field/task-item-user-field-get-list":"task.item.userfield.getlist","/api-reference/tasks/user-field/task-item-user-field-get-types":"task.item.userfield.gettypes","/api-reference/tasks/user-field/task-item-user-field-get":"task.item.userfield.get","/api-reference/tasks/user-field/task-item-user-field-update":"task.item.userfield.update","/api-reference/telephony/follow-up/call-followup-field-get":"call.followup.field.get","/api-reference/telephony/follow-up/call-followup-field-list":"call.followup.field.list","/api-reference/telephony/follow-up/call-followup-get":"call.followup.get","/api-reference/telephony/follow-up/call-followup-list":"call.followup.list","/api-reference/telephony/telephony-call-attach-transcription":"telephony.call.attachTranscription","/api-reference/telephony/telephony-external-call-attach-record":"telephony.externalCall.attachRecord","/api-reference/telephony/telephony-external-call-finish":"telephony.externalCall.finish","/api-reference/telephony/telephony-external-call-hide":"telephony.externalCall.hide","/api-reference/telephony/telephony-external-call-register":"telephony.externalCall.register","/api-reference/telephony/telephony-external-call-search-crm-entities":"telephony.externalCall.searchCrmEntities","/api-reference/telephony/telephony-external-call-show":"telephony.externalCall.show","/api-reference/telephony/telephony-external-line-add":"telephony.externalLine.add","/api-reference/telephony/telephony-external-line-delete":"telephony.externalLine.delete","/api-reference/telephony/telephony-external-line-get":"telephony.externalLine.get","/api-reference/telephony/telephony-external-line-update":"telephony.externalLine.update","/api-reference/telephony/voximplant/lines/voximplant-line-get":"voximplant.line.get","/api-reference/telephony/voximplant/lines/voximplant-line-outgoing-get":"voximplant.line.outgoing.get","/api-reference/telephony/voximplant/lines/voximplant-line-outgoing-set":"voximplant.line.outgoing.set","/api-reference/telephony/voximplant/lines/voximplant-line-outgoing-sip-set":"voximplant.line.outgoing.sip.set","/api-reference/telephony/voximplant/sip/voximplant-sip-add":"voximplant.sip.add","/api-reference/telephony/voximplant/sip/voximplant-sip-connector-status":"voximplant.sip.connector.status","/api-reference/telephony/voximplant/sip/voximplant-sip-delete":"voximplant.sip.delete","/api-reference/telephony/voximplant/sip/voximplant-sip-get":"voximplant.sip.get","/api-reference/telephony/voximplant/sip/voximplant-sip-status":"voximplant.sip.status","/api-reference/telephony/voximplant/sip/voximplant-sip-update":"voximplant.sip.update","/api-reference/telephony/voximplant/users/voximplant-user-activate-phone":"voximplant.user.activatePhone","/api-reference/telephony/voximplant/users/voximplant-user-deactivate-phone":"voximplant.user.deactivatePhone","/api-reference/telephony/voximplant/users/voximplant-user-get":"voximplant.user.get","/api-reference/telephony/voximplant/voximplant-callback-start":"voximplant.callback.start","/api-reference/telephony/voximplant/voximplant-infocall-start-with-sound":"voximplant.infocall.startwithsound","/api-reference/telephony/voximplant/voximplant-infocall-start-with-text":"voximplant.infocall.startwithtext","/api-reference/telephony/voximplant/voximplant-statistic-get":"voximplant.statistic.get","/api-reference/telephony/voximplant/voximplant-tts-voices-get":"voximplant.tts.voices.get","/api-reference/telephony/voximplant/voximplant-url-get":"voximplant.url.get","/api-reference/timeman/base/timeman-close":"timeman.close","/api-reference/timeman/base/timeman-open":"timeman.open","/api-reference/timeman/base/timeman-pause":"timeman.pause","/api-reference/timeman/base/timeman-settings":"timeman.settings","/api-reference/timeman/base/timeman-status":"timeman.status","/api-reference/timeman/networkrange/timeman-networkrange-check":"timeman.networkrange.check","/api-reference/timeman/networkrange/timeman-networkrange-get":"timeman.networkrange.get","/api-reference/timeman/networkrange/timeman-networkrange-set":"timeman.networkrange.set","/api-reference/timeman/record/timeman-record-field-get":"timeman.record.field.get","/api-reference/timeman/record/timeman-record-field-list":"timeman.record.field.list","/api-reference/timeman/record/timeman-record-list":"timeman.record.list","/api-reference/timeman/schedule/timeman-schedule-get":"timeman.schedule.get","/api-reference/timeman/timecontrol/timeman-timecontrol-report-add":"timeman.timecontrol.report.add","/api-reference/timeman/timecontrol/timeman-timecontrol-reports-get":"timeman.timecontrol.reports.get","/api-reference/timeman/timecontrol/timeman-timecontrol-reports-settings-get":"timeman.timecontrol.reports.settings.get","/api-reference/timeman/timecontrol/timeman-timecontrol-reports-users-get":"timeman.timecontrol.reports.users.get","/api-reference/timeman/timecontrol/timeman-timecontrol-settings-get":"timeman.timecontrol.settings.get","/api-reference/timeman/timecontrol/timeman-timecontrol-settings-set":"timeman.timecontrol.settings.set","/api-reference/user-consent/user-consent-agreement-list":"userconsent.agreement.list","/api-reference/user-consent/user-consent-agreement-text":"userconsent.agreement.text","/api-reference/user-consent/user-consent-consent-add":"userconsent.consent.add","/api-reference/user/user-add":"user.add","/api-reference/user/user-get":"user.get","/api-reference/user/user-search":"user.search","/api-reference/user/user-update":"user.update","/api-reference/user/userfields/user-userfield-add":"user.userfield.add","/api-reference/user/userfields/user-userfield-delete":"user.userfield.delete","/api-reference/user/userfields/user-userfield-list":"user.userfield.list","/api-reference/user/userfields/user-userfield-update":"user.userfield.update","/api-reference/vibe/landing-repowidget-debug":"landing.repowidget.debug","/api-reference/vibe/landing-repowidget-get-list":"landing.repowidget.getlist","/api-reference/vibe/landing-repowidget-register":"landing.repowidget.register","/api-reference/vibe/landing-repowidget-unregister":"landing.repowidget.unregister","/api-reference/vote/vote.attachedvote.download":"vote.AttachedVote.download","/api-reference/vote/vote.attachedvote.get":"vote.AttachedVote.get","/api-reference/vote/vote.attachedvote.getAnswerVoted":"vote.AttachedVote.getAnswerVoted","/api-reference/vote/vote.attachedvote.getMany":"vote.AttachedVote.getMany","/api-reference/vote/vote.attachedvote.getWithVoted":"vote.AttachedVote.getWithVoted","/api-reference/vote/vote.attachedvote.recall":"vote.AttachedVote.recall","/api-reference/vote/vote.attachedvote.resume":"vote.AttachedVote.resume","/api-reference/vote/vote.attachedvote.stop":"vote.AttachedVote.stop","/api-reference/vote/vote.attachedvote.vote":"vote.AttachedVote.vote","/api-reference/vote/vote.integration.im.send":"vote.Integration.Im.send","/api-reference/widgets/placement-get":"placement.get","/api-reference/widgets/placement-list":"placement.list","/api-reference/widgets/placement-unbind":"placement.unbind","/api-reference/widgets/user-field/userfieldtype-add":"userfieldtype.add","/api-reference/widgets/user-field/userfieldtype-delete":"userfieldtype.delete","/api-reference/widgets/user-field/userfieldtype-list":"userfieldtype.list","/api-reference/widgets/user-field/userfieldtype-update":"userfieldtype.update"} diff --git a/simulator/generate-spec.js b/simulator/generate-spec.js index 9c444fb80..be2a066f3 100644 --- a/simulator/generate-spec.js +++ b/simulator/generate-spec.js @@ -12,7 +12,8 @@ const path = require('path'); const { buildSpec } = require('./lib/build-spec.js'); const { parseTables } = require('./lib/yfm-table.js'); -const { PILOT_DIRS, READ_EXECUTABLE } = require('./lib/config.js'); +const { PILOT_DIRS, READ_EXECUTABLE, METHOD_ENTITY } = require('./lib/config.js'); +const B24Sim = require('./lib/core.js'); // Состав полей сущности описан не на странице списочного метода, а отдельно. // Для CRM это подтаблица «Параметр fields» у метода *.add, для задач — своя страница. @@ -110,6 +111,8 @@ function main() { } attachEntityFields(specs, byMethod); + const examples = attachRequestExample(specs); + const hints = attachDatasetHint(specs); report(specs, skipped, noteCounts, unknownTypes); @@ -193,6 +196,131 @@ function attachEntityFields(specs, byMethod) { } } +// Рабочий пример вызова. У ИИ-агента список параметров есть, а вызова, +// который точно проходит, — нет: отсюда «не передан обязательный параметр» +// как самый частый класс ошибок. Пример на странице обычно есть, но до +// схемы не доезжал. +// +// Кладём ТОЛЬКО тот, что проходит нашу же валидацию. Пример, противоречащий +// собственной таблице параметров, научит агента ошибке вместо вызова. +function attachRequestExample(specs) { + const bodyRe = /-d\s+'((?:[^']|'"[^"]*"')*)'\s*\\?\s*\n/g; + let attached = 0; + let rejected = 0; + + for (const spec of specs) { + const file = spec.source && spec.source.file; + if (!file || !fs.existsSync(file)) { + continue; + } + const markdown = fs.readFileSync(file, 'utf8'); + bodyRe.lastIndex = 0; + + let match; + while ((match = bodyRe.exec(markdown)) !== null) { + const raw = match[1].trim(); + if (!raw.startsWith('{')) { + continue; + } + // Подстановки оболочки — не пример, а шаблон. + if (/\$\(|\$\{|`|'"|\$[A-Za-z_]/.test(raw)) { + continue; + } + let body; + try { + body = JSON.parse(raw); + } catch (error) { + continue; + } + + const verdict = B24Sim.validate(spec, body); + if (verdict && verdict.ok) { + spec.requestExample = body; + attached += 1; + break; + } + rejected += 1; + } + } + return { attached, rejected }; +} + +// Какие идентификаторы реально лежат в тестовом датасете. Без этого агент +// подставляет единицу, получает «не найдено» и не понимает почему: у задач +// идентификаторы начинаются со 100. +function attachDatasetHint(specs) { + const file = path.join(OUT_DIR, '..', 'fixtures', 'dataset.json'); + if (!fs.existsSync(file)) { + return 0; + } + const dataset = JSON.parse(fs.readFileSync(file, 'utf8')); + let attached = 0; + const brokenRunnable = []; + + for (const spec of specs) { + const entity = METHOD_ENTITY[spec.method]; + const items = entity && dataset.entities && dataset.entities[entity]; + if (!items || !items.length) { + continue; + } + + const ids = items.map((item) => String(item.id !== undefined ? item.id : item.ID)); + const hint = { entity, count: items.length }; + const nums = ids.every((x) => /^\d+$/.test(x)) ? ids.map(Number).sort((a, b) => a - b) : null; + + if (nums && nums[nums.length - 1] - nums[0] + 1 === nums.length) { + hint.idFrom = nums[0]; + hint.idTo = nums[nums.length - 1]; + } else { + hint.ids = (nums ? nums.map(String) : ids).slice(0, 12); + } + + // Пример из документации ссылается на идентификаторы боевого + // портала: скопировав его в песочницу, агент получит «не найдено». + // Даём рядом тот же вызов с идентификатором, который здесь есть. + const first = (nums ? nums.map(String) : ids)[0]; + const idValue = /^\d+$/.test(first) ? Number(first) : first; + const isIdKey = (key) => /^(id|taskid)$/i.test(key); + + let runnable = null; + if (spec.requestExample && Object.keys(spec.requestExample).some(isIdKey)) { + runnable = {}; + for (const [key, value] of Object.entries(spec.requestExample)) { + runnable[key] = isIdKey(key) ? idValue : value; + } + } else { + const idParam = spec.params.find((param) => isIdKey(param.name)); + if (idParam) { + // Примера нет или он не прошёл валидацию — собираем + // минимальный сами: для get-метода это один параметр. + runnable = { [idParam.name]: idValue }; + } else { + // Списочный метод: годится пример со страницы, а если его + // нет — пустой вызов, он у списков осмыслен. + runnable = spec.requestExample || {}; + } + } + + // Публикуем только то, что сами прогнали: пример, который не + // работает, хуже отсутствующего. + if (runnable) { + const check = B24Sim.call(spec, runnable, dataset); + if (check && !check.error) { + hint.runnableExample = runnable; + } else { + brokenRunnable.push(spec.method + ' → ' + (check && check.error)); + } + } + + spec.datasetHint = hint; + attached += 1; + } + if (brokenRunnable.length) { + console.warn(' примеры для песочницы не прошли прогон: ' + brokenRunnable.join('; ')); + } + return attached; +} + function write(specs) { const methodsDir = path.join(OUT_DIR, 'methods'); fs.rmSync(OUT_DIR, { recursive: true, force: true }); @@ -248,6 +376,10 @@ function report(specs, skipped, noteCounts, unknownTypes) { console.log(' из них read : ' + specs.filter((s) => s.kind === 'read').length); console.log(' из них исполняемых : ' + executable); console.log(' с примером ответа : ' + withExample + ' (' + pct(withExample, specs.length) + ')'); + const withRequest = specs.filter((s) => s.requestExample).length; + const withHint = specs.filter((s) => s.datasetHint).length; + console.log(' с примером запроса : ' + withRequest + ' (' + pct(withRequest, specs.length) + ')'); + console.log(' с подсказкой по датасету: ' + withHint); console.log(' deprecated : ' + specs.filter((s) => s.deprecated).length); console.log('параметров всего : ' + totalParams); console.log(' обязательность неясна: ' + unknownRequired + ' (' + pct(unknownRequired, totalParams) + ')');