Please make sure to read the Introduction to the REST API before starting to use it.
This page describes all rest endpoints which are related to configure a synchronization.
|
Method |
URL |
Description |
|---|---|---|
|
GET |
/integrations/{integrationKey}/draft |
Returns the draft for this synchronization. |
|
POST |
/integrations/{integrationKey}/draft |
Creates a new draft for this synchronization. |
|
DELETE |
/integrations/{integrationKey}/draft |
Deletes the draft for this synchronization. |
|
GET |
/integrations/{integrationKey}/draft/conflicts |
Gets the conflicts for this draft. |
|
POST |
/integrations/{integrationKey}/draft/publish |
Publishes the changes of this draft into the synchronization. |
|
POST |
/integrations/{integrationKey}/draft/issueTypeMappings |
Adds an issuetype mapping. |
|
POST |
/integrations/{integrationKey}/draft/issueTypeMappings/bulk |
Adds multiple issuetype mappings. |
|
PUT |
/integrations/{integrationKey}/draft/issueTypeMappings |
Edits an issuetype mapping. |
|
DELETE |
/integrations/{integrationKey}/draft/issueTypeMappings |
Deletes an issuetype mapping. |
|
POST |
/integrations/{integrationKey}/draft/fieldMappings |
Adds a field mapping. |
|
POST |
/integrations/{integrationKey}/draft/fieldMappings/bulk |
Adds multiple field mappings. |
|
PUT |
/integrations/{integrationKey}/draft/fieldMappings |
Edits a field mapping. |
|
DELETE |
/integrations/{integrationKey}/draft/fieldMappings |
Deletes a field mapping. |
|
POST |
/integrations/{integrationKey}/draft/fieldDefaults/{connectorKey} |
Adds a field default mapping. |
|
PUT |
/integrations/{integrationKey}/draft/fieldDefaults/{connectorKey}/{fieldDefaultKey} |
Edit the field default mapping. |
|
DELETE |
/integrations/{integrationKey}/draft/fieldDefaults/{connectorKey}/{fieldDefaultKey} |
Delete the field default mapping. |
Detailed description
Get draft
GET /integrations/{integrationKey}/draft
Retrieve the current draft of a single Backbone synchronization. It will respond with HTTP 404 if no draft exists for this synchronization.
|
URL Parameter |
Description |
Default |
Required |
|---|---|---|---|
|
integrationKey |
Key of the Backbone synchronization. You can get this from the "get synchronizations" endpoint. |
- |
|
Example Response
The endpoint will return all details about the current draft with the given integrationKey.
Create draft
POST /integrations/{integrationKey}/draft
Create a draft for the given synchronization. It will respond with HTTP 400 if a draft already exists for this synchronization.
|
URL Parameter |
Description |
Default |
Required |
|---|---|---|---|
|
integrationKey |
Key of the Backbone synchronization. |
- |
|
You don't need to provide a body with your request.
Example Result
The endpoint will return all details about the newly created draft.
Delete draft
DELETE /integrations/{integrationKey}/draft
Delete the current draft of a single Backbone synchronization. It will respond with HTTP 404 if no draft exists for this synchronization.
|
URL Parameter |
Description |
Default |
Required |
|---|---|---|---|
|
integrationKey |
Key of the Backbone synchronization. |
- |
|
You don't need to provide a body with your request.
Example Result
The endpoint will return a HTTP 200 response.