Estructuras complejas de API REST en Jitterbit App Builder

Introducción

La API REST de App Builder admite estructuras complejas de API REST para operaciones GET. Esto hace posible solicitar datos de múltiples tablas y anidar los resultados en una única estructura JSON devuelta.

Nota

Otros métodos HTTP como POST y PUT no son compatibles.

Configuración

Navega a App Builder IDE > Extiende tu empresa > Publicar
Crea tu endpoint REST como de costumbre con tu tabla/endpoint raíz
Haz clic en el ícono de Estructura para tu endpoint
Agrega recursos secundarios según sea necesario

Parámetros de recurso

Nombre	Descripción
Padre	La tabla padre en la jerarquía.
Nombre	El nombre de este nodo en la estructura del árbol. Ten en cuenta que el nombre puede incluir barras diagonales para anidar la estructura aún más.
Tabla	La tabla de la que se recuperarán los datos.
Tipo de campo	El tipo de campo. Array de objetos: Este es el tipo predeterminado donde cada fila en la tabla es un objeto JSON. Array de escalares: Un array de elementos de valor único, serializados a un array JSON de escalares. La tabla debe contener columnas `Index` y `Value`. Objeto: Se mapea a un único objeto JSON (eliminando efectivamente el array JSON). La tabla solo debe devolver una fila como máximo.
Expandir por defecto	Si es verdadero, la tabla se expande por defecto (mostrada en el JSON de salida). Si es falso, el llamador REST deberá proporcionar una propiedad de cadena de consulta `$expand=true` para ver los datos Ten en cuenta que esta propiedad solo afecta a una solicitud de colección (por ejemplo, `/orders`). Una solicitud para un elemento específico en una colección (por ejemplo, `/orders/101`) siempre expandirá las tablas secundarias.
Límite máximo de obtención	Si se proporciona, indica el límite máximo de elementos que se pueden devolver en una solicitud `GET`. Si es NULL, se utiliza el valor máximo predeterminado para la API REST.
Vínculos de recursos	Configura los vínculos entre las tablas padre e hijo.

Cambios en los parámetros de consulta

Los siguientes parámetros de consulta han sido modificados para funcionar con estructuras complejas de API REST:

$fields permite especificar tablas secundarias:
- Por ejemplo, details/*: Todos los campos de la tabla secundaria details.
- Por ejemplo, details/name: Solo el campo name de la tabla secundaria details.
- Por ejemplo, *: Todos los campos en todas las tablas.
$expand es un parámetro verdadero/falso añadido para permitir que el llamador REST expanda tablas que no están expandidas por defecto (o viceversa). Solo se utiliza para solicitudes de colección:
- Por ejemplo, $expand=true.