Verfügbare Abfrageparameter definieren

  • Freigeben Version: Zurich
  • Aktualisiert 31. Juli 2025
  • 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 APIsan.
    2. Wählen Sie einen geskripteten REST-API-Datensatz aus.
    3. In Abfrageparameter Zugehörige Liste, wählen Sie aus 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 den Abfrageparameter, und legen Sie fest Ist erforderlich Auf „wahr“, um diesen Abfrageparameter nach Bedarf zu dokumentieren.
      Hinweis:
      Wenn Sie festgelegt haben Ist erforderlich Bei „wahr“ erzwingt der geskriptete REST-Service die Notwendigkeit des Parameters nicht. Um die Notwendigkeit eines Abfrageparameters zu erzwingen, müssen Sie der geskripteten REST API-Ressource Logik hinzufügen, die Anforderungen ablehnt, denen die erforderlichen Parameter fehlen.

    Nächste Maßnahme

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