Configurando o método HTTP, o URL e os Parâmetros de URL

Especifique o método HTTP e o URL da solicitação REST a ser executada e configure quaisquer parâmetros de URL para a tarefa REST.

Os procedimentos a seguir também podem ser usados ao inserir (ou editar) o URL de sondagem opcional e o URL de encerramento.

Configurando o Método HTTP e o URL

Trata-se de um método HTTP padrão, como GET ou POST. O URL é o ponto final da API REST para o recurso a ser acessado na solicitação REST.

Por exemplo, o seguinte ponto final REST lista os ativos de dados no ID de espaço de trabalho finance123:

http://myserver.com:8081/workspaces/finance123/dataAssets

O URL pode incluir parâmetros usando a sintaxe ${}. Por exemplo, o ponto final REST a seguir lista os ativos de dados em um espaço de trabalho usando a sintaxe de parâmetro para as seções de variáveis do URL que especificam o host do servidor e o ID do espaço de trabalho.

http://${myserver}:8081/workspaces/${workspaceId}/dataAssets

Quando você especifica partes do URL usando a sintaxe de parâmetro, essas partes são convertidas em parâmetros de URL de String para a tarefa REST. Um valor padrão deve ser designado a cada parâmetro de URL.

Quando a tarefa for executada, você poderá alterar os valores desses parâmetros de URL. Por exemplo, no runtime, você pode fornecer diferentes valores para o servidor e o ID do espaço de trabalho.

O procedimento a seguir também pode ser usado para inserir (ou editar) o URL de sondagem opcional e o URL de encerramento.

Para configurar o método HTTP e o URL:

  1. Na etapa Definir detalhes da execução da página Configurar Detalhes da API REST, em método HTTP, selecione o método HTTP a ser usado para o URL dessa tarefa REST.

    Para configurar o URL de sondagem e o URL de encerramento opcionais, vá para a etapa Especificar critérios de conclusão, selecione a guia Sondagem ou Encerramento e selecione o método HTTP. Observe que as guias Sondagem e Encerramento só aparecem quando a caixa de seleção Configurar uma condição de sondagem e encerramento para uma chamada REST sem espera está selecionada.

  2. No campo URL, digite o URL completo e pressione Enter.

    Se a sintaxe do parâmetro ${} for usada para partes do URL, essas partes serão convertidas em parâmetros de URL para a tarefa REST.

    A tabela na guia Parâmetros de URL abaixo do campo de URL é atualizada com as partes parâmetros. O tipo de dados padrão para cada parâmetro de URL é String.

    Para designar um valor padrão a cada parâmetro de URL, consulte Configurando Parâmetros de URL. Você pode alterar o tipo de dados e adicionar uma descrição a cada parâmetro.

  3. Se você editar o URL a qualquer momento adicionando ou removendo a sintaxe de parâmetro, a tabela de parâmetros de URL será atualizada adequadamente.
Configurando Parâmetros de URL

Depois de digitar (ou editar) o URL e pressionar Enter, qualquer seção no URL que use a sintaxe de parâmetro ${} será convertida em parâmetros de URL para a tarefa REST.

O tipo de dados padrão de todos os parâmetros de URL recém-adicionados é String. Na guia Parâmetros de URL, você pode adicionar valores padrão para os parâmetros de tarefa REST e também alterar o tipo de dados de parâmetro, se necessário.

O procedimento a seguir também pode ser usado para editar parâmetros de URL para o URL de sondagem opcional e o URL de encerramento.

Para configurar parâmetros de URL:

  1. Na etapa Definir detalhes do processo da página Configurar detalhes do API REST, selecione a guia Parâmetros de URL.

    Para configurar parâmetros de URL para o URL de sondagem e encerramento opcional, vá para a etapa Especificar critérios de conclusão, selecione a guia Sondagem ou Encerramento e selecione Parâmetros de URL. Observe que as guias Sondagem e Encerramento só aparecem quando a caixa de seleção Configurar uma condição de sondagem e encerramento para uma chamada REST sem espera está selecionada.

  2. Na linha da tabela de um parâmetro de URL recentemente adicionado, selecione Editar no menu Ações (Ações menu).
  3. No painel Editar parâmetro, o campo Identificador somente para leitura é o nome do parâmetro de tarefa REST da seção de variável de URL que é parametrizada.
    1. Digite uma Descrição opcional para o parâmetro.
    2. Use o menu Tipo de dados para alterar o tipo de dados de parâmetro.
    3. No campo Valor, digite o valor padrão para o parâmetro.
    4. Selecione Salvar.
      O parâmetro de URL é atualizado na tabela.
  4. Para mostrar ou ocultar o URL usando os valores padrão de parâmetro que você configurou, selecione Mostrar URL da visualização ou Ocultar URL da visualização.