We use cookies to create a secure and effective browsing experience for our website visitors and to understand how you use our site (i.e. Google Analytics). For more information: Click Here
This page describes all rest endpoints which are related to one or multiple connectors. A connector is one half of a synchronization, responsible for one project.
All endpoints described here need a connector key. You can find the corresponding connector key by using the synchronization endpoints. Inside a synchronization, you can locate two connectorKeys, one for each project.
Detailed description
Trigger a resync
POST /connectors/{connectorKey}/resync
This REST API request mirrors the UI action to trigger a resync, it will force a resynchronization of all issues matching the given JQL.
URL Parameter
Description
Default
Required
connectorKey
The key of the connector you are interested in.
-
In order to access the endpoint successfully, you need to provide a request entity as JSON. This entity needs the following parameter:
Entity Parameter
Type
Description
Default
Required
jql
string
A JQL query string selecting the issues you want to synchronize. The JQL you already configured in the synchronization will be combined with it.
-
fieldMappings
string array
This array contains the IDs of all the field mappings which should be considered during the resync. You can get these ids by examining the synchronization configuration you can get via the get synchronization endpoint. You have to use the id value of each fieldmapping.
-
responsibility
boolean
This relates to the advanced setting responsibility if it also should be resynced or not.
false
sendStatusField
boolean
If the status field should also be resynced or not - please be aware that you will force the other issue in the current status regardless of the history how the issue transitioned to that state. We recommend to only resync the status in exceptional cases.
The endpoint will response with a HTTP status 200 OK if the import succeeded.
Delete a sync information entry
DELETE /connectors/{connectorKey}/syncInformation
Deletes a single sync information entry.
URL Parameter
Description
Default
Required
connectorKey
The key of the connector you are interested in.
-
syncInfoId
The id of the sync information entry. This can be found via the get endpoint.
-
If you omit the syncInfoId parameter from the URL and only specify connectorKey, then Backbone will remove all sync information for this connector. You can not revert these changes, except if you have a database backup.
Example Result
The endpoint will response with a HTTP status 200 OK if the import succeeded.
JavaScript errors detected
Please note, these errors can depend on your browser setup.
If this problem persists, please contact our support.