Saltar al contenido principal
GET
Get a match rule

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

ruleId
string<uuid>
requerido

The unique identifier of the match rule. Rule ID

Respuesta

Successfully retrieved match rule

config
object
requerido

Rule-specific configuration object (matched fields and tolerance/lag parameters).

contextId
string
requerido

Identifier of the context this rule 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 rule.

Ejemplo:

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

priority
integer<int64>
requerido

Execution priority; lower numbers run first.

Rango requerido: 1 <= x <= 1000
Ejemplo:

1

type
enum<string>
requerido

Matching strategy. EXACT requires identical field values; TOLERANCE allows configured numeric slack; DATE_LAG allows a configured date offset between sides; FUZZY matches on normalized/similarity-scored references and always proposes for review.

Opciones disponibles:
EXACT,
TOLERANCE,
DATE_LAG,
FUZZY
Ejemplo:

"EXACT"

updatedAt
string
requerido

Last update timestamp in RFC 3339 format.

Ejemplo:

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