Interface ATB

Encapsulates typed und untyped workflow metadata for case properties

interface ATB {
    ATBNumber?: AtlasDocumentNumber;
    amountOfPackages?: Meta<number>;
    bbox?: Bbox;
    confidence?: number;
    display?: boolean;
    errors?: ErrorModel[];
    grossWeight?: Meta<number>;
    input?: string;
    lastChangedBy?: string;
    lineItem?: Meta<number>;
    modifiedAt?: number;
    modifiedBy?: {
        displayName?: string;
        id?: string;
    };
    options?: PreliminaryDocument[];
    preliminaryDocumentCode?: Meta<string>;
    presentationDate?: DateTimeModel;
    reason?: any;
    required?: boolean;
    reviewNeeded?: boolean;
    searchValue?: string;
    source?: string;
    templateValue?: string;
    type: ATB;
    userEdited?: boolean;
    value?: PreliminaryDocument;
}

Hierarchy (view full)

Properties

ATBNumber? amountOfPackages? bbox? confidence? display? errors? grossWeight? input? lastChangedBy? lineItem? modifiedAt? modifiedBy? options? preliminaryDocumentCode? presentationDate? reason? required? reviewNeeded? searchValue? source? templateValue? type userEdited? value?

Properties

Optional ATBNumber

ATBNumber?: AtlasDocumentNumber

Optional amountOfPackages

amountOfPackages?: Meta<number>

Optional bbox

bbox?: Bbox

Bounding box of extracted value

Optional confidence

confidence?: number

Confidence supplied by data extraction or 1.0 if entered by human

Optional display

display?: boolean

Optional errors

errors?: ErrorModel[]

could be validation errors

Optional grossWeight

grossWeight?: Meta<number>

Optional input

input?: string

The input value which was initially supplied for the property

Optional lastChangedBy

lastChangedBy?: string

Encoded user (username, userId, etc.)

Deprecated

Optional lineItem

lineItem?: Meta<number>

Optional modifiedAt

modifiedAt?: number

Last modification date (user or machine), as a UTC unix timestamp

Optional modifiedBy

modifiedBy?: {
    displayName?: string;
    id?: string;
}

Field last changed by

Type declaration

  • Optional displayName?: string
  • Optional id?: string

Optional options

options?: PreliminaryDocument[]

Optional preliminaryDocumentCode

preliminaryDocumentCode?: Meta<string>

Optional presentationDate

presentationDate?: DateTimeModel

Optional reason

reason?: any

Optional required

required?: boolean

Optional reviewNeeded

reviewNeeded?: boolean

Optional searchValue

searchValue?: string

Normalized searchValue, for any related queries. Needs to be a string, even if value is of a different type.

Optional source

source?: string

Optional templateValue

templateValue?: string

Template value which was used to generate the value

type

type: ATB

Optional userEdited

userEdited?: boolean

Mark this property as user-edited (as opposed to machine-generated)

Optional value

value?: PreliminaryDocument

The current value of the property

Settings

Member Visibility

Theme

On This Page

ATBNumberamountOfPackagesbboxconfidencedisplayerrorsgrossWeightinputlastChangedBylineItemmodifiedAtmodifiedByoptionspreliminaryDocumentCodepresentationDatereasonrequiredreviewNeededsearchValuesourcetemplateValuetypeuserEditedvalue