You can manage Sync Existing Issues operations through the REST API.
Endpoints you can use are listed below:
Start Sync Existing Issues Operation
Starts a new Sync Existing Issues operation.
HTTP POST
<jira-server>/rest/fieldsync/1.0/syncallservice/start
Request Body Parameters
- jqlQuery: A JQL query to filter issues for sync.
Permissions Required
- User must be authenticated
- User must be an admin
Response
| Result | HTTP | Description |
|---|---|---|
| Success | 200 | Sync Existing Issues operation is completed |
| Authentication required | 401 | User is not authenticated |
| Invalid license | 403 | Field Sync license is invalid |
| Unauthorized user | 403 | User is not an admin |
| Ongoing operation exists | 400 | There is another ongoing Sync Existing Issues operation |
| No issue found | 400 | No issue can be found for the given JQL |
| Empty JQL | 400 | The given JQL is empty |
| Wrong JQL Syntax | 400 | The given JQL's syntax is not correct |
| Invalid JQL | 400 | The given JQL is not valid |
| Too long JQL | 400 | The given JQL is too long and exceeds the maximum character limit |
| Search error | 500 | Searching issues using the given JQL cannot be completed successfully |
| Unexpected error | 500 | An unexpected error occurred |
Error response format:
{
"title": "<Error_Title>",
"message": "<Error_Message>"
}
Track Sync Existing Issues Operation
Returns the current state of Sync Existing Issues operation.
HTTP GET
<jira-server>/rest/fieldsync/1.0/syncallservice/progress
Permissions Required
- User must be authenticated
- User must be an admin
Response
| Result | HTTP | Description |
|---|---|---|
| Success | 200 | Sync Existing Issues operation is canceled |
| Authentication required | 401 | User is not authenticated |
| Unauthorized user | 403 | User is not an admin |
Ongoing operation:
{
"start": "30/12/2019 10:59:05",
"total": 250,
"synced": 125,
"percentage": 0.5,
"cancel": false,
"running": true,
"jql": "project in (ABC, XYZ)"
}
Completed operation:
{
"start": "30/12/2019 10:59:05",
"end": "30/12/2019 11:30:00",
"total": 250,
"synced": 250,
"percentage": 1,
"cancel": false,
"running": false,
"jql": "project in (ABC, XYZ)"
}
Canceled operation:
{
"start": "30/12/2019 10:59:05",
"end": "30/12/2019 11:30:00",
"total": 250,
"synced": 125,
"percentage": 0.5,
"cancel": true,
"running": false,
"jql": "project in (ABC, XYZ)"
}
Error response format:
{
"title": "<Error_Title>",
"message": "<Error_Message>"
}
Cancel Sync Existing Issues Operation
Stops the ongoing Sync Existing Issues operation.
HTTP POST
<jira-server>/rest/fieldsync/1.0/syncallservice/cancel
Permissions Required
- User must be authenticated
- User must be an admin
Response
| Result | HTTP | Description |
|---|---|---|
| Success | 200 | Sync Existing Issues operation is canceled |
| Authentication required | 401 | User is not authenticated |
| Unauthorized user | 403 | User is not an admin |
Error response format:
{
"title": "<Error_Title>",
"message": "<Error_Message>"
}