Skip to main content

Document full-text search

POST 
/searchFulltext

Document full-text search (and more robust multi-tag search queries, powered by OpenSearch); available as an Add-On Module

Request​

Query Parameters

    siteId string

    Site Identifier

    indexName string

    IndexName to query

    limit string

    Limit Results

    Default value: 10

Body

required

    query

    object

    required

    Document full text search criteria

    page integer

    Result page to return (starting at 1)

    text string

    Full text search

    tags

    object[]

    List of search tags

  • Array [

    • eq string

    Searches for strings that eq

    eqOr string[]

    Searches for ANY strings that eq

    key stringrequired

    Tag key to search

  • ]

    • attributes

    object[]

    List of search attributes

  • Array [

    • eq

    DocumentFulltextAttributeEq

    stringValue string

    Search for string value

    numberValue number

    Search for number value

    booleanValue boolean

    Search for boolean value

    dateValue string

    Search for date value

    eqOr

    DocumentFulltextAttributeEq[]

    Searches for ANY strings that eq

  • Array [

    • stringValue string

    Search for string value

    numberValue number

    Search for number value

    booleanValue boolean

    Search for boolean value

    dateValue string

    Search for date value

  • ]

    • key stringrequired

    Tag key to search

  • ]

    • responseFields

    SearchResponseFields

    attributes string[]
    tags string[]

Responses​

200 OK

Response Headers

  • Access-Control-Allow-Origin

    string

  • Access-Control-Allow-Methods

    string

  • Access-Control-Allow-Headers

    string

Schema

    totalCount integer

    Total number of documents that matched the search query. When the number of matches exceeds 10,000, this value will be reported as 10,000+ unless the search request explicitly enables exact total hit tracking.

    documents

    object[]

    List of search result documents

  • Array [

    • siteId string

    Site Identifier

    path string

    Path or Name of document

    contentType string

    Document Content-Type

    width string

    Document Content Width property

    height string

    Document Content Height property

    deepLinkPath string

    Path or Name of deep link

    resourceType DocumentResourceType (string)

    Document resource type

    Possible values: [DOCUMENT, DOSSIER, DEEP_LINK]

    insertedDate string

    Inserted Timestamp

    lastModifiedDate string

    Last Modified Timestamp

    checksum string

    Document checksum, changes when document file changes

    checksumType ChecksumType (string)

    The type of checksum to use for file validation

    Possible values: [SHA1, SHA256, SHA512]

    documentId string

    Document Identifier

    contentLength integer

    Document size

    createdBy string

    User who added document

    tags

    object

    metadata

    object

    attributes

    object

    property name*

    FulltextAttribute

    insertedDate string

    Inserted Timestamp

    stringValues string[]

    Attribute with string values

    numberValues number[]

    Attribute with number values

    booleanValue boolean

    Attribute with boolean value

    dateValues string[]

    Attribute with date values

    valueType AttributeValueType (string)

    Attribute Value Type

    Possible values: [BOOLEAN, DATE, KEY_ONLY, NUMBER, STRING, PUBLICATION, CLASSIFICATION, COMPOSITE_STRING, RELATIONSHIPS, WATERMARK, ENTITY]

  • ]

Loading...