API Reference

Resultado do workflow

Retorna o resultado completo da execução de um workflow, incluindo input, output e histórico de execução.


ParâmetroTipoDescrição
workflowIdstring (path)Identificador único do workflow para consulta.
jobIdstring (path)Identificador único da execução do workflow para consulta.

Autenticação

Todos os endpoints da Sinky Studio exigem um header de API Key:

  • x‑api-key: sua-api-key-aqui

O valor deve ser obtido no painel administrativo da sua conta.


Requisição

Este endpoint não requer corpo na requisição. Apenas os parâmetros jobId e workflowId na URL é necessário.


Resposta

A API devolve um objeto JSON contendo o relatório completo da execução, incluindo informações sobre erros e status detalhado:

CampoTipoDescrição
jobIdstringIdentificador da execução consultada.
workflowIdstringIdentificador do workflow executado.
statusstringStatus final da execução (ex.: completed, failed, running).
startTimestringData/hora de início da execução (ISO-8601).
endTimestringData/hora de término da execução (ISO-8601).
executionTimenumberTempo total de execução em milissegundos.
inputDataobjectDados de entrada utilizados na execução.
outputDataobjectDados de saída gerados pela execução (se concluída).
errorsarrayLista de erros ocorridos durante a execução.
nodeExecutionsarrayDetalhes da execução de cada nó do workflow.

Estrutura detalhada

errors
CampoTipoDescrição
nodeIdstringIdentificador do nó onde ocorreu o erro.
messagestringMensagem descritiva do erro.
timestampstringData/hora do erro (ISO-8601).
detailsobjectInformações adicionais sobre o erro.
nodeExecutions
CampoTipoDescrição
nodeIdstringIdentificador único do nó.
nodeNamestringNome descritivo do nó.
nodeTypestringTipo do nó (ex.: input, decision, decision-table, ruleset, variable, custom-api, integration, database, ml).
statusstringStatus da execução do nó.
startTimestringData/hora de início da execução do nó.
endTimestringData/hora de término da execução do nó.
executionTimenumberTempo de execução do nó em milissegundos.
inputDataobjectDados de entrada do nó.
outputDataobjectDados de saída do nó.
errorsarrayErros específicos do nó (se houver).

Observações

  • Se a execução não for encontrada, a API retornará um erro 404 com mensagem explicativa.
  • O relatório inclui informações detalhadas sobre cada etapa da execução, facilitando a depuração e análise.
  • Execuções em andamento retornarão informações parciais até o momento da consulta.
  • O campo errors pode estar vazio se a execução foi bem-sucedida.

cão

Language
Credentials
Header
Click Try It! to start a request and see the response here!