get_field_map Database

Retrieve a field map and its entries for review

Overview

Fetches a field map and all of its mapping entries so you can review the LLM-generated mappings before confirming, rejecting, or applying corrections. Returns the full field map metadata (status, source file, target platform, model used) plus every individual field mapping entry with its source field, target entity/column, transformation, LLM reasoning, and confidence level.

How It Works

  1. Validates that the job belongs to the authenticated user.
  2. Looks up the field map by ID and verifies it belongs to the specified job.
  3. Loads all field map entries associated with the map.
  4. Returns the complete field map object with entries in a single response.

Input Parameters

ParameterTypeRequiredDescription
job_id string required Clone job ID
field_map_id string required ID of the field map to retrieve

What You Get Back

Example Use Case

After running map_source_database_to_target, call get_field_map to review every mapping the LLM generated. Check the confidence levels and reasoning — low-confidence fields may need corrections via confirm_field_map before proceeding to seed script generation.

Tips

This is also the POLL endpoint for map_source_database_to_target. While status is 'running' or 'queued', poll again every 5-10s — do NOT re-call the kickoff.
On status='failed', read the error_message field before deciding whether to retry the kickoff.
Always review the field map before confirming — the LLM may misinterpret ambiguous source fields.
Look for low-confidence entries that may need manual corrections.
Use the entry IDs from this response when submitting corrections via confirm_field_map.

Related Tools