Secure Fields History REST API

Endpoints:

1 2 GET /rest/secure-fields/1.0/history?issueKey={issueKey} GET /rest/secure-fields/1.0/history?issueKey={issueKey}&secureFieldId=customfield_{secureFieldId}

where issueKey is the key of the issue and secureFieldId is the id of Secure Field.

The first endpoint returns the whole history of the Secure Fields for the given issue and the second one returns history for a specific Secure Field.

 

Response Structure:

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 [ { "created":number, "author":number, "authorFullName":text, "issueId":number, "secureFieldChangeItems":[ { "oldValue":text, "newValue":text, "secureFieldId":number, "secureFieldName":text } ] } ]

 

created

Secure Field creation date

author

author’s key

authorFullName

author’s full name

issueId

issue id

oldValue

previous value of Secure Field

newValue

new value of Secure Field

secureFieldId

Secure Field id

secureFieldName

Secure Field name

If successful, the response status is OK HTTP 200.

If no Issue corresponding to provided issueKey was found, the endpoint returns BAD REQUEST 400 with message Issue for key {id} not found.

If no Custom Field corresponding to provided secureFieldId was found, the endpoint returns BAD REQUEST 400 with message Custom field for id {id} not found.

If the type of Custom Field corresponding to provided secureFieldId was not Secure Field, the endpoint returns BAD REQUEST 400 with the message The given custom field is not a Secure Field.

If a user has no permission for this Secure field, the endpoint returns FORBIDDEN 403 with the message User {user} has no permission to view history in field {id}.

Example of Secure Field History data returned from REST API:

 

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 [ { "created":1617950735988, "author":"JIRAUSER10000", "authorFullName":"admin.admin", "issueId":10100, "secureFieldChangeItems":[ { "oldValue":"2, 3", "newValue":"2, 3, 5", "secureFieldId":10100, "secureFieldName":"Secure List" } ] }, { "created":1617950755314, "author":"JIRAUSER10010", "authorFullName":"John Smith", "issueId":10100, "secureFieldChangeItems":[ { "oldValue":"old Test", "newValue":"new Test", "secureFieldId":10001, "secureFieldName":"Secure Text" } ] } ]