Skip to main content
Version: Next

STN REST API

Краткое описание методов​

НомерМетодОписание
1GET /assistants/versionВозвращает версию сервиса Ассистент.
2GET /assistants/statusПроверяет статус доступности сервиса Ассистент.
3POST /assistants/answerСохраняет контекст ответа на поисковой запрос пользователя, затем на их основе формирует ответ пользователю.
4GET /reltype/versionВозвращает версию сервиса определения типа связи.
5POST /reltype/tasksСоздаёт задачу на определение типа связи.
6GET /reltype/gettasksПолучает результат задачи на определение типа связи.
7POST /reltype/classifyОпределяет тип связи без создания задачи.
8DELETE /reltype/deletetasksУдаляет задачу на определение типа связи.
9GET /semanalysis/versionВозвращает версию севиса семантического анализа.
10POST /semanalysis/documentsearchВыявляет содержательные пересечения текстовых фрагментов документов для определения пересекающихся между собой документов.
11GET /archive/versionВозвращает версию сервиса хранения.
12POST /archive/QueryGetListПолучает информацию о запросах в определённом индексе.
13POST /archive/favoritesQueryGetListПолучает информацию по избранным запросам в определённом индексе.
14POST /archive/favoritesQueryAddДобавляет избранный запрос.
15POST /archive/favoritesQueryDeleteУдаляет избранный запрос.
16POST /archive/archiveGetListПолучает информацию о просмотренных документах пользователя.
17POST /archive/favoritesArchiveGetListПолучает список избранных документов.
18POST /archive/favoritesArchiveAddДобавляет документ в избранное.
19POST /archive/favoritesArchiveDeleteУдаляет документ из избранного.
20GET /ais/versionВозвращает версию Content AI Intelligent Search.
21GET /ais/statusПолучает информацию об основных настройках Intelligent Search.
22GET /ais/indexesПолучает информацию о списке индексов Content AI Intelligent Search.
23GET /ais/indexes/indexNameПолучает информацию о конкретном индексе Content AI Intelligent Search.
24GET /ais/searchЗадействует поиск Intelligent Service.
25GET /ais/SuggestionsВозвращает подсказки в ответ на запрос.
26GET /ais/getFileВозвращает бинарный файл.
27GET /info/versionВозвращает версию ProxyBack.

Краткое описание методов Configuration service​

НомерМетодОписание
28GET /versionВозвращает версию сервиса конфигурации.
29GET /parameters/frontПолучение публичного списка параметров.
30GET /parametrsВозвращает список всех параметров.
31GET /parameters/publicВозвращает ограниченный список параметров, используемый при первоначальной загрузке.
32PUT /parametersПозволяет редактировать список параметров.
33GET /parameterПозволяет редактировать отдельный параметр.
34GET /parameter/idВозвращает значение конкретного параметра по идентификатору.
35GET /typesПолучить список типов приложений.

1. Получение информации о версии сервиса Ассистент​

Данный метод возвращает версию сервиса Ассистент

URL​

http://server:8095/

Метод​

GET /assistants/version

Параметры​

Параметры запроса отсутствуют.

Тело запроса​

Тело запроса отсутствует.

Ответы​

200

2. Получение информации о сервисе Ассистент​

Данный метод проверяет статус доступности сервиса Ассистент.

URL​

http://server:8095/

Метод​

GET /assistants/status

Параметры​

Параметры запроса отсутствуют.

Тело запроса​

Тело запроса отсутствует.

Ответы​

200

3. Вызов сервиса Ассистент​

Данный метод сохраняет контекст ответа на поисковой запрос пользователя, затем на их основе формирует ответ пользователю.

URL​

http://server:8095/

Метод​

POST /assistants/answer

Параметры​

ИмяТипОписаниеЗначение по умолчанию
guidstringGuid входного запроса поиска для получения результатов из кеша. Может быть пустым. Используется для снижения нагрузки на поиск.-
indexNamestringНаименование индекса, в котором необходимо осуществить поиск.Из параметров сервера.
getContextbooleanВозвращать ли контекст, отправляемый в сервис Ассистента?false

