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.

Paramètres

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

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

Paramètre	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 étiquettes 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 étiquettes 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é étiquettes avec des étiquettes 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 étiquettes 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 countOutput a é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.

Documentation