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.
Lists all notifaction rule steps for the user. It optionally takes two parameters - offset and size.
read:ops-config:jira-service-management
string
Requiredinteger
integer
Returned if the request is successful.
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'
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"
}
}
Creates a notification rule step with the given properties.
read:ops-config:jira-service-management
write:ops-config:jira-service-management
string
RequiredNotificationRulesStepContact
Requiredinteger
boolean
RequiredReturned if the request is successful.
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
}'
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
}
Gets a notification rule step with given id in the request.
read:ops-config:jira-service-management
string
Requiredstring
RequiredReturned if the request is successful.
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'
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
}
Deletes a notification rule step with given id in the request.
read:ops-config:jira-service-management
delete:ops-config:jira-service-management
string
Requiredstring
RequiredReturned if the request is successful.
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>'
Updates a notification rule step with given id in the request.
read:ops-config:jira-service-management
write:ops-config:jira-service-management
string
Requiredstring
RequiredNotificationRulesStepContact
integer
boolean
Returned if the request is successful.
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
}'
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
}
Rate this page: