Todos os produtos
Search
Central de documentação

Qoder CN Series:Get schedule run

Última atualização: Jul 15, 2026

Recupera uma única execução de agendamento pelo ID.

GET /api/v1/forward/schedule_runs/{run_id}

Retorna um único registro de execução de agendamento. É possível passar identity_id como uma restrição adicional de propriedade.

Cabeçalhos da requisição

Cabeçalho

Obrigatório

Descrição

Authorization

Sim

Bearer <PAT>

Parâmetros de caminho

Parâmetro

Tipo

Obrigatório

Descrição

run_id

string

Sim

ID da execução de agendamento.

Parâmetros de consulta

Parâmetro

Tipo

Obrigatório

Padrão

Descrição

identity_id

string

Não

-

Restrição adicional de propriedade.

Exemplo de requisição

curl -s -X GET 'https://api.qoder.com.cn/api/v1/forward/schedule_runs/srun_019f00112233445566778899aabbccdd' \
  -H "Authorization: Bearer $QODER_PAT"

Exemplo de resposta

HTTP 200 OK

{
  "id": "srun_019f00112233445566778899aabbccdd",
  "schedule_id": "sched_019f00112233445566778899aabbccdd",
  "identity_id": "idn_019eabc123",
  "template_id": "tmpl_support",
  "session_id": "sess_019ec55a68b37e1e8d660691af161ab4",
  "status": "completed",
  "trigger_context": {
    "type": "schedule",
    "scheduled_at": "2026-06-22T01:00:00Z"
  },
  "result_payload": "Today's technology highlights: ...",
  "push_sink": "im_channel",
  "push_status": "succeeded",
  "push_finished_at": "2026-06-22T01:00:21Z",
  "attempt": 1,
  "triggered_at": "2026-06-22T01:00:00Z",
  "started_at": "2026-06-22T01:00:03Z",
  "completed_at": "2026-06-22T01:00:20Z",
  "duration_ms": 17000,
  "created_at": "2026-06-22T01:00:00Z"
}

Campos da resposta

Campo

Tipo

Descrição

id

string

ID da execução de agendamento.

schedule_id

string

ID do agendamento pai.

identity_id

string

ID da identidade de encaminhamento.

template_id

string

ID do modelo de encaminhamento.

session_id

string \

null

Sessão criada ou utilizada nesta execução.

status

string

pending, running, completed, failed ou skipped.

trigger_context

object

Origem do gatilho.

error

object \

null

Erro estruturado para execuções com falha ou ignoradas.

result_payload

string \

null

Resultado em texto do fluxo principal de execução.

error_message

string \

null

Mensagem de erro legível; os detalhes estruturados estão em error.

push_sink

string \

null

Tipo de destino usado para entrega via IM; null se a entrega não estiver configurada.

push_status

string

Status de entrega via IM: pending, succeeded, failed ou skipped. O status do fluxo principal e o status de entrega são independentes.

push_finished_at

string \

null

Horário de conclusão da entrega via IM.

attempt

integer

Número sequencial da tentativa; atualmente 1.

triggered_at

string

Horário do gatilho.

started_at

string \

null

Horário de início da execução.

completed_at

string \

null

Horário de conclusão.

duration_ms

integer \

null

Duração da execução em milissegundos.

created_at

string

Horário de criação do registro.

Objeto Trigger Context

type

Descrição

schedule

Acionado automaticamente pela trigger_policy do agendamento, como cron, once ou interval. Retorna scheduled_at para gatilhos automáticos.

manual

Acionado manualmente via POST /api/v1/forward/schedules/{schedule_id}/run.

Objeto Run Error

O objeto error representa uma falha estruturada ou motivo de interrupção. Pode ser retornado quando status=failed ou status=skipped; é null quando status=completed.

error.type

Descrição

concurrency_limit_reached

O mesmo agendamento atingiu execution.max_concurrent_runs. O gatilho foi registrado, mas não será executado.

session_creation_failed

Falha ao criar ou vincular uma sessão de encaminhamento.

execution_failed

A execução do modelo falhou.

Erros

HTTP

Tipo

Código

Condição de acionamento

404

not_found_error

schedule_run_not_found

A execução não existe, é cross-tenant ou não atende à restrição de identity_id.

401

authentication_error

authentication_required

O PAT é inválido ou expirou.

Observações

  • error.type=concurrency_limit_reached indica que o gatilho foi registrado, mas ignorado devido aos limites de concorrência.

  • Consulte este endpoint periodicamente até que o status atinja um estado terminal.