Trabajo con tareas de REST

Para llamar a un punto final de API de REST, proporcione la información para ejecutar y completar la solicitud REST en una tarea de REST.

La creación de una tarea de REST implica los siguientes pasos principales:

• Definir detalles de ejecución: defina los detalles de ejecución de la solicitud de REST, incluido el método HTTP, la URL y la cabecera de solicitud.

  La URL es el servidor REST con el que contactar y la ruta relativa al recurso al que desea acceder en la solicitud. Por ejemplo:

  http://myserver.com:8081/workspaces/finance1234/dataAssets

  Para un método POST o PUT, también debe proporcionar el cuerpo de la solicitud. Actualmente, solo JSON es el formato soportado para un cuerpo de solicitud.

  La definición de los detalles de ejecución en Data Integration es la misma para operaciones de API de ejecución corta y operaciones de API de ejecución larga.

• Especificar los criterios de finalización: especifique los criterios de condición correcta que se deben cumplir para que la tarea de REST se complete correctamente.

  Escriba la condición que se evalúe como true o false mediante la respuesta de la llamada de REST en el paso de ejecución. Si la condición devuelve true, el resultado de la tarea de REST es correcto. Si es false, el resultado es una tarea de REST con fallos.

  Data Integration proporciona una condición correcta por defecto que puede utilizar o editar.

  La especificación de los criterios de finalización para una operación de API de larga ejecución requiere la adición de una condición de sondeo y otros valores de sondeo. La agregación de una solicitud de termination es opcional.

Consulte también Parámetros en una tarea de REST y lo que debe configurar antes de utilizar la entidad de recurso de Oracle Cloud Infrastructure para autenticar un punto final de API en una tarea de REST.

Para una operación de API de REST de larga ejecución, además de una condición correcta, debe especificar una URL de sondeo y una condición, así como valores de intervalo de sondeo y timeout para identificar la finalización de la llamada de REST.

La configuración de sondeo se utiliza para sondear periódicamente el estado de la llamada de REST que se llama en el paso de ejecución.

En el sondeo, la condición correcta es una expresión que se escribe en la respuesta de la solicitud de sondeo. La llamada de sondeo evalúa la condición de sondeo para determinar si el sondeo se para o continúa. Data Integration emite una llamada de sondeo varias veces en el intervalo de sondeo especificado hasta que se alcanza el valor del timeout de sondeo especificado o hasta que la condición de sondeo devuelve false, lo que ocurra primero.

El intervalo de sondeo es el tiempo de espera antes de enviar la siguiente solicitud de sondeo. El timeout de sondeo es el período de tiempo máximo que se permite para que se repita el sondeo en el ratio de intervalo especificado. El valor de intervalo debe ser inferior al valor de timeout.

Supongamos que el timeout de sondeo es de 24 horas y que el intervalo de sondeo es de 1 hora. Después de llamar a la solicitud de REST en el paso de ejecución, la solicitud de REST de sondeo se envía a intervalos de 1 hora, pero solo durante un máximo de 24 horas o hasta que la condición de sondeo devuelva false.

Si se cumplen los criterios especificados en la condición correcta, la llamada de REST se completa correctamente y la ejecución de la tarea de REST se considera correcta. Si la condición correcta devuelve un valor false, el resultado de la ejecución de la tarea de REST se considera con fallos.

Por ejemplo, suponga que la configuración de sondeo sondea el progreso de una tarea ejecutada mediante la evaluación del estado en la respuesta:

cast(json_path(SYS.RESPONSE_PAYLOAD_JSON, '$.status') as String) != 'SUCCESS' or cast(json_path(SYS.RESPONSE_PAYLOAD_JSON, '$.status') as String) != 'ERROR'

El sondeo se para cuando se cumple la condición correcta.

cast(json_path(SYS.RESPONSE_PAYLOAD_JSON, '$.status') as String) == 'SUCCESS'

La configuración del método HTTP y la URL de REST para terminar la llamada de REST es opcional para una operación de API de larga ejecución.

La definición de los detalles de la solicitud de terminación de REST en Data Integration es similar a la definición de la solicitud REST en el paso de ejecución. Sin embargo, puede incluir expresiones que utilicen la respuesta de API del paso de ejecución de REST en la URL de terminación.

Si termina una ejecución de tarea de REST y no se proporciona una configuración de terminación en esa tarea de REST, Data Integration:

• Para la ejecución de la tarea de REST
• No para la operación de API subyacente llamada por la tarea de REST

Si se proporciona una configuración de terminación, Data Integration parará la ejecución de la tarea de REST y la operación de API subyacente.

Proporcione la autenticación para llamar al punto final de la API de REST en la tarea de REST.

Actualmente, puede utilizar la entidad de recurso de Oracle Cloud Infrastructure como método para autenticar los puntos finales de la API de Oracle Cloud Infrastructure. Puede utilizar el espacio de trabajo o la entidad de recurso de aplicación.

Puede incluir parámetros en una tarea de REST para poder reutilizar la tarea en diferentes situaciones de tiempo de ejecución.

Puede utilizar parámetros para las siguientes partes de la solicitud de REST en una tarea de REST:

• Una o más secciones de la URL de ejecución de REST, la URL de sondeo o la URL de terminación. En Data Integration, las secciones de variables con parámetros de la URL se denominan parámetros de URL. Consulte Configuración del método HTTP, la URL y los parámetros de URL.
• El valor de una cabecera en la solicitud. Consulte Parametrización de un valor de cabecera.
• Todo el cuerpo de la solicitud en una solicitud POST o PUT. Consulte Parametrización del cuerpo de solicitud.
• La condición correcta que determina los criterios para una finalización correcta de la llamada de REST. Consulte Parametrización de la condición correcta.
• La condición de votación (escrita en la respuesta que se devuelve de la solicitud de votación) que determina si el sondeo se para o continúa. Consulte Parametrización de la condición de sondeo.