Définir Un en-tête de demande d’API REST scripté

  • Rversion finale: Australia
  • Mis à jour 12 mars 2026
  • 1 minute de lecture

    • Définissez des en-têtes de demande API REST scriptés pour contrôler les en-têtes que l’API.

    Avant de commencer

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

    Rôle requis : web_service_admin

    Pourquoi et quand exécuter cette tâche

    Dans la procédure suivante, nous vous expliquons le processus de définition manuelle d’un en-tête de requête API REST scripté. Pour plus d’informations sur la génération automatique de définitions d’en-tête de demande dans les instances de non-production, reportez-vous à la section Générer automatiquement des définitions de demandes d’API.

    Procédure

    1. Accédez à la Tous > Services web 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. Saisissez un nom d’en-tête.
    5. Saisissez une description brève et un exemple de valeur pour expliquer l’utilisation de l’en-tête.
    6. Sélectionnez Envoyer.
    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 Est requis sur « vrai », le service REST scripté n’impose pas l’obligation d’en-tête. Pour imposer l’obligation d’un en-tête, vous devez ajouter une logique à la ressource d’API REST scriptée qui rejette les demandes auxquelles il manque les en-têtes requis.

    Que faire ensuite

    Après avoir défini les en-têtes disponibles, associez les en-têtes à une ressource REST scriptée. Pour plus d'informations, consultez Associer un en-tête de demande à une ressource.