Register Resource¶
注册资源。
请求格式¶
POST https://{apigw-address}/app-portal-service/v2.3/resource/create
请求参数(Query)¶
名称 |
必需/可选 |
数据类型 |
描述 |
---|---|---|---|
orgId |
必需 |
String |
组织 ID。 |
请求参数(Body)¶
名称 |
必需/可选 |
数据类型 |
描述 |
---|---|---|---|
resources |
必需 |
Resources 结构体 |
资源列表。 |
type |
必需 |
String |
资源类型标识符。 |
assignCodeTold |
可选 |
Boolean |
资源标识符是否和资源代码保持一致。true 为一致,false 为不一致,默认值为 false。 |
响应参数¶
名称 |
数据类型 |
描述 |
---|---|---|
data |
Data 结构体 |
资源注册结果与资源信息。 |
Data 结构体¶
名称 |
数据类型 |
描述 |
---|---|---|
success |
Boolean |
注册结果。true 为成功,false 为失败。 |
resources |
Resources 返回结构体 |
资源信息。 |
Resources 返回结构体¶
名称 |
数据类型 |
描述 |
---|---|---|
id |
String |
资源标识符。 |
code |
String |
资源代码。 |
name |
Object |
资源名称。 |
type |
String |
资源类型。 |
错误码¶
代码 |
描述 |
---|---|
31400 |
缺少必要参数,或资源名称不符合规则。 |
31404 |
本 OU 未获取此应用。 |
31408 |
资源代码或资源标识符已存在。 |
31415 |
资源总数已达上限。 |
示例¶
请求示例¶
url: /app-portal-service/v2.3/resource/create?orgId=your_org_ID
method: POST
{
"type": "your_resource_type",
"assignCodeToId": true,
"resources": [
{
"code": "your_resource_code_1",
"name": {
"defaultValue": "your_resource_name_1",
"i18nValue": {
"zh_CN": "your_resource_name_zh_1",
"en_US": "your_resource_name_en_1"
}
}
},
{
"code": "your_resource_code_2",
"name": {
"defaultValue": "your_resource_name_2",
"i18nValue": {
"zh_CN": "your_resource_name_zh_2",
"en_US": "your_resource_name_en_2"
}
}
}
]
}
返回示例¶
{
"code": 0,
"message": "OK",
"data": {
"success": true,
"resources": [
{
"id": "your_resource_id_1",
"code": "your_resource_code_1",
"type": "your_resource_type_1",
"name": {
"defaultValue": "your_resource_name_1",
"i18nValue": {
"zh_CN": "your_resource_name_zh_1",
"en_US": "your_resource_name_en_1"
}
}
},
{
"id": "your_resource_id_2",
"code": "your_resource_code_2",
"type": "your_resource_type_2",
"name": {
"defaultValue": "your_resource_name_2",
"i18nValue": {
"zh_CN": "your_resource_name_zh_2",
"en_US": "your_resource_name_en_2"
}
}
}
]
}
}