Update App¶
更新组织应用。
操作权限¶
应用被授权 OU 的应用注册管理员策略。
请求格式¶
PUT https://{apigw-address}/enos-app-service/v2.5/apps
请求参数(URI)¶
名称 |
位置(Path/Query) |
必需/可选 |
数据类型 |
描述 |
---|---|---|---|---|
orgId |
Query |
必需 |
String |
应用所属的 OU ID。如何获取 orgId 信息 >> |
请求参数(Header)¶
名称 |
必需/可选 |
数据类型 |
描述 |
---|---|---|---|
accept-language |
可选 |
String |
返回结果中的语言,如 zh-CN、en-US。默认返回所有可用的国际化内容。EnOS 支持的语言 >> |
请求参数(Body)¶
名称 |
必需/可选 |
数据类型 |
描述 |
---|---|---|---|
id |
必需 |
String |
应用 ID,由系统自动生成的唯一标识。 |
name |
必需 |
StringI18n |
应用名称。 国际化字段表示方法 >> |
category |
必需 |
Integer |
应用分类的 ID,如 |
type |
必需 |
integer |
应用类型, |
keyword |
可选 |
String |
应用标识符,自定义的应用唯一标识。 |
icon |
可选 |
String |
应用的图标,使用 base64 编码的图像数据字符串来表示。 |
description |
可选 |
StringI18n |
应用的描述信息。 国际化字段表示方法 >> |
url |
可选 |
String |
应用的 URL。 |
响应参数¶
名称 |
数据类型 |
描述 |
---|---|---|
id |
String |
应用 ID,由系统生成的唯一标识。 |
accessKey |
String |
应用的 accessKey。 |
secretKey |
String |
应用的 secretKey。 |
name |
StringI18n |
应用的名称。 |
description |
StringI18n |
应用的描述。 |
categoryId |
String |
应用分类的 ID。 |
categoryName |
StringI18n |
应用分类的名称。 |
keyword |
String |
应用标识,自定义的应用唯一标识。 |
type |
String |
应用类型。 |
icon |
String |
应用的图标。 |
url |
String |
应用的 URL。 |
organizationId |
String |
应用所属的 OU ID。 |
organizationName |
String |
应用所属的 OU 名称。 |
createdByUserId |
String |
应用的创建人 ID。 |
createdAt |
String |
应用的创建时间。 |
status |
String |
应用的状态,固定为 |
createdByUserName |
String |
应用的创建人名称。 |
approvedAt |
String |
应用获取请求审批通过的时间。 |
示例¶
请求示例¶
url: https://{apigw-address}/enos-app-service/v2.5/apps?orgId=yourOrgId
method: PUT
request Body:
{
"id": "abc-applicationID-xyz",
"name": {
"en_US": "Energy Management",
"zh_CN":"",
"default": "Energy Management"
},
"description": {
"en_US": "Energy Management",
"zh_CN": "",
"default": "Energy Management"
},
"type": 0,
"keyword": "energy-management",
"category": 101,
"url": "",
"icon": ""
}
返回示例¶
{
"code": 0,
"msg": "OK",
"subMsg": null,
"data": {
"id": "abc-applicationID-xyz",
"accessKey": "accesskey-application",
"secretKey": "secretkey-application",
"name": {
"default": "Energy Management",
"en_US": "Energy Management",
"zh_CN": "能源管理应用"
},
"description": {
"default": "Energy Management",
"en_US": "Energy Management",
"zh_CN": "能源管理应用"
},
"keyword": "energy-management",
"categoryId": 101,
"categoryName": {
"pl_PL": "",
"en_US": "Storage",
"es_ES": "",
"zh_CN": "储能",
"fr_FR": "",
"ja_JP": "",
"de_DE": ""
},
"type": 0,
"icon": "",
"url": "",
"organizationId": "yourorgId",
"organizationName": "Your OU Name",
"createdByUserId": "abc-userID-xyz",
"createdAt": "2024-01-19 08:40:45",
"status": 2,
"createByUserName": null,
"approvedAt": null
}
}