Change V1 API 结束生命周期(EOL)公告

Change V1 API 结束生命周期(EOL)公告

用户朋友们,

ServiceDesk Plus变更模块的V1 API将会在2024年1月31日结束其生命周期,此后后续版本的发布V1版本的变更API将不再可用。 

影响:

任何外部产品、WEB客户端或桌面应用通过V1 API与ServiceDesk Plus集成的会受到影响(特别是集成中使用了变更API的)。

简单来说,任何使用v1版本API的功能,如客户端集成、客户端脚本或功能配置将不再工作。

建议行动:

我们强烈建议采用v3 API来更新可能涉及的集成功能内容,避免因V1生命周期到期而产生不必要的影响。

以下是将会启用的变更 V1 版本 API 清单以及对应的V3版本API:

API 名称
V1 API URL
V1 操作名称
等效 V3 API URL
V3 HTTP 方法
获取变更
/sdpapi/change/{change_id}
GET
/api/v3/changes/{change_id}
GET
获取所有变更
/sdpapi/change
GET_ALL
/api/v3/changes
GET
添加变更
/sdpapi/change
ADD
/api/v3/changes
POST
更新变更
/sdpapi/change/{change_id}
UPDATE
/api/v3/changes/{change_id}
PUT
删除变更
/sdpapi/change/{change_id}
DELETE
/api/v3/changes/{change_id}/move_to_trash
DELETE
添加附件到变更
/sdpapi/change/{change_id}/attachment
ADD_ATTACHMENT
/api/v3/changes/{change_id}/upload

(Here the input data would be the file data.)
PUT


在ServiceDesk Plus中,变更API也在诸多支持脚本的功能中使用(如下),我们也强烈建议用户检查并做相应修改:

1. 管理 > 自动化 - 自定义触发器 - 变更 > 执行脚本操作
2. 管理 > 开发者空间 - 自定义函数 - 变更 > 自定义函数
3. 管理 > 自动化 - 自定义计划 > 执行器
4. 管理 > 开发者空间 - 页面脚本
5. 管理 > 开发者空间 - Webhook - 变更
6. 位于<SDP_Home>\integration\custom_scripts文件夹的自定义脚本

V3 API文档:

可参考应用中管理 > 开发者空间 > API下的文档。您也可以在我们的演示环境中查看:


更多有关变更模块以v3 API配置的示例功能可参考以下链接: