Scripted REST API のバージョン管理の有効化

  • リリースバージョン: Yokohama
  • 更新日 2025年01月30日
  • 所要時間：1分

    • 既存の統合との互換性を維持しながら、複数のバージョンの API を提供するために、Scripted REST API のバージョニングを有効にします。

    始める前に

    バージョニングを有効にする前に、Scripted REST API を定義する必要があります。

    必要なロール：web_service_admin

    手順

    1. 次のように移動する。 All (すべて) > システム Web サービス > スクリプト済み REST APIs.
    2. Scripted REST API を選択します。
    3. [関連リンク] で、[バージョニングの有効化] をクリックします。
      [バージョニングの有効化] ポップアップが表示されます。[バージョン v1 をデフォルトにする] チェックボックスはデフォルトでオンになっています。
    4. オプション: デフォルトバージョンなしでバージョニングを有効にするには、[バージョン v1 をデフォルトにする] チェックボックスをオフにします。
      デフォルトバージョンなしでバージョニングされた API は、バージョン固有の URI を使用する場合にのみアクセスできます。バージョン v1 をデフォルトにするか、バージョニングを有効にした後にデフォルトとして別のバージョンを選択します。
    5. [OK] をクリックします。
      [バージョニング] 埋め込みリストが [スクリプト化済み REST サービス] フォームに追加されます。このリストに新しいバージョンを追加したり、このリストからデフォルトにするバージョンを制御したりできます。