Date: Fri, 29 Mar 2024 08:27:36 +0000 (UTC) Message-ID: <983241901.11517.1711700856253@catch-kbase-p> Subject: Exported From Confluence MIME-Version: 1.0 Content-Type: multipart/related; boundary="----=_Part_11516_36912649.1711700856253" ------=_Part_11516_36912649.1711700856253 Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Content-Location: file:///C:/exported.html
Allows the creation of a new incident in ET that is synchronized to a ti= cket in an external system (JIRA, TFS or Rally).
This resource supports the following methods: POST
Creates a background task for creating an incident from an external tick= et. Note: this task completes asynchronously and may take some time to comp= lete.
These are the expected status codes returned by the service. In addition= , some other status codes may be returned if either an internal error occur= s or there is an authentication issue (such as an expired OAuth token).
Status | Description |
---|---|
202 - Accepted | Returned if the task was created successfully.= td> |
403 - Forbidden | If you do not have permission to execute this jo= b, or the parameters are invalid. |
An example of creating a new incident synchronized with a ticket. Note: = When the task completes, retrieving the progress of the task will include a= link to the Incident that was created and an additional value, 'IncidentId= '.
Request Headers
Key | Value | Description |
---|---|---|
Accept | application/json |
Request Parameters
Key | Value | Description |
---|---|---|
{ticketId} | 16841 | ID of the ticket to link to. In cases of systems= such as JIRA, this is the internal identifier, not the 'Key' for the ticke= t (issue). |
{externalSystemLinkId} | c63e805c-e5d3-4919-9d10-a0a500e0754a | This is the unique identifier of the external sy= stem link in ET. |
Response Headers
Key | Value | Description |
---|---|---|
Content-Type | application/json; charset=3Dutf-8 |
Response Body
{ "Complete": false, "TotalElements": 0, "ProcessedElements": 0, "StartedAt": "2012-08-06T11:28:45Z", "ProgressInPercent": 0.0, "Id": "ticketlinking_cba3035a-bf63-4006-89b1-b291aaac0460", "Message": null, "Self": "http://localhost/api/backgroundtask/ticketlinking_cba3035a-bf63-= 4006-89b1-b291aaac0460" }
Status Code
202 - Accepted
This example shows the progress response of linking once completed, incl= uding the additional details of the Incident that was created.
Request Headers
Key | Value | Description |
---|---|---|
Accept | application/json |
Request Parameters
Key | Value | Description |
---|---|---|
{ticketId} | 16841 | ID of the ticket to link to. In cases of systems= such as JIRA, this is the internal identifier, not the 'Key' for the ticke= t (issue). |
{externalSystemLinkId} | 9b01796c-a9ae-40cb-a6ad-a802346c0c33 | This is the unique identifier of the external sy= stem link in ET. |
Response Headers
Key | Value | Description |
---|---|---|
Content-Type | application/json; charset=3Dutf-8 |
Response Body
{ "Complete": true, "StartedAt": "2012-08-06T11:39:45Z", "FinishedAt": "2012-08-06T11:39:53Z", "ProgressInPercent": 1.0, "Id": "ticketlinking_9b01796c-a9ae-40cb-a6ad-a802346c0c33", "Message": "Completed", "IncidentId": "029b2c43-38be-4c94-b547-a0a50185fb9e", "Self": "http://localhost/api/backgroundtask/ticketlinking_9b01796c-a9ae-= 40cb-a6ad-a802346c0c33", "Links": [ { "Href": "http://localhost/api/incident/029b2c43-38be-4c94-b547-a0a501= 85fb9e", "Rel": "Incident" } ] }
Status Code
202 - Accepted