Actif store functional Revu le 2026-06-23 store/bi-hardware.md

BI — Export du matériel

Cette route BI permet de récupérer, pour une entité, la liste de son parc — le matériel (postes, serveurs, imprimantes, équipements réseau…) et les machines virtuelles (VM) — en vue d'une exploitation dans un outil décisionnel (Power BI, etc.).

À quoi ça sert

Alimenter un tableau de bord avec l'inventaire du parc d'une entité, avec la possibilité de choisir les types de matériel souhaités ou de tout récupérer.

Matériel et VM sont retournés dans une seule liste (comme ils sont traités côté utilisateur), chaque ligne indiquant son origine via le champ tpsource : hw (matériel) ou vm (machine virtuelle).

Accès

Route : GET bi/v1/hardware
Authentification : clé d'API BI (en-têtes X-API-key + X-ENTITY-ID), comme les autres routes BI.
La route doit être activée pour l'entité depuis l'administration des routes BI (sinon : « Route invalide »).

Choisir les types de matériel

Paramètre tphard (optionnel) :

Usage	Exemple	Résultat
Tout le matériel	`bi/v1/hardware` ou `bi/v1/hardware?tphard=all`	L'ensemble du parc de l'entité
Un type précis	`bi/v1/hardware?tphard=FIX`	Uniquement les postes fixes
Plusieurs types	`bi/v1/hardware?tphard=FIX,POR,SER`	Postes fixes, portables et serveurs

Quelques codes de type courants : FIX (fixe), POR (portable), LIG (client léger), SER (serveur), SMA (smartphone), TAB (tablette), IMP (imprimante/copieur), SWI/ROU/WIF (réseau), IMP, SCR (écran/TV), OND (onduleur)…

Un code inconnu renvoie une erreur (400) listant les codes valides.

ℹ️ Le paramètre tphard ne filtre que le matériel. Les VM sont toujours présentes dans le résultat, quel que soit le filtre de type (leurs types — VMWARE, HYPERV… — relèvent d'un autre vocabulaire). Pour ne traiter que le matériel ou que les VM, filtrez sur le champ tpsource dans votre outil décisionnel.

Filtrer par date (optionnel)

Les paramètres startDate et endDate restreignent le résultat à la date de référence de chaque élément : la date d'achat (dtbuy) pour le matériel et la date de mise en production (dtprod) pour les VM. Format : AAAA-MM-JJ.

Exemple : bi/v1/hardware?tphard=all&startDate=2023-01-01&endDate=2023-12-31

Données renvoyées

Le parc actif de l'entité — matériel + VM (les éléments supprimés sont exclus) — au format JSON. Pour une entité mère, le périmètre couvre l'ensemble de ses entités filles.

Les VM sont alignées sur les colonnes du matériel (par ex. leur type apparaît dans tphard, leur identifiant dans idhw, leur date de mise en production dans dtbuy) afin que l'outil décisionnel traite tout le parc de façon homogène. Le champ tpsource permet de distinguer matériel (hw) et VM (vm).

Documentation technique

Voir .claude/technical-docs/store/bi-hardware.md.