Документерра: руководство пользователя

[API] Поиск по порталу

Выдает результаты полнотекстового поискового запроса. Проекты/публикации, закрытые для пользователя, отправившего запрос, будут пропущены. Для неавторизованных пользователей выдаются результаты только из открытых публикаций.

GET search? count={search-results-count}&projectIds={id1, id2}&lang={lang-code}&isReturnSnippets={return-snippets}&q={search-query}

Авторизация

Этот запрос может быть отправлен анонимно или с базовой авторизацией .

Параметры запроса

Параметры поискового запроса

count	int	[опционально] Максимальное количество выдаваемых результатов. Если не указано, то выдается 10 лучших результатов. Если указано отрицательное число, то выдаются все результаты поиска независимо от их общего количества.
projectUrls	string	[исключается] То же, что и projectIds.
projectIds	string	[опционально] Разделенный запятыми список идентификаторов проектов/публикаций для поиска. Идентификаторы проектов/публикаций, к которым у вас нет доступа, будут игнорироваться.
lang	string	[опционально] Четырехбуквенный код языка. Если указано, то поиск ведется только по проектам/публикациям на этом языке.
isReturnSnippets	int	[опционально] Если условие верное, то в теле ответа выдаются ftsTitleHtml и ftsSnippetHtml.
q	string	Полнотекстовый поисковый запрос. Может содержать любые поддерживаемые операторы поиска.

Образцы

Образец запроса

Copy Code

Bash (Unix Shell)

curl --location -g --request GET 'https://{portal-url}/api/v1/search?count=2&projectIds=project-deep-space-exploration, space-program-pub&lang=en-us&isReturnSnippets=1&q=nebula'

Образец тела ответа

Copy Code

JSON

[
    {
        "assigneeUserName": 'admin',
        "createdOn": "2021-05-10T12:32:25",
        "ftsSnippetHtml": "...A&#160;<strong>nebula</strong>&#160;( Latin&#160;for &#39;cloud&#39; or &#39;fog&#39;; <strong>nebulae</strong>,&#160;nebul&#230;&#160;or&#160;<strong>nebulas</strong> [3] [4] [5] [6]) is an interstellar cloud&#160;of dust, hydrogen, helium&#160;and other ionized gases. Originally, the term was used to describe any diffused astronomical...",
        "ftsTitleHtml": "New topic created with API",
        "fullUrl": "https://docs.hedron.org/articles/project-deep-space-exploration/nebula",
        "html": null,
        "id": "nebula",
        "indexKeywords": [
            "cluster",
            "N",
            "nebula",
            "N, nebula"
        ],
        "modifiedOn": "2022-11-07T12:59:40",
        "ownerUserName": 'admin',
        "projectId": "project-deep-space-exploration",
        "projectTitle": "Project Deep Space Exploration",
        "projectUrl": "project-deep-space-exploration",
        "smartLink": "https://docs.hedron.org/smart/project-deep-space-exploration/nebula",
        "statusName": null,
        "title": "New topic created with API",
        "tocNodeId": "cd1ad87f-55a4-46e5-b496-c3434d555cd1",
        "url": "nebula"
    },
    {
        "assigneeUserName": 'admin',
        "createdOn": "2022-10-25T13:32:19",
        "ftsSnippetHtml": "...A&#160;<strong>nebula</strong>&#160;( Latin&#160;for &#39;cloud&#39; or &#39;fog&#39;; <strong>nebulae</strong>,&#160;nebul&#230;&#160;or&#160;<strong>nebulas</strong> [3] [4] [5] [6]) is an interstellar cloud&#160;of dust, hydrogen, helium&#160;and other ionized gases. Originally, the term was used to describe any diffused astronomical...",
        "ftsTitleHtml": "<strong>Nebula</strong>",
        "fullUrl": "https://docs.hedron.org/articles/space-program-pub/nebula",
        "html": null,
        "id": "nebula",
        "indexKeywords": [],
        "modifiedOn": "2022-10-25T13:32:27",
        "ownerUserName": 'admin',
        "projectId": "space-program-pub",
        "projectTitle": "Space Program Pub",
        "projectUrl": "space-program-pub",
        "smartLink": "https://docs.hedron.org/smart/project-deep-space-exploration/nebula",
        "statusName": null,
        "title": "Nebula",
        "tocNodeId": "cd1ad87f-55a4-46e5-b496-c3434d555cd1",
        "url": "nebula"
    }
]

Поля ответа

assigneeUserName	Логин исполнителя, которому назначена страница.
body	Содержание тега <body> страницы. Возвращает значение null для всех способов, кроме Get Topic.
createdOn	Временная метка ISO 8601 даты создания страницы. Часовой пояс GMT.
ftsSnippetHtml	Выделена HTML-разметка заголовка страницы с совпадениями с полнотекстовым поисковым запросом. Заполняется только в том случае, если isReturnSnippets больше нуля.
ftsTitleHtml	HTML-разметка сниппета контента страницы с выделенными соответствиями полнотекстовому поисковому запросу. Заполняется только в том случае, если isReturnSnippets больше нуля.
fullUrl	Полный URL-адрес страницы.
html	HTML-контент страницы. Возвращает значение null для всех способов, кроме Get Topic.
id	Идентификатор страницы.
indexKeywords	Массив строк, содержащих ключевые слова, связанные со страницей. Иерархические ключевые слова представляются в виде значений, разделенных запятыми.
modifiedOn	Временная метка ISO 8601 даты изменения страницы. Часовой пояс GMT.
ownerUserName	Логин владельца страницы.
projectId	Уникальный идентификатор проекта или публикации.
projectTitle	Название проекта или публикации, к которой относится данная страница.
projectUrl	[устарело] То же, что и projectIds.
smartLink	Смарт-ссылка, сгенерированная для страницы.
statusName	Состояние рабочего процесса страницы.
title	Название страницы.
tocNodeId	Идентификатор элемента Дерева страниц, связанный со страницей.
url	[устарело] То же, что и id.

API: Поиск API: Хранилище