Atividade HTTP v2 PATCH

Introdução

Uma atividade HTTP v2 PATCH, usando sua conexão HTTP v2, aplica modificações parciais a um recurso existente em um serviço acessível pelo protocolo HTTP ou HTTPS e pode ser usado como uma fonte (para fornecer dados em uma operação) ou um destino (para consumir dados em uma operação).

Crie uma atividade HTTP v2 PATCH

Uma instância de uma atividade HTTP v2 PATCH é criada a partir de uma conexão HTTP v2 usando seu tipo de atividade PATCH.

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

Uma atividade HTTP v2 PATCH existente pode ser editada nestes locais:

A quadro de design (veja menu de ações do componente em Tela de design).
A aba Componentes do painel do projeto (consulte menu de ações do componente na aba Componentes do painel Projeto).

Configurar uma atividade HTTP v2 PATCH

Siga estas etapas para configurar uma atividade HTTP v2 PATCH:

Etapa 1: Insira um nome e especifique as configurações
Forneça um nome para a atividade e especifique a URL, os parâmetros de solicitação, os cabeçalhos de solicitação e as 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 abaixo.

Etapa 1 da configuração da atividade HTTP v2 PATCH

Dica

Campos com um í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 somente no modo de edição. Para que os valores 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: Insira um nome para identificar a atividade. O nome deve ser exclusivo para cada atividade HTTP v2 PATCH e não deve conter barras / ou dois pontos :.
Caminho: Insira uma URL para usar na atividade:
- Se deixado em branco, o URL base configurado na conexão HTTP v2 será usado em tempo de execução.
- Se um caminho parcial for especificado, ele será anexado ao URL base configurado na conexão HTTP v2.
- Se uma URL completa for especificada, ela substituirá a URL base configurada na conexão HTTP v2.
Os 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 adicionar para adicionar uma linha à tabela abaixo e inserir um Nome e um Valor para cada parâmetro de solicitação. Os parâmetros de solicitação fornecidos serão automaticamente codificados por 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 transformação de solicitação, aquela especificada na transformaçã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 excluir ícone .

Para excluir todas as linhas, clique em Limpar tudo.
Cabeçalhos de solicitação: Clique no ícone adicionar para adicionar uma linha à tabela abaixo e inserir 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 IU 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:
1. Um cabeçalho fornecido na transformação da solicitação substitui todos os campos abaixo.
2. Um cabeçalho fornecido no campo Cabeçalhos de solicitação de uma atividade HTTP v2 PATCH (este campo) substitui o campo restante abaixo.
3. Um cabeçalho fornecido no campo Cabeçalhos de solicitação de uma conexão HTTP v2, se Enviar Cabeçalhos de Solicitação na Execução de Atividade estiver habilitado, 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 excluir ícone .

Para excluir todas as linhas, clique em Limpar tudo.

Configurações adicionais: Clique no ícone adicionar para adicionar uma linha à tabela abaixo e inserir um Nome e um Valor para cada configuração adicional.

