mediatype.update

説明

object mediatype.update(object/array mediaTypes)

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

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

パラメータ

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

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

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

パラメータ タイプ 説明
parameters array Webhookパラメーター。現在のWebhookパラメーターを置き換えます。
message_templates array メッセージテンプレート。現在のメッセージテンプレートを置き換えます。

戻り値

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

例

メディアタイプの有効化

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

Request:

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

Response:

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

ソース

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