Saltar al contenido

Arreglos JSON REST (drill downs) en Jitterbit App Builder

Introducción

App Builder soporta la transmisión de arreglos JSON complejos y anidados a través de la función Drill Down. Esto permite a los desarrolladores construir estructuras de datos jerárquicas al especificar relaciones entre una llamada API raíz y sus sub-tablas relacionadas.

Al usar drill downs, se puede navegar por una estructura JSON para asegurar que los registros padre y sus registros hijo asociados se procesen en una sola operación unificada.

Arreglos JSON en solicitudes GET

Un caso de uso común para los arreglos JSON es una relación "Uno a Muchos", como un cliente con múltiples direcciones. En una solicitud GET estándar, App Builder interpreta estos como una colección donde el objeto raíz contiene un arreglo de objetos hijo.

El siguiente JSON muestra un registro de cliente con múltiples direcciones:

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

App Builder crearía una tabla raíz con el ID y el Nombre, y una tabla adicional Dirección para contener las direcciones, vinculada a la tabla raíz por la clave foránea ID.

Configurar solicitudes POST con datos anidados

Para enviar datos anidados a un servicio externo, primero se debe organizar los datos locales y luego configurar el endpoint API correspondiente para aceptar la estructura jerárquica.

Paso 1: Organizar datos locales

Asegúrese de que su base de datos local refleje la estructura que pretende enviar. Por ejemplo, una tabla local Cliente debería estar vinculada a una sub-tabla Dirección a través de una clave foránea CustomerID.

Paso 2: Configurar el endpoint POST

Defina la estructura de los datos salientes dentro de la configuración del servidor de datos REST.

  1. Navegue a IDE > Servidores de Datos.

  2. Abra su servidor de datos REST y seleccione Endpoints.

  3. Agregue o edite un endpoint POST.

  4. En Cuerpo de Solicitud, proporcione un objeto JSON de ejemplo que incluya tanto el registro padre como el arreglo hijo.

  5. Verifica que App Builder haya generado las tablas necesarias para el endpoint REST.

Nota

El campo Request Body solo está disponible para endpoints POST.

Configuración de la llamada a la API

Para enviar datos anidados con éxito, debes definir reglas de llamada a la API jerárquicas que reflejen la estructura de tu JSON.

Paso 1: Define la regla raíz

Crea una regla de tipo llamada a la API que apunte a la tabla raíz (por ejemplo, customers (post)). Esta regla es responsable de insertar campos primarios como ID y Name.

Paso 2: Define la regla anidada

Crea una regla secundaria de tipo llamada a la API que apunte a la ruta anidada (por ejemplo, customers (post)/addresses). Esta regla inserta la información relacionada de los hijos en el arreglo.

Cómo usar Drill Down

La configuración de Drill Down es el mecanismo que conecta reglas de llamada a la API separadas en una sola operación anidada. Sigue estos pasos:

  1. Navega a la regla de llamada a la API de nivel superior.

  2. Abre Configuraciones Avanzadas y localiza el panel de Drill Downs.

  3. Haz clic en + Drill Down y especifica la sub-regla que se ejecutará (por ejemplo, Customer_Address_POST).

  4. Configura el enlace para asegurar que los datos de los hijos estén correctamente mapeados al registro padre.