image.update

Description

object image.update(object/array images)

Cette méthode permet de mettre à jour des images existantes.

Paramètres

(object/array) Propriétés de l'image à mettre à jour.

La propriété imageid doit être définie pour chaque image, toutes les autres propriétés sont facultatives. Seules les propriétés transmises seront mises à jour, toutes les autres resteront inchangées.

En plus des propriétés de l'objet image standard, la méthode accepte les paramètres suivants.

Paramètre Type Description
image string Image encodée en base64. La taille maximale de l'image encodée est de 1 Mo.

Valeurs retournées

(object) Retourne un objet contenant les identifiants des images mises à jour sous la propriété imageids.

Exemples

Renommage d'une image

Renommer une image en "Cloud icon".

Requête :

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

Réponse :

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

Source

CImage::update() dans frontends/php/include/classes/api/services/CImage.php.