image.update
説明
object image.update(object/array images)
このメソッドでは、既存の画像を更新できます。
このメソッドは、Super admin ユーザータイプでのみ利用できます。 メソッドを呼び出す権限は、ユーザーロールの設定で取り消すことができます。詳細は ユーザーロール を参照してください。
パラメータ
(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.