Scope Audit Logs API

Scope Audit Logs API

Get Scope Audit Logs

Retrieve audit logs for scope-related activities including creation, updates, deletions, and template/hierarchy assignments.

Endpoint

GET /rest/smartissuetemplates/1.0/scope/audit

Parameters

Parameter

Type

Required

Default

Description

Parameter

Type

Required

Default

Description

scopeId

int

No

-

Filter by specific scope ID

userKey

string

No

-

Filter by user who performed action

actionType

string

No

-

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

fromDate

string

No

-

Start date (ISO 8601 format)

toDate

string

No

-

End date (ISO 8601 format)

limit

int

No

50

Maximum number of records to return

offset

int

No

0

Starting position for pagination

Request Example

curl -X GET \ "https://your-jira-instance.com/rest/smartissuetemplates/1.0/scope/audit?scopeId=101&actionType=TEMPLATE_ASSIGNED" \ -H "Authorization: Basic <base64-credentials>" \ -H "Accept: application/json"

Response

{ "auditLogs": [ { "id": 30001, "timestamp": "2024-01-20T15:45:00.000Z", "actionType": "TEMPLATE_ASSIGNED", "scopeId": 101, "scopeName": "Development Team Scope", "user": { "userKey": "scope.admin", "displayName": "Scope Administrator", "emailAddress": "scope.admin@company.com" }, "details": { "templateIds": [201, 202, 203], "templateCount": 3, "action": "add", "templateNames": [ "Bug Report Template", "Feature Request Template", "Task Template" ] }, "relatedEntities": [ { "type": "TEMPLATE", "id": 201, "name": "Bug Report Template" }, { "type": "TEMPLATE", "id": 202, "name": "Feature Request Template" } ] } ], "totalCount": 45, "startAt": 0, "maxResults": 50 }

Action Types

  • SCOPE_CREATED - Scope creation

  • SCOPE_UPDATED - Scope modification

  • SCOPE_DELETED - Scope deletion

  • TEMPLATE_ASSIGNED - Template assigned to scope

  • TEMPLATE_UNASSIGNED - Template removed from scope

  • HIERARCHY_ASSIGNED - Hierarchy assigned to scope

  • HIERARCHY_UNASSIGNED - Hierarchy removed from scope

  • SCOPE_PERMISSIONS_CHANGED - Scope permissions modified

Usage Examples

Get all template assignments for a scope:

GET /rest/smartissuetemplates/1.0/scope/audit?scopeId=101&actionType=TEMPLATE_ASSIGNED

Get recent scope activity:

GET /rest/smartissuetemplates/1.0/scope/audit?fromDate=2024-01-15T00:00:00.000Z&limit=20

Get scope modifications by specific user:

GET /rest/smartissuetemplates/1.0/scope/audit?userKey=scope.admin&actionType=SCOPE_UPDATED