API для поиска по файлам
/api/Search/SearchFile
Поиск по файлам
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Выражение для поиска
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| query | string | Поисковый запрос | нет | |
| searchAfterId | string | Id последнего элемента последней выдачи. Используется для пейджинации. | нет | |
| size | integer (int32) | Максимальное число элементов в выдаче | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: text/plain
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | FileModel[] | Данные результата метода API. | нет | |
| typeInfo | TypeInfo | |||
| error | IErrorDescription | |||
| isError | boolean | Получает признак наличия ошибки | нет |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/fulltextsearchservice public SearchController SearchFile(ASE.MD.Platform.Services.FullTextSearchService.Models.SearchParams)
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | fulltextsearchservice:fulltextsearchservice:execute |
/components/securitySchemes/fulltextsearchservice
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | fulltextsearchservice:fulltextsearchservice:execute |
/api/Search/Search
Обобщенный поиск по модели данных и файлам
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Выражение для поиска
| На звание поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| query | string | Поисковый запрос | нет | |
| projects | string[] | Список проектов, в которых надо искать | нет | |
| classes | string[] | Список классов,в которых надо искать. Имя класса может быть как с проектом, так и без него: -- "system.file" - поиск в классе "file" проекта "system"; -- "my_class" - поиск в классах "my_class" во всех проектах | нет | |
| searchAfterId | string | Id последнего элемента последней выдачи. Используется для пейджинации. | нет | |
| size | integer (int32) | Максимальное число элементов в выдаче | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: text/plain
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| warningMessage | string | нет | ||
| result | SearchModelBase[] | Данные результата метода API. | нет | |
| typeInfo | TypeInfo | |||
| error | IErrorDescription | |||
| isError | boolean | Получает признак наличия ошибки | нет |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/fulltextsearchservice public SearchController Search(ASE.MD.Platform.Services.FullTextSearchService.Models.SearchParamsProject)
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | fulltextsearchservice:fulltextsearchservice:execute |
/components/securitySchemes/fulltextsearchservice
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | fulltextsearchservice:fulltextsearchservice:execute |
/api/Search/SearchDirect
Низкоуровневый поиск. Тело запроса напрямую передается в поисковую систему.
Тип HTTP запроса: post
Отсылаемый запрос
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: text/plain
Success
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/fulltextsearchservice public SearchController SearchDirect()
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | fulltextsearchservice:fulltextsearchservice:execute |
/components/securitySchemes/fulltextsearchservice
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений до ступа | fulltextsearchservice:fulltextsearchservice:execute |