Get a match rule

Use this endpoint to retrieve the details of a specific match rule by its identifier.

GET /v1/contexts/{contextId}/rules/{ruleId}

Get a match rule

cURL

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

200

{
  "config": {},
  "contextId": "019c96a0-10a0-72d2-9fb0-2b7de8093182",
  "createdAt": "2025-01-15T10:30:00.000Z",
  "id": "019c96a0-1071-7a0d-9916-a831221de252",
  "priority": 1,
  "type": "EXACT",
  "updatedAt": "2025-01-15T10:30:00.000Z"
}

Authorizations

Authorization · string · header · required

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

Headers

X-Request-Id · string

A unique identifier for tracing the request across services.

Path Parameters

contextId · string · required

The unique identifier of the reconciliation context.

ruleId · string · required

The unique identifier of the match rule.

Response

200

application/json

Successfully retrieved match rule

Matching rule within a reconciliation context

config · object

Rule configuration

Show child attributes

contextId · string

Context ID this rule belongs to

Example:

"019c96a0-10a0-72d2-9fb0-2b7de8093182"

createdAt · string

Creation timestamp in RFC3339 format

Example:

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

id · string

Unique identifier for the rule

Example:

"019c96a0-1071-7a0d-9916-a831221de252"

priority · integer

Execution priority (lower = higher priority)

Required range: 1 <= x <= 1000

Example:

1

type · enum<string>

Type of matching rule

Available options: EXACT, TOLERANCE, DATE_LAG

Example:

"EXACT"

updatedAt · string

Last update timestamp in RFC3339 format

Example:

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