screen.create

Description

object screen.create(object/array screens)

Cette méthode permet de créer de nouveaux écrans.

Paramètres

(object/array) Écran à créer.

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

Paramètre Type Description
screenitems array Éléments d'écran à créer pour l'écran.
users array Partages utilisateur d'écran à créer pour l'écran.
userGroups array Partages groupe d'utilisateurs d'écran à créer pour l'écran.

Valeurs retournées

(object) Retourne un objet contenant les identifiants des écrans créés sous la propriété screenids. L'ordre des ID retournés correspond à l'ordre des écrans passés.

Exemples

Création d'écran

Créer un écran nommé "Graphs" avec 2 lignes et 3 colonnes et ajouter un graphique à la cellule supérieure gauche.

Requête :

{
    "jsonrpc": "2.0",
    "method": "screen.create",
    "params": {
        "name": "Graphs",
        "hsize": 3,
        "vsize": 2,
        "screenitems": [
            {
                "resourcetype": 0,
                "resourceid": "612",
                "rowspan": 1,
                "colspan": 1,
                "x": 0,
                "y": 0
            }
        ]
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}

Réponse :

{
    "jsonrpc": "2.0",
    "result": {
        "screenids": [
            "26"
        ]
    },
    "id": 1
}

Partage d'écran

Créer un écran avec deux types de partage (utilisateur et groupe d'utilisateurs).

Requête :

{
    "jsonrpc": "2.0",
    "method": "screen.create",
    "params": {
        "name": "Screen sharing",
        "hsize": 3,
        "vsize": 2,
        "users": [
            {
                "userid": "4",
                "permission": "3"
            }
        ],
        "userGroups": [
            {
                "usrgrpid": "7",
                "permission": "2"
            }
        ]
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}

Réponse :

{
    "jsonrpc": "2.0",
    "result": {
        "screenids": [
            "83"
        ]
    },
    "id": 1
}

Voir également

Source

CScreen::create() dans frontends/php/include/classes/api/services/CScreen.php.