[comment]: # ({2a69f566-2a69f566})
# screen.get

[comment]: # ({/2a69f566-2a69f566})

[comment]: # ({7e4bbf78-015f28d0})
### Description

`integer/array screen.get(object parameters)`

La méthode permet de récupérer des écrans en fonction des paramètres
donnés.

[comment]: # ({/7e4bbf78-015f28d0})

[comment]: # ({75eca424-eb531953})
### Paramètres

`(object)` Paramètres définissant la sortie souhaitée.

La méthode prend en charge les paramètres suivants.

|Paramètre|Type|Description|
|----------|----|-----------|
|screenids|string/array|Renvoie uniquement les écrans avec les identifiants donnés.|
|userids|string/array|Renvoie uniquement les écrans appartenant aux ID utilisateur donnés.|
|screenitemids|string/array|Renvoie uniquement les écrans contenant les éléments d’écran donnés.|
|selectUsers|query|Renvoie les utilisateurs avec lesquels l'écran est partagé dans la propriété `users`.|
|selectUserGroups|query|Renvoie les groupes d'utilisateur avec lesquels l'écran est partagé dans la propriété `userGroups`.|

|   |   |   |
|---|---|---|
|selectScreenItems|query|Renvoie les éléments d'écran utilisés dans l'écran.|
|sortfield|string/array|Trie le résultat en fonction des propriétés données.<br><br>Valeurs possibles : `screenid` et `name`.|
|countOutput|boolean|Ces paramètres, communs à toutes les méthodes "get", sont décrits dans les [commentaires de référence](/fr/manual/api/reference_commentary#Parametres_communs_de_la_methode_get).|
|editable|boolean|^|
|excludeSearch|boolean|^|
|filter|object|^|
|limit|integer|^|
|output|query|^|
|preservekeys|boolean|^|
|search|object|^|
|searchByAny|boolean|^|
|searchWildcardsEnabled|boolean|^|
|sortorder|string/array|^|
|startSearch|boolean|^|

[comment]: # ({/75eca424-eb531953})

[comment]: # ({36e7b1e2-7223bab1})
### Valeurs retournées

`(integer/array)` Retourne soit :

-   un tableau d'objets ;
-   le nombre d'objets récupérés, si le paramètre `countOutput` a été
    utilisé.

[comment]: # ({/36e7b1e2-7223bab1})

[comment]: # ({88e43968-b41637d2})
### Exemples

[comment]: # ({/88e43968-b41637d2})

[comment]: # ({fdc24d92-e68a8713})
#### Récupération d'écran par ID

Récupérer toutes les données de l'écran "26" et ses éléments d'écran.

Requête :

``` {.java}
{
    "jsonrpc": "2.0",
    "method": "screen.get",
    "params": {
        "output": "extend",
        "selectScreenItems": "extend",
        "selectUsers": "extend",
        "selectUserGroups": "extend",
        "screenids": "26"
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}
```

Réponse :

``` {.java}
{
    "jsonrpc": "2.0",
    "result": [    
        {
            "screenitems": [
                {
                    "screenitemid": "67",
                    "screenid": "26",
                    "resourcetype": "0",
                    "resourceid": "612",
                    "width": "320",
                    "height": "200",
                    "x": "0",
                    "y": "0",
                    "colspan": "0",
                    "rowspan": "0",
                    "elements": "25",
                    "valign": "0",
                    "halign": "0",
                    "style": "0",
                    "url": "",
                    "dynamic": "0",
                    "sort_triggers": "0"
                }
            ],
            "users": [
                {
                    "sysmapuserid": "1",
                    "userid": "2",
                    "permission": "2"
                }
            ],
            "userGroups": [
                {
                    "screenusrgrpid": "1",
                    "usrgrpid": "7",
                    "permission": "3"
                }
            ],
            "screenid": "26",
            "name": "CPU Graphs",
            "hsize": "3",
            "vsize": "2",
            "templateid": "0",
            "userid": "1",
            "private": "1"
        }
    ],
    "id": 1
}
```

[comment]: # ({/fdc24d92-e68a8713})

[comment]: # ({55be0bf4-796d9b7a})
### Voir également

-   [Élément
    d'écran](/fr/manual/api/reference/screenitem/object#element_d_ecran)
-   [Utilisateur
    d'écran](/fr/manual/api/reference/screen/object#utilisateurd_d_ecran)
-   [Groupe utilisateurs
    d'écran](/fr/manual/api/reference/screen/object#groupe_utilisateurs_d_ecran)

[comment]: # ({/55be0bf4-796d9b7a})

[comment]: # ({38924482-38924482})
### Source

CScreen::get() in
*frontends/php/include/classes/api/services/CScreen.php*.

[comment]: # ({/38924482-38924482})