Cómo definir respuestas de error personalizadas
Resumen
Así como puedes definir formatos y plantillas para las respuestas exitosas de la solicitud al método, puedes definir plantillas de error para cada formato que hayas agregado y para cada tipo de error conocido.
Configurar plantillas de error personalizadas
Al crear o editar un método se mostrará un listado de Planillas de error que puedes gestionar en cada método de tus APIs.
Allí puedes definir un error genérico para cualquier tipo de error, o errores específicos según los códigos de error.
Debes considerar que los códigos que aquí se muestran son códigos de error internos de la plataforma que se mapean con los códigos de error entregados por tus orígenes de datos.
- METHOD DEFAULT: Es el error por defecto que aplicará para todos los códigos de error y todos los formatos de salida que hayas agregado al método.
- 204 - NO DATA FOUND: Por defecto el estado 204 entrega una respuesta sin contenido. En caso de definirse una plantilla personalizada se cambiará el estado de la respuesta a 500 y se mostrará el contenido de la plantilla que aquí definas.
El error 204 puede darse porque el origen de datos respondió de forma correcta pero sin contenido o, por ejemplo, porque en la vista de datos se aplicó un filtro y no hay resultado para los valores enviados. - 404 - NOT FOUND: Si el origen de datos responde con error 404 aplicará esta plantilla.
- 408 - REQUEST ACCEPTED: Cuando un origen de datos demora más de 20 segundos en responder, la plataforma responde con el código de error 408 que representa que la solicitud ha sido recibida pero no hay un respuesta disponible en ese momento. La plataforma continúa intentando recibir la respuesta del origen de datos aunque no se reintente la solicitud al método de la API. Una vez que la respuesta está disponible, hay realizar la solicitud al método se entregará la respuesta.
Esta plantilla le permite establecer un mensaje de espera y solicitud de reintento personalizada. - 422 - TABLE NOT FOUND: Este código de error aplica únicamente cuando su origen de datos en un archivo Excel y no se encuentra la hoja/tabla que fue referenciada en la vista de datos. Un caso común es que la hoja que fue referenciada al crear la vista de datos haya sido eliminada del archivo Excel.
- 500 - INTERNAL SERVER ERROR: Este código de error aplica cuando su origen de datos responde con error 500.
- 502 - ORIGIN RESPONSE ERROR: Este código de error aplica cuando su origen de datos responde con algún código de error que no fue posible mapear con el resto de los códigos de error disponibles.
Related Articles
Introducción a WorkSpace
Resumen Workspace es donde acceden los usuarios administradores, publicadores y editores para gestionar las APIs. En esta sección encontrarás la documentación relacionada al Workspace. Sugerimos que continúe la lectura de Qué son los recursos de ...Qué es una vista de datos
Resumen La plataforma no requiere de un proceso ETL off-line para extraer los datos desde los orígenes, sino que asociadas a la vista se encuentran un conjunto de reglas que el motor de datos interpreta para consultar la fuente a demanda o ...Cómo definir formatos de respuesta de los métodos
Resumen Los formatos de salida permiten definir uno o más formatos de respuesta en los métodos de su API. Los formatos de salida pueden ser mútiples en formato JSON, aunque también puede exponer los datos en CSV y XML. Configurar formatos Al crear un ...Crear métodos de APIs
Resumen En el articulo Crear y gestionar versiones de APIs se mostraron los primeros pasos necearios para crear APIs. Los métodos definen la acción que se realizará sobre un determinado recurso. Como primer paso debe seleccionar la opción de Agregar ...Configuración general de la cuenta
Resumen Puedes configurar información general de la cuenta en la sección Configuraciones. Información de la cuenta En esta sección puedes configurar información contextual para el equipo de Vor-Tex: El nombre de la organización. La dirección del ...