Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Bloco de código
themeRDark
titleBody
{
  "pCodEscr": ["SP001", "SP001SP003"],
  "pCodFatura": "000000180180",
  "pCodData": "09/02/2002"
  "pAtivo": "Sim"
  "pNomeSocio": "Isabelle Silva"
}

...

Depois que o cadastro de um relatório foi feito, para que ele seja disparado em alguma extensão do produto é preciso fazer a integração para ativar a geração do mesmo, sendo assim, é preciso utilizar o hyperlink que monta os links disponíveis para integração com visualizador.
Para iniciar o fluxo precisamos ter conhecimento do id de relatório que desejamos executar, caso não saiba essa informação, utilizaremos a busca de relatório para buscar essa informação.

Busca de Relatório

...

Como já foi dito anteriormente, a A "busca de relatório" é uma API que retorna os relatórios cadastrados no sistema, é possível buscar apenas os relatórios em que o usuário tem permissão de acesso, sejam eles de sua própria criação, compartilhados via pasta ou compartilhamento único. Assim como na interface do sistema, a busca possui a funcionalidade de filtro onde é necessário enviar no mínimo 3 caracteres para pesquisa, dessa forma, os relatórios que tiverem esses caracteres em comum em seu nome de exibição ou descrição serão retornados. 

...

Abaixo temos um exemplo da lista de relatórios retornados pela API, utilizaremos o relatório com id: a4127383cd767d3f-3229ec71-420f4c1a-bd478143-c795c2af5ebdc6645dd8f63c como exemplo para dar continuidade em nosso fluxo de uso na próxima etapa.

Bloco de código
themeRDark
titleResponse Body
[	
	{
        "id": "a4127383-3229-420f-bd47-c795c2af5ebd",
        "displayName": "Recibo de Fatura (JU203b) ",
        "description": "Recibo de Fatura (JU203b) - Grupo de Estudos",
        "navigationFolderId": 1
    },
    {
        "id": "cd767d3f-ec71-4c1a-8143-c6645dd8f63c",
        "displayName": "Recibo de Fatura\"",
        "description": "Recibo de Fatura\"",
        "navigationFolderId": null
    },
    {
        "id": "e30288af-6989-4a30-9792-3c7f5735db56",
        "displayName": "Relatorio sem fitro de casos",
        "description": null,
        "navigationFolderId": null
    }
]

Hyperlinks para integração

...

Os links retornados na requisição de Hyperlinks são utilizados para visualização da integração feita integrações feitas com o sistema, dessa forma é possível enviar uma URL pronta para ativação de geração de um relatório em qualquer ponta do produto.
O endpoint que utilizaremos para esse fluxo:

...

Para utilizar essa requisição vamos precisar de um ID de um relatório existente, nesse caso, utilizaremos o ID buscado na requisição de buscaa4127383cd767d3f-3229ec71-420f4c1a-bd478143-c795c2af5ebdc6645dd8f63c

Os demais parâmetros podem ser informados por meio de QueryString ou diretamente na URL retornada. Esses parametros são as informações do token do usuário que irá abrir a interface da integração, essas informações são utilizadas para realizar contextualização e verificação de permissões.

...