Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

IssueSYNC public REST API

You can freely use IssueSYNC's REST API to integrate Jira with other solutions. If you want to use some external app for further integration, or just present some statistics?
Each endpoint URL starts with your's Jira BaseURL, which is followed by /rest/synchronizer/1.0/.

Below you can find our REST API description.

Table of Contents
minLevel3
indent2

Synchronized Issues

Info

Since IssueSYNC 2.6.0

You will get a list of issue ids and/or issue keys of your Jira instance as well as remote (linked) issue id and issue key.

You can choose between three different types of searches (by pagination, providing list of issue ids or list of issue keys). Each of the response data you can extend to additionally return issue key .

Status
colourGreen
titleGET
 {$baseURL}/rest/synchronizer/1.0/synchronizedIssues

possible Query params are:

  • limit: how many results you want to get from one call (max. 10 000)
  • page: which page you want to get (by default 1)
Code Block
languagejs
{
	"name":"Synchronized issues",
	"self":"http://localhost:7112/jira7112/rest/synchronizer/1.0/synchronizedIssues",
	"searchQuery":"limit=1",
	"totalEntitiesCount":299,
	"queriedEntitiesCount":1,
	"synchronizedIssues":[
		{
			"id":27,
			"issueId":10306,
			"remoteIssueId":10118,
			"remoteIssueKey":"TEST-98"
		}
	],
	"currentPage":1
}


Status
colourGreen
titleGET
 {$baseURL}/rest/synchronizer/1.0/synchronizedIssues/withIssueKey

possible Query params are:

  • limit: how many results you want to get from one call (max. 10 000)
  • page: which page you want to get (by default 1)
Code Block
languagejs
{
	"name":"Synchronized issues",
	"self":"http://localhost:7112/jira7112/rest/synchronizer/1.0/synchronizedIssues/withIssueKey",
	"searchQuery":"limit=1&",
	"totalEntitiesCount":299,
	"queriedEntitiesCount":1,
	"synchronizedIssues":[
		{
			"id":27,
			"issueId":10306,
			"issueKey":"SDIS-6",
			"remoteIssueId":10118,
			"remoteIssueKey":"TEST-98"
		}
	],
	"currentPage":1
}



Status
colourGreen
titleGET
 {$baseURL}/rest/synchronizer/1.0/synchronizedIssues/issueIds

possible Query params are:

  • ids: id's of your issues
Code Block
languagejs
{  
  "name":"Synchronized issues",
  "self":"http://localhost:7112/jira-7112/rest/synchronizer/1.0/synchronizedIssues/issueIds",
  "searchQuery":"ids=10306&",
  "totalEntitiesCount":299,
  "queriedEntitiesCount":1,
  "synchronizedIssues":[  
    {  
      "id":27,
      "issueId":10306,
      "remoteIssueId":10118,
      "remoteIssueKey":"TEST-98"
    }
  ],
  "currentPage":1
}

Status
colourGreen
titleGET
 {$baseURL}/rest/synchronizer/1.0/synchronizedIssues/withIssueKey/issueIds

possible Query params are:

  • ids
Code Block
languagejs
{  
  "name":"Synchronized issues",
  "self":"http://localhost:7112/jira-7112/rest/synchronizer/1.0/synchronizedIssues/withIssueKey/issueIds",
  "searchQuery":"ids=10306&",
  "totalEntitiesCount":299,
  "queriedEntitiesCount":1,
  "synchronizedIssues":[  
    {  
      "id":27,
      "issueId":10306,
      "issueKey":"SDIS-6",
      "remoteIssueId":10118,
      "remoteIssueKey":"TEST-98"
    }
  ],
  "currentPage":1
}



Status
colourGreen
titleGET
 {$baseURL}/rest/synchronizer/1.0/synchronizedIssues/issueKeys

possible Query params are:

  • keys: issue keys of your issues
Code Block
languagejs
{  
  "name":"Synchronized issues",
  "self":"http://localhost:7112/jira-7112/rest/synchronizer/1.0/synchronizedIssues/issueKeys",
  "searchQuery":"keys=SDIS-6&",
  "totalEntitiesCount":299,
  "queriedEntitiesCount":1,
  "synchronizedIssues":[  
    {  
      "id":27,
      "issueId":10306,
      "remoteIssueId":10118,
      "remoteIssueKey":"TEST-98"
    }
  ],
  "currentPage":1
}

Status
colourGreen
titleGET
 {$baseURL}/rest/synchronizer/1.0/synchronizedIssues/withIssueKey/issueKeys

possible Query params are:

  • keys: issue keys of your issues
Code Block
languagejs
{  
  "name":"Synchronized issues",
  "self":"http://localhost:7112/jira-7112/rest/synchronizer/1.0/synchronizedIssues/withIssueKey/issueKeys",
  "searchQuery":"keys=SDIS-6&",
  "totalEntitiesCount":299,
  "queriedEntitiesCount":1,
  "synchronizedIssues":[  
    {  
      "id":27,
      "issueId":10306,
	  "issueKey":"SDIS-6",
      "remoteIssueId":10118,
      "remoteIssueKey":"TEST-98"
    }
  ],
  "currentPage":1
}