应用
创建迁移包升级任务
创建迁移包文件的导入迁移或升级任务。通过 API 操作时不校验操作人的个人权限。
鉴权方式
HAP 组织授权开放接口为每个组织提供一套独立的密钥信息(AppKey 和 SecretKey),组织可通过此密钥信息安全调用 HAP 平台开放的各类接口,包括人员组织管理、汇报关系管理、应用管理、流程待办等数据接口。
版本
请求地址
Body 参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
appKey | string | 是 | AppKey |
sign | string | 是 | 签名 |
timestamp | integer | 是 | 时间戳 |
projectId | string | 是 | HAP组织Id |
operatorId | string | 是 | 操作人 ID |
mediaList | object[] | 是 | 本次导入或升级的迁移包文件列表 |
mediaList.mediaId | string | 是 | 文件 id |
mediaList.password | string | 否 | 非必填:导入密码,若该文件设置了密码时填写 |
mediaList.appId | string | 是 | 应用 id。为空表示导入新应用,不为空表示升级指定应用 |
callback | string | 是 | 回调地址,用于接收文件导入的状态变更回调消息,实时了解文件导入的进度与结果。 |
modelType | integer | 是 | 更新模式。0:合并更新,1:覆盖更新 可选值: 01 |
backupCurrentVersion | boolean | 是 | 是否备份当前版本,备份:true,不备份:false,默认为 true |
matchOffice | boolean | 是 | 是否匹配人员部门职位,匹配:true,不匹配:false,默认为 true |
upgradeName | boolean | 是 | 是否更新名称和说明,默认为 true,更新:true,不更新:false |
upgradeHide | boolean | 是 | 是否更新显隐配置,默认为 true,更新:true,不更新:false |
upgradeStyle | boolean | 是 | 是否更新外观与导航,默认为 true,更新:true,不更新:false |
upgradeLang | boolean | 是 | 是否更新应用语言,默认为 true,更新:true,不更新:false |
upgradeTimeZone | boolean | 是 | 是否更新应用时区,默认为 true,更新:true,不更新:false |
响应参数
200| 名称 | 类型 | 描述 |
|---|---|---|
error_code | integer | 状态码,1表示成功,非1表示操作异常。 (为1时error_msg字段不存在,非1时data字段不存在) |
error_msg | string | 状态描述 |
success | boolean | error_code为1时该参数值为true,否则为false |
data | object | — |
data.upgradeId | string | 导入迁移/升级任务 ID |
curl -X POST "https://example.com/v1/open/App/ImportMigration" \ -H "Content-Type: application/json" \ -d '{ "appKey": "string", "sign": "string", "timestamp": 0, "projectId": "string", "operatorId": "user_123", "mediaList": [ { "mediaId": "file_111", "password": "xxxxxx", "appId": "" } ], "callback": "https://example.com/import/callback", "modelType": 0, "backupCurrentVersion": true, "matchOffice": true, "upgradeName": true, "upgradeHide": true, "upgradeStyle": true, "upgradeLang": true, "upgradeTimeZone": true }'{ "data": { "upgradeId": "upg_20250211_000001" }, "error_code": null, "error_msg": null, "success": true}