Interface IImportEntryRequest

Request body for importing an entry.

interface IImportEntryRequest {
    autoRename?: boolean;
    importAsElectronicDocument?: boolean;
    metadata?: ImportEntryRequestMetadata;
    name: string;
    pdfOptions?: ImportEntryRequestPdfOptions;
    volumeName?: string;
}

Implemented by

Properties

autoRename? importAsElectronicDocument? metadata? name pdfOptions? 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.

OptionalpdfOptions

pdfOptions?: ImportEntryRequestPdfOptions

The options applied when importing a PDF.

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