Acompanhar trabalhos

Estados do ciclo de vida

Consulte o trabalho

Use limit e offset para resultados grandes. O padrão é 50 e o máximo de limit é 200.

{
  "schemaVersion": "3.0",
  "jobId": "job_exemplo_01",
  "type": "invoice_sync_latest",
  "status": "running",
  "dist": "CELESC",
  "connectionId": "conn_exemplo_123",
  "target": {
    "uc": "154026601110",
    "count": 5
  },
  "progress": {
    "total": 5,
    "completed": 4,
    "failed": 0
  },
  "createdAt": "2026-08-24T14:00:00Z",
  "startedAt": "2026-08-24T14:00:04Z"
}

Percorra todas as páginas do resultado

Suponha que um uc_discovery tenha result.count: 600. A consulta com limit=200&offset=0 retorna os primeiros 200 itens. Se result.pagination.hasMore for true, consulte o mesmo trabalho com o próximo offset:

Se essa página ainda retornar hasMore: true, faça a terceira consulta com offset=400. Encerre quando hasMore for false.

A regra é próximo offset = pagination.offset + pagination.limit. Veja o exemplo JavaScript completo.

Trate partial_success

Leia os itens presentes em result.items. Em seguida, use error.code, error.retryable e error.details para decidir a próxima ação. Um job_timeout pode terminar assim quando parte do resultado já estava disponível.

Cancele quando necessário

Um trabalho ainda aguardando retorna cancelled. Um trabalho em execução retorna cancelling; continue consultando até o estado terminal. Um trabalho já terminal retorna job_not_cancellable.