Get a field map by source

Use this endpoint to retrieve the field map for a specific source within a context. Field maps define how source fields are mapped to reconciliation fields.

GET /v1/contexts/{contextId}/sources/{sourceId}/field-maps

Get a field map by source

cURL

curl --request GET \
  --url https://matcher.sandbox.lerian.net/v1/contexts/{contextId}/sources/{sourceId}/field-maps \
  --header 'Authorization: Bearer <token>'

200

Example

{
  "contextId": "550e8400-e29b-41d4-a716-446655440000",
  "createdAt": "2025-01-15T10:30:00Z",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "mapping": {},
  "sourceId": "550e8400-e29b-41d4-a716-446655440000",
  "updatedAt": "2025-01-15T10:30:00Z",
  "version": 1
}

Autorizaciones

Authorization · string · header · requerido

Bearer token authentication (format: "Bearer {token}")

Encabezados

X-Request-Id · string

A unique identifier for tracing the request across services.

Parámetros de ruta

contextId · string<uuid> · requerido

The unique identifier of the reconciliation context. Context ID

sourceId · string<uuid> · requerido

The unique identifier of the reconciliation source. Source ID

Respuesta

200

application/json

Successfully retrieved field map

contextId · string · requerido

Identifier of the context this field map belongs to.

Ejemplo:

"550e8400-e29b-41d4-a716-446655440000"

createdAt · string · requerido

Creation timestamp in RFC 3339 format.

Ejemplo:

"2025-01-15T10:30:00Z"

id · string · requerido

Unique identifier of the field map.

Ejemplo:

"550e8400-e29b-41d4-a716-446655440000"

mapping · object · requerido

Field-mapping object normalizing the source's raw columns to canonical transaction fields.

Show child attributes

sourceId · string · requerido

Identifier of the source this field map normalizes.

Ejemplo:

"550e8400-e29b-41d4-a716-446655440000"

updatedAt · string · requerido

Last update timestamp in RFC 3339 format.

Ejemplo:

"2025-01-15T10:30:00Z"

version · integer<int64> · requerido

Monotonic mutation counter incremented server-side on each field-map change. Read-only on the write path and NOT honored for optimistic concurrency control.

Ejemplo:

1