Skip to main content
Skip table of contents

Hierarchy Audit Logs API

Get Hierarchy Audit Logs

Retrieve audit logs for hierarchy-related activities including creation, updates, deletions, and applications.

Endpoint

GET /rest/smartissuetemplates/1.0/hierarchy/audit

Parameters

Parameter

Type

Required

Default

Description

hierarchyId

int

No

-

Filter by specific hierarchy ID

userKey

string

No

-

Filter by user who performed action

actionType

string

No

-

Filter by action type (CREATED, UPDATED, DELETED, APPLIED)

fromDate

string

No

-

Start date (ISO 8601 format)

toDate

string

No

-

End date (ISO 8601 format)

projectId

int

No

-

Filter by target project ID

limit

int

No

50

Maximum number of records to return

offset

int

No

0

Starting position for pagination

Request Example

CODE
curl -X GET \
  "https://your-jira-instance.com/rest/smartissuetemplates/1.0/hierarchy/audit?hierarchyId=456&actionType=APPLIED" \
  -H "Authorization: Basic <base64-credentials>" \
  -H "Accept: application/json"

Response

CODE
{
  "auditLogs": [
    {
      "id": 20001,
      "timestamp": "2024-01-20T13:30:00.000Z",
      "actionType": "HIERARCHY_APPLIED",
      "hierarchyId": 456,
      "hierarchyName": "Release Management Workflow",
      "user": {
        "userKey": "release.manager",
        "displayName": "Release Manager",
        "emailAddress": "release.manager@company.com"
      },
      "details": {
        "targetProject": {
          "projectId": 10001,
          "projectKey": "DEV",
          "projectName": "Development Project"
        },
        "createdIssues": [
          {
            "issueKey": "DEV-1001",
            "issueType": "Epic",
            "nodeId": "node1"
          },
          {
            "issueKey": "DEV-1002", 
            "issueType": "Story",
            "nodeId": "node2"
          }
        ],
        "variablesUsed": {
          "releaseVersion": "2.1.0",
          "targetDate": "2024-03-15"
        }
      },
      "performance": {
        "executionTime": 8500,
        "issuesCreated": 5,
        "linksCreated": 4
      }
    }
  ],
  "totalCount": 89,
  "startAt": 0,
  "maxResults": 50
}

Action Types

  • HIERARCHY_CREATED - Hierarchy creation

  • HIERARCHY_UPDATED - Hierarchy modification

  • HIERARCHY_DELETED - Hierarchy deletion

  • HIERARCHY_APPLIED - Hierarchy applied to create issue structure

  • HIERARCHY_VALIDATED - Hierarchy validation performed

  • HIERARCHY_NODE_ADDED - Node added to hierarchy

  • HIERARCHY_NODE_REMOVED - Node removed from hierarchy

Usage Examples

Get all applications for a specific hierarchy:

CODE
GET /rest/smartissuetemplates/1.0/hierarchy/audit?hierarchyId=456&actionType=HIERARCHY_APPLIED

Get hierarchy modifications in a date range:

CODE
GET /rest/smartissuetemplates/1.0/hierarchy/audit?actionType=HIERARCHY_UPDATED&fromDate=2024-01-01T00:00:00.000Z&toDate=2024-01-31T23:59:59.000Z

Get all hierarchy activities for a project:

CODE
GET /rest/smartissuetemplates/1.0/hierarchy/audit?projectId=10001&limit=100
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.