• 文档
  • 应用
  • Create Message Rules

Create Message Rules


创建消息规则。

请求格式


POST https://{apigw-address}/app-portal-service/v2.2/message-service/rule/create

请求参数（URI）


名称 必需/可选 数据类型 描述
orgId 必需 String 组织 ID。

请求参数（Body）


名称 必需/可选 数据类型 描述
appId 必需 String 应用 ID。
isEnable 必需 String 是否启用规则。0为禁用，1为启用。
rules 必需 ruleDTO 结构体 规则。
relations 可选 relationDTO 结构体 规则关联的用户或用户组。

ruleDTO 结构体


名称 必需/可选 数据类型 描述
ruleName 必需 String 规则名称。
messageRule 必需 Object 消息规则。

relationDTO 结构体


名称 必需/可选 数据类型 描述
type 可选 integer 类型。0为用户，1为用户组。
identifiers 可选 List 用户或用户组 ID 列表。

响应参数


名称 数据类型 描述
data List 创建的消息规则 ID。

错误码


代码 描述
31400 组织 ID 为空。
31404 组织不存在，应用不存在，组织未获取应用，用户或用户组不存在等。
31600 消息规则内容异常。
31601 消息规则数量超过限制。
31602 消息规则中 mark 数量超过限制。
31603 消息规则不匹配。
31604 消息规则 mark 为空。
31607 组织结构错误。

示例

请求示例


url: https://{apigw-address}/app-portal-service/v2.2/message-service/rule/create?orgId=your_org_id

method: POST

requestBody:
{
    "appId": "your_app_id",
    "rules": [
        {
            "isEnable": 0,
            "ruleName": "your_rule_name_1",
            "messageRule": {
                "mark1": ["siteA","siteB"],
                "mark2": ["deviceA","deviceB"],
                "mark3": ["fault"],
                "mark4": [""],
                "mark6": null
            }
        },
        {
            "isEnable": 0,
            "ruleName": "your_rule_name_2",
            "messageRule": {
                "mark1": ["siteA","siteB"],
                "mark2": ["deviceA","deviceB"],
                "mark3": ["fault"],
                "mark4": [""],
                "mark6": null
            }
        }
    ],
    "relations": [
        {
            "type": 0,
            "identifiers": ["your_id_1","your_id_2"]
        },
        {
            "type": 1,
            "identifiers": ["your_id_3"]
        }
    ]
}

返回示例


{
    "code": 0,
    "message": "OK",
    "data": ["your_rule_id_1","your_rule_id_2"]
}