Reconciliation report for a rail

Answers “did we lose a message?” by evaluating E(m) = C(m) + T(m) + R(m) per rail over a declared window. What pages: a non-zero divergence, and a send with no captured return leg past the return-leg window. What does not: a hole in the vendor’s sequence, which is counted and listed here: the vendor numbers the whole cabin in one sequence, so a hole is usually another legacy system’s message. Whichever cycle is reported, it lists the rail’s open findings and its closed ones with their closure; closedCursor pages to older closures. The Courier deletes no cycle and no closure: they are audit evidence, and the client defines how long its database keeps them.

GET /v1/channels/{channelId}/reconciliation

Reconciliation report for a rail

cURL

curl --request GET \
  --url https://api.example.com/v1/channels/{channelId}/reconciliation \
  --header 'Authorization: Bearer <token>'

200

{
  "channelCount": 1,
  "channelId": "spb",
  "closedFindings": [
    {
      "channelId": "spb",
      "detail": "<string>",
      "detectedAt": "2023-11-07T05:31:56Z",
      "engineIds": [
        "<string>"
      ],
      "findingId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "subjectReference": "<string>",
      "type": "COUNT_DIVERGENCE",
      "updatedAt": "2023-11-07T05:31:56Z",
      "closed": {
        "closedAt": "2023-11-07T05:31:56Z",
        "closedBy": "<string>",
        "note": "<string>"
      }
    }
  ],
  "closedFindingsNextCursor": "<string>",
  "cycleId": "<string>",
  "divergence": 123,
  "engineCounts": [
    {
      "delivered": 1,
      "engineId": "<string>"
    }
  ],
  "expectedOutcomeCount": 1,
  "generatedAt": "2023-11-07T05:31:56Z",
  "historyUnjudgedBefore": "2023-11-07T05:31:56Z",
  "missingReturnLegs": [
    {
      "controlId": "<string>",
      "engineId": "<string>"
    }
  ],
  "openFindings": [
    {
      "channelId": "spb",
      "detail": "<string>",
      "detectedAt": "2023-11-07T05:31:56Z",
      "engineIds": [
        "<string>"
      ],
      "findingId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "subjectReference": "<string>",
      "type": "COUNT_DIVERGENCE",
      "updatedAt": "2023-11-07T05:31:56Z",
      "closed": {
        "closedAt": "2023-11-07T05:31:56Z",
        "closedBy": "<string>",
        "note": "<string>"
      }
    }
  ],
  "openFindingsTruncated": true,
  "refusedCount": 1,
  "retainedCount": 1,
  "returnLegWindowSeconds": 2,
  "sequenceGapCount": 123,
  "sequenceGaps": [
    {
      "afterKey": "<string>",
      "beforeKey": "<string>",
      "cycleId": "<string>",
      "missingCount": "<string>"
    }
  ],
  "sequenceGapsTruncated": true,
  "sequenceRegressions": 1,
  "windowEnd": "2023-11-07T05:31:56Z",
  "windowSeconds": 2,
  "windowStart": "2023-11-07T05:31:56Z"
}

Autorizaciones

Authorization · string · header · requerido

JWT bearer token issued by the identity provider.

Parámetros de ruta

channelId · string · requerido

The rail. A value outside the vocabulary, or a rail this build does not carry, is a 404.

Parámetros de consulta

cycleId · string

A specific cycle. Omitted returns the most recent.

Maximum string length: 64

from · string

RFC 3339. With to, lists the sequence gaps of every cycle whose window overlaps [from, to), each with its cycle. One bound alone leaves the other open. Both omitted list the reported cycle's own gaps.

Maximum string length: 64

to · string

RFC 3339; see from.

Maximum string length: 64

closedCursor · string

The closedFindingsNextCursor of a previous report: lists the closures older than its page. Its format is not contract.

Maximum string length: 512

Respuesta

200

application/json

OK

channelCount · integer<int64> · requerido

Rango requerido: x >= 0

channelId · enum<string> · requerido

Opciones disponibles: spb, pix

closedFindings · object[] · requerido

The findings closed on this channel, whichever cycle is reported, most recent closure first, at most 100, each with who closed it, when and the note.

Show child attributes

closedFindingsNextCursor · string | null · requerido

Pass as closedCursor for the older closures; null on the last page.

cycleId · string · requerido

Maximum string length: 64

divergence · integer<int64> · requerido

E − (C + T + R). Non-zero is an alert.

engineCounts · object[] · requerido

C per engine: completed deliveries whose engine is in the message's frozen resolved set.

Show child attributes

expectedOutcomeCount · integer<int64> · requerido

E, summed from each message's own stored expectation, never recomputed.

Rango requerido: x >= 0

generatedAt · string<date-time> · requerido

historyUnjudgedBefore · string<date-time> | null · requerido

Set on a channel's first cycle when the channel was registered more than a day before reconciliation first ran: nothing captured or sent before this instant was judged, and a divergence older than it is never reconciled automatically. Null when the cycle judged all it could.

missingReturnLegs · object[] · requerido

Sends whose return-leg window closed during this cycle with no captured message echoing their control identifier. Each one pages.

Show child attributes

openFindings · object[] · requerido

The findings open on this channel NOW, whichever cycle is reported, oldest first, at most 1000: what pages until an operator closes it with POST /v1/assurance/findings/{findingId}/close.

Show child attributes

openFindingsTruncated · boolean · requerido

True when more findings are open than openFindings lists.

refusedCount · integer<int64> · requerido

Rango requerido: x >= 0

retainedCount · integer<int64> · requerido

Rango requerido: x >= 0

returnLegWindowSeconds · integer<int64> · requerido

A send with no captured return leg older than this pages.

Rango requerido: x >= 1

sequenceGapCount · integer<int64> | null · requerido

Holes in the channel's own sequence over the cycle, or over the range when from/to are given; null when no sequence was measured: the rail has none, or no key that arrived could be read as one. Counted and exposed, never paged: the vendor numbers the whole cabin in one sequence, so a hole is usually another legacy system's message.

sequenceGaps · object[] | null · requerido

The holes, oldest cycle first, each with the cycle that saw it; null when no sequence was measured, as for sequenceGapCount. At most 1000; sequenceGapsTruncated says when there were more.

Show child attributes

sequenceGapsTruncated · boolean · requerido

True when sequenceGapCount is larger than the list returned: narrow the range to see the rest.

sequenceRegressions · integer<int64> · requerido

Arrivals at or below the sequence before them: a reorder or a reset, never a gap.

Rango requerido: x >= 0

windowEnd · string<date-time> · requerido

windowSeconds · integer<int64> · requerido

The declared window. A divergence inside it may be a message in transit; outside it, a loss candidate.

Rango requerido: x >= 1

windowStart · string<date-time> · requerido

The capture instants this cycle judged, [windowStart, windowEnd). Consecutive cycles tile time.