Interface StartHsClassificationResearch

Encapsulates typed und untyped workflow metadata for case properties

interface StartHsClassificationResearch {
    assumedInteractions: HsClassificationInteraction[];
    bbox?: Bbox;
    confidence?: number;
    currentItemDef: string;
    currentItemInteraction: string;
    currentItemName: string;
    currentItemPaths: string[];
    currentQuestionInteraction: HsClassificationInteraction;
    currentSIP: string;
    dataBuildDate: string;
    dataVersion: string;
    display?: boolean;
    duration: number;
    errorDetail: string;
    errors?: ErrorModel[];
    hsCode: string;
    hsYear: string;
    id: null;
    input?: string;
    itemOutOfScopeError: string;
    languageCode: string;
    lastChangedBy?: string;
    mixedContentError: null;
    modifiedAt?: number;
    modifiedBy?: {
        displayName?: string;
        id?: string;
    };
    multiItemError: string;
    options?: string[];
    potentialHeadings: string[];
    previousClassificationResponses?: StartHsClassificationResearch[];
    productDescription: string;
    profileId: string;
    rational: string;
    reason?: any;
    reqCount?: number;
    required?: boolean;
    reviewNeeded?: boolean;
    schedule: string;
    searchValue?: string;
    source?: string;
    systemError: string;
    tariffScheduleEffectiveDate: string;
    tariffScheduleSource: string;
    txId: string;
    userEdited?: boolean;
    value?: string;
}

Hierarchy (view full)

Properties

assumedInteractions: HsClassificationInteraction[]
bbox?: Bbox

Bounding box of extracted value

confidence?: number

Confidence supplied by data extraction or 1.0 if entered by human

currentItemDef: string
currentItemInteraction: string
currentItemName: string
currentItemPaths: string[]
currentQuestionInteraction: HsClassificationInteraction
currentSIP: string
dataBuildDate: string
dataVersion: string
display?: boolean
duration: number
errorDetail: string
errors?: ErrorModel[]

could be validation errors

hsCode: string
hsYear: string
id: null
input?: string

The input value which was initially supplied for the property

itemOutOfScopeError: string
languageCode: string
lastChangedBy?: string

Encoded user (username, userId, etc.)

Deprecated

mixedContentError: null
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
multiItemError: string
options?: string[]
potentialHeadings: string[]
previousClassificationResponses?: StartHsClassificationResearch[]
productDescription: string
profileId: string
rational: string
reason?: any
reqCount?: number
required?: boolean
reviewNeeded?: boolean
schedule: string
searchValue?: string

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

source?: string
systemError: string
tariffScheduleEffectiveDate: string
tariffScheduleSource: string
txId: string
userEdited?: boolean

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

value?: string

The current value of the property

Generated using TypeDoc