Verfügbare Abfrageparameter definieren

  • Freigeben Version: Xanadu
  • Aktualisiert 1. August 2024
  • 1 Minute Lesedauer

    • Definieren Sie verfügbare Abfrageparameter, um zu steuern, welche Werte ein anfragender Benutzer dem Anforderungs-URI übergeben kann.

    Vorbereitungen

    Erforderliche Rolle: web_service_admin

    Prozedur

    1. Navigieren zu Alle > System-Webservices > Scripted REST APIs.
    2. Wählen Sie einen geskripteten REST-API-Datensatz aus.
    3. Wählen Sie in der zugehörigen Liste „Abfrageparameter“ Neu.
    4. Geben Sie den Abfrageparameternamen an.
    5. Geben Sie eine Kurzbeschreibung und einen Beispielwert ein, um zu erklären, wie der Parameter verwendet wird.
    6. Wählen Sie Absenden.
    7. Wahlweise: Suchen Sie auf der Registerkarte „Abfrageparameter“ nach dem Abfrageparameter, und setzen Sie „ Ist erforderlich “ auf „wahr“, um diesen Abfrageparameter als erforderlich zu dokumentieren.
      Hinweis:
      Wenn Sie Ist erforderlich auf „wahr“ setzen, erzwingt der geskriptete REST-Service das Erfordernis des Parameters nicht. Um das Erfordernis eines Abfrageparameters zu erzwingen, müssen Sie der geskripteten REST-API-Ressource Logik hinzufügen, die Anforderungen ablehnt, bei denen die erforderlichen Parameter fehlen.

    Nächste Maßnahme

    Nachdem Sie die verfügbaren Abfrageparameter definiert haben, ordnen Sie die Parameter einer geskripteten REST-Ressource zu. Details finden Sie unter Ordnen Sie einer Ressource Abfrageparameter zu.