Sign in
search

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

post/search/sdoc

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.

memosobject required

A dictionary of sdoc_id and a list of memo IDs that are attached to the document.

total_resultsinteger required

The total number of hits. Used for pagination.

Changes

Changed in 13 of the 73 revisions of this API.22636

  • 28b2f0e8bc011See the full diff
    • ○

      added AttachedObjectTypeOperator AttachedObjectOperator SpanAnnotationOperator to the filter/items/items/anyOf[subschema #1: FilterExpression[SdocColumns]]/operator request property anyOf list

      request-property-any-of-added

    This revision also has 10 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 7d9df729f4fc2See the full diff
    • ○

      added the optional property sdocs/additionalProperties/memo_ids to the response with the 200 status

      response-optional-property-added

    • ○

      added the required property memos to the response with the 200 status

      response-required-property-added

  • fab14ec2229b11See the full diff
    • ▲

      removed the required property memos from the response with the 200 status

      response-required-property-removed

    • ●

      removed the optional property sdocs/additionalProperties/memo_ids from the response with the 200 status

      response-optional-property-removed

  • 99542cbdb5a92See the full diff
    • ○

      added the optional property sdocs/additionalProperties/memo_ids to the response with the 200 status

      response-optional-property-added

    • ○

      added the required property memos to the response with the 200 status

      response-required-property-added

  • ebfa22e4da0a2See the full diff
    • ○

      added the new SD_FOLDER_ID_LIST_RECURSIVE enum value to the request property filter/items/items/anyOf[subschema #1: FilterExpression[SdocColumns]]/column/anyOf[subschema #1: SdocColumns]/

      request-property-enum-value-added

    • ○

      added the new SD_FOLDER_ID_LIST_RECURSIVE enum value to the request property sorts/items/column/anyOf[subschema #1: SdocColumns]/

      request-property-enum-value-added

  • 01c6f5cdc4f345See the full diff
    • ▲

      removed the enum value SD_CODE_ID_LIST of the request property filter/items/items/anyOf[subschema #1: FilterExpression[SdocColumns]]/column/anyOf[subschema #1: SdocColumns]/

      request-property-enum-value-removed

    • ▲

      removed the enum value SD_CODE_ID_LIST of the request property sorts/items/column/anyOf[subschema #1: SdocColumns]/

      request-property-enum-value-removed

    • ▲

      removed the enum value SD_TAG_ID_LIST of the request property filter/items/items/anyOf[subschema #1: FilterExpression[SdocColumns]]/column/anyOf[subschema #1: SdocColumns]/

      request-property-enum-value-removed

    • ▲

      removed the enum value SD_TAG_ID_LIST of the request property sorts/items/column/anyOf[subschema #1: SdocColumns]/

      request-property-enum-value-removed

    • ○

      added IDListRecursiveOperator to the filter/items/items/anyOf[subschema #1: FilterExpression[SdocColumns]]/operator request property anyOf list

      request-property-any-of-added

    • ○

      added the new SD_CODE_ID_LIST_RECURSIVE enum value to the request property filter/items/items/anyOf[subschema #1: FilterExpression[SdocColumns]]/column/anyOf[subschema #1: SdocColumns]/

      request-property-enum-value-added

    • ○

      added the new SD_CODE_ID_LIST_RECURSIVE enum value to the request property sorts/items/column/anyOf[subschema #1: SdocColumns]/

      request-property-enum-value-added

    • ○

      added the new SD_TAG_ID_LIST_RECURSIVE enum value to the request property filter/items/items/anyOf[subschema #1: FilterExpression[SdocColumns]]/column/anyOf[subschema #1: SdocColumns]/

      request-property-enum-value-added

    • ○

      added the new SD_TAG_ID_LIST_RECURSIVE enum value to the request property sorts/items/column/anyOf[subschema #1: SdocColumns]/

      request-property-enum-value-added

  • 365d71aa38a02See the full diff
    • ○

      added the new optional query request parameter show_child_folders

      new-optional-request-parameter

    • ○

      added the new optional query request parameter show_folders

      new-optional-request-parameter

  • bd1187f3520e1See the full diff
    • ●

      deleted the query request parameter show_folders

      request-parameter-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 2a7bef9e5b1f1See the full diff
    • ○

      added the new optional query request parameter show_folders

      new-optional-request-parameter

  • bd1187f3520e724See the full diff
    • ▲

      removed IDListRecursiveOperator from the filter/items/items/anyOf[subschema #1: FilterExpression[SdocColumns]]/operator request property anyOf list

      request-property-any-of-removed

    • ▲

      removed the enum value SD_CODE_ID_LIST_RECURSIVE of the request property filter/items/items/anyOf[subschema #1: FilterExpression[SdocColumns]]/column/anyOf[subschema #1: SdocColumns]/

      request-property-enum-value-removed

    • ▲

      removed the enum value SD_CODE_ID_LIST_RECURSIVE of the request property sorts/items/column/anyOf[subschema #1: SdocColumns]/

      request-property-enum-value-removed

    • ▲

      removed the enum value SD_FOLDER_ID_LIST_RECURSIVE of the request property filter/items/items/anyOf[subschema #1: FilterExpression[SdocColumns]]/column/anyOf[subschema #1: SdocColumns]/

      request-property-enum-value-removed

    • ▲

      removed the enum value SD_FOLDER_ID_LIST_RECURSIVE of the request property sorts/items/column/anyOf[subschema #1: SdocColumns]/

      request-property-enum-value-removed

    • ▲

      removed the enum value SD_TAG_ID_LIST_RECURSIVE of the request property filter/items/items/anyOf[subschema #1: FilterExpression[SdocColumns]]/column/anyOf[subschema #1: SdocColumns]/

      request-property-enum-value-removed

    • ▲

      removed the enum value SD_TAG_ID_LIST_RECURSIVE of the request property sorts/items/column/anyOf[subschema #1: SdocColumns]/

      request-property-enum-value-removed

    • ●

      deleted the query request parameter show_child_folders

      request-parameter-removed

    • ●

      deleted the query request parameter show_folders

      request-parameter-removed

    • ○

      added the new SD_CODE_ID_LIST enum value to the request property filter/items/items/anyOf[subschema #1: FilterExpression[SdocColumns]]/column/anyOf[subschema #1: SdocColumns]/

      request-property-enum-value-added

    • ○

      added the new SD_CODE_ID_LIST enum value to the request property sorts/items/column/anyOf[subschema #1: SdocColumns]/

      request-property-enum-value-added

    • ○

      added the new SD_TAG_ID_LIST enum value to the request property filter/items/items/anyOf[subschema #1: FilterExpression[SdocColumns]]/column/anyOf[subschema #1: SdocColumns]/

      request-property-enum-value-added

    • ○

      added the new SD_TAG_ID_LIST enum value to the request property sorts/items/column/anyOf[subschema #1: SdocColumns]/

      request-property-enum-value-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog