cmdb.objets#
Travail en cours
cmdb.objets.lire#
Récupère une liste d'objets
Paramètres de la requête#
| Clé | Type de données JSON | Requis | Description |
|---|---|---|---|
| catégories | Tableau | Non | Ici, vous pouvez filtrer par une liste ou une catégorie, sous la forme de constantes de catégorie. "catégories": ["C__CATG__MA_CATÉGORIE_PERSONNALISÉE"] "catégories": ["C__CATG__MA_CATÉGORIE_PERSONNALISÉE", "C__CATG__MA_DEUXIÈME_CATÉGORIE"] |
| filtre | Tableau | Non | Liste de filtres d'objets; voir ci-dessous pour une liste complète des options |
| limite | Mixte | Non | Nombre maximum d'objets (en tant qu'entier), par exemple, récupérer les mille premiers objets: 1000 Combinez cette limite avec un décalage (en tant que chaîne), par exemple, récupérer les mille objets suivants: "1000,1000" |
| tri_par | Chaîne | Non | Ordonne l'ensemble de résultats par (voir filtre pour plus de détails sur la signification de chaque valeur): - "email", - "prénom", - "id", - "nom", - "sysid", - "type", - "titre", - **"type_titre" |
| tri | Chaîne | Non | Utile uniquement en combinaison avec la clé tri_par; les valeurs autorisées sont soit "ASC" (croissant) ou "DESC" (décroissant) |
Filtre#
| Clé | Type de données JSON | Requis | Description |
|---|---|---|---|
| ids | Tableau | Non | Liste des identifiants d'objets (en tant qu'entiers), par exemple : [1, 2, 3] |
| type | Tableau | Non | Identifiant de type d'objet (en tant qu'entier), par exemple : 5 Alternativement, constante de type d'objet (en tant que chaîne), par exemple : "C__OBJTYPE__SERVEUR" |
| title | Chaîne | Non | Titre de l'objet (voir attribut Titre dans la catégorie Global), par exemple : "Mon petit serveur" |
| type_title | Chaîne | Non | Nom traduit du type d'objet, par exemple : "Serveur" Remarque : Définissez une langue appropriée dans votre demande. |
| sysid | Chaîne | Non | SYSID (voir catégorie Global), par exemple : "SRV_101010" |
| first_name | Chaîne | Non | Prénom d'un objet de type Personnes (voir attribut Prénom dans la catégorie Personnes → Données maîtres), par exemple : "John" |
| last_name | Chaîne | Non | Nom de famille d'un objet de type Personnes (voir attribut Nom de famille dans la catégorie Personnes → Données maîtres), par exemple : "Doe" |
| Chaîne | Non | Adresse e-mail principale d'un objet de type Personnes, Groupes de personnes ou Organisation (voir attribut Adresse e-mail dans les catégories Personnes/Groupes de personnes/Organisation → Données maîtres), par exemple : "john.doe@example.com" | |
| type_group | Chaîne | Non | Filtre par le groupe de type d'objet par exemple Infrastructure ou Autre : "C__OBJTYPE_GROUP__INFRASTRUCTURE" |
| status | Chaîne | Non | Filtrer par statut des objets par exemple Normal ou Archivé : - C__RECORD_STATUS__BIRTH = Non terminé - C__RECORD_STATUS__NORMAL = Normal - C__RECORD_STATUS__ARCHIVED = Archivé - C__RECORD_STATUS__DELETED = Supprimé - C__RECORD_STATUS__TEMPLATE = Modèle - C__RECORD_STATUS__MASS_CHANGES_TEMPLATE = Modèle pour les changements massifs |
Vous pouvez utiliser n'importe quelle combinaison de filtres. Les filtres sont logiquement associés avec un ET. Une combinaison valide pourrait être : "Donnez-moi tous les serveurs qui ont le même nom d'hôte."
Paramètres de réponse#
La clé JSON result contient un tableau d'objets JSON. Chaque objet contient un tas d'informations sur un objet i-doit.
| Clé | Type de données JSON | Description |
|---|---|---|
| id | Chaîne de caractères | Identifiant de l'objet (sous forme de chaîne numérique) |
| title | Chaîne de caractères | Titre de l'objet |
| sysid | Chaîne de caractères | SYSID (voir la catégorie Global) |
| type | Chaîne de caractères | Identifiant du type d'objet (sous forme de chaîne numérique) |
| created | Chaîne de caractères | Date de création ; format : Y-m-d H:i:s |
| updated | Chaîne de caractères | Date de la dernière mise à jour ; format : Y-m-d H:i:s Note : Cette clé est facultative car tous les objets n'ont pas été mis à jour auparavant. |
| type_title | Chaîne de caractères | Nom traduit du type d'objet |
| type_group_title | Chaîne de caractères | Nom traduit du groupe de type d'objet |
| status | Chaîne de caractères | Statut de l'objet : C__RECORD_STATUS__BIRTH ID du statut = 1 Titre =Non terminé C__RECORD_STATUS__NORMAL ID du statut = 2 Titre = Normal C__RECORD_STATUS__ARCHIVED ID du statut = 3 Titre = Archivé C__RECORD_STATUS__DELETED ID du statut = 4 Titre = Supprimé C__RECORD_STATUS__TEMPLATE ID du statut = 6 Titre = Modèle C__RECORD_STATUS__MASS_CHANGES_TEMPLATE ID du statut = 7 Titre = Modèle de changement massif |
| cmdb_status | Chaîne de caractères | Statut CMDB (voir la catégorie Global ; sous forme de chaîne numérique) |
| cmdb_status_title | Chaîne de caractères | Statut CMDB traduit (voir la catégorie Global) |
| image | Chaîne de caractères | URL vers l'image de l'objet |
| categories | Mixte | Attributs optionnels avec des valeurs dépendant de la catégorie demandée |
Exemple#
1 | |
1 | |