Documentation Oracle Cloud Infrastructure

Fourniture de critères de fin

Indiquez la condition qui détermine les critères de succès de l'exécution REST.

Une condition de réussite est requise pour terminer un appel REST, que l'API appelle une opération à courte durée d'exécution ou à longue durée d'exécution.

Afin de définir la fin de l'appel REST pour une opération à longue durée d'exécution à l'aide de l'interrogation, reportez-vous également à Fourniture de critères de fin à l'aide de l'interrogation.

Utilisation de fonctions dans une condition

Les fonctions de chaîne et d'opérateur de base sont prises en charge dans les conditions de réussite et d'interrogation.

L'expression d'une condition de réussite ou d'interrogation peut inclure uniquement les fonctions telles qu'indiquées dans la section suivante. Pour extraire des valeurs de structures JSON, utilisez la fonction json_path.

Arithmétique de base

+

-

*

., etc.
Booléenne de base

AND

OR

NOT
Comparaison de base

>

<

!=
NULL de base

IS NULL

IS NOT NULL

NVL
Chaîne de base

CONCAT

LENGTH

UPPER

LOWER
Date/heure de base

DATE_ADD
Fonction json_path

Pour les éléments de syntaxe JSONPath, reportez-vous à :

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

Par exemple, pour extraire la valeur de statut en cours de la réponse suivante, utilisez la syntaxe : $.status.current-status

{
   "processName": "createCustomer",
   "region" : "usa-1",
   "status" : {
      "current-status": "accepted",
      "id" : "usa1h3l4ewrt0989"
}
Spécification des critères de fin (condition de réussite)

La condition de réussite d'une tâche REST est une expression qui détermine la réussite de l'appel d'API REST. L'interrogation s'arrête lorsque la condition de réussite est remplie.

Par défaut, Data Integration fournit une condition de réussite pour une tâche REST. La condition de réussite par défaut est un code de statut HTTP supérieur ou égal à 200, mais inférieur à 300, écrit sous la forme de l'expression suivante :

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

L'expression de condition de réussite référence la sortie dans la réponse JSON reçue de la demande REST définie dans l'étape d'exécution.

Vous pouvez utiliser la condition de réussite par défaut ou écrire une expression de condition à l'aide des sorties système ou des valeurs de propriété JSON extraites de la réponse.

Pour modifier la condition de réussite, procédez comme suit :

  1. Sur la page Configurer les détails de l'API REST, accédez à l'étape Indiquer des critères de fin.
  2. Si l'API REST appelle une opération à longue durée d'exécution, cochez la case Configurer une condition d'interrogation et de terminaison pour un appel REST sans attente.
  3. Dans le bloc Conditions, en regard de Conditions de réussite, sélectionnez Modifier.
  4. Dans le panneau Modifier la condition de réussite, entrez une expression qui utilise la sortie de la réponse de la demande REST.

    L'expression de condition peut inclure les éléments suivants :

    • Entrant : vous pouvez utiliser les sorties de réponse entrantes (par exemple, SYS.RESPONSE_PAYLOAD_JSON, SYS.RESPONSE_HEADERS_JSON, SYS.RESPONSE_STATUS).

    • Paramètres : vous pouvez utiliser n'importe quel paramètre défini dans la portée de la tâche REST. Reportez-vous à Affichage et gestion des paramètres dans une tâche REST.

    • Fonctions : vous pouvez utiliser les fonctions Data Integration de chaînes et d'opérateur de base. La fonction json_path, qui se trouve sous Chaîne, permet d'extraire les valeurs de propriété de la réponse à l'aide des éléments de syntaxe JSONPath au format suivant : json_path(json_string, json_filter_path)

      Par exemple : json_path(SYS.RESPONSE_PAYLOAD, '$.@STATUS')

    Toutes les fonctions ne sont pas prises en charge dans une expression de condition de réussite. Reportez-vous à la liste prise en charge.

    (Pour les opérations à longue durée d'exécution) Si vous avez coché la case Configurer une condition d'interrogation et de terminaison pour un appel REST sans attente, la condition de réussite est une expression écrite sur la réponse de la demande d'interrogation. Vous pouvez créer des expressions qui utilisent la réponse d'API de l'étape d'exécution, puis inclure les expressions nommées pour créer la condition de réussite.

  5. Pour affecter un paramètre de tâche à la condition de réussite, sélectionnez Affecter le paramètre. Reportez-vous à Paramétrage de la condition de réussite.
Paramétrage de la condition de réussite

Vous pouvez affecter un paramètre de tâche à la condition de réussite dans une tâche REST.

La procédure suivante peut également être utilisée pour paramétrer une condition d'interrogation.

Pour paramétrer une condition :

  1. Sur la page Configurer les détails de l'API REST, accédez à l'étape Indiquer des critères de fin.

    Pour paramétrer la condition d'interrogation, accédez à l'étape Spécifier les critères de fin et sélectionnez l'onglet Interrogation. Notez que l'onglet Interrogation apparaît uniquement lorsque la case Configurer une condition d'interrogation et de terminaison pour un appel REST sans attente est cochée.

  2. Dans le bloc Conditions, sélectionnez Affecter un paramètre en regard de la condition.
  3. Dans le panneau Ajouter un paramètre, entrez le nom du paramètre dans le champ Identificateur ou utilisez la valeur par défaut.

    Le nom du paramètre doit être unique dans la tâche REST. Pour obtenir la liste des paramètres en cours dans la tâche, reportez-vous à Affichage de tous les paramètres d'une tâche REST.

  4. (Facultatif) Entrez une description afin d'identifier l'objectif du paramètre pour les autres utilisateurs.
  5. Le type du paramètre est Expression, qui ne peut pas être modifié.
  6. Dans le générateur de condition, définissez l'expression de condition par défaut pour ce paramètre. Cette condition par défaut est utilisée lors de l'exécution, sauf si vous modifiez la valeur ultérieurement (au moment de la conception ou de l'exécution).

    L'expression de condition peut inclure les éléments suivants :

    • Entrantes : sorties de réponse entrantes (par exemple, SYS.RESPONSE_PAYLOAD_JSON, SYS.RESPONSE_HEADERS_JSON, SYS.RESPONSE_STATUS).

    • Paramètres : paramètres définis dans la portée de cette tâche REST. Reportez-vous à Affichage et gestion des paramètres dans une tâche REST.

    • Fonctions : fonctions d'intégration de chaînes et de données d'opérateur de base. La fonction json_path, qui se trouve sous Chaîne, permet d'extraire les valeurs de propriété de la réponse à l'aide des éléments de syntaxe JSONPath au format suivant : json_path(json_string, json_filter_path)

      Par exemple : json_path(SYS.RESPONSE_PAYLOAD, '$.@STATUS')

  7. Sélectionnez Ajouter.
    Le nom du paramètre est ajouté en regard de la condition.
Modification du paramètre de condition de réussite

Vous pouvez modifier la description et la valeur par défaut du paramètre de tâche pour la condition de réussite.

La procédure suivante peut également être utilisée pour modifier le paramètre de condition d'interrogation.

Pour modifier la condition paramétrée :

  1. Sur la page Configurer les détails de l'API REST, accédez à l'étape Indiquer des critères de fin.

    Pour modifier la condition d'interrogation paramétrée, accédez à l'étape Spécifier les critères de finalisation et sélectionnez l'onglet Interrogation. Notez que l'onglet Interrogation apparaît uniquement lorsque la case Configurer une condition d'interrogation et de terminaison pour un appel REST sans attente est cochée.

  2. Dans le bloc Conditions, sélectionnez Modifier le paramètre.
  3. Dans le panneau Modifier le paramètre, modifiez uniquement la description et l'expression de condition. Vous ne pouvez pas modifier l'identificateur (nom) et le type de données.
  4. Sélectionnez Enregistrer les modifications.
Suppression du paramètre de condition de réussite

La suppression du paramètre de condition enlève uniquement l'association du paramètre à la condition de réussite spécifiée pour la tâche REST.

La procédure suivante peut également être utilisée pour supprimer le paramètre de condition d'interrogation.

Pour annuler l'affectation du paramètre à la condition, procédez comme suit :

  1. Sur la page Configurer les détails de l'API REST, accédez à l'étape Indiquer des critères de fin.

    Pour annuler l'affectation du paramètre à la condition d'interrogation, accédez à l'étape Spécifier les critères de fin et sélectionnez l'onglet Interrogation. Notez que l'onglet Interrogation apparaît uniquement lorsque la case Configurer une condition d'interrogation et de terminaison pour un appel REST sans attente est cochée.

  2. Dans le bloc Conditions, sélectionnez Enlever le paramètre.
  3. Dans la boîte de dialogue Enlever le paramètre, sélectionnez Enlever.

    L'affectation du paramètre à la condition est annulée. L'expression de condition affectée au paramètre devient la condition par défaut.

    Remarque

    Le paramètre n'est pas supprimé de la tâche REST. Pour supprimer le paramètre, reportez-vous à Suppression d'un paramètre de tâche REST.