Atividade HTTP v2 PATCH

Introdução

Uma atividade HTTP v2 PATCH, utilizando 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 usada tanto como fonte (para fornecer dados em uma operação) quanto como destino (para consumir dados em uma operação).

Criar 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 tela de design ou copie o tipo de atividade e cole-o na tela de design. Para mais detalhes, veja Criar uma instância de atividade ou ferramenta em Reutilização de componentes.

Uma atividade HTTP v2 PATCH existente pode ser editada a partir destes locais:

• A tela de design (veja Menu de ações do componente em Tela de design).
• A aba Componentes do painel do projeto (veja Menu de ações do componente em Aba Componentes do painel do 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, 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á utilizado.

• Passo 3: Fornecer 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á utilizado.

• Passo 4: Revisar os esquemas de dados
  Os esquemas de solicitação e resposta configurados são exibidos.

Passo 1: Insira um nome e especifique as configurações

Neste passo, 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 deste passo é descrito abaixo.

• Nome: Insira um nome para identificar a atividade. O nome deve ser único para cada atividade HTTP v2 PATCH e não deve conter barras normais / ou dois pontos :.

• Caminho: Insira uma URL a ser utilizada para a atividade:

  • Se deixado em branco, a Base URL configurada na conexão HTTP v2 será utilizada em tempo de execução.
  • Se um caminho parcial for especificado, ele será anexado à Base URL configurada na conexão HTTP v2.
  • Se uma URL completa for especificada, ela substituirá a Base URL configurada na conexão HTTP v2.

  Os parâmetros de solicitação podem ser incluídos envolvendo-os entre chaves { }. Parâmetros de consulta (como /queryrecord?id=10) também podem ser usados.

  • URL: Exibe a URL completa a ser utilizada em tempo de execução.

• Parâmetros de Solicitação: Clique no ícone de adicionar para adicionar uma linha à tabela abaixo e insira um Nome e Valor para cada parâmetro de solicitação. Os parâmetros de solicitação fornecidos serão automaticamente codificados em URL.

  Alternativamente, os parâmetros de solicitação podem ser fornecidos na transformação de solicitação. 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 tanto neste campo quanto na transformação de solicitação, a especificada na transformação terá precedência.

  Para salvar a linha, clique no ícone de enviar na coluna mais à direita.

  Para editar ou excluir uma única linha, passe o mouse sobre a coluna mais à direita e use o ícone de editar ou o ícone de excluir .

  Para excluir todas as linhas, clique em Limpar Tudo.

  Importante

  Os campos na tabela Parâmetros de Solicitação exibem o ícone de variável apenas no modo de edição. Para que os valores de variável desses campos sejam preenchidos em tempo de execução, a versão do agente deve ser pelo menos 10.75 / 11.13.

  Os campos na tabela Parâmetros de Solicitação não suportam o uso de variáveis para passar JSON bruto. Se seu caso de uso não suportar a definição de JSON bruto nos campos diretamente, escape o conteúdo JSON antes de passá-lo com uma variável. Por exemplo, escapar {"success": "true"}; se torna {\"success\": \"true\"};.

• Cabeçalhos de Solicitação: Clique no ícone de adicionar para adicionar uma linha à tabela abaixo e insira um Nome e Valor para cada cabeçalho de solicitação.

  Alternativamente, 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. 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 de solicitação substitui todos os campos abaixo.
2. Um cabeçalho fornecido no campo Request Headers de uma atividade HTTP v2 PATCH (este campo) substitui o restante dos campos abaixo.
3. Um cabeçalho fornecido no campo Request Headers de uma conexão HTTP v2, se Send Request Headers in Activity Execution 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 o ícone de exclusão .

Para excluir todas as linhas, clique em Clear All.

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

  Essas configurações adicionais são suportadas:

  Chave	Valor Padrão	Tipo de Dado	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 é de 30000 milissegundos (30 segundos). Defina como 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 há 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. Defina como 0 ou um número negativo para impedir o seguimento de quaisquer redirecionamentos.
  trailing-linebreaks	false	String	Remove espaços em branco e quebras de linha no início e no final quando definido como true. Se esta configuração não for especificada ou definida como false, os dados permanecem inalterados.

  Alternativamente, configurações adicionais podem ser fornecidas na transformação da 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 o tipo de conteúdo, se a mesma chave de configuração for especificada tanto neste campo quanto na transformação da solicitação, a especificada na transformação tem precedência.

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

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

Para salvar a linha, clique no ícone de enviar na coluna mais à direita.

Para editar ou excluir uma única linha, passe o mouse sobre a coluna mais à direita e use o ícone de editar ou o ícone de excluir .

Para excluir todas as linhas, clique em Limpar Tudo.

• Multipart: Selecione para suportar requisições multipart/form-data ao usar esquemas padrão. Isso é necessário para requisições que incluem uploads de formulário RFC 1867.

  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 que um código de status não bem-sucedido seja retornado da API que o conector está chamando. O valor padrão é não selecionado.

  • Selecionar código de status HTTP a ser considerado sucesso em tempo de execução da operação: Selecione Agrupado por Classe ou Granular (Entrada Manual) para considerar códigos de status especificados como bem-sucedidos nos logs de operação.

    • Agrupado por Classe: Quando selecionado, um dropdown é exibido com classes de códigos de status não bem-sucedidos a serem tratados como bem-sucedidos. As opções do dropdown incluem Redirecionamento 3xx, Erro do Cliente 4xx e Erro do Servidor 5xx. O valor padrão do dropdown é 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 qualquer etapa. Uma mensagem pergunta se você deseja confirmar 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á utilizado.

• 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 instruções sobre como completar esta seção da 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 qualquer 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á utilizado.

• 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 instruções sobre como completar esta seção da 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 utilizado 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 é envolto dentro de uma estrutura definida pelo Jitterbit, permitindo que parâmetros adicionais sejam acessíveis no esquema:

  

  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 não bem-sucedido.

  • 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 de root. Como um novo esquema é gerado para esse propósito, o original sem o wrapper pode ser usado posteriormente, se necessário.

• Voltar: Clique para armazenar temporariamente a configuração para esta 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 Finalizado na última etapa.

• Descartar Alterações: Após fazer alterações, clique para fechar a configuração sem salvar as alterações feitas em qualquer etapa. Uma mensagem pede para você confirmar 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 o mapeamento de transformação.

  Se algum esquema personalizado foi fornecido nas etapas anteriores, eles serão exibidos. 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 se regeneram automaticamente com base nas atualizações feitas nos esquemas definidos em etapas anteriores.

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

• Solicitação:

  Nó/Campo do Esquema de Solicitação	Notas
  json	Formato do esquema de solicitação
  request	Nó de solicitação
  root	Nó raiz
  headers	Nó de cabeçalhos
  item	Nó de um cabeçalho específico
  key	Chave do cabeçalho
  value	Valor do cabeçalho
  requestParameters	Nó de parâmetros de solicitação
  item	Nó de um parâmetro de solicitação específico
  key	Chave do parâmetro de solicitação
  value	Valor do parâmetro de solicitação
  multipart	Nó de um multipart (incluído apenas quando Multipart é selecionado na interface de configuração da atividade e os esquemas padrão são usados)
  plainText	Nó das partes de texto simples de um multipart
  item	Nó de uma parte de texto simples específica no multipart
  key	Chave da parte de texto simples que mapeia para seu atributo name na carga útil da solicitação
  value	Valor da parte de texto simples que mapeia para seu conteúdo na carga útil da solicitação
  contentType	Content-Type da parte de texto simples Nota Este campo tem precedência sobre um cabeçalho Content-Type fornecido no nó headers.
  fileData	Nó das partes de dados de arquivo de um multipart
  item	Nó de uma parte de dados de arquivo específica no multipart
  key	Chave da parte de dados de arquivo que mapeia para seus atributos name e filename na carga útil da solicitação. Deve incluir a extensão do arquivo, se conhecida Nota Se um caminho for fornecido para esta chave e o campo fileName for deixado vazio, o atributo filename conterá apenas o nome e a extensão do arquivo.
  value	Valor da parte de dados de arquivo que mapeia para seu conteúdo na carga útil da solicitação Importante A string fornecida para este valor representa o próprio arquivo e deve ser codificada em formato Base64. Veja Base64encodefile em Funções Criptográficas para saber como codificar um arquivo usando um script.
  fileName	String representando o nome do arquivo da parte de dados de arquivo que mapeia para seu atributo filename na carga útil da solicitação. Deve incluir a extensão do arquivo, se conhecida. Este campo tem precedência sobre o que está definido no campo key para o atributo filename
  mimeType	String representando o tipo MIME (mídia) da parte de dados de arquivo, independente das extensões de arquivo fornecidas nos campos key ou fileName
  additionalSettings	Nó de configurações adicionais
  item	Nó de uma configuração adicional específica
  key	Chave da configuração adicional
  value	Valor da configuração adicional
  body	Corpo da solicitação
  bodyContentType	Content-Type do corpo da solicitação Nota Este campo tem precedência sobre um cabeçalho Content-Type fornecido no nó headers.

  • Resposta:

    Nó/Campo do Esquema de Resposta	Notas
    json	Formato do esquema de resposta
    response	Nó de resposta
    responseItem	Nó do item de resposta
    status	Um booleano indicando se uma resposta foi retornada
    properties	Propriedades da resposta
    headers	Nó de cabeçalhos
    item	Nó de um cabeçalho específico
    key	Chave do cabeçalho
    value	Valor do cabeçalho
    responseContent	Conteúdo da resposta
    error	Nó de erro
    statusCode	Código de status HTTP da resposta
    statusMessage	Mensagem de status da resposta
    details	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 de 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 qualquer etapa. Uma mensagem solicita que você confirme que deseja descartar as alterações.

Próximas etapas

Após configurar uma atividade HTTP v2 PATCH, complete a configuração da operação adicionando e configurando outras atividades ou ferramentas como etapas da operação. Você também pode configurar as configurações da operação, que incluem a capacidade de encadear operações que estão no mesmo ou em diferentes fluxos de trabalho.

As ações do menu para uma atividade estão acessíveis a partir do painel do projeto e da tela de design. Para detalhes, consulte o menu de ações da atividade em Conceitos básicos do conector.

Atividades HTTP v2 PATCH que são usadas como fonte podem ser utilizadas com esses padrões de operação:

• Padrão de transformação
• Padrão de arquivo de dois alvos (como a primeira fonte apenas)
• Padrão de arquivo HTTP de dois alvos (como a primeira fonte apenas)
• Padrão de duas transformações (como a primeira ou segunda fonte)

Atividades HTTP v2 PATCH que são usadas como alvo podem ser utilizadas 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, escreva os dados em um local temporário e, em seguida, use esse local temporário na função de script.

Quando estiver pronto, implante e execute a operação e valide o comportamento verificando os logs da operação.