Type Alias ImportTypeStatus

Status of a single type from the import file.

type ImportTypeStatus = {
    diff?: ImportTypeDiff;
    error?: string;
    errorCode?:
        | "IMPORT_REGEX_PATTERN_MISSING"
        | "IMPORT_REGEX_PATTERN_TOO_LONG"
        | "IMPORT_REGEX_PATTERN_INVALID"
        | "IMPORT_DICTIONARY_VALUES_MISSING"
        | "IMPORT_DICTIONARY_VALUE_BLANK"
        | "IMPORT_COMPOUND_CHILDREN_MISSING"
        | "IMPORT_COMPOUND_CHILDREN_NOT_FOUND"
        | "IMPORT_DICTIONARY_VALIDATION_CRITERIA_INVALID";
    label: string;
    status: "NEW"
    | "CONFLICT"
    | "ERROR"
    | "DUPLICATE";
    type: "REGEX" | "DICTIONARY" | "COMPOUND";
}
Index
diff? error? errorCode? label status type
diff?: ImportTypeDiff

Field-by-field comparison between the type from the import file and the existing type in the tenant. Only present when status is CONFLICT. Each field shows the value from the file and the existing value so the user can make an informed OVERWRITE / SKIP / KEEP_BOTH decision.

error?: string

Human-readable error message. Only present when status is ERROR.

errorCode?:
    | "IMPORT_REGEX_PATTERN_MISSING"
    | "IMPORT_REGEX_PATTERN_TOO_LONG"
    | "IMPORT_REGEX_PATTERN_INVALID"
    | "IMPORT_DICTIONARY_VALUES_MISSING"
    | "IMPORT_DICTIONARY_VALUE_BLANK"
    | "IMPORT_COMPOUND_CHILDREN_MISSING"
    | "IMPORT_COMPOUND_CHILDREN_NOT_FOUND"
    | "IMPORT_DICTIONARY_VALIDATION_CRITERIA_INVALID"

Machine-readable error code. Only present when status is ERROR.

label: string

Label of the semantic type.

status: "NEW" | "CONFLICT" | "ERROR" | "DUPLICATE"

NEW: no type with this label exists in the tenant. CONFLICT: a type with this label already exists but differs from the imported version. ERROR: the type has a validation error (missing field, invalid regex, etc.). DUPLICATE: the type is a duplicate — either another type with the same label appears earlier in the import file, or the imported type is identical to an existing type in the tenant (all user-visible fields match; auto-skipped with no conflict resolution needed).

type: "REGEX" | "DICTIONARY" | "COMPOUND"

Category of the semantic type.

Settings
Member Visibility

On This Page
Properties