Interface AtlasDocumentNumber

Encapsulates typed und untyped workflow metadata for case properties

interface AtlasDocumentNumber {
    bbox?: Bbox;
    confidence?: number;
    customsOffice?: CustomsOffice;
    display?: boolean;
    errors?: ErrorModel[];
    identifier?: string;
    identifierNumber?: string;
    input?: string;
    lastChangedBy?: string;
    modifiedAt?: number;
    modifiedBy?: {
        displayName?: string;
        id?: string;
    };
    month?: string;
    options?: string[];
    reason?: any;
    required?: boolean;
    reviewNeeded?: boolean;
    searchValue?: string;
    serialNumber?: string;
    source?: string;
    templateValue?: string;
    userEdited?: boolean;
    value?: string;
    year?: string;
}

Hierarchy (view full)

  • Meta<string>
    • AtlasDocumentNumber

Properties

bbox? confidence? customsOffice? display? errors? identifier? identifierNumber? input? lastChangedBy? modifiedAt? modifiedBy? month? options? reason? required? reviewNeeded? searchValue? serialNumber? source? templateValue? userEdited? value? year?

Properties

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 customsOffice

customsOffice?: CustomsOffice

Optional display

display?: boolean

Optional errors

errors?: ErrorModel[]

could be validation errors

Optional identifier

identifier?: string

Optional identifierNumber

identifierNumber?: string

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 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 month

month?: string

Optional options

options?: string[]

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 serialNumber

serialNumber?: string

Optional source

source?: string

Optional templateValue

templateValue?: string

Template value which was used to generate the value

Optional userEdited

userEdited?: boolean

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

Optional value

value?: string

The current value of the property

Optional year

year?: string

Settings

Member Visibility

Theme

On This Page

bboxconfidencecustomsOfficedisplayerrorsidentifieridentifierNumberinputlastChangedBymodifiedAtmodifiedBymonthoptionsreasonrequiredreviewNeededsearchValueserialNumbersourcetemplateValueuserEditedvalueyear