Pular para o conteúdo principal
GET
Get a match rule

Autorizações

Authorization
string
header
obrigatório

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

Cabeçalhos

X-Request-Id
string

A unique identifier for tracing the request across services.

Parâmetros de caminho

contextId
string<uuid>
obrigatório

The unique identifier of the reconciliation context. Context ID

ruleId
string<uuid>
obrigatório

The unique identifier of the match rule. Rule ID

Resposta

Successfully retrieved match rule

config
object
obrigatório

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

contextId
string
obrigatório

Identifier of the context this rule belongs to.

Exemplo:

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

createdAt
string
obrigatório

Creation timestamp in RFC 3339 format.

Exemplo:

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

id
string
obrigatório

Unique identifier of the rule.

Exemplo:

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

priority
integer<int64>
obrigatório

Execution priority; lower numbers run first.

Intervalo obrigatório: 1 <= x <= 1000
Exemplo:

1

type
enum<string>
obrigatório

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.

Opções disponíveis:
EXACT,
TOLERANCE,
DATE_LAG,
FUZZY
Exemplo:

"EXACT"

updatedAt
string
obrigatório

Last update timestamp in RFC 3339 format.

Exemplo:

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