Documentation sur Oracle Cloud Infrastructure

Ajout et gestion d'un en-tête

Définissez un ou plusieurs en-têtes à transmettre à la section d'en-tête de la demande REST. Un en-tête a une clé et une valeur. Tous les en-têtes de demande d'API REST standard sont pris en charge.

Par exemple, vous pouvez ajouter l'en-tête Content-Type pour une demande POST ou PUT.

Les procédures suivantes peuvent être utilisées pour ajouter et gérer des en-têtes dans l'URL HTTP principale ou dans l'URL de scrutation et l'URL d'arrêt facultatives.

Création d'un en-tête

Créez un en-tête de demande pour la méthode HTTP principale ou pour les méthodes HTTP de scrutation et d'arrêt facultatives.

Pour créer un en-tête :

  1. À l'étape Définir les détails d'exécution de la page Configurer les détails de l'API REST, sélectionnez Header pour créer un en-tête pour la tâche REST.

    Pour créer un en-tête pour l'URL de scrutation ou d'arrêt, allez à la page Sélectionner les critères d'achèvement et cochez la case Configurer une condition de scrutation et d'arrêt pour un appel REST sans attente. Dans l'onglet Sondage ou Résiliation, sélectionnez En-tête.

  2. Sélectionnez Ajouter un en-tête.
  3. Dans le champ clé, commencez à saisir le nom d'un en-tête.
    Lorsqu'une clé correspondante est trouvée, une liste de suggestions s'affiche dans un menu. Sélectionnez l'en-tête voulu.
  4. Dans le champ Valeur, commencez à saisir le nom de la valeur d'en-tête.
    Lorsqu'une valeur correspondante est trouvée, une liste de suggestions s'affiche dans un menu. Sélectionnez la valeur d'en-tête voulue.
  5. Sélectionnez Ajouter.

    La clé et la valeur d'en-tête sont ajoutées au tableau en-tête.

    Pour affecter un paramètre à la valeur de la paire clé-valeur d'en-tête, sélectionnez Exposer en tant que paramètre de tâche. Voir Paramétrage d'une valeur d'en-tête.

Modification d'un en-tête

Vous pouvez modifier la clé et la valeur d'un en-tête.

Si la valeur d'en-tête est paramétrée, modifiez le paramètre pour modifier la valeur de paramètre par défaut. Voir Modification de la valeur d'un en-tête paramétré.

Pour modifier une paire clé-valeur d'en-tête :

  1. À l'étape Définir les détails d'exécution de la page Configurer les détails de l'API REST, sélectionnez En-tête pour modifier un en-tête dans la tâche REST.

    Pour modifier un en-tête pour l'URL de scrutation ou d'arrêt, allez à la page Spécifier les critères d'achèvement. Dans l'onglet Sondage ou Résiliation, sélectionnez En-tête.

  2. Dans le tableau, dans la rangée d'en-tête d'un tableau, sélectionnez Modifier dans le menu Actions (Menu Actions).
  3. Dans le panneau Modifier l'en-tête, modifiez les valeurs des champs Clé et Valeur, puis sélectionnez Enregistrer.

    Lorsque vous commencez à saisir des caractères dans l'un des champs, une liste de suggestions s'affiche dans un menu lorsqu'un élément correspondant est trouvé. Vous pouvez ensuite sélectionner la clé ou la valeur d'en-tête voulue.

    Note

    Si la valeur du champ Valeur est une chaîne de paramètre telle que ${PARAMETER_HEADER} et que vous remplacez la chaîne par une valeur d'en-tête correspondant à la clé, le paramètre est supprimé lorsque vous sélectionnez Enregistrer. Pour paramétrer à nouveau la valeur d'en-tête, sélectionnez Exposer en tant que paramètre de tâche, comme décrit dans Paramétrage d'une valeur d'en-tête.

Suppression d'un en-tête

La suppression d'un en-tête supprime la paire clé-valeur de l'en-tête de la tâche REST.

