.NET SDK — Client Reference: AuditClient¶

Overview

This page documents the thin-wrapper methods exposed via Context.AuditClient and the AuditViewModel used in responses.

• Methods:
  • GetAsync: retrieve a single audit record by Id.
  • GetAllAsync: search audit records by criteria.
• Models:
  • AuditViewModel (shape of audit records)
  • Enums: AuditEntity, AuditAccessType

Prerequisites¶

• .NET 6+ and SDK installed:

  dotnet add package AIForged.SDK
  

• Environment variables:

  • AIFORGED_BASE_URL = https://portal.aiforged.com
  • AIFORGED_API_KEY = Not provided

• Initialize the SDK context (API key auth).

  using AIForged.API;
  
  var baseUrl = Environment.GetEnvironmentVariable("AIFORGED_BASE_URL") ?? "https://portal.aiforged.com";
  var apiKey  = Environment.GetEnvironmentVariable("AIFORGED_API_KEY")  ?? throw new Exception("AIFORGED_API_KEY not set.");
  
  var cfg = new Config { BaseUrl = baseUrl, Timeout = TimeSpan.FromMinutes(5) };
  await cfg.Init();
  cfg.HttpClient.DefaultRequestHeaders.Add("X-Api-Key", apiKey);
  
  var ctx = new Context(cfg);
  
  // Access the Audit client from the context
  var auditClient = ctx.AuditClient;
  

Methods¶

GetAsync¶

Get a single audit record by Id.

• Signatures:

  System.Threading.Tasks.Task<PortalResponse<AuditViewModel>> GetAsync(int? id);
  System.Threading.Tasks.Task<PortalResponse<AuditViewModel>> GetAsync(int? id, System.Threading.CancellationToken cancellationToken);
  

• Parameters:
  • id: Log record id (int?).
• Returns:
  • PortalResponse<AuditViewModel> with the record in Result.

• Errors:

  • SwaggerException indicates a server-side error.
  • AIForged returns HTTP 404 for not found records.

• Retrieve an audit record.

  using AIForged.API;
  using System;
  using System.Threading;
  using System.Threading.Tasks;
  
  int id = 123;
  
  try
  {
      var resp = await ctx.AuditClient.GetAsync(id);
      var item = resp.Result; // AuditViewModel
  
      Console.WriteLine($"Id={item.Id}, Entity={item.Entity}, Access={item.Access}, DT(UTC)={item.DT:u}");
      Console.WriteLine($"Local time: {item.DT.ToLocalTime():u}");
  }
  catch (SwaggerException ex) when (ex.StatusCode == 404)
  {
      Console.WriteLine("Audit record not found.");
  }
  

• With cancellation.

  using System.Threading;
  
  using var cts = new CancellationTokenSource(TimeSpan.FromSeconds(30));
  
  try
  {
      var resp = await ctx.AuditClient.GetAsync(id, cts.Token);
      var item = resp.Result;
      Console.WriteLine($"Id={item.Id}, Entity={item.Entity}, Access={item.Access}");
  }
  catch (SwaggerException ex) when (ex.StatusCode == 404)
  {
      Console.WriteLine("Audit record not found.");
  }
  

GetAllAsync¶

Search audit records by criteria.

• Signatures:

  System.Threading.Tasks.Task<PortalResponse<System.Collections.ObjectModel.ObservableCollection<AuditViewModel>>> GetAllAsync(
      string userId,
      int? groupId,
      AuditEntity? entity,
      AuditAccessType? access,
      int? entityId,
      System.DateTime? from,
      System.DateTime? to
  );
  
  System.Threading.Tasks.Task<PortalResponse<System.Collections.ObjectModel.ObservableCollection<AuditViewModel>>> GetAllAsync(
      string userId,
      int? groupId,
      AuditEntity? entity,
      AuditAccessType? access,
      int? entityId,
      System.DateTime? from,
      System.DateTime? to,
      System.Threading.CancellationToken cancellationToken
  );
  

• Parameters:
  • userId: User id (string).
  • groupId: Group id (int?).
  • entity: Entity type (AuditEntity?).
  • access: Access type (AuditAccessType?).
  • entityId: Entity id (int?).
  • from: From date (DateTime?, UTC).
  • to: To date (DateTime?, UTC).
• Returns:
  • PortalResponse<ObservableCollection<AuditViewModel>> with records in Result.

• Errors:

  • SwaggerException for server-side errors.

• Filter by entity and UTC date range.

  using AIForged.API;
  using System;
  using System.Linq;
  
  var fromUtc = new DateTime(2025, 1, 1, 0, 0, 0, DateTimeKind.Utc);
  var toUtc   = new DateTime(2025, 12, 31, 23, 59, 59, DateTimeKind.Utc);
  
  var resp = await ctx.AuditClient.GetAllAsync(
      userId: null,
      groupId: null,
      entity: AuditEntity.Document,
      access: null,
      entityId: null,
      from: fromUtc,
      to: toUtc
  );
  
  var audits = resp.Result ?? new System.Collections.ObjectModel.ObservableCollection<AuditViewModel>();
  foreach (var a in audits)
  {
      Console.WriteLine($"{a.DT:u} [{a.Entity}/{a.Access}] KeyId={a.KeyId} Field={a.Field} Value={a.Value}");
  }
  

