変更API V1のサポート終了のお知らせ
※本ナレッジは「End-of-Life (EOL) Announcement for Change V1 APIs」をもとに作成しております。
2024年1月31日より、ServiceDesk Plusの変更API V1のサポートが終了(EOL)となります。
これにより、以降のServiceDesk Plusのリリースでは、変更のAPI V1へアクセスできなくなります。
ビルド14503以下のServiceDesk Plusでは、引き続き変更API V1をご利用いただけます。
影響
API V1(特に変更のAPI V1)を利用して、ServiceDesk Plusと連携している
外部の製品/Webクライアント/デスクトップアプリが影響を受けます。
すなわち、API V1で設定しているクライアント連携/カスタムスクリプト/カスタム関数などで該当の機能が動作しなくなります。
推奨事項
API V1を使用して設定されている前述の機能を、API V3に更新することを強く推奨いたします。
なお、以下は廃止される変更のAPI V1および、それに対応するAPI V3の一覧です。
API名
|
API V1 URL
|
V1オペレーション名
|
対応するAPI V3 URL
|
V3 HTTPメソッド
|
GET Change
(変更の取得)
|
/sdpapi/change/{変更ID}
|
GET
|
/api/v3/changes/{変更ID}
|
GET
|
GET All Changes
(すべての変更の取得) |
/sdpapi/change
|
GET_ALL
|
/api/v3/changes
|
GET
|
ADD Change
(変更の追加) |
/sdpapi/change
|
ADD
|
/api/v3/changes
|
POST
|
UPDATE Change
(変更の更新) |
/sdpapi/change/{変更ID}
|
UPDATE
|
/api/v3/changes/{変更ID}
|
PUT
|
DELETE Change
(変更の削除) |
/sdpapi/change/{変更ID}
|
DELETE
|
/api/v3/changes/{変更ID}/move_to_trash
|
DELETE
|
ADD Attachment
in Change (変更への添付ファイルの追加)
|
/sdpapi/change/{変更ID}/attachment
|
ADD_ATTACHMENT
|
/api/v3/changes/{変更ID}/upload
(ここでの入力データはファイルデータとなります)
|
PUT
|
なお、ServiceDesk Plus内では、以下の機能で変更APIを用いたスクリプトをサポートしています。
そのため、以下機能も確認/更新することを強く推奨いたします。
- [管理]→[自動化]→[カスタムトリガー]→[変更]の[スクリプトを実行]オプション
- [管理]→[自動化]→[カスタムスケジュール]の「実行対象」セクション
- [管理]→[開発者スペース]→[カスタム関数]→[変更]のカスタム関数
- [管理]→[開発者スペース]→[ページスクリプト]
- [管理]→[開発者スペース]→[Webhook]→[新規変更]
- <インストールディレクトリ>\ManageEngine\ServiceDesk\integration\custom_scripts 内にあるカスタムスクリプト
API V3ドキュメント
APIの更新に伴い、ServiceDesk PlusのAPI V3ドキュメントツールを確認されたい場合、
ServiceDesk Plusの製品画面にて、[管理]→[開発者スペース]→[API]からご利用ください。
また、グローバル本社で公開している「デモサイト」を利用して、API V3のドキュメントをご参照いただけます。
その他ご不明な点等ございましたら「技術サポート」までお問い合わせください。