Skip to main content

Add document's full-text

POST 
/documents/:documentId/fulltext

Add a document to OpenSearch; available as an Add-On Module

Request​

Path Parameters

    documentId stringrequired

    Document Identifier

Query Parameters

    siteId string

    Site Identifier

Body

    contentType string

    Document Content-Type

    content string

    Document content

    contentUrls string[]

    URL(s) which contain document content

    path string

    Path or Name of document

    width string

    Document Content Width property

    height string

    Document Content Height property

    deepLinkPath string

    Path or Name of deep link

    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]

    tags

    object[]

    List of document tags

  • Array [

    • key stringrequired

    Tag key

    value string

    Tag value

    values string[]

    Tag values

  • ]

    • metadata

    object[]

    List of document Metadata

  • Array [

    • key stringrequired

    Metadata key

    value string

    Metadata value

    values string[]

    Metadata values

  • ]

    • attributes

    object

    property name*

    FulltextAttribute

    stringValues string[]

    Attribute with string values

    numberValues number[]

    Attribute with number values

    booleanValue boolean

    Attribute with boolean value

    valueType AttributeValueType (string)

    Attribute Value Type

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

Responses​

200 OK

Response Headers

  • Access-Control-Allow-Origin

    string

  • Access-Control-Allow-Methods

    string

  • Access-Control-Allow-Headers

    string

Schema

    message string

    Full text processing message

Loading...