Définir les paramètres de requête disponibles

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

    • Définissez les paramètres de requête disponibles pour contrôler les valeurs qu’un utilisateur demandeur peut transmettre dans l’URI de demande.

    Avant de commencer

    Rôle requis : web_service_admin

    Pourquoi et quand exécuter cette tâche

    La procédure suivante décrit le processus de définition manuelle des paramètres de requête pour un service d’API REST scripté. Pour plus d’informations sur la génération automatique de paramètres de requête pour les demandes 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 Paramètres de requête , sélectionnez Nouveau.
    4. Spécifiez le nom du paramètre Requête.
    5. Saisissez une description brève et un exemple de valeur pour expliquer l’utilisation du paramètre.
    6. Sélectionnez Envoyer.
    7. Facultatif : Dans l’onglet Paramètres de requête, localisez le paramètre de requête et définissez Est requis sur « vrai » pour documenter ce paramètre de requête comme demandé.
      Remarque :
      Si vous définissez Is required sur « true », le service REST scripté n’impose pas l’obligation de paramètre. Pour imposer un paramètre de requête, vous devez ajouter une logique à la ressource d’API REST scriptée qui rejette les demandes pour lesquelles il manque les paramètres requis.

    Que faire ensuite

    Après avoir défini les paramètres de requête disponibles, associez les paramètres à une ressource REST scriptée. Pour plus de détails, voir Associer des paramètres de requête à une ressource.