Integration App SDK - v1.14.0
    Preparing search index...

    Interface FieldMappingInstance

    interface FieldMappingInstance {
        userId: string;
        revision: string;
        user?: Customer;
        connectionId: string;
        connection?: Connection;
        integrationId: string;
        integration?: Integration;
        fieldMappingRevision?: string;
        fieldMappingId?: string;
        fieldMapping?: FieldMapping;
        instanceKey?: string;
        dataSourceInstanceId?: string;
        dataSourceInstance?: DataSourceInstance;
        dataSourceSchema?: DataSchema;
        direction?: FieldMappingDirection;
        appSchema?: DataSchema;
        importValue?: any;
        exportValue?: any;
        isCustomized?: boolean;
        unifiedExportValue?: any;
        unifiedImportValue?: any;
        frozenImportFields?: string[];
        frozenExportFields?: string[];
        state?: WorkspaceElementState;
        error?: ErrorData;
        externalSchema?: any;
        id: string;
        name: string;
        key: string;
        errors?: ErrorData[];
    }

    Hierarchy (View Summary)

    Index

    Properties

    userId revision user? connectionId connection? integrationId integration? fieldMappingRevision? fieldMappingId? fieldMapping? instanceKey? dataSourceInstanceId? dataSourceInstance? dataSourceSchema? direction? appSchema? importValue? exportValue? isCustomized? unifiedExportValue? unifiedImportValue? frozenImportFields? frozenExportFields? state? error? externalSchema? id name key errors?

    Properties

    userId: string
    revision: string
    user?: Customer
    connectionId: string
    connection?: Connection
    integrationId: string
    integration?: Integration
    fieldMappingRevision?: string
    fieldMappingId?: string
    fieldMapping?: FieldMapping
    instanceKey?: string
    dataSourceInstanceId?: string
    dataSourceInstance?: DataSourceInstance
    dataSourceSchema?: DataSchema
    direction?: FieldMappingDirection
    appSchema?: DataSchema
    importValue?: any

    Value used for app element fields. Can use external element fields in its formulas.

    exportValue?: any

    Value used for external element fields. Can use app element fields in its formulas.

    isCustomized?: boolean

    Whether instance was customized by a user (or generated by default).

    If instance was not customized, it will be automatically updated when underlying data changes. If it was customized, it won't be automatically updated.

    unifiedExportValue?: any

    Import mapping from UDM to appSchema. Parsed into exportValue on setup.

    unifiedImportValue?: any

    Export mapping from UDM to appSchema. Parsed into importValue on setup.

    frozenImportFields?: string[]
    frozenExportFields?: string[]
    state?: WorkspaceElementState
    error?: ErrorData
    externalSchema?: any
    • use dataSourceSchema
    id: string
    name: string
    key: string
    errors?: ErrorData[]

    Settings

    Member Visibility

    On This Page

    Properties