image.update

説明

object image.update(object/array images)

このメソッドでは、既存の画像を更新できます。

パラメータ

(object/array) 更新する画像のプロパティ

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

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

戻り値

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

例

画像の名前変更

画像の名前を"Cloud icon"に変更

Request:

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

Response:

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

ソース

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