Fluxos de trabalho públicos da API do Use Case Manager
Use esses fluxos de trabalho para fazer download de dados do relatório para arquivos CSV ou JSON. Para o formato JSON, é possível optar por gerar um formato paginado ou um relatório completo Arquivos paginados são úteis para locais onde você precisa de JSON, como a interface com o usuário, e você precisa paginar através dos resultados. Você pode solicitar página por página e não todo o conjunto de resultados. Arquivos de relatório completos são mais rápidos para download do que o corpo JSON, mas a paginação não está disponível no formato de download de arquivo.
Selecione um fluxo de trabalho para baixar dados do relatório.
- Gerar um resultado paginado em JSON
- Gerar e baixar relatórios no CSV
- Gerar e baixar relatórios em JSON
- Dados do relatório de download
Fluxo de trabalho para gerar um resultado paginado em JSON
| Terminal | Descrição |
|---|---|
| POST /api/use_case_explorer | Gera um relatório Explorador de caso de uso e retorna um reportId. Deve-se usar esse terminal primeiro ao iniciar a geração de relatórios. Preencha o corpo da solicitação com colunas de relatório e quaisquer filtros ou agrupamentos de tabelas que desejar no relatório gerado. Use o valor de reportId retornado em outras chamadas da API no fluxo de trabalho. |
| GET /api/use_case_explorer/{reportId}/status | Retorna o status de /api/use_case_explorer. Use o terminal para ver se sua geração de relatório foi bem-sucedida ou falhou. |
| GET /api/use_case_explorer/{reportId}/result | Retorna o resultado de /api/use_case_explorer em uma matriz JSON paginada. Inclua o valor reportId retornado do terminal /api/use_case_explorer no caminho para obter seu resultado. |
Fluxo de trabalho para gerar e fazer download de relatórios em CSV
Gerar o relatório completo do Use Case Explorer em formato CSV. Esse fluxo de trabalho é um processo de 5 etapas que usa os terminais de API na ordem descrita na tabela a seguir:
| Terminal | Descrição |
|---|---|
| POST /api/use_case_explorer | Gera um relatório Explorador de caso de uso e retorna um reportId. Deve-se usar esse terminal primeiro ao iniciar a geração de relatórios. Preencha o corpo da solicitação com colunas de relatório e quaisquer filtros ou agrupamentos de tabelas que desejar no relatório gerado. Use o valor de reportId retornado em outras chamadas da API no fluxo de trabalho. |
| GET /api/use_case_explorer/{reportId}/status | Retorna o status de /api/use_case_explorer. Use o terminal para ver se sua geração de relatório foi concluída ou falhou. |
| POST /api/use_case_explorer/{reportId}/download_csv | Inicia o download de um arquivo CSV do relatório do Explorador de caso de uso. Inclua o valor reportId do /api/use_case_explorer result no caminho e preencha o corpo da solicitação com seus códigos de coluna, parâmetros de classificação, IDs de regra ou parâmetros de procura selecionados para obter um jobId. |
| GET /api/use_case_explorer/download_csv/{jobId}/status | Verifica o status de uma tarefa de download do arquivo CSV do relatório do Explorador de caso de uso. Inclua o valor jobId retornado do terminal /api/use_case_explorer/{reportId}/download_csv no caminho para obter um status sobre se a tarefa foi concluída ou falhou. |
| GET /api/use_case_explorer/download_csv/{jobId}/result | Retornará o relatório do Explorador de caso de uso em um arquivo CSV se o terminal /api/use_case_explorer/download_csv/{jobId}/status retornar um status 'Concluído'. Inclua o valor jobId retornado pelo terminal /api/use_case_explorer/{reportId}/download_csv e o nome desejado para o arquivo CSV na consulta para obter um link de download para o arquivo CSV. |
Fluxo de trabalho para gerar e fazer download de relatórios em JSON
Gere o relatório Explorador de caso de uso como uma matriz JSON em um formato de relatório completo. Esse fluxo de trabalho será útil se você desejar fazer download de todo o conjunto de resultados porque o arquivo JSON é mais rápido para download do que o corpo JSON. A paginação não está disponível no formato de download do arquivo O fluxo de trabalho é um processo de 5 etapas que usa os terminais de API na ordem descrita na tabela a seguir:
| Terminal | Descrição |
|---|---|
| POST /api/use_case_explorer | Gera um relatório Explorador de caso de uso e retorna um reportId. Deve-se usar esse terminal primeiro ao iniciar a geração de relatórios. Preencha o corpo da solicitação com colunas de relatório e quaisquer filtros ou agrupamentos de tabelas que desejar no relatório gerado. Use o valor de reportId retornado em outros terminais de API no fluxo de trabalho. |
| GET /api/use_case_explorer/{reportId}/status | Retorna o status de /api/use_case_explorer. Use o terminal para ver se sua geração de relatório foi bem-sucedida ou falhou. |
| POST /api/use_case_explorer/{reportId}/download_json | Faz download do relatório do Explorador de caso de uso como um arquivo JSON. Inclua o valor reportId do terminal /api/use_case_explorer no caminho e preencha o corpo com seus códigos de coluna, parâmetros de classificação, IDs de regra ou parâmetros de procura selecionados para obter um jobId. |
| GET /api/use_case_explorer/download_json/{jobId}/status | Verifica o status de uma tarefa de download do arquivo JSON do relatório do Explorador de caso de uso. Inclua o valor jobId retornado do terminal /api/use_case_explorer/{reportId}/download_json no caminho para obter um status sobre se a tarefa foi concluída ou falhou. |
| GET /api/use_case_explorer/download_json/{jobId}/result | Retorna o resultado final do arquivo JSON do Explorador de caso de uso depois que o terminal /api/use_case_explorer/download_json/{jobId}/status retorna um status 'Concluído'. Inclua o valor jobId retornado pelo terminal /api/use_case_explorer/{reportId}/download_json e o nome desejado para o arquivo JSON na consulta para obter um link de download para o arquivo JSON. |