report

Exportar relatorio bloqueante (padrao de integracao)

PADRAO DE INTEGRACAO, use quando voce esta ajudando um desenvolvedor a implementar integracao com cliente HTTP que suporta timeout longo (>= 6 min). Para um usuario apenas exportando no chat, use export_report_and_wait.

O endpoint BLOQUEIA ate a geracao concluir e responde 202 com o registro da exportacao (link em url). Use timeout longo no cliente HTTP.

Para fluxo interativo de agente, prefira export_report_and_wait (timeout previsivel de 2min, com aviso quando relatorio nao esta finalizado). Para integracao com webhook, use export_report_via_webhook.

get/report/export-sync/{id}

Request

  • Base URL: https://gyra-core.gyramais.com.br
  • URL: https://gyra-core.gyramais.com.br/report/export-sync/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

ID do relatorio a exportar.

Query parameters

type'REPORT' | 'REPORT_MINIFIED' required

Obrigatorio. Use REPORT. Sem ele, a resposta e 400.

exportFormat'pdf' | 'excel' | 'both'

pdf (padrao) ou excel. both nao e suportado nesta rota: use a exportacao assincrona.

sectionOrderstring[]

Secoes do arquivo, na ordem desejada. Repita o parametro para cada secao. Sem ele, valem as secoes e a ordem do modelo.

templateIdstring

ID de um modelo de exportacao da organizacao.

systemTemplate'COMPLETE' | 'COMPACT'

Modelo nativo de exportacao.

Response

Registro da exportacao, com o arquivo ja pronto. O link esta em url.

idstring
urlstring

Link do arquivo gerado.

userIdstring
organizationIdstring
typeIdstring
createdAtstring date-time
updatedAtstring date-time

Changes

No recorded changes to this operation across all 1 revision of this API.