Cloud
Jira Service Management ops / Reference / REST API

Notification rule steps

Postman Collection
OpenAPI

Notification rule steps allow users to define how they want to be notified. This resource represents the all contracts of notification rule steps in Jira Service Management.

GET

List notification rule stepsExperimental

Lists all notifaction rule steps for the user. It optionally takes two parameters - offset and size.

Request

Path parameters

ruleId

string

Required

Query parameters

offset

integer

size

integer

Responses

Returned if the request is successful.

application/json

NotificationRulesStepPaginatedResponse
GET/v1/notification-rules/{ruleId}/steps
1 2 3 4 curl --request GET \ --url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/notification-rules/{ruleId}/steps' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 { "values": [ { "id": "dbf70781-d6d8-4924-b90d-6a0c77833748", "sendAfter": 5, "contact": { "method": "email", "to": "johnsmith@atlassian.com" }, "enabled": true } ], "links": { "next": "/v1/notification-rules/0hcb717e-c442-4185-8bc1-cc998844f567/steps?offset=10&size=5" } }
POST

Create notification rule stepExperimental

Creates a notification rule step with the given properties.

Request

Path parameters

ruleId

string

Required

Request bodyapplication/json

contact

NotificationRulesStepContact

Required
sendAfter

integer

enabled

boolean

Required

Responses

Returned if the request is successful.

application/json

NotificationRulesStepNotificationRuleStep
POST/v1/notification-rules/{ruleId}/steps
1 2 3 4 5 6 7 8 9 10 11 12 13 curl --request POST \ --url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/notification-rules/{ruleId}/steps' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "contact": { "method": "email", "to": "johnsmith@atlassian.com" }, "sendAfter": 5, "enabled": true }'
201Response
1 2 3 4 5 6 7 8 9 { "id": "dbf70781-d6d8-4924-b90d-6a0c77833748", "sendAfter": 5, "contact": { "method": "email", "to": "johnsmith@atlassian.com" }, "enabled": true }
GET

Get notification rule stepExperimental

Gets a notification rule step with given id in the request.

Request

Path parameters

ruleId

string

Required
id

string

Required

Responses

Returned if the request is successful.

application/json

NotificationRulesStepNotificationRuleStep
GET/v1/notification-rules/{ruleId}/steps/{id}
1 2 3 4 curl --request GET \ --url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/notification-rules/{ruleId}/steps/{id}' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 { "id": "dbf70781-d6d8-4924-b90d-6a0c77833748", "sendAfter": 5, "contact": { "method": "email", "to": "johnsmith@atlassian.com" }, "enabled": true }
DEL

Delete notification rule stepExperimental

Deletes a notification rule step with given id in the request.

Request

Path parameters

ruleId

string

Required
id

string

Required

Responses

Returned if the request is successful.

DEL/v1/notification-rules/{ruleId}/steps/{id}
1 2 3 curl --request DELETE \ --url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/notification-rules/{ruleId}/steps/{id}' \ --user 'email@example.com:<api_token>'
PATCH

Update notification rule stepExperimental

Updates a notification rule step with given id in the request.

Request

Path parameters

ruleId

string

Required
id

string

Required

Request bodyapplication/json

contact

NotificationRulesStepContact

sendAfter

integer

enabled

boolean

Responses

Returned if the request is successful.

application/json

NotificationRulesStepNotificationRuleStep
PATCH/v1/notification-rules/{ruleId}/steps/{id}
1 2 3 4 5 6 7 8 9 10 11 12 13 curl --request PATCH \ --url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/notification-rules/{ruleId}/steps/{id}' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "contact": { "method": "email", "to": "johnsmith@atlassian.com" }, "sendAfter": 5, "enabled": true }'
200Response
1 2 3 4 5 6 7 8 9 { "id": "dbf70781-d6d8-4924-b90d-6a0c77833748", "sendAfter": 5, "contact": { "method": "email", "to": "johnsmith@atlassian.com" }, "enabled": true }