Versões comparadas
Chave
- Esta linha foi adicionada.
- Esta linha foi removida.
- A formatação mudou.
Índice:
Objetivo:
Este documento tem por objetivo especificar a atividade “Executar Requisição REST” disponível na Fórmula Visual.
Especificação:
A atividade “Executar Requisição REST” permite que a fórmula visual execute uma requisição utilizando o protocolo HTTP(S) e o padrão REST com formato JSON. Esta requisição de ser feita utilizando qualquer método HTTP (GET, POST, ETC) e permite que os dados retornados pela requisição sejam consumidos pela fórmula.
É possível ainda definir o tipo de autenticação da requisição que pode ser básica (informando um usuário e senha) ou baseada em Tokens (informando o schema e token).
Parâmetros da Requisição
Nome | Descrição |
Endereço da Requisição | Informe o endereço do servidor para executar a requisição. O endereço deve ser informado completo inclusive com o protocolo que pode ser HTTP ou HTTPS. É possível criar parâmetros para montagem do endereço, informando os valores entre <>. Exemplo: https://www.google.com/search?q=<texto> Neste caso será criada uma propriedade dinâmica para que seja informado o conteúdo do parâmetro <texto>. |
Método de Requisição | Selecione o método HTTP que será utilizado para fazer a requisição, os métodos disponíveis são Get, Head, Post, Put, Delete e Patch. |
Tempo Limite | Informe um tempo limite para execução da requisição em segundos. Caso este tempo seja ultrapassado será gerado um erro de timeout. |
Utilizar Proxy do Sistema | Selecione se a requisição deverá utilizar a configuração padrão de proxy do Windows. Image Modified |
Definição da Requisição
Nome | Descrição |
JSON (Requisição) | Informe um texto no formato JSON que será utilizado para fazer a requisição ao servidor. Este texto poderá conter parâmetros para montagem do JSON que deverão ser informados entre <>. Image Modified Propriedades dinâmicas geradas: Image Modified |
JSON (Resposta) | Informe um texto no formato JSON, contendo um exemplo de JSON que é retornado pelo servidor, que será utilizado para gerar a estrutura de tabelas e campos do retorno da requisição. |
Segurança/Autenticação
Nome | Descrição |
Tipo de Autenticação | Selecione o tipo de autenticação da requisição, que pode ser:
|
Usuário | Informe o nome do usuário que será utilizado pela autenticação básica. |
Senha | Informe a senha do usuário que será utilizado pela autenticação básica. |
Token | Informe os dados do Token que será utilizado pela autenticação via Token. |
Token Schema | Informe o Schema do Token que será utilizado pela autenticação via Token. São exemplos de schema BEARER, OASIS e outros. |
Tipo de Conteúdo
Nome | Descrição do Parâmetro |
Codificação do Texto da Requisição | Informe o tipo de codificação utilizado para codificar/decodificar os textos da requisição. Por padrão será utilizado a formato UTF-8. Para mais informações consulte: https://msdn.microsoft.com/pt-br/library/system.text.encoding(v=vs.110).aspx |
Tipo de Conteúdo Aceito | Informe o tipo de conteúdo MIME aceito como retorno da requisição. Por padrão será aceito qualquer tipo de conteúdo, porém alguns servidores Web exigem que o tipo de conteúdo aceito seja informado (Header HTTP Accept). Para mais informações consulte: https://developer.mozilla.org/pt-BR/docs/Web/HTTP/Headers/Accept |
Tipo de Conteúdo da Requisição | Informe o tipo de conteúdo MIME que será enviado nos dados da requisição (Header HTTP Content-Type). Por padrão o sistema irá utilizar o tipo “application/json”. Para mais informações consulte: https://developer.mozilla.org/pt-BR/docs/Web/HTTP/Headers/Content-Type |
Resposta
As propriedades de resposta contêm os dados retornados pela execução da requisição.
Nome | Descrição do Parâmetro |
Resposta (Código) | Contém o código HTTP da resposta do servidor. |
Resposta (Texto) | Contém o conteúdo da resposta da requisição no formato de texto, caso o tipo da resposta (Content-Type: “text”), em formato texto. |
Dados da Leitura | Contém uma fonte de dados com os dados do retorno da requisição, caso a tipo da resposta (Content-Type: “application/json”), em formato de tabelas/colunas. A propriedade JSON (Retorno) será utilizada para geração da estrutura da fonte de dados. Dica: Utilize a atividade de Transformar Registro em XML e gere um erro com a estrutura de tabelas da requisição). Image Modified |
Tabelas | Provê acesso aos dados retornados pela requisição no formato de tabela/coluna. |
Campos | Provê acesso aos dados da tabela principal retornada pela requisição. |
Informações | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||
|
Informações | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||
|