Essas 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 será `30000` milissegundos (30 segundos). Defina para `0` para um tempo limite ilimitado.
`content-type`	—	String	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` redirecionamentos. Definir para `0` ou um número negativo para evitar seguir qualquer redirecionamento.
`trailing-linebreaks`	`false`	String	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 como `false`, os dados permanecem inalterados.

Como alternativa, configurações adicionais podem ser fornecidas na transformação de solicitação. 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 content-type, se a mesma chave de configurações for especificada neste campo e na transformação de solicitação, aquela especificada na transformação terá precedência.

Para content-type, um valor especificado aqui tem precedência sobre todos os outros lugares na IU onde o content-type pode ser especificado. Se content-type for especificado em vários lugares, esta ordem de precedência será seguida:

A Content-Type O cabeçalho fornecido na tabela Configurações adicionais de uma atividade HTTP v2 PATCH (esta tabela) substitui todos os campos abaixo.
O bodyContentType o campo especificado em uma transformação de solicitação substitui os campos restantes abaixo.
Um Content-Type cabeçalho fornecido na transformação da solicitação headers nó substitui os campos restantes abaixo.
Um Content-Type O cabeçalho fornecido no campo Cabeçalhos de Solicitação de uma atividade HTTP v2 PATCH substitui o campo restante abaixo.
Um Content-Type o cabeçalho fornecido no campo Cabeçalhos de Solicitação de uma conexão HTTP v2, se Enviar Cabeçalhos de Solicitação na Execução de Atividade estiver habilitado, tem a menor precedência.

Nota

Se um cabeçalho for definido em vários locais, cada instância do cabeçalho será adicionada à solicitação de uma atividade seguindo a ordem de precedência acima. Essa ordem é baseada em como os serviços normalmente lidam com cabeçalhos duplicados em uma solicitação.

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 excluir ícone .

Para excluir todas as linhas, clique em Limpar tudo.

Multipart: Selecione para oferecer suporte multipart/form-data solicitações ao usar esquemas padrão. Isso é necessário para solicitações que incluem RFC 1867 formulários de upload.

Nota

Ao usar esquemas personalizados, multipart/form-data não é suportado.
Configurações opcionais: Clique para expandir configurações opcionais adicionais:
- Ignorar erro de operação em caso de código de status não bem-sucedido: Selecione para que as operações relatem um status bem-sucedido mesmo se um código de status não bem-sucedido for retornado da API que o conector está chamando. O valor padrão é desmarcado.
- Selecione o código de status HTTP para ser considerado bem-sucedido no tempo de execução da operação: Selecione Agrupado por classe ou Granular (entrada manual) para considerar os códigos de status especificados como bem-sucedidos em registros de operação.
  - Agrupado por classe: Quando selecionado, um menu suspenso é exibido com classes de códigos de status não bem-sucedidos a serem tratados como bem-sucedidos. As opções do menu suspenso incluem Redirecionamento 3xx, Erro do cliente 4xx e Erro do servidor 5xx. O valor padrão do menu suspenso não é selecionado.
  - Granular (entrada manual): Quando selecionado, um campo é exibido para inserir manualmente uma lista delimitada por vírgulas de códigos de status não bem-sucedidos a serem tratados como bem-sucedidos. Esta lista pode incluir diferentes classes de códigos de status ao mesmo tempo. O valor padrão do campo é em branco.
Salvar e sair: Se habilitado, clique para salvar a configuração para esta etapa e fechar a configuração da atividade.
Próximo: Clique para armazenar temporariamente a configuração para esta etapa e continuar para a 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 alterações, clique para fechar a configuração sem salvar as alterações feitas em nenhuma etapa. Uma mensagem pede para você confirmar que deseja descartar as alterações.

Etapa 2: Forneça 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.

Etapa 2 da configuração da atividade HTTP v2 PATCH

Fornecer Esquema de Solicitação: O esquema de solicitação define a estrutura dos dados de solicitação que são usados pela atividade HTTP v2 PATCH. Para obter instruções sobre como concluir esta seção de configuração da atividade, consulte Esquemas definidos em uma atividade.
Voltar: Clique para armazenar temporariamente a configuração desta etapa e retornar à etapa anterior.
Próximo: Clique para armazenar temporariamente a configuração desta etapa e continuar para a 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 alterações, clique para fechar a configuração sem salvar as alterações feitas em nenhuma etapa. Uma mensagem solicita que você confirme se deseja descartar as alterações.

Etapa 3: Forneça 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.

Etapa 3 da configuração da atividade HTTP v2 PATCH

Fornecer Esquema de Resposta: O esquema de resposta define a estrutura dos dados de resposta que são usados pela atividade HTTP v2 PATCH. Para obter instruções sobre como concluir esta seção de configuração da atividade, consulte Esquemas definidos em uma atividade.

Incluir Propriedades Adicionais da Resposta HTTP no Esquema: Quando Sim, Usar Esquema Salvo ou Sim, Fornecer Novo Esquema é selecionado e o esquema usado tem um tipo de arquivo XML ou JSON, a caixa de seleção Incluir Propriedades Adicionais da Resposta HTTP no Esquema é exibida. Quando selecionada, o esquema é encapsulado em uma estrutura definida pelo Jitterbit, permitindo que parâmetros adicionais sejam acessíveis no esquema:

Propriedades adicionais do HTTP v2 no esquema de resposta

JSONXML

{
  "__jitterbit_aditional_properties__": {
    "__jitterbit_api_headers__": [
      {
        "key": "",
        "value": ""
      },
      {
        "key": "",
        "value": ""
      }
    ],
    "__jitterbit_api_statuscode__": 200,
    "__jitterbit_api_errorbody__": ""
  },
  "root": {
    // Original JSON
  }
}

<__jitterbitResponse__>
    <__jitterbit_aditional_properties__>
        <__jitterbit_api_headers__>
            <key>headerKey1</key>
            <value>headerValue1</value>
        </__jitterbit_api_headers__>
        <__jitterbit_api_headers__>
            <key>headerKey2</key>
            <value>headerValue2</value>
        </__jitterbit_api_headers__>
        <__jitterbit_api_statuscode__>200</__jitterbit_api_statuscode__>
        <__jitterbit_api_errorbody__>
        </__jitterbit_api_errorbody__>
    </__jitterbit_aditional_properties__>
    <root>
        <!-- Original XML -->
    </root>
</__jitterbitResponse__>

__jitterbit_api_headers__: Retorna os cabeçalhos fornecidos pela chamada de solicitação.
__jitterbit_api_statuscode__: Retorna o código de status da chamada de solicitação.
__jitterbit_api_errorbody__: Retorna o corpo da resposta da chamada de solicitação em formato de string se a chamada de solicitação retornar um código de status malsucedido.
root: Abriga a estrutura original do esquema de resposta.

Nota

Quando selecionado, um novo esquema é gerado com o wrapper. A estrutura do esquema original é preservada dentro root. Como um novo esquema é gerado para essa finalidade, o original sem o wrapper pode ser usado posteriormente, se necessário.

Voltar: Clique para armazenar temporariamente a configuração desta etapa e retornar à etapa anterior.
Próximo: Clique para armazenar temporariamente a configuração para esta etapa e continuar para a 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 alterações, clique para fechar a configuração sem salvar as alterações feitas em nenhuma etapa. Uma mensagem pede para você confirmar que deseja descartar as alterações.

Etapa 4: Revise os esquemas de dados

Os esquemas de solicitação e resposta configurados são exibidos.

etapa 4 da configuração da atividade HTTP v2 PATCH

Esquemas de dados: Esses esquemas de dados são herdados por transformações adjacentes e são exibidos novamente durante o mapeamento de transformação.

Se algum esquema personalizado foi fornecido nas etapas anteriores, ele será exibido. Se esquemas personalizados não foram fornecidos, os esquemas padrão incluídos com o conector serão exibidos.

Para atividades HTTP v2, os esquemas de dados são regenerados automaticamente com base nas atualizações feitas nos esquemas definidos nas etapas anteriores.

Cuidado

As atividades HTTP v2 criadas antes do lançamento do Harmony 10.85 / 11.23 podem ter um botão manual Atualizar presente devido a metadados de projeto definidos anteriormente. Se presente, não interaja com este botão. Crie uma nova instância de uma atividade afetada para removê-la.

Os esquemas de solicitação e resposta padrão consistem nestes nós e campos:

Solicitação:

Nó/Campo do Esquema de Solicitação	Notas
json	Formato do esquema de solicitação

solicitação	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

requestParameters	Nó de parâmetros de solicitação

item	Nó de um parâmetro de solicitação específico
chave	Chave do parâmetro de solicitação
valor	Valor do parâmetro de solicitação

multipart	Nó de uma multipart (incluído somente quando Multipart é selecionado na interface de configuração da atividade e esquemas padrão são usados)

plainText	Nó das partes de texto simples de uma multiparte

item	Nó de uma parte específica de texto simples na multiparte
chave	Chave da parte do texto simples que mapeia para seu `name` atributo na payload da solicitação
valor	Valor da parte de texto simples que mapeia seu conteúdo na payload da solicitação
Tipo de conteúdo	`Content-Type`da parte de texto simples Nota Este campo tem precedência sobre um `Content-Type` cabeçalho fornecido no `headers` nó.

fileData	Nó das partes de dados de arquivo de uma multiparte

item	Nó de uma parte de dados de arquivo específica na multiparte
chave	Chave da parte de dados do arquivo que mapeia para seu `name` e `filename` atributos na payload da solicitação. Deve incluir a extensão do arquivo, se conhecida Nota Se um caminho for fornecido para esta chave e o `fileName` campo é deixado em branco, o `filename` atributo conterá apenas o nome e a extensão do arquivo.
valor	Valor da parte de dados do arquivo que mapeia seu conteúdo na payload da solicitação Importante A string fornecida para este valor representa o próprio arquivo e deve ser codificado no formato Base64. Veja Base64encodefile em Funções criptográficas para saber como codificar um arquivo usando um script.
fileName	String que representa o nome do arquivo da parte de dados do arquivo que mapeia para seu `filename` atributo no payload da solicitação. Ele deve incluir a extensão do arquivo, se conhecida. Este campo tem precedência sobre o que é definido no `key` campo para o `filename` atributo
mimeType	String que representa o tipo MIME (mídia) da parte de dados do arquivo, independente das extensões de arquivo fornecidas no `key` ou `fileName` campos

additionalSettings	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
TipoDeConteúdoDoCorpo	`Content-Type`do corpo da solicitação Nota Este campo tem precedência sobre um `Content-Type` cabeçalho fornecido no `headers` nó.

Resposta:

Nó/Campo do Esquema de Resposta	Notas
json	Formato do esquema de resposta

resposta	Nó de resposta

responseItem	Nó do item de resposta
status	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

responseContent	Conteúdo da resposta

erro	Nó de erro
statusCode	Código de status HTTP da resposta
statusMessage	Mensagem de status da resposta
detalhes	Detalhes da resposta

Voltar: Clique para armazenar temporariamente a configuração para esta etapa e retornar à etapa anterior.
Concluído: Clique para salvar a configuração para todas as etapas e fechar a configuração da atividade.
Descartar alterações: Após fazer alterações, clique para fechar a configuração sem salvar as alterações feitas em nenhuma etapa. Uma mensagem pede para você confirmar que deseja descartar as alterações.

Próximos passos

Após configurar uma atividade HTTP v2 PATCH, 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 configurar as definições da operação, que incluem a capacidade de encadear operações que estejam no mesmo fluxo de trabalho ou em workflows diferentes.

As ações de menu para uma atividade são acessíveis a partir do painel do projeto e da quadro de design. Para obter detalhes, consulte menu de ações de atividade em Noções básicas do conector.

As atividades HTTP v2 PATCH que são 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 primeira fonte)
Padrão de arquivo HTTP de dois alvos (apenas como primeira fonte)
Padrão de duas transformações (como primeira ou segunda fonte)

As atividades HTTP v2 PATCH que são usadas como alvo podem ser usadas com esses padrões de operação:

Padrão de Transformação
Padrão de duas transformações (como o primeiro ou segundo alvo)

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 de operação.