Interface IUpdateDocumentUploadedPartsRequest

Request body for updating a document's electronic document and/or metadata from previously uploaded parts.

interface IUpdateDocumentUploadedPartsRequest {
    importAsElectronicDocument?: boolean;
    metadata?: ImportEntryRequestMetadata;
    partETags: string[];
    pdfOptions?: ImportEntryRequestPdfOptions;
    uploadId: string;
}

Implemented by

Properties

importAsElectronicDocument? metadata? partETags pdfOptions? uploadId

Properties

OptionalimportAsElectronicDocument

importAsElectronicDocument?: boolean

Whether the assembled file is imported as the electronic document (true) or as image pages (false). Default: false. This flag is only effective when the file 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.

partETags

partETags: string[]

The array of the ETag values received when writing the file chunks into the upload URLs. The ETag values should be in the order of their associated upload URLs.

OptionalpdfOptions

pdfOptions?: ImportEntryRequestPdfOptions

Server-side processing options applied to the assembled file. See ImportEntryRequestPdfOptions for the full contract.

uploadId

uploadId: string

The UploadId received when calling the CreateMultipartUploadUrls API to request upload URLs.

Settings

Member Visibility

On This Page

Properties