Définir une structure de demande de ressource d’API

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

    • Ajoutez un schéma à un enregistrement de demande REST pour définir la structure de données attendue de la demande.

    Avant de commencer

    Vous devez définir au moins une ressource de l’API REST et au moins un schéma dans l’API REST avant de définir la structure de la demande.

    Rôle requis : web_service_admin

    Pourquoi et quand exécuter cette tâche

    La procédure suivante décrit le processus d’ajout manuel d’un schéma de demande à une ressource. Pour plus d’informations sur la génération automatique de définitions de schéma 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 à un nouvel enregistrement de demande REST de l’une des façons suivantes.
      Si vous parcourez un enregistrement d’API REST scripté, la plupart des champs de l’enregistrement de demande REST sont pré-remplis.
      OptionProcédure
      Parcourir un enregistrement scripté d’API REST
      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 Ressources , sélectionnez une ressource.
      4. Dans l’onglet Schéma de demande , sélectionnez Nouveau.
      Accéder directement à un nouvel enregistrement de demande REST
      1. Accédez à la Tous > Filtre et accédez à sys_ws_request_spec.form.
      2. Dans le champ API , sélectionnez une API.
      3. Dans le champ Ressource d’API , sélectionnez la ressource d’API dont vous souhaitez spécifier le schéma de demande.
      4. Dans le champ Version , sélectionnez la version de la ressource d’API.
      5. Dans le champ Méthode HTTP , sélectionnez la méthode dont vous souhaitez spécifier le schéma de requête (par exemple, PUT).
    2. Dans le champ Schéma , recherchez ou saisissez le schéma que vous souhaitez pour définir la structure et le format du corps de la demande de ressource.
    3. Dans le champ Description , résumez le format attendu de la demande REST.
    4. Sélectionnez Envoyer.

    Résultats

    Le schéma que vous avez utilisé pour définir la structure du corps de la demande est inclus dans la spécification OpenAPI exportable dans l’explorateur d’API REST. Pour plus d’informations sur l’exportation des spécifications OpenAPI, reportez-vous à la section Exporter vers la spécification OpenAPI.