@hubex/mcp 0.5.0 → 0.5.20260909
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/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/COMMON.json
CHANGED
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
"Applications"
|
|
22
22
|
],
|
|
23
23
|
"summary": "Возвращает список приложений.",
|
|
24
|
-
"description": "Метод используется для получения справочника приложений.\r\nПоддерживает диапазон через заголовок `Range`.\r\n \r\n## Пример запроса:\r\n```text\r\nGET /Applications\r\nAuthorization: Bearer <token>\r\nRange:
|
|
24
|
+
"description": "Метод используется для получения справочника приложений.\r\nПоддерживает диапазон через заголовок `Range`.\r\n \r\n## Пример запроса:\r\n```text\r\nGET /Applications\r\nAuthorization: Bearer <token>\r\nRange: items=1-50\r\n```\r\n \r\n## Пример успешного ответа (200):\r\n```json\r\n{ \"1\": { \"code\": \"LIC\", \"nameRu\": \"Лицензия\" } }\r\n```\r\n \r\n## Пример успешного ответа (206):\r\nТело ответа имеет тот же формат, что и для `200`, но содержит только часть диапазона.\r\n \r\n## Негативные сценарии:\r\n- 401 Unauthorized — отсутствует или некорректен Bearer-токен.\r\n- 403 Forbidden — недостаточно прав `ApplicationList`.\r\n- 204 — справочник приложений пуст.",
|
|
25
25
|
"parameters": [
|
|
26
26
|
{
|
|
27
27
|
"name": "Range",
|
|
@@ -156,7 +156,7 @@
|
|
|
156
156
|
"Attachments"
|
|
157
157
|
],
|
|
158
158
|
"summary": "Загружает один файл из multipart/form-data.",
|
|
159
|
-
"description": "Используется для загрузки одного вложения из HTML-формы.\r\n \r\n## Пример запроса (multipart/form-data):\r\nPOST /attachments/upload/fromForm\r\nAuthorization: Bearer <token>\r\nContent-Type: multipart/form-data\r\nПоля: file=<binary>, description=<text>, isPublic=<true|false>, isIgnorePossibleDuplication=<true|false>, roles=<short[]>, coordinate=<string>\r\n \r\n## Пример успешного ответа (201):\r\n{ \"attachmentID\": 123, \"checkSum\": \"md5hash\", \"fileName\": \"photo.png\", \"isProtected\": false }\r\n \r\n## Негативные сценарии:\r\n- 401
|
|
159
|
+
"description": "Используется для загрузки одного вложения из HTML-формы.\r\n \r\n## Пример запроса (multipart/form-data):\r\nPOST /attachments/upload/fromForm\r\nAuthorization: Bearer <token>\r\nContent-Type: multipart/form-data\r\nПоля: file=<binary>, description=<text>, isPublic=<true|false>, isIgnorePossibleDuplication=<true|false>, roles=<short[]>, coordinate=<string>\r\n \r\n## Пример успешного ответа (201):\r\n{ \"attachmentID\": 123, \"checkSum\": \"md5hash\", \"fileName\": \"photo.png\", \"isProtected\": false }\r\n \r\n## Негативные сценарии:\r\n- 401 Unauthorized — отсутствует или некорректен Bearer-токен.\r\n- 403 Forbidden — недостаточно прав `AttachmentUpload`.\r\n- 400 — некорректные входные данные/пустой файл/несоответствие формата.",
|
|
160
160
|
"parameters": [
|
|
161
161
|
{
|
|
162
162
|
"name": "X-Application-ID",
|
|
@@ -403,7 +403,7 @@
|
|
|
403
403
|
"Attachments"
|
|
404
404
|
],
|
|
405
405
|
"summary": "Загружает несколько файлов из multipart/form-data.",
|
|
406
|
-
"description": "Используется для пакетной загрузки вложений из формы.\r\n \r\n## Пример запроса:\r\nPOST /attachments/v2/upload/fromForm\r\nAuthorization: Bearer <token>\r\nBody: { \"attachments\": [ { \"file\": <binary>, \"fileName\": \"a.txt\", \"description\": \"...\" , \"isPublic\": true, \"roles\": [ 1 ] } ] }\r\n \r\n## Пример успешного ответа (201):\r\n[ { \"attachmentID\": 123, \"checkSum\": \"md5hash\", \"fileName\": \"a.txt\", \"isProtected\": true }, { \"attachmentID\": 124, \"checkSum\": \"md5hash2\", \"fileName\": \"b.txt\", \"isProtected\": false } ]\r\n \r\n## Негативные сценарии:\r\n- 401
|
|
406
|
+
"description": "Используется для пакетной загрузки вложений из формы.\r\n \r\n## Пример запроса:\r\nPOST /attachments/v2/upload/fromForm\r\nAuthorization: Bearer <token>\r\nBody: { \"attachments\": [ { \"file\": <binary>, \"fileName\": \"a.txt\", \"description\": \"...\" , \"isPublic\": true, \"roles\": [ 1 ] } ] }\r\n \r\n## Пример успешного ответа (201):\r\n[ { \"attachmentID\": 123, \"checkSum\": \"md5hash\", \"fileName\": \"a.txt\", \"isProtected\": true }, { \"attachmentID\": 124, \"checkSum\": \"md5hash2\", \"fileName\": \"b.txt\", \"isProtected\": false } ]\r\n \r\n## Негативные сценарии:\r\n- 401 Unauthorized — отсутствует или некорректен Bearer-токен.\r\n- 403 Forbidden — недостаточно прав `AttachmentUpload`.\r\n- 400 — некорректные данные.",
|
|
407
407
|
"parameters": [
|
|
408
408
|
{
|
|
409
409
|
"name": "X-Application-ID",
|
|
@@ -534,7 +534,7 @@
|
|
|
534
534
|
"Attachments"
|
|
535
535
|
],
|
|
536
536
|
"summary": "Загружает один файл из тела запроса.",
|
|
537
|
-
"description": "Используется для сценариев, где содержимое файла и метаданные передаются в JSON-теле запроса.\r\n \r\n## Пример запроса (JSON):\r\nPOST /attachments/upload/fromBody\r\nAuthorization: Bearer <token>\r\n \r\n{\r\n \"file\": \"<base64>\",\r\n \"fileName\": \"photo.png\",\r\n \"contentType\": \"image/png\",\r\n \"description\": \"Фото\",\r\n \"isPublic\": false,\r\n \"isIgnorePossibleDuplication\": false,\r\n \"checkSum\": \"md5hash\",\r\n \"roles\": [ 1 ],\r\n \"coordinate\": \"55.75,37.61\"\r\n}\r\n \r\n## Пример успешного ответа (201):\r\n{ \"attachmentID\": 123, \"checkSum\": \"md5hash\", \"fileName\": \"photo.png\", \"isProtected\": true }\r\n \r\n## Негативные сценарии:\r\n- 401
|
|
537
|
+
"description": "Используется для сценариев, где содержимое файла и метаданные передаются в JSON-теле запроса.\r\n \r\n## Пример запроса (JSON):\r\nPOST /attachments/upload/fromBody\r\nAuthorization: Bearer <token>\r\n \r\n{\r\n \"file\": \"<base64>\",\r\n \"fileName\": \"photo.png\",\r\n \"contentType\": \"image/png\",\r\n \"description\": \"Фото\",\r\n \"isPublic\": false,\r\n \"isIgnorePossibleDuplication\": false,\r\n \"checkSum\": \"md5hash\",\r\n \"roles\": [ 1 ],\r\n \"coordinate\": \"55.75,37.61\"\r\n}\r\n \r\n## Пример успешного ответа (201):\r\n{ \"attachmentID\": 123, \"checkSum\": \"md5hash\", \"fileName\": \"photo.png\", \"isProtected\": true }\r\n \r\n## Негативные сценарии:\r\n- 401 Unauthorized — отсутствует или некорректен Bearer-токен.\r\n- 403 Forbidden — недостаточно прав `AttachmentUpload`.\r\n- 400 — некорректный base64/empty file/checkSum.",
|
|
538
538
|
"parameters": [
|
|
539
539
|
{
|
|
540
540
|
"name": "X-Application-ID",
|
|
@@ -657,7 +657,7 @@
|
|
|
657
657
|
"Attachments"
|
|
658
658
|
],
|
|
659
659
|
"summary": "Возвращает временную ссылку для скачивания вложения.",
|
|
660
|
-
"description": "В зависимости от параметра `noRedirect` метод либо возвращает редирект на файл, либо отдает ссылку в теле ответа.\r\n \r\n## Пример запроса:\r\nGET /attachments/123?thumbnailSize=128&noRedirect=false\r\nAuthorization: Bearer <token>\r\n \r\n## Пример успешного ответа:\r\n- 307 — редирект на временную ссылку на скачивание (noRedirect=false).\r\n- 200 — если noRedirect=true: ссылка на файл отдается в теле ответа (формат зависит от DownloadAttachmentAsync2).\r\n \r\n## Негативные сценарии:\r\n- 401
|
|
660
|
+
"description": "В зависимости от параметра `noRedirect` метод либо возвращает редирект на файл, либо отдает ссылку в теле ответа.\r\n \r\n## Пример запроса:\r\nGET /attachments/123?thumbnailSize=128&noRedirect=false\r\nAuthorization: Bearer <token>\r\n \r\n## Пример успешного ответа:\r\n- 307 — редирект на временную ссылку на скачивание (noRedirect=false).\r\n- 200 — если noRedirect=true: ссылка на файл отдается в теле ответа (формат зависит от DownloadAttachmentAsync2).\r\n \r\n## Негативные сценарии:\r\n- 401 Unauthorized — отсутствует или некорректен Bearer-токен.\r\n- 403 Forbidden — недостаточно прав `AttachmentDownload`.\r\n- 400 — некорректный thumbnailSize.\r\n- 500 — ошибка при подготовке ссылки.",
|
|
661
661
|
"parameters": [
|
|
662
662
|
{
|
|
663
663
|
"name": "attachmentID",
|
|
@@ -686,48 +686,6 @@
|
|
|
686
686
|
"type": "boolean"
|
|
687
687
|
}
|
|
688
688
|
},
|
|
689
|
-
{
|
|
690
|
-
"name": "Range",
|
|
691
|
-
"in": "header",
|
|
692
|
-
"description": "Формат: items=FROM-TILL , где FROM - начальный элемент (включая), TILL - конечный элемент (включая)",
|
|
693
|
-
"schema": {
|
|
694
|
-
"type": "string"
|
|
695
|
-
}
|
|
696
|
-
},
|
|
697
|
-
{
|
|
698
|
-
"name": "offset",
|
|
699
|
-
"in": "query",
|
|
700
|
-
"description": "количество элементов, которое нобходимо пропустить",
|
|
701
|
-
"schema": {
|
|
702
|
-
"type": "string"
|
|
703
|
-
}
|
|
704
|
-
},
|
|
705
|
-
{
|
|
706
|
-
"name": "fetch",
|
|
707
|
-
"in": "query",
|
|
708
|
-
"description": "количество элементов, которое необходимо вернуть",
|
|
709
|
-
"schema": {
|
|
710
|
-
"type": "string"
|
|
711
|
-
}
|
|
712
|
-
},
|
|
713
|
-
{
|
|
714
|
-
"name": "thumbnailSize",
|
|
715
|
-
"in": "query",
|
|
716
|
-
"description": "Размер эскиза (будет возвращен ближайший больший эскиз из доступных)",
|
|
717
|
-
"schema": {
|
|
718
|
-
"type": "integer",
|
|
719
|
-
"format": "int32",
|
|
720
|
-
"nullable": true
|
|
721
|
-
}
|
|
722
|
-
},
|
|
723
|
-
{
|
|
724
|
-
"name": "noRedirect",
|
|
725
|
-
"in": "query",
|
|
726
|
-
"description": "Если true, ссылка на файл возвращается в теле ответа вместо редиректа",
|
|
727
|
-
"schema": {
|
|
728
|
-
"type": "boolean"
|
|
729
|
-
}
|
|
730
|
-
},
|
|
731
689
|
{
|
|
732
690
|
"name": "X-Application-ID",
|
|
733
691
|
"in": "header",
|
|
@@ -799,17 +757,6 @@
|
|
|
799
757
|
}
|
|
800
758
|
}
|
|
801
759
|
}
|
|
802
|
-
},
|
|
803
|
-
"206": {
|
|
804
|
-
"description": "PartialContent",
|
|
805
|
-
"headers": {
|
|
806
|
-
"Content-Range": {
|
|
807
|
-
"description": "items=FROM-TILL/OF , где FROM - начальный элемент (включая), TILL - конечный элемент (включая) OF - общее количество элементов",
|
|
808
|
-
"schema": {
|
|
809
|
-
"type": "string"
|
|
810
|
-
}
|
|
811
|
-
}
|
|
812
|
-
}
|
|
813
760
|
}
|
|
814
761
|
},
|
|
815
762
|
"security": [
|
|
@@ -823,7 +770,7 @@
|
|
|
823
770
|
"Attachments"
|
|
824
771
|
],
|
|
825
772
|
"summary": "Удаляет вложение по идентификатору.",
|
|
826
|
-
"description": "Помечает вложение и все его связи как удаленные.\r\n \r\n## Пример запроса:\r\n```text\r\nDELETE /attachments/123\r\nAuthorization: Bearer <token>\r\n```\r\n \r\n## Пример успешного ответа (202):\r\n(пустой response body)\r\n \r\n## Негативные сценарии:\r\n- 401
|
|
773
|
+
"description": "Помечает вложение и все его связи как удаленные.\r\n \r\n## Пример запроса:\r\n```text\r\nDELETE /attachments/123\r\nAuthorization: Bearer <token>\r\n```\r\n \r\n## Пример успешного ответа (202):\r\n(пустой response body)\r\n \r\n## Негативные сценарии:\r\n- 401 Unauthorized — отсутствует или некорректен Bearer-токен.\r\n- 403 Forbidden — недостаточно прав `AttachmentDelete`.\r\n- 500 — во время удаления произошла внутренняя ошибка.",
|
|
827
774
|
"parameters": [
|
|
828
775
|
{
|
|
829
776
|
"name": "attachmentID",
|
|
@@ -959,31 +906,6 @@
|
|
|
959
906
|
"type": "string"
|
|
960
907
|
}
|
|
961
908
|
},
|
|
962
|
-
{
|
|
963
|
-
"name": "temp_url_sig",
|
|
964
|
-
"in": "query",
|
|
965
|
-
"description": "Подпись временного URL",
|
|
966
|
-
"schema": {
|
|
967
|
-
"type": "string"
|
|
968
|
-
}
|
|
969
|
-
},
|
|
970
|
-
{
|
|
971
|
-
"name": "temp_url_expires",
|
|
972
|
-
"in": "query",
|
|
973
|
-
"description": "Срок действия временного URL в Unix time",
|
|
974
|
-
"schema": {
|
|
975
|
-
"type": "integer",
|
|
976
|
-
"format": "int64"
|
|
977
|
-
}
|
|
978
|
-
},
|
|
979
|
-
{
|
|
980
|
-
"name": "filename",
|
|
981
|
-
"in": "query",
|
|
982
|
-
"description": "Имя файла для заголовка Content-Disposition",
|
|
983
|
-
"schema": {
|
|
984
|
-
"type": "string"
|
|
985
|
-
}
|
|
986
|
-
},
|
|
987
909
|
{
|
|
988
910
|
"name": "X-Application-ID",
|
|
989
911
|
"in": "header",
|
|
@@ -1053,7 +975,7 @@
|
|
|
1053
975
|
"Attachments"
|
|
1054
976
|
],
|
|
1055
977
|
"summary": "Удаляет несколько вложений.",
|
|
1056
|
-
"description": "Помечает переданные вложения и их связи как удаленные.\r\n \r\n## Пример запроса:\r\n```text\r\nDELETE /attachments\r\nAuthorization: Bearer <token>\r\n```\r\n```json\r\n[101, 102]\r\n```\r\n \r\n## Пример успешного ответа (202):\r\n(пустой response body)\r\n \r\n## Негативные сценарии:\r\n- 401
|
|
978
|
+
"description": "Помечает переданные вложения и их связи как удаленные.\r\n \r\n## Пример запроса:\r\n```text\r\nDELETE /attachments\r\nAuthorization: Bearer <token>\r\n```\r\n```json\r\n[101, 102]\r\n```\r\n \r\n## Пример успешного ответа (202):\r\n(пустой response body)\r\n \r\n## Негативные сценарии:\r\n- 401 Unauthorized — отсутствует или некорректен Bearer-токен.\r\n- 403 Forbidden — недостаточно прав `AttachmentDelete`.\r\n- 500 — во время удаления произошла внутренняя ошибка.",
|
|
1057
979
|
"parameters": [
|
|
1058
980
|
{
|
|
1059
981
|
"name": "X-Application-ID",
|
|
@@ -1173,7 +1095,7 @@
|
|
|
1173
1095
|
"Attachments"
|
|
1174
1096
|
],
|
|
1175
1097
|
"summary": "Возвращает список вложений.",
|
|
1176
|
-
"description": "Поддерживает фильтрацию по связанным сущностям и флагам, а также ограничение результата через заголовок `Range`.\r\n \r\n## Пример запроса:\r\n```text\r\nGET /attachments?taskID=1001&isDeleted=false\r\nAuthorization: Bearer <token>\r\nRange:
|
|
1098
|
+
"description": "Поддерживает фильтрацию по связанным сущностям и флагам, а также ограничение результата через заголовок `Range`.\r\n \r\n## Пример запроса:\r\n```text\r\nGET /attachments?taskID=1001&isDeleted=false\r\nAuthorization: Bearer <token>\r\nRange: items=1-50\r\n```\r\n \r\n## Пример успешного ответа (200):\r\n```json\r\n{\r\n \"123\": {\r\n \"id\": 123,\r\n \"fileName\": \"photo.png\",\r\n \"description\": \"Фото для тестов\",\r\n \"publicUrl\": \"https://files.example.com/attachments/123\",\r\n \"isUploaded\": false,\r\n \"isProtected\": false,\r\n \"size\": 1024,\r\n \"created\": \"2026-08-19T10:44:42Z\"\r\n }\r\n}\r\n```\r\n \r\n## Пример успешного ответа (206):\r\nТело ответа имеет тот же формат, что и для `200`, но содержит только часть диапазона.\r\n \r\n## Негативные сценарии:\r\n- 401 Unauthorized — отсутствует или некорректен Bearer-токен.\r\n- 403 Forbidden — недостаточно прав `AttachmentsList`.\r\n- 204 — вложения по указанным критериям не найдены.",
|
|
1177
1099
|
"parameters": [
|
|
1178
1100
|
{
|
|
1179
1101
|
"name": "Range",
|
|
@@ -1352,7 +1274,7 @@
|
|
|
1352
1274
|
"Attachments"
|
|
1353
1275
|
],
|
|
1354
1276
|
"summary": "Возвращает данные вложения.",
|
|
1355
|
-
"description": "Возвращает метаданные вложения без скачивания бинарного содержимого.\r\n \r\n## Пример запроса:\r\n```text\r\nGET /attachments/123/this\r\nAuthorization: Bearer <token>\r\n```\r\n \r\n## Пример успешного ответа (200):\r\n```json\r\n{\r\n \"id\": 123,\r\n \"fileName\": \"photo.png\",\r\n \"description\": \"Фото для тестов\",\r\n \"publicUrl\": \"https://files.example.com/attachments/123\",\r\n \"isUploaded\": false,\r\n \"isProtected\": false,\r\n \"size\": 1024,\r\n \"created\": \"2026-08-19T10:44:42Z\"\r\n}\r\n```\r\n \r\n## Негативные сценарии:\r\n- 401
|
|
1277
|
+
"description": "Возвращает метаданные вложения без скачивания бинарного содержимого.\r\n \r\n## Пример запроса:\r\n```text\r\nGET /attachments/123/this\r\nAuthorization: Bearer <token>\r\n```\r\n \r\n## Пример успешного ответа (200):\r\n```json\r\n{\r\n \"id\": 123,\r\n \"fileName\": \"photo.png\",\r\n \"description\": \"Фото для тестов\",\r\n \"publicUrl\": \"https://files.example.com/attachments/123\",\r\n \"isUploaded\": false,\r\n \"isProtected\": false,\r\n \"size\": 1024,\r\n \"created\": \"2026-08-19T10:44:42Z\"\r\n}\r\n```\r\n \r\n## Негативные сценарии:\r\n- 401 Unauthorized — отсутствует или некорректен Bearer-токен.\r\n- 403 Forbidden — недостаточно прав `AttachmentsList`.\r\n- 204 — вложение не найдено.",
|
|
1356
1278
|
"parameters": [
|
|
1357
1279
|
{
|
|
1358
1280
|
"name": "attachmentID",
|
|
@@ -1435,7 +1357,7 @@
|
|
|
1435
1357
|
"Attachments"
|
|
1436
1358
|
],
|
|
1437
1359
|
"summary": "Публикует вложение для общего доступа.",
|
|
1438
|
-
"description": "После публикации вложение получает публичную ссылку.\r\n \r\n## Пример запроса:\r\n```text\r\nPOST /attachments/123/publish\r\nAuthorization: Bearer <token>\r\n```\r\n \r\n## Пример успешного ответа (202):\r\n```json\r\n{ \"attachmentID\": 123, \"publicUrl\": \"https://storage.example.com/public/attachment/123\" }\r\n```\r\n \r\n## Негативные сценарии:\r\n- 401
|
|
1360
|
+
"description": "После публикации вложение получает публичную ссылку.\r\n \r\n## Пример запроса:\r\n```text\r\nPOST /attachments/123/publish\r\nAuthorization: Bearer <token>\r\n```\r\n \r\n## Пример успешного ответа (202):\r\n```json\r\n{ \"attachmentID\": 123, \"publicUrl\": \"https://storage.example.com/public/attachment/123\" }\r\n```\r\n \r\n## Негативные сценарии:\r\n- 401 Unauthorized — отсутствует или некорректен Bearer-токен.\r\n- 403 Forbidden — недостаточно прав `AttachmentPublish`.\r\n- 400 — неверный `attachmentID` (<= 0).",
|
|
1439
1361
|
"parameters": [
|
|
1440
1362
|
{
|
|
1441
1363
|
"name": "attachmentID",
|
|
@@ -1515,7 +1437,7 @@
|
|
|
1515
1437
|
"Attachments"
|
|
1516
1438
|
],
|
|
1517
1439
|
"summary": "Снимает публикацию с вложения.",
|
|
1518
|
-
"description": "После вызова публичная ссылка перестает быть доступной.\r\n \r\n## Пример запроса:\r\n```text\r\nPOST /attachments/123/unpublish\r\nAuthorization: Bearer <token>\r\n```\r\n \r\n## Пример успешного ответа (202):\r\n(пустой response body)\r\n \r\n## Негативные сценарии:\r\n- 401
|
|
1440
|
+
"description": "После вызова публичная ссылка перестает быть доступной.\r\n \r\n## Пример запроса:\r\n```text\r\nPOST /attachments/123/unpublish\r\nAuthorization: Bearer <token>\r\n```\r\n \r\n## Пример успешного ответа (202):\r\n(пустой response body)\r\n \r\n## Негативные сценарии:\r\n- 401 Unauthorized — отсутствует или некорректен Bearer-токен.\r\n- 403 Forbidden — недостаточно прав `AttachmentPublish`.\r\n- 400 — неверный `attachmentID` (<= 0).",
|
|
1519
1441
|
"parameters": [
|
|
1520
1442
|
{
|
|
1521
1443
|
"name": "attachmentID",
|
|
@@ -1578,7 +1500,7 @@
|
|
|
1578
1500
|
"Attachments"
|
|
1579
1501
|
],
|
|
1580
1502
|
"summary": "Подготавливает данные для скачивания архива вложений по заявкам.",
|
|
1581
|
-
"description": "Используется для формирования архива файлов по списку заявок.\r\nВ одном запросе поддерживается не более 100 заявок.\r\n \r\n## Пример запроса:\r\n```text\r\nGET /attachments/downloadLink?taskID=1001&taskID=1002&isDeleted=false\r\nAuthorization: Bearer <token>\r\n```\r\n \r\n## Пример успешного ответа (200):\r\n```json\r\n{\r\n \"downloadUrl\": \"https://storage.example.com/container/folder.zip\",\r\n \"headers\": [\r\n { \"name\": \"X-Auth-Token\", \"value\": \"token-example\" }\r\n ],\r\n \"expiresAfter\": \"2026-08-19T14:32:00Z\"\r\n}\r\n```\r\n \r\n## Негативные сценарии:\r\n- 401
|
|
1503
|
+
"description": "Используется для формирования архива файлов по списку заявок.\r\nВ одном запросе поддерживается не более 100 заявок.\r\n \r\n## Пример запроса:\r\n```text\r\nGET /attachments/downloadLink?taskID=1001&taskID=1002&isDeleted=false\r\nAuthorization: Bearer <token>\r\n```\r\n \r\n## Пример успешного ответа (200):\r\n```json\r\n{\r\n \"downloadUrl\": \"https://storage.example.com/container/folder.zip\",\r\n \"headers\": [\r\n { \"name\": \"X-Auth-Token\", \"value\": \"token-example\" }\r\n ],\r\n \"expiresAfter\": \"2026-08-19T14:32:00Z\"\r\n}\r\n```\r\n \r\n## Негативные сценарии:\r\n- 401 Unauthorized — отсутствует или некорректен Bearer-токен.\r\n- 403 Forbidden — недостаточно прав `AttachmentsList`.\r\n- 204 — для указанных заявок не найдено вложений или не передан ни один `taskID`.\r\n- 500 — внутренняя ошибка при подготовке архива.",
|
|
1582
1504
|
"parameters": [
|
|
1583
1505
|
{
|
|
1584
1506
|
"name": "Range",
|
|
@@ -1732,7 +1654,7 @@
|
|
|
1732
1654
|
"Attachments"
|
|
1733
1655
|
],
|
|
1734
1656
|
"summary": "Возвращает роли, имеющие доступ к вложению.",
|
|
1735
|
-
"description": "Метод возвращает роли, для которых вложение доступно как защищенный файл.\r\nПоддерживает диапазон через заголовок `Range`.\r\n \r\n## Пример запроса:\r\n```text\r\nGET /attachments/123/roles\r\nAuthorization: Bearer <token>\r\nRange:
|
|
1657
|
+
"description": "Метод возвращает роли, для которых вложение доступно как защищенный файл.\r\nПоддерживает диапазон через заголовок `Range`.\r\n \r\n## Пример запроса:\r\n```text\r\nGET /attachments/123/roles\r\nAuthorization: Bearer <token>\r\nRange: items=1-50\r\n```\r\n \r\n## Пример успешного ответа (200):\r\n```json\r\n{ \"1\": \"Админ\", \"2\": \"Пользователь\" }\r\n```\r\n \r\n## Пример успешного ответа (206):\r\nТело ответа имеет тот же формат, что и для `200`, но содержит только часть диапазона.\r\n \r\n## Негативные сценарии:\r\n- 401 Unauthorized — отсутствует или некорректен Bearer-токен.\r\n- 403 Forbidden — недостаточно прав `RoleAttachmentsList`.\r\n- 204 — для вложения не настроены роли доступа.",
|
|
1736
1658
|
"parameters": [
|
|
1737
1659
|
{
|
|
1738
1660
|
"name": "attachmentID",
|
|
@@ -1877,7 +1799,7 @@
|
|
|
1877
1799
|
"AttributeListOfValues"
|
|
1878
1800
|
],
|
|
1879
1801
|
"summary": "Сохраняет список допустимых значений атрибута.",
|
|
1880
|
-
"description": "Метод принимает набор значений и объединяет его с текущими данными атрибута.\r\nИспользуется для создания, обновления и удаления значений в одном запросе.\r\n \r\n## Пример запроса (JSON):\r\n```text\r\nPOST /AttributeListOfValues\r\nAuthorization: Bearer <token>\r\n```\r\n```json\r\n[\r\n {\r\n \"attributeID\": 12,\r\n \"data\": [\r\n { \"key\": \"VAL_1\", \"value\": \"Значение 1\" },\r\n { \"key\": \"VAL_2\", \"value\": \"Значение 2\" }\r\n ]\r\n }\r\n]\r\n```\r\n \r\n## Пример успешного ответа (202):\r\n(пустой ответ body, операция принята к обработке)\r\n \r\n## Негативные сценарии:\r\n- 401
|
|
1802
|
+
"description": "Метод принимает набор значений и объединяет его с текущими данными атрибута.\r\nИспользуется для создания, обновления и удаления значений в одном запросе.\r\n \r\n## Пример запроса (JSON):\r\n```text\r\nPOST /AttributeListOfValues\r\nAuthorization: Bearer <token>\r\n```\r\n```json\r\n[\r\n {\r\n \"attributeID\": 12,\r\n \"data\": [\r\n { \"key\": \"VAL_1\", \"value\": \"Значение 1\" },\r\n { \"key\": \"VAL_2\", \"value\": \"Значение 2\" }\r\n ]\r\n }\r\n]\r\n```\r\n \r\n## Пример успешного ответа (202):\r\n(пустой ответ body, операция принята к обработке)\r\n \r\n## Негативные сценарии:\r\n- 401 Unauthorized — отсутствует или некорректен Bearer-токен.\r\n- 403 Forbidden — недостаточно прав `AttributeListOfValueMerge`.\r\n- 400 — некорректные данные (невалидный attributeID, пустые/битые значения).",
|
|
1881
1803
|
"parameters": [
|
|
1882
1804
|
{
|
|
1883
1805
|
"name": "X-Application-ID",
|
|
@@ -1969,7 +1891,7 @@
|
|
|
1969
1891
|
"Attributes"
|
|
1970
1892
|
],
|
|
1971
1893
|
"summary": "Возвращает атрибут по идентификатору.",
|
|
1972
|
-
"description": "Возвращает пользовательское поле вместе со списком допустимых значений, если они настроены.\r\n \r\n## Пример запроса:\r\nGET /Attributes/12\r\nAuthorization: Bearer <token>\r\n \r\n## Пример успешного ответа (200):\r\n{ \"name\": \"Договор №\", \"type\": { \"id\": 5, \"code\": \"DOC_NUM\", \"name\": \"Номер договора\" }, \"domain\": { \"id\": 2, \"name\": \"Договор\", \"code\": \"CONTRACT\" }, \"isPublic\": true, \"measurementUnit\": null, \"deleted\": null, \"relevantFor\": { \"task\": true, \"asset\": false, \"checkList\": false, \"completedWork\": false, \"contract\": true, \"company\": false, \"customer\": false, \"technician\": false }, \"listOfValues\": [ { \"key\": \"VAL_1\", \"value\": \"Значение 1\", \"deleted\": null } ] }\r\n \r\n## Негативные сценарии:\r\n- 401
|
|
1894
|
+
"description": "Возвращает пользовательское поле вместе со списком допустимых значений, если они настроены.\r\n \r\n## Пример запроса:\r\nGET /Attributes/12\r\nAuthorization: Bearer <token>\r\n \r\n## Пример успешного ответа (200):\r\n{ \"name\": \"Договор №\", \"type\": { \"id\": 5, \"code\": \"DOC_NUM\", \"name\": \"Номер договора\" }, \"domain\": { \"id\": 2, \"name\": \"Договор\", \"code\": \"CONTRACT\" }, \"isPublic\": true, \"measurementUnit\": null, \"deleted\": null, \"relevantFor\": { \"task\": true, \"asset\": false, \"checkList\": false, \"completedWork\": false, \"contract\": true, \"company\": false, \"customer\": false, \"technician\": false }, \"listOfValues\": [ { \"key\": \"VAL_1\", \"value\": \"Значение 1\", \"deleted\": null } ] }\r\n \r\n## Негативные сценарии:\r\n- 401 Unauthorized — отсутствует или некорректен Bearer-токен.\r\n- 403 Forbidden — недостаточно прав `AttributeGet`.\r\n- 204 — атрибут не найден/не доступен в текущем тенанте.",
|
|
1973
1895
|
"parameters": [
|
|
1974
1896
|
{
|
|
1975
1897
|
"name": "attributeID",
|
|
@@ -2052,7 +1974,7 @@
|
|
|
2052
1974
|
"Attributes"
|
|
2053
1975
|
],
|
|
2054
1976
|
"summary": "Возвращает список атрибутов.",
|
|
2055
|
-
"description": "Поддерживает фильтрацию по query-параметрам и ограничение результата через заголовок `Range`.\r\n \r\n## Пример запроса:\r\nGET /Attributes?isDeleted=false&isPublic=true&isRelevantForTask=true\r\nAuthorization: Bearer <token>\r\nRange:
|
|
1977
|
+
"description": "Поддерживает фильтрацию по query-параметрам и ограничение результата через заголовок `Range`.\r\n \r\n## Пример запроса:\r\nGET /Attributes?isDeleted=false&isPublic=true&isRelevantForTask=true\r\nAuthorization: Bearer <token>\r\nRange: items=1-50\r\n \r\n## Пример успешного ответа (200):\r\n{ \"12\": { \"name\": \"Договор №\", \"type\": { \"id\": 5, \"code\": \"DOC_NUM\", \"name\": \"Номер договора\" }, \"domain\": { \"id\": 2, \"name\": \"Договор\", \"code\": \"CONTRACT\" }, \"isPublic\": true, \"deleted\": null, \"relevantFor\": { \"task\": true, \"asset\": false, \"checkList\": false, \"completedWork\": false, \"contract\": true, \"company\": false, \"customer\": false, \"technician\": false }, \"listOfValues\": { \"VAL_1\": \"Значение 1\" } } }\r\n \r\n## Пример успешного ответа (206):\r\nТело ответа имеет тот же формат, что и для `200`, но содержит только часть диапазона.\r\n \r\n## Негативные сценарии:\r\n- 401 Unauthorized — отсутствует или некорректен Bearer-токен.\r\n- 403 Forbidden — недостаточно прав `AttributeList`.\r\n- 204 — атрибуты по фильтрам не найдены.",
|
|
2056
1978
|
"parameters": [
|
|
2057
1979
|
{
|
|
2058
1980
|
"name": "Range",
|
|
@@ -2265,7 +2187,7 @@
|
|
|
2265
2187
|
"Attributes"
|
|
2266
2188
|
],
|
|
2267
2189
|
"summary": "Создает атрибуты.",
|
|
2268
|
-
"description": "Метод принимает коллекцию пользовательских полей и создает их в текущем тенанте.\r\n \r\n## Пример запроса (JSON):\r\nPOST /Attributes\r\nAuthorization: Bearer <token>\r\n \r\n[\r\n {\r\n \"name\": \"Договор №\",\r\n \"attributeTypeID\": 5,\r\n \"domainID\": 2,\r\n \"isPublic\": true,\r\n \"measurementUnitID\": 1,\r\n \"isRelevantForTask\": true,\r\n \"isRelevantForAsset\": false,\r\n \"isRelevantForCheckList\": false,\r\n \"isRelevantForCompletedWork\": false,\r\n \"isRelevantForContract\": true,\r\n \"isRelevantForCompany\": false,\r\n \"isRelevantForCustomer\": false,\r\n \"isRelevantForTechnician\": false\r\n }\r\n]\r\n \r\n## Пример успешного ответа (201):\r\n[501]\r\n \r\n## Негативные сценарии:\r\n- 401
|
|
2190
|
+
"description": "Метод принимает коллекцию пользовательских полей и создает их в текущем тенанте.\r\n \r\n## Пример запроса (JSON):\r\nPOST /Attributes\r\nAuthorization: Bearer <token>\r\n \r\n[\r\n {\r\n \"name\": \"Договор №\",\r\n \"attributeTypeID\": 5,\r\n \"domainID\": 2,\r\n \"isPublic\": true,\r\n \"measurementUnitID\": 1,\r\n \"isRelevantForTask\": true,\r\n \"isRelevantForAsset\": false,\r\n \"isRelevantForCheckList\": false,\r\n \"isRelevantForCompletedWork\": false,\r\n \"isRelevantForContract\": true,\r\n \"isRelevantForCompany\": false,\r\n \"isRelevantForCustomer\": false,\r\n \"isRelevantForTechnician\": false\r\n }\r\n]\r\n \r\n## Пример успешного ответа (201):\r\n[501]\r\n \r\n## Негативные сценарии:\r\n- 401 Unauthorized — отсутствует или некорректен Bearer-токен.\r\n- 403 Forbidden — недостаточно прав `AttributeAdd`.\r\n- 400 — некорректные данные (невалидные ID типов/доменов, пустые обязательные поля и т.п.).",
|
|
2269
2191
|
"parameters": [
|
|
2270
2192
|
{
|
|
2271
2193
|
"name": "X-Application-ID",
|
|
@@ -2355,7 +2277,7 @@
|
|
|
2355
2277
|
"Attributes"
|
|
2356
2278
|
],
|
|
2357
2279
|
"summary": "Обновляет атрибуты.",
|
|
2358
|
-
"description": "Метод принимает коллекцию изменений и применяет их к существующим пользовательским полям.\r\n \r\n## Пример запроса (JSON):\r\nPUT /Attributes\r\nAuthorization: Bearer <token>\r\n \r\n[\r\n {\r\n \"id\": 501,\r\n \"name\": \"Договор № (обновлено)\",\r\n \"attributeTypeID\": 5,\r\n \"domainID\": 2,\r\n \"isPublic\": true,\r\n \"measurementUnitID\": 1\r\n }\r\n]\r\n \r\n## Пример успешного ответа (202):\r\n(пустой body)\r\n \r\n## Негативные сценарии:\r\n- 401
|
|
2280
|
+
"description": "Метод принимает коллекцию изменений и применяет их к существующим пользовательским полям.\r\n \r\n## Пример запроса (JSON):\r\nPUT /Attributes\r\nAuthorization: Bearer <token>\r\n \r\n[\r\n {\r\n \"id\": 501,\r\n \"name\": \"Договор № (обновлено)\",\r\n \"attributeTypeID\": 5,\r\n \"domainID\": 2,\r\n \"isPublic\": true,\r\n \"measurementUnitID\": 1\r\n }\r\n]\r\n \r\n## Пример успешного ответа (202):\r\n(пустой body)\r\n \r\n## Негативные сценарии:\r\n- 401 Unauthorized — отсутствует или некорректен Bearer-токен.\r\n- 403 Forbidden — недостаточно прав `AttributeUpdate`.\r\n- 400 — некорректные данные/несуществующий ID.",
|
|
2359
2281
|
"parameters": [
|
|
2360
2282
|
{
|
|
2361
2283
|
"name": "X-Application-ID",
|
|
@@ -2445,7 +2367,7 @@
|
|
|
2445
2367
|
"Attributes"
|
|
2446
2368
|
],
|
|
2447
2369
|
"summary": "Удаляет несколько атрибутов.",
|
|
2448
|
-
"description": "Метод принимает коллекцию идентификаторов и удаляет соответствующие пользовательские поля.\r\n \r\n## Пример запроса (JSON):\r\nDELETE /Attributes\r\nAuthorization: Bearer <token>\r\n \r\n[501, 502]\r\n \r\n## Пример успешного ответа (202):\r\n(пустой body)\r\n \r\n## Негативные сценарии:\r\n- 401
|
|
2370
|
+
"description": "Метод принимает коллекцию идентификаторов и удаляет соответствующие пользовательские поля.\r\n \r\n## Пример запроса (JSON):\r\nDELETE /Attributes\r\nAuthorization: Bearer <token>\r\n \r\n[501, 502]\r\n \r\n## Пример успешного ответа (202):\r\n(пустой body)\r\n \r\n## Негативные сценарии:\r\n- 401 Unauthorized — отсутствует или некорректен Bearer-токен.\r\n- 403 Forbidden — недостаточно прав `AttributeDelete`.\r\n- 400 — некорректные идентификаторы.",
|
|
2449
2371
|
"parameters": [
|
|
2450
2372
|
{
|
|
2451
2373
|
"name": "X-Application-ID",
|
|
@@ -2541,7 +2463,7 @@
|
|
|
2541
2463
|
"Attributes"
|
|
2542
2464
|
],
|
|
2543
2465
|
"summary": "Удаляет атрибут по идентификатору.",
|
|
2544
|
-
"description": "Является сокращенной формой группового удаления для одного пользовательского поля.\r\n \r\n## Пример запроса:\r\nDELETE /Attributes/501\r\nAuthorization: Bearer <token>\r\n \r\n## Пример успешного ответа (202):\r\n(пустой body)\r\n \r\n## Негативные сценарии:\r\n- 401
|
|
2466
|
+
"description": "Является сокращенной формой группового удаления для одного пользовательского поля.\r\n \r\n## Пример запроса:\r\nDELETE /Attributes/501\r\nAuthorization: Bearer <token>\r\n \r\n## Пример успешного ответа (202):\r\n(пустой body)\r\n \r\n## Негативные сценарии:\r\n- 401 Unauthorized — отсутствует или некорректен Bearer-токен.\r\n- 403 Forbidden — недостаточно прав `AttributeDelete`.\r\n- 400 — некорректный ID.",
|
|
2545
2467
|
"parameters": [
|
|
2546
2468
|
{
|
|
2547
2469
|
"name": "id",
|
|
@@ -2607,7 +2529,7 @@
|
|
|
2607
2529
|
"Attributes"
|
|
2608
2530
|
],
|
|
2609
2531
|
"summary": "Возвращает допустимые значения атрибута.",
|
|
2610
|
-
"description": "Метод используется для пользовательских полей со списком значений.\r\nПоддерживает диапазон через заголовок `Range`.\r\n \r\n## Пример запроса:\r\n```text\r\nGET /Attributes/12/listOfValues\r\nAuthorization: Bearer <token>\r\nRange:
|
|
2532
|
+
"description": "Метод используется для пользовательских полей со списком значений.\r\nПоддерживает диапазон через заголовок `Range`.\r\n \r\n## Пример запроса:\r\n```text\r\nGET /Attributes/12/listOfValues\r\nAuthorization: Bearer <token>\r\nRange: items=1-50\r\n```\r\n \r\n## Пример успешного ответа (200):\r\n```json\r\n{ \"VAL_1\": \"Значение 1\", \"VAL_2\": \"Значение 2\" }\r\n```\r\n \r\n## Пример успешного ответа (206):\r\nТело ответа имеет тот же формат, что и для `200`, но содержит только часть диапазона.\r\n \r\n## Негативные сценарии:\r\n- 401 Unauthorized — отсутствует или некорректен Bearer-токен.\r\n- 403 Forbidden — недостаточно прав `AttributeListOfValuesList`.\r\n- 204 — для атрибута не найдено допустимых значений.",
|
|
2611
2533
|
"parameters": [
|
|
2612
2534
|
{
|
|
2613
2535
|
"name": "attributeID",
|
|
@@ -2752,7 +2674,7 @@
|
|
|
2752
2674
|
"AttributeTypes"
|
|
2753
2675
|
],
|
|
2754
2676
|
"summary": "Возвращает список типов атрибутов.",
|
|
2755
|
-
"description": "Возвращает сгруппированный справочник типов пользовательских полей.\r\nПоддерживает диапазон через заголовок `Range`.\r\n \r\n## Пример запроса:\r\n```text\r\nGET /AttributeTypes\r\nAuthorization: Bearer <token>\r\nRange:
|
|
2677
|
+
"description": "Возвращает сгруппированный справочник типов пользовательских полей.\r\nПоддерживает диапазон через заголовок `Range`.\r\n \r\n## Пример запроса:\r\n```text\r\nGET /AttributeTypes\r\nAuthorization: Bearer <token>\r\nRange: items=1-50\r\n```\r\n \r\n## Пример успешного ответа (200):\r\n```json\r\n{ \"3\": { \"code\": \"TASK_ATTR\", \"name\": \"Атрибут задачи\" } }\r\n```\r\n \r\n## Пример успешного ответа (206):\r\nТело ответа имеет тот же формат, что и для `200`, но содержит только часть диапазона.\r\n \r\n## Негативные сценарии:\r\n- 401 Unauthorized — отсутствует или некорректен Bearer-токен.\r\n- 403 Forbidden — недостаточно прав `AttributeTypeList`.",
|
|
2756
2678
|
"parameters": [
|
|
2757
2679
|
{
|
|
2758
2680
|
"name": "Range",
|
|
@@ -2884,7 +2806,7 @@
|
|
|
2884
2806
|
"AttributeTypes"
|
|
2885
2807
|
],
|
|
2886
2808
|
"summary": "Возвращает плоский список типов атрибутов с доменами.",
|
|
2887
|
-
"description": "В отличие от базового метода, возвращает записи в плоском виде, включая связанный домен, если он есть.\r\nПоддерживает диапазон через заголовок `Range`.\r\n \r\n## Пример запроса:\r\n```text\r\nGET /AttributeTypes/v2\r\nAuthorization: Bearer <token>\r\nRange:
|
|
2809
|
+
"description": "В отличие от базового метода, возвращает записи в плоском виде, включая связанный домен, если он есть.\r\nПоддерживает диапазон через заголовок `Range`.\r\n \r\n## Пример запроса:\r\n```text\r\nGET /AttributeTypes/v2\r\nAuthorization: Bearer <token>\r\nRange: items=1-50\r\n```\r\n \r\n## Пример успешного ответа (200):\r\n```json\r\n[ { \"id\": 3, \"code\": \"TASK_ATTR\", \"name\": \"Атрибут задачи\", \"domain\": { \"id\": 1, \"name\": \"Задача\", \"code\": \"TASK\" } } ]\r\n```\r\n \r\n## Пример успешного ответа (206):\r\nТело ответа имеет тот же формат, что и для `200`, но содержит только часть диапазона.\r\n \r\n## Негативные сценарии:\r\n- 401 Unauthorized — отсутствует или некорректен Bearer-токен.\r\n- 403 Forbidden — недостаточно прав `AttributeTypeList`.",
|
|
2888
2810
|
"parameters": [
|
|
2889
2811
|
{
|
|
2890
2812
|
"name": "Range",
|
|
@@ -3016,7 +2938,7 @@
|
|
|
3016
2938
|
"Banks"
|
|
3017
2939
|
],
|
|
3018
2940
|
"summary": "Возвращает список банков.",
|
|
3019
|
-
"description": "Поддерживает фильтрацию по query-параметрам и ограничение результата через заголовок `Range`.\r\n \r\n## Пример запроса:\r\n```text\r\nGET /Banks?searchText=central\r\nAuthorization: Bearer <token>\r\nRange:
|
|
2941
|
+
"description": "Поддерживает фильтрацию по query-параметрам и ограничение результата через заголовок `Range`.\r\n \r\n## Пример запроса:\r\n```text\r\nGET /Banks?searchText=central\r\nAuthorization: Bearer <token>\r\nRange: items=1-50\r\n```\r\n \r\n## Пример успешного ответа (200):\r\n```json\r\n{ \"1\": { \"id\": 1, \"name\": \"Центральный банк\", \"bic\": \"044525225\", \"correspondingAccount\": \"30101810400000000225\", \"swift\": \"SWIFT\", \"phone\": \"+74950001122\", \"eMail\": \"bank@example.com\", \"address\": \"Россия, Москва\", \"isActive\": true } }\r\n```\r\n \r\n## Пример успешного ответа (206):\r\nТело ответа имеет тот же формат, что и для `200`, но содержит только часть диапазона.\r\n \r\n## Негативные сценарии:\r\n- 401 Unauthorized — отсутствует или некорректен Bearer-токен.\r\n- 403 Forbidden — недостаточно прав `BankList`.\r\n- 204 — банки по фильтрам не найдены.",
|
|
3020
2942
|
"parameters": [
|
|
3021
2943
|
{
|
|
3022
2944
|
"name": "searchText",
|
|
@@ -3058,14 +2980,6 @@
|
|
|
3058
2980
|
"type": "boolean"
|
|
3059
2981
|
}
|
|
3060
2982
|
},
|
|
3061
|
-
{
|
|
3062
|
-
"name": "searchText",
|
|
3063
|
-
"in": "query",
|
|
3064
|
-
"description": "Строка поиска по названию или реквизитам банка",
|
|
3065
|
-
"schema": {
|
|
3066
|
-
"type": "string"
|
|
3067
|
-
}
|
|
3068
|
-
},
|
|
3069
2983
|
{
|
|
3070
2984
|
"name": "X-Application-ID",
|
|
3071
2985
|
"in": "header",
|
|
@@ -3175,7 +3089,7 @@
|
|
|
3175
3089
|
"Banks"
|
|
3176
3090
|
],
|
|
3177
3091
|
"summary": "Возвращает данные банка по идентификатору.",
|
|
3178
|
-
"description": "Используется для открытия карточки банка или проверки существования записи.\r\n \r\n## Пример запроса:\r\n```text\r\nGET /Banks/1\r\nAuthorization: Bearer <token>\r\n```\r\n \r\n## Пример успешного ответа (200):\r\n```json\r\n{ \"id\": 1, \"name\": \"Центральный банк\", \"bic\": \"044525225\", \"correspondingAccount\": \"30101810400000000225\", \"swift\": \"SABRRUMM\", \"phone\": \"+74951234567\", \"eMail\": \"info@sberbank.ru\", \"address\": \"Москва, ул. Тестовая, 1\", \"isActive\": true }\r\n```\r\n \r\n## Негативные сценарии:\r\n- 401
|
|
3092
|
+
"description": "Используется для открытия карточки банка или проверки существования записи.\r\n \r\n## Пример запроса:\r\n```text\r\nGET /Banks/1\r\nAuthorization: Bearer <token>\r\n```\r\n \r\n## Пример успешного ответа (200):\r\n```json\r\n{ \"id\": 1, \"name\": \"Центральный банк\", \"bic\": \"044525225\", \"correspondingAccount\": \"30101810400000000225\", \"swift\": \"SABRRUMM\", \"phone\": \"+74951234567\", \"eMail\": \"info@sberbank.ru\", \"address\": \"Москва, ул. Тестовая, 1\", \"isActive\": true }\r\n```\r\n \r\n## Негативные сценарии:\r\n- 401 Unauthorized — отсутствует или некорректен Bearer-токен.\r\n- 403 Forbidden — недостаточно прав `BankGet`.\r\n- 404 — банк с указанным id не найден.",
|
|
3179
3093
|
"parameters": [
|
|
3180
3094
|
{
|
|
3181
3095
|
"name": "bankId",
|
|
@@ -3258,7 +3172,7 @@
|
|
|
3258
3172
|
"Contacts"
|
|
3259
3173
|
],
|
|
3260
3174
|
"summary": "Возвращает контакт по идентификатору.",
|
|
3261
|
-
"description": "Используется для открытия карточки контакта.\r\n \r\n## Пример запроса:\r\n```text\r\nGET /Contacts/123\r\nAuthorization: Bearer <token>\r\n```\r\n \r\n## Пример успешного ответа (200):\r\n```json\r\n{ \"id\": 123, \"fullName\": \"Иван Иванов\", \"email\": \"ivan@example.com\", \"phone\": \"+79990001122\", \"position\": \"Менеджер\", \"description\": \"Описание\", \"deleted\": null }\r\n```\r\n \r\n## Негативные сценарии:\r\n- 401
|
|
3175
|
+
"description": "Используется для открытия карточки контакта.\r\n \r\n## Пример запроса:\r\n```text\r\nGET /Contacts/123\r\nAuthorization: Bearer <token>\r\n```\r\n \r\n## Пример успешного ответа (200):\r\n```json\r\n{ \"id\": 123, \"fullName\": \"Иван Иванов\", \"email\": \"ivan@example.com\", \"phone\": \"+79990001122\", \"position\": \"Менеджер\", \"description\": \"Описание\", \"deleted\": null }\r\n```\r\n \r\n## Негативные сценарии:\r\n- 401 Unauthorized — отсутствует или некорректен Bearer-токен.\r\n- 403 Forbidden — недостаточно прав `ContactGet`.\r\n- 204 — контакт недоступен/отсутствует.",
|
|
3262
3176
|
"parameters": [
|
|
3263
3177
|
{
|
|
3264
3178
|
"name": "contactID",
|
|
@@ -3341,7 +3255,7 @@
|
|
|
3341
3255
|
"Contacts"
|
|
3342
3256
|
],
|
|
3343
3257
|
"summary": "Возвращает список контактов.",
|
|
3344
|
-
"description": "Поддерживает фильтрацию по query-параметрам и ограничение результата через заголовок `Range`.\r\nЕсли диапазон не передан, применяется стандартное ограничение на размер выборки.\r\n \r\n## Пример запроса:\r\n```text\r\nGET /Contacts?searchText=ivan\r\nAuthorization: Bearer <token>\r\nRange:
|
|
3258
|
+
"description": "Поддерживает фильтрацию по query-параметрам и ограничение результата через заголовок `Range`.\r\nЕсли диапазон не передан, применяется стандартное ограничение на размер выборки.\r\n \r\n## Пример запроса:\r\n```text\r\nGET /Contacts?searchText=ivan\r\nAuthorization: Bearer <token>\r\nRange: items=1-50\r\n```\r\n \r\n## Пример успешного ответа (200):\r\n```json\r\n{ \"1\": { \"id\": 1, \"fullName\": \"Иван Иванов\", \"email\": \"ivan@example.com\", \"phone\": \"+79990001122\", \"position\": \"Менеджер\", \"description\": \"Описание\", \"deleted\": null, \"isUsed\": true } }\r\n```\r\n \r\n## Пример успешного ответа (206):\r\nТело ответа имеет тот же формат, что и для `200`, но содержит только часть диапазона.\r\n \r\n## Негативные сценарии:\r\n- 401 Unauthorized — отсутствует или некорректен Bearer-токен.\r\n- 403 Forbidden — недостаточно прав `ContactsList`.\r\n- 204 — подходящие контакты не найдены.",
|
|
3345
3259
|
"parameters": [
|
|
3346
3260
|
{
|
|
3347
3261
|
"name": "searchText",
|
|
@@ -3392,14 +3306,6 @@
|
|
|
3392
3306
|
"format": "int32"
|
|
3393
3307
|
}
|
|
3394
3308
|
},
|
|
3395
|
-
{
|
|
3396
|
-
"name": "searchText",
|
|
3397
|
-
"in": "query",
|
|
3398
|
-
"description": "Строка поиска по контактам",
|
|
3399
|
-
"schema": {
|
|
3400
|
-
"type": "string"
|
|
3401
|
-
}
|
|
3402
|
-
},
|
|
3403
3309
|
{
|
|
3404
3310
|
"name": "X-Application-ID",
|
|
3405
3311
|
"in": "header",
|
|
@@ -3507,7 +3413,7 @@
|
|
|
3507
3413
|
"Contacts"
|
|
3508
3414
|
],
|
|
3509
3415
|
"summary": "Создает контакты.",
|
|
3510
|
-
"description": "Метод принимает коллекцию контактов и создает их в текущем тенанте.\r\n \r\n## Пример запроса (JSON):\r\n```text\r\nPOST /Contacts\r\nAuthorization: Bearer <token>\r\n```\r\n \r\n```json\r\n[\r\n { \"fullName\": \"Иван Иванов\", \"email\": \"ivan@example.com\", \"phone\": \"+79990001122\", \"position\": \"Менеджер\", \"description\": \"Описание\" }\r\n]\r\n```\r\n \r\n## Пример успешного ответа (201):\r\n```json\r\n[ 101 ]\r\n```\r\n \r\n## Негативные сценарии:\r\n- 401
|
|
3416
|
+
"description": "Метод принимает коллекцию контактов и создает их в текущем тенанте.\r\n \r\n## Пример запроса (JSON):\r\n```text\r\nPOST /Contacts\r\nAuthorization: Bearer <token>\r\n```\r\n \r\n```json\r\n[\r\n { \"fullName\": \"Иван Иванов\", \"email\": \"ivan@example.com\", \"phone\": \"+79990001122\", \"position\": \"Менеджер\", \"description\": \"Описание\" }\r\n]\r\n```\r\n \r\n## Пример успешного ответа (201):\r\n```json\r\n[ 101 ]\r\n```\r\n \r\n## Негативные сценарии:\r\n- 401 Unauthorized — отсутствует или некорректен Bearer-токен.\r\n- 403 Forbidden — недостаточно прав `ContactAdd`.\r\n- 400 — некорректные данные (невалидный email/телефон, пустые обязательные поля и т.п.).",
|
|
3511
3417
|
"parameters": [
|
|
3512
3418
|
{
|
|
3513
3419
|
"name": "X-Application-ID",
|
|
@@ -3597,7 +3503,7 @@
|
|
|
3597
3503
|
"Contacts"
|
|
3598
3504
|
],
|
|
3599
3505
|
"summary": "Обновляет контакты.",
|
|
3600
|
-
"description": "Метод принимает коллекцию изменений и применяет их к существующим контактам.\r\n \r\n## Пример запроса (JSON):\r\n```text\r\nPUT /Contacts\r\nAuthorization: Bearer <token>\r\n```\r\n \r\n```json\r\n[\r\n { \"id\": 101, \"fullName\": \"Иван Иванов (обновленный)\", \"email\": \"ivan@example.com\", \"phone\": \"+79990001122\", \"position\": \"Директор\", \"description\": \"Описание (обновлено)\" }\r\n]\r\n```\r\n \r\n## Пример успешного ответа (202):\r\n(пустой response body)\r\n \r\n## Негативные сценарии:\r\n- 401
|
|
3506
|
+
"description": "Метод принимает коллекцию изменений и применяет их к существующим контактам.\r\n \r\n## Пример запроса (JSON):\r\n```text\r\nPUT /Contacts\r\nAuthorization: Bearer <token>\r\n```\r\n \r\n```json\r\n[\r\n { \"id\": 101, \"fullName\": \"Иван Иванов (обновленный)\", \"email\": \"ivan@example.com\", \"phone\": \"+79990001122\", \"position\": \"Директор\", \"description\": \"Описание (обновлено)\" }\r\n]\r\n```\r\n \r\n## Пример успешного ответа (202):\r\n(пустой response body)\r\n \r\n## Негативные сценарии:\r\n- 401 Unauthorized — отсутствует или некорректен Bearer-токен.\r\n- 403 Forbidden — недостаточно прав `ContactUpdate`.\r\n- 400 — некорректные данные/несуществующий ID.",
|
|
3601
3507
|
"parameters": [
|
|
3602
3508
|
{
|
|
3603
3509
|
"name": "X-Application-ID",
|
|
@@ -3687,7 +3593,7 @@
|
|
|
3687
3593
|
"Contacts"
|
|
3688
3594
|
],
|
|
3689
3595
|
"summary": "Удаляет несколько контактов.",
|
|
3690
|
-
"description": "Метод принимает коллекцию идентификаторов и помечает соответствующие контакты как удаленные.\r\n \r\n## Пример запроса (JSON):\r\n```text\r\nDELETE /Contacts\r\nAuthorization: Bearer <token>\r\n```\r\n \r\n```json\r\n[101, 102]\r\n```\r\n \r\n## Пример успешного ответа (202):\r\n(пустой response body)\r\n \r\n## Негативные сценарии:\r\n- 401
|
|
3596
|
+
"description": "Метод принимает коллекцию идентификаторов и помечает соответствующие контакты как удаленные.\r\n \r\n## Пример запроса (JSON):\r\n```text\r\nDELETE /Contacts\r\nAuthorization: Bearer <token>\r\n```\r\n \r\n```json\r\n[101, 102]\r\n```\r\n \r\n## Пример успешного ответа (202):\r\n(пустой response body)\r\n \r\n## Негативные сценарии:\r\n- 401 Unauthorized — отсутствует или некорректен Bearer-токен.\r\n- 403 Forbidden — недостаточно прав `ContactDelete`.\r\n- 400 — некорректные идентификаторы.",
|
|
3691
3597
|
"parameters": [
|
|
3692
3598
|
{
|
|
3693
3599
|
"name": "X-Application-ID",
|
|
@@ -3783,7 +3689,7 @@
|
|
|
3783
3689
|
"Contacts"
|
|
3784
3690
|
],
|
|
3785
3691
|
"summary": "Удаляет контакт по идентификатору.",
|
|
3786
|
-
"description": "Является сокращенной формой группового удаления для одного контакта.\r\n \r\n## Пример запроса:\r\n```text\r\nDELETE /Contacts/101\r\nAuthorization: Bearer <token>\r\n```\r\n \r\n## Пример успешного ответа (202):\r\n(пустой response body)\r\n \r\n## Негативные сценарии:\r\n- 401
|
|
3692
|
+
"description": "Является сокращенной формой группового удаления для одного контакта.\r\n \r\n## Пример запроса:\r\n```text\r\nDELETE /Contacts/101\r\nAuthorization: Bearer <token>\r\n```\r\n \r\n## Пример успешного ответа (202):\r\n(пустой response body)\r\n \r\n## Негативные сценарии:\r\n- 401 Unauthorized — отсутствует или некорректен Bearer-токен.\r\n- 403 Forbidden — недостаточно прав `ContactDelete`.\r\n- 400 — некорректный id.",
|
|
3787
3693
|
"parameters": [
|
|
3788
3694
|
{
|
|
3789
3695
|
"name": "id",
|
|
@@ -3849,7 +3755,7 @@
|
|
|
3849
3755
|
"Countries"
|
|
3850
3756
|
],
|
|
3851
3757
|
"summary": "Возвращает список стран.",
|
|
3852
|
-
"description": "Метод используется для заполнения справочников стран.\r\nПоддерживает диапазон через заголовок `Range`.\r\n \r\n## Пример запроса:\r\n```text\r\nGET /Countries\r\nAuthorization: Bearer <token>\r\nRange:
|
|
3758
|
+
"description": "Метод используется для заполнения справочников стран.\r\nПоддерживает диапазон через заголовок `Range`.\r\n \r\n## Пример запроса:\r\n```text\r\nGET /Countries\r\nAuthorization: Bearer <token>\r\nRange: items=1-50\r\n```\r\n \r\n## Пример успешного ответа (200):\r\n```json\r\n{ \"1\": { \"name\": \"Россия\", \"twoSymbolCode\": \"RU\", \"threeSymbolCode\": \"RUS\" } }\r\n```\r\n \r\n## Пример успешного ответа (206):\r\nТело ответа имеет тот же формат, что и для `200`, но содержит только часть диапазона.\r\n \r\n## Негативные сценарии:\r\n- 401 Unauthorized — отсутствует или некорректен Bearer-токен.\r\n- 403 Forbidden — недостаточно прав `CountriesList`.\r\n- 204 — список стран пуст (нет записей).",
|
|
3853
3759
|
"parameters": [
|
|
3854
3760
|
{
|
|
3855
3761
|
"name": "Range",
|
|
@@ -3984,7 +3890,7 @@
|
|
|
3984
3890
|
"Currencies"
|
|
3985
3891
|
],
|
|
3986
3892
|
"summary": "Возвращает список валют.",
|
|
3987
|
-
"description": "Используется для заполнения справочников валют в интерфейсах HubEx.\r\nПри передаче заголовка диапазона возвращает частичный набор записей.\r\n \r\n## Пример запроса:\r\n```text\r\nGET /Currencies\r\nAuthorization: Bearer <token>\r\nRange:
|
|
3893
|
+
"description": "Используется для заполнения справочников валют в интерфейсах HubEx.\r\nПри передаче заголовка диапазона возвращает частичный набор записей.\r\n \r\n## Пример запроса:\r\n```text\r\nGET /Currencies\r\nAuthorization: Bearer <token>\r\nRange: items=1-50\r\n```\r\n \r\n## Пример успешного ответа (200):\r\n```json\r\n{ \"1\": { \"name\": \"Российский рубль\", \"shortName\": \"RUB\", \"asciiCode\": \"RUB\" } }\r\n```\r\n \r\n## Пример успешного ответа (206):\r\nТело ответа имеет тот же формат, что и для `200`, но содержит только часть диапазона.\r\n \r\n## Негативные сценарии:\r\n- 401 Unauthorized — отсутствует или некорректен Bearer-токен.\r\n- 403 Forbidden — недостаточно прав `CurrenciesList`.\r\n- 204 — справочник валют пуст (записей нет).",
|
|
3988
3894
|
"parameters": [
|
|
3989
3895
|
{
|
|
3990
3896
|
"name": "Range",
|
|
@@ -4119,7 +4025,7 @@
|
|
|
4119
4025
|
"Events"
|
|
4120
4026
|
],
|
|
4121
4027
|
"summary": "Возвращает список событий.",
|
|
4122
|
-
"description": "Позволяет отфильтровать события по типу транспорта, системному признаку и признаку скрытия.\r\nПоддерживает диапазон через заголовок `Range`.\r\n \r\n## Пример запроса:\r\n```text\r\nGET /Events?
|
|
4028
|
+
"description": "Позволяет отфильтровать события по типу транспорта, системному признаку и признаку скрытия.\r\nПоддерживает диапазон через заголовок `Range`.\r\n \r\n## Пример запроса:\r\n```text\r\nGET /Events?eventTransportTypeID=1&isSystem=true&isHidden=false\r\nAuthorization: Bearer <token>\r\nRange: items=1-50\r\n```\r\n \r\n## Пример успешного ответа (200):\r\n```json\r\n{ \"10\": { \"id\": 10, \"name\": \"Событие\", \"code\": \"EVENT_1\" } }\r\n```\r\n \r\n## Пример успешного ответа (206):\r\nТело ответа имеет тот же формат, что и для `200`, но содержит только часть диапазона.\r\n \r\n## Негативные сценарии:\r\n- 401 Unauthorized — отсутствует или некорректен Bearer-токен.\r\n- 403 Forbidden — недостаточно прав `EventList`.\r\n- 204 — подходящие события не найдены.",
|
|
4123
4029
|
"parameters": [
|
|
4124
4030
|
{
|
|
4125
4031
|
"name": "Range",
|
|
@@ -4279,7 +4185,7 @@
|
|
|
4279
4185
|
"MeasurementUnits"
|
|
4280
4186
|
],
|
|
4281
4187
|
"summary": "Возвращает список единиц измерения.",
|
|
4282
|
-
"description": "Используется для вывода справочника единиц измерения.\r\nПри наличии заголовка диапазона возвращает частичный результат.\r\n \r\n## Пример запроса:\r\n```text\r\nGET /MeasurementUnits\r\nAuthorization: Bearer <token>\r\nRange:
|
|
4188
|
+
"description": "Используется для вывода справочника единиц измерения.\r\nПри наличии заголовка диапазона возвращает частичный результат.\r\n \r\n## Пример запроса:\r\n```text\r\nGET /MeasurementUnits\r\nAuthorization: Bearer <token>\r\nRange: items=1-50\r\n```\r\n \r\n## Пример успешного ответа (200):\r\n```json\r\n{ \"1\": { \"name\": \"штука\", \"abbreviation\": \"шт\", \"designation\": \"piece\" } }\r\n```\r\n \r\n## Пример успешного ответа (206):\r\nТело ответа имеет тот же формат, что и для `200`, но содержит только часть диапазона.\r\n \r\n## Негативные сценарии:\r\n- 401 Unauthorized — отсутствует или некорректен Bearer-токен.\r\n- 403 Forbidden — недостаточно прав `MeasurementUnitList`.\r\n- 204 — справочник единиц измерения пуст.",
|
|
4283
4189
|
"parameters": [
|
|
4284
4190
|
{
|
|
4285
4191
|
"name": "Range",
|
|
@@ -4414,7 +4320,7 @@
|
|
|
4414
4320
|
"PowerBIReports"
|
|
4415
4321
|
],
|
|
4416
4322
|
"summary": "Возвращает список Power BI отчетов.",
|
|
4417
|
-
"description": "Используется для получения списка отчетов, доступных пользователю.\r\nПоддерживает диапазон через заголовок `Range`.\r\n \r\n## Пример запроса:\r\n```text\r\nGET /PowerBIReports\r\nAuthorization: Bearer <token>\r\nRange:
|
|
4323
|
+
"description": "Используется для получения списка отчетов, доступных пользователю.\r\nПоддерживает диапазон через заголовок `Range`.\r\n \r\n## Пример запроса:\r\n```text\r\nGET /PowerBIReports\r\nAuthorization: Bearer <token>\r\nRange: items=1-50\r\n```\r\n \r\n## Пример успешного ответа (200):\r\n```json\r\n[ { \"id\": 1, \"name\": \"Отчет по продажам\", \"reportID\": \"RPT_001\", \"reportType\": { \"id\": 2, \"name\": \"Sales\" } } ]\r\n```\r\n \r\n## Пример успешного ответа (206):\r\nТело ответа имеет тот же формат, что и для `200`, но содержит только часть диапазона.\r\n \r\n## Негативные сценарии:\r\n- 401 Unauthorized — отсутствует или некорректен Bearer-токен.\r\n- 403 Forbidden — недостаточно прав `PowerBIReportList`.\r\n- 204 — отчетов по доступности нет.",
|
|
4418
4324
|
"parameters": [
|
|
4419
4325
|
{
|
|
4420
4326
|
"name": "Range",
|
|
@@ -4549,7 +4455,7 @@
|
|
|
4549
4455
|
"PowerBIReports"
|
|
4550
4456
|
],
|
|
4551
4457
|
"summary": "Возвращает Power BI отчет по идентификатору.",
|
|
4552
|
-
"description": "Используется для получения детальной информации о конкретном отчете.\r\n \r\n## Пример запроса:\r\n```text\r\nGET /PowerBIReports/1\r\nAuthorization: Bearer <token>\r\n```\r\n \r\n## Пример успешного ответа (200):\r\n```json\r\n{ \"id\": 1, \"name\": \"Отчет по продажам\", \"reportID\": \"RPT_001\", \"reportType\": { \"id\": 2, \"name\": \"Sales\" } }\r\n```\r\n \r\n## Негативные сценарии:\r\n- 401
|
|
4458
|
+
"description": "Используется для получения детальной информации о конкретном отчете.\r\n \r\n## Пример запроса:\r\n```text\r\nGET /PowerBIReports/1\r\nAuthorization: Bearer <token>\r\n```\r\n \r\n## Пример успешного ответа (200):\r\n```json\r\n{ \"id\": 1, \"name\": \"Отчет по продажам\", \"reportID\": \"RPT_001\", \"reportType\": { \"id\": 2, \"name\": \"Sales\" } }\r\n```\r\n \r\n## Негативные сценарии:\r\n- 401 Unauthorized — отсутствует или некорректен Bearer-токен.\r\n- 403 Forbidden — недостаточно прав `PowerBIReportGet`.\r\n- 404 — отчет с указанным id не найден.",
|
|
4553
4459
|
"parameters": [
|
|
4554
4460
|
{
|
|
4555
4461
|
"name": "id",
|
|
@@ -4632,7 +4538,7 @@
|
|
|
4632
4538
|
"SystemTags"
|
|
4633
4539
|
],
|
|
4634
4540
|
"summary": "Возвращает список системных тегов.",
|
|
4635
|
-
"description": "Метод отдает системные теги, доступные пользователю в текущем тенанте.\r\nПоддерживает диапазон через заголовок `Range`.\r\n \r\n## Пример запроса:\r\n```text\r\nGET /SystemTags\r\nAuthorization: Bearer <token>\r\nRange:
|
|
4541
|
+
"description": "Метод отдает системные теги, доступные пользователю в текущем тенанте.\r\nПоддерживает диапазон через заголовок `Range`.\r\n \r\n## Пример запроса:\r\n```text\r\nGET /SystemTags\r\nAuthorization: Bearer <token>\r\nRange: items=1-50\r\n```\r\n \r\n## Пример успешного ответа (200):\r\n```json\r\n[ { \"id\": 1, \"name\": \"Системный тег\" } ]\r\n```\r\n \r\n## Пример успешного ответа (206):\r\nТело ответа имеет тот же формат, что и для `200`, но содержит только часть диапазона.\r\n \r\n## Негативные сценарии:\r\n- 401 Unauthorized — отсутствует или некорректен Bearer-токен.\r\n- 403 Forbidden — недостаточно прав `TagsList`.\r\n- 204 — системных тегов для текущего тенанта нет.",
|
|
4636
4542
|
"parameters": [
|
|
4637
4543
|
{
|
|
4638
4544
|
"name": "Range",
|
|
@@ -4767,7 +4673,7 @@
|
|
|
4767
4673
|
"Tags"
|
|
4768
4674
|
],
|
|
4769
4675
|
"summary": "Возвращает список тегов.",
|
|
4770
|
-
"description": "Если указан `searchText`, в ответ попадают только теги, соответствующие условию поиска.\r\nПоддерживается ограничение диапазоном через заголовок `Range`.\r\n \r\n## Пример запроса:\r\n```text\r\nGET /Tags?searchText=finance\r\nAuthorization: Bearer <token>\r\nRange:
|
|
4676
|
+
"description": "Если указан `searchText`, в ответ попадают только теги, соответствующие условию поиска.\r\nПоддерживается ограничение диапазоном через заголовок `Range`.\r\n \r\n## Пример запроса:\r\n```text\r\nGET /Tags?searchText=finance\r\nAuthorization: Bearer <token>\r\nRange: items=1-50\r\n```\r\n \r\n## Пример успешного ответа (200):\r\n```json\r\n[ \"finance\", \"bank\", \"reporting\" ]\r\n```\r\n \r\n## Пример успешного ответа (206):\r\nТело ответа имеет тот же формат, что и для `200`, но содержит только часть диапазона.\r\n \r\n## Негативные сценарии:\r\n- 401 Unauthorized — отсутствует или некорректен Bearer-токен.\r\n- 403 Forbidden — недостаточно прав `TagsList`.\r\n- 204 — подходящие теги не найдены.",
|
|
4771
4677
|
"parameters": [
|
|
4772
4678
|
{
|
|
4773
4679
|
"name": "searchText",
|
|
@@ -4801,14 +4707,6 @@
|
|
|
4801
4707
|
"type": "string"
|
|
4802
4708
|
}
|
|
4803
4709
|
},
|
|
4804
|
-
{
|
|
4805
|
-
"name": "searchText",
|
|
4806
|
-
"in": "query",
|
|
4807
|
-
"description": "Строка поиска по тексту тега",
|
|
4808
|
-
"schema": {
|
|
4809
|
-
"type": "string"
|
|
4810
|
-
}
|
|
4811
|
-
},
|
|
4812
4710
|
{
|
|
4813
4711
|
"name": "X-Application-ID",
|
|
4814
4712
|
"in": "header",
|
|
@@ -4918,7 +4816,7 @@
|
|
|
4918
4816
|
"Timezones"
|
|
4919
4817
|
],
|
|
4920
4818
|
"summary": "Возвращает список часовых поясов.",
|
|
4921
|
-
"description": "Метод отдает справочник доступных часовых поясов.\r\nПоддерживает диапазон через заголовок `Range`.\r\n \r\n## Пример запроса:\r\n```text\r\nGET /Timezones\r\nAuthorization: Bearer <token>\r\nRange:
|
|
4819
|
+
"description": "Метод отдает справочник доступных часовых поясов.\r\nПоддерживает диапазон через заголовок `Range`.\r\n \r\n## Пример запроса:\r\n```text\r\nGET /Timezones\r\nAuthorization: Bearer <token>\r\nRange: items=1-50\r\n```\r\n \r\n## Пример успешного ответа (200):\r\n```json\r\n{ \"1\": { \"name\": \"Москва\", \"utcTimeOffset\": \"+03:00\" } }\r\n```\r\n \r\n## Пример успешного ответа (206):\r\nТело ответа имеет тот же формат, что и для `200`, но содержит только часть диапазона.\r\n \r\n## Негативные сценарии:\r\n- 401 Unauthorized — отсутствует или некорректен Bearer-токен.\r\n- 403 Forbidden — недостаточно прав `TimezonesList`.\r\n- 204 — часовые пояса не найдены.",
|
|
4922
4820
|
"parameters": [
|
|
4923
4821
|
{
|
|
4924
4822
|
"name": "Range",
|
|
@@ -5053,7 +4951,7 @@
|
|
|
5053
4951
|
"Timezones"
|
|
5054
4952
|
],
|
|
5055
4953
|
"summary": "Возвращает информацию о часовом поясе.",
|
|
5056
|
-
"description": "Метод возвращает детальную информацию по часовому поясу по его идентификатору.\r\n \r\n## Пример запроса:\r\n```text\r\nGET /Timezones/info?timezoneId=1\r\nAuthorization: Bearer <token>\r\n```\r\n \r\n## Пример успешного ответа (200):\r\n```json\r\n{ \"name\": \"Москва\", \"utcTimeOffsetMinutes\": 180 }\r\n```\r\n \r\n## Негативные сценарии:\r\n- 401
|
|
4954
|
+
"description": "Метод возвращает детальную информацию по часовому поясу по его идентификатору.\r\n \r\n## Пример запроса:\r\n```text\r\nGET /Timezones/info?timezoneId=1\r\nAuthorization: Bearer <token>\r\n```\r\n \r\n## Пример успешного ответа (200):\r\n```json\r\n{ \"name\": \"Москва\", \"utcTimeOffsetMinutes\": 180 }\r\n```\r\n \r\n## Негативные сценарии:\r\n- 401 Unauthorized — отсутствует или некорректен Bearer-токен.\r\n- 403 Forbidden — недостаточно прав `TimezonesList`.\r\n- 204 — часовой пояс не найден.",
|
|
5057
4955
|
"parameters": [
|
|
5058
4956
|
{
|
|
5059
4957
|
"name": "timezoneId",
|
|
@@ -5064,39 +4962,6 @@
|
|
|
5064
4962
|
"format": "int32"
|
|
5065
4963
|
}
|
|
5066
4964
|
},
|
|
5067
|
-
{
|
|
5068
|
-
"name": "Range",
|
|
5069
|
-
"in": "header",
|
|
5070
|
-
"description": "Формат: items=FROM-TILL , где FROM - начальный элемент (включая), TILL - конечный элемент (включая)",
|
|
5071
|
-
"schema": {
|
|
5072
|
-
"type": "string"
|
|
5073
|
-
}
|
|
5074
|
-
},
|
|
5075
|
-
{
|
|
5076
|
-
"name": "offset",
|
|
5077
|
-
"in": "query",
|
|
5078
|
-
"description": "количество элементов, которое нобходимо пропустить",
|
|
5079
|
-
"schema": {
|
|
5080
|
-
"type": "string"
|
|
5081
|
-
}
|
|
5082
|
-
},
|
|
5083
|
-
{
|
|
5084
|
-
"name": "fetch",
|
|
5085
|
-
"in": "query",
|
|
5086
|
-
"description": "количество элементов, которое необходимо вернуть",
|
|
5087
|
-
"schema": {
|
|
5088
|
-
"type": "string"
|
|
5089
|
-
}
|
|
5090
|
-
},
|
|
5091
|
-
{
|
|
5092
|
-
"name": "timezoneId",
|
|
5093
|
-
"in": "query",
|
|
5094
|
-
"description": "Идентификатор часового пояса",
|
|
5095
|
-
"schema": {
|
|
5096
|
-
"type": "integer",
|
|
5097
|
-
"format": "int32"
|
|
5098
|
-
}
|
|
5099
|
-
},
|
|
5100
4965
|
{
|
|
5101
4966
|
"name": "X-Application-ID",
|
|
5102
4967
|
"in": "header",
|
|
@@ -5153,17 +5018,6 @@
|
|
|
5153
5018
|
},
|
|
5154
5019
|
"204": {
|
|
5155
5020
|
"description": "Часовой пояс не найден."
|
|
5156
|
-
},
|
|
5157
|
-
"206": {
|
|
5158
|
-
"description": "PartialContent",
|
|
5159
|
-
"headers": {
|
|
5160
|
-
"Content-Range": {
|
|
5161
|
-
"description": "items=FROM-TILL/OF , где FROM - начальный элемент (включая), TILL - конечный элемент (включая) OF - общее количество элементов",
|
|
5162
|
-
"schema": {
|
|
5163
|
-
"type": "string"
|
|
5164
|
-
}
|
|
5165
|
-
}
|
|
5166
|
-
}
|
|
5167
5021
|
}
|
|
5168
5022
|
},
|
|
5169
5023
|
"security": [
|