Тело запроса​

{
"query": "string",
  "userQuery": "string",
  "isSuggest": true,
  "resultFields": [
    "string"
  ],
  "count": 0,
  "from": 0,
  "hlFields": [
    "string"
  ],
  "id": "string",
  "position": 0,
  "__acl": [
    "string"
  ],
  "defaultSearchFields": [
    "string"
  ],
  "facets": [
    "string"
  ],
  "searchFieldsBoost": {
    "additionalProp1": 0,
    "additionalProp2": 0,
    "additionalProp3": 0
  },
  "sort": [
    "string"
  ],
  "flags": [
    "string"
  ],
  "problemCode": "string",
  "problemDescription": "string",
  "siteUrl": "string",
  "subscribe": true,
  "reportDocumentId": "string",
  "queryAnalysisTime": 0,
  "description": "string",
  "availableHits": 0,
  "totalHits": 0,
  "totalSearchTime": 0,
  "flagAddedResultsByQuery": true
}

Описание параметров тела запроса находится в руководстве по интеграции Content AI Intelligent Search.

Ответы​

200

4. Получение информации о версии сервиса определения типа связи​

Данный метод возвращает версию сервиса определения типа связи

URL​

http://server:8095/

Метод​

GET /reltype/version

Параметры​

Параметры запроса отсутствуют.

Тело запроса​

Тело запроса отсутствует.

Ответы​

200

5. Создать задачу на определение типа связи​

Данный метод создаёт задачу на определение типа связи.

URL​

http://server:8095/

Метод​

POST /reltype/tasks

Параметры​

Параметры запроса отсутствуют.

Тело запроса​

{
  "query_text": "string",
  "found_text": "string",
  "threshold": 0,
  "uid": "string"
}
П р и м е ч а н и я​
  1. Между query_text и found_text метод устанавливает логическую связь, возвращая одно из значений в параметр result: дублирование (entailment), противоречие (contradiction) или нейтральная (neutral).
  2. Параметр threshold - критерий выделения кандидатов на выделение связи. Чем выше значение, тем меньше вероятность получения связи, отличной от нейтральной.
  3. Параметр uid – идентификатор пользователя, предназначен для удаления задач разлогинившегося пользователя.

Ответы​

200

П р и м е ч а н и я​
  1. Параметр status показывает статус задачи по определению типа связи.
  2. Параметр result содержит результат определения типа связи. Если он равен null, то нужно воспользоваться методом получения задачи по определение типа связи.
  3. Параметр detail возвращает информацию об ошибке в обработке задачи, если задача выполнена успешно, то возвращает null.

6. Получить задачу по определение типа связи​

Данный метод получает результат задачи на определение типа связи.

URL​

http://server:8095/

Метод​

GET /reltype/gettasks

Параметры​

ИмяТипОписаниеЗначение по умолчанию
taskIdstringID задачи, которое возвращается при создании задачи.-

Тело запроса​

Тело запроса отсутствует.

Ответы​

200

П р и м е ч а н и я​
  1. Параметр status показывает статус задачи по определению типа связи.
  2. Параметр result содержит результат определения типа связи. Если он равен null, то нужно воспользоваться методом получения задачи по определение типа связи.
  3. Параметр detail возвращает информацию об ошибке в обработке задачи, если задача выполнена успешно, то возвращается null.

7. Определить тип связи​

Данный метод определяет тип связи без создания задачи.

URL​

http://server:8095/

Метод​

POST /reltype/classify

Параметры​

Параметры запроса отсутствуют.

Тело запроса​

{
  "query_text": "string",
  "found_text": "string",
  "threshold": 0,
  "uid": "string"
}
П р и м е ч а н и я​
  1. Между query_text и found_text метод устанавливает логическую связь, возвращая одно из значений: дублирование (entailment), противоречие (contradiction) или нейтральная (neutral).
  2. Параметр threshold - критерий выделения кандидатов на выделение связи. Чем выше значение, тем меньше вероятность получения связи, отличной от нейтральной.
  3. Параметр uid – идентификатор пользователя, предназначен для удаления задач разлогинившегося пользователя.

Ответы​

