REST JSON arrays (drill downs) in Jitterbit App Builder

Introdução

O App Builder suporta a transmissão de arrays JSON complexos e aninhados através do recurso Drill Down. Isso permite que os desenvolvedores construam estruturas de dados hierárquicas especificando relacionamentos entre uma chamada de API raiz e suas sub-tabelas relacionadas.

Ao usar drill downs, é possível navegar em uma estrutura JSON para garantir que os registros pai e seus registros filho associados sejam processados em uma única operação unificada.

Arrays JSON em requisições GET

Um caso de uso comum para arrays JSON é um relacionamento "Um-para-Muitos", como um cliente com vários endereços. Em uma requisição GET padrão, o App Builder interpreta isso como uma coleção onde o objeto raiz contém um array de objetos filho.

O seguinte JSON mostra um registro de cliente com múltiplos endereços:

"customers": [
    {
        "id": 1,
        "name": "Preston",
        "addresses": [
            {
                "street": "123 Broadway",
                "city": "NYC",
                "state": "NY"
            },
            {
                "street": "456 Multi-region Street",
                "city": "Boston",
                "state": "MA"
            }
        ]
    },
]

O App Builder criaria uma tabela raiz com o ID e o Nome, e uma tabela adicional Endereço para conter os endereços, vinculada à tabela raiz pela chave estrangeira ID.

Configurar requisições POST com dados aninhados

Para enviar dados aninhados a um serviço externo, primeiro é necessário organizar seus dados locais e, em seguida, configurar o endpoint da API correspondente para aceitar a estrutura hierárquica.

Passo 1: Organizar dados locais

Certifique-se de que seu banco de dados local reflita a estrutura que você pretende enviar. Por exemplo, uma tabela local Cliente deve estar vinculada a uma sub-tabela Endereço via uma chave estrangeira CustomerID.

Passo 2: Configurar o endpoint POST

Defina a estrutura dos dados de saída dentro da configuração do servidor de dados REST.

1. Navegue até IDE > Servidores de Dados.

2. Abra seu servidor de dados REST e selecione Endpoints.

3. Adicione ou edite um endpoint POST.

4. Em Corpo da Requisição, forneça um objeto JSON de exemplo que inclua tanto o registro pai quanto o array filho.

5. Verifique se o App Builder gerou as tabelas necessárias para o endpoint REST.

Configuração da Chamada da API

Para enviar dados aninhados com sucesso, você deve definir regras de Chamada da API hierárquicas que reflitam a estrutura do seu JSON.

Passo 1: Defina a regra raiz

Crie uma regra do tipo Chamada da API que tenha como alvo a tabela raiz (por exemplo, customers (post)). Essa regra é responsável por inserir campos principais como ID e Name.

Passo 2: Defina a regra aninhada

Crie uma regra secundária do tipo Chamada da API que tenha como alvo o caminho aninhado (por exemplo, customers (post)/addresses). Essa regra insere as informações relacionadas do filho no array.

Como usar o Drill Down

A configuração de Drill Down é o mecanismo que conecta regras separadas de Chamada da API em uma única operação aninhada. Siga estes passos:

1. Navegue até a regra de Chamada da API de nível superior.

2. Abra Configurações Avançadas e localize o painel Drill Downs.

3. Clique em + Drill Down e especifique a sub-regra a ser executada (por exemplo, Customer_Address_POST).

4. Configure o mapeamento para garantir que os dados do filho sejam corretamente vinculados ao registro pai.