Atividade PUT HTTP v2 (Beta)¶
Introdução¶
Uma atividade HTTP v2 (Beta) PUT, usando sua conexão HTTP v2 (Beta), substitui um recurso existente em um servidor HTTP e pode ser usado como origem (para fornecer dados em uma operação) ou destino (para consumir dados em uma operação).
Nota
Este conector é atualmente lançado como uma versão beta. Comentários sobre bugs e melhorias sugeridas podem ser fornecidos por meio do seu Gerente de sucesso do cliente (CSM).
Criar uma Atividade PUT HTTP v2 (Beta)¶
Uma instância de uma atividade HTTP v2 (Beta) PUT é criada a partir de uma conexão HTTP v2 (Beta) usando seu tipo de atividade PUT.
Para criar uma instância de uma atividade, arraste o tipo de atividade para a quadro de design ou copie o tipo de atividade e cole-o na quadro de design. Para obter detalhes, consulte Criando uma instância de atividade em Reutilização de componente.
Uma atividade HTTP v2 (Beta) PUT existente pode ser editada a partir destes locais:
- A quadro de design (consulte Menu de ações do componente em Quadro de Design).
- A aba Componentes do painel do projeto (consulte Menu de ações do componente na Guia Componentes do painel do projeto).
Configurar uma Atividade PUT HTTP v2 (Beta)¶
Siga estas etapas para configurar uma atividade HTTP v2 (Beta) PUT:
-
Etapa 1: Digite um nome e especifique as configurações
Forneça um nome para a atividade e especifique o URL, parâmetros de solicitação, cabeçalhos de solicitação e configurações adicionais. -
Etapa 2: Forneça o Esquema de Solicitação
Forneça um esquema de solicitação personalizado (opcional). Se você não fornecer um esquema de resposta personalizado, o esquema de resposta padrão do conector será usado. -
Etapa 3: Forneça o Esquema de Resposta
Forneça um esquema de resposta personalizado (opcional). Se você não fornecer um esquema de resposta personalizado, o esquema de resposta padrão do conector será usado. -
Etapa 4: Revise os Esquemas de Dados
Os esquemas de solicitação e resposta configurados são exibidos.
Etapa 1: Insira um Nome e Especifique as Configurações¶
Nesta etapa, forneça um nome para a atividade e especifique a URL, parâmetros de solicitação, cabeçalhos de solicitação e configurações adicionais. Cada elemento da interface do usuário desta etapa é descrito a seguir.
Dica
Campos com ícone de variável suporte usando variáveis globais, variáveis do projeto e variáveis Jitterbit. Comece digitando um colchete aberto
[
no campo ou clicando no ícone da variável para exibir uma lista das variáveis existentes para escolher.
Importante
Os campos nas tabelas exibem o ícone de variável apenas no modo de edição. Para que os valores das variáveis desses campos sejam preenchidos em tempo de execução, a versão do agente deve ser pelo menos 10.75 / 11.13.
-
Nome: Digite um nome para identificar a atividade. O nome deve ser exclusivo para cada atividade HTTP v2 (Beta) PUT e não deve conter barras
/
ou dois pontos:
. -
Caminho: Insira um URL para usar na atividade:
- Se deixado em branco, o Base URL configurado na conexão HTTP v2 (Beta) será usado em tempo de execução.
- Se um caminho parcial for especificado, ele será anexado ao Base URL configurado na conexão HTTP v2 (Beta).
- Se um URL completo for especificado, ele substituirá o Base URL configurado na conexão HTTP v2 (Beta).
Parâmetros de solicitação podem ser incluídos colocando-os entre chaves
{
}
. Parâmetros de consulta (como/queryrecord?id=10
) também pode ser usado.- URL: Exibe a URL completa a ser usada em tempo de execução.
-
Parâmetros de Solicitação: Clique no ícone de adição
para adicionar uma linha à tabela abaixo e insira um Nome e um Valor para cada parâmetro de solicitação. Os parâmetros de solicitação fornecidos serão automaticamente codificados em URL.
Como alternativa, os parâmetros de solicitação podem ser fornecidos na transformação de solicitação. Os parâmetros de solicitação que não compartilham uma chave são enviados cumulativamente, independentemente de onde são especificados. Se a mesma chave de parâmetro for especificada neste campo e na solicitação, aquela especificada na solicitação terá precedência.
Para salvar a linha, clique no ícone de envio
na coluna mais à direita.
Para editar ou excluir uma única linha, passe o mouse sobre a coluna mais à direita e use o ícone de edição
ou ícone de exclusão
.
Para excluir todas as linhas, clique em Limpar tudo.
-
Cabeçalhos de solicitação: Clique no ícone de adição
para adicionar uma linha à tabela abaixo e insira um Nome e um Valor para cada cabeçalho de solicitação.
Como alternativa, os cabeçalhos podem ser definidos em outros campos de configuração da interface do usuário ou fornecidos na transformação de solicitação. Os cabeçalhos que não compartilham uma chave são enviados cumulativamente, independentemente de onde são especificados.
Se a mesma chave de cabeçalho for especificada em vários lugares, esta ordem de precedência será seguida:
- Um cabeçalho fornecido na transformação de solicitação substitui todos os campos abaixo.
- Um cabeçalho fornecido no campo Request Headers de uma atividade HTTP v2 (Beta) PUT (este campo) substitui o campo restante abaixo.
- Um cabeçalho fornecido no campo Request Headers de uma conexão HTTP v2 (Beta) tem a menor precedência.
Para salvar a linha, clique no ícone de envio
na coluna mais à direita.
Para editar ou excluir uma única linha, passe o mouse sobre a coluna mais à direita e use o ícone de edição
ou ícone de exclusão
.
Para excluir todas as linhas, clique em Limpar tudo.
-
Configurações adicionais: Clique no ícone de adição
para adicionar uma linha à tabela abaixo e insira um Nome e um Valor para cada configuração adicional.
Estas configurações adicionais são suportadas:
Chave Valor padrão Tipo de dados Descrição connection-timeout
30000
inteiro O tempo limite de transferência em milissegundos. Se esta configuração não for especificada, o tempo limite de transferência padrão é 30000
milissegundos (30 segundos). Definido como0
para um tempo limite ilimitado.content-type
— Corda O tipo de conteúdo da estrutura de solicitação que é esperado pela API específica. Por exemplo, text/plain
,application/json
,application/x-www-form-urlencoded
, etc. Se esta configuração não for especificada, não haverá valor padrão.max-redirect
50
inteiro O número máximo de redirecionamentos a seguir. Se esta configuração não for especificada, o padrão é seguir 50
redireciona. Definido como0
ou um número negativo para evitar seguir qualquer redirecionamento.trailing-linebreaks
false
Corda Remove espaços em branco iniciais e finais e quebras de linha quando definido como true
. Se esta configuração não for especificada ou definida comofalse
, os dados permanecem inalterados.Como alternativa, configurações adicionais podem ser fornecidas na transformação de solicitação. As configurações adicionais que não compartilham uma chave são enviadas cumulativamente, independentemente de onde são especificadas. Para todas as configurações, exceto para tipo de conteúdo, se a mesma chave de configurações for especificada neste campo e na solicitação, aquela especificada na solicitação terá precedência.
Para
content-type
, um valor especificado aqui tem precedência sobre todos os outros locais na interface do usuário em que o tipo de conteúdo pode ser especificado. Se o tipo de conteúdo for especificado em vários lugares, esta ordem de precedência será seguida:- A
Content-Type
O cabeçalho fornecido na tabela Additional Settings de uma atividade HTTP v2 (Beta) PUT (esta tabela) substitui todos os campos abaixo. - O
bodyContentType
campo especificado em uma transformação de solicitação substitui os campos restantes abaixo. - A
Content-Type
cabeçalho fornecido na transformação de solicitaçãoheaders
nó substitui os campos restantes abaixo. - A
Content-Type
O cabeçalho fornecido no campo Request Headers de uma atividade HTTP v2 (Beta) PUT substitui os campos restantes abaixo. - A
Content-Type
O cabeçalho fornecido no campo Request Headers de uma conexão HTTP v2 (Beta) substitui o campo restante abaixo. - A
Content-Type
O cabeçalho fornecido no campo Content-Type de uma conexão HTTP v2 (Beta) tem a menor precedência.
Para salvar a linha, clique no ícone de envio
na coluna mais à direita.
Para editar ou excluir uma única linha, passe o mouse sobre a coluna mais à direita e use o ícone de edição
ou ícone de exclusão
.
Para excluir todas as linhas, clique em Limpar tudo.
- A
-
Multipart: Selecione para suportar
multipart/form-data
solicitações ao usar esquemas padrão. Isso é necessário para solicitações que incluem RFC 1867 envios de formulários.Nota
Ao usar esquemas personalizados,
multipart/form-data
não é suportado. -
Save & Exit: Se ativado, clique para salvar a configuração desta etapa e fechar a configuração da atividade.
-
Avançar: Clique para armazenar temporariamente a configuração desta etapa e continuar na próxima etapa. A configuração não será salva até que você clique no botão Concluído na última etapa.
-
Descartar alterações: Após fazer as alterações, clique para fechar a configuração sem salvar as alterações feitas em nenhuma etapa. Uma mensagem solicita que você confirme que deseja descartar as alterações.
Etapa 2: Fornecer o Esquema de Solicitação¶
Nesta etapa, você pode fornecer um esquema de solicitação personalizado. Se você não fornecer um esquema de solicitação personalizado, o esquema de solicitação padrão do conector será usado.
-
Fornecer esquema de solicitação: O esquema de solicitação define a estrutura dos dados da solicitação que é usada pela atividade HTTP v2 (Beta) PUT. Para obter instruções sobre como concluir esta seção de configuração de atividade, consulte Esquemas definidos em uma atividade.
-
Voltar: Clique para armazenar temporariamente a configuração desta etapa e retornar à etapa anterior.
-
Avançar: Clique para armazenar temporariamente a configuração desta etapa e continuar na próxima etapa. A configuração não será salva até que você clique no botão Concluído na última etapa.
-
Descartar alterações: Após fazer as alterações, clique para fechar a configuração sem salvar as alterações feitas em nenhuma etapa. Uma mensagem solicita que você confirme que deseja descartar as alterações.
Etapa 3: Fornecer o Esquema de Resposta¶
Nesta etapa, você pode fornecer um esquema de resposta personalizado. Se você não fornecer um esquema de resposta personalizado, o esquema de resposta padrão do conector será usado.
-
Resposta: O esquema de resposta define a estrutura dos dados de resposta usados pela atividade HTTP v2 (Beta) PUT. Para obter instruções sobre como concluir esta seção de configuração de atividade, consulte Esquemas definidos em uma atividade.
-
Voltar: Clique para armazenar temporariamente a configuração desta etapa e retornar à etapa anterior.
-
Avançar: Clique para armazenar temporariamente a configuração desta etapa e continuar na próxima etapa. A configuração não será salva até que você clique no botão Concluído na última etapa.
-
Descartar alterações: Após fazer as alterações, clique para fechar a configuração sem salvar as alterações feitas em nenhuma etapa. Uma mensagem solicita que você confirme que deseja descartar as alterações.
Etapa 4: Revisar os Esquemas de Dados¶
Os esquemas de solicitação e resposta configurados são exibidos.
-
Esquemas de Dados: Esses esquemas de dados são herdados por transformações adjacentes e são exibidos novamente durante mapeamento de transformação.
Se quaisquer esquemas personalizados forem fornecidos nas etapas anteriores, eles serão exibidos. Se os esquemas personalizados não forem fornecidos, os esquemas padrão incluídos no conector serão exibidos.
Os esquemas de solicitação e resposta padrão consistem nestes nós e campos:
-
Pedido:
Nó/campo do esquema de solicitação Notas json Formato do esquema de solicitação solicitar Nó de solicitação raiz Nó raiz cabeçalhos Nó de cabeçalhos item Nó de um cabeçalho específico chave Chave do cabeçalho valor Valor do cabeçalho Parâmetros de solicitação Nó de parâmetros de solicitação item Nó de um parâmetro de solicitação específico chave Chave do parâmetro do pedido valor Valor do parâmetro do pedido várias partes Nó de um multipart (incluído apenas quando Multipart é selecionado na UI de configuração de atividade e esquemas padrão são usados) texto simples Nó das partes de texto simples de uma multiparte item Nó de uma parte de texto simples específica no multipart chave Chave da parte de texto simples que mapeia para sua name
atributo no payload da solicitaçãovalor Valor da parte de texto sem formatação que mapeia para seu conteúdo na payload da solicitação arquivoDados Nó das partes de dados de um arquivo multipart item Nó de uma parte de dados de arquivo específica no multipart chave Chave da parte de dados do arquivo que mapeia para sua name
efilename
atributos na payload da solicitação que devem incluir a extensão do arquivo, se conhecida
Nota
Se um caminho for fornecido para esta chave, o
filename
O atributo conterá apenas o nome e a extensão do arquivo.valor Valor da parte de dados do arquivo que mapeia para seu conteúdo na payload da solicitação
Importante
A string fornecida para este valor representa o próprio arquivo e deve ser codificada no formato Base64. Consulte Base64EncodeFile em Funções criptográficas para saber como codificar um arquivo usando um script.
Configurações adicionais Nó de configurações adicionais item Nó de uma configuração adicional específica chave Chave da configuração adicional valor Valor da configuração adicional corpo Corpo da solicitação bodyContentType Content-Type
do corpo da solicitação
Nota
Este campo tem precedência sobre um
Content-Type
cabeçalho fornecido noheaders
nó. -
Resposta:
Nó/campo do esquema de resposta Notas json Formato do esquema de resposta resposta Nó de resposta item de resposta Nó do item de resposta estado Um booleano indicando se uma resposta foi retornada propriedades Propriedades da resposta cabeçalhos Nó de cabeçalhos item Nó de um cabeçalho específico chave Chave do cabeçalho valor Valor do cabeçalho respostaConteúdo Conteúdo da resposta erro Nó de erro código de status Código de status HTTP da resposta detalhes Detalhes da resposta
-
-
Atualizar: Clique no ícone de atualização
ou a palavra Atualizar para regenerar esquemas do endpoint HTTP v2 (Beta). Essa ação também regenera um esquema em outros locais do projeto em que o mesmo esquema é referenciado, como em uma transformação adjacente.
-
Voltar: Clique para armazenar temporariamente a configuração desta etapa e retornar à etapa anterior.
-
Concluído: Clique para salvar a configuração de todas as etapas e fechar a configuração da atividade.
-
Descartar alterações: Após fazer as alterações, clique para fechar a configuração sem salvar as alterações feitas em nenhuma etapa. Uma mensagem solicita que você confirme que deseja descartar as alterações.
Próximos Passos¶
Depois de configurar uma atividade HTTP v2 (Beta) PUT, conclua a configuração da operação adicionando e configurando outras atividades, transformações ou scripts como etapas da operação. Você também pode definir as configurações de operação, que incluem a capacidade de encadear operações que estão no mesmo workflows ou em diferentes.
As ações de menu para uma atividade podem ser acessadas no painel do projeto e na quadro de design. Para obter detalhes, consulte Menu de ações de atividade em Noções básicas do conector.
As atividades HTTP v2 (Beta) PUT usadas como fonte podem ser usadas com esses padrões de operação:
- Padrão de transformação
- Padrão de arquivo de dois alvos (apenas como a primeira fonte)
- Padrão de arquivo HTTP de dois destinos (apenas como a primeira fonte)
- Padrão de duas transformações (como primeira ou segunda fonte)
As atividades HTTP v2 (Beta) PUT usadas como destino podem ser usadas com esses padrões de operação:
- Padrão de transformação
- Padrão de duas transformações (como primeiro ou segundo alvo)
Um caso de uso típico é usar uma atividade HTTP v2 (Beta) PUT como destino no Two-transformation Pattern. Neste exemplo, a primeira transformação (HTTP v2 (Beta) PUT Request) cria uma estrutura de solicitação que é transmitida para a atividade HTTP v2 (Beta) PUT. A segunda transformação (HTTP v2 (Beta) PUT Response) recebe a estrutura de resposta, que é então gravada em uma variável por uma atividade Variable Write (Write HTTP v2 (Beta) PUT Response) e uma mensagem é então registrada por o script Write to Operation Log:
Para usar a atividade com funções de script, grave os dados em um local temporário e use esse local temporário na função de script.
Quando estiver pronto, implantar e executar a operação e validar o comportamento verificando os logs da operação.