200

8. Удалить задачу по определение типа связи​

Данный метод удаляет задачу на определение типа связи.

URL​

http://server:8095/

Метод​

DELETE /reltype/deletetasks

Параметры​

ИмяТипОписаниеЗначение по умолчанию
uidstringID задачи, которое возвращается при создании задачи.-

Тело запроса​

Тело запроса отсутствует.

Ответы​

200

П р и м е ч а н и е​

Параметр detail содержит информацию о статусе удаления задачи на определение типа связи.

9. Получение информации о версии сервиса семантического анализа​

Данный метод возвращает текущую версию сервиса семантического анализа.

URL​

http://server:8095/

Метод​

GET /semanalysis/version

Параметры​

Параметры запроса отсутствуют.

Тело запроса​

Тело запроса отсутствует.

Ответы​

200

10. Найти похожие документы​

Данный метод выявляет содержательные пересечения текстовых фрагментов документов для определения пересекающихся между собой документов.

URL​

http://server:8095/

Метод​

POST /semanalysis/documentsearch

Параметры​

ИмяТипОписаниеЗначение по умолчанию
indexNamestringНаименование индекса, в котором надо осуществить поиск.Указано в переменной DEFAULT_INDEX.

Тело запроса​

{
"input": "string",
  "filters": "string",
  "resultFields": [
    "string"
  ],
  "facets": [
    {
      "facetName": "string",
      "includeFilter": "string",
      "sortBy": "string",
      "sortOrder": "string"
    }
  ],
  "percentageOfSimilarity": 0,
  "percentageDocsContains": 0,
  "topDocsToTake": 0
}
П р и м е ч а н и е​

Описание параметров тела запроса находится в руководстве по интеграции Content AI Intelligent Search.

Ответы​

200

П р и м е ч а н и я​
  1. Параметр id возвращает идентификатор документа.
  2. Параметр relevance получается сложением параметра score у найденных документов. Чем выше значение, тем выше релевантность.
  3. Параметр body возвращает текст документа, в котором найденные вхождения выделены тегом em.
  4. Параметры start и end у параметра ranges возвращают позиции найденных подстрок.
  5. Параметр count возвращает число найденных документов.
  6. Описание параметров, входящих в resultFields, находится в руководстве по интеграции Content AI Intelligent Search.
  7. Параметры value и count у параметра sourceNameFacet возвращают имя источника, из которого получены документы, и количество документов в этом источнике.
  8. Параметры value и count у параметра creatorFacet возвращают имя создателя документов, и количество документов, созданных им.
  9. Параметры value и count у параметра extensionFacet возвращают расширение документов, и количество документов с таким расширением.
  10. Параметры value и count у параметра modifiedFacet возвращают дату документов, и количество документов с такой датой.
  11. Параметры value и count у параметра languageFacet возвращают язык документов, и количество документов с таким языком.

11. Получение информации о версии сервиса хранения​

Данный метод возвращает версию сервиса хранения

URL​

http://server:8095/

Метод​

GET /archive/version

Параметры​

Параметры запроса отсутствуют.

Тело запроса​

Тело запроса отсутствует.

Ответы​

200

12. Информация о выбранных запросах​

Данный метод получает информацию о запросах в определённом индексе.

URL​

http://server:8095/

Метод​

POST /archive/QueryGetList

Параметры​

Параметры запроса отсутствуют.

Тело запроса​

{
  "index": "string",
  "count": 0,
  "from": 0
}
П р и м е ч а н и я​
  1. Параметр index заполняется названием индекса.
  2. Параметр count заполняется числом, равным количеству запросов, которые нужно получить.
  3. Параметр from заполняется числом, равным порядковому номеру запроса, начиная с которого нужно получить выбранные запросы.

Ответы​

200

П р и м е ч а н и я​
  1. Параметр id заполняется идентификатором запроса, удовлетворяющего параметрам отбора.
  2. Параметр date заполняется датой создания запроса.
  3. Параметр user заполняется логином пользователя, выполнившего запрос.
  4. Параметр index заполняется названием индекса.
  5. Параметр query заполняется содержимым запроса.

