Saltar al contenido

Crear una operación de entidad API

Introducción

En esta página se describe cómo crear una operación de entidad API. La entidad Jitterbit y la operación de entidad API se utilizan para crear una API de servicio OData. Cuando se completa la operación de entidad API, la operación se asignará a una API de servicio OData.

Consejo

  • Debes estar usando Design Studio (no Integration Studio) para crear una operación de entidad API.
  • Antes de poder crear una operación de entidad API, debe haber completado lo siguiente:
    • Las operaciones residen dentro de un proyecto. Antes de poder crear una operación de entidad API, deberá seguir las instrucciones para Crear un nuevo proyecto en Design Studio.
    • Las operaciones de entidad API se asignan a una entidad Jitterbit. Deberá seguir las instrucciones en Crear una entidad Jitterbit antes de crear una operación de entidad API.
    • Un proyecto puede contener varias entidades. Cada entidad puede contener una o más operaciones de entidad API, pero solo una operación por método HTTP.

Crear una operación de entidad API

  1. Abra su proyecto en la aplicación Design Studio. La pantalla Primeros pasos debería mostrar lo siguiente:

    archivo adjunto

    • El panel en el lado izquierdo del Design Studio enumera los elementos del proyecto que utilizará para crear su integración, como Operaciones, Transformaciones, Secuencias de comandos, etc. Desplácese hacia abajo dentro del panel hasta Operaciones.
    • Haga clic derecho en Operaciones y seleccione Nueva operación en el menú desplegable.
  2. La ventana emergente Seleccionar tipo muestra la lista de tipos de operación disponibles dentro de Design Studio. Seleccione Operación de entidad API de la lista de opciones y luego haga clic en Continuar:

    archivo adjunto

  3. La ventana emergente Entity Wizard debería mostrarse de forma similar a la imagen que se muestra a continuación. Una entidad define los datos disponibles para un servicio OData y consta de un extremo, una selección de objetos y una selección de campos específicos. Cualquier entidad existente disponible dentro del proyecto se enumera debajo de la carpeta Entidades Jitterbit:

    archivo adjunto

    • Crear nueva entidad Jitterbit: Seleccione esta opción si una entidad no está disponible en el proyecto y no aparece en el Asistente de entidades como se muestra arriba. El Asistente de entidades lo guía a través del proceso de creación de la entidad, la selección de las tablas u objetos y la selección de los campos. Siga las instrucciones que se describen en Crear una entidad Jitterbit a medida que continúa en el Asistente de entidad.
    • Use una entidad Jitterbit existente en el proyecto: Puede crear la entidad antes de crear su operación siguiendo las instrucciones en Crear una entidad Jitterbit. Todas las entidades existentes disponibles dentro de su proyecto se enumeran debajo de la carpeta Entidades Jitterbit en la sección superior derecha del Asistente de entidades, como se muestra arriba. Al hacer clic en una entidad existente en la lista de entidades disponibles, se selecciona automáticamente Usar una entidad Jitterbit existente en el proyecto.
    • Para este ejemplo, se selecciona la entidad Clientes. Haga clic en Siguiente en la parte inferior de la pantalla para continuar:

      adjunto

  4. Aparece la pantalla Transformaciones:

    archivo adjunto

    1. Transformaciones de paso:

      • Jitterbit crea una operación de paso a través de forma predeterminada.
      • Deje las casillas de verificación Transformación de solicitud y Transformación de respuesta en blanco si no se requiere una asignación personalizada.
      • En este ejemplo, optamos por la transformación de paso básica y no seleccionamos ninguna casilla de verificación:

        archivo adjunto

      • Haga clic en Finalizar en la parte inferior de la ventana. La operación de transferencia se crea y se muestra en la pestaña Operaciones de Design Studio:

        archivo adjunto

    2. Necesito asignaciones personalizadas en:

      • Transformación de solicitud: Haga clic en la casilla de verificación si se requiere una asignación personalizada de la solicitud.
      • Transformación de respuesta: Haga clic en la casilla de verificación si se requiere una asignación personalizada de la respuesta.
      • En este ejemplo, las casillas de verificación Transformación de respuesta y Transformación de solicitud están seleccionadas:

        archivo adjunto

      • El botón Siguiente se activa automáticamente. Haga clic en Siguiente.

      • Aparece un mensaje de advertencia dentro del Asistente de entidad: " La transformación personalizada solo se admite con entidades GET ( APIs de OData )".
      • Haga clic en Finalizar en la parte inferior de la ventana. La operación se crea y se muestra en Design Studio con una solicitud personalizada y una transformación de respuesta personalizada:

        archivo adjunto

      • Haga clic con el botón derecho en la transformación Clientes - Solicitud y seleccione Editar clientes - Solicitud para abrir la pantalla de asignación de campos en la pestaña Transformaciones. Puede crear asignaciones personalizadas con secuencias de comandos según sea necesario:

        archivo adjunto

      • Repita este paso en la transformación Clientes - Respuesta para asignar los campos de respuesta adecuadamente.

      • Una vez completado el mapeo, haga clic en el archivo archivo adjunto Icono Guardar en la barra de herramientas. Haga clic en Desplegar archivo adjunto en la barra de herramientas para desplegar todo el proyecto en Harmony.
  5. Próximo paso: Consulte Configuración del servicio OData sobre el uso de la nueva entidad y la operación de entidad API.