Ugrás a fő tartalomhoz
Was this helpful?

Személyes naplók API

Személyes naplók és ellenőrzési előzmények

A felhasználó által látható ellenőrzési nyomvonal lekérdezése az adminisztrátori végpontok érintése nélkül

A PrimeCal személyes ellenőrzési felületet tesz elérhetővé a bejelentkezett felhasználó számára. Ezek a végpontok biztosítják mind a szűrhető esemény hírcsatorna és egy összesített összefoglaló.

JWT vagy felhasználói API kulcsSzűrhető ellenőrzési hírcsatornaÖsszefoglaló nézet

Forrás

  • Vezérlő: backend-nestjs/src/users/users.controller.ts
  • DTO: backend-nestjs/src/users/dto/personal-audit.query.dto.ts

Hitelesítés és engedélyek

  • Mindkét útvonal hitelesítést igényel.
  • Az eredmények az aktuális felhasználóra vonatkoznak.
  • Ez az oldal szándékosan zárja ki az adminisztrátori vagy többfelhasználós audit API-kat.

Végpont referencia

módszerÚtvonalCélKérjen vagy érdeklődjönAuthForrás
GET/api/users/me/auditSorolja fel a személyes ellenőrzési hírfolyamot.Lekérdezés: categories,outcomes,severities,actions,search,from,to,limit,offset,includeAutomationJWT vagy felhasználói API kulcsusers/users.controller.ts
GET/api/users/me/audit/summaryNyújtsa vissza az összesített ellenőrzési összefoglalót.Lekérdezés: ugyanaz, mint a hírcsatorna végpontjaJWT vagy felhasználói API kulcsusers/users.controller.ts

Alakzat lekérdezése

PersonalAuditQueryDto

  • categories: opcionális karakterlánc tömb, vesszővel elválasztott értékek támogatottak
  • outcomes: opcionális karakterlánc tömb, vesszővel elválasztott értékek támogatottak
  • severities: opcionális karakterlánc tömb, vesszővel elválasztott értékek támogatottak
  • actions: opcionális karakterlánc tömb, vesszővel elválasztott értékek támogatottak
  • search: opcionális karakterlánc
  • from: opcionális karakterlánc
  • to: opcionális karakterlánc
  • limit: opcionális int 1..500
  • offset: opcionális int >= 0
  • includeAutomation: opcionális logikai érték, alapértelmezett true

Példahívások

Olvassa el a legutóbbi ellenőrzési eseményeket

curl "$PRIMECAL_API/api/users/me/audit?includeAutomation=true&actions=automation.rule.execute&limit=20" \
-H "Authorization: Bearer $TOKEN"

Olvassa el a dátumtartomány összefoglalóját

curl "$PRIMECAL_API/api/users/me/audit/summary?from=2026-03-22T00:00:00.000Z&to=2026-03-29T23:59:59.999Z" \
-H "Authorization: Bearer $TOKEN"

Válasz és viselkedés megjegyzések

  • Az összefoglaló végpont belsőleg újra felhasználja a feed szolgáltatást, és csak a summary értéket adja vissza.
  • A includeAutomation=true az a kapcsoló, amely automatizálásból származó rekordokat von be az eredménykészletbe.
  • A tömbszerű szűrők vesszővel elválasztott lekérdezési karakterláncokat vagy ismétlődő értékeket fogadnak el.

Legjobb gyakorlatok

  • Használja a feed útvonalat a részletes idővonal felhasználói felületekhez, az összefoglaló útvonalat pedig diagramokhoz vagy KPI-kártyákhoz.
  • Tartsa a limit értéket ésszerűen kicsiben az interaktív nézetekhez, és lapozzon a feedben a offset segítségével.
  • Párosítsa ezeket az adatokat a Compliance API adatvédelmi központtal, így a felhasználók láthatják az előzményeket és a vezérlőket is.