13. Список избранных запросов​

Данный метод получает информацию по избранным запросам в определённом индексе для пользователя, под которым авторизована текущая сессия.

URL​

http://server:8095/

Метод​

POST /archive/favoritesQueryGetList

Параметры​

Параметры запроса отсутствуют.

Тело запроса​

{
  "index": "string",
  "count": 0,
  "from": 0
}
П р и м е ч а н и я​
  1. Параметр index заполняется названием индекса.
  2. Параметр count заполняется числом, равным количеству избранных запросов, которые нужно получить.
  3. Параметр from заполняется числом, равным порядковому номеру избранного запроса, начиная с которого нужно получить выбранные запросы.

Ответы​

200

П р и м е ч а н и я​
  1. Параметр id заполняется идентификатором избранного запроса.
  2. Параметр date заполняется датой добавления запроса в избранное.
  3. Параметр user заполняется логином пользователя, выполнившего запрос.
  4. Параметр index заполняется названием индекса.
  5. Параметр query заполняется содержимым запроса.

14. Добавить избранный запрос​

Данный метод добавляет избранный запрос запрос для пользователя, под которым авторизована текущая сессия.

URL​

http://server:8095/

Метод​

POST /archive/favoritesQueryAdd

Параметры​

Параметры запроса отсутствуют.

Тело запроса​

{
  "index": "string",
  "query": "string"
}
П р и м е ч а н и я​
  1. Параметр index заполняется названием индекса.
  2. Параметр query заполняется текстом избранного запроса, который нужно добавить.

Ответы​

200

15. Удалить избранный запрос​

Данный метод удаляет избранный запрос для пользователя, под которым авторизована текущая сессия.

URL​

http://server:8095/

Метод​

POST /archive/favoritesQueryDelete

Параметры​

ИмяТипОписаниеЗначение по умолчанию
idstringИдентификатор избранного запроса, который можно получить запросом информации о всех запросах.-

Тело запроса​

Тело запроса отсутствует.

Ответы​

200

16. Информация о просмотренных документах​

Данный метод получает информацию о просмотренных документах пользователя, под которым авторизована текущая сессия.

URL​

http://server:8095/

Метод​

POST /archive/archiveGetList

Параметры​

Параметры запроса отсутствуют.

Тело запроса​

{
  "index": "string",
  "count": 0,
  "from": 0
}
П р и м е ч а н и я​
  1. Параметр index заполняется названием индекса.
  2. Параметр count заполняется числом, равным количеству просмотренных документов, которые нужно получить.
  3. Параметр from заполняется числом, равным порядковому номеру просмотренного документа, начиная с которого нужно получить выбранные просмотренные документы.

Ответы​

200

17. Список избранных документов​

Данный метод получает список избранных документов пользователя, под которым авторизована текущая сессия.

URL​

http://server:8095/

Метод​

POST /archive/favoritesArchiveGetList

Параметры​

Параметры запроса отсутствуют.

Тело запроса​

{
  "index": "string",
  "count": 0,
  "from": 0
}
П р и м е ч а н и я​
  1. Параметр index заполняется названием индекса.
  2. Параметр count заполняется числом, равным количеству избранных документов, которые нужно получить.
  3. Параметр from заполняется числом, равным порядковому номеру избранного документа, начиная с которого нужно получить выбранные избранные документы.

Ответы​

200

П р и м е ч а н и я​
  1. Параметр id возвращает идентификатор избранного документа.
  2. Параметр date возвращает дату добавления избранного документа.
  3. Параметр user возвращает имя пользователя, добавившего избранный документ.
  4. Параметр index возвращает название индекса, содержащего избранный документ.
  5. Параметр fileId возвращает идентификатор файла избранного документа.
  6. Параметр fileName возвращает название файла избранного документа.
  7. Параметр location возвращает местоположение файла избранного документа.
  8. Параметр isDeleted возвращает признак удаления файла.

18. Добавить избранный документ​

Данный метод добавляет документ в Избранное для пользователя, под которым авторизована текущая сессия.

URL​

http://server:8095/

Метод​

POST /archive/favoritesArchiveAdd

