/
Obter conteúdo da URL (Cliente) / Get URL content (Client)

Obter conteúdo da URL (Cliente) / Get URL content (Client)

Realiza uma requisição REST a partir do recurso (URL) informado. 

 

Figura 1 - Bloco Obter conteúdo da URL

Compatibilidade

  • Bloco cliente: cronapi.util.getURLFromOthers()

Retorno

O bloco não possui retorno. No entanto, o resultado da requisição pode ser obtido por meio da variável de retorno "item".

Parâmetros

Método da requisição

Permite selecionar o verbo HTTP do recurso.

  • Posição: 1

  • Inglês: Request Method

  • Tipo: Objeto / Object

  • Exemplo: "GET"

  • Opções: 

    • GET: solicita uma representação de dados de um recurso específico.

    • POST: submete dados a serem processados para um recurso específico.

    • PUT: usado para enviar dados ao servidor para criar ou atualizar um recurso específico. O corpo da requisição contém os dados a serem armazenados ou atualizados. Se o recurso não existir, ele pode ser criado; se já existir, ele será atualizado com os novos dados.

    • 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.

Acesse Métodos de requisição HTTP para maiores informações.

Tipo de conteúdo

Define o formato passado no corpo da requisição. Em geral, esse parâmetro é mais utilizado em requisições do tipo PUT e POST.

  • Posição: 2

  • Inglês: Content Type

  • Tipo: Texto / String

  • Exemplo: "application/x-www-form-urlencoded"

  • Opções:

    • application/json: objeto JSON.

    • application/x-www-form-urlencoded: formato para codificação de pares chave-valor. Veja mais detalhes sobre este formato em POST.

Endereço URL

Endereço UL da requisição REST.

Parâmetro

Parâmetros a serem utilizados como filtros da requisição. É necessário passar um mapa (ou objeto JSON) com atributo para cada parâmetro. Para isso, utilize o retorno bloco criar mapa com.

  • Posição: 4

  • Inglês: Parameters

  • Tipo: Map / Mapa

  • Exemplo: "{"id":"345678"}"

Cabeçalho de requisição

Objeto com atributos a serem tratados pelo serviço. É necessário passar um mapa (ou objeto JSON) com os atributos. Para isso, utilize o retorno bloco criar mapa com.

  • Posição: 5

  • Inglês: Headers

  • Tipo: Map / Mapa

  • Exemplo: "{"X-AUTH-TOKEN":"eyJhbGMiJ9.eyJzdWIsI..."}"

Sucesso

Executa uma ação quando a requisição for realizada com sucesso.

  • Posição: 6

  • Inglês: Success

  • Tipo: Comando com retorno ("item") / Command with return ("item")

  • Exemplo: uso do bloco Exibir notificação

Erro

Executa uma ação quando ocorre um erro.

  • Posição: 7

  • Inglês: Error

  • Tipo: Comando com retorno ("item") / Command with return ("item")

  • Exemplo: uso do bloco Exibir notificação

Exemplo

No exemplo da imagem abaixo, por meio do bloco Obter conteúdo da URL estamos fazendo uma requisição a uma API pública que retornará os dados de um usuário.

Figura 2 - Exemplo de uso do bloco Obter conteúdo da URL

Na imagem a seguir, podemos visualizar o resultado de execução da função da Figura 2.

Figura 2.1 - Resultado de execução da função da Figura 2

Nesta página