id of the mapping (new: 'mapping/<name>', legacy: 'sync/<name>')
mapping object
a promise that resolves to an mapping object
Create an empty mapping export template
an empty mapping export template
Delete mapping
id of the mapping (new: 'mapping/<name>', legacy: 'sync/<name>')
a promise that resolves an mapping object
Delete all mappings, or only the mappings of a connector and/or a managed object type. With both, only the mappings that belong to both are deleted. Every selected mapping is tried: a mapping that cannot be deleted does not stop the others. Mappings that are not selected are left alone.
OptionalconnectorId: string
limit mappings to connector
OptionalmoType: string
limit mappings to managed object type
OptionalresultCallback: ResultCallback<MappingSkeleton>
Optional callback to process individual results. When given, the outcome of every delete is passed to it as it happens (a failed delete as an error that names the mapping) and a failed delete does not throw. Without it, the failures are collected and thrown as one error after every mapping was tried. Failing to read the mappings always throws.
a promise that resolves to an array of the deleted mapping objects
Export mapping
id of the mapping (new: 'mapping/<name>', legacy: 'sync/<name>')
Optionaloptions: MappingExportOptions
export options
a promise that resolves to a MappingExportInterface object
Export all mappings
Optionaloptions: MappingExportOptions
export options
a promise that resolves to a MappingExportInterface object
Import first mapping
import data
Optionaloptions: MappingImportOptions
import options
a promise resolving to a MappingSkeleton object
Import mapping
id of the mapping (new: 'mapping/<name>', legacy: 'sync/<name>')
import data
Optionaloptions: MappingImportOptions
import options
a promise resolving to a MappingSkeleton object
Import all mappings. Every mapping is tried: a mapping that cannot be imported does not stop the others.
import data
Optionaloptions: MappingImportOptions
import options
OptionalresultCallback: ResultCallback<MappingSkeleton>
Optional callback to process individual results. When given, the outcome of every mapping is passed to it as it happens (a failed mapping as an error that names the mapping and carries the cause) and a failed mapping does not throw: the mappings that were imported are returned. Without it, the failures are collected and thrown as one error after every mapping was tried.
a promise resolving to an array of MappingSkeleton objects
Read mapping
id of the mapping (new: 'mapping/<name>', legacy: 'sync/<name>')
a promise that resolves an mapping object
Read mappings
OptionalconnectorId: string
limit mappings to connector
OptionalmoType: string
limit mappings to managed object type
a promise that resolves to an array of mapping objects
Read mappings from sync.json (legacy)
a promise that resolves to an array of mapping objects
Update or create mapping
id of the mapping (new: 'mapping/<name>', legacy: 'sync/<name>')
mapping object
a promise that resolves to an mapping object
Update or create mappings in sync.json (legacy)
a promise that resolves to an mapping object
Create mapping