The Tag REST API returns several latest tags for the issue. Tags are sorted in chronological order from newest to oldest.
url
{JiraBaseURL}/rest/gitplugin/1.0/issuegitdetails/issue/{issuekey}/tag
method
GET
Parameters
| Field | Description |
|---|---|
| issueKey | String. Required. Path parameter.
This is the Jira Issue Key – a concatenation of Project key and Issue number. It must contain a dash (‘-‘). The issueKey must be valid and existent. For example: |
| tagsPerRepository | Integer. Required.
This parameter limits the total number of tags returned. Use values greater than or equal to 1 RECOMMENDED. Using the zero (0) value will return all tags linked to the issue but this greatly impacts Jira performance NOT RECOMMENDED. Example:
|
Response
Returns the number of tags according to the parameter value for each repository associated with the issue.
The result contains tag elements with basic information such as name of a tag, associated commit data, associated repository settings, etc.
The additional flag hasMore indicates if an issue contains more tags. Increasing the quantity number for tagsPerRepository will return a large collection result depending on the size of the parameter value – in case hasMore has true as response.
Example:
http://jira.yourorg.com/rest/gitplugin/1.0/issuegitdetails/issue/TEST-435/tag?tagsPerRepository=2
Result:
{
"tags": [
{
"name": "test tag 1",
"commitId": "4caf6aa4fd50ef42012863ce561bddba32557152",
"repoId": 2,
"repoName": "test-repo-01",
"isGitViewerEnabled": true,
"creationDateFormatted": "April 9, 2020 20:27:28 PM OMST",
"committerName": "John Smith",
"committerEmail": "[email protected]",
"creationDate": 1617978448000
},
{
"name": "test tag 2",
"commitId": "90e902222248ae205ed6ed42cd037df8fbefc871",
"repoId": 3,
"repoName": "test-repo-02",
"isGitViewerEnabled": true,
"creationDateFormatted": "November 12, 2020 10:38:56 AM OMST",
"message": "TEST-1 message",
"committerName": "John Smith",
"committerEmail": "[email protected]",
"creationDate": 1605155936000
}
],
"isTagsFeatureEnabled": true,
"hasMore": true,
"calculationError": "",
"firstTag": {
"name": "testrepo-test-tag-01",
"commitId": "a7141bf14e3a27c413b568c8d1f5a5f3a6a45135",
"repoId": 1,
"repoName": "test-repo-main",
"isGitViewerEnabled": true,
"creationDateFormatted": "April 5, 2018 11:52:11 AM OMST",
"message": "TEST-1 tags per repo example",
"committerName": "John Smith",
"committerEmail": "[email protected]",
"creationDate": 1459835531000
}
}
