[comment]: # translation:outdated
[comment]: # ({14e441a9-14e441a9})
# map.get
[comment]: # ({/14e441a9-14e441a9})
[comment]: # ({72489b9c-480bee08})
### Description
`integer/array map.get(object parameters)`
La méthode permet de récupérer des cartes selon les paramètres donnés.
::: noteclassic
Cette méthode est disponible pour les utilisateurs de tout type. Les autorisations
d’appeler la méthode peuvent être révoquées dans les paramètres du rôle utilisateur. Voir [User
roles](/manual/web_interface/frontend_sections/users/user_roles)
pour plus d’informations.
:::
[comment]: # ({/72489b9c-480bee08})
[comment]: # ({eb92de32-c0fdc6dd})
### 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|
|--|--|------|
|sysmapids|ID/array|Renvoie uniquement les cartes avec les ID donnés.|
|userids|ID/array|Renvoie uniquement les cartes qui appartiennent aux ID d'utilisateur donnés.|
|expandUrls|flag|Ajoute les URL globales de la carte aux éléments de carte correspondants et développe les macros dans toutes les URL des éléments de carte.|
|selectIconMap|query|Renvoie une propriété [`iconmap`](/manual/api/reference/iconmap/object) avec le plan d'icônes utilisé sur la carte.|
|selectLinks|query|Renvoie une propriété [`links`](/manual/api/reference/map/object#map-link) avec les liens de la carte entre les éléments.|
|selectSelements|query|Renvoie une propriété [`selements`](/manual/api/reference/map/object#map-element) avec les éléments de la carte.|
|selectUrls|query|Renvoie une propriété [`urls`](/manual/api/reference/map/object#map-url) avec les URL de la carte.|
|selectUsers|query|Renvoie une propriété [`users`](/manual/api/reference/map/object#map-user) avec les utilisateurs avec lesquels la carte est partagée.|
|selectUserGroups|query|Renvoie une propriété [`userGroups`](/manual/api/reference/map/object#map-user-group) avec les groupes d'utilisateurs avec lesquels la carte est partagée.|
|selectShapes|query|Renvoie une propriété [`shapes`](/manual/api/reference/map/object#map-shapes) avec les formes de la carte.|
|selectLines|query|Renvoie une propriété [`lines`](/manual/api/reference/map/object#map-lines) avec les lignes de la carte.|
|sortfield|string/array|Trie le résultat selon les propriétés données.
Valeurs possibles : `name`, `width`, `height`.|
|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]: # ({/eb92de32-c0fdc6dd})
[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]: # ({645c26fb-cb769d11})
#### Récupérer une carte
Récupérez toutes les données concernant la carte « 3 ».
[Requête](/manual/api#performing-requests) :
```json
{
"jsonrpc": "2.0",
"method": "map.get",
"params": {
"output": "extend",
"selectSelements": "extend",
"selectLinks": "extend",
"selectUsers": "extend",
"selectUserGroups": "extend",
"selectShapes": "extend",
"selectLines": "extend",
"sysmapids": "3"
},
"id": 1
}
```
Réponse :
```json
{
"jsonrpc": "2.0",
"result": [
{
"selements": [
{
"selementid": "10",
"sysmapid": "3",
"elementtype": "4",
"evaltype": "0",
"iconid_off": "1",
"iconid_on": "0",
"label": "Zabbix server",
"label_location": "3",
"x": "11",
"y": "141",
"iconid_disabled": "0",
"iconid_maintenance": "0",
"elementsubtype": "0",
"areatype": "0",
"width": "200",
"height": "200",
"viewtype": "0",
"use_iconmap": "1",
"show_label": "-1",
"zindex":"0",
"elements": [],
"urls": [],
"tags": [
{
"tag": "service",
"value": "mysqld",
"operator": "0"
}
]
},
{
"selementid": "11",
"sysmapid": "3",
"elementtype": "4",
"evaltype": "0",
"iconid_off": "1",
"iconid_on": "0",
"label": "Web server",
"label_location": "3",
"x": "211",
"y": "191",
"iconid_disabled": "0",
"iconid_maintenance": "0",
"elementsubtype": "0",
"areatype": "0",
"width": "200",
"height": "200",
"viewtype": "0",
"use_iconmap": "1",
"show_label": "0",
"zindex":"0",
"elements": [],
"urls": [],
"tags": []
},
{
"selementid": "12",
"sysmapid": "3",
"elementtype": "0",
"evaltype": "0",
"iconid_off": "185",
"iconid_on": "0",
"label": "{HOST.NAME}\r\n{HOST.CONN}",
"label_location": "0",
"x": "111",
"y": "61",
"iconid_disabled": "0",
"iconid_maintenance": "0",
"elementsubtype": "0",
"areatype": "0",
"width": "200",
"height": "200",
"viewtype": "0",
"use_iconmap": "0",
"show_label": "1",
"zindex":"0",
"elements": [
{
"hostid": "10084"
}
],
"urls": [],
"tags": []
}
],
"links": [
{
"linkid": "23",
"sysmapid": "3",
"selementid1": "10",
"selementid2": "11",
"drawtype": "0",
"color": "00CC00",
"label": "",
"show_label": "1",
"indicator_type": "0",
"itemid": "0",
"linktriggers": [],
"thresholds": [],
"highlights": []
}
],
"users": [
{
"sysmapuserid": "1",
"userid": "2",
"permission": "2"
}
],
"userGroups": [
{
"sysmapusrgrpid": "1",
"usrgrpid": "7",
"permission": "2"
}
],
"shapes":[
{
"sysmap_shapeid":"1",
"type":"0",
"x":"0",
"y":"0",
"width":"680",
"height":"15",
"text":"{MAP.NAME}",
"font":"9",
"font_size":"11",
"font_color":"000000",
"text_halign":"0",
"text_valign":"0",
"border_type":"0",
"border_width":"0",
"border_color":"000000",
"background_color":"",
"zindex":"0"
}
],
"lines":[
{
"sysmap_shapeid":"2",
"x1": 30,
"y1": 10,
"x2": 100,
"y2": 50,
"line_type": 1,
"line_width": 10,
"line_color": "009900",
"zindex":"1"
}
],
"sysmapid": "3",
"name": "Local network",
"width": "400",
"height": "400",
"backgroundid": "0",
"background_scale": "1",
"label_type": "2",
"label_location": "3",
"show_element_label": "0",
"show_link_label": "1",
"highlight": "1",
"expandproblem": "1",
"markelements": "0",
"show_unack": "0",
"grid_size": "50",
"grid_show": "1",
"grid_align": "1",
"label_format": "0",
"label_type_host": "2",
"label_type_hostgroup": "2",
"label_type_trigger": "2",
"label_type_map": "2",
"label_type_image": "2",
"label_string_host": "",
"label_string_hostgroup": "",
"label_string_trigger": "",
"label_string_map": "",
"label_string_image": "",
"iconmapid": "0",
"expand_macros": "0",
"severity_min": "0",
"userid": "1",
"private": "1",
"show_suppressed": "1"
}
],
"id": 1
}
```
[comment]: # ({/645c26fb-cb769d11})
[comment]: # ({07cf6602-4be4cd90})
### Voir aussi
- [Carte d'icônes](/manual/api/reference/iconmap/object#icon-map)
- [Élément de carte](object#map-element)
- [Lien de carte](object#map-link)
- [URL de carte](object#map-url)
- [Utilisateur de carte](object#map-user)
- [Groupe d'utilisateurs de carte](object#map-user-group)
- [Formes de carte](object#map-shapes)
- [Lignes de carte](object#map-lines)
[comment]: # ({/07cf6602-4be4cd90})
[comment]: # ({d61644e7-d61644e7})
### Source
CMap::get() dans *ui/include/classes/api/services/CMap.php*.
[comment]: # ({/d61644e7-d61644e7})