Erstellen Sie eine geskriptete REST-API-Ressource

  • Freigeben Version: Yokohama
  • Aktualisiert 30. Januar 2025
  • 1 Minute Lesedauer
  • Erstellen Sie eine geskriptete REST-API-Ressource, um die HTTP-Methode und das Verarbeitungsskript zu definieren und Einstellungen aus dem übergeordneten Service zu überschreiben.

    Vorbereitungen

    Es muss eine geskriptete REST-API definiert sein, bevor Sie Ressourcen erstellen können.

    Erforderliche Rolle: web_service_admin

    Warum und wann dieser Vorgang ausgeführt wird

    Standardmäßig enthält jede neue geskriptete REST-API-Ressource, die Sie erstellen, eine ACL, die Anwender mit der Rolle „snc_external“ daran hindert, Anforderungen an die API zu stellen.

    Prozedur

    1. Navigieren zu Alle > System-Webservices > Scripted REST APIsan.
    2. Wählen Sie einen geskripteten REST-API-Datensatz aus.
    3. In Ressourcen Zugehörige Liste, klicken Sie auf Neu .
    4. Geben Sie einen Namen ein.
      Der Ressourcenname wirkt sich auf den URI zum Senden von Anforderungen an die API aus.
    5. Wählen Sie aus HTTP-Methode Diese Ressource implementiert z. B. ABRUFEN .
    6. In Skript Feld definieren, wie der Vorgang Anforderungen analysiert und darauf reagiert.
    7. Wahlweise: Überschreiben Sie Einstellungen aus der übergeordneten REST-API nach Bedarf, z. B. durch Angabe verschiedener Sicherheitseinstellungen oder gültiger Inhaltstypen.
    8. Wahlweise: Auf Dokumentation Registerkarte, geben Sie ein an Kurzbeschreibung Erklärt, wie auf die Ressource zugegriffen wird.
      Diese Informationen werden angezeigt, wenn Sie diese Ressource mit dem REST API Explorer erkunden.
    9. Klicken Sie auf Absenden.

    Nächste Maßnahme

    Nach dem Erstellen der Ressource können Sie Header und Abfrageparameter zuordnen. Weitere Informationen finden Sie unter Definieren Sie geskriptete REST-API-Header Und Definieren Sie verfügbare Abfrageparameter .