image.update

説明

object image.update(object/array images)

このメソッドを使用すると、既存の画像を更新できます。

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

パラメータ

(object/array) 更新するイメージのプロパティ。

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

このメソッドは標準イメージプロパティを持つイメージを受け付けます。

戻り値

(object) imageidsプロパティの下で更新された画像のIDを含むオブジェクトを返します。

例

イメージの名前変更

イメージの名前を「Cloud icon」に変更します。

リクエスト:

{
    "jsonrpc": "2.0",
    "method": "image.update",
    "params": {
        "imageid": "2",
        "name": "Cloud icon"
    },
    "id": 1
}

レスポンス:

{
    "jsonrpc": "2.0",
    "result": {
        "imageids": [
            "2"
        ]
    },
    "id": 1
}

ソース

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