Audit Object

Applies to QAComplete 12.84 SaaS, last modified on July 19, 2021

QAComplete keeps the history of all changes made to defects, releases, and other items. It automatically records a history entry (we call it an audit) each time a user adds, deletes, or updates an item, adds notes and attachments to an item, and so on.

An Audit object represents an entry in an item’s version history. Using the API, you can get the version history of an item, and add audits manually if needed.

Properties

FKId  :  integer

The ID of the item that was changed. For example, BugID of a defect, Id of a release, and so on.

EntityCode  :  string (max 100 chars)

The type of the item that was changed. Possible values:

  • Bugs (defects)
  • Contacts
  • FileExchanges (shared documents)
  • FunctionalSpecs (requirements)
  • ProjectPlans
  • ProjectPlanTasks
  • ProjectTasks (agile tasks)
  • Releases
  • TestCases (legacy test cases used in release 9.6.0 and earlier)
  • TestConfigurations
  • Tests
  • TestSets

Title  :  string (max 100 chars)

The description of the changes. For example, Updated Status or Added File Attachment.

XML entities in this value are double encoded:

& – &

< – &amp;#60;

> – &amp;#62;

OldValue  :  string (max 1000 chars)

The previous value that was changed. Default value: N/A.

NewValue  :  string (max 1000 chars)

A new value. Default value: N/A.

DateCreated  :  dateTime

The date and time when the audit was created.

Description  :  string

Reserved. Always an empty string.

ProjId  :  integer

The ID of the QAComplete project that contains the changed item.

UpdateUserId  :  integer

The ID of the user who made the change.

UserName  :  string (max 78 chars)

The name of the user who made the change (in the LastName, FirstName format).

Relevant Operations

Example

XML

<Audit>
  <FKId>13254</FKId>
  <EntityCode>Defects</EntityCode>
  <Title>Updated Status</Title>
  <OldValue>Active</OldValue>
  <NewValue>Resolved</NewValue>
  <DateCreated>2014-07-25T01:28:18.53</DateCreated>
  <ProjId>10372</ProjId>
  <UpdateUserId>27568</UpdateUserId>
  <UserName>McLaren, Susan</UserName>
</Audit>

See Also

Audits_Add Operation
Audits_LoadElevated Operation
Audit Operations

Highlight search results