@hubex/mcp 0.5.0 → 0.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/schema/build-index.js +16 -1
- package/dist/schema/describe.js +1 -0
- package/dist/tools/discovery.js +2 -1
- package/generated/index.dev.json +914 -1055
- package/package.json +1 -1
- package/swagger/dev/AUTH.json +70 -22
- package/swagger/dev/AUTHN.json +5 -5
- package/swagger/dev/AUTHZ.json +13 -13
- package/swagger/dev/CM.json +22 -4
- package/swagger/dev/COMMON.json +41 -187
- package/swagger/dev/ES.json +7583 -2342
- package/swagger/dev/EXPORT.json +735 -2116
- package/swagger/dev/LIC.json +4 -4
- package/swagger/dev/MSG.json +518 -67
- package/swagger/dev/PA.json +627 -122
- package/swagger/dev/PMP.json +932 -46
- package/swagger/dev/PROXY.json +9 -6
- package/swagger/dev/REPORT.json +2 -2
- package/swagger/dev/SC.json +1936 -1149
- package/swagger/dev/SLA.json +2 -78
- package/swagger/dev/TSTG.json +272 -14
- package/swagger/dev/UI.json +62 -425
- package/swagger/dev/WORK.json +17949 -18386
- package/swagger/dev/WSP.json +190 -559
- package/swagger/prod/WORK.json +114 -84
package/swagger/dev/MSG.json
CHANGED
|
@@ -21,8 +21,32 @@
|
|
|
21
21
|
"ContentTypes"
|
|
22
22
|
],
|
|
23
23
|
"summary": "Возвращает список типов контента.",
|
|
24
|
-
"description": "Поддерживает ограничение результата через заголовок `Range`.\r\n \r\n## Пример запроса:\r\n```text\r\nGET /ContentTypes\r\nAuthorization: Bearer <token>\r\nRange:
|
|
24
|
+
"description": "Поддерживает ограничение результата через заголовок `Range`.\r\n \r\n## Пример запроса:\r\n```text\r\nGET /ContentTypes\r\nAuthorization: Bearer <token>\r\nRange: items=0-49\r\n```\r\n \r\n## Пример успешного ответа (200):\r\n```json\r\n{\r\n \"1\": {\r\n \"id\": 1,\r\n \"name\": \"HTML\",\r\n \"code\": \"HTML\"\r\n }\r\n}\r\n```\r\n \r\n## Пример успешного ответа (206):\r\nТело ответа имеет тот же формат, что и для `200`, но содержит только часть диапазона.\r\n \r\n## Негативные сценарии:\r\n- 401/403 — отсутствие или недостаточность прав доступа.\r\n- 204 — типы контента не найдены.",
|
|
25
25
|
"parameters": [
|
|
26
|
+
{
|
|
27
|
+
"name": "Range",
|
|
28
|
+
"in": "header",
|
|
29
|
+
"description": "Формат: items=FROM-TILL , где FROM - начальный элемент (включая), TILL - конечный элемент (включая)",
|
|
30
|
+
"schema": {
|
|
31
|
+
"type": "string"
|
|
32
|
+
}
|
|
33
|
+
},
|
|
34
|
+
{
|
|
35
|
+
"name": "offset",
|
|
36
|
+
"in": "query",
|
|
37
|
+
"description": "количество элементов, которое нобходимо пропустить",
|
|
38
|
+
"schema": {
|
|
39
|
+
"type": "string"
|
|
40
|
+
}
|
|
41
|
+
},
|
|
42
|
+
{
|
|
43
|
+
"name": "fetch",
|
|
44
|
+
"in": "query",
|
|
45
|
+
"description": "количество элементов, которое необходимо вернуть",
|
|
46
|
+
"schema": {
|
|
47
|
+
"type": "string"
|
|
48
|
+
}
|
|
49
|
+
},
|
|
26
50
|
{
|
|
27
51
|
"name": "X-Application-ID",
|
|
28
52
|
"in": "header",
|
|
@@ -225,8 +249,32 @@
|
|
|
225
249
|
"MailBoxes"
|
|
226
250
|
],
|
|
227
251
|
"summary": "Возвращает список почтовых ящиков.",
|
|
228
|
-
"description": "Поддерживает ограничение результата через заголовок `Range`.\r\n \r\n## Пример запроса:\r\n```text\r\nGET /MailBoxes\r\nAuthorization: Bearer <token>\r\nRange:
|
|
252
|
+
"description": "Поддерживает ограничение результата через заголовок `Range`.\r\n \r\n## Пример запроса:\r\n```text\r\nGET /MailBoxes\r\nAuthorization: Bearer <token>\r\nRange: items=0-49\r\n```\r\n \r\n## Пример успешного ответа (200):\r\n```json\r\n{\r\n \"1\": {\r\n \"id\": 1,\r\n \"name\": \"Support inbox\",\r\n \"isActive\": true,\r\n \"email\": \"support@example.com\",\r\n \"calls\": { \"remaining\": 2, \"total\": 5 },\r\n \"lastCall\": { \"completed\": \"2026-08-20T10:00:00Z\", \"exception\": null, \"hasError\": false }\r\n }\r\n}\r\n```\r\n \r\n## Пример успешного ответа (206):\r\nТело ответа имеет тот же формат, что и для `200`, но содержит только часть диапазона.\r\n \r\n## Негативные сценарии:\r\n- 401/403 — отсутствие или недостаточность прав доступа.\r\n- 204 — почтовые ящики не найдены.",
|
|
229
253
|
"parameters": [
|
|
254
|
+
{
|
|
255
|
+
"name": "Range",
|
|
256
|
+
"in": "header",
|
|
257
|
+
"description": "Формат: items=FROM-TILL , где FROM - начальный элемент (включая), TILL - конечный элемент (включая)",
|
|
258
|
+
"schema": {
|
|
259
|
+
"type": "string"
|
|
260
|
+
}
|
|
261
|
+
},
|
|
262
|
+
{
|
|
263
|
+
"name": "offset",
|
|
264
|
+
"in": "query",
|
|
265
|
+
"description": "количество элементов, которое нобходимо пропустить",
|
|
266
|
+
"schema": {
|
|
267
|
+
"type": "string"
|
|
268
|
+
}
|
|
269
|
+
},
|
|
270
|
+
{
|
|
271
|
+
"name": "fetch",
|
|
272
|
+
"in": "query",
|
|
273
|
+
"description": "количество элементов, которое необходимо вернуть",
|
|
274
|
+
"schema": {
|
|
275
|
+
"type": "string"
|
|
276
|
+
}
|
|
277
|
+
},
|
|
230
278
|
{
|
|
231
279
|
"name": "X-Application-ID",
|
|
232
280
|
"in": "header",
|
|
@@ -692,7 +740,7 @@
|
|
|
692
740
|
"MailBoxes"
|
|
693
741
|
],
|
|
694
742
|
"summary": "Возвращает ошибки чтения почтового ящика.",
|
|
695
|
-
"description": "Поддерживает фильтрацию по дате возникновения ошибки и ограничение результата через заголовок `Range`.\r\n \r\n## Пример запроса:\r\n```text\r\nGET /MailBoxes/1/errors?occurredFrom=2026-08-01T00:00:00Z&occurredTill=2026-08-31T23:59:59Z\r\nAuthorization: Bearer <token>\r\nRange:
|
|
743
|
+
"description": "Поддерживает фильтрацию по дате возникновения ошибки и ограничение результата через заголовок `Range`.\r\n \r\n## Пример запроса:\r\n```text\r\nGET /MailBoxes/1/errors?occurredFrom=2026-08-01T00:00:00Z&occurredTill=2026-08-31T23:59:59Z\r\nAuthorization: Bearer <token>\r\nRange: items=0-49\r\n```\r\n \r\n## Пример успешного ответа (200):\r\n```json\r\n[\r\n {\r\n \"tenantID\": 1,\r\n \"mailBoxID\": 1,\r\n \"name\": \"Support inbox\",\r\n \"email\": \"support@example.com\",\r\n \"occurred\": \"2026-08-20T10:00:00Z\",\r\n \"error\": \"Connection timeout\"\r\n }\r\n]\r\n```\r\n \r\n## Пример успешного ответа (206):\r\nТело ответа имеет тот же формат, что и для `200`, но содержит только часть диапазона.\r\n \r\n## Негативные сценарии:\r\n- 401/403 — отсутствие или недостаточность прав доступа.\r\n- 204 — ошибки не найдены.",
|
|
696
744
|
"parameters": [
|
|
697
745
|
{
|
|
698
746
|
"name": "id",
|
|
@@ -704,6 +752,48 @@
|
|
|
704
752
|
"format": "int32"
|
|
705
753
|
}
|
|
706
754
|
},
|
|
755
|
+
{
|
|
756
|
+
"name": "Range",
|
|
757
|
+
"in": "header",
|
|
758
|
+
"description": "Формат: items=FROM-TILL , где FROM - начальный элемент (включая), TILL - конечный элемент (включая)",
|
|
759
|
+
"schema": {
|
|
760
|
+
"type": "string"
|
|
761
|
+
}
|
|
762
|
+
},
|
|
763
|
+
{
|
|
764
|
+
"name": "offset",
|
|
765
|
+
"in": "query",
|
|
766
|
+
"description": "количество элементов, которое нобходимо пропустить",
|
|
767
|
+
"schema": {
|
|
768
|
+
"type": "string"
|
|
769
|
+
}
|
|
770
|
+
},
|
|
771
|
+
{
|
|
772
|
+
"name": "fetch",
|
|
773
|
+
"in": "query",
|
|
774
|
+
"description": "количество элементов, которое необходимо вернуть",
|
|
775
|
+
"schema": {
|
|
776
|
+
"type": "string"
|
|
777
|
+
}
|
|
778
|
+
},
|
|
779
|
+
{
|
|
780
|
+
"name": "occurredFrom",
|
|
781
|
+
"in": "query",
|
|
782
|
+
"description": "Начало периода фильтрации по дате возникновения ошибки",
|
|
783
|
+
"schema": {
|
|
784
|
+
"type": "string",
|
|
785
|
+
"format": "date-time"
|
|
786
|
+
}
|
|
787
|
+
},
|
|
788
|
+
{
|
|
789
|
+
"name": "occurredTill",
|
|
790
|
+
"in": "query",
|
|
791
|
+
"description": "Конец периода фильтрации по дате возникновения ошибки",
|
|
792
|
+
"schema": {
|
|
793
|
+
"type": "string",
|
|
794
|
+
"format": "date-time"
|
|
795
|
+
}
|
|
796
|
+
},
|
|
707
797
|
{
|
|
708
798
|
"name": "X-Application-ID",
|
|
709
799
|
"in": "header",
|
|
@@ -1127,8 +1217,32 @@
|
|
|
1127
1217
|
"MailBoxes"
|
|
1128
1218
|
],
|
|
1129
1219
|
"summary": "Возвращает список действий при неудачном применении регулярного выражения.",
|
|
1130
|
-
"description": "Справочник действий, которые выполняются, если регулярное выражение для темы или тела письма не совпало.\r\nПоддерживает ограничение результата через заголовок `Range`.\r\n \r\n## Пример запроса:\r\n```text\r\nGET /MailBoxes/regexactions\r\nAuthorization: Bearer <token>\r\nRange:
|
|
1220
|
+
"description": "Справочник действий, которые выполняются, если регулярное выражение для темы или тела письма не совпало.\r\nПоддерживает ограничение результата через заголовок `Range`.\r\n \r\n## Пример запроса:\r\n```text\r\nGET /MailBoxes/regexactions\r\nAuthorization: Bearer <token>\r\nRange: items=0-49\r\n```\r\n \r\n## Пример успешного ответа (200):\r\n```json\r\n{\r\n \"1\": {\r\n \"id\": 1,\r\n \"name\": \"Пропустить\"\r\n }\r\n}\r\n```\r\n \r\n## Пример успешного ответа (206):\r\nТело ответа имеет тот же формат, что и для `200`, но содержит только часть диапазона.\r\n \r\n## Негативные сценарии:\r\n- 401/403 — отсутствие или недостаточность прав доступа.\r\n- 204 — действия не найдены.",
|
|
1131
1221
|
"parameters": [
|
|
1222
|
+
{
|
|
1223
|
+
"name": "Range",
|
|
1224
|
+
"in": "header",
|
|
1225
|
+
"description": "Формат: items=FROM-TILL , где FROM - начальный элемент (включая), TILL - конечный элемент (включая)",
|
|
1226
|
+
"schema": {
|
|
1227
|
+
"type": "string"
|
|
1228
|
+
}
|
|
1229
|
+
},
|
|
1230
|
+
{
|
|
1231
|
+
"name": "offset",
|
|
1232
|
+
"in": "query",
|
|
1233
|
+
"description": "количество элементов, которое нобходимо пропустить",
|
|
1234
|
+
"schema": {
|
|
1235
|
+
"type": "string"
|
|
1236
|
+
}
|
|
1237
|
+
},
|
|
1238
|
+
{
|
|
1239
|
+
"name": "fetch",
|
|
1240
|
+
"in": "query",
|
|
1241
|
+
"description": "количество элементов, которое необходимо вернуть",
|
|
1242
|
+
"schema": {
|
|
1243
|
+
"type": "string"
|
|
1244
|
+
}
|
|
1245
|
+
},
|
|
1132
1246
|
{
|
|
1133
1247
|
"name": "X-Application-ID",
|
|
1134
1248
|
"in": "header",
|
|
@@ -1413,7 +1527,7 @@
|
|
|
1413
1527
|
"MailBoxes"
|
|
1414
1528
|
],
|
|
1415
1529
|
"summary": "Возвращает список отправителей почтового ящика.",
|
|
1416
|
-
"description": "Поддерживает ограничение результата через заголовок `Range`.\r\n \r\n## Пример запроса:\r\n```text\r\nGET /MailBoxes/1/senders\r\nAuthorization: Bearer <token>\r\nRange:
|
|
1530
|
+
"description": "Поддерживает ограничение результата через заголовок `Range`.\r\n \r\n## Пример запроса:\r\n```text\r\nGET /MailBoxes/1/senders\r\nAuthorization: Bearer <token>\r\nRange: items=0-49\r\n```\r\n \r\n## Пример успешного ответа (200):\r\n```json\r\n{\r\n \"10\": {\r\n \"id\": 10,\r\n \"mailBoxID\": 1,\r\n \"recipient\": \"sender@example.com\",\r\n \"taskTemplateID\": \"TMPL-001\",\r\n \"isActive\": true,\r\n \"sendResponse\": true,\r\n \"taskSubjectRegex\": \".*\",\r\n \"taskTextBodyRegex\": \".*\",\r\n \"regexNotMatchAction\": { \"id\": 1, \"name\": \"Skip\" },\r\n \"lastTask\": { \"id\": 100, \"number\": \"T-100\" },\r\n \"calls\": { \"remaining\": 1, \"total\": 3 },\r\n \"lastCall\": { \"started\": \"2026-08-20T10:00:00Z\", \"completed\": \"2026-08-20T10:00:01Z\", \"exception\": null, \"hasError\": false, \"lastRecipient\": \"sender@example.com\" }\r\n }\r\n}\r\n```\r\n \r\n## Пример успешного ответа (206):\r\nТело ответа имеет тот же формат, что и для `200`, но содержит только часть диапазона.\r\n \r\n## Негативные сценарии:\r\n- 401/403 — отсутствие или недостаточность прав доступа.\r\n- 204 — отправители не найдены.",
|
|
1417
1531
|
"parameters": [
|
|
1418
1532
|
{
|
|
1419
1533
|
"name": "mailBoxID",
|
|
@@ -1425,6 +1539,30 @@
|
|
|
1425
1539
|
"format": "int32"
|
|
1426
1540
|
}
|
|
1427
1541
|
},
|
|
1542
|
+
{
|
|
1543
|
+
"name": "Range",
|
|
1544
|
+
"in": "header",
|
|
1545
|
+
"description": "Формат: items=FROM-TILL , где FROM - начальный элемент (включая), TILL - конечный элемент (включая)",
|
|
1546
|
+
"schema": {
|
|
1547
|
+
"type": "string"
|
|
1548
|
+
}
|
|
1549
|
+
},
|
|
1550
|
+
{
|
|
1551
|
+
"name": "offset",
|
|
1552
|
+
"in": "query",
|
|
1553
|
+
"description": "количество элементов, которое нобходимо пропустить",
|
|
1554
|
+
"schema": {
|
|
1555
|
+
"type": "string"
|
|
1556
|
+
}
|
|
1557
|
+
},
|
|
1558
|
+
{
|
|
1559
|
+
"name": "fetch",
|
|
1560
|
+
"in": "query",
|
|
1561
|
+
"description": "количество элементов, которое необходимо вернуть",
|
|
1562
|
+
"schema": {
|
|
1563
|
+
"type": "string"
|
|
1564
|
+
}
|
|
1565
|
+
},
|
|
1428
1566
|
{
|
|
1429
1567
|
"name": "X-Application-ID",
|
|
1430
1568
|
"in": "header",
|
|
@@ -1627,7 +1765,7 @@
|
|
|
1627
1765
|
"MessageTemplates"
|
|
1628
1766
|
],
|
|
1629
1767
|
"summary": "Возвращает шаблон уведомлений по идентификатору.",
|
|
1630
|
-
"description": "Используется для просмотра и редактирования карточки шаблона уведомления.\r\n \r\n## Пример запроса:\r\n```text\r\nGET /MessageTemplates/1\r\nAuthorization: Bearer <token>\r\n```\r\n \r\n## Пример успешного ответа (200):\r\n```json\r\n{ \"id\": 1, \"description\": \"Welcome\", \"subject\": \"Hello\", \"content\": \"<p>Hi</p>\", \"validated\": \"2026-08-20T10:00:00Z\", \"isValid\": true, \"provider\": { \"id\": 1, \"code\": \"Email\", \"name\": \"Email\" }, \"application\": { \"id\": 2, \"code\": \"Portal\", \"name\": \"Portal\" }, \"navigateTo\": { \"id\": 3, \"code\": \"Task\", \"name\": \"Task\" }, \"contentType\": { \"id\": 1, \"code\": \"Html\", \"name\": \"HTML\" }, \"deleted\": null }\r\n```\r\n \r\n## Негативные сценарии:\r\n- 401
|
|
1768
|
+
"description": "Используется для просмотра и редактирования карточки шаблона уведомления.\r\n \r\n## Пример запроса:\r\n```text\r\nGET /MessageTemplates/1\r\nAuthorization: Bearer <token>\r\n```\r\n \r\n## Пример успешного ответа (200):\r\n```json\r\n{ \"id\": 1, \"description\": \"Welcome\", \"subject\": \"Hello\", \"content\": \"<p>Hi</p>\", \"validated\": \"2026-08-20T10:00:00Z\", \"isValid\": true, \"provider\": { \"id\": 1, \"code\": \"Email\", \"name\": \"Email\" }, \"application\": { \"id\": 2, \"code\": \"Portal\", \"name\": \"Portal\" }, \"navigateTo\": { \"id\": 3, \"code\": \"Task\", \"name\": \"Task\" }, \"contentType\": { \"id\": 1, \"code\": \"Html\", \"name\": \"HTML\" }, \"deleted\": null }\r\n```\r\n \r\n## Негативные сценарии:\r\n- 401 Unauthorized: отсутствует или некорректен Bearer-токен.\r\n- 403 Forbidden: недостаточно прав `MessageTemplateGet`.\r\n- 204 — шаблон с указанным идентификатором не найден.",
|
|
1631
1769
|
"parameters": [
|
|
1632
1770
|
{
|
|
1633
1771
|
"name": "id",
|
|
@@ -1668,10 +1806,10 @@
|
|
|
1668
1806
|
],
|
|
1669
1807
|
"responses": {
|
|
1670
1808
|
"401": {
|
|
1671
|
-
"description": "
|
|
1809
|
+
"description": "Отсутствует или некорректен Bearer-токен."
|
|
1672
1810
|
},
|
|
1673
1811
|
"403": {
|
|
1674
|
-
"description": "
|
|
1812
|
+
"description": "Недостаточно прав `MessageTemplateGet`."
|
|
1675
1813
|
},
|
|
1676
1814
|
"200": {
|
|
1677
1815
|
"description": "Шаблон уведомления успешно получен.",
|
|
@@ -1708,7 +1846,7 @@
|
|
|
1708
1846
|
"MessageTemplates"
|
|
1709
1847
|
],
|
|
1710
1848
|
"summary": "Помечает шаблон уведомлений как удаленный.",
|
|
1711
|
-
"description": "## Пример запроса:\r\n```text\r\nDELETE /MessageTemplates/1\r\nAuthorization: Bearer <token>\r\n```\r\n \r\n## Пример успешного ответа (202):\r\nТело ответа отсутствует.\r\n \r\n## Негативные сценарии:\r\n- 401
|
|
1849
|
+
"description": "## Пример запроса:\r\n```text\r\nDELETE /MessageTemplates/1\r\nAuthorization: Bearer <token>\r\n```\r\n \r\n## Пример успешного ответа (202):\r\nТело ответа отсутствует.\r\n \r\n## Негативные сценарии:\r\n- 401 Unauthorized: отсутствует или некорректен Bearer-токен.\r\n- 403 Forbidden: недостаточно прав `MessageTemplateDelete`.\r\n- 409 — шаблон не может быть удален из-за связанных данных.",
|
|
1712
1850
|
"parameters": [
|
|
1713
1851
|
{
|
|
1714
1852
|
"name": "id",
|
|
@@ -1749,10 +1887,10 @@
|
|
|
1749
1887
|
],
|
|
1750
1888
|
"responses": {
|
|
1751
1889
|
"401": {
|
|
1752
|
-
"description": "
|
|
1890
|
+
"description": "Отсутствует или некорректен Bearer-токен."
|
|
1753
1891
|
},
|
|
1754
1892
|
"403": {
|
|
1755
|
-
"description": "
|
|
1893
|
+
"description": "Недостаточно прав `MessageTemplateDelete`."
|
|
1756
1894
|
},
|
|
1757
1895
|
"202": {
|
|
1758
1896
|
"description": "Шаблон уведомления успешно помечен как удаленный."
|
|
@@ -1800,8 +1938,40 @@
|
|
|
1800
1938
|
"MessageTemplates"
|
|
1801
1939
|
],
|
|
1802
1940
|
"summary": "Возвращает список шаблонов уведомлений.",
|
|
1803
|
-
"description": "Поддерживает фильтрацию по query-параметрам и ограничение результата через заголовок `Range`.\r\n \r\n## Пример запроса:\r\n```text\r\nGET /MessageTemplates?isDeleted=false\r\nAuthorization: Bearer <token>\r\nRange:
|
|
1941
|
+
"description": "Поддерживает фильтрацию по query-параметрам и ограничение результата через заголовок `Range`.\r\n \r\n## Пример запроса:\r\n```text\r\nGET /MessageTemplates?isDeleted=false\r\nAuthorization: Bearer <token>\r\nRange: items=0-49\r\n```\r\n \r\n## Пример успешного ответа (200):\r\n```json\r\n{ \"1\": { \"id\": 1, \"description\": \"Welcome\", \"subject\": \"Hello\", \"validated\": \"2026-08-20T10:00:00Z\", \"isValid\": true, \"providerID\": 1, \"applicationID\": 2, \"navigateToID\": 3, \"contentTypeID\": 1 } }\r\n```\r\n \r\n## Пример успешного ответа (206):\r\nТело ответа имеет тот же формат, что и для `200`, но содержит только часть диапазона.\r\n \r\n## Негативные сценарии:\r\n- 401 Unauthorized: отсутствует или некорректен Bearer-токен.\r\n- 403 Forbidden: недостаточно прав `MessageTemplateList`.\r\n- 204 — шаблоны по фильтрам не найдены.",
|
|
1804
1942
|
"parameters": [
|
|
1943
|
+
{
|
|
1944
|
+
"name": "Range",
|
|
1945
|
+
"in": "header",
|
|
1946
|
+
"description": "Формат: items=FROM-TILL , где FROM - начальный элемент (включая), TILL - конечный элемент (включая)",
|
|
1947
|
+
"schema": {
|
|
1948
|
+
"type": "string"
|
|
1949
|
+
}
|
|
1950
|
+
},
|
|
1951
|
+
{
|
|
1952
|
+
"name": "offset",
|
|
1953
|
+
"in": "query",
|
|
1954
|
+
"description": "количество элементов, которое нобходимо пропустить",
|
|
1955
|
+
"schema": {
|
|
1956
|
+
"type": "string"
|
|
1957
|
+
}
|
|
1958
|
+
},
|
|
1959
|
+
{
|
|
1960
|
+
"name": "fetch",
|
|
1961
|
+
"in": "query",
|
|
1962
|
+
"description": "количество элементов, которое необходимо вернуть",
|
|
1963
|
+
"schema": {
|
|
1964
|
+
"type": "string"
|
|
1965
|
+
}
|
|
1966
|
+
},
|
|
1967
|
+
{
|
|
1968
|
+
"name": "isDeleted",
|
|
1969
|
+
"in": "query",
|
|
1970
|
+
"description": "Если true, результат будет содержать только удаленные шаблоны уведомлений, если false - только неудаленные",
|
|
1971
|
+
"schema": {
|
|
1972
|
+
"type": "boolean"
|
|
1973
|
+
}
|
|
1974
|
+
},
|
|
1805
1975
|
{
|
|
1806
1976
|
"name": "X-Application-ID",
|
|
1807
1977
|
"in": "header",
|
|
@@ -1831,10 +2001,10 @@
|
|
|
1831
2001
|
],
|
|
1832
2002
|
"responses": {
|
|
1833
2003
|
"401": {
|
|
1834
|
-
"description": "
|
|
2004
|
+
"description": "Отсутствует или некорректен Bearer-токен."
|
|
1835
2005
|
},
|
|
1836
2006
|
"403": {
|
|
1837
|
-
"description": "
|
|
2007
|
+
"description": "Недостаточно прав `MessageTemplateList`."
|
|
1838
2008
|
},
|
|
1839
2009
|
"200": {
|
|
1840
2010
|
"description": "Список шаблонов уведомлений успешно получен.",
|
|
@@ -1909,7 +2079,7 @@
|
|
|
1909
2079
|
"MessageTemplates"
|
|
1910
2080
|
],
|
|
1911
2081
|
"summary": "Создает шаблоны уведомлений.",
|
|
1912
|
-
"description": "## Пример запроса:\r\n```text\r\nPOST /MessageTemplates\r\nAuthorization: Bearer <token>\r\nContent-Type: application/json\r\n```\r\n \r\n```json\r\n[{ \"description\": \"Welcome\", \"providerID\": 1, \"applicationID\": 2, \"navigateToID\": 3, \"subject\": \"Hello\", \"content\": \"<p>Hi</p>\", \"contentTypeID\": 1 }]\r\n```\r\n \r\n## Пример успешного ответа (201):\r\n```json\r\n[1, 2]\r\n```\r\n \r\n## Негативные сценарии:\r\n- 401
|
|
2082
|
+
"description": "## Пример запроса:\r\n```text\r\nPOST /MessageTemplates\r\nAuthorization: Bearer <token>\r\nContent-Type: application/json\r\n```\r\n \r\n```json\r\n[{ \"description\": \"Welcome\", \"providerID\": 1, \"applicationID\": 2, \"navigateToID\": 3, \"subject\": \"Hello\", \"content\": \"<p>Hi</p>\", \"contentTypeID\": 1 }]\r\n```\r\n \r\n## Пример успешного ответа (201):\r\n```json\r\n[1, 2]\r\n```\r\n \r\n## Негативные сценарии:\r\n- 401 Unauthorized: отсутствует или некорректен Bearer-токен.\r\n- 403 Forbidden: недостаточно прав `MessageTemplateAdd`.\r\n- 400 — некорректные данные запроса.",
|
|
1913
2083
|
"parameters": [
|
|
1914
2084
|
{
|
|
1915
2085
|
"name": "X-Application-ID",
|
|
@@ -1977,13 +2147,13 @@
|
|
|
1977
2147
|
},
|
|
1978
2148
|
"responses": {
|
|
1979
2149
|
"401": {
|
|
1980
|
-
"description": "
|
|
2150
|
+
"description": "Отсутствует или некорректен Bearer-токен."
|
|
1981
2151
|
},
|
|
1982
2152
|
"403": {
|
|
1983
|
-
"description": "
|
|
2153
|
+
"description": "Недостаточно прав `MessageTemplateAdd`."
|
|
1984
2154
|
},
|
|
1985
2155
|
"400": {
|
|
1986
|
-
"description": "
|
|
2156
|
+
"description": "Некорректные данные запроса."
|
|
1987
2157
|
},
|
|
1988
2158
|
"201": {
|
|
1989
2159
|
"description": "Шаблоны уведомлений успешно созданы.",
|
|
@@ -2029,7 +2199,7 @@
|
|
|
2029
2199
|
"MessageTemplates"
|
|
2030
2200
|
],
|
|
2031
2201
|
"summary": "Изменяет шаблоны уведомлений.",
|
|
2032
|
-
"description": "## Пример запроса:\r\n```text\r\nPUT /MessageTemplates\r\nAuthorization: Bearer <token>\r\nContent-Type: application/json\r\n```\r\n \r\n```json\r\n[{ \"id\": 1, \"description\": \"Welcome updated\", \"providerID\": 1, \"applicationID\": 2, \"navigateToID\": 3, \"subject\": \"Hello\", \"content\": \"<p>Hi</p>\", \"contentTypeID\": 1 }]\r\n```\r\n \r\n## Пример успешного ответа (202):\r\nТело ответа отсутствует.\r\n \r\n## Негативные сценарии:\r\n- 401
|
|
2202
|
+
"description": "## Пример запроса:\r\n```text\r\nPUT /MessageTemplates\r\nAuthorization: Bearer <token>\r\nContent-Type: application/json\r\n```\r\n \r\n```json\r\n[{ \"id\": 1, \"description\": \"Welcome updated\", \"providerID\": 1, \"applicationID\": 2, \"navigateToID\": 3, \"subject\": \"Hello\", \"content\": \"<p>Hi</p>\", \"contentTypeID\": 1 }]\r\n```\r\n \r\n## Пример успешного ответа (202):\r\nТело ответа отсутствует.\r\n \r\n## Негативные сценарии:\r\n- 401 Unauthorized: отсутствует или некорректен Bearer-токен.\r\n- 403 Forbidden: недостаточно прав `MessageTemplateUpdate`.\r\n- 400 — некорректные данные запроса.",
|
|
2033
2203
|
"parameters": [
|
|
2034
2204
|
{
|
|
2035
2205
|
"name": "X-Application-ID",
|
|
@@ -2097,13 +2267,13 @@
|
|
|
2097
2267
|
},
|
|
2098
2268
|
"responses": {
|
|
2099
2269
|
"401": {
|
|
2100
|
-
"description": "
|
|
2270
|
+
"description": "Отсутствует или некорректен Bearer-токен."
|
|
2101
2271
|
},
|
|
2102
2272
|
"403": {
|
|
2103
|
-
"description": "
|
|
2273
|
+
"description": "Недостаточно прав `MessageTemplateUpdate`."
|
|
2104
2274
|
},
|
|
2105
2275
|
"400": {
|
|
2106
|
-
"description": "
|
|
2276
|
+
"description": "Некорректные данные запроса."
|
|
2107
2277
|
},
|
|
2108
2278
|
"202": {
|
|
2109
2279
|
"description": "Шаблоны уведомлений успешно изменены."
|
|
@@ -2120,7 +2290,7 @@
|
|
|
2120
2290
|
"MessageTemplates"
|
|
2121
2291
|
],
|
|
2122
2292
|
"summary": "Помечает шаблоны уведомлений как удаленные.",
|
|
2123
|
-
"description": "## Пример запроса:\r\n```text\r\nDELETE /MessageTemplates\r\nAuthorization: Bearer <token>\r\nContent-Type: application/json\r\n```\r\n \r\n```json\r\n[1, 2]\r\n```\r\n \r\n## Пример успешного ответа (202):\r\nТело ответа отсутствует.\r\n \r\n## Негативные сценарии:\r\n- 401
|
|
2293
|
+
"description": "## Пример запроса:\r\n```text\r\nDELETE /MessageTemplates\r\nAuthorization: Bearer <token>\r\nContent-Type: application/json\r\n```\r\n \r\n```json\r\n[1, 2]\r\n```\r\n \r\n## Пример успешного ответа (202):\r\nТело ответа отсутствует.\r\n \r\n## Негативные сценарии:\r\n- 401 Unauthorized: отсутствует или некорректен Bearer-токен.\r\n- 403 Forbidden: недостаточно прав `MessageTemplateDelete`.\r\n- 409 — шаблон не может быть удален из-за связанных данных.",
|
|
2124
2294
|
"parameters": [
|
|
2125
2295
|
{
|
|
2126
2296
|
"name": "X-Application-ID",
|
|
@@ -2192,10 +2362,10 @@
|
|
|
2192
2362
|
},
|
|
2193
2363
|
"responses": {
|
|
2194
2364
|
"401": {
|
|
2195
|
-
"description": "
|
|
2365
|
+
"description": "Отсутствует или некорректен Bearer-токен."
|
|
2196
2366
|
},
|
|
2197
2367
|
"403": {
|
|
2198
|
-
"description": "
|
|
2368
|
+
"description": "Недостаточно прав `MessageTemplateDelete`."
|
|
2199
2369
|
},
|
|
2200
2370
|
"202": {
|
|
2201
2371
|
"description": "Шаблоны уведомлений успешно помечены как удаленные."
|
|
@@ -2243,7 +2413,7 @@
|
|
|
2243
2413
|
"MessageTemplates"
|
|
2244
2414
|
],
|
|
2245
2415
|
"summary": "Валидирует шаблон уведомлений и сохраняет результат проверки.",
|
|
2246
|
-
"description": "Проверяет корректность шаблонов темы и содержимого через MessageBuilder.\r\n \r\n## Пример запроса:\r\n```text\r\nPUT /MessageTemplates/1/validate\r\nAuthorization: Bearer <token>\r\n```\r\n \r\n## Пример успешного ответа (200):\r\nТело ответа отсутствует.\r\n \r\n## Негативные сценарии:\r\n- 401
|
|
2416
|
+
"description": "Проверяет корректность шаблонов темы и содержимого через MessageBuilder.\r\n \r\n## Пример запроса:\r\n```text\r\nPUT /MessageTemplates/1/validate\r\nAuthorization: Bearer <token>\r\n```\r\n \r\n## Пример успешного ответа (200):\r\nТело ответа отсутствует.\r\n \r\n## Негативные сценарии:\r\n- 401 Unauthorized: отсутствует или некорректен Bearer-токен.\r\n- 403 Forbidden: недостаточно прав `MessageTemplateValidate`.\r\n- 204 — шаблон с указанным идентификатором не найден.\r\n- 400 — шаблон не прошел валидацию.",
|
|
2247
2417
|
"parameters": [
|
|
2248
2418
|
{
|
|
2249
2419
|
"name": "id",
|
|
@@ -2284,13 +2454,13 @@
|
|
|
2284
2454
|
],
|
|
2285
2455
|
"responses": {
|
|
2286
2456
|
"401": {
|
|
2287
|
-
"description": "
|
|
2457
|
+
"description": "Отсутствует или некорректен Bearer-токен."
|
|
2288
2458
|
},
|
|
2289
2459
|
"403": {
|
|
2290
|
-
"description": "
|
|
2460
|
+
"description": "Недостаточно прав `MessageTemplateValidate`."
|
|
2291
2461
|
},
|
|
2292
2462
|
"400": {
|
|
2293
|
-
"description": "
|
|
2463
|
+
"description": "Шаблон не прошел валидацию."
|
|
2294
2464
|
},
|
|
2295
2465
|
"200": {
|
|
2296
2466
|
"description": "Шаблон успешно провалидирован."
|
|
@@ -2312,8 +2482,32 @@
|
|
|
2312
2482
|
"NavigateTo"
|
|
2313
2483
|
],
|
|
2314
2484
|
"summary": "Возвращает список переходов.",
|
|
2315
|
-
"description": "Поддерживает ограничение результата через заголовок `Range`.\r\n \r\n## Пример запроса:\r\n```text\r\nGET /NavigateTo\r\nAuthorization: Bearer <token>\r\nRange:
|
|
2485
|
+
"description": "Поддерживает ограничение результата через заголовок `Range`.\r\n \r\n## Пример запроса:\r\n```text\r\nGET /NavigateTo\r\nAuthorization: Bearer <token>\r\nRange: items=0-49\r\n```\r\n \r\n## Пример успешного ответа (200):\r\n```json\r\n{\r\n \"1\": {\r\n \"id\": 1,\r\n \"code\": \"TASK\",\r\n \"name\": \"Заявка\"\r\n }\r\n}\r\n```\r\n \r\n## Пример успешного ответа (206):\r\nТело ответа имеет тот же формат, что и для `200`, но содержит только часть диапазона.\r\n \r\n## Негативные сценарии:\r\n- 401/403 — отсутствие или недостаточность прав доступа.\r\n- 204 — переходы не найдены.",
|
|
2316
2486
|
"parameters": [
|
|
2487
|
+
{
|
|
2488
|
+
"name": "Range",
|
|
2489
|
+
"in": "header",
|
|
2490
|
+
"description": "Формат: items=FROM-TILL , где FROM - начальный элемент (включая), TILL - конечный элемент (включая)",
|
|
2491
|
+
"schema": {
|
|
2492
|
+
"type": "string"
|
|
2493
|
+
}
|
|
2494
|
+
},
|
|
2495
|
+
{
|
|
2496
|
+
"name": "offset",
|
|
2497
|
+
"in": "query",
|
|
2498
|
+
"description": "количество элементов, которое нобходимо пропустить",
|
|
2499
|
+
"schema": {
|
|
2500
|
+
"type": "string"
|
|
2501
|
+
}
|
|
2502
|
+
},
|
|
2503
|
+
{
|
|
2504
|
+
"name": "fetch",
|
|
2505
|
+
"in": "query",
|
|
2506
|
+
"description": "количество элементов, которое необходимо вернуть",
|
|
2507
|
+
"schema": {
|
|
2508
|
+
"type": "string"
|
|
2509
|
+
}
|
|
2510
|
+
},
|
|
2317
2511
|
{
|
|
2318
2512
|
"name": "X-Application-ID",
|
|
2319
2513
|
"in": "header",
|
|
@@ -2423,8 +2617,32 @@
|
|
|
2423
2617
|
"Notifications"
|
|
2424
2618
|
],
|
|
2425
2619
|
"summary": "Возвращает список полей, используемых в шаблонах уведомлений.",
|
|
2426
|
-
"description": "Поддерживает ограничение результата через заголовок `Range`.\r\n \r\n## Пример запроса:\r\n```text\r\nGET /Notifications/fields\r\nAuthorization: Bearer <token>\r\nRange:
|
|
2620
|
+
"description": "Поддерживает ограничение результата через заголовок `Range`.\r\n \r\n## Пример запроса:\r\n```text\r\nGET /Notifications/fields\r\nAuthorization: Bearer <token>\r\nRange: items=0-49\r\n```\r\n \r\n## Пример успешного ответа (200):\r\n```json\r\n{\r\n \"TaskNumber\": \"Номер заявки\",\r\n \"UserName\": \"Имя пользователя\"\r\n}\r\n```\r\n \r\n## Пример успешного ответа (206):\r\nТело ответа имеет тот же формат, что и для `200`, но содержит только часть диапазона.\r\n \r\n## Негативные сценарии:\r\n- 401/403 — отсутствие или недостаточность прав доступа.\r\n- 204 — поля не найдены.",
|
|
2427
2621
|
"parameters": [
|
|
2622
|
+
{
|
|
2623
|
+
"name": "Range",
|
|
2624
|
+
"in": "header",
|
|
2625
|
+
"description": "Формат: items=FROM-TILL , где FROM - начальный элемент (включая), TILL - конечный элемент (включая)",
|
|
2626
|
+
"schema": {
|
|
2627
|
+
"type": "string"
|
|
2628
|
+
}
|
|
2629
|
+
},
|
|
2630
|
+
{
|
|
2631
|
+
"name": "offset",
|
|
2632
|
+
"in": "query",
|
|
2633
|
+
"description": "количество элементов, которое нобходимо пропустить",
|
|
2634
|
+
"schema": {
|
|
2635
|
+
"type": "string"
|
|
2636
|
+
}
|
|
2637
|
+
},
|
|
2638
|
+
{
|
|
2639
|
+
"name": "fetch",
|
|
2640
|
+
"in": "query",
|
|
2641
|
+
"description": "количество элементов, которое необходимо вернуть",
|
|
2642
|
+
"schema": {
|
|
2643
|
+
"type": "string"
|
|
2644
|
+
}
|
|
2645
|
+
},
|
|
2428
2646
|
{
|
|
2429
2647
|
"name": "X-Application-ID",
|
|
2430
2648
|
"in": "header",
|
|
@@ -2596,7 +2814,7 @@
|
|
|
2596
2814
|
"Notifications"
|
|
2597
2815
|
],
|
|
2598
2816
|
"summary": "Возвращает список уведомлений пользователя.",
|
|
2599
|
-
"description": "Поддерживает ограничение результата через заголовок `Range`.\r\n \r\n## Пример запроса:\r\n```text\r\nGET /Notifications?includeIsViewed=false\r\nAuthorization: Bearer <token>\r\nRange:
|
|
2817
|
+
"description": "Поддерживает ограничение результата через заголовок `Range`.\r\n \r\n## Пример запроса:\r\n```text\r\nGET /Notifications?includeIsViewed=false\r\nAuthorization: Bearer <token>\r\nRange: items=0-24\r\n```\r\n \r\n## Пример успешного ответа (200):\r\n```json\r\n{\r\n \"101\": {\r\n \"id\": 101,\r\n \"providerID\": 1,\r\n \"subject\": \"Новая заявка\",\r\n \"content\": \"Создана заявка №123\",\r\n \"contentTypeID\": 1,\r\n \"created\": \"2026-08-20T10:00:00Z\",\r\n \"sent\": \"2026-08-20T10:00:01Z\",\r\n \"navigateTo\": 3,\r\n \"taskID\": 123,\r\n \"isViewed\": false\r\n }\r\n}\r\n```\r\n \r\n## Пример успешного ответа (206):\r\nТело ответа имеет тот же формат, что и для `200`, но содержит только часть диапазона.\r\n \r\n## Негативные сценарии:\r\n- 401/403 — отсутствие или недостаточность прав доступа.\r\n- 204 — уведомления не найдены.",
|
|
2600
2818
|
"parameters": [
|
|
2601
2819
|
{
|
|
2602
2820
|
"name": "includeIsViewed",
|
|
@@ -2606,6 +2824,30 @@
|
|
|
2606
2824
|
"type": "boolean"
|
|
2607
2825
|
}
|
|
2608
2826
|
},
|
|
2827
|
+
{
|
|
2828
|
+
"name": "Range",
|
|
2829
|
+
"in": "header",
|
|
2830
|
+
"description": "Формат: items=FROM-TILL , где FROM - начальный элемент (включая), TILL - конечный элемент (включая)",
|
|
2831
|
+
"schema": {
|
|
2832
|
+
"type": "string"
|
|
2833
|
+
}
|
|
2834
|
+
},
|
|
2835
|
+
{
|
|
2836
|
+
"name": "offset",
|
|
2837
|
+
"in": "query",
|
|
2838
|
+
"description": "количество элементов, которое нобходимо пропустить",
|
|
2839
|
+
"schema": {
|
|
2840
|
+
"type": "string"
|
|
2841
|
+
}
|
|
2842
|
+
},
|
|
2843
|
+
{
|
|
2844
|
+
"name": "fetch",
|
|
2845
|
+
"in": "query",
|
|
2846
|
+
"description": "количество элементов, которое необходимо вернуть",
|
|
2847
|
+
"schema": {
|
|
2848
|
+
"type": "string"
|
|
2849
|
+
}
|
|
2850
|
+
},
|
|
2609
2851
|
{
|
|
2610
2852
|
"name": "X-Application-ID",
|
|
2611
2853
|
"in": "header",
|
|
@@ -2906,8 +3148,32 @@
|
|
|
2906
3148
|
"Protocols"
|
|
2907
3149
|
],
|
|
2908
3150
|
"summary": "Возвращает список протоколов.",
|
|
2909
|
-
"description": "Поддерживает ограничение результата через заголовок `Range`.\r\n \r\n## Пример запроса:\r\n```text\r\nGET /Protocols\r\nAuthorization: Bearer <token>\r\nRange:
|
|
3151
|
+
"description": "Поддерживает ограничение результата через заголовок `Range`.\r\n \r\n## Пример запроса:\r\n```text\r\nGET /Protocols\r\nAuthorization: Bearer <token>\r\nRange: items=0-49\r\n```\r\n \r\n## Пример успешного ответа (200):\r\n```json\r\n{\r\n \"1\": {\r\n \"id\": 1,\r\n \"name\": \"SMTP\"\r\n }\r\n}\r\n```\r\n \r\n## Пример успешного ответа (206):\r\nТело ответа имеет тот же формат, что и для `200`, но содержит только часть диапазона.\r\n \r\n## Негативные сценарии:\r\n- 401/403 — отсутствие или недостаточность прав доступа.\r\n- 204 — протоколы не найдены.",
|
|
2910
3152
|
"parameters": [
|
|
3153
|
+
{
|
|
3154
|
+
"name": "Range",
|
|
3155
|
+
"in": "header",
|
|
3156
|
+
"description": "Формат: items=FROM-TILL , где FROM - начальный элемент (включая), TILL - конечный элемент (включая)",
|
|
3157
|
+
"schema": {
|
|
3158
|
+
"type": "string"
|
|
3159
|
+
}
|
|
3160
|
+
},
|
|
3161
|
+
{
|
|
3162
|
+
"name": "offset",
|
|
3163
|
+
"in": "query",
|
|
3164
|
+
"description": "количество элементов, которое нобходимо пропустить",
|
|
3165
|
+
"schema": {
|
|
3166
|
+
"type": "string"
|
|
3167
|
+
}
|
|
3168
|
+
},
|
|
3169
|
+
{
|
|
3170
|
+
"name": "fetch",
|
|
3171
|
+
"in": "query",
|
|
3172
|
+
"description": "количество элементов, которое необходимо вернуть",
|
|
3173
|
+
"schema": {
|
|
3174
|
+
"type": "string"
|
|
3175
|
+
}
|
|
3176
|
+
},
|
|
2911
3177
|
{
|
|
2912
3178
|
"name": "X-Application-ID",
|
|
2913
3179
|
"in": "header",
|
|
@@ -3017,8 +3283,32 @@
|
|
|
3017
3283
|
"Providers"
|
|
3018
3284
|
],
|
|
3019
3285
|
"summary": "Возвращает список провайдеров сообщений.",
|
|
3020
|
-
"description": "Поддерживает ограничение результата через заголовок `Range`.\r\n \r\n## Пример запроса:\r\n```text\r\nGET /Providers\r\nAuthorization: Bearer <token>\r\nRange:
|
|
3286
|
+
"description": "Поддерживает ограничение результата через заголовок `Range`.\r\n \r\n## Пример запроса:\r\n```text\r\nGET /Providers\r\nAuthorization: Bearer <token>\r\nRange: items=0-49\r\n```\r\n \r\n## Пример успешного ответа (200):\r\n```json\r\n{\r\n \"1\": {\r\n \"id\": 1,\r\n \"name\": \"SMS\",\r\n \"code\": \"SMS\",\r\n \"descriptionRu\": \"SMS-провайдер\"\r\n }\r\n}\r\n```\r\n \r\n## Пример успешного ответа (206):\r\nТело ответа имеет тот же формат, что и для `200`, но содержит только часть диапазона.\r\n \r\n## Негативные сценарии:\r\n- 401/403 — отсутствие или недостаточность прав доступа.\r\n- 204 — провайдеры не найдены.",
|
|
3021
3287
|
"parameters": [
|
|
3288
|
+
{
|
|
3289
|
+
"name": "Range",
|
|
3290
|
+
"in": "header",
|
|
3291
|
+
"description": "Формат: items=FROM-TILL , где FROM - начальный элемент (включая), TILL - конечный элемент (включая)",
|
|
3292
|
+
"schema": {
|
|
3293
|
+
"type": "string"
|
|
3294
|
+
}
|
|
3295
|
+
},
|
|
3296
|
+
{
|
|
3297
|
+
"name": "offset",
|
|
3298
|
+
"in": "query",
|
|
3299
|
+
"description": "количество элементов, которое нобходимо пропустить",
|
|
3300
|
+
"schema": {
|
|
3301
|
+
"type": "string"
|
|
3302
|
+
}
|
|
3303
|
+
},
|
|
3304
|
+
{
|
|
3305
|
+
"name": "fetch",
|
|
3306
|
+
"in": "query",
|
|
3307
|
+
"description": "количество элементов, которое необходимо вернуть",
|
|
3308
|
+
"schema": {
|
|
3309
|
+
"type": "string"
|
|
3310
|
+
}
|
|
3311
|
+
},
|
|
3022
3312
|
{
|
|
3023
3313
|
"name": "X-Application-ID",
|
|
3024
3314
|
"in": "header",
|
|
@@ -3128,7 +3418,7 @@
|
|
|
3128
3418
|
"RecipientSelectionRules"
|
|
3129
3419
|
],
|
|
3130
3420
|
"summary": "Возвращает правило выбора получателя по идентификатору.",
|
|
3131
|
-
"description": "## Пример запроса:\r\n```text\r\nGET /RecipientSelectionRules/1\r\nAuthorization: Bearer <token>\r\n```\r\n \r\n## Пример успешного ответа (200):\r\n```json\r\n{ \"id\": 1, \"description\": \"Исполнитель и руководитель\", \"isCaller\": false, \"isTaskRequestor\": true, \"isTaskAssignee\": true, \"isPreviousTaskAssignee\": false, \"isTaskAssigneeManager\": true, \"isTaskContact\": false, \"isTaskAssetResponsiblePerson\": false, \"isTenantPowerUser\": false, \"isTaskWatchList\": false, \"isForRelevantUsers\": false, \"isForRelevantUsersByWorkType\": false, \"isCustomOrgUnitManager\": null, \"isCustomOrgUnitStaff\": null, \"customEmailList\": null, \"customPhoneList\": null, \"useUnverifiedContacts\": false, \"orgUnitsUpwardTillRole\": { \"id\": 5, \"name\": \"Manager\", \"description\": \"Руководитель\" }, \"customAssetResponsible\": null, \"customUser\": null, \"customOrgUnit\": null, \"customRole\": null, \"deleted\": null }\r\n```\r\n \r\n## Негативные сценарии:\r\n- 401/403 —
|
|
3421
|
+
"description": "## Пример запроса:\r\n```text\r\nGET /RecipientSelectionRules/1\r\nAuthorization: Bearer <token>\r\n```\r\n \r\n## Пример успешного ответа (200):\r\n```json\r\n{ \"id\": 1, \"description\": \"Исполнитель и руководитель\", \"isCaller\": false, \"isTaskRequestor\": true, \"isTaskAssignee\": true, \"isPreviousTaskAssignee\": false, \"isTaskAssigneeManager\": true, \"isTaskContact\": false, \"isTaskAssetResponsiblePerson\": false, \"isTenantPowerUser\": false, \"isTaskWatchList\": false, \"isForRelevantUsers\": false, \"isForRelevantUsersByWorkType\": false, \"isCustomOrgUnitManager\": null, \"isCustomOrgUnitStaff\": null, \"customEmailList\": null, \"customPhoneList\": null, \"useUnverifiedContacts\": false, \"orgUnitsUpwardTillRole\": { \"id\": 5, \"name\": \"Manager\", \"description\": \"Руководитель\" }, \"customAssetResponsible\": null, \"customUser\": null, \"customOrgUnit\": null, \"customRole\": null, \"deleted\": null }\r\n```\r\n \r\n## Негативные сценарии:\r\n- 401/403 — отсутствие или недостаточность прав доступа.\r\n- 204 — правило с указанным идентификатором не найдено.",
|
|
3132
3422
|
"parameters": [
|
|
3133
3423
|
{
|
|
3134
3424
|
"name": "id",
|
|
@@ -3209,7 +3499,7 @@
|
|
|
3209
3499
|
"RecipientSelectionRules"
|
|
3210
3500
|
],
|
|
3211
3501
|
"summary": "Помечает правило выбора получателя как удаленное.",
|
|
3212
|
-
"description": "## Пример запроса:\r\n```text\r\nDELETE /RecipientSelectionRules/1\r\nAuthorization: Bearer <token>\r\n```\r\n \r\n## Пример успешного ответа (202):\r\nТело ответа отсутствует.\r\n \r\n## Негативные сценарии:\r\n- 401/403 —
|
|
3502
|
+
"description": "## Пример запроса:\r\n```text\r\nDELETE /RecipientSelectionRules/1\r\nAuthorization: Bearer <token>\r\n```\r\n \r\n## Пример успешного ответа (202):\r\nТело ответа отсутствует.\r\n \r\n## Негативные сценарии:\r\n- 401/403 — отсутствие или недостаточность прав доступа.\r\n- 409 — правило не может быть удалено из-за связанных данных.",
|
|
3213
3503
|
"parameters": [
|
|
3214
3504
|
{
|
|
3215
3505
|
"name": "id",
|
|
@@ -3301,8 +3591,49 @@
|
|
|
3301
3591
|
"RecipientSelectionRules"
|
|
3302
3592
|
],
|
|
3303
3593
|
"summary": "Возвращает список правил выбора получателя.",
|
|
3304
|
-
"description": "Поддерживает фильтрацию по query-параметрам и ограничение результата через заголовок `Range`.\r\n \r\n## Пример запроса:\r\n```text\r\nGET /RecipientSelectionRules?isDeleted=false&triggerID=10\r\nAuthorization: Bearer <token>\r\nRange:
|
|
3594
|
+
"description": "Поддерживает фильтрацию по query-параметрам и ограничение результата через заголовок `Range`.\r\n \r\n## Пример запроса:\r\n```text\r\nGET /RecipientSelectionRules?isDeleted=false&triggerID=10\r\nAuthorization: Bearer <token>\r\nRange: items=0-49\r\n```\r\n \r\n## Пример успешного ответа (200):\r\n```json\r\n{ \"1\": { \"id\": 1, \"description\": \"Исполнитель и руководитель\", \"isCaller\": false, \"isTaskRequestor\": true, \"isTaskAssignee\": true, \"isPreviousTaskAssignee\": false, \"isTaskAssigneeManager\": true, \"isTaskContact\": false, \"isTaskAssetResponsiblePerson\": false, \"isTenantPowerUser\": false, \"isTaskWatchList\": false, \"isForRelevantUsers\": false, \"isForRelevantUsersByWorkType\": false, \"deleted\": null } }\r\n```\r\n \r\n## Пример успешного ответа (206):\r\nТело ответа имеет тот же формат, что и для `200`, но содержит только часть диапазона.\r\n \r\n## Негативные сценарии:\r\n- 401/403 — отсутствие или недостаточность прав доступа.\r\n- 204 — правила по фильтрам не найдены.",
|
|
3305
3595
|
"parameters": [
|
|
3596
|
+
{
|
|
3597
|
+
"name": "Range",
|
|
3598
|
+
"in": "header",
|
|
3599
|
+
"description": "Формат: items=FROM-TILL , где FROM - начальный элемент (включая), TILL - конечный элемент (включая)",
|
|
3600
|
+
"schema": {
|
|
3601
|
+
"type": "string"
|
|
3602
|
+
}
|
|
3603
|
+
},
|
|
3604
|
+
{
|
|
3605
|
+
"name": "offset",
|
|
3606
|
+
"in": "query",
|
|
3607
|
+
"description": "количество элементов, которое нобходимо пропустить",
|
|
3608
|
+
"schema": {
|
|
3609
|
+
"type": "string"
|
|
3610
|
+
}
|
|
3611
|
+
},
|
|
3612
|
+
{
|
|
3613
|
+
"name": "fetch",
|
|
3614
|
+
"in": "query",
|
|
3615
|
+
"description": "количество элементов, которое необходимо вернуть",
|
|
3616
|
+
"schema": {
|
|
3617
|
+
"type": "string"
|
|
3618
|
+
}
|
|
3619
|
+
},
|
|
3620
|
+
{
|
|
3621
|
+
"name": "isDeleted",
|
|
3622
|
+
"in": "query",
|
|
3623
|
+
"description": "Если true, результат будет содержать только удаленные правила, если false - только неудаленные",
|
|
3624
|
+
"schema": {
|
|
3625
|
+
"type": "boolean"
|
|
3626
|
+
}
|
|
3627
|
+
},
|
|
3628
|
+
{
|
|
3629
|
+
"name": "triggerID",
|
|
3630
|
+
"in": "query",
|
|
3631
|
+
"description": "Идентификаторы триггеров, по которым будет отфильтрован результат",
|
|
3632
|
+
"schema": {
|
|
3633
|
+
"type": "integer",
|
|
3634
|
+
"format": "int32"
|
|
3635
|
+
}
|
|
3636
|
+
},
|
|
3306
3637
|
{
|
|
3307
3638
|
"name": "X-Application-ID",
|
|
3308
3639
|
"in": "header",
|
|
@@ -3410,7 +3741,7 @@
|
|
|
3410
3741
|
"RecipientSelectionRules"
|
|
3411
3742
|
],
|
|
3412
3743
|
"summary": "Создает правила выбора получателя.",
|
|
3413
|
-
"description": "## Пример запроса:\r\n```text\r\nPOST /RecipientSelectionRules\r\nAuthorization: Bearer <token>\r\nContent-Type: application/json\r\n```\r\n \r\n```json\r\n[{ \"description\": \"Исполнитель и руководитель\", \"isCaller\": false, \"isTaskRequestor\": true, \"isTaskAssignee\": true, \"isPreviousTaskAssignee\": false, \"isTaskAssigneeManager\": true, \"isTaskContact\": false, \"isTaskAssetResponsiblePerson\": false, \"isTenantPowerUser\": false, \"isTaskWatchList\": false, \"isForRelevantUsers\": false, \"isForRelevantUsersByWorkType\": false, \"orgUnitsUpwardTillRoleID\": 5, \"customAssetResponsiblePerson\": null, \"customOrgUnitID\": null, \"isCustomOrgUnitManager\": null, \"isCustomOrgUnitStaff\": null, \"customUserID\": null, \"customRoleID\": null, \"customEmailList\": null, \"customPhoneList\": null, \"useUnverifiedContacts\": false }]\r\n```\r\n \r\n## Пример успешного ответа (201):\r\n```json\r\n[1]\r\n```\r\n \r\n## Негативные сценарии:\r\n- 401/403 —
|
|
3744
|
+
"description": "## Пример запроса:\r\n```text\r\nPOST /RecipientSelectionRules\r\nAuthorization: Bearer <token>\r\nContent-Type: application/json\r\n```\r\n \r\n```json\r\n[{ \"description\": \"Исполнитель и руководитель\", \"isCaller\": false, \"isTaskRequestor\": true, \"isTaskAssignee\": true, \"isPreviousTaskAssignee\": false, \"isTaskAssigneeManager\": true, \"isTaskContact\": false, \"isTaskAssetResponsiblePerson\": false, \"isTenantPowerUser\": false, \"isTaskWatchList\": false, \"isForRelevantUsers\": false, \"isForRelevantUsersByWorkType\": false, \"orgUnitsUpwardTillRoleID\": 5, \"customAssetResponsiblePerson\": null, \"customOrgUnitID\": null, \"isCustomOrgUnitManager\": null, \"isCustomOrgUnitStaff\": null, \"customUserID\": null, \"customRoleID\": null, \"customEmailList\": null, \"customPhoneList\": null, \"useUnverifiedContacts\": false }]\r\n```\r\n \r\n## Пример успешного ответа (201):\r\n```json\r\n[1]\r\n```\r\n \r\n## Негативные сценарии:\r\n- 401/403 — отсутствие или недостаточность прав доступа.\r\n- 400 — некорректные данные запроса.",
|
|
3414
3745
|
"parameters": [
|
|
3415
3746
|
{
|
|
3416
3747
|
"name": "X-Application-ID",
|
|
@@ -3530,7 +3861,7 @@
|
|
|
3530
3861
|
"RecipientSelectionRules"
|
|
3531
3862
|
],
|
|
3532
3863
|
"summary": "Изменяет правила выбора получателя.",
|
|
3533
|
-
"description": "## Пример запроса:\r\n```text\r\nPUT /RecipientSelectionRules\r\nAuthorization: Bearer <token>\r\nContent-Type: application/json\r\n```\r\n \r\n```json\r\n[{ \"id\": 1, \"description\": \"Исполнитель и руководитель\", \"isCaller\": false, \"isTaskRequestor\": true, \"isTaskAssignee\": true, \"isPreviousTaskAssignee\": false, \"isTaskAssigneeManager\": true, \"isTaskContact\": false, \"isTaskAssetResponsiblePerson\": false, \"isTenantPowerUser\": false, \"isTaskWatchList\": false, \"isForRelevantUsers\": false, \"isForRelevantUsersByWorkType\": false, \"orgUnitsUpwardTillRoleID\": 5, \"customAssetResponsiblePerson\": null, \"customOrgUnitID\": null, \"isCustomOrgUnitManager\": null, \"isCustomOrgUnitStaff\": null, \"customUserID\": null, \"customRoleID\": null, \"customEmailList\": null, \"customPhoneList\": null, \"useUnverifiedContacts\": false }]\r\n```\r\n \r\n## Пример успешного ответа (202):\r\nТело ответа отсутствует.\r\n \r\n## Негативные сценарии:\r\n- 401/403 —
|
|
3864
|
+
"description": "## Пример запроса:\r\n```text\r\nPUT /RecipientSelectionRules\r\nAuthorization: Bearer <token>\r\nContent-Type: application/json\r\n```\r\n \r\n```json\r\n[{ \"id\": 1, \"description\": \"Исполнитель и руководитель\", \"isCaller\": false, \"isTaskRequestor\": true, \"isTaskAssignee\": true, \"isPreviousTaskAssignee\": false, \"isTaskAssigneeManager\": true, \"isTaskContact\": false, \"isTaskAssetResponsiblePerson\": false, \"isTenantPowerUser\": false, \"isTaskWatchList\": false, \"isForRelevantUsers\": false, \"isForRelevantUsersByWorkType\": false, \"orgUnitsUpwardTillRoleID\": 5, \"customAssetResponsiblePerson\": null, \"customOrgUnitID\": null, \"isCustomOrgUnitManager\": null, \"isCustomOrgUnitStaff\": null, \"customUserID\": null, \"customRoleID\": null, \"customEmailList\": null, \"customPhoneList\": null, \"useUnverifiedContacts\": false }]\r\n```\r\n \r\n## Пример успешного ответа (202):\r\nТело ответа отсутствует.\r\n \r\n## Негативные сценарии:\r\n- 401/403 — отсутствие или недостаточность прав доступа.\r\n- 400 — некорректные данные запроса.",
|
|
3534
3865
|
"parameters": [
|
|
3535
3866
|
{
|
|
3536
3867
|
"name": "X-Application-ID",
|
|
@@ -3621,7 +3952,7 @@
|
|
|
3621
3952
|
"RecipientSelectionRules"
|
|
3622
3953
|
],
|
|
3623
3954
|
"summary": "Помечает правила выбора получателя как удаленные.",
|
|
3624
|
-
"description": "## Пример запроса:\r\n```text\r\nDELETE /RecipientSelectionRules\r\nAuthorization: Bearer <token>\r\nContent-Type: application/json\r\n```\r\n \r\n```json\r\n[1, 2]\r\n```\r\n \r\n## Пример успешного ответа (202):\r\nТело ответа отсутствует.\r\n \r\n## Негативные сценарии:\r\n- 401/403 —
|
|
3955
|
+
"description": "## Пример запроса:\r\n```text\r\nDELETE /RecipientSelectionRules\r\nAuthorization: Bearer <token>\r\nContent-Type: application/json\r\n```\r\n \r\n```json\r\n[1, 2]\r\n```\r\n \r\n## Пример успешного ответа (202):\r\nТело ответа отсутствует.\r\n \r\n## Негативные сценарии:\r\n- 401/403 — отсутствие или недостаточность прав доступа.\r\n- 409 — правило не может быть удалено из-за связанных данных.",
|
|
3625
3956
|
"parameters": [
|
|
3626
3957
|
{
|
|
3627
3958
|
"name": "X-Application-ID",
|
|
@@ -3744,8 +4075,40 @@
|
|
|
3744
4075
|
"RecipientSelectionRules"
|
|
3745
4076
|
],
|
|
3746
4077
|
"summary": "Возвращает список получателей уведомлений.",
|
|
3747
|
-
"description": "Поддерживает фильтрацию по query-параметрам и ограничение результата через заголовок `Range`.\r\n \r\n## Пример запроса:\r\n```text\r\nGET /RecipientSelectionRules/recipients?isHidden=false\r\nAuthorization: Bearer <token>\r\nRange:
|
|
4078
|
+
"description": "Поддерживает фильтрацию по query-параметрам и ограничение результата через заголовок `Range`.\r\n \r\n## Пример запроса:\r\n```text\r\nGET /RecipientSelectionRules/recipients?isHidden=false\r\nAuthorization: Bearer <token>\r\nRange: items=0-49\r\n```\r\n \r\n## Пример успешного ответа (200):\r\n```json\r\n{ \"1\": { \"id\": 1, \"code\": \"TaskAssignee\", \"name\": \"Исполнитель заявки\" } }\r\n```\r\n \r\n## Пример успешного ответа (206):\r\nТело ответа имеет тот же формат, что и для `200`, но содержит только часть диапазона.\r\n \r\n## Негативные сценарии:\r\n- 401/403 — отсутствие или недостаточность прав доступа.\r\n- 204 — получатели по фильтрам не найдены.",
|
|
3748
4079
|
"parameters": [
|
|
4080
|
+
{
|
|
4081
|
+
"name": "Range",
|
|
4082
|
+
"in": "header",
|
|
4083
|
+
"description": "Формат: items=FROM-TILL , где FROM - начальный элемент (включая), TILL - конечный элемент (включая)",
|
|
4084
|
+
"schema": {
|
|
4085
|
+
"type": "string"
|
|
4086
|
+
}
|
|
4087
|
+
},
|
|
4088
|
+
{
|
|
4089
|
+
"name": "offset",
|
|
4090
|
+
"in": "query",
|
|
4091
|
+
"description": "количество элементов, которое нобходимо пропустить",
|
|
4092
|
+
"schema": {
|
|
4093
|
+
"type": "string"
|
|
4094
|
+
}
|
|
4095
|
+
},
|
|
4096
|
+
{
|
|
4097
|
+
"name": "fetch",
|
|
4098
|
+
"in": "query",
|
|
4099
|
+
"description": "количество элементов, которое необходимо вернуть",
|
|
4100
|
+
"schema": {
|
|
4101
|
+
"type": "string"
|
|
4102
|
+
}
|
|
4103
|
+
},
|
|
4104
|
+
{
|
|
4105
|
+
"name": "isHidden",
|
|
4106
|
+
"in": "query",
|
|
4107
|
+
"description": "Если true, то результат содержит только скрытые записи",
|
|
4108
|
+
"schema": {
|
|
4109
|
+
"type": "boolean"
|
|
4110
|
+
}
|
|
4111
|
+
},
|
|
3749
4112
|
{
|
|
3750
4113
|
"name": "X-Application-ID",
|
|
3751
4114
|
"in": "header",
|
|
@@ -3948,7 +4311,7 @@
|
|
|
3948
4311
|
"Triggers"
|
|
3949
4312
|
],
|
|
3950
4313
|
"summary": "Возвращает список критичностей для триггера.",
|
|
3951
|
-
"description": "Поддерживает ограничение результата через заголовок `Range`.\r\n \r\n## Пример запроса:\r\n```text\r\nGET /Triggers/1/criticalities\r\nAuthorization: Bearer <token>\r\nRange:
|
|
4314
|
+
"description": "Поддерживает ограничение результата через заголовок `Range`.\r\n \r\n## Пример запроса:\r\n```text\r\nGET /Triggers/1/criticalities\r\nAuthorization: Bearer <token>\r\nRange: items=0-49\r\n```\r\n \r\n## Пример успешного ответа (200):\r\n```json\r\n[\r\n {\r\n \"id\": 1,\r\n \"name\": \"Низкая\"\r\n },\r\n {\r\n \"id\": 2,\r\n \"name\": \"Высокая\"\r\n }\r\n]\r\n```\r\n \r\n## Пример успешного ответа (206):\r\nТело ответа имеет тот же формат, что и для `200`, но содержит только часть диапазона.\r\n \r\n## Негативные сценарии:\r\n- 401/403 — отсутствие или недостаточность прав доступа.\r\n- 204 — критичности для триггера не найдены.",
|
|
3952
4315
|
"parameters": [
|
|
3953
4316
|
{
|
|
3954
4317
|
"name": "id",
|
|
@@ -3960,6 +4323,30 @@
|
|
|
3960
4323
|
"format": "int32"
|
|
3961
4324
|
}
|
|
3962
4325
|
},
|
|
4326
|
+
{
|
|
4327
|
+
"name": "Range",
|
|
4328
|
+
"in": "header",
|
|
4329
|
+
"description": "Формат: items=FROM-TILL , где FROM - начальный элемент (включая), TILL - конечный элемент (включая)",
|
|
4330
|
+
"schema": {
|
|
4331
|
+
"type": "string"
|
|
4332
|
+
}
|
|
4333
|
+
},
|
|
4334
|
+
{
|
|
4335
|
+
"name": "offset",
|
|
4336
|
+
"in": "query",
|
|
4337
|
+
"description": "количество элементов, которое нобходимо пропустить",
|
|
4338
|
+
"schema": {
|
|
4339
|
+
"type": "string"
|
|
4340
|
+
}
|
|
4341
|
+
},
|
|
4342
|
+
{
|
|
4343
|
+
"name": "fetch",
|
|
4344
|
+
"in": "query",
|
|
4345
|
+
"description": "количество элементов, которое необходимо вернуть",
|
|
4346
|
+
"schema": {
|
|
4347
|
+
"type": "string"
|
|
4348
|
+
}
|
|
4349
|
+
},
|
|
3963
4350
|
{
|
|
3964
4351
|
"name": "X-Application-ID",
|
|
3965
4352
|
"in": "header",
|
|
@@ -4242,8 +4629,48 @@
|
|
|
4242
4629
|
"Triggers"
|
|
4243
4630
|
],
|
|
4244
4631
|
"summary": "Возвращает список триггеров.",
|
|
4245
|
-
"description": "Поддерживает фильтрацию по query-параметрам и ограничение результата через заголовок `Range`.\r\n \r\n## Пример запроса:\r\n```text\r\nGET /Triggers?isDeleted=false&isEnabled=true\r\nAuthorization: Bearer <token>\r\nRange:
|
|
4632
|
+
"description": "Поддерживает фильтрацию по query-параметрам и ограничение результата через заголовок `Range`.\r\n \r\n## Пример запроса:\r\n```text\r\nGET /Triggers?isDeleted=false&isEnabled=true\r\nAuthorization: Bearer <token>\r\nRange: items=0-49\r\n```\r\n \r\n## Пример успешного ответа (200):\r\n```json\r\n{\r\n \"1\": {\r\n \"id\": 1,\r\n \"timeoutSeconds\": 60,\r\n \"description\": \"Уведомление при создании заявки\",\r\n \"isNotifyDuringWorkHours\": true,\r\n \"isNotifyDuringDutyHours\": false,\r\n \"isNotifyDuringOtherHours\": false,\r\n \"isEnabled\": true,\r\n \"provider\": {\r\n \"id\": 1,\r\n \"name\": \"Email\",\r\n \"description\": \"Email-провайдер\"\r\n },\r\n \"event\": {\r\n \"id\": 2,\r\n \"name\": \"Создание заявки\"\r\n },\r\n \"messageTemplate\": {\r\n \"id\": 3,\r\n \"name\": null,\r\n \"description\": \"Шаблон уведомления\"\r\n },\r\n \"deleted\": null\r\n }\r\n}\r\n```\r\n \r\n## Пример успешного ответа (206):\r\nТело ответа имеет тот же формат, что и для `200`, но содержит только часть диапазона.\r\n \r\n## Негативные сценарии:\r\n- 401/403 — отсутствие или недостаточность прав доступа.\r\n- 204 — триггеры по фильтрам не найдены.",
|
|
4246
4633
|
"parameters": [
|
|
4634
|
+
{
|
|
4635
|
+
"name": "Range",
|
|
4636
|
+
"in": "header",
|
|
4637
|
+
"description": "Формат: items=FROM-TILL , где FROM - начальный элемент (включая), TILL - конечный элемент (включая)",
|
|
4638
|
+
"schema": {
|
|
4639
|
+
"type": "string"
|
|
4640
|
+
}
|
|
4641
|
+
},
|
|
4642
|
+
{
|
|
4643
|
+
"name": "offset",
|
|
4644
|
+
"in": "query",
|
|
4645
|
+
"description": "количество элементов, которое нобходимо пропустить",
|
|
4646
|
+
"schema": {
|
|
4647
|
+
"type": "string"
|
|
4648
|
+
}
|
|
4649
|
+
},
|
|
4650
|
+
{
|
|
4651
|
+
"name": "fetch",
|
|
4652
|
+
"in": "query",
|
|
4653
|
+
"description": "количество элементов, которое необходимо вернуть",
|
|
4654
|
+
"schema": {
|
|
4655
|
+
"type": "string"
|
|
4656
|
+
}
|
|
4657
|
+
},
|
|
4658
|
+
{
|
|
4659
|
+
"name": "isDeleted",
|
|
4660
|
+
"in": "query",
|
|
4661
|
+
"description": "Если true, результат будет содержать только удаленные триггеры, если false - только неудаленные",
|
|
4662
|
+
"schema": {
|
|
4663
|
+
"type": "boolean"
|
|
4664
|
+
}
|
|
4665
|
+
},
|
|
4666
|
+
{
|
|
4667
|
+
"name": "isEnabled",
|
|
4668
|
+
"in": "query",
|
|
4669
|
+
"description": "Если true, результат будет содержать только включенные триггеры, если false - только выключенные",
|
|
4670
|
+
"schema": {
|
|
4671
|
+
"type": "boolean"
|
|
4672
|
+
}
|
|
4673
|
+
},
|
|
4247
4674
|
{
|
|
4248
4675
|
"name": "X-Application-ID",
|
|
4249
4676
|
"in": "header",
|
|
@@ -5008,8 +5435,32 @@
|
|
|
5008
5435
|
"Webhooks"
|
|
5009
5436
|
],
|
|
5010
5437
|
"summary": "Возвращает список webhook-ов.",
|
|
5011
|
-
"description": "Поддерживает ограничение результата через заголовок `Range`.\r\n \r\n## Пример запроса:\r\n```text\r\nGET /Webhooks\r\nAuthorization: Bearer <token>\r\nRange:
|
|
5438
|
+
"description": "Поддерживает ограничение результата через заголовок `Range`.\r\n \r\n## Пример запроса:\r\n```text\r\nGET /Webhooks\r\nAuthorization: Bearer <token>\r\nRange: items=0-49\r\n```\r\n \r\n## Пример успешного ответа (200):\r\n```json\r\n{ \"1\": { \"id\": 1, \"name\": \"Hook\", \"isActive\": true, \"callsRemaining\": 3, \"lastCall\": { \"completed\": \"2026-08-20T10:00:00Z\", \"exception\": null } } }\r\n```\r\n \r\n## Пример успешного ответа (206):\r\nТело ответа имеет тот же формат, что и для `200`, но содержит только часть диапазона.\r\n \r\n## Негативные сценарии:\r\n- 401/403 — отсутствие или недостаточность прав доступа.\r\n- 204 — webhook-и не найдены.",
|
|
5012
5439
|
"parameters": [
|
|
5440
|
+
{
|
|
5441
|
+
"name": "Range",
|
|
5442
|
+
"in": "header",
|
|
5443
|
+
"description": "Формат: items=FROM-TILL , где FROM - начальный элемент (включая), TILL - конечный элемент (включая)",
|
|
5444
|
+
"schema": {
|
|
5445
|
+
"type": "string"
|
|
5446
|
+
}
|
|
5447
|
+
},
|
|
5448
|
+
{
|
|
5449
|
+
"name": "offset",
|
|
5450
|
+
"in": "query",
|
|
5451
|
+
"description": "количество элементов, которое нобходимо пропустить",
|
|
5452
|
+
"schema": {
|
|
5453
|
+
"type": "string"
|
|
5454
|
+
}
|
|
5455
|
+
},
|
|
5456
|
+
{
|
|
5457
|
+
"name": "fetch",
|
|
5458
|
+
"in": "query",
|
|
5459
|
+
"description": "количество элементов, которое необходимо вернуть",
|
|
5460
|
+
"schema": {
|
|
5461
|
+
"type": "string"
|
|
5462
|
+
}
|
|
5463
|
+
},
|
|
5013
5464
|
{
|
|
5014
5465
|
"name": "X-Application-ID",
|
|
5015
5466
|
"in": "header",
|
|
@@ -5117,7 +5568,7 @@
|
|
|
5117
5568
|
"Webhooks"
|
|
5118
5569
|
],
|
|
5119
5570
|
"summary": "Добавляет или обновляет webhook-и.",
|
|
5120
|
-
"description": "## Пример запроса:\r\n```text\r\nPOST /Webhooks\r\nAuthorization: Bearer <token>\r\nContent-Type: application/json\r\n```\r\n \r\n```json\r\n[{ \"name\": \"Hook\", \"uri\": \"https://example.com/hook\", \"isActive\": true, \"events\": [1], \"taskStages\": [10] }]\r\n```\r\n \r\n## Пример успешного ответа (201):\r\n```json\r\n[1]\r\n```\r\n \r\n## Негативные сценарии:\r\n- 401/403 —
|
|
5571
|
+
"description": "## Пример запроса:\r\n```text\r\nPOST /Webhooks\r\nAuthorization: Bearer <token>\r\nContent-Type: application/json\r\n```\r\n \r\n```json\r\n[{ \"name\": \"Hook\", \"uri\": \"https://example.com/hook\", \"isActive\": true, \"events\": [1], \"taskStages\": [10] }]\r\n```\r\n \r\n## Пример успешного ответа (201):\r\n```json\r\n[1]\r\n```\r\n \r\n## Негативные сценарии:\r\n- 401/403 — отсутствие или недостаточность прав доступа.\r\n- 400 — некорректные данные запроса.",
|
|
5121
5572
|
"parameters": [
|
|
5122
5573
|
{
|
|
5123
5574
|
"name": "X-Application-ID",
|
|
@@ -5237,7 +5688,7 @@
|
|
|
5237
5688
|
"Webhooks"
|
|
5238
5689
|
],
|
|
5239
5690
|
"summary": "Помечает webhook-и как удаленные.",
|
|
5240
|
-
"description": "## Пример запроса:\r\n```text\r\nDELETE /Webhooks\r\nAuthorization: Bearer <token>\r\nContent-Type: application/json\r\n```\r\n \r\n```json\r\n[1, 2]\r\n```\r\n \r\n## Пример успешного ответа (202):\r\nТело ответа отсутствует.\r\n \r\n## Негативные сценарии:\r\n- 401/403 —
|
|
5691
|
+
"description": "## Пример запроса:\r\n```text\r\nDELETE /Webhooks\r\nAuthorization: Bearer <token>\r\nContent-Type: application/json\r\n```\r\n \r\n```json\r\n[1, 2]\r\n```\r\n \r\n## Пример успешного ответа (202):\r\nТело ответа отсутствует.\r\n \r\n## Негативные сценарии:\r\n- 401/403 — отсутствие или недостаточность прав доступа.",
|
|
5241
5692
|
"parameters": [
|
|
5242
5693
|
{
|
|
5243
5694
|
"name": "X-Application-ID",
|
|
@@ -5331,7 +5782,7 @@
|
|
|
5331
5782
|
"Webhooks"
|
|
5332
5783
|
],
|
|
5333
5784
|
"summary": "Возвращает детальную информацию о webhook-е по идентификатору.",
|
|
5334
|
-
"description": "## Пример запроса:\r\n```text\r\nGET /Webhooks/1\r\nAuthorization: Bearer <token>\r\n```\r\n \r\n## Пример успешного ответа (200):\r\n```json\r\n{ \"id\": 1, \"name\": \"Hook\", \"uri\": \"https://example.com/hook\", \"isActive\": true, \"callsRemaining\": 3, \"events\": [{ \"id\": 1, \"name\": \"TaskCreated\" }], \"taskStages\": [{ \"id\": 10, \"name\": \"New\" }], \"lastCall\": { \"started\": \"2026-08-20T09:59:00Z\", \"completed\": \"2026-08-20T10:00:00Z\", \"exception\": null } }\r\n```\r\n \r\n## Негативные сценарии:\r\n- 401/403 —
|
|
5785
|
+
"description": "## Пример запроса:\r\n```text\r\nGET /Webhooks/1\r\nAuthorization: Bearer <token>\r\n```\r\n \r\n## Пример успешного ответа (200):\r\n```json\r\n{ \"id\": 1, \"name\": \"Hook\", \"uri\": \"https://example.com/hook\", \"isActive\": true, \"callsRemaining\": 3, \"events\": [{ \"id\": 1, \"name\": \"TaskCreated\" }], \"taskStages\": [{ \"id\": 10, \"name\": \"New\" }], \"lastCall\": { \"started\": \"2026-08-20T09:59:00Z\", \"completed\": \"2026-08-20T10:00:00Z\", \"exception\": null } }\r\n```\r\n \r\n## Негативные сценарии:\r\n- 401/403 — отсутствие или недостаточность прав доступа.\r\n- 204 — webhook с указанным идентификатором не найден.",
|
|
5335
5786
|
"parameters": [
|
|
5336
5787
|
{
|
|
5337
5788
|
"name": "id",
|
|
@@ -5412,7 +5863,7 @@
|
|
|
5412
5863
|
"Webhooks"
|
|
5413
5864
|
],
|
|
5414
5865
|
"summary": "Помечает webhook как удаленный.",
|
|
5415
|
-
"description": "## Пример запроса:\r\n```text\r\nDELETE /Webhooks/1\r\nAuthorization: Bearer <token>\r\n```\r\n \r\n## Пример успешного ответа (202):\r\nТело ответа отсутствует.\r\n \r\n## Негативные сценарии:\r\n- 401/403 —
|
|
5866
|
+
"description": "## Пример запроса:\r\n```text\r\nDELETE /Webhooks/1\r\nAuthorization: Bearer <token>\r\n```\r\n \r\n## Пример успешного ответа (202):\r\nТело ответа отсутствует.\r\n \r\n## Негативные сценарии:\r\n- 401/403 — отсутствие или недостаточность прав доступа.",
|
|
5416
5867
|
"parameters": [
|
|
5417
5868
|
{
|
|
5418
5869
|
"name": "id",
|
|
@@ -5475,7 +5926,7 @@
|
|
|
5475
5926
|
"Webhooks"
|
|
5476
5927
|
],
|
|
5477
5928
|
"summary": "Активирует webhook.",
|
|
5478
|
-
"description": "## Пример запроса:\r\n```text\r\nPUT /Webhooks/activate/1\r\nAuthorization: Bearer <token>\r\n```\r\n \r\n## Пример успешного ответа (202):\r\nТело ответа отсутствует.\r\n \r\n## Негативные сценарии:\r\n- 401/403 —
|
|
5929
|
+
"description": "## Пример запроса:\r\n```text\r\nPUT /Webhooks/activate/1\r\nAuthorization: Bearer <token>\r\n```\r\n \r\n## Пример успешного ответа (202):\r\nТело ответа отсутствует.\r\n \r\n## Негативные сценарии:\r\n- 401/403 — отсутствие или недостаточность прав доступа.",
|
|
5479
5930
|
"parameters": [
|
|
5480
5931
|
{
|
|
5481
5932
|
"name": "id",
|
|
@@ -5538,7 +5989,7 @@
|
|
|
5538
5989
|
"Webhooks"
|
|
5539
5990
|
],
|
|
5540
5991
|
"summary": "Деактивирует webhook.",
|
|
5541
|
-
"description": "## Пример запроса:\r\n```text\r\nPUT /Webhooks/deactivate/1\r\nAuthorization: Bearer <token>\r\n```\r\n \r\n## Пример успешного ответа (202):\r\nТело ответа отсутствует.\r\n \r\n## Негативные сценарии:\r\n- 401/403 —
|
|
5992
|
+
"description": "## Пример запроса:\r\n```text\r\nPUT /Webhooks/deactivate/1\r\nAuthorization: Bearer <token>\r\n```\r\n \r\n## Пример успешного ответа (202):\r\nТело ответа отсутствует.\r\n \r\n## Негативные сценарии:\r\n- 401/403 — отсутствие или недостаточность прав доступа.",
|
|
5542
5993
|
"parameters": [
|
|
5543
5994
|
{
|
|
5544
5995
|
"name": "id",
|
|
@@ -5601,7 +6052,7 @@
|
|
|
5601
6052
|
"Webhooks"
|
|
5602
6053
|
],
|
|
5603
6054
|
"summary": "Активирует webhook-и.",
|
|
5604
|
-
"description": "## Пример запроса:\r\n```text\r\nPUT /Webhooks/activate\r\nAuthorization: Bearer <token>\r\nContent-Type: application/json\r\n```\r\n \r\n```json\r\n[1, 2]\r\n```\r\n \r\n## Пример успешного ответа (202):\r\nТело ответа отсутствует.\r\n \r\n## Негативные сценарии:\r\n- 401/403 —
|
|
6055
|
+
"description": "## Пример запроса:\r\n```text\r\nPUT /Webhooks/activate\r\nAuthorization: Bearer <token>\r\nContent-Type: application/json\r\n```\r\n \r\n```json\r\n[1, 2]\r\n```\r\n \r\n## Пример успешного ответа (202):\r\nТело ответа отсутствует.\r\n \r\n## Негативные сценарии:\r\n- 401/403 — отсутствие или недостаточность прав доступа.",
|
|
5605
6056
|
"parameters": [
|
|
5606
6057
|
{
|
|
5607
6058
|
"name": "X-Application-ID",
|
|
@@ -5695,7 +6146,7 @@
|
|
|
5695
6146
|
"Webhooks"
|
|
5696
6147
|
],
|
|
5697
6148
|
"summary": "Деактивирует webhook-и.",
|
|
5698
|
-
"description": "## Пример запроса:\r\n```text\r\nPUT /Webhooks/deactivate\r\nAuthorization: Bearer <token>\r\nContent-Type: application/json\r\n```\r\n \r\n```json\r\n[1, 2]\r\n```\r\n \r\n## Пример успешного ответа (202):\r\nТело ответа отсутствует.\r\n \r\n## Негативные сценарии:\r\n- 401/403 —
|
|
6149
|
+
"description": "## Пример запроса:\r\n```text\r\nPUT /Webhooks/deactivate\r\nAuthorization: Bearer <token>\r\nContent-Type: application/json\r\n```\r\n \r\n```json\r\n[1, 2]\r\n```\r\n \r\n## Пример успешного ответа (202):\r\nТело ответа отсутствует.\r\n \r\n## Негативные сценарии:\r\n- 401/403 — отсутствие или недостаточность прав доступа.",
|
|
5699
6150
|
"parameters": [
|
|
5700
6151
|
{
|
|
5701
6152
|
"name": "X-Application-ID",
|
|
@@ -6733,7 +7184,7 @@
|
|
|
6733
7184
|
"items": {
|
|
6734
7185
|
"$ref": "#/components/schemas/RMBSListResult"
|
|
6735
7186
|
},
|
|
6736
|
-
"description": "Список
|
|
7187
|
+
"description": "Список отправителей почтового ящика",
|
|
6737
7188
|
"nullable": true
|
|
6738
7189
|
},
|
|
6739
7190
|
"lastCall": {
|
|
@@ -6968,7 +7419,7 @@
|
|
|
6968
7419
|
},
|
|
6969
7420
|
"isValid": {
|
|
6970
7421
|
"type": "boolean",
|
|
6971
|
-
"description": "Флаг состояния
|
|
7422
|
+
"description": "Флаг состояния валидации",
|
|
6972
7423
|
"example": true
|
|
6973
7424
|
},
|
|
6974
7425
|
"provider": {
|
|
@@ -7028,7 +7479,7 @@
|
|
|
7028
7479
|
},
|
|
7029
7480
|
"isValid": {
|
|
7030
7481
|
"type": "boolean",
|
|
7031
|
-
"description": "Флаг состояния
|
|
7482
|
+
"description": "Флаг состояния валидации",
|
|
7032
7483
|
"example": true
|
|
7033
7484
|
},
|
|
7034
7485
|
"providerID": {
|
|
@@ -7108,14 +7559,14 @@
|
|
|
7108
7559
|
},
|
|
7109
7560
|
"navigateTo": {
|
|
7110
7561
|
"type": "integer",
|
|
7111
|
-
"description": "Идентификатор
|
|
7562
|
+
"description": "Идентификатор перехода",
|
|
7112
7563
|
"format": "int32",
|
|
7113
7564
|
"nullable": true,
|
|
7114
7565
|
"example": 2
|
|
7115
7566
|
},
|
|
7116
7567
|
"taskID": {
|
|
7117
7568
|
"type": "integer",
|
|
7118
|
-
"description": "Идентификатор
|
|
7569
|
+
"description": "Идентификатор заявки",
|
|
7119
7570
|
"format": "int32",
|
|
7120
7571
|
"nullable": true,
|
|
7121
7572
|
"example": 12345
|
|
@@ -7214,7 +7665,7 @@
|
|
|
7214
7665
|
},
|
|
7215
7666
|
"description": {
|
|
7216
7667
|
"type": "string",
|
|
7217
|
-
"description": "Описание
|
|
7668
|
+
"description": "Описание правила выбора получателя",
|
|
7218
7669
|
"nullable": true,
|
|
7219
7670
|
"example": "Уведомление исполнителя заявки"
|
|
7220
7671
|
},
|
|
@@ -7265,7 +7716,7 @@
|
|
|
7265
7716
|
},
|
|
7266
7717
|
"isForRelevantUsers": {
|
|
7267
7718
|
"type": "boolean",
|
|
7268
|
-
"description": "Флаг
|
|
7719
|
+
"description": "Флаг причастных пользователей",
|
|
7269
7720
|
"example": false
|
|
7270
7721
|
},
|
|
7271
7722
|
"isForRelevantUsersByWorkType": {
|
|
@@ -7299,7 +7750,7 @@
|
|
|
7299
7750
|
},
|
|
7300
7751
|
"useUnverifiedContacts": {
|
|
7301
7752
|
"type": "boolean",
|
|
7302
|
-
"description": "Флаг использования
|
|
7753
|
+
"description": "Флаг использования неподтверждённых контактов",
|
|
7303
7754
|
"example": false
|
|
7304
7755
|
},
|
|
7305
7756
|
"orgUnitsUpwardTillRole": {
|
|
@@ -7326,7 +7777,7 @@
|
|
|
7326
7777
|
}
|
|
7327
7778
|
},
|
|
7328
7779
|
"additionalProperties": false,
|
|
7329
|
-
"description": "Данные
|
|
7780
|
+
"description": "Данные правила выбора получателя"
|
|
7330
7781
|
},
|
|
7331
7782
|
"RRSRListResult": {
|
|
7332
7783
|
"type": "object",
|
|
@@ -7337,7 +7788,7 @@
|
|
|
7337
7788
|
},
|
|
7338
7789
|
"description": {
|
|
7339
7790
|
"type": "string",
|
|
7340
|
-
"description": "Описание
|
|
7791
|
+
"description": "Описание правила выбора получателя",
|
|
7341
7792
|
"nullable": true,
|
|
7342
7793
|
"example": "Уведомление исполнителя заявки"
|
|
7343
7794
|
},
|
|
@@ -7388,7 +7839,7 @@
|
|
|
7388
7839
|
},
|
|
7389
7840
|
"isForRelevantUsers": {
|
|
7390
7841
|
"type": "boolean",
|
|
7391
|
-
"description": "Флаг
|
|
7842
|
+
"description": "Флаг причастных пользователей",
|
|
7392
7843
|
"example": false
|
|
7393
7844
|
},
|
|
7394
7845
|
"isForRelevantUsersByWorkType": {
|
|
@@ -7422,7 +7873,7 @@
|
|
|
7422
7873
|
},
|
|
7423
7874
|
"useUnverifiedContacts": {
|
|
7424
7875
|
"type": "boolean",
|
|
7425
|
-
"description": "Флаг использования
|
|
7876
|
+
"description": "Флаг использования неподтверждённых контактов",
|
|
7426
7877
|
"example": false
|
|
7427
7878
|
},
|
|
7428
7879
|
"orgUnitsUpwardTillRole": {
|
|
@@ -7589,7 +8040,7 @@
|
|
|
7589
8040
|
},
|
|
7590
8041
|
"callsRemaining": {
|
|
7591
8042
|
"type": "integer",
|
|
7592
|
-
"description": "Осталось попыток
|
|
8043
|
+
"description": "Осталось попыток выполнения при неудачном результате",
|
|
7593
8044
|
"format": "int32",
|
|
7594
8045
|
"nullable": true,
|
|
7595
8046
|
"example": 3
|
|
@@ -7668,7 +8119,7 @@
|
|
|
7668
8119
|
},
|
|
7669
8120
|
"callsRemaining": {
|
|
7670
8121
|
"type": "integer",
|
|
7671
|
-
"description": "Осталось попыток
|
|
8122
|
+
"description": "Осталось попыток выполнения при неудачном результате",
|
|
7672
8123
|
"format": "int32",
|
|
7673
8124
|
"nullable": true,
|
|
7674
8125
|
"example": 3
|
|
@@ -7695,7 +8146,7 @@
|
|
|
7695
8146
|
},
|
|
7696
8147
|
"name": {
|
|
7697
8148
|
"type": "string",
|
|
7698
|
-
"description": "
|
|
8149
|
+
"description": "Наименование получателя",
|
|
7699
8150
|
"nullable": true,
|
|
7700
8151
|
"example": "Исполнитель заявки"
|
|
7701
8152
|
}
|