Définir les en-têtes de REST API scriptés

  • Rversion finale: Xanadu
  • Mis à jour 1 août 2024
  • 1 minute de lecture
  • Définissez des en-têtes d’API REST scriptés pour contrôler les en-têtes que l’API accepte et avec lesquels elle peut répondre.

    Avant de commencer

    Une API REST scriptée doit être définie avant de pouvoir créer des en-têtes.

    Rôle requis : web_service_admin

    Procédure

    1. Accédez à la Tout > Services web du système > API REST basées sur un script.
    2. Sélectionnez un enregistrement d’API REST scripté.
    3. Dans la liste connexe En-têtes de demande , sélectionnez Nouveau.
    4. Entrez un nom d’en-tête.
    5. Saisissez une description brève et un exemple de valeur pour expliquer comment utiliser l’en-tête.
    6. Sélectionnez Soumettre.
    7. Facultatif : Dans l’onglet En-têtes de demande, localisez le nom de l’en-tête et définissez Est requis sur « vrai » pour documenter cet en-tête de demande comme demandé.
      Remarque :
      Si vous définissez la valeur Est obligatoire sur « vrai », le service REST scripté n’applique pas l’exigence de l’en-tête. Pour appliquer l’exigence d’un en-tête, vous devez ajouter une logique à la ressource d’API REST scriptée qui rejette les demandes pour lesquelles il manque des en-têtes requis.

    Que faire ensuite

    Après avoir défini les en-têtes disponibles, associez-les à une ressource REST scriptée.