Configurar plantillas API

La biblioteca API para Business Central proporciona una representación simplificada de las entidades subyacentes. Todas las propiedades de la aplicación no están expuestas a través de la API asociada. La página Configuración de API le permite definir plantillas que se utilizan para llenar propiedades vacías en una entidad cuando crea una acción POST a través de la API.

Por ejemplo, si se define una plantilla de configuración para la entidad del elemento, cuando se crea un nuevo registro del elemento a través de la API de elementos, las propiedades del nuevo elemento que no están definidas en la API se rellenarán a partir de la plantilla seleccionada. Si, por ejemplo, no se define ningún valor para el campo Grupo contable producto a través de la API, pero se define un valor en la plantilla seleccionada, el valor del grupo definido en la plantilla se aplicará al nuevo elemento.

Configuración de la plantilla de entidad

Para usar plantillas con la biblioteca API, primero debe configurar y definir propiedades para las plantillas. Puede configurar estas plantillas en la página Plantillas de configuración. Para más información, consulte Migración de datos locales a Business Central Online en el contenido de administración (solo en inglés).

Asigne la plantilla a una API

Para asignar una plantilla a una API, debe seguir los siguientes pasos.

Nota

Las plantillas de API solo se pueden configurar con las siguientes páginas de API: contactos, countriesRegions, divisas, clientes, empleados, itemCategories, paymentMethods, paymentTerms, shipmentMethods, unitsOfMeasure, y proveedores.

1. Elija el icono , escriba Configuración de API y luego elija el enlace relacionado.

2. Seleccione Nuevo y el valor Orden para el registro.

   Si hay más de una plantilla seleccionada para una API (ID de página), las plantillas se aplican en el orden definido en la columna Pedido.

   Cuando se aplican las plantillas, los valores de campo definidos en la plantilla solo se aplican a los campos que aún no tienen un valor definido, ya sea explícitamente en la API o en una plantilla previamente aplicada en el pedido.

3. Seleccionar un valor de ID de página.

   Esta es la página de la API a la que se aplicará la plantilla. La búsqueda de ID de página proporciona una lista de todas las API disponibles en la biblioteca.

4. Seleccione un valor en el campo Código de plantilla.

   El código de plantilla es el código para la plantilla que se definió en la página Plantillas de configuración. Los valores de plantilla definidos se aplican a la API.

5. En el campo Condiciones, especifique qué plantilla se debe aplicar.

   La plantilla definida se aplica a un nuevo registro creado a través de la API si, y únicamente en el caso de que, las condiciones definidas en el campo Condiciones se cumplan con los valores ya definidos para la nueva instancia de la entidad.

Consulte también

Documentación de la API
Desarrollar Connect Apps para Business Central
Activar las API
Extremos para las API
Administración

Encuentre módulos de aprendizaje en línea gratuitos de Business Central aquí