UHuhh-lt
search

Returns all SourceDocument Ids and their scores and (optional) hightlights that match the query parameters.

post/search/sdoc

Request

  • The document declares no server URL.
  • Auth
    OAuth 2
    Password
    Token URL: /authentication/login

Query parameters

project_idinteger required
search_querystring required
expert_modeboolean required
highlightboolean required
folder_idinteger nullable
page_numberinteger nullable
page_sizeinteger nullable
show_foldersboolean
show_child_foldersboolean

Request body

Response

Successful Response

sdocsobject required

A dictionary of sdoc_id and SourceDocumentRead.

sdoc_foldersobject required

A dictionary of folder_id and FolderRead.

annotatorsobject required

A dictionary of sdoc_id and a list of annotator user IDs that annotated the document.

tagsobject required

A dictionary of sdoc_id and a list of tag IDs that are associated with the document.

total_resultsinteger required

The total number of hits. Used for pagination.

Changes