How-to read the Metadata Audit Logs

Owned by Andreas Spall (evolu.software)
Last updated: Apr 09, 2020
2 min read

This documentation applies to Metadata for Jira version 4.6.0 and higher

Every Metadata change (add/edit/delete) will be recorded using the audit log of Jira.

Each entry will have the following structure:

summary

One of the following:

  • Metadata has been created : METADATA_KEY

  • Metadata has been updated : METADATA_KEY

  • Metadata has been deleted : METADATA_KEY

category

One of the following:

  • projects (for projects, components and versions)

  • user management (for user)

  • group management (for groups)

objectItem

With the following entries:

  • id: the technical id of the element

  • name : e.g. Sample Project, Component, Version 1.2, admin, jira-administrators

  • typeName : PROJECT, PROJECT_COMPONENT, VERSION, USER, GROUP

changedValues

With the following entries:

  • Key

    • fieldName: Key

    • changedFrom

      • on create : empty

      • on update : the changed key

      • on delete : the deleted key

    • changedTo

      • on create : the new key

      • on update : the changed key

      • on delete : empty

  • Value

    • fieldName: Value

    • changedFrom

      • on create : empty

      • on update : the changed value

      • on delete : the deleted value

    • changedTo

      • on create : the new value

      • on update : the changed value

      • on delete : empty

  • Group

    • fieldName: Group

    • changedFrom

      • on create : empty

      • on update : the changed group

      • on delete : the deleted group

    • changedTo

      • on create : the new group

      • on update : the changed group

      • on delete : empty

  • Hidden

    • fieldName: hidden

    • changedFrom

      • on create : empty

      • on update : the changed hidden boolean

      • on delete : the deleted hidden boolean

    • changedTo

      • on create : the new hidden boolean

      • on update : the changed hidden boolean

      • on delete : empty

In Jira's audit logs, you will see a deleted metadata as follows (Further details about Jira’s audit logs: https://confluence.atlassian.com/doc/audit-log-829076528.html).

 

The Rest-interface returns the following Json (Further information can be found here https://docs.atlassian.com/software/jira/docs/api/REST/latest/#api/2/auditing-getRecords)