• Filter by user and access type (with cancellation).

  using System;
  using System.Threading;
  
  using var cts = new CancellationTokenSource(TimeSpan.FromSeconds(30));
  
  var resp = await ctx.AuditClient.GetAllAsync(
      userId: "user-123",
      groupId: null,
      entity: null,
      access: AuditAccessType.Update,
      entityId: null,
      from: null,
      to: null,
      cancellationToken: cts.Token
  );
  
  var audits = resp.Result;
  Console.WriteLine($"Found {audits?.Count ?? 0} update records for user-123.");
  

Examples¶

Retrieve and inspect related context¶

var resp = await ctx.AuditClient.GetAsync(555);
var a = resp.Result;

Console.WriteLine($"{a.DT:u} {a.UserName} {a.Entity}/{a.Access} key={a.KeyId}");
if (a.Document != null)
    Console.WriteLine($"Doc #{a.Document.Id} -> {a.Document.Filename}");
if (a.Verification != null)
    Console.WriteLine($"Verification #{a.Verification.Id} value={a.Verification.Value}");

Search audits for document activity in the past 7 days (UTC)¶

var toUtc = DateTime.UtcNow;
var fromUtc = toUtc.AddDays(-7);

var resp = await ctx.AuditClient.GetAllAsync(
    userId: null,
    groupId: null,
    entity: AuditEntity.Document,
    access: null,
    entityId: null,
    from: fromUtc,
    to: toUtc
);

var items = resp.Result ?? new System.Collections.ObjectModel.ObservableCollection<AuditViewModel>();
Console.WriteLine($"Found {items.Count} audit records in last 7 days (UTC window).");

sequenceDiagram
    participant "App" as "Your App"
    participant "SDK" as "Context"
    participant "API" as "AIForged API"

    "App"->>"SDK": "ctx.AuditClient.GetAsync(id)"
    "SDK"->>"API": "GetAsync(id)"
    "API"-->>"SDK": "PortalResponse"
    "SDK"-->>"App": "Result"

    "App"->>"SDK": "ctx.AuditClient.GetAllAsync(filters)"
    "SDK"->>"API": "GetAllAsync(userId, groupId, entity, access, entityId, from, to)"
    "API"-->>"SDK": "PortalResponse>"
    "SDK"-->>"App": "Result"

Model: AuditViewModel¶

Represents an audit record.

Console.WriteLine($"Local: {audit.DT.ToLocalTime():u}");

Enums¶

AuditEntity¶

• Project = 0
• Service = 1
• Document = 2
• Work = 3
• Contact = 4
• Notification = 5
• Payment = 6
• Verification = 7
• DataSet = 8
• Reports = 9
• Group = 10
• ParamDef = 11
• Parameter = 12
• Audit = 13
• Account = 14
• Role = 15
• Bundle = 16
• Classes = 17
• UserSettings = 18
• Credit = 19
• ProjectUser = 20
• GroupRole = 21
• GroupRoleUser = 22

AuditAccessType¶

• Create = 0
• Read = 1
• Update = 2
• Delete = 3
• Move = 4
• Copy = 5
• Clone = 6
• Elevate = 7
• Work = 8
• Init = 9
• Train = 10
• Process = 11
• UnDelete = 12
• Define = 13
• Verify = 14
• Link = 15
• Expire = 16
• Compile = 17
• Approve = 18
• Archive = 19

Error handling¶

• All methods may throw SwaggerException. Inspect StatusCode and Response for diagnostics; apply retries per your policy if appropriate.

try
{
    var resp = await ctx.AuditClient.GetAllAsync(
        userId: null,
        groupId: null,
        entity: AuditEntity.Document,
        access: null,
        entityId: null,
        from: DateTime.UtcNow.AddDays(-7),
        to: DateTime.UtcNow
    );
    var items = resp.Result;
}
catch (SwaggerException ex)
{
    if (ex.StatusCode == 404)
    {
        Console.Error.WriteLine("No audit records found for the given criteria.");
    }
    else
    {
        Console.Error.WriteLine($"API error {ex.StatusCode}");
        Console.Error.WriteLine(ex.Response);
    }
}

Troubleshooting¶

• No results:
  • Verify filter parameters (userId, entity, access, entityId).
  • Ensure from/to are UTC and the time window is correct.
• 404 on GetAsync:
  • The audit record does not exist; confirm the Id and scope.
• Server errors (4xx/5xx):
  • Log StatusCode and Response; retry on transient statuses per your policy.