Update Message Rules¶

修改消息规则。

请求格式¶

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

请求参数（URI）¶

名称	位置（Path/Query）	必需/可选	数据类型	描述
orgId	Query	必需	String	OU ID。如何获取 orgId 信息 >>

请求参数（Header）¶

名称

必需/可选

数据类型

描述

Authorization

可选

String

用户登录并选择 OU 后生成的 Access Token，以 Bearer Token 表示，其形式为 Bearer {your token}。可通过调用 Log In 或 Refresh Access Token 接口后获取。

若未指定此参数，则应用将作为此次修改的相关用户。
若指定此参数，则 Access Token 所属的用户将作为此次修改的相关用户。获取 Access Token 的 OU 应与请求参数 orgId 的值保持一致。

请求参数（Body）¶

名称	必需/可选	数据类型	描述
ruleId	必需	String	消息规则 ID。
ruleName	可选	String	消息规则名称。如不指定，将不更新规则的名称。
isEnable	可选	String	是否启用规则。支持以下赋值： `0` 为禁用。 `1` 为启用。如不指定，将不更新规则的启用状态。
messageRule	必需	Object	基于特定标签触发消息的条件，例如资产、用户或事件类型。指定后，消息中的原有规则将被覆盖。每条规则需包含 1 至 6 个标签。规则内的所有标签必须同时满足，消息才会触发。标签的格式为键值对，形如 `"markN": ["值1", "值2", ...]` 或 `"markN": null`，其中：键：必须为 `markN` 格式，其中 N 为正整数，例如 mark1、mark2。键在规则内唯一。值：字符串列表（或 null），表示关联的实体，如场站 ID、用户 ID 等。每个值最长 400 字符。若一个值中列出多个实体，事件与任一实体匹配即为满足该标签。例如 `"messageRule": {"mark1": ["siteA", "siteB"], "mark2": ["user123"]}` 表示当事件与 `siteA` 或 `siteB` 关联，同时与 `user123` 关联时触发消息。
relations	可选	relationDTO 结构体	规则关联的用户或用户组。如不指定，将不更新规则关联的对象。relationDTO 结构体 >>

relationDTO 结构体¶

名称

必需/可选

数据类型

描述

type

可选，如需指定规则的关联对象则为必填

Integer

对象类型。支持以下赋值：

0 为用户。
1 为用户组。

identifiers

可选，如需指定规则的关联对象则为必填

List

用户或用户组 ID。

响应参数¶

名称	数据类型	描述
data	Boolean	更新结果。`true` 表示更新成功。`false` 表示更新失败。

错误码¶

代码	描述
31400	OU ID 为空，类型参数或是否启用参数不合法等。
31404	OU、应用、用户、用户组或消息规则不存在，或应用未被 OU 获取。
31600	消息规则内容异常。
31601	用户消息规则数量超过阈值。
31602	规则中 mark 数量超过阈值。
31603	消息规则不匹配。
31604	消息规则 mark 为空。
31607	用户组织结构错误。

示例¶

请求示例¶

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

method: POST

requestBody:
{
    "ruleId": "your_rule_id",
    "ruleName": "your_rule_name",
    "isEnable": 0,
    "messageRule": {
        "mark1": ["siteA","siteB"],
        "mark2": ["deviceA","deviceB"],
        "mark3": ["fault"],
        "mark4": [""],
        "mark6": null
    },
    "relations": [
        {
            "type": 0,
            "identifiers": ["your_user_id_1","your_user_id_2"]
        },
        {
            "type": 1,
            "identifiers": ["your_user_group_id"]
        }
    ]
}

返回示例¶

{
    "code": 0,
    "message": "OK",
    "data": true
}