Interface IStartImportUploadedPartsRequest

Request body for starting an asynchronous import entry task.

interface IStartImportUploadedPartsRequest {
    autoRename?: boolean;
    importAsElectronicDocument?: boolean;
    metadata?: ImportEntryRequestMetadata;
    name: string;
    partETags: string[];
    pdfOptions?: ImportEntryRequestPdfOptions;
    uploadId: string;
    volumeName?: string;
}

Implemented by

Properties

autoRename? importAsElectronicDocument? metadata? name partETags pdfOptions? uploadId volumeName?

Properties

OptionalautoRename

autoRename?: boolean

Indicates if the entry should be automatically renamed if an entry already exists with the given name in the folder. The default value is false.

OptionalimportAsElectronicDocument

importAsElectronicDocument?: boolean

Indicates if the document should be imported as an electronic document (true) or as image pages (false). The default value is false. This option is only applicable when importing the following document types: txt, tif, tiff, bmp, pcx, jpg, jpeg, gif, png.

Optionalmetadata

metadata?: ImportEntryRequestMetadata

The metadata that will be assigned to the entry.

name

name: string

The name for the imported entry.

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, i.e. {eTag received when writing to the first URL}, {eTag received when writing to the second URL}, ...

OptionalpdfOptions

pdfOptions?: ImportEntryRequestPdfOptions

The options applied when importing a PDF.

uploadId

uploadId: string

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

OptionalvolumeName

volumeName?: string

The name of the volume to use. Will use the default parent entry volume if not specified. This is ignored in Laserfiche Cloud.

Settings

Member Visibility

On This Page

Properties