Como Trabalhar com Tarefas REST

Para chamar um ponto final de API REST, forneça as informações para executar e concluir a solicitação REST em uma tarefa REST.

A criação de uma tarefa REST envolve as seguintes etapas principais:

• Definir os detalhes da execução: Defina os detalhes da execução da solicitação REST, incluindo o método HTTP, o URL e o cabeçalho da solicitação.

  O URL é o servidor REST a ser contatado e o caminho relativo para o recurso que você deseja acessar na solicitação. Por exemplo:

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

  Para um método POST ou PUT, você também fornece o corpo da solicitação. No momento, somente JSON é o formato suportado para um corpo de solicitação.

  A definição dos detalhes da execução no Data Integration é a mesma das operações de API de execução curta e longa.

• Especificar critérios de conclusão: Especifique os critérios de condição de sucesso que devem ser atendidos para considerar uma conclusão bem-sucedida da tarefa REST.

  Grave a condição avaliada como verdadeira ou falsa usando a resposta da chamada REST na etapa de execução. Se a condição retornar verdadeiro, o resultado da tarefa REST será bem-sucedido. Se for falso, o resultado será uma tarefa REST com falha.

  O Data Integration fornece uma condição de sucesso padrão que você pode usar ou editar.

  A especificação de critérios de conclusão para uma operação de API de longa execução exige a adição de uma condição de polling e outros valores de polling. A adição de uma solicitação de encerramento é opcional.

Consulte também Parâmetros em uma tarefa REST e o que você precisa configurar antes de usar o Controlador de Recursos do Oracle Cloud Infrastructure para autenticar um ponto final de API em uma tarefa REST.

Para uma operação de API REST de execução longa, além de uma condição de sucesso, você deve especificar um URL de sondagem e uma condição, além de valores de intervalo e timeout de sondagem para identificar a conclusão da chamada REST.

A configuração de apuração é usada para apurar periodicamente o status da chamada REST que é feita na etapa de execução.

Na pesquisa, a condição de sucesso é uma expressão gravada na resposta da solicitação de pesquisa. A chamada de sondagem avalia a condição de sondagem para determinar a interrupção ou a continuação da sondagem. O Data Integration emite uma chamada de pesquisa repetidamente no intervalo de pesquisa especificado até que o valor do timeout especificado seja atingido ou até que a condição de pesquisa retorne falso, o que ocorre primeiro.

O intervalo de sondagem é o tempo de espera antes de enviar a próxima solicitação de sondagem. O timeout de polling é o período máximo de tempo permitido para que a polling repetida ocorra na taxa de intervalo especificada. O valor do intervalo deve ser menor que o valor do timeout.

Suponha que o timeout de sondagem seja de 24 horas e o intervalo de sondagem seja de 1 hora. Depois que a solicitação REST na etapa de execução for chamada, a solicitação REST de sondagem será enviada em intervalos de 1 hora, mas somente por até 24 horas ou até que a condição de sondagem retorne falso.

Se os critérios especificados na condição de sucesso forem atendidos, a chamada REST será concluída com sucesso e a execução da tarefa REST será considerada um sucesso. Se a condição de sucesso retornar falso, o resultado da execução da tarefa REST será considerado como falha.

Por exemplo, suponha que a configuração de sondagem verifique o andamento de uma execução de tarefa avaliando o status na resposta:

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

A sondagem é interrompida quando a condição de sucesso é atendida.

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

A configuração do método HTTP e do URL REST para encerrar a chamada REST é opcional para uma operação de API de execução longa.

A definição dos detalhes da solicitação de encerramento REST no Data Integration é semelhante à definição da solicitação REST na etapa de execução. No entanto, você pode incluir expressões que usam a resposta da API da etapa de execução REST no URL de encerramento.

Se você encerrar uma execução de tarefa REST e uma configuração de encerramento não for fornecida nessa tarefa REST, o Data Integration:

• Interromperá a execução da tarefa REST
• Não interromperá a operação de API subjacente chamada pela tarefa REST

Se uma configuração de encerramento for fornecida, o Data Integration interromperá a execução da tarefa REST e a operação de API subjacente.

Forneça a autenticação para chamar o ponto final da API REST na tarefa REST.

No momento, você pode usar o controlador de recursos do Oracle Cloud Infrastructure como método para autenticar pontos finais de API do Oracle Cloud Infrastructure. Você pode usar o espaço de trabalho ou o controlador de recursos do aplicativo.

Você pode incluir parâmetros em uma tarefa REST para reutilizar a tarefa em diferentes situações de runtime.

Você pode usar parâmetros para as seguintes partes da solicitação REST em uma tarefa REST:

• Uma ou mais seções do URL de execução REST, bem como do URL de sondagem ou encerramento. No Data Integration, as seções de variáveis parametrizadas do URL são conhecidas como parâmetros de URL. Consulte Configurando o método HTTP, o URL e os Parâmetros de URL.
• O valor de um cabeçalho na solicitação. Consulte Parametrizando um Valor de Cabeçalho.
• Todo o corpo da solicitação em uma solicitação POST ou PUT. Consulte Parametrizando o Corpo da Solicitação.
• A condição de sucesso que determina os critérios para uma conclusão bem-sucedida da chamada REST. Consulte Parametrizando a Condição de Sucesso.
• A condição de pesquisa (gravada na resposta que é retornada da solicitação de pesquisa) que determina a interrupção ou a continuação da pesquisa. Consulte Parametrizando a Condição de Sondagem.