Updates pipeline name and / or description.
Id · string Id · string
required The ID or name of the pipeline to retrieve.
The new description of the pipeline.
The version number of the mapper to make active in the pipeline.
The new name of the pipeline. Must be unique within the organization.
A pipeline organizes mapper versions that operate on the same source data schema. It is initialized with a mapper which can be edited iteratively to produce new versions. A single mapper version is active at a time.
The date and time this pipeline was created.
The UUID of the pipeline.
The user-provided name of the pipeline.
The UUID of the user who created the pipeline.
The user-provided description of the pipeline.
The status of the last run of the active mapper in the pipeline.
Available options:
QUEUED,
RUNNING,
FINISHED,
FAILED,
NEEDS REVIEW
A mapper is a set of transformation logic that maps data from a source schema to a target schema.
The status of mapper creation. The mapper is only usable once creation is complete.
Available options:
QUEUED,
RUNNING,
FINISHED,
FAILED,
NEEDS REVIEW
The UUID of the user who created the mapper.
The mapper version number. Assigned sequentially from zero. Unique within a pipeline.
A dependency graph of target fields and their corresponding source fields. Derived from the target schema and transformations.
mapper.manifest.items. property
mapper.manifest.items.property. name
The name of the target property
mapper.manifest.items.property. schema
The schema of the target property
mapper.manifest.items.property. types
The types of the target property
mapper.manifest.items. children
The children of the target property
mapper.manifest.items.children. property
mapper.manifest.items.children. children
The children of the target property
mapper.manifest.items.children. conditional
The conditional transformation for this property
mapper.manifest.items.children. dependencies
The dependencies of the target property
mapper.manifest.items.children. lookup_mappings
The mappings for this property
mapper.manifest.items. conditional
The conditional transformation for this property
mapper.manifest.items.conditional. condition
mapper.manifest.items.conditional. false
The action to be taken if the condition is not met
mapper.manifest.items.conditional. true
The action to be taken if the condition is met
mapper.manifest.items. dependencies
The dependencies of the target property
mapper.manifest.items.dependencies. default_values
The default values used for this property
mapper.manifest.items.dependencies. source_properties
The source data properties that this property depends on
mapper.manifest.items. lookup_mappings
The mappings for this property
mapper.manifest.items.lookup_mappings. mapped_value
mapper.manifest.items.lookup_mappings. source_value
mapper.manifest.items.lookup_mappings. confidence
The confidence of the mapping. None if not available
Available options:
Confident,
Very High,
High,
Medium,
Low,
Very Low,
Incorrect
mapper.manifest.items.lookup_mappings. confidence_score
The confidence score of the mapping. None if not available
The target JSON schema to which data will be mapped.
The transformation logic executed by the mapper.