Параметры​

Параметры запроса отсутствуют.

Тело запроса​

{
  "index": "string",
  "fileId": "string",
  "fileName": "string",
  "location": "string",
  "isDeleted": true
}
П р и м е ч а н и я​
  1. Параметр index заполняется названием индекса.
  2. Параметр fileId заполняется идентификатором файла.
  3. Параметр fileName заполняется именем файла.
  4. Параметр location заполняется путём к файлу.
  5. Параметр isDeleted заполнять true.

Ответы​

200

19. Удалить избранный документ​

Данный метод удаляет документ из Избранного для пользователя, под которым авторизована текущая сессия.

URL​

http://server:8095/

Метод​

POST /archive/favoritesArchiveDelete

Параметры​

ИмяТипОписаниеЗначение по умолчанию
idstringИдентификатор удаляемого избранного документа-

Тело запроса​

Тело запроса отсутствует.

Ответы​

200

20. Получение информации о версии Content AI Intelligent Search​

Данный метод возвращает версию Content AI Intelligent Search

URL​

http://server:8095/

Метод​

GET /ais/version

Параметры​

Параметры запроса отсутствуют.

Тело запроса​

Тело запроса отсутствует.

Ответы​

200

Данный метод получает информацию об основных настройках Intelligent Search.

URL​

http://server:8095/

Метод​

GET /ais/status

Параметры​

Параметры запроса отсутствуют.

Тело запроса​

Тело запроса отсутствует.

Ответы​

200

П р и м е ч а н и е​

Описание параметров тела ответа находится в руководстве по интеграции Content AI Intelligent Search.

22. Информация о списке индексов​

Данный метод получает список индексов Intelligent Search.

URL​

http://server:8095/

Метод​

GET /ais/indexes

Параметры​

Параметры запроса отсутствуют.

Тело запроса​

Тело запроса отсутствует.

Ответы​

200

23. Получение информации о конкретном индексе Content AI Intelligent Search.​

Данный метод получает информацию о конкретном выбранном индексе.

URL​

http://server:8095/

Метод

GET /ais/indexes/indexName

Параметры​

ИмяТипОписаниеЗначение по умолчанию
indexNamestringНаименование индекса, в котором необходимо осуществить поиск.Указано в переменной DEFAULT_INDEX.

Тело запроса​

{
  "index": "gost",
  "fields": [
    {
      "field": "body",
      "type": "String",
      "indexType": "Semantic",
      "sorted": false,
      "isArray": false,
      "updateUsingRegex": [],
      "similarSearch": {
        "enabled": true
      },
      "promotedResults": {
        "enabled": false
      },
      "synonyms": {
        "enabled": true,
        "applyWhileIndexing": false,
        "dictionaries": []
      },
      "characterNormalization": {
        "enabled": false
      },
      "queryCorrection": {
        "enabled": true,
        "useAsSource": true,
        "maxTokensCount": 300
      },
      "urlDecoding": {
        "enabled": false
      },
      "addHyperlinks": [
        {
          "order": 1,
          "addLinksOn": "Synonyms"
        }
      ],
      "systemField": false
    }]
}
П р и м е ч а н и е​

Описание параметров тела запроса находится в руководстве по интеграции Content AI Intelligent Search.

Ответы​

200

Данный метод задействует поиск Intelligent Service.

URL​

http://server:8095/

Метод​

GET /ais/search

Параметры​

ИмяТипОписаниеЗначение по умолчанию
indexNamestringИмя индексаУказано в переменной DEFAULT_INDEX.

Тело запроса​

{
  "query": "string",
  "userQuery": "string",
  "isSuggest": true,
  "resultFields": [
    "string"
  ],
  "count": 0,
  "from": 0,
  "hlFields": [
    "string"
  ],
  "id": "string",
  "position": 0,
  "__acl": [
    "string"
  ],
  "defaultSearchFields": [
    "string"
  ],
  "facets": [
    "string"
  ],
  "searchFieldsBoost": {
    "additionalProp1": 0,
    "additionalProp2": 0,
    "additionalProp3": 0
  },
  "sort": [
    "string"
  ],
  "flags": [
    "string"
  ],
  "problemCode": "string",
  "problemDescription": "string",
  "siteUrl": "string",
  "subscribe": true,
  "reportDocumentId": "string",
  "queryAnalysisTime": 0,
  "description": "string",
  "availableHits": 0,
  "totalHits": 0,
  "totalSearchTime": 0,
  "flagAddedResultsByQuery": true
}
П р и м е ч а н и е​

