mediatype.update

説明

object mediatype.update(object/array mediaTypes)

このメソッドでは、既存のメディアタイプを更新できます。

このメソッドは、Super admin ユーザータイプでのみ利用できます。 このメソッドを呼び出す権限は、ユーザーロール設定で取り消すことができます。詳細は ユーザーロール を参照してください。

パラメータ

(object/array) 更新するメディアタイプのプロパティ。

各メディアタイプに対して mediatypeid プロパティを定義する必要があり、その他の プロパティはすべて任意です。渡されたプロパティのみが 更新され、その他はすべて変更されません。

このメソッドは、標準のメディアタイププロパティに加えて、 以下のパラメータを受け付けます。

パラメータ Type 説明
message_templates array 現在のメッセージテンプレートを置き換えるメッセージテンプレート。

戻り値

(object) mediatypeidsプロパティの下で更新されたメディアタイプのIDを含むオブジェクトを返します。

例

メディアタイプの有効化

メディアタイプを有効化します。つまり、ステータスを "0" に設定します。

リクエスト:

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

レスポンス:

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

ソース

CMediaType::update() in ui/include/classes/api/services/CMediaType.php.