ServiceDesk Plus オンプレミス版 ナレッジベース

リクエストAPI V1のサポート終了について


本ナレッジは「End-of-Life of Request V1 APIs - Impact on Upgrade, Scripts and Integrations」を参考に記載しています。

 

ServiceDesk Plusバージョン11.3より、一部のリクエストAPI V1のサポートが終了となります。
これらのAPIに基づくすべてのクライアントと連携は、新しいAPIに更新されない限り、動作しなくなります。
そのため、新しいバージョンのAPIを使用および更新することを推奨いたします。

本変更に伴い、カスタムトリガーとカスタムメニューコマンドのカスタムスクリプトの入力フォーマットを変更しました。サポートが終了となった場合、カスタムトリガーとカスタムメニューコマンドでは、引数「$COMPLETE_JSON_FILE」は機能しなくなります。その代わり、API V3フォーマットで入力する引数「$COMPLETE_V3_JSON_FILE」を使用してください。カスタムトリガーとカスタムメニューでサポートされていない「$COMPLETE_JSON_FILE」が使用されている場合、バージョン11.3へアップグレードできません。
影響を受ける機能
  • [管理]→[カスタムトリガー]→[スクリプトを実行する]
  • [管理]→[インシデント/サービスカタログの業務ルール]→[スクリプトを実行する]
  • [管理]→[リクエストライフサイクル]→[スクリプトを実行する]
  • [管理]→[カスタムメニュー]→[スクリプトを実行する]
  • [管理]→[インシデントテンプレート/サービスカタログ]→[フィールド&フォームルールのスクリプトを実行する]
  • [管理]→[カスタムスケジュール]→[実行対象]
  • [ホームページ&ダッシュボード]→[ウィジェットのカスタマイズ]
  • [管理]→[ページスクリプト]

サポートが終了となった場合、カスタムトリガーとカスタムメニューコマンドでは引数「$ COMPLETE_JSON_FILE」は機能しません。引数「$COMPLETE_V3_JSON_FILE」を使用してください。

サポート終了となるリクエストAPI V1およびAPI V3の一覧

API V3をサポートしていないリクエストAPI V1に関しては、バージョン11.3以降も当面は引き続き利用可能です。
例:GET_REQUEST_FILTERS、ADD_CONVERSATION、REPLY_REQUEST、GET_CONVERSATION、GET_NOTIFICATION、MENU_ACTION

注意点

ServiceDesk Plusのモバイルアプリを使用している場合は、モバイルアプリを最新バージョンへアップグレードをお願いします。

  • IOS:バージョン5.2.2011以降
  • Android:バージョン5.5以降

 

ServiceDesk Plusインスタンスが連携している他のManageEngine製品のバージョンにも影響します。すべての連携が機能するように他の製品についても確認するようお願いします。

リクエストAPI V3がサポートされているManageEngine製品のビルドは以下の通りです。

  • Desktop Central:ビルド100574以降
  • OpManager:ビルド12.5.0232以降
  • Application Manager:ビルド14780以降
  • Password Manager Pro:ビルド11200以降
  • ADManager:未定
  • ADSelfService Plus:未定

なお、これらの製品の互換性バージョンが利用可能になるまで、ServiceDesk Plusのアップグレードを延期することを推奨いたします。

関連するドキュメント

API V1とAPI V3の違いについては、「API V1とV3の比較」をご覧ください。

API V3に関するドキュメントは「API Documentation」をご覧ください。