Перейти к основному содержимому

API для поиска по файлам

/api/Search/SearchFile​

Поиск по файлам

Тип HTTP запроса: post

Отсылаемый запрос​

MIME-тип HTTP запроса: application/json

Выражение для поиска

Название поляТип поляОписаниеОбязательноеВозможные значения
querystringПоисковый запроснет
searchAfterIdstringId последнего элемента последней выдачи. Используется для пейджинации.нет
sizeinteger (int32)Максимальное число элементов в выдаченет

Возвращаемые результаты​

Код HTTP ответа: 200​

MIME-тип HTTP ответа: text/plain

Success

Название поляТип поляОписаниеОбязательноеВозможные значения
resultFileModel[]Данные результата метода API.нет
typeInfoTypeInfo
errorIErrorDescription
isErrorbooleanПолучает признак наличия ошибкинет

Код 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

Выражение для поиска

Название поляТип поляОписаниеОбязательноеВозможные значения
querystringПоисковый запроснет
projectsstring[]Список проектов, в которых надо искатьнет
classesstring[]Список классов,в которых надо искать.
Имя класса может быть как с проектом, так и без него:
-- "system.file" - поиск в классе "file" проекта "system";
-- "my_class" - поиск в классах "my_class" во всех проектах
нет
searchAfterIdstringId последнего элемента последней выдачи. Используется для пейджинации.нет
sizeinteger (int32)Максимальное число элементов в выдаченет

Возвращаемые результаты​

Код HTTP ответа: 200​

MIME-тип HTTP ответа: text/plain

Success

Название поляТип поляОписаниеОбязательноеВозможные значения
warningMessagestringнет
resultSearchModelBase[]Данные результата метода API.нет
typeInfoTypeInfo
errorIErrorDescription
isErrorbooleanПолучает признак наличия ошибкинет

Код 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