Interface Port

Encapsulates typed und untyped workflow metadata for case properties

interface Port {
    address?: AddressModel;
    bbox?: Bbox;
    confidence?: number;
    country?: string;
    display?: boolean;
    errors?: ErrorModel[];
    hasAirport?: boolean;
    hasPostalExchangeOffice?: boolean;
    hasRailTerminal?: boolean;
    hasRoadTerminal?: boolean;
    input?: string;
    keywords?: string[];
    lastChangedBy?: string;
    location?: string;
    modifiedAt?: number;
    modifiedBy?: {
        displayName?: string;
        id?: string;
    };
    name?: string;
    options?: string[];
    reason?: any;
    required?: boolean;
    reviewNeeded?: boolean;
    searchValue?: string;
    source?: string;
    templateValue?: string;
    type?: PortType;
    userEdited?: boolean;
    value?: string;
}

Hierarchy (view full)

Properties

address? bbox? confidence? country? display? errors? hasAirport? hasPostalExchangeOffice? hasRailTerminal? hasRoadTerminal? input? keywords? lastChangedBy? location? modifiedAt? modifiedBy? name? options? reason? required? reviewNeeded? searchValue? source? templateValue? type? userEdited? value?

Properties

Optional address

address?: AddressModel

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 country

country?: string

Part of the UN/Locode

Optional display

display?: boolean

Optional errors

errors?: ErrorModel[]

could be validation errors

Optional hasAirport

hasAirport?: boolean

Optional hasPostalExchangeOffice

hasPostalExchangeOffice?: boolean

Optional hasRailTerminal

hasRailTerminal?: boolean

Optional hasRoadTerminal

hasRoadTerminal?: boolean

Optional input

input?: string

The input value which was initially supplied for the property

Optional keywords

keywords?: string[]

Optional lastChangedBy

lastChangedBy?: string

Encoded user (username, userId, etc.)

Deprecated

Optional location

location?: string

Part of the UN/Locode

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 name

name?: 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 source

source?: string

Optional templateValue

templateValue?: string

Template value which was used to generate the value

Optional type

type?: PortType

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

Settings

Member Visibility

Theme

On This Page

addressbboxconfidencecountrydisplayerrorshasAirporthasPostalExchangeOfficehasRailTerminalhasRoadTerminalinputkeywordslastChangedBylocationmodifiedAtmodifiedBynameoptionsreasonrequiredreviewNeededsearchValuesourcetemplateValuetypeuserEditedvalue