Documentation
Table of Contents
service.get
Description
integer/array service.get(object parameters)
La m¨¦thode permet de r¨¦cup¨¦rer des services en fonction des param¨¨tres donn¨¦s.
Cette m¨¦thode est disponible ¨¤ tous les types d'utilisateurs. Les autorisations d'appeler la m¨¦thode peuvent ¨ºtre r¨¦voqu¨¦es dans les param¨¨tres du le r?le d'utilisateur. Voir R?les Utilisateur pour plus d'informations.
±Ê²¹°ù²¹³¾¨¨³Ù°ù±ð²õ
(object) ±Ê²¹°ù²¹³¾¨¨³Ù°ù±ð²õ d¨¦finissant la sortie souhait¨¦e.
La m¨¦thode prend en charge les param¨¨tres suivants.
| ±Ê²¹°ù²¹³¾¨¨³Ù°ù±ð | Type | |
|---|---|---|
| serviceids | string/array | Renvoie uniquement les services avec les ID donn¨¦s. |
| parentids | string/array | Renvoie uniquement les services li¨¦s aux services parents donn¨¦s. |
| deep_parentids | flag | Renvoyer tous les services directs et indirects aux enfants. Utilis¨¦ avec parentids. |
| childids | string/array | Renvoie uniquement les services li¨¦s aux services enfants donn¨¦s. |
| evaltype | integer | R¨¨gles de recherche d'¨¦tiquette. Valeurs possibles : 0 - (par d¨¦faut) Et/Ou ; 2 - Ou. |
| tags | object/array of objects | Renvoie uniquement les services avec des ¨¦³Ù¾±±ç³Ü±ð³Ù³Ù±ð²õ donn¨¦s. Correspondance exacte par ¨¦tiquette et recherche sensible ou insensible ¨¤ la casse par valeur d'¨¦tiquette en fonction de la valeur de l'op¨¦rateur. Format : [{"tag": "<¨¦tiquette>", "value": "<valeure>", "operator": "<op¨¦rateur>"}, ...].Un tableau vide renvoie tous les services. Valeurs d'op¨¦rateur possibles : 0 - (par d¨¦faut) Contient ; 1 - ?gal ¨¤ ; 2 - Ne contient pas ; 3 - N'est pas ¨¦gal ; 4 - Existe ; 5 - N'existe pas. |
| problem_tags | object/array of objects | Renvoie uniquement les services avec des ¨¦³Ù¾±±ç³Ü±ð³Ù³Ù±ð²õ de probl¨¨me donn¨¦s. Correspondance exacte par tag et recherche sensible ou insensible ¨¤ la casse par valeur d'¨¦tiquette en fonction de la valeur de l'op¨¦rateur. Format : [{"tag": "<¨¦tiquette>", "value": "<valeur>", "operator": "<op¨¦rateur>"}, ...].Un tableau vide renvoie tous les services. Valeurs d'op¨¦rateur possibles : 0 - (par d¨¦faut) Contient ; 1 - ?gal ¨¤ ; 2 - Ne contient pas ; 3 - N'est pas ¨¦gal ; 4 - Existe ; 5 - N'existe pas. |
| without_problem_tags | flag | Renvoie uniquement les services sans ¨¦tiquette de probl¨¨me. |
| slaids | string/array | Renvoie uniquement les services li¨¦s au(x) SLA sp¨¦cifique(s). |
| selectChildren | query | Renvoie une propri¨¦t¨¦ children avec les services enfants.Prend en charge count. |
| selectParents | query | Renvoie une propri¨¦t¨¦ parents avec les services parents.Prend en charge count. |
| selectTags | query | Renvoie une propri¨¦t¨¦ ¨¦³Ù¾±±ç³Ü±ð³Ù³Ù±ð²õ avec des ¨¦³Ù¾±±ç³Ü±ð³Ù³Ù±ð²õ de service. Prend en charge count. |
| selectProblemEvents | query | Renvoie une propri¨¦t¨¦ problem_events avec un tableau d'objets d'¨¦v¨¦nement de probl¨¨me.L'objet d'¨¦v¨¦nement de probl¨¨me a les propri¨¦t¨¦s suivantes : eventid - (string) ID d'¨¦v¨¦nement ;severity - (string) Gravit¨¦ de l'¨¦v¨¦nement actuel ;name - (string) Nom de l'¨¦v¨¦nement r¨¦solu.Prend en charge count. |
| selectProblemTags | query | Renvoie une propri¨¦t¨¦ problem_tags avec des ¨¦³Ù¾±±ç³Ü±ð³Ù³Ù±ð²õ de probl¨¨me. Prend en charge count. |
| selectStatusRules | query | Renvoie une propri¨¦t¨¦ status_rules avec des r¨¨gles de statut. Prend en charge count. |
| selectStatusTimeline | object/array of objects | Renvoie une propri¨¦t¨¦ status_timeline contenant les changements d'¨¦tat du service pour des p¨¦riodes donn¨¦es.Format [{"period_from": "<period_from>", "period_to": "<period_to>"}, ...] - period_from ¨¦tant une date de d¨¦but (inclusif ; horodatage entier) et period_to ¨¦tant une date de fin (exclusif ; horodatage entier) pour la p¨¦riode qui vous int¨¦resse.Retourne un tableau d'entr¨¦es contenant une propri¨¦t¨¦ start_value et un tableau alarms pour les changements d'¨¦tat dans des p¨¦riodes sp¨¦cifi¨¦es. |
| sortfield | string/array | Trie le r¨¦sultat selon les propri¨¦t¨¦s donn¨¦es. Les valeurs possibles sont : serviceid, name, status, sortorder et created_at. |
| countOutput | boolean | Ces param¨¨tres communs ¨¤ toutes les m¨¦thodes get sont d¨¦crits en d¨¦tail dans la page de commentaire de r¨¦f¨¦rence. |
| editable | boolean | |
| excludeSearch | boolean | |
| filter | object | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| search | object | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean |
Valeurs retourn¨¦es
(integer/array) Retourne soit :
- un tableau d'objets ;
- le nombre d'objets r¨¦cup¨¦r¨¦s, si le param¨¨tre
countOutputa ¨¦t¨¦ utilis¨¦.
Exemples
R¨¦cup¨¦ration de tous les services
R¨¦cup¨¦rez toutes les donn¨¦es sur tous les services et leurs d¨¦pendances.
Requ¨ºte :
{
"jsonrpc": "2.0",
"method": "service.get",
"params": {
"output": "extend",
"selectChildren": "extend",
"selectParents": "extend"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}R¨¦ponse :
{
"jsonrpc": "2.0",
"result": [
{
"serviceid": "1",
"name": "My Service - 0001",
"status": "-1",
"algorithm": "2",
"sortorder": "0",
"weight": "0",
"propagation_rule": "0",
"propagation_value": "0",
"description": "My Service Description 0001.",
"uuid": "dfa4daeaea754e3a95c04d6029182681",
"created_at": "946684800",
"readonly": false,
"parents": [],
"children": []
},
{
"serviceid": "2",
"name": "My Service - 0002",
"status": "-1",
"algorithm": "2",
"sortorder": "0",
"weight": "0",
"propagation_rule": "0",
"propagation_value": "0",
"description": "My Service Description 0002.",
"uuid": "20ea0d85212841219130abeaca28c065",
"created_at": "946684800",
"readonly": false,
"parents": [],
"children": []
}
],
"id": 1
}Source
CService::get() dans ui/include/classes/api/services/CService.php.