Saltar al contenido

Actividad OPCIONES HTTP v2

Introducción

Una actividad HTTP v2 OPCIONES, que utiliza su conexión HTTP v2, recupera información sobre las opciones de comunicación para un recurso en un servicio accesible a través del protocolo HTTP o HTTPS, y puede usarse como fuente (para proporcionar datos en una operación) o como destino (para consumir datos en una operación).

Crear una actividad OPCIONES HTTP v2

Se crea una instancia de una actividad HTTP v2 OPCIONES a partir de una conexión HTTP v2 utilizando su tipo de actividad OPCIONES.

Para crear una instancia de una actividad, arrastre el tipo de actividad al tela de diseño o copie el tipo de actividad y péguelo en el tela de diseño. Para obtener más detalles, consulte Creación de una instancia de actividad en Reutilización de componentes.

Se puede editar una actividad HTTP v2 OPCIONES existente desde estas ubicaciones:

Configurar una actividad OPCIONES HTTP v2

Siga estos pasos para configurar una actividad HTTP v2 OPCIONES:

Paso 1: Ingrese un nombre y especifique la configuración

En este paso, proporcione un nombre para la actividad y especifique la URL, los parámetros de solicitud, los encabezados de solicitud y las configuraciones adicionales. A continuación, se describe cada elemento de la interfaz de usuario de este paso.

OPCIONES HTTP v2, paso 1 de configuración de la actividad

Sugerencia