Pour supprimer un en-tête :

  1. À l'étape Définir les détails d'exécution de la page Configurer les détails de l'API REST, sélectionnez En-tête pour supprimer un en-tête de la tâche REST.

    Pour supprimer un en-tête pour l'URL de scrutation ou d'arrêt, allez à la page Spécifier les critères d'achèvement. Dans l'onglet Sondage ou Résiliation, sélectionnez En-tête.

  2. Dans le tableau, dans la rangée d'un en-tête, sélectionnez Supprimer dans le menu Actions (Menu Actions).
  3. Dans la boîte de dialogue Supprimer l'en-tête, sélectionnez Supprimer.

    La paire clé-valeur de l'en-tête est supprimée du tableau.

    Note

    Si la valeur d'en-tête a été paramétrée, le paramètre associé à la valeur d'en-tête n'est pas supprimé. Pour supprimer le paramètre, voir Suppression d'un paramètre de tâche REST.
Paramétrage d'une valeur d'en-tête

Après avoir défini la paire clé-valeur pour un en-tête, vous pouvez affecter un paramètre de tâche à la valeur d'en-tête.

Pour paramériser la valeur d'en-tête d'un en-tête :

  1. À l'étape Définir les détails d'exécution de la page Configurer les détails de l'API REST, sélectionnez En-tête.

    Pour paramétrer une valeur d'en-tête pour l'URL de scrutation ou d'arrêt, allez à la page Spécifier les critères d'achèvement. Dans l'onglet Sondage ou Résiliation, sélectionnez En-tête.

  2. Dans la rangée du tableau d'un en-tête, à côté de la valeur d'en-tête, sélectionnez Exposer en tant que paramètre de tâche.
  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. La valeur de Type de données est Chaîne Vous ne pouvez pas modifier le type de données.
  6. Définissez la longueur.
  7. Définissez la valeur par défaut du paramètre.
    La valeur d'en-tête par défaut est utilisée au moment de l'exécution, sauf si vous modifiez la valeur au moment de la conception ou de l'exécution.
  8. Sélectionnez Ajouter.
    La rangée du tableau de l'en-tête est mise à jour avec le nom du paramètre à côté de la valeur d'en-tête.
Modification de la valeur d'un en-tête paramétré

Vous ne pouvez modifier que la valeur par défaut du paramètre.

Pour modifier la valeur par défaut d'une valeur d'en-tête paramétrée :

  1. À l'étape Définir les détails d'exécution de la page Configurer les détails de l'API REST, sélectionnez En-tête.

    Pour modifier une valeur d'en-tête paramétrée pour l'URL de scrutation ou d'arrêt, allez à la page Spécifier les critères d'achèvement. Dans l'onglet Sondage ou Résiliation, sélectionnez En-tête.

  2. Dans la rangée de la table de la valeur d'en-tête à modifier, à côté du nom du paramètre, sélectionnez Modifier le paramètre.
  3. Dans le panneau Modifier le paramètre, modifiez la valeur du paramètre.
  4. Sélectionnez enregistrer.
Suppression d'un paramètre de valeur d'en-tête

La suppression d'un paramètre de valeur d'en-tête supprime uniquement l'association entre le paramètre et la valeur d'en-tête de l'en-tête.

La suppression du paramètre de valeur d'en-tête ne supprime pas la paire clé-valeur de l'en-tête.

Pour supprimer un paramètre de valeur d'en-tête :

  1. À l'étape Définir les détails d'exécution de la page Configurer les détails de l'API REST, sélectionnez En-tête.

    Pour supprimer un paramètre de valeur d'en-tête pour l'URL de scrutation ou d'arrêt, allez à la page Spécifier les critères d'achèvement. Dans l'onglet Sondage ou Résiliation, sélectionnez En-tête.

  2. Dans la rangée de la table du paramètre de valeur d'en-tête à supprimer, 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 valeur d'en-tête de l'en-tête est annulée. La valeur affectée au paramètre devient la valeur d'en-tête.

    Note

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