Frodo Library - v4.0.0-10
    Preparing search index...

    Type Alias Mapping

    type Mapping = {
        createMapping(
            mappingId: string,
            mappingData: MappingSkeleton,
        ): Promise<MappingSkeleton>;
        createMappingExportTemplate(): MappingExportInterface;
        deleteMapping(mappingId: string): Promise<MappingSkeleton>;
        deleteMappings(
            connectorId?: string,
            moType?: string,
        ): Promise<MappingSkeleton[]>;
        exportMapping(
            mappingId: string,
            options?: MappingExportOptions,
        ): Promise<MappingExportInterface>;
        exportMappings(
            options?: MappingExportOptions,
        ): Promise<MappingExportInterface>;
        importFirstMapping(
            importData: MappingExportInterface,
            options?: MappingImportOptions,
        ): Promise<MappingSkeleton>;
        importMapping(
            mappingId: string,
            importData: MappingExportInterface,
            options?: MappingImportOptions,
        ): Promise<MappingSkeleton>;
        importMappings(
            importData: MappingExportInterface,
            options?: MappingImportOptions,
        ): Promise<MappingSkeleton[]>;
        isLegacyMapping(mappingId: string): boolean;
        readMapping(mappingId: string): Promise<MappingSkeleton>;
        readMappings(
            connectorId?: string,
            moType?: string,
        ): Promise<MappingSkeleton[]>;
        readSyncMappings(): Promise<MappingSkeleton[]>;
        updateMapping(
            mappingId: string,
            mappingData: MappingSkeleton,
        ): Promise<MappingSkeleton>;
        updateSyncMappings(mappings: MappingSkeleton[]): Promise<MappingSkeleton[]>;
    }
    Index

    Methods

    createMapping createMappingExportTemplate deleteMapping deleteMappings exportMapping exportMappings importFirstMapping importMapping importMappings isLegacyMapping readMapping readMappings readSyncMappings updateMapping updateSyncMappings

    Methods

    • Delete mapping

      Parameters

      • mappingId: string

        id of the mapping (new: 'mapping/<name>', legacy: 'sync/<name>')

      Returns Promise<MappingSkeleton>

      a promise that resolves an mapping object

    • Delete all mappings

      Parameters

      • OptionalconnectorId: string

        limit mappings to connector

      • OptionalmoType: string

        limit mappings to managed object type

      Returns Promise<MappingSkeleton[]>

      a promise that resolves to an array of mapping objects

    • Helper that returns a boolean indicating whether the mapping is a legacy mapping or not given the id

      Parameters

      • mappingId: string

        the mapping id

      Returns boolean

      true if the mapping is a legacy mapping, false otherwise

      if the id is invalid

    • Read mapping

      Parameters

      • mappingId: string

        id of the mapping (new: 'mapping/<name>', legacy: 'sync/<name>')

      Returns Promise<MappingSkeleton>

      a promise that resolves an mapping object

    • Read mappings

      Parameters

      • OptionalconnectorId: string

        limit mappings to connector

      • OptionalmoType: string

        limit mappings to managed object type

      Returns Promise<MappingSkeleton[]>

      a promise that resolves to an array of mapping objects

    Settings

    Member Visibility

    On This Page

    Methods