inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-05-12 17:04:57 +00:00
Code Issues Packages Projects Releases Wiki Activity
alfresco-ng2-components/docs/content-services/services/audit.service.md
Ardit Domi 657e5ef7fd
Generate docs (#8481) 
* Generate docs

* Fix duplicated Optional and restore code block ticks

* Fix docbuild command errors, improve documentations

---------

Co-authored-by: Amedeo Lepore <amedeo.lepore85@gmail.com>
Co-authored-by: Amedeo Lepore <amedeo.lepore@hyland.com>
2023-04-18 15:28:07 +02:00

3.9 KiB
Raw Permalink Blame History

Title, Added, Status, Last reviewed
Title Added Status Last reviewed
Audit Service v3.9.0 Active 2020-08-12

Audit Service

Manages Audit apps and entries.

Class members

Methods

  • deleteAuditEntries(auditApplicationId: string, where: string): Observable<any>
    Permanently delete audit entries for an audit application.
    • auditApplicationId: string - The identifier of an audit application.
    • where: string - Audit entries to permanently delete for an audit application, given an inclusive time period or range of ids.
    • Returns Observable<any> -
  • deleteAuditEntry(auditApplicationId: string, auditEntryId: string): Observable<any>
    Permanently delete an audit entry.
    • auditApplicationId: string - The identifier of an audit application.
    • auditEntryId: string - The identifier of an audit entry.
    • Returns Observable<any> -
  • getAuditApp(auditApplicationId: string, opts?: any): Observable<AuditAppEntry>
    Get audit application info.
    • auditApplicationId: string - The identifier of an audit application.
    • opts: any - (Optional) Options.
    • Returns Observable<AuditAppEntry> - status of an audit application.
  • getAuditApps(opts?: any): Observable<AuditAppPaging>
    Gets a list of audit applications.
    • opts: any - (Optional) Options.
    • Returns Observable<AuditAppPaging> - a list of the audit applications.
  • getAuditEntries(auditApplicationId: string, opts?: any): Observable<AuditEntryPaging>
    List audit entries for an audit application.
    • auditApplicationId: string - The identifier of an audit application.
    • opts: any - (Optional) Options.
    • Returns Observable<AuditEntryPaging> - a list of audit entries.
  • getAuditEntriesForNode(nodeId: string, opts?: any): Observable<AuditEntryPaging>
    List audit entries for a node.
    • nodeId: string - The identifier of a node.
    • opts: any - (Optional) Options.
    • Returns Observable<AuditEntryPaging> -
  • getAuditEntry(auditApplicationId: string, auditEntryId: string, opts?: any): Observable<AuditEntryEntry>
    Get audit entry.
    • auditApplicationId: string - The identifier of an audit application.
    • auditEntryId: string - The identifier of an audit entry.
    • opts: any - (Optional) Options.
    • Returns Observable<AuditEntryEntry> - audit entry.
  • updateAuditApp(auditApplicationId: string, auditAppBodyUpdate: boolean, opts?: any): Observable<AuditApp|any>
    Update audit application info.
    • auditApplicationId: string - The identifier of an audit application.
    • auditAppBodyUpdate: boolean - The audit application to update.
    • opts: any - (Optional) Options.
    • Returns Observable<AuditApp|any> -