Versionsverwaltung für eine geskriptete REST-API aktivieren

  • Freigeben Version: Xanadu
  • Aktualisiert 1. August 2024
  • 1 Minute Lesedauer
  • Aktivieren Sie die Versionsverwaltung für eine geskriptete REST-API, um mehrere Versionen der API bereitzustellen und die Kompatibilität mit vorhandenen Integrationen zu gewährleisten.

    Vorbereitungen

    Es muss eine geskriptete REST API definiert sein, bevor Sie die Versionsverwaltung aktivieren können.

    Erforderliche Rolle: web_service_admin

    Prozedur

    1. Navigieren zu Alle > System-Webservices > Scripted REST APIs.
    2. Wählen Sie eine geskriptete REST API aus.
    3. Klicken Sie unter „ Zugehörige Links“ auf Versionsverwaltung aktivieren.
      Das Popup Versionsverwaltung aktivieren wird angezeigt. Die Checkbox Version v1 als Standard festlegen ist standardmäßig aktiviert.
    4. Wahlweise: Deaktivieren Sie die Checkbox Version v1 als Standard festlegen, um die Versionsverwaltung ohne Standardversion zu aktivieren.
      Auf versionsverwaltete APIs ohne Standardversion kann nur mit dem versionsspezifischen URI zugegriffen werden. Legen Sie Version v1 als Standard fest, oder wählen Sie eine andere Version als Standard aus, nachdem Sie die Versionsverwaltung aktiviert haben.
    5. Klicken Sie auf OK.
      Die eingebettete Liste „Versionsverwaltung“ wird dem Formular „ Geskripteter REST-Service“ hinzugefügt. In dieser Liste können Sie neue Versionen hinzufügen oder steuern, welche Version standardmäßig verwendet wird.