Детальное описание параметров тела запроса смотрите в Content AI Intelligent Search - Руководство по интеграции.

Ответы​

200

П р и м е ч а н и е​

Описание параметров тела ответа находится в руководстве по интеграции Content AI Intelligent Search.

25. Отображение подсказок при вводе запроса​

Данный метод возвращает подсказки в ответ на запрос.

URL​

http://server:8095/

Метод​

GET /ais/Suggestions

Параметры​

ИмяТипОписаниеЗначение по умолчанию
indexNamestringИмя индексаУказано в переменной DEFAULT_INDEX.

Тело запроса​

{
  "query": "string",
  "maxCount": 0
}
П р и м е ч а н и я​
  1. Параметр query заполняется текстом запроса, к которому нужны подсказки.
  2. Параметр maxCount заполняется числом, ограничивающим максимальное количество подсказок.

Ответы​

200

П р и м е ч а н и е​

Описание параметров тела ответа находится в руководстве по интеграции Content AI Intelligent Search.

26. Скачивание файла​

Данный метод возвращает бинарный файл.

URL​

http://server:8095/

Метод​

GET /ais/getFile

Параметры​

ИмяТипОписаниеЗначение по умолчанию
docIdstringИдентификатор файла Intelligent Search-
fileNamestringИмя файла для скачивания с расширениемfile
indexNamestringНаименование индексаУказано в переменной DEFAULT_INDEX.

Тело запроса​

Тело запроса отсутствует.

Ответы​

200

27. Получение информации о версии ProxyBack​

Данный метод возвращает версию ProxyBack

URL​

http://server:8095/

Метод​

GET /info/version

Параметры​

Параметры запроса отсутствуют.

Тело запроса​

Тело запроса отсутствует.

Ответы​

200

28. Получение информации о версии Configuration service​

Данный метод возвращает версию Configuration service. Доступен без авторизации.

URL​

http://server:8097/

Метод​

GET /version

Параметры​

Параметры запроса отсутствуют.

Тело запроса​

Тело запроса отсутствует.

Ответы​

200

29. Получение публичного списка параметров​

Метод возвращает ограниченный список параметров, доступный без авторизации. Используется только фронтендом для внутреннего отображения.

URL​

http://server:8097/

Метод​

GET /parameters/front

Параметры​

ИмяТипОписание
sectionstringРаздел администирования, наименование связано с наименованием сервиса

Тело запроса​

Тело запроса отсутствует.

Ответы​

200

30. Получение списка параметров конфигурации​

Данный метод возвращает список всех доступных параметров. Используется всеми сервисами Системы.

URL​

http://server:8097/

Метод​

GET /parameters

Параметры​

ИмяТипОписание
sectionstringРаздел администирования, наименование связано с наименованием сервиса

Тело запроса​

Тело запроса отсутствует.

Ответы​

200

31. Получение публичного списка параметров​

Метод возвращает ограниченный список параметров, доступный без авторизации. Используется только фронтендом для внутреннего отображения.

URL​

http://server:8097/

Метод​

GET /parameters/public

Параметры​

Параметры запроса отсутствуют.

Тело запроса​

Тело запроса отсутствует.

Ответы​

200

32. Редактирование списка параметров​

Метод позволяет редактировать несколько параметров сервиса конфигурирования.

URL​

http://server:8097/

Метод​

PUT /parameters

Параметры​

Параметры запроса отсутствуют.

