Definieren Sie geskriptete REST-API-Header

  • Freigeben Version: Yokohama
  • Aktualisiert 30. Januar 2025
  • 1 Minute Lesedauer

    • Definieren Sie geskriptete REST-API-Header, um zu steuern, welche Header die API akzeptiert und mit denen 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 ein Headername .
    5. Geben Sie ein Kurzbeschreibung Und Beispielwert Um zu erklären, wie der Header 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 verfügbare Header definiert haben, ordnen Sie die Header einer geskripteten REST-Ressource zu.