Aller au contenu

Rapports de maintenance

10 routes. Chemins relatifs à https://api.nexus-engine.eu/api/v1.

GET /report-schedules

Les abonnements aux rapports : cadence, destinataires, blocs, prochain envoi.

RequêteclientId (facultatif)
RéponseReportScheduleDto[]
POST /report-schedules Owner et Admin

Abonne un client à un rapport périodique.

CorpsclientId, label, enabled, period (DAILY, WEEKLY, MONTHLY, QUARTERLY), anchorDay (1–7 en hebdomadaire, 1–28 sinon), hourLocal, timezone (nom IANA, ex. Europe/Paris), to, cc, bcc, copyToOwner, replyTo, showAvailability, showBackups, showServer, showWork, showUpdates, showTickets, intro, siteIds (vide = tous les sites du client)
RéponseReportScheduleDto
NoteSans « to », l’adresse de la fiche client sert de destinataire. La copie à l’agence part en copie CACHÉE : un « cc » afficherait l’adresse interne du prestataire chez son client. « timezone » doit être un nom IANA connu du moteur (« Paris » est refusé, « Europe/Paris » accepté) ; « showTickets » ajoute le chapitre des demandes du client.
PATCH /report-schedules/:id Owner et Admin

Modifie un abonnement : cadence, destinataires, contenu.

Corpsmêmes champs qu’à la création, tous facultatifs (sauf clientId, qui ne change pas)
RéponseReportScheduleDto
DELETE /report-schedules/:id Owner et Admin

Supprime un abonnement. Les rapports déjà rendus restent consultables.

GET /reports

Les rapports rendus, les plus récents d’abord.

RequêteclientId (facultatif), limit (≤ 50, défaut 20)
RéponseMaintenanceReportDto[]
POST /reports Owner et Admin

Rend un rapport à la demande, sans l’envoyer.

CorpsclientId, scheduleId, period, periodStart et periodEnd (ISO 8601), siteIds, intro, showAvailability, showBackups, showServer, showWork, showUpdates
RéponseMaintenanceReportDetailDto
NoteSans dates, la dernière période CLOSE de la cadence demandée — le même choix que le planificateur. Le rapport est figé à sa génération et ne se recalcule jamais.
GET /reports/:id

Un rapport : ses chiffres figés, sa page rendue, ses destinataires.

RéponseMaintenanceReportDetailDto
POST /reports/:id/send Owner et Admin

Envoie ou renvoie un rapport à ses destinataires.

Corpsapercu (envoi à soi seul, ne marque rien), to, cc, bcc
Réponse{ envoye, destinataires }
DELETE /reports/:id Owner et Admin

Supprime un rapport et rend son adresse publique injoignable.

GET /rapport/:token sans authentification

La page d’un rapport, consultable sans compte. Rend du HTML, pas du JSON.

NoteLe client d’une agence n’a pas de compte Nexus : il ouvre le rapport depuis son courriel. Le jeton de 32 octets tiré au sort est la seule protection de ce document nominatif.