Cloud
Incidents / Reference / REST API

Incident

Postman Collection
OpenAPI

This resource represents Jira Service Management Incident. Use this resource to create, delete and fetch an Incident.

POST

Create IncidentExperimental

Creates a new Incident in a service desk.

Request

Request bodyapplication/json

serviceDeskId

string

Required
requestTypeId

string

Required
fields

object

update

object

alertIds

array<string>

Responses

Returned if the request is successful.

application/json

CreateIncidentResponse
POST/jsm/incidents/cloudId/{cloudId}/v1/incident
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 curl --request POST \ --url 'https://api.atlassian.com/jsm/incidents/cloudId/{cloudId}/v1/incident' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "requestTypeId": "75", "serviceDeskId": "6", "fields": { "summary": "Incident with alerts from JSM Incidents APIs", "customfield_10002": [ { "ari": "ari:cloud:identity::user/99:27935d01-92a7-4687-8272-a9b8d3b2ae2e" } ] }, "alertIds": [ "8dd24912-a0ad-41cd-ac80-535eaf649ed7" ] }'
201Response
1 2 3 4 5 { "id": "10050", "key": "ITSM-30", "self": "http://your-domain.atlassian.net/rest/api/3/issue/10050" }
GET

Get incidentExperimental

Returns a Jira Service Management Incident.

Request

Path parameters

issueID

integer

Required

Responses

Returned if the request is successful.

application/json

IncidentDTO
GET/jsm/incidents/cloudId/{cloudId}/v1/incident/{issueID}
1 2 3 curl --request GET \ --url 'https://api.atlassian.com/jsm/incidents/cloudId/{cloudId}/v1/incident/{issueID}' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 { "summary": "Mia create this incident", "reporter": { "accountId": "99:27935d01-92a7-4687-8272-a9b8d3b2ae2e", "accountType": "ATLASSIAN_ACCOUNT", "displayName": "Mia Krystof" }, "priority": { "name": "Medium", "id": "3" }, "status": { "id": "1", "name": "Open", "statusCategory": { "id": 2, "key": "new", "name": "To Do" } }, "participants": { "fieldId": "customfield_10000", "value": [] }, "majorIncident": { "fieldId": "customfield_10001", "value": null }, "responders": { "fieldId": "customfield_10002", "value": [ { "ari": "ari:cloud:identity::user/99:27935d01-92a7-4687-8272-a9b8d3b2ae2e", "name": "Mia Krystof", "type": "user" } ] }, "affectedServices": { "fieldId": "customfield_10003", "value": [] } }
DEL

Delete IncidentExperimental

Deletes a Jira Service Management Incident.

Request

Path parameters

issueID

integer

Required

Responses

Returned if the request is successful.

DEL/jsm/incidents/cloudId/{cloudId}/v1/incident/{issueID}
1 2 curl --request DELETE \ --url 'https://api.atlassian.com/jsm/incidents/cloudId/{cloudId}/v1/incident/{issueID}'

Rate this page: