[comment]: # aside: 4
[comment]: # translation:outdated
[comment]: # ({f7884974-f7884974})
# dashboard.get
[comment]: # ({/f7884974-f7884974})
[comment]: # ({29679c8d-8d36c9b5})
### Description
`integer/array dashboard.get(object parameters)`
La méthode permet de récupérer des tableaux de bord en fonction des paramètres donnés.
::: noteclassic
Cette méthode est disponible pour tout type d'utilisateurs. Les autorisations d'appel de la méthode peuvent être révoquées dans les paramètres du rôle utilisateur. Voir les [rôles utilisateur](/manual/web_interface/frontend_sections/administration/user_roles) pour plus d'informations.
:::
[comment]: # ({/29679c8d-8d36c9b5})
[comment]: # ({af217620-342bbd26})
### Paramètres
`(object)` Paramètres définissant la sortie souhaitée.
La méthode prend en charge les paramètres suivants.
|Paramètre|[Type](/manual/api/reference_commentary#data-types)|Description|
|--|--|------|
|dashboardids|ID/array|Retourner uniquement les tableaux de bord avec les ID donnés.|
|selectPages|query|Retourner une propriété [`pages`](/manual/api/reference/dashboard/object#dashboard-page) avec les pages du tableau de bord, correctement ordonnées.|
|selectUsers|query|Retourner une propriété [`users`](/manual/api/reference/dashboard/object#dashboard-user) avec les utilisateurs avec lesquels le tableau de bord est partagé.|
|selectUserGroups|query|Retourner une propriété [`userGroups`](/manual/api/reference/dashboard/object#dashboard-user-group) avec les groupes d'utilisateurs avec lesquels le tableau de bord est partagé.|
|sortfield|string/array|Trier le résultat selon les propriétés données.
Valeurs possibles : `dashboardid`.|
|countOutput|boolean|Ces paramètres sont décrits dans le [commentaire de référence](/manual/api/reference_commentary#common-get-method-parameters).|
|editable|boolean|^|
|excludeSearch|boolean|^|
|filter|object|^|
|limit|integer|^|
|output|query|^|
|preservekeys|boolean|^|
|search|object|^|
|searchByAny|boolean|^|
|searchWildcardsEnabled|boolean|^|
|sortorder|string/array|^|
|startSearch|boolean|^|
[comment]: # ({/af217620-342bbd26})
[comment]: # ({7223bab1-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]: # ({/7223bab1-7223bab1})
[comment]: # ({b41637d2-b41637d2})
### Exemples
[comment]: # ({/b41637d2-b41637d2})
[comment]: # ({b8f24ab7-84a10cd6})
#### Récupération d’un tableau de bord par ID
Récupérez toutes les données des tableaux de bord « 1 » et « 2 ».
[Requête](/manual/api#performing-requests) :
```json
{
"jsonrpc": "2.0",
"method": "dashboard.get",
"params": {
"output": "extend",
"selectPages": "extend",
"selectUsers": "extend",
"selectUserGroups": "extend",
"dashboardids": [
"1",
"2"
]
},
"id": 1
}
```
Réponse :
```json
{
"jsonrpc": "2.0",
"result": [
{
"dashboardid": "1",
"name": "Dashboard",
"userid": "1",
"private": "0",
"display_period": "30",
"auto_start": "1",
"users": [],
"userGroups": [],
"pages": [
{
"dashboard_pageid": "1",
"name": "",
"display_period": "0",
"widgets": [
{
"widgetid": "9",
"type": "systeminfo",
"name": "",
"x": "12",
"y": "8",
"width": "12",
"height": "5",
"view_mode": "0",
"fields": []
},
{
"widgetid": "8",
"type": "problemsbysv",
"name": "",
"x": "12",
"y": "4",
"width": "12",
"height": "4",
"view_mode": "0",
"fields": []
},
{
"widgetid": "7",
"type": "problemhosts",
"name": "",
"x": "12",
"y": "0",
"width": "12",
"height": "4",
"view_mode": "0",
"fields": []
},
{
"widgetid": "6",
"type": "discovery",
"name": "",
"x": "6",
"y": "9",
"width": "18",
"height": "4",
"view_mode": "0",
"fields": []
},
{
"widgetid": "5",
"type": "web",
"name": "",
"x": "0",
"y": "9",
"width": "18",
"height": "4",
"view_mode": "0",
"fields": []
},
{
"widgetid": "4",
"type": "problems",
"name": "",
"x": "0",
"y": "3",
"width": "12",
"height": "6",
"view_mode": "0",
"fields": []
},
{
"widgetid": "3",
"type": "favmaps",
"name": "",
"x": "8",
"y": "0",
"width": "12",
"height": "3",
"view_mode": "0",
"fields": []
},
{
"widgetid": "1",
"type": "favgraphs",
"name": "",
"x": "0",
"y": "0",
"width": "12",
"height": "3",
"view_mode": "0",
"fields": []
}
]
},
{
"dashboard_pageid": "2",
"name": "",
"display_period": "0",
"widgets": []
},
{
"dashboard_pageid": "3",
"name": "Custom page name",
"display_period": "60",
"widgets": []
}
]
},
{
"dashboardid": "2",
"name": "My dashboard",
"userid": "1",
"private": "1",
"display_period": "60",
"auto_start": "1",
"users": [
{
"userid": "4",
"permission": "3"
}
],
"userGroups": [
{
"usrgrpid": "7",
"permission": "2"
}
],
"pages": [
{
"dashboard_pageid": "4",
"name": "",
"display_period": "0",
"widgets": [
{
"widgetid": "10",
"type": "problems",
"name": "",
"x": "0",
"y": "0",
"width": "12",
"height": "5",
"view_mode": "0",
"fields": [
{
"type": "2",
"name": "groupids",
"value": "4"
}
]
}
]
}
]
}
],
"id": 1
}
```
[comment]: # ({/b8f24ab7-84a10cd6})
[comment]: # ({9c4ba6ce-299ae089})
### Voir aussi
- [Page de tableau de bord](object#dashboard-page)
- [Widget de tableau de bord](object#dashboard-widget)
- [Champ de widget de tableau de bord](object#dashboard-widget-field)
- [Utilisateur du tableau de bord](object#dashboard-user)
- [Groupe d'utilisateurs du tableau de bord](object#dashboard-user-group)
[comment]: # ({/9c4ba6ce-299ae089})
[comment]: # ({75a9042e-75a9042e})
### Source
CDashboard::get() dans *ui/include/classes/api/services/CDashboard.php*.
[comment]: # ({/75a9042e-75a9042e})