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

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

Avant de commencer

Rôle requis : web_service_admin

Procédure

1. Accédez à la Tous > Services web du système > API REST basées sur un script.
2. Sélectionnez un enregistrement scripté de REST API.
3. Dans la liste connexe Paramètres de requête , sélectionnez Nouveau.
4. Spécifiez le nom du paramètre de requête.
5. Saisissez une brève description et un exemple pour expliquer comment utiliser le 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 il convient.
   Remarque :

   Si vous définissez Est requis sur « vrai », le service REST scripté n’applique pas l’exigence du paramètre. Pour imposer l’exigence d’un paramètre de requête, vous devez ajouter une logique à la ressource de l’API REST scriptée qui rejette les demandes pour lesquelles les paramètres requis sont manquants.

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.