mediatype.update

説明

object mediatype.update(object/array mediaTypes)

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

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

パラメーター

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

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

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

パラメーター 型 説明
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.