Geskriptete REST-API-Ressourcen erstellen

Erstellen Sie eine geskriptete REST-API-Ressource, um die HTTP-Methode und das Verarbeitungsskript zu definieren, und um Einstellungen des ü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, von Ihnen erstellte Scripted REST API-Ressource eine ACL, die Benutzern mit der Rolle „snc_external“ untersagt, Anforderungen an die API zu stellen.

Prozedur

1. Navigieren zu Alle > System-Webservices > Scripted REST APIs.
2. Wählen Sie einen geskripteten REST-API-Datensatz aus.
3. Klicken Sie in der zugehörigen Liste Ressourcen auf Neu.
4. Geben Sie einen Namen ein.
   Der Ressourcenname beeinflusst den URI zum Senden von Anforderungen an die API.
5. Wählen Sie die HTTP-Methode aus, die diese Ressource implementiert, wie z. B. GET.
6. Definieren Sie im Feld Skript, wie die Operation Anforderungen analysiert und beantwortet.
7. Wahlweise: Überschreiben Sie die Einstellungen der übergeordneten REST-API nach Bedarf, z. B. durch Angabe anderer Sicherheitseinstellungen oder gültiger Content-Typen.
8. Wahlweise: Geben Sie in der Registerkarte Dokumentation eine Kurzbeschreibung an, die erklärt, wie auf die Ressource zugegriffen werden kann.
   Diese Informationen werden angezeigt, wenn Sie diese Ressource mit dem REST-API-Explorer untersuchen.
9. Klicken Sie auf Absenden.

Nächste Maßnahme

Nach dem Erstellen der Ressource können Sie Kopfzeilen und Abfrageparameter zuordnen. Weitere Informationen finden Sie unter Geskriptete REST-API-Headerdefinieren und Verfügbare Abfrageparameter definieren.