Interface Package

Encapsulates typed und untyped workflow metadata for case properties

interface Package {
    amount?: Meta<number>;
    bbox?: Bbox;
    confidence?: number;
    customsTariffNumber?: CustomsTariffNumber;
    dimensions?: Dimensions;
    display?: boolean;
    errors?: ErrorModel[];
    input?: string;
    lastChangedBy?: string;
    marks?: Meta<string>;
    modifiedAt?: number;
    modifiedBy?: {
        displayName?: string;
        id?: string;
    netWeight?: Weight;
    options?: any[];
    packageNetWeight?: Weight;
    packageNumber?: Meta<string>;
    packageWeight?: Weight;
    reason?: any;
    required?: boolean;
    reviewNeeded?: boolean;
    searchValue?: string;
    source?: string;
    templateValue?: string;
    type?: PackageType;
    userEdited?: boolean;
    value?: any;
    weight?: Weight;
    weightUnit?: Meta<WeightUnit>;

Hierarchy (view full)


amount?: Meta<number>
bbox?: Bbox

Bounding box of extracted value

confidence?: number

Confidence supplied by data extraction or 1.0 if entered by human

customsTariffNumber?: CustomsTariffNumber
dimensions?: Dimensions
display?: boolean
errors?: ErrorModel[]

could be validation errors

input?: string

The input value which was initially supplied for the property

lastChangedBy?: string

Encoded user (username, userId, etc.)


marks?: Meta<string>
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
netWeight?: Weight
options?: any[]
packageNetWeight?: Weight
packageNumber?: Meta<string>
packageWeight?: Weight
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
templateValue?: string

Template value which was used to generate the value

userEdited?: boolean

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

value?: any

The current value of the property

weight?: Weight
weightUnit?: Meta<WeightUnit>