更新

描述

object mediatype.update(object/array mediaTypes)

此方法允许更新现有的媒介类型。

此方法对于任何用户可用。可以在用户角色设置中撤销调用该方法的权限。更多信息请查看 用户角色

参数

(object/array) 需要被更新的媒介类型属性。

必须为每种媒介类型定义mediatypeid属性,其他所有属性都是可选的。只有传递的属性会被更新,其他所有的都将保持不变。

除了标准媒介类型属性外,此方法还接受以下参数。

参数 类型 描述
parameters array Webhook 参数 用于替换当前的 webhook 参数。
message_templates array 消息模板 用于替换当前的消息模板。

返回值

(object) 返回包含mediatypeids属性下所更新IDs的对象。

示例

启用一个媒介类型

启用媒介类型,即设置其状态为0。

请求:

{
    "jsonrpc": "2.0",
    "method": "mediatype.update",
    "params": {
        "mediatypeid": "6",
        "status": 0
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}

响应:

{
    "jsonrpc": "2.0",
    "result": {
        "mediatypeids": [
            "6"
        ]
    },
    "id": 1
}

来源

ui/include/classes/api/services/CMediaType.php 中的 CMediaType::update()。