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;
    type: ATB;
    userEdited?: boolean;
    value?: PreliminaryDocument;
}

Hierarchy (view full)

Properties

amountOfPackages?: Meta<number>
bbox?: Bbox

Bounding box of extracted value

confidence?: number

Confidence supplied by data extraction or 1.0 if entered by human

display?: boolean
errors?: ErrorModel[]

could be validation errors

grossWeight?: Meta<number>
input?: string

The input value which was initially supplied for the property

lastChangedBy?: string

Encoded user (username, userId, etc.)

Deprecated

lineItem?: Meta<number>
modifiedAt?: number

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

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

Field last changed by

Type declaration

  • Optional displayName?: string
  • Optional id?: string
preliminaryDocumentCode?: Meta<string>
presentationDate?: DateTimeModel
reason?: any
required?: boolean
reviewNeeded?: boolean
searchValue?: string

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

source?: string
type: ATB
userEdited?: boolean

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

The current value of the property

Generated using TypeDoc