Get document's full-text

GET 
/documents/:documentId/fulltext

Retrieve an OpenSearch document's details, i.e., metadata

Request

Path Parameters

documentId stringrequired

Document Identifier

Query Parameters

siteId string

Site Identifier

shareKey string

Share Identifier

Responses

200

200 OK

Response Headers

• Access-Control-Allow-Origin

  string

• Access-Control-Allow-Methods

  string

• Access-Control-Allow-Headers

  string

application/json

Schema

Schema

siteId string

Site Identifier

content string

Content of document

contentType string

Document Content-Type

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

insertedDate string

Inserted Timestamp

lastModifiedDate string

Last Modified Timestamp

documentId string

Document Identifier

createdBy string

User who added document

contentLength integer

Document size

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

metadata

object

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]

Example (from schema)

{
  "siteId": "string",
  "content": "string",
  "contentType": "string",
  "path": "string",
  "width": "string",
  "height": "string",
  "deepLinkPath": "string",
  "insertedDate": "string",
  "lastModifiedDate": "string",
  "documentId": "string",
  "createdBy": "string",
  "contentLength": 0,
  "checksum": "string",
  "checksumType": "SHA1",
  "tags": {},
  "metadata": {},
  "attributes": {}
}

Loading...