image.update

説明

object image.update(object/array images)

このメソッドは、既存のイメージを更新するためのものです。

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

パラメータ

(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.

Documentation

image.update

説明

パラメータ

戻り値

例

イメージの名前変更

ソース