Définir une structure de réponse de ressource d’API

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

    • Ajoutez un schéma et des en-têtes de réponse pertinents à une réponse REST pour définir la structure de données attendue de la réponse.

    Avant de commencer

    Au moins une ressource de l’API REST et au moins un schéma doivent déjà être définis pour être utilisés dans l’API REST pertinente. Vous devez également définir les en-têtes de réponse que vous souhaitez utiliser. Pour plus d'informations, consultez Définir un en-tête de réponse API REST.

    Rôle requis : web_service_admin

    Procédure

    1. Accédez à un nouvel enregistrement de réponse REST de l’une des façons suivantes.
      Si vous parcourez l’enregistrement de l’API REST scripté, la plupart des champs de l’enregistrement Réponse 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 réponse , sélectionnez Nouveau.
      Accéder directement à l’enregistrement de réponse REST
      1. Accédez à la Tous > Filtre et dans sys_ws_response_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 format de réponse.
      4. Dans le champ Méthode HTTP , sélectionnez la méthode dont vous souhaitez spécifier le format de réponse (par exemple, GET).
      5. Dans le champ Version, sélectionnez la version de la ressource d’API.
    2. Dans le champ État HTTP , entrez l’état HTTP auquel s’appliquent les spécifications de réponse REST (par exemple, 200).
      Par exemple, renvoyez l’état ABC en saisissant 200.
    3. Dans le champ Schéma , recherchez ou saisissez le schéma qui définit la structure et le format de l’état, de la version et de la méthode HTTP sélectionnés de la ressource.
    4. Facultatif : Ajoutez des en-têtes de réponse pertinents associés à l’API.
      1. Sélectionnez l’icône Déverrouiller les en-têtes de réponse .
      2. Recherchez ou saisissez les en-têtes de réponse pertinents associés à l’API.
    5. Dans le champ Description , résumez le format attendu de la réponse REST.
    6. Sélectionnez Envoyer.

    Résultats

    Le schéma que vous avez utilisé pour définir la structure du corps de la réponse 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.