Interface IStartExportEntryRequest

Request body for starting an asynchronous export entry task.

interface IStartExportEntryRequest {
    alternateEdocName?: string;
    auditReasonComment?: string;
    auditReasonId?: number;
    imageOptions?: ExportEntryRequestImageOptions;
    part: ExportEntryRequestPart;
    textOptions?: ExportEntryRequestTextOptions;
}

Implemented by

Properties

alternateEdocName? auditReasonComment? auditReasonId? imageOptions? part textOptions?

Properties

OptionalalternateEdocName

alternateEdocName?: string

The name of the alternate electronic document to export. Required when part=AlternateEdoc, and rejected for every other part. 1 to 15 characters, each an ASCII letter, an ASCII digit, or one of !@#$%^&()-+={}[]_~. Matched exactly, so a name differing only in letter case is not found. Names reserved for internal use are also reported as not found.

OptionalauditReasonComment

auditReasonComment?: string

The comment for this audit event.

OptionalauditReasonId

auditReasonId?: number

The reason id for this audit event.

OptionalimageOptions

imageOptions?: ExportEntryRequestImageOptions

The options applied when exporting as Image.

part

part: ExportEntryRequestPart

Specifies the part of the document to export. Options include: Image, Text, Edoc, AlternateEdoc. AlternateEdoc also requires alternateEdocName.

OptionaltextOptions

textOptions?: ExportEntryRequestTextOptions

The options applied when exporting as Text.

Settings

Member Visibility

On This Page

Properties