Cloud
Incidents / Reference / REST API

Affected Services

Postman Collection
OpenAPI

This resource represents affected services of a Jira Service Management Incident. Use this resource to get, add and remove affected services to an incident issue.

POST

Add affected servicesExperimental

Adds affected services to a Jira Service Management Incident

read:incident:jira-service-management
,
write:incident:jira-service-management

Request

Path parameters

issueID

integer

Required

Request bodyapplication/json

affectedServices

array<AffectedServicesAri>

Required

Responses

Returned if the request is successful.

POST/jsm/incidents/cloudId/{cloudId}/v1/incident/{issueID}/affected-service/add
1 2 3 4 5 6 7 8 9 10 11 curl --request POST \ --url 'https://api.atlassian.com/jsm/incidents/cloudId/{cloudId}/v1/incident/{issueID}/affected-service/add' \ --header 'Authorization: Bearer <access_token>' \ --header 'Content-Type: application/json' \ --data '{ "affectedServices": [ { "ari": "ari:cloud:graph::service/88b53f41-0fa3-4371-95f7-ef8e65910943/4f302e3a-b39c-11ee-8d82-0e3e7a21a911" } ] }'
GET

Get affected servicesExperimental

Returns affected services to a Jira Service Management Incident.

read:incident:jira-service-management

Request

Path parameters

issueID

integer

Required

Responses

Returned if the request is successful.

application/json

GetAffectedServicesResponse
GET/jsm/incidents/cloudId/{cloudId}/v1/incident/{issueID}/affected-service
1 2 3 4 curl --request GET \ --url 'https://api.atlassian.com/jsm/incidents/cloudId/{cloudId}/v1/incident/{issueID}/affected-service' \ --header 'Authorization: Bearer <access_token>' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 { "affectedServices": [ { "ari": "ari:cloud:graph::service/88b53f41-0fa3-4371-95f7-ef8e65910943/4f302e3a-b39c-11ee-8d82-0e3e7a21a911" } ] }
POST

Remove affected servicesExperimental

Removes affected services to a Jira Service Management Incident

read:incident:jira-service-management
,
write:incident:jira-service-management

Request

Path parameters

issueID

integer

Required

Request bodyapplication/json

affectedServices

array<AffectedServicesAri>

Required

Responses

Returned if the request is successful.

POST/jsm/incidents/cloudId/{cloudId}/v1/incident/{issueID}/affected-service/remove
1 2 3 4 5 6 7 8 9 10 11 curl --request POST \ --url 'https://api.atlassian.com/jsm/incidents/cloudId/{cloudId}/v1/incident/{issueID}/affected-service/remove' \ --header 'Authorization: Bearer <access_token>' \ --header 'Content-Type: application/json' \ --data '{ "affectedServices": [ { "ari": "ari:cloud:graph::service/88b53f41-0fa3-4371-95f7-ef8e65910943/4f302e3a-b39c-11ee-8d82-0e3e7a21a911" } ] }'

Rate this page: