Fornecendo um Corpo de Solicitação

Forneça o corpo da solicitação que é necessário para uma solicitação REST usando o método POST ou PUT.

Os procedimentos a seguir podem ser usados para configurar um corpo de solicitação no URL HTTP principal ou no URL de sondagem opcional e no URL de encerramento.

Adicionando o Corpo de Solicitação

No momento, somente JSON é o formato suportado para um corpo de solicitação.

Para criar um corpo de solicitação:

  1. Na etapa Definir detalhes da execução da página Configurar detalhes da API REST, selecione Solicitação para criar um corpo de solicitação para a tarefa REST.

    Para criar um corpo de solicitação para um URL de apuração ou encerramento, vá para a página Especificar critérios de conclusão, marque a caixa de seleção Configurar uma condição de apuração e encerramento para uma chamada REST sem espera. Na guia Sondagem ou Encerramento, selecione Solicitação.

    Se você não vir a guia Solicitação, certifique-se de ter selecionado o método HTTP apropriado.

  2. No editor, digite o corpo da solicitação.
    • Você pode digitar ou copiar e colar todo o payload.

    • Você pode referenciar parâmetros existentes no payload usando a sintaxe ${}. Por exemplo:

      {
          "modelType": "USER_PROJECT",
          "modelVersion": "20200901",
          "parentRef": {},
          "name": "${PROJECT_NAME}",
          "identifier": "${PROJECT_NAME}",
          "description": "Creating my project",
          "objectVersion": 0,
          "objectStatus": 8,
          "registryMetadata": {
              "registryVersion": 0
          }
      }
    Observação

    O validador incorporado no editor valida o corpo da solicitação. Se você vir um ponto vermelho com um 'x' ao lado do editor, passe o mouse sobre o ícone para ver o erro dessa linha de código.
  3. Para atribuir um parâmetro de tarefa ao corpo inteiro da solicitação, selecione Expor como um parâmetro de tarefa. Consulte Parametrizando o Corpo da Solicitação.

    Para editar o corpo de um corpo de solicitação parametrizado, edite o valor do parâmetro.

Parametrizando o Corpo da Solicitação

Além de usar parâmetros dentro do corpo da solicitação, você pode parametrizar todo o corpo.

Consulte Adicionando o Corpo da Solicitação.

Depois de criar o corpo da solicitação no editor, você poderá designar um parâmetro de tarefa ao corpo inteiro.

Para definir parâmetros para todo o corpo da solicitação:

  1. Na etapa Definir detalhes da execução da página Configurar detalhes da API REST, selecione Solicitação.

    Para parametrizar o corpo da solicitação de um URL de sondagem ou encerramento, vá para a página Especificar critérios de conclusão. Na guia Sondagem ou Encerramento, selecione Solicitação.

  2. Selecione Expor como um parâmetro de tarefa.

    Se você ainda não tiver digitado o corpo da solicitação, o Data Integration exibirá uma mensagem de advertência em uma caixa de diálogo. Digite um corpo de solicitação primeiro e, em seguida, designe um parâmetro ao corpo inteiro.

  3. No painel Adicionar parâmetro, digite um nome para o parâmetro no campo Identifier ou use o valor padrão.

    O nome do parâmetro deve ser exclusivo na tarefa REST. Para obter uma lista atual dos parâmetros na tarefa, consulte Exibindo Todos os Parâmetros em uma Tarefa REST.

  4. (Opcional) Digite uma Descrição para ajudar a identificar a finalidade do parâmetro para outros usuários.
  5. O Tipo de dados do parâmetro é JSON, que você não pode alterar.
  6. No campo Valor, defina o JSON padrão para esse parâmetro de tarefa.
  7. Selecione Adicionar.
    O nome do parâmetro é adicionado à parte superior do editor.

Para editar o corpo de um corpo de solicitação parametrizado, edite o valor do parâmetro.

Editando o Valor de um Parâmetro de Corpo de Solicitação

É possível alterar o valor padrão do parâmetro de tarefa para o corpo da solicitação.

Para editar o corpo de solicitação parametrizado:

  1. Na etapa Definir detalhes da execução da página Configurar detalhes da API REST de um método POST ou PUT, selecione Solicitação.

    Para editar o corpo da solicitação parametrizado de um URL de sondagem ou encerramento, vá para a página Especificar critérios de conclusão. Na guia Sondagem ou Encerramento, selecione Solicitação.

  2. Selecione Editar parâmetro.
  3. No painel Editar parâmetro, você só pode editar o campo Valor. Você não pode alterar o tipo de dados ou a descrição.

    Para editar a descrição, consulte Editando um Parâmetro de Tarefa REST.

  4. Selecione Salvar.
Removendo o Parâmetro de Corpo da Solicitação

A remoção do parâmetro só remove a associação do parâmetro com o corpo da solicitação na tarefa REST.

Para cancelar a designação do parâmetro de todo o corpo da solicitação:

  1. Na etapa Definir detalhes da execução da página Configurar detalhes da API REST de um método POST ou PUT, selecione Solicitação.

    Para cancelar a atribuição do parâmetro do corpo da solicitação de um URL de sondagem ou encerramento, vá para a página Especificar critérios de conclusão. Na guia Sondagem ou Encerramento, selecione Solicitação.

  2. Selecione Remover parâmetro.
  3. Na caixa de diálogo Remover parâmetro, selecione Remover.

    A designação do parâmetro é cancelada no corpo da solicitação. O corpo da solicitação que foi designado ao parâmetro se torna o corpo da solicitação padrão.

    Observação

    O parâmetro não é excluído da tarefa REST. Para excluir o parâmetro, consulte Excluindo um Parâmetro de Tarefa REST.