Get annotations for audits - Metasys - LIT-12013522 - Software Application - Basic Services client library for .NET (and COM) - Metasys API - 4.2

Metasys REST Client for .NET and COM Developer Guide

Brand
Metasys
Product name
Basic Services client library for .NET (and COM)
Metasys API
Document type
API Reference Guide
Document number
LIT-12013522
Version
4.2
Revision date
2021-04-07
Language
English (United States)

To get the annotations of an audit, use the GetAnnotations method. GetAnnotations takes the GUID of the audit and returns a collection of AuditAnnotation objects.

Table 1. Get annotations for an object .NET signature
Library method name GetAnnotations
Description Get annotations for a single object
Method signature AuditAnnotation GetAnnotations(Guid auditId)
Method input parameters auditId: GUID of the audit object.
Return value A list of AuditAnnotation.
The following .NET C# code is an example of a get annotations for an object call:
IEnumerable<AuditAnnotation> annotations = client.Audits.GetAnnotations(audit.Id);
AuditAnnotation firstAnnotation = annotations.FirstOrDefault();
Console.WriteLine(firstAnnotation);
/*
  {
    "auditUrl": "https://win-ervotujej94/api/v2/audits/40aff6ec-ecb2-4b65-a504-0ac659756956",
    "creationTime": "2020-06-05T15:58:40.407Z",
    "user": "MetasysSysAgent",
    "text": "TEST AUDIT ANNOTATION 02",
    "signature": null,
    "action": "none"
  } 
*/