Documentação do Oracle Cloud Infrastructure

Adicionando e Gerenciando um Cabeçalho

Defina um ou mais cabeçalhos a serem transmitidos à seção de cabeçalho da solicitação REST. Um cabeçalho tem uma chave e um valor. Todos os cabeçalhos de solicitação de API REST padrão são suportados.

Por exemplo, você pode adicionar o cabeçalho Content-Type para uma solicitação POST ou PUT.

Os procedimentos a seguir podem ser usados para adicionar e gerenciar cabeçalhos no URL HTTP principal ou no URL de sondagem opcional e no URL de encerramento.

Criando um Cabeçalho

Crie um cabeçalho de solicitação para o método HTTP principal ou os métodos HTTP de sondagem e encerramento opcionais.

Para criar um cabeçalho:

  1. Na etapa Definir detalhes da execução da página Configurar detalhes da API REST, selecione Cabeçalho para criar um cabeçalho para a tarefa REST.

    Para criar um cabeçalho para o 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 Cabeçalho.

  2. Selecione Adicionar cabeçalho.
  3. No campo Chave, comece a digitar o nome de um cabeçalho.
    Quando uma chave correspondente é encontrada, uma lista de sugestões é exibida em um menu. Selecione o cabeçalho desejado.
  4. No campo Valor, comece a digitar o nome do valor do cabeçalho.
    Quando um valor correspondente é encontrado, uma lista de sugestões é exibida em um menu. Selecione o valor do cabeçalho desejado.
  5. Selecione Adicionar.

    A chave e o valor do cabeçalho são adicionados à tabela C cabeçalho.

    Para designar um parâmetro para o valor do par de chave/valor do cabeçalho, selecione Expor como parâmetro de tarefa. Consulte Parametrizando um Valor de Cabeçalho.

Editando um Cabeçalho

Você pode editar a chave e o valor de um cabeçalho.

Se o valor do cabeçalho for parametrizado, edite o parâmetro para alterar o valor do parâmetro padrão. Consulte Editando o Valor de um Cabeçalho Parametrizado.

Para editar um par de chave/valor do cabeçalho:

  1. Na etapa Definir detalhes de execução da página Configurar detalhes de API REST, selecione Cabeçalho para editar um cabeçalho na tarefa REST.

    Para editar um cabeçalho para o URL de sondagem ou encerramento, vá para a página Especificar critérios de conclusão. Na guia Sondagem ou Encerramento, selecione Cabeçalho.

  2. Na linha da tabela de um cabeçalho, selecione Editar no menu Ações (Ações menu).
  3. No painel de cabeçalho Editar, altere os valores nos campos Chave e Valor e selecione Salvar.

    Quando você começa a digitar em um dos campos, uma lista de sugestões é exibida em um menu quando um item correspondente é encontrado. Você então pode selecionar a chave ou o valor do cabeçalho que deseja.

    Observação

    Se o valor no campo Valor for uma string de parâmetro como ${PARAMETER_HEADER} e você substituir a string por um valor de cabeçalho que corresponda à chave, o parâmetro será removido quando você selecionar Salvar. Para parametrizar o valor do cabeçalho novamente, selecione Expor como um parâmetro de tarefa, conforme descrito em Parametrizando um Valor de Cabeçalho.

Excluindo um Cabeçalho

A exclusão de um cabeçalho remove o par de chave/valor do cabeçalho da tarefa REST.

Para excluir um cabeçalho:

  1. Na etapa Definir detalhes de execução da página Configurar detalhes de API REST, selecione Cabeçalho para excluir um cabeçalho na tarefa REST.

    Para excluir um cabeçalho do URL de sondagem ou encerramento, vá para a página Especificar critérios de conclusão. Na guia Sondagem ou Encerramento, selecione Cabeçalho.

  2. Na linha da tabela de um cabeçalho, selecione Excluir no menu Ações (Ações menu).
  3. Na caixa de diálogo Excluir cabeçalho, selecione Excluir.

    O par de chave/valor do cabeçalho é removido da tabela Cabeçalho.

    Observação

    Se o valor do cabeçalho tiver sido parametrizado, o parâmetro associado ao valor não será excluído. Para excluir o parâmetro, consulte Excluindo um Parâmetro de Tarefa REST.
Parametrizando um Valor de Cabeçalho

Depois de definir o par chave/valor para um cabeçalho, você pode designar um parâmetro de tarefa ao valor do cabeçalho.

Para parâmetro do valor de um cabeçalho:

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

    Para parametrizar um valor de cabeçalho para o URL de sondagem ou encerramento, vá para a página Especificar critérios de conclusão. Na guia Sondagem ou Encerramento, selecione Cabeçalho.

  2. Na linha da tabela de um cabeçalho, ao lado do valor do cabeçalho, selecione Expor como parâmetro da tarefa.
  3. No painel Adicionar parâmetro, digite um nome para o parâmetro no campo Identificador 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 é String. Você não pode alterar o tipo de dados.
  6. Defina o Tamanho.
  7. Defina o Valor padrão do parâmetro.
    O valor do cabeçalho padrão é usado no runtime, a menos que você altere o valor no design time ou no runtime.
  8. Selecione Adicionar.
    A linha da tabela do cabeçalho é atualizada com o nome do parâmetro ao lado do valor do cabeçalho.
Editando o Valor de um Cabeçalho Parametrizado

Você só pode alterar o valor padrão do parâmetro.

Para editar o valor padrão de um valor de cabeçalho parametrizado:

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

    Para editar um valor de cabeçalho parametrizado para o URL de sondagem ou encerramento, vá para a página Especificar critérios de conclusão. Na guia Sondagem ou Encerramento, selecione Cabeçalho.

  2. Na linha da tabela do valor do cabeçalho que você deseja alterar, ao lado do nome do parâmetro, selecione Editar parâmetro.
  3. No painel Editar parâmetro, altere o valor do parâmetro.
  4. Selecione Salvar.
Removendo um Parâmetro de Valor de Cabeçalho

A remoção de um parâmetro de valor de cabeçalho remove apenas a associação do parâmetro com o valor do cabeçalho.

A remoção do parâmetro de valor do cabeçalho não exclui o par de chave/valor do cabeçalho.

Para remover um parâmetro de valor de cabeçalho:

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

    Para remover um parâmetro de valor de cabeçalho para o URL de sondagem ou encerramento, vá para a página Especificar critérios de conclusão. Na guia Sondagem ou Encerramento, selecione Cabeçalho.

  2. Na linha da tabela do parâmetro de valor do cabeçalho que você deseja remover, selecione Remover parâmetro.
  3. Na caixa de diálogo Remover parâmetro, selecione Remover.

    A designação do parâmetro é cancelada no valor do cabeçalho. O valor designado ao parâmetro se torna o valor do cabeçalho.

    Observação

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