Тело запроса​

  [
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "key": "string",
    "value": "string",
    "value_type": "string",
    "section_index": 100,
    "section": "string",
    "type": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "value": "string"
      }
    ],
    "description": "string",
    "last_updated": "2025-10-09T12:45:19.038Z"
  }
]
П р и м е ч а н и я​
  1. id — уникальный идентификатор параметра (UUID).
  2. key — системное имя параметра.
  3. value — сохранённое значение параметра после редактирования.
  4. value_type — тип значения (string, uint, bool и т. п.), определяет формат данных в value.
  5. section_index — числовой индекс раздела, используется для упорядочивания параметров.
  6. section — наименование раздела (например, «Семантический анализ», «Генеративные ответы»).
  7. type — список связанных значений:
    • id — идентификатор связанного объекта;
    • value — текстовое значение (наименование сервиса).
  8. description — текстовое описание назначения параметра.
  9. last_updated — дата и время последнего изменения параметра (формат ISO 8601).

Ответы​

200

33. Редактирование отдельного параметра​

Метод позволяет редактировать параметр сервиса конфигурирования.

URL​

http://server:8097/

Метод​

PUT /parameter

Параметры​

Параметры запроса отсутствуют.

Тело запроса​

  {
    "id": "ae9248c0-f896-4a90-a8c8-327f2f6290d7",
    "key": "REL_TYPE_SERVICE_TIMEOUT",
    "value": "101",
    "value_type": "uint",
    "section_index": 5,
    "section": "Проксибек",
    "type": [
      {
        "id": "9622364c-178e-4cb5-91b2-7cb45364c5c8",
        "value": "stn-proxyback"
      }
    ],
    "description": "Таймаут сервиса определения типа связи",
    "last_updated": "2025-04-07T06:00:20.087813Z"
  }
П р и м е ч а н и я​
  1. id — уникальный идентификатор параметра (UUID).
  2. key — системное имя параметра.
  3. value — сохранённое значение параметра после редактирования.
  4. value_type — тип значения (string, uint, bool и т. п.), определяет формат данных в value.
  5. section_index — числовой индекс раздела, используется для упорядочивания параметров.
  6. section — наименование раздела (например, «Семантический анализ», «Генеративные ответы»).
  7. type — список связанных значений:
    • id — идентификатор связанного объекта;
    • value — текстовое значение (наименование сервиса).
  8. description — текстовое описание назначения параметра.
  9. last_updated — дата и время последнего изменения параметра (формат ISO 8601).

Ответы​

200

34. Вернуть значение конкретного параметра​

Метод позволяет вернуть значение для конкретного параметра

URL​

http://server:8097/

Метод​

PUT /parameter/id

Параметры​

ИмяТипОписание
idstringуникальный идентификатор параметра (UUID)

Тело запроса​

  {
    "id": "ae9248c0-f896-4a90-a8c8-327f2f6290d7",
    "key": "REL_TYPE_SERVICE_TIMEOUT",
    "value": "101",
    "value_type": "uint",
    "section_index": 5,
    "section": "Проксибек",
    "type": [
      {
        "id": "9622364c-178e-4cb5-91b2-7cb45364c5c8",
        "value": "stn-proxyback"
      }
    ],
    "description": "Таймаут сервиса определения типа связи",
    "last_updated": "2025-04-07T06:00:20.087813Z"
  }
П р и м е ч а н и я​
  1. id — уникальный идентификатор параметра (UUID).
  2. key — системное имя параметра.
  3. value — сохранённое значение параметра после редактирования.
  4. value_type — тип значения (string, uint, bool и т. п.), определяет формат данных в value.
  5. section_index — числовой индекс раздела, используется для упорядочивания параметров.
  6. section — наименование раздела (например, «Семантический анализ», «Генеративные ответы»).
  7. type — список связанных значений:
    • id — идентификатор связанного объекта;
    • value — текстовое значение (наименование сервиса).
  8. description — текстовое описание назначения параметра.
  9. last_updated — дата и время последнего изменения параметра (формат ISO 8601).

Ответы​

200

35. Получение списка тивов сервисов​

Метод возвращает список всех доступных типов приложений (сервисов), которые могут использовать параметры.

URL​

http://server:8097/

Метод​

GET /types

Параметры​

Параметры запроса отсутствуют.

Тело запроса​

Тело запроса отсутствует.

Ответы​

200