search

Returns BBox Annotations.

post/search/bbox_annotation

Request body

project_idinteger required

Project the search runs in

search_querystring

Full-text query

group_keystring nullable

Key of the single group to drill into (requires group_by). Both must be set or both omitted.

page_numberinteger

Zero-based page index

page_sizeinteger

Number of rows per page

Response

Successful Response

total_resultsinteger required

Total number of matching rows (unpaginated), used for pagination

Changes

Changed in 11 of the 73 revisions of this API.23641

  • 28b2f0e8bc014313See the full diff
    • added the new required request property project_id

      new-required-request-property

    • removed the enum value BB_CODE_ID of the request property filter/items/items/anyOf[subschema #1: FilterExpression[BBoxColumns]]/column/anyOf[subschema #1: BBoxColumns]/

      request-property-enum-value-removed

    • removed the enum value BB_CODE_ID of the request property sorts/items/column/anyOf[subschema #1: BBoxColumns]/

      request-property-enum-value-removed

    • removed the required property data from the response with the 200 status

      response-required-property-removed

    • deleted the query request parameter page

      request-parameter-removed

    • deleted the query request parameter page_size

      request-parameter-removed

    • deleted the query request parameter project_id

      request-parameter-removed

    • added the new optional request property group_by

      new-optional-request-property

    • added the new optional request property group_key

      new-optional-request-property

    • added the new optional request property page_number

      new-optional-request-property

    • added the new optional request property page_size

      new-optional-request-property

    • added the new optional request property search_query

      new-optional-request-property

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

      request-property-any-of-added

    • the request property sorts became optional

      request-property-became-optional

    • the sorts request property default value was added

      request-property-default-value-added

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

      request-property-enum-value-added

    • added the new BB_CODE_ID_LIST_RECURSIVE enum value to the request property sorts/items/column/anyOf[subschema #1: BBoxColumns]/

      request-property-enum-value-added

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

      request-property-enum-value-added

    • added the new BB_USER_ID enum value to the request property sorts/items/column/anyOf[subschema #1: BBoxColumns]/

      request-property-enum-value-added

    • added the required property items to the response with the 200 status

      response-required-property-added

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

    • removed the required property data/items/memo from the response with the 200 status

      response-required-property-removed

    • added the optional property data/items/sdoc/memo_ids to the response with the 200 status

      response-optional-property-added

    • added the required property data/items/memo_ids to the response with the 200 status

      response-required-property-added

  • fab14ec2229b111See the full diff
    • removed the required property data/items/memo_ids from the response with the 200 status

      response-required-property-removed

    • removed the optional property data/items/sdoc/memo_ids from the response with the 200 status

      response-optional-property-removed

    • added the required property data/items/memo to the response with the 200 status

      response-required-property-added

    • removed the required property data/items/memo from the response with the 200 status

      response-required-property-removed

    • added the optional property data/items/sdoc/memo_ids to the response with the 200 status

      response-optional-property-added

    • added the required property data/items/memo_ids to the response with the 200 status

      response-required-property-added

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

      request-property-enum-value-added

    • added the new BB_FOLDER_ID_LIST_RECURSIVE enum value to the request property sorts/items/column/anyOf[subschema #1: BBoxColumns]/

      request-property-enum-value-added

  • 01c6f5cdc4f323See the full diff
    • removed the enum value BB_TAG_ID_LIST of the request property filter/items/items/anyOf[subschema #1: FilterExpression[BBoxColumns]]/column/anyOf[subschema #1: BBoxColumns]/

      request-property-enum-value-removed

    • removed the enum value BB_TAG_ID_LIST of the request property sorts/items/column/anyOf[subschema #1: BBoxColumns]/

      request-property-enum-value-removed

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

      request-property-any-of-added

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

      request-property-enum-value-added

    • added the new BB_TAG_ID_LIST_RECURSIVE enum value to the request property sorts/items/column/anyOf[subschema #1: BBoxColumns]/

      request-property-enum-value-added

  • bd1187f3520e52See the full diff
    • removed IDListRecursiveOperator from the filter/items/items/anyOf[subschema #1: FilterExpression[BBoxColumns]]/operator request property anyOf list

      request-property-any-of-removed

    • removed the enum value BB_FOLDER_ID_LIST_RECURSIVE of the request property filter/items/items/anyOf[subschema #1: FilterExpression[BBoxColumns]]/column/anyOf[subschema #1: BBoxColumns]/

      request-property-enum-value-removed

    • removed the enum value BB_FOLDER_ID_LIST_RECURSIVE of the request property sorts/items/column/anyOf[subschema #1: BBoxColumns]/

      request-property-enum-value-removed

    • removed the enum value BB_TAG_ID_LIST_RECURSIVE of the request property filter/items/items/anyOf[subschema #1: FilterExpression[BBoxColumns]]/column/anyOf[subschema #1: BBoxColumns]/

      request-property-enum-value-removed

    • removed the enum value BB_TAG_ID_LIST_RECURSIVE of the request property sorts/items/column/anyOf[subschema #1: BBoxColumns]/

      request-property-enum-value-removed

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

      request-property-enum-value-added

    • added the new BB_TAG_ID_LIST enum value to the request property sorts/items/column/anyOf[subschema #1: BBoxColumns]/

      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

  • 1af5a8046f2027See the full diff
    • removed the enum value BB_TAG_ID_LIST of the request property filter/items/items/anyOf[subschema #1: FilterExpression[BBoxColumns]]/column/anyOf[subschema #1: BBoxColumns]/

      request-property-enum-value-removed

    • removed the enum value BB_TAG_ID_LIST of the request property sorts/items/column/anyOf[subschema #1: BBoxColumns]/

      request-property-enum-value-removed

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

      request-property-any-of-added

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

      request-property-enum-value-added

    • added the new BB_FOLDER_ID_LIST_RECURSIVE enum value to the request property sorts/items/column/anyOf[subschema #1: BBoxColumns]/

      request-property-enum-value-added

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

      request-property-enum-value-added

    • added the new BB_TAG_ID_LIST_RECURSIVE enum value to the request property sorts/items/column/anyOf[subschema #1: BBoxColumns]/

      request-property-enum-value-added

    • added the optional property detail/items/ctx to the response with the 422 status

      response-optional-property-added

    • added the optional property detail/items/input to the response with the 422 status

      response-optional-property-added

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

  • fbbe054a012a11See the full diff
    • the response property data/items/code/description became optional for the status 200

      response-property-became-optional

    • the description response's property default value was added for the status 200

      response-property-default-value-added

  • c5b78916c4e524See the full diff
    • removed the enum value BB_SOURCE_SOURCE_DOCUMENT_FILENAME of the request property filter/items/items/anyOf[subschema #1: FilterExpression[BBoxColumns]]/column/anyOf[subschema #1: BBoxColumns]/

      request-property-enum-value-removed

    • removed the enum value BB_SOURCE_SOURCE_DOCUMENT_FILENAME of the request property sorts/items/column/anyOf[subschema #1: BBoxColumns]/

      request-property-enum-value-removed

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

      request-property-enum-value-added

    • added the new BB_SOURCE_SOURCE_DOCUMENT_NAME enum value to the request property sorts/items/column/anyOf[subschema #1: BBoxColumns]/

      request-property-enum-value-added

    • the response property data/items/sdoc/name became required for the status 200

      response-property-became-required

    • response property data/items/sdoc/name list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed