Skip to main content
This page covers the mapping work inside a connector project: endpoint mapping, schema mapping, and the Mapping Workspace.

The two levels of mapping

Connector Studio maps at two levels, and you complete them in order. The following table describes each level: The two levels form a hierarchy:
  • An API holds operations, and each operation is one endpoint. You map these first.
  • An operation holds properties, which are its fields, enumerations, and transformations. You map these second.
Approve your endpoints first, then approve your properties. Schema mapping can only run for an operation after you approve or receive a suggestion for its endpoint pair.
The interface labels field-level work Property Mappings, while the backend and the AI messages call the same work schema mapping. Both names describe the same step.

Actions at the top of a project

The following table describes the actions in the project header:

Project metrics

The metrics band on the project overview gives you a quick health check:

Project tabs

The following table describes each tab on the project overview:

Map endpoints

Start here after you create a project. Endpoint mapping usually starts automatically when you open Mapping Workspace. If it doesn’t, or if you want to run it again, select Run AI Suggestions.
1

Open the Mapping Workspace

Open the project and select Mapping Workspace. A progress banner reports that Endpoint Matching or Endpoint Mapping is running when the job starts.
2

Run AI suggestions if needed

If endpoint mapping did not start, or if you want to run it again, select Run AI Suggestions.
3

Review the suggestions

On the Mappings tab, compare each suggested pair against the vendor documentation, then approve or reject it.

What the Mappings tab shows

The tab groups endpoint pairs into two sections:
  • Approved Mappings holds the pairs you accepted. Each row reports how many attributes, or properties, the operation contains.
  • AI Suggestions holds the draft matches that AI isn’t confident about. To hide low-confidence rows, use the Confidence threshold slider. To narrow the list further, filter by Role: Primary, Lookup, Enrichment, or Conditional.

Actions on an endpoint row

The following table describes when to use each row action:
Do not approve rows or open the Mapping Workspace while endpoint mapping runs. If you see Endpoint mapping is in progress or Schema mapping is in progress, wait for the job to finish. The two workflows are not safe to run at the same time.

Map schemas

Schema mapping answers one question: for this source JSON or XML structure, which target field corresponds to each source field?

How schema mapping starts

Schema mapping starts in three ways: While schema mapping runs, you see a Property mapping in progress banner, or a Mapping schemas… spinner on the row.
Do not approve property rows until the generation finishes. Rows can still change while the job runs.

Use the Mapping Workspace

To open the workspace, select Mapping Workspace in the project header, or Open Workspace on the Mappings tab.

Workspace metrics

The following table describes the metrics in the workspace header:

Select an operation

To move between endpoint pairs, use the operation switcher, which shows each pair as a source method and path followed by a target method and path. The switcher groups the pairs into Approved, Partial review, AI Suggestions, and API Gaps. Before you map properties, select either Request or Response. Map each side separately.

Map a field

The workspace has three columns: To create a mapping by hand:
1

Select the source field

In the SOURCE column, select the field you want to map.
2

Select the target field

In the TARGET column, select the field it maps to.
3

Approve the new row

A new row appears in the center column, usually as an AI suggestion. Approve it to confirm the mapping.
If the vendor documentation is incomplete but you know the path from your own integration knowledge, select + Add manual property under SOURCE or TARGET.

Review property mappings

Approved Mappings holds the field pairs you trust. To change the strategy, the null handling, or the enumeration mappings, expand a row. AI Suggestions holds draft field pairs, each with a confidence score. Approve a pair, reject it, or expand it to make a correction before you approve it. The workspace header also has bulk actions:
Approve All Suggestions accepts low-confidence pairs along with high-confidence ones. Raise the confidence threshold first, or review the pairs one by one, so that a wrong pair doesn’t reach your generated transformation.

Mapping strategies

Each property mapping uses a strategy. The following table describes when to use each one: For the lookup strategy, create the table on the project’s Code Lists tab first, then link to it from the property editor.

Manual mapping

You can map endpoints and fields without waiting for AI suggestions.

Manual endpoint mapping

On the Mappings tab, select Edit on an endpoint row to correct paths or metadata by hand. You can also create a mapping pair when AI didn’t suggest one.

Manual schema mapping

When a field is missing from the uploaded specification but you know the path from your integration knowledge, select + Add manual property under SOURCE or TARGET in the Mapping Workspace.

Gaps and confidence

A gap is a source property that has no target mapping. To close a gap, select Generate mappings, accept an AI suggestion, or map the field by hand. Low confidence doesn’t mean the suggestion is wrong. It means you need to verify it. If Connector Studio indexed a specification only in part, you see Partial schema index. Upload the specification again, or wait for indexing to finish on the API Specs page, before you rely on automatic mapping.

Troubleshooting

The following table lists common mapping problems and how to resolve them:

Next steps