Documentation Oracle Cloud Infrastructure

Ajout et gestion d'un en-tête

Définissez des en-têtes à transmettre à la section d'en-tête de la demande REST. Un en-tête possède 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 l'URL d'interrogation et l'URL de terminaison facultatives.

Création d'un en-tête

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

Pour créer un en-tête, procédez comme suit :

  1. A l'étape Définir les détails d'exécution de la page Configurer les détails d'API REST, sélectionnez En-têtes afin de créer l'en-tête de la tâche REST.

    Afin de créer un en-tête pour l'URL d'interrogation ou de terminaison, accédez à la page Indiquer des critères de fin et cochez la case Configurer une condition d'interrogation et de terminaison pour un appel REST sans attente. Dans l'onglet Interrogation ou Fin de contrat, 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 apparaît dans un menu. Sélectionnez l'en-tête de votre choix.
  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 apparaît dans un menu. Sélectionnez la valeur d'en-tête de votre choix.
  5. Sélectionnez Ajouter.

    La clé et la valeur d'en-tête sont ajoutées à la table 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. Reportez-vous à 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. Reportez-vous à Modification de la valeur d'un en-tête paramétré.

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

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

    Pour modifier un en-tête pour l'URL d'interrogation ou de terminaison, accédez à la page Spécifier des critères de fin. Dans l'onglet Interrogation ou Fin de contrat, sélectionnez En-tête.

  2. Dans la ligne de table correspondant à un en-tête, 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 votre saisie dans l'un des champs, une liste de suggestions apparaît dans un menu dès qu'un élément correspondant est trouvé. Vous pouvez sélectionner la clé d'en-tête ou la valeur d'en-tête de votre choix.

    Remarque

    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 enlevé lorsque vous sélectionnez Enregistrer. Pour paramétrer à nouveau la valeur d'en-tête, sélectionnez Afficher 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 enlève la paire clé-valeur de l'en-tête dans la tâche REST.

Pour supprimer un en-tête :

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

    Pour supprimer un en-tête pour l'URL d'interrogation ou de terminaison, accédez à la page Spécifier des critères de fin. Dans l'onglet Interrogation ou Fin de contrat, sélectionnez En-tête.

  2. Dans la ligne de table correspondant à 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 enlevée de la table d'en-tête.

    Remarque

    Si la valeur d'en-tête a été paramétrée, le paramètre associé n'est pas supprimé. Pour supprimer le paramètre, reportez-vous à 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étrer la valeur d'un en-tête :

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

    Pour paramétrer une valeur d'en-tête pour l'URL d'interrogation ou de terminaison, accédez à la page Spécifier des critères de fin. Dans l'onglet Interrogation ou Fin de contrat, sélectionnez En-tête.

  2. Dans la ligne de table correspondant à un en-tête, en regard de la valeur d'en-tête, sélectionnez Afficher en tant que paramètre d'en-tête.
  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 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 lors de l'exécution, sauf si vous modifiez la valeur lors de la conception ou de l'exécution.
  8. Sélectionnez Ajouter.
    La ligne de table de l'en-tête est mise à jour avec le nom du paramètre en regard de la valeur d'en-tête.
Modification de la valeur d'un en-tête paramétré

Vous pouvez uniquement modifier 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, procédez comme suit :

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

    Pour modifier une valeur d'en-tête paramétrée pour l'URL d'interrogation ou de terminaison, accédez à la page Spécifier des critères de fin. Dans l'onglet Interrogation ou Fin de contrat, sélectionnez En-tête.

  2. Dans la ligne de la table correspondant à la valeur d'en-tête à modifier, en regard 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 Save (Enregistrer).
Suppression d'un paramètre de valeur d'en-tête

La suppression d'un paramètre de valeur d'en-tête enlève uniquement l'association du paramètre à la valeur 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 enlever un paramètre de valeur d'en-tête, procédez comme suit :

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

    Pour enlever un paramètre de valeur d'en-tête pour l'URL d'interrogation ou de terminaison, accédez à la page Spécifier des critères de fin. Dans l'onglet Interrogation ou Fin de contrat, sélectionnez En-tête.

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

    Remarque

    Le paramètre de valeur d'en-tête 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.