Interface IUpdateDocumentRequest

Request body for updating a document's electronic document and/or metadata.

interface IUpdateDocumentRequest {
    generateImagePagesText?: boolean;
    importAsElectronicDocument?: boolean;
    metadata?: ImportEntryRequestMetadata;
    pdfOptions?: ImportEntryRequestPdfOptions;
}

Implemented by

Properties

generateImagePagesText? importAsElectronicDocument? metadata? pdfOptions?

Properties

OptionalgenerateImagePagesText

generateImagePagesText?: boolean

Whether to request text extraction from the document's electronic document part after the image pages in imageFiles are added. This does not OCR those image pages — image pages are OCR'd by the repository's automatic OCR when the page image is written, regardless of this setting. Default: true. Does not affect pages generated from file — use pdfOptions.generateText for those.

OptionalimportAsElectronicDocument

importAsElectronicDocument?: boolean

Whether a provided file is imported as the electronic document (true) or as image pages (false). Default: false. This flag is only effective when file is provided and its extension is one of: txt, tif, tiff, bmp, pcx, jpg, jpeg, gif, png. For any other file type (PDF, Word, Excel, etc.), the file is always imported as the electronic document regardless of this flag.

Optionalmetadata

metadata?: ImportEntryRequestMetadata

The metadata that will be assigned to the entry. Metadata updates are additive — only the specified fields, tags, and links are touched. Existing values not mentioned in the request are preserved.

OptionalpdfOptions

pdfOptions?: ImportEntryRequestPdfOptions

The options applied when importing a PDF.

Settings

Member Visibility

On This Page

Properties