> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt
> Use this file to discover all available pages before exploring further.

# Obter o progresso da configuração do contexto

> Retorna contagens de recursos configurados, estado da última execução e prontidão para ativação de um contexto em um único agregado, para que clientes derivem o estado de wizard/checklist de uma requisição.



## OpenAPI

````yaml pt/openapi/v3-current/matcher.yaml get /v1/contexts/{contextId}/setup-progress
openapi: 3.1.0
info:
  title: Matcher APIs
  description: >-
    Referência completa de API para o motor de conciliação Matcher, que fornece
    conciliação automática de transações entre o Midaz Ledger e sistemas
    externos.
  version: 4.1.0
  license:
    name: Elastic License 2.0
    url: https://www.elastic.co/licensing/elastic-license
servers:
  - url: https://matcher.sandbox.lerian.net
security: []
paths:
  /v1/contexts/{contextId}/setup-progress:
    get:
      tags:
        - Configuration
      summary: Obter o progresso da configuração do contexto
      description: >-
        Retorna contagens de recursos configurados, estado da última execução e
        prontidão para ativação de um contexto em um único agregado, para que
        clientes derivem o estado de wizard/checklist de uma requisição.
      operationId: getSetupProgress
      parameters:
        - description: Context ID
          in: path
          name: contextId
          required: true
          schema:
            description: ID do contexto
            format: uuid
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SetupProgressResponse'
          description: OK
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Erro
      security:
        - BearerAuth: []
components:
  schemas:
    SetupProgressResponse:
      additionalProperties: false
      properties:
        contextId:
          description: Identificador do contexto que este relatório de progresso descreve.
          examples:
            - 550e8400-e29b-41d4-a716-446655440000
          type: string
        fieldMaps:
          $ref: '#/components/schemas/SetupProgressFieldMapsResponse'
          description: Cobertura de mapa de campo nas origens do contexto.
        lastRun:
          $ref: '#/components/schemas/SetupProgressLastRunResponse'
          description: >-
            Execução de correspondência mais recente; null quando o contexto
            nunca foi executado.
        matchRules:
          $ref: '#/components/schemas/SetupProgressMatchRulesResponse'
          description: Contagem de regras de correspondência do contexto.
        readiness:
          $ref: '#/components/schemas/SetupProgressReadinessResponse'
          description: Resumo de prontidão para ativação.
        schedules:
          $ref: '#/components/schemas/SetupProgressSchedulesResponse'
          description: Contagem de agendamentos do contexto.
        sources:
          $ref: '#/components/schemas/SetupProgressSourcesResponse'
          description: Contagens de origem divididas por lado de correspondência.
        status:
          description: >-
            Status atual do ciclo de vida do contexto. DRAFT está sendo
            configurado; ACTIVE executa; PAUSED está suspenso; ARCHIVED está
            aposentado.
          enum:
            - DRAFT
            - ACTIVE
            - PAUSED
            - ARCHIVED
          examples:
            - DRAFT
          type: string
      required:
        - contextId
        - status
        - sources
        - fieldMaps
        - matchRules
        - schedules
        - lastRun
        - readiness
      type: object
    Detail:
      additionalProperties: false
      properties:
        code:
          description: >-
            Código de erro de domínio estável e legível por máquina com escopo
            no serviço emissor (formato: <SERVICE>-NNNN).
          examples:
            - ERR-0001
          type: string
        detail:
          description: >-
            Uma explicação legível por humanos específica para esta ocorrência
            do problema.
          examples:
            - Property foo is required but is missing.
          type: string
        errors:
          description: Lista opcional de detalhes de erro individuais
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type:
            - array
            - 'null'
        instance:
          description: >-
            Uma referência URI que identifica a ocorrência específica do
            problema.
          examples:
            - https://example.com/error-log/abc123
          format: uri
          type: string
        status:
          description: Código de status HTTP
          examples:
            - 400
          format: int64
          type: integer
        title:
          description: >-
            Um resumo curto e legível por humanos do tipo do problema. Este
            valor não deve mudar entre ocorrências do erro.
          examples:
            - Bad Request
          type: string
        type:
          default: about:blank
          description: >-
            Uma referência URI para documentação legível por humanos sobre o
            erro.
          examples:
            - https://example.com/errors/example
          format: uri
          type: string
      type: object
    SetupProgressFieldMapsResponse:
      additionalProperties: false
      properties:
        mappedSources:
          description: Número de origens que têm um mapa de campo configurado.
          examples:
            - 2
          format: int64
          type: integer
      required:
        - mappedSources
      type: object
    SetupProgressLastRunResponse:
      additionalProperties: false
      properties:
        completedAt:
          description: >-
            Timestamp de conclusão no formato RFC 3339; omitido enquanto a
            execução está em andamento.
          examples:
            - '2025-01-15T10:30:00Z'
          type: string
        id:
          description: Identificador da execução de correspondência.
          examples:
            - 550e8400-e29b-41d4-a716-446655440000
          type: string
        status:
          description: >-
            Status da execução. PROCESSING está em andamento; COMPLETED terminou
            com sucesso; FAILED terminou em erro.
          enum:
            - PROCESSING
            - COMPLETED
            - FAILED
          examples:
            - COMPLETED
          type: string
      required:
        - id
        - status
      type: object
    SetupProgressMatchRulesResponse:
      additionalProperties: false
      properties:
        total:
          description: Número total de regras de correspondência no contexto.
          examples:
            - 3
          format: int64
          type: integer
      required:
        - total
      type: object
    SetupProgressReadinessResponse:
      additionalProperties: false
      properties:
        missing:
          description: >-
            Slugs estáveis de requisitos ausentes (sources_left, sources_right,
            field_maps, match_rules); vazio quando pronto.
          examples:
            - - sources_left
              - match_rules
          items:
            type: string
          type:
            - array
            - 'null'
        ready:
          description: >-
            Verdadeiro quando o contexto satisfaz todos os requisitos de
            ativação.
          examples:
            - true
          type: boolean
      required:
        - ready
        - missing
      type: object
    SetupProgressSchedulesResponse:
      additionalProperties: false
      properties:
        total:
          description: Número total de agendamentos no contexto.
          examples:
            - 1
          format: int64
          type: integer
      required:
        - total
      type: object
    SetupProgressSourcesResponse:
      additionalProperties: false
      properties:
        left:
          description: Número de origens do lado LEFT.
          examples:
            - 1
          format: int64
          type: integer
        right:
          description: Número de origens do lado RIGHT.
          examples:
            - 1
          format: int64
          type: integer
        total:
          description: Número total de origens no contexto.
          examples:
            - 2
          format: int64
          type: integer
      required:
        - total
        - left
        - right
      type: object
    ErrorDetail:
      additionalProperties: false
      properties:
        location:
          description: 'Onde o erro ocorreu, ex.: ''body.items[3].tags'' ou ''path.thing-id'''
          type: string
        message:
          description: Texto da mensagem de erro
          type: string
        value:
          description: O valor na localização informada
      type: object
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: 'Autenticação por Bearer token (formato: "Bearer {token}")'

````