Fornire criteri di completamento

Specificare la condizione che determina i criteri per il completamento riuscito dell'esecuzione REST.

È necessaria una condizione di operazione riuscita per completare qualsiasi richiamo REST, indipendentemente dal fatto che l'API richiami un'operazione con tempi di esecuzione brevi o lunghi.

Per definire il completamento del richiamo REST per un'operazione con tempi di esecuzione lunghi mediante il polling, vedere anche Fornitura di criteri di completamento mediante polling.

Utilizzo delle funzioni in una condizione

Le funzioni String e Operator di base sono supportate nelle condizioni di operazione riuscita e di polling.

L'espressione per una condizione di operazione riuscita o di polling può includere solo le funzioni come mostrato nella sezione seguente. Per estrarre i valori dalle strutture JSON, utilizzare la funzione json_path.

Aritmetica di base

+

-

*

. e così via

booleano di base

AND

OR

NOT

Confronto di base

>

<

!=

Null di base

IS NULL

IS NOT NULL

NVL

Stringa di base

CONCAT

LENGTH

UPPER

LOWER

Data/ora di base

DATE_ADD

Funzione json_path

Per gli elementi della sintassi JSONPath, vedere:

http://goessner.net/articles/JsonPath/

Ad esempio, per recuperare il valore dello stato corrente dalla seguente risposta, utilizzare la sintassi: $.status.current-status

