Get context setup progress

Returns configured-resource counts, last-run state, and activation readiness for a context in a single aggregate, so clients derive wizard/checklist state from one request.

GET /v1/contexts/{contextId}/setup-progress

Get context setup progress

cURL

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

200

Example

{
  "contextId": "550e8400-e29b-41d4-a716-446655440000",
  "fieldMaps": {
    "mappedSources": 2
  },
  "lastRun": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "status": "COMPLETED",
    "completedAt": "2025-01-15T10:30:00Z"
  },
  "matchRules": {
    "total": 3
  },
  "next": {
    "method": "POST",
    "operationId": "createSource",
    "path": "/v1/contexts/{contextId}/sources",
    "requiredFields": [
      "name",
      "type",
      "side"
    ],
    "requirementId": "context.activation.requirement.left-source",
    "forSource": {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Bank statement"
    }
  },
  "readiness": {
    "missing": [
      "context.activation.requirement.left-source",
      "context.activation.requirement.match-rule"
    ],
    "ready": true
  },
  "schedules": {
    "total": 1
  },
  "sources": {
    "left": 1,
    "right": 1,
    "total": 2
  },
  "status": "DRAFT"
}

Autorizaciones

Authorization · string · header · requerido

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

Parámetros de ruta

contextId · string<uuid> · requerido

Context ID

Respuesta

200

application/json

OK

contextId · string · requerido

Identifier of the context this progress report describes.

Ejemplo:

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

fieldMaps · object · requerido

Field-map coverage across the context's sources.

Show child attributes

lastRun · object | null · requerido

Most recent match run; null when the context has never run.

Show child attributes

matchRules · object · requerido

Match-rule count for the context.

Show child attributes

next · object | null · requerido

Deterministic next setup action derived from readiness; null when the context is ready.

Show child attributes

readiness · object · requerido

Activation readiness summary.

Show child attributes

schedules · object · requerido

Schedule count for the context.

Show child attributes

sources · object · requerido

Source counts split by matching side.

Show child attributes

status · enum<string> · requerido

Current context lifecycle status. DRAFT is being configured; ACTIVE runs; PAUSED is suspended; ARCHIVED is retired.

Opciones disponibles: DRAFT, ACTIVE, PAUSED, ARCHIVED

Ejemplo:

"DRAFT"