Campos con un ícono de variable Ícono de variable admite el uso de variables globales, variables del proyecto y variables Jitterbit. Comience escribiendo un corchete abierto [ en el campo o haciendo clic en el icono de variable para mostrar una lista de las variables existentes entre las que elegir.

Importante

Los campos de las tablas muestran el ícono de variable Ícono de variable solo en modo de edición. Para que los valores de las variables de estos campos se completen en tiempo de ejecución, la versión del agente debe ser al menos 10.75 / 11.13.

  • Nombre: Ingrese un nombre para identificar la actividad. El nombre debe ser único para cada actividad HTTP v2 OPCIONES y no debe contener barras diagonales / o dos puntos :.

  • Ruta: Ingrese una URL para usar en la actividad:

    • Si se deja en blanco, la URL base configurada en la conexión HTTP v2 se utilizará en tiempo de ejecución.
    • Si se especifica una ruta parcial, se agregará a la URL base configurada en la conexión HTTP v2.
    • Si se especifica una URL completa, anulará la URL base configurada en la conexión HTTP v2.

    Los parámetros de solicitud se pueden incluir encerrándolos entre llaves. { }. Parámetros de consulta (como /queryrecord?id=10) también se puede utilizar.

    • URL: Muestra la URL completa que se utilizará en tiempo de ejecución.

  • Parámetros de solicitud: Haga clic en el ícono de agregar agregar ícono para agregar una fila a la tabla que aparece a continuación e ingresar un Nombre y un Valor para cada parámetro de solicitud. Los parámetros de solicitud proporcionados se codificarán automáticamente en URL.

    Como alternativa, los parámetros de solicitud se pueden proporcionar en la transformación de solicitud. Los parámetros de solicitud que no comparten una clave se envían de forma acumulativa, independientemente de dónde se especifiquen. Si se especifica la misma clave de parámetro tanto en este campo como en la transformación de solicitud, la especificada en la transformación tiene prioridad.

    Para guardar la fila, haga clic en el ícono de envío icono de envío en la columna más a la derecha.

    Para editar o eliminar una sola fila, pase el cursor sobre la columna más a la derecha y use el ícono de edición ícono de edición o eliminar icono eliminar icono.

    Para eliminar todas las filas, haga clic en Borrar todo.

  • Encabezados de solicitud: Haga clic en el ícono de agregar ícono de agregar para agregar una fila a la tabla a continuación e ingresar un Nombre y Valor para cada encabezado de solicitud.

    Como alternativa, los encabezados se pueden definir en otros campos de configuración de la interfaz de usuario o se pueden proporcionar en la transformación de la solicitud. Los encabezados que no comparten una clave se envían de forma acumulativa, independientemente de dónde se especifiquen.

    Si se especifica la misma clave de encabezado en varios lugares, se sigue este orden de precedencia:

    1. Un encabezado proporcionado en la transformación de la solicitud anula todos los campos siguientes.
    2. Un encabezado proporcionado en el campo Encabezados de solicitud de una actividad HTTP v2 OPCIONES (este campo) anula el campo restante a continuación.
    3. Un encabezado proporcionado en el campo Encabezados de solicitud de una conexión HTTP v2, si está habilitada la opción Enviar encabezados de solicitud en la ejecución de la actividad, tiene la menor prioridad.

    Nota

    Si se define un encabezado en varias ubicaciones, cada instancia del encabezado se agregará a la solicitud de una actividad siguiendo el orden de precedencia indicado anteriormente. Este orden se basa en cómo los servicios suelen manejar los encabezados duplicados en una solicitud.

    Para guardar la fila, haga clic en el ícono de envío icono de envío en la columna más a la derecha.

    Para editar o eliminar una sola fila, pase el cursor sobre la columna más a la derecha y use el ícono de edición ícono de edición o eliminar icono eliminar icono.

    Para eliminar todas las filas, haga clic en Borrar todo.

  • Configuración adicional: Haga clic en el ícono de agregar ícono de agregar para agregar una fila a la tabla a continuación e ingresar un Nombre y un Valor para cada configuración adicional.

    Se admiten estas configuraciones adicionales:

    Clave
    		 Valor predeterminado Tipo de datos Descripción
    connection-timeout 30000 Entero El tiempo de espera de transferencia en milisegundos. Si no se especifica esta configuración, el tiempo de espera de transferencia predeterminado es 30000 milisegundos (30 segundos). Establecido en 0 por un tiempo de espera ilimitado.TABLEROWEND
    content-type — Cadena El tipo de contenido de la estructura de solicitud que espera la API en particular. Por ejemplo, text/plain, application/json, application/x-www-form-urlencoded, etc. Si no se especifica esta configuración, no hay ningún valor predeterminado.
    max-redirect 50 Entero El número máximo de redirecciones a seguir. Si no se especifica esta configuración, el valor predeterminado es seguir 50 redirecciones. Establecer en 0 o un número negativo para evitar seguir cualquier redirección.
    trailing-linebreaks false Cadena Elimina los espacios en blanco iniciales y finales y los saltos de línea cuando se establece en true. Si esta configuración no se especifica o se establece en false, los datos no se modifican.

    Como alternativa, se pueden proporcionar configuraciones adicionales en la transformación de solicitud. Las configuraciones adicionales que no comparten una clave se envían de forma acumulativa, independientemente de dónde se especifiquen. Para todas las configuraciones excepto para content-type, si se especifica la misma clave de configuración tanto en este campo como en la transformación de solicitud, la especificada en la transformación tiene prioridad.

    Para content-type, un valor especificado aquí tiene prioridad sobre todos los demás lugares de la interfaz de usuario donde se puede especificar el tipo de contenido. Si se especifica el tipo de contenido en varios lugares, se sigue este orden de precedencia:

    1. Un Content-Type El encabezado proporcionado en la tabla Configuración adicional de una actividad HTTP v2 OPCIONES (esta tabla) anula todos los campos siguientes.
    2. El bodyContentType El campo especificado en una transformación de solicitud anula los campos restantes a continuación.
    3. Un Content-Type encabezado proporcionado en la transformación de la solicitud headers El nodo reemplaza los campos restantes a continuación.
    4. A Content-Type El encabezado proporcionado en el campo Encabezados de solicitud de una actividad HTTP v2 OPCIONES anula el campo restante a continuación.
    5. Un Content-Type El encabezado proporcionado en el campo Encabezados de solicitud de una conexión HTTP v2, si está habilitado Enviar encabezados de solicitud en ejecución de actividad, tiene la menor precedencia.

    Nota

    Si se define un encabezado en varias ubicaciones, cada instancia del encabezado se agregará a la solicitud de una actividad siguiendo el orden de precedencia indicado anteriormente. Este orden se basa en cómo los servicios suelen manejar los encabezados duplicados en una solicitud.

    Para guardar la fila, haga clic en el ícono de envío icono de envío en la columna más a la derecha.

    Para editar o eliminar una sola fila, pase el cursor sobre la columna más a la derecha y use el ícono de edición ícono de edición o eliminar icono eliminar icono.

    Para eliminar todas las filas, haga clic en Borrar todo.

  • Configuración opcional: Haga clic para expandir configuraciones opcionales adicionales:

    • Ignorar error de operación en caso de código de estado de error: Seleccione esta opción para que las operaciones informen un estado de error incluso si la API a la que llama el conector devuelve un código de estado de error. El valor predeterminado no está seleccionado.

    • Seleccione el código de estado HTTP que se considerará exitoso en el tiempo de ejecución de la operación: Seleccione Agrupado por clase o Granular (entrada manual) para considerar los códigos de estado especificados como exitosos en registros de operación.

      • Agrupado por clase: Cuando se selecciona, se muestra un menú desplegable con clases de códigos de estado no exitosos que se tratarán como exitosos. Las opciones del menú desplegable incluyen Redirección 3xx, Error de cliente 4xx y Error de servidor 5xx. El valor predeterminado del menú desplegable no está seleccionado.

      • Granular (entrada manual): Cuando se selecciona, se muestra un campo para ingresar manualmente una lista delimitada por comas de códigos de estado no exitosos que se tratarán como exitosos. Esta lista puede incluir diferentes clases de códigos de estado al mismo tiempo. El valor predeterminado del campo está en blanco.

        Estado granular HTTP v2

  • Guardar y salir: Si está habilitado, haga clic para guardar la configuración de este paso y cerrar la configuración de la actividad.

  • Siguiente: Haga clic para almacenar temporalmente la configuración de este paso y continuar con el siguiente paso. La configuración no se guardará hasta que haga clic en el botón Terminado en el último paso.

  • Descartar cambios: Después de realizar cambios, haga clic para cerrar la configuración sin guardar los cambios realizados en ningún paso. Un mensaje le solicitará que confirme que desea descartar los cambios.

Paso 2: Proporcionar el esquema de solicitud

En este paso, puede proporcionar un esquema de solicitud personalizado. Si no proporciona un esquema de solicitud personalizado, se utilizará el esquema de solicitud predeterminado del conector.

Paso 2 de configuración de la actividad del parche HTTP v2

  • Proporcionar esquema de solicitud: El esquema de solicitud define la estructura de los datos de solicitud que utiliza la actividad OPCIONES HTTP v2. Para obtener instrucciones sobre cómo completar esta sección de configuración de la actividad, consulte Esquemas definidos en una actividad.

  • Atrás: Haga clic para almacenar temporalmente la configuración de este paso y volver al paso anterior.

  • Siguiente: Haga clic para almacenar temporalmente la configuración de este paso y continuar con el siguiente paso. La configuración no se guardará hasta que haga clic en el botón Terminado en el último paso.

  • Descartar cambios: Después de realizar cambios, haga clic para cerrar la configuración sin guardar los cambios realizados en ningún paso. Un mensaje le solicitará que confirme que desea descartar los cambios.

Paso 3: Proporcionar el esquema de respuesta

En este paso, puede proporcionar un esquema de respuesta personalizado. Si no proporciona un esquema de respuesta personalizado, se utilizará el esquema de respuesta predeterminado del conector.

OPCIONES HTTP v2, paso 3 de configuración de la actividad

  • Proporcionar esquema de respuesta: El esquema de respuesta define la estructura de los datos de respuesta que utiliza la actividad OPCIONES HTTP v2. Para obtener instrucciones sobre cómo completar esta sección de configuración de la actividad, consulte Esquemas definidos en una actividad.

  • Incluir propiedades adicionales de la respuesta HTTP en el esquema: Cuando se selecciona Sí, usar esquema guardado o Sí, proporcionar nuevo esquema y el esquema utilizado tiene un tipo de archivo XML o JSON, se muestra la casilla de verificación Incluir propiedades adicionales de la respuesta HTTP en el esquema. Cuando se selecciona, el esquema se envuelve dentro de una estructura definida por Jitterbit, lo que permite que se pueda acceder a parámetros adicionales en el esquema:

    Propiedades adicionales de HTTP v2 en el esquema de respuesta

    {
  "__jitterbit_aditional_properties__": {
    "__jitterbit_api_headers__": [
      {
        "key": "",
        "value": ""
      },
      {
        "key": "",
        "value": ""
      }
    ],
    "__jitterbit_api_statuscode__": 200,
    "__jitterbit_api_errorbody__": ""
  },
  "root": {
    // Original JSON
  }
}

    <__jitterbitResponse__>
    <__jitterbit_aditional_properties__>
        <__jitterbit_api_headers__>
            <key>headerKey1</key>
            <value>headerValue1</value>
        </__jitterbit_api_headers__>
        <__jitterbit_api_headers__>
            <key>headerKey2</key>
            <value>headerValue2</value>
        </__jitterbit_api_headers__>
        <__jitterbit_api_statuscode__>200</__jitterbit_api_statuscode__>
        <__jitterbit_api_errorbody__>
        </__jitterbit_api_errorbody__>
    </__jitterbit_aditional_properties__>
    <root>
        <!-- Original XML -->
    </root>
</__jitterbitResponse__>

    • __jitterbit_api_headers__: Devuelve los encabezados proporcionados por la llamada de solicitud.

    • __jitterbit_api_statuscode__: Devuelve el código de estado de la llamada de solicitud.

    • __jitterbit_api_errorbody__: Devuelve el cuerpo de respuesta de la llamada de solicitud en formato de cadena si la llamada de solicitud devuelve un código de estado de error.

    • root: Alberga la estructura original del esquema de respuesta.

    Nota

    Cuando se selecciona, se genera un nuevo esquema con el contenedor. La estructura del esquema original se conserva dentro root Dado que para este fin se genera un nuevo esquema, el original sin el contenedor se puede utilizar más adelante, si es necesario.

  • Atrás: Haga clic para almacenar temporalmente la configuración de este paso y regresar al paso anterior.

  • Siguiente: Haga clic para guardar temporalmente la configuración de este paso y continuar con el siguiente. La configuración no se guardará hasta que haga clic en el botón Finalizado en el último paso.

  • Descartar cambios: Después de realizar los cambios, haga clic para cerrar la configuración sin guardar los cambios realizados en ningún paso. Un mensaje le solicitará que confirme que desea descartar los cambios.

Paso 4: Revisar los esquemas de datos

Se muestran los esquemas de solicitud y respuesta configurados.

OPCIONES HTTP v2, paso 4 de configuración de la actividad

  • Esquemas de datos: Estos esquemas de datos son heredados por transformaciones adyacentes y se muestran nuevamente durante el mapeo de transformación.

    Si se proporcionaron esquemas personalizados en los pasos anteriores, se mostrarán. Si no se proporcionaron esquemas personalizados, se mostrarán los esquemas predeterminados incluidos con el conector.

    Para las actividades HTTP v2, los esquemas de datos se regeneran automáticamente en función de las actualizaciones realizadas a los esquemas definidos en los pasos anteriores.

    Precaución

    Las actividades HTTP v2 creadas antes de la versión 10.85/11.23 de Harmony pueden tener un botón Actualizar manual presente debido a metadatos de proyecto definidos previamente. Si está presente, no interactúe con este botón. Cree una nueva instancia de una actividad afectada para eliminarla.

    Los esquemas de solicitud y respuesta predeterminados constan de estos nodos y campos:

    • Solicitud:

      Nodo/Campo del Esquema de Solicitud Notas
      json Formato del esquema de solicitud
      solicitud Nodo de solicitud
      raíz Nodo raíz
      encabezados Nodo de encabezados
      elemento Nodo de un encabezado específico
      clave Clave del encabezado
      valor Valor del encabezado
      requestParameters Nodo de parámetros de solicitud
      item Nodo de un parámetro de solicitud específico
      clave Clave del parámetro de solicitud
      valor Valor del parámetro de solicitud
      Configuracionesadicionales Nodo de configuraciones adicionales
      ítem Nodo de una configuración adicional específica
      tecla Tecla de configuración adicional
      valor Valor del ajuste adicional
      cuerpo Cuerpo de la solicitud
      tipoContenidoCuerpo Content-Typedel cuerpo de la solicitud

      Nota

      Este campo tiene prioridad sobre un Content-Type encabezado proporcionado en el headers nodo.

    • Respuesta:

      Nodo/Campo del esquema de respuesta Notas
      json Formato del esquema de respuesta
      respuesta Nodo de respuesta
      responseItem Nodo del elemento de respuesta
      estado Un valor booleano que indica si se devolvió una respuesta
      propiedades Propiedades de la respuesta
      encabezados Nodo de encabezados
      elemento Nodo de un encabezado específico
      clave Clave del encabezado
      valor Valor del encabezado
      responseContent Contenido de la respuesta
      error Nodo de error
      statusCode Código de estado HTTP de la respuesta
      statusMessage Mensaje de estado de la respuesta
      detalles Detalles de la respuesta

  • Atrás: Haz clic para guardar temporalmente la configuración de este paso y volver al paso anterior.

  • Terminado: Haz clic para guardar la configuración de todos los pasos y cerrar la configuración de la actividad.

  • Descartar cambios: Después de realizar los cambios, haz clic para cerrar la configuración sin guardar los cambios realizados en ningún paso. Un mensaje te pedirá que confirmes que deseas descartar los cambios.

Próximos pasos

Después de configurar una actividad HTTP v2 OPCIONES, complete la configuración de la operación agregando y configurando otras actividades, transformaciones o secuencias de comandos como pasos de la operación. También puede configurar los ajustes de la operación, que incluyen la capacidad de encadenar operaciones que se encuentran en el mismo flujo de trabajo o en flujos de trabajo diferentes.

Se puede acceder a las acciones del menú de una actividad desde el panel del proyecto y el tela de diseño. Para obtener más información, consulte menú de acciones de la actividad en Conceptos básicos del conector.

Las actividades HTTP v2 OPCIONES que se utilizan como fuente se pueden utilizar con estos patrones de operación:

Las actividades HTTP v2 OPCIONES que se utilizan como objetivo se pueden utilizar con estos patrones de operación:

Para utilizar la actividad con funciones de script, escriba los datos en una ubicación temporal y luego use esa ubicación temporal en la función de script.

Cuando esté listo, desplegar y ejecute la operación y validar el comportamiento comprobando los registros de operación.