Endpoints:
/rest/secure-fields/1.0/history?issueKey={issueKey}
/rest/secure-fields/1.0/history?issueKey={issueKey}&secureFieldId={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 seconde one returns only for specific Secure Field.
Response Structure:
[
{
"created":number,
"author":text,
"authorFullName":text,
"issueId":numer,
"secureFieldChangeItems":[
{
"oldValue":text,
"newValue":text,
"secureFieldId":number,
"secureFieldName":text
}
]
}
]
created | Secure Field edition date |
author | author’s username of change |
authorFullName | author’s full name of change |
issueId | id of issue |
oldValue | previous value in Secure Field |
newValue | new value in Secure Field |
secureFieldId | id of Secure Field |
secureFieldName | Secure Field label |
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 type of Custom Field corresponding to provided secureFieldId was not Secure Field, the endpoint returns BAD REQUEST 400 with message The given custom field is not a Secure Field.
If a user has no permission for this Secure field, the endpoint returs FORBIDDEN 403 with message User {user} has no permission to view history in field {id}.
Example of Secure Field History data returned from REST API:
[
{
"created":1617950735988,
"author":"admin",
"authorFullName":"admin.admin",
"issueId":10100,
"secureFieldChangeItems":[
{
"oldValue":"2, 3",
"newValue":"2, 3, 5",
"secureFieldId":10100,
"secureFieldName":"Secure List"
}
]
},
{
"created":1617950755314,
"author":"john.s",
"authorFullName":"John Smith",
"issueId":10100,
"secureFieldChangeItems":[
{
"oldValue":"old Test",
"newValue":"new Test",
"secureFieldId":10001,
"secureFieldName":"Secure Text"
}
]
}
]