{
   "processName": "createCustomer",
   "region" : "usa-1",
   "status" : {
      "current-status": "accepted",
      "id" : "usa1h3l4ewrt0989"
}
Specifica dei criteri di completamento (condizione riuscita)

La condizione di operazione riuscita in un task REST è un'espressione che determina il completamento riuscito della chiamata dell'API REST. Il polling si interrompe quando viene soddisfatta la condizione di operazione riuscita.

Per impostazione predefinita, Data Integration fornisce una condizione di operazione riuscita per un task REST. La condizione di operazione riuscita predefinita è un codice di stato HTTP uguale o superiore a 200 ma inferiore a 300, scritto come espressione riportata di seguito.

SYS.RESPONSE_STATUS >= 200 AND SYS.RESPONSE_STATUS < 300

L'espressione della condizione di operazione riuscita fa riferimento all'output nella risposta JSON ricevuta dalla richiesta REST definita nel passo di esecuzione.

È possibile utilizzare la condizione di operazione riuscita predefinita oppure scrivere un'espressione di condizione utilizzando output di sistema o valori di proprietà JSON estratti dalla risposta.

Per modificare la condizione di operazione riuscita:

  1. Nella pagina Configura dettagli API REST, andare al passo Specifica criteri di completamento.
  2. Se l'API REST richiama un'operazione con tempi di esecuzione lunghi, selezionare la casella di controllo Configura una condizione di polling e interruzione per una chiamata REST senza attesa.
  3. Nel blocco Condizioni, accanto alla condizione di operazione riuscita, fare clic su Modifica.
  4. Nel pannello Modifica condizione riuscita, immettere un'espressione che utilizza l'output della risposta della richiesta REST.

    L'espressione della condizione può includere i seguenti elementi:

    • In entrata: è possibile utilizzare gli output delle risposte in entrata (ad esempio, SYS.RESPONSE_PAYLOAD_JSON, SYS.RESPONSE_HEADERS_JSON, SYS.RESPONSE_STATUS).

    • Parametri: è possibile utilizzare qualsiasi parametro definito nell'ambito di questo task REST. Vedere Visualizzazione e gestione dei parametri in un task REST.

    • Funzioni: è possibile utilizzare le funzioni di base String e Operator Data Integration. La funzione json_path, disponibile in String, consente di estrarre i valori delle proprietà dalla risposta utilizzando gli elementi della sintassi JSONPath nel formato: json_path(json_string, json_filter_path)

      Ad esempio: json_path(SYS.RESPONSE_PAYLOAD, '$.@STATUS')

    Non tutte le funzioni sono supportate in un'espressione di condizione di operazione riuscita. Vedere la lista supportata qui.

    (Per le operazioni con tempi di esecuzione lunghi) Se è stata selezionata la casella di controllo Configura una condizione di polling e interruzione per una chiamata REST senza attesa, la condizione di operazione riuscita è un'espressione scritta nella risposta della richiesta di polling. È possibile creare espressioni che utilizzano la risposta API dal passo di esecuzione, quindi includere le espressioni denominate per creare la condizione di operazione riuscita.

  5. Per assegnare un parametro di task alla condizione di operazione riuscita, fare clic su Assegna parametro. Vedere Parametrizzazione della condizione di operazione riuscita.
Parametrizzazione della condizione di successo

È possibile assegnare un parametro task alla condizione di operazione riuscita in un task REST.

La procedura riportata di seguito può essere utilizzata anche per parametrizzare una condizione di polling.

Per parametrizzare una condizione:

  1. Nella pagina Configura dettagli API REST, andare al passo Specifica criteri di completamento.

    Per parametrizzare la condizione di polling, andare al passo Specifica criteri di completamento e fare clic sulla scheda Polling. Tenere presente che la scheda Polling viene visualizzata solo quando è selezionata la casella di controllo Configura una condizione di polling e interruzione per una chiamata REST senza attesa.

  2. Nel blocco Condizioni, fare clic su Assegna parametro accanto alla condizione.
  3. Nel pannello Aggiungi parametro, immettere un nome per il parametro nel campo Identificativo oppure utilizzare il valore predefinito.

    Il nome del parametro deve essere univoco nel task REST. Per un elenco corrente dei parametri nel task, vedere Visualizzazione di tutti i parametri in un task REST.

  4. (Facoltativo) Immettere una descrizione per facilitare l'identificazione dello scopo del parametro per gli altri utenti.
  5. Il tipo del parametro è Espressione, che non può essere modificata.
  6. In Condition builder, impostare l'espressione di condizione predefinita per questo parametro. Questa condizione predefinita viene utilizzata in runtime, a meno che non si modifichi il valore in un secondo momento (in fase di progettazione o in runtime).

    L'espressione della condizione può includere i seguenti elementi:

    • In entrata: output di risposta in entrata (ad esempio, SYS.RESPONSE_PAYLOAD_JSON, SYS.RESPONSE_HEADERS_JSON, SYS.RESPONSE_STATUS).

    • Parametri: parametri definiti nell'ambito di questo task REST. Vedere Visualizzazione e gestione dei parametri in un task REST.

    • Funzioni: funzioni Basic String e Operator Data Integration. La funzione json_path, disponibile in String, consente di estrarre i valori delle proprietà dalla risposta utilizzando gli elementi della sintassi JSONPath nel formato: json_path(json_string, json_filter_path)

      Ad esempio: json_path(SYS.RESPONSE_PAYLOAD, '$.@STATUS')

  7. Fare clic su Aggiungi.
    Il nome del parametro viene aggiunto accanto alla condizione.
Modifica del parametro della condizione di operazione riuscita

È possibile modificare la descrizione e il valore predefinito del parametro task per la condizione di operazione riuscita.

La procedura riportata di seguito può essere utilizzata anche per modificare il parametro della condizione di polling.

Per modificare la condizione con parametri:

  1. Nella pagina Configura dettagli API REST, andare al passo Specifica criteri di completamento.

    Per modificare la condizione di polling con parametri, andare al passo Specifica criteri di completamento e fare clic sulla scheda Polling. Tenere presente che la scheda Polling viene visualizzata solo quando è selezionata la casella di controllo Configura una condizione di polling e interruzione per una chiamata REST senza attesa.

  2. Nel blocco Condizioni, fare clic su Modifica parametro.
  3. Nel pannello Modifica parametro modificare solo la descrizione e l'espressione della condizione. Non è possibile modificare l'identificativo (nome) e il tipo di dati.
  4. Fare clic su Salva modifiche.
Rimozione del parametro della condizione di operazione riuscita

La rimozione del parametro condizione rimuove solo l'associazione del parametro alla condizione di operazione riuscita specificata per il task REST.

La procedura riportata di seguito può essere utilizzata anche per rimuovere il parametro della condizione di polling.

Per annullare l'assegnazione del parametro dalla condizione, effettuare le operazioni riportate di seguito.

  1. Nella pagina Configura dettagli API REST, andare al passo Specifica criteri di completamento.

    Per annullare l'assegnazione del parametro dalla condizione di polling, andare al passo Specifica criteri di completamento e fare clic sulla scheda Polling. Tenere presente che la scheda Polling viene visualizzata solo quando è selezionata la casella di controllo Configura una condizione di polling e interruzione per una chiamata REST senza attesa.

  2. Nel blocco Condizioni fare clic su Rimuovi parametro.
  3. Nella finestra di dialogo Rimuovi parametro fare clic su Rimuovi.

    L'assegnazione del parametro alla condizione è stata annullata. L'espressione di condizione assegnata al parametro diventa la condizione predefinita.

    Nota

    Il parametro non viene eliminato dal task REST. Per eliminare il parametro, vedere Eliminazione di un parametro di task REST.