Geskriptete REST-API-Kopfzeilen definieren

Definieren Sie geskriptete REST-API-Kopfzeilen, um zu steuern, welche Kopfzeilen die API akzeptiert und mit denen sie antworten kann.

Vorbereitungen

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

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 Anforderungsheader Zugehörige Liste, wählen Sie aus Neu .
4. Geben Sie einen Kopfzeilen-Namen ein.
5. Geben Sie eine Kurzbeschreibung und einen Beispielwert ein, um zu erklären, wie die Kopfzeile verwendet wird.
6. Wählen Sie Absenden.
7. Wahlweise: Suchen Sie auf der Registerkarte Anforderungsheader nach dem Headernamen, und legen Sie fest Ist erforderlich Auf „wahr“, um diesen Anforderungsheader nach Bedarf zu dokumentieren.
   Hinweis:

   Wenn Sie festgelegt haben Ist erforderlich Bei „wahr“ erzwingt der geskriptete REST-Service nicht, dass der Header erforderlich ist. Um die Notwendigkeit eines Headers zu erzwingen, müssen Sie der geskripteten REST-API-Ressource Logik hinzufügen, die Anforderungen ablehnt, denen die erforderlichen Header fehlen.

Nächste Maßnahme

Nachdem Sie die verfügbaren Kopfzeilen definiert haben, verknüpfen Sie die Kopfzeilen mit einer geskripteten REST-Ressource.