Obter conteúdo da URL
Obtém o conteúdo de um serviço REST.
Parâmetros de Entrada
Nome | Tipo | Doc |
---|---|---|
Parâmetro 1 | String | Método de requisição |
Parâmetro 2 | String | Tipo do conteúdo |
Parâmetro 3 | String | Endereço URL a ter conteúdo obtido |
Parâmetro 4 | Mapa | Parâmetros a serem utilizados como filtros da requisição. É necessário passar um objeto JSON com objetos para cada parâmetro. |
Parâmetro 5 | Mapa | Objeto com atributos a serem tratados pelo serviço. É necessário passar um objeto JSON com os atributos. |
Parâmetro 6 | Mapa | Mapa com o corpo a ser adicionado a requisição |
Parâmetro 7 | String | Endereço e nome do arquivo. Esse campo deve ser utilizado quando o retorno for um array de bytes referente a um arquivo. |
Parâmetro 8 | String | Retorna o tipo de resposta desejada, podendo ser Body, Stream ou Status. |
A partir da versão do cronapi-2.8.16
, o parâmetro Parâmetro passa a montar a query string e o parâmetro Dados para postagem passa a executar e montar os parâmetros no post body.
Retorno
Retorna uma String com o conteúdo da URL.
Compatibilidade
Servidor
Exemplo 1
A função abaixo faz uma requisição GET em um serviço web e utiliza a entrada Parâmetros para realizar um filtro. O conteúdo obtido pela requisição é impresso no Console do Depurador.
Figura 1 - Exemplo de requisição utilizando o bloco Obter conteúdo da URL
Exemplo 2
Também é possível realizar uma requisição que retorna um array de bytes de arquivo.
O exemplo abaixo faz uma requisição que retorna um arquivo (logo.img), usamos o parâmetro Caminho do arquivo (destaque 1 da figura 2) para informar o local onde será salvo este conteúdo "Pasta da aplicação/logo-Cronapp.png" (destaque 2 da figura 2).
Figura 2 - Exemplo de requisição com array de bytes
Sobre o protocolo HTTP
Hypertext Transfer Protocol (HTTP) é o método utilizado para enviar e receber informações na web. Este protocolo é baseado em requisições e respostas entre clientes e servidores.
Mais sobre
Sobre URL - Localizador Uniforme de Recursos
Um URL se refere ao endereço de rede no qual se encontra algum recurso a ser acessado, como por exemplo uma página de internet, um arquivo de computador. Este acesso pode ser feito via Internet, por uma rede corporativa (como uma intranet) e etc.
Mais sobre
Sobre URI - Identificador Uniforme de Recursos
Uniform Resource Identifier (em inglês) é a uma cadeia de caracteres compacta usada para identificar ou denominar um recurso na Internet. O principal propósito desta identificação é permitir a interação com representações do recurso através de uma rede usando protocolos específicos.
Mais sobre
Sobre os métodos de requisição
A obtenção de cabeçalhos do URL pode ser feito utilizando os métodos:
- GET: solicita uma representação de dados de um recurso específico
- POST: submete dados a serem processados para um recurso específico
- PUT: requisita que uma entidade seja armazenada embaixo do URI fornecido. Se o URI se refere a um recurso que já existe, ele é modificado; se o URI não aponta para um recurso existente, então o servidor pode criar o recurso com esse URI.
- DELETE: apaga o recurso especificado.
- PATCH: utilizado para aplicar modificações parciais em um recurso.
- HEAD: solicita uma resposta de forma idêntica ao método
GET
, porém sem conter o corpo da resposta. - OPTIONS: usado para descrever as opções de comunicação com o recurso de destino.
- TRACE: executa um teste de chamada loop-back junto com o caminho para o recurso de destino.
Figura 3 - Métodos de Requisição
Acesse Métodos de requisição HTTP para maiores informações.
Sobre os tipos de conteúdo
A codificação URL é frequentemente utilizada no envio de formulários web através de uma requisição POST. A codificação padrão empregada nesse envio é a "x-www-form-urlencoded". Este é um formato para codificação de pares chave-valor. Cada par chave-valor é separado por um caractere '&' e cada chave é separada de seu valor por um caractere '='. Chaves e valores são ambos espaçados pela substituição de espaços com o caractere '+' e então utilização de codificação de URL em todos os caracteres não-alfanuméricos.
Mais sobre
JSON é um acrônimo para "JavaScript Object Notation". Um formato de padrão aberto que utiliza texto legível a humanos para transmitir objetos de dados consistindo de pares chave-valor. É o formato de dados mais comumente utilizado para comunicação assíncrona navegador/servidor.
Mais sobre
Os itens mostrados na figura 3 são conhecidos por MIME Type, Clique a aqui para saber mais sobre.
Figura 4 - Tipos de conteúdo