Documentation sur Oracle Cloud Infrastructure

Définition des critères d'achèvement

Spécifiez la condition de réussite qui détermine les critères d'achèvement réussi de l'exécution REST.

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

Pour définir l'achèvement de l'appel REST pour une opération de longue durée à l'aide de la scrutation, voir aussi Définition de critères d'achèvement à l'aide de la scrutation.

Utilisation de fonctions dans une condition

Les fonctions de base (chaîne et opérateur) sont prises en charge dans les conditions de réussite et de scrutation.

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

Opérateur arithmétique de base

+

-

*

. etc.
Opérateur booléen de base

AND

OR

NOT
Comparaison de base

>

<

!=
Fonction nulle 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, voir :

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

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

{
   "processName": "createCustomer",
   "region" : "usa-1",
   "status" : {
      "current-status": "accepted",
      "id" : "usa1h3l4ewrt0989"
}
Définition des critères d'achèvement (condition de réussite)

La condition de réussite d'une tâche REST est une expression qui détermine l'achèvement réussi de l'appel d'API REST. La scrutation s'arrête lorsque la condition de réussite est satisfaite.

Par défaut, le service d'intégration de données 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 de 200 ou supérieur, mais inférieur à 300. Elle est exprimée par l'expression suivante :

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

L'expression de la condition de réussite référence la sortie de la réponse JSON à la demande REST définie à 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 du système ou extraire des valeurs de propriété JSON de la réponse.

Pour modifier la condition de réussite :

  1. Dans la page Configurer les détails de l'API REST, allez à l'étape Spécifier les critères d'achèvement.
  2. Si l'API REST appelle une opération de longue durée, cochez la case Configurer une condition de scrutation et d'arrêt pour un appel REST sans attente.
  3. Dans le bloc Conditions, à côté de condition 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 à la demande REST.

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

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

    • Paramètres : Vous pouvez utiliser tout paramètre défini dans la portée de cette tâche REST. Voir Consultation et gestion des paramètres d'une tâche REST.

    • Fonctions : Vous pouvez utiliser les fonctions de base de type chaîne et opérateur du service d'intégration de données. La fonction json_path (Chaîne) vous permet d'extraire les valeurs de propriété de la réponse à l'aide d'éléments de syntaxe JSONPath au format : 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. Voir la liste des fonctions prises en charge.

    (Pour les opérations de longue durée) Si vous avez coché la case Configurer une condition de scrutation et d'arrêt pour un appel REST sans attente, la condition de réussite est une expression écrite dans la réponse à la demande de scrutation. 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 un paramètre. Voir 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 d'une tâche REST.

La procédure suivante peut également être utilisée pour paramétrer une condition de scrutation.

Pour paramétrer une condition :

  1. Dans la page Configurer les détails de l'API REST, allez à l'étape Spécifier les critères d'achèvement.

    Pour paramétrer la condition de scrutation, allez à l'étape Spécifier les critères d'achèvement et sélectionnez l'onglet Pollage. Notez que l'onglet Sondage s'affiche uniquement lorsque la case Configurer une condition de scrutation et d'arrêt pour un appel REST sans attente est cochée.

  2. Dans le bloc Conditions, sélectionnez Affecter un paramètre à côté de la condition.
  3. Dans le panneau Ajouter un paramètre, entrez un nom pour le 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 courante des paramètres de la tâche, voir Consultation de tous les paramètres d'une tâche REST.

  4. (Facultatif) Entrez une description pour aider les autres utilisateurs à identifier la fonction du paramètre.
  5. Le type du paramètre est Expression, qui ne peut pas être modifié.
  6. Dans le générateur de conditions, 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, à moins que vous ne modifiiez la valeur plus tard (au moment de la conception ou de l'exécution).

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

    • Entrant : Sorties de réponse entrante (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. Voir Consultation et gestion des paramètres d'une tâche REST.

    • Fonctions : Fonctions de base d'intégration de données de chaîne et d'opérateur. La fonction json_path (Chaîne) vous permet d'extraire les valeurs de propriété de la réponse à l'aide d'éléments de syntaxe JSONPath au format : 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é à côté 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 de la condition de réussite.

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

Pour modifier la condition paramétrée :

  1. Dans la page Configurer les détails de l'API REST, allez à l'étape Spécifier les critères d'achèvement.

    Pour modifier la condition de scrutation paramétrée, allez à l'étape Spécifier les critères d'achèvement et sélectionnez l'onglet Pollage. Notez que l'onglet Sondage s'affiche uniquement lorsque la case Configurer une condition de scrutation et d'arrêt 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 supprime 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 de scrutation.

Pour annuler l'affectation du paramètre à la condition :

  1. Dans la page Configurer les détails de l'API REST, allez à l'étape Spécifier les critères d'achèvement.

    Pour annuler l'affectation du paramètre à la condition de scrutation, allez à l'étape Spécifier les critères d'achèvement et sélectionnez l'onglet Pollage. Notez que l'onglet Sondage s'affiche uniquement lorsque la case Configurer une condition de scrutation et d'arrêt pour un appel REST sans attente est cochée.

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

    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.

    Note

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