Geskriptete REST-API-Kopfzeilen definieren

  • Freigeben Version: Xanadu
  • Aktualisiert 1. August 2024
  • 1 Minute Lesedauer

    • 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 APIs.
    2. Wählen Sie einen geskripteten REST-API-Datensatz aus.
    3. Wählen Sie in der zugehörigen Liste AnforderungsheaderNeu.
    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 den Headernamen, und setzen Sie Ist erforderlich auf „wahr“, um diesen Anforderungsheader als erforderlich zu dokumentieren.
      Hinweis:
      Wenn Sie Ist erforderlich auf „wahr“ setzen, erzwingt der geskriptete REST-Service das Erfordernis des Headers nicht. Um das Erzwingen eines Headers zu erzwingen, müssen Sie der geskripteten REST-API-Ressource Logik hinzufügen, die Anforderungen ablehnt, bei 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.