This resource represents schedule on-calls in Jira Service Management. Use it to:
Lists the on-call responders at a specific time for the schedule with given id in the request.
Permissions required: Permission to access to the schedule:
read:ops-config:jira-service-management
string
Requiredboolean
string
Returned if the request is successful.
oneOf [OnCallParticipants, OnCallUsers]
Details of the on-call participants. Returned only flat=false
is sent in the request.
User IDs of the on-call participants. Returned only flat=true
is sent in the request.
1
2
3
4
curl --request GET \
--url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/schedules/{scheduleId}/on-calls' \
--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
17
18
19
20
21
22
23
24
25
26
{
"onCallParticipants": [
{
"id": "bc667897-cb21-496f-a46e-7c05ff0419dd",
"type": "team"
},
{
"id": "5b2b0e011b3a756623f4e25e",
"type": "user"
},
{
"id": "7a24e9d7-7a4f-4f86-a1df-21ca9c3112ac",
"type": "escalation",
"onCallParticipants": [
{
"id": "5b2b0e011b3a756623f4e25e",
"type": "user",
"forwardedFrom": {
"id": "c5646941-3f05-404d-8594-825fa73af99f",
"type": "user"
}
}
]
}
]
}
Lists the next on-call responders at a specific time for the schedule with given id in the request.
Permissions required: Permission to access to the schedule:
read:ops-config:jira-service-management
string
Requiredboolean
string
Returned if the request is successful.
oneOf [NextOnCallParticipants, NextOnCallUsers]
Details of the next on-call participants. Returned only flat=false
is sent in the request.
User IDs of the next on-call participants. Returned only flat=true
is sent in the request.
1
2
3
4
curl --request GET \
--url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/schedules/{scheduleId}/next-on-calls' \
--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
17
18
19
20
21
22
23
24
25
26
{
"nextOnCallParticipants": [
{
"id": "bc667897-cb21-496f-a46e-7c05ff0419dd",
"type": "team"
},
{
"id": "5b2b0e011b3a756623f4e25e",
"type": "user"
},
{
"id": "7a24e9d7-7a4f-4f86-a1df-21ca9c3112ac",
"type": "escalation",
"nextOnCallParticipants": [
{
"id": "5b2b0e011b3a756623f4e25e",
"type": "user",
"forwardedFrom": {
"id": "c5646941-3f05-404d-8594-825fa73af99f",
"type": "user"
}
}
]
}
]
}
Exports the on-call periods in the calendar (.ics) format for the user with given id in the request.
Permissions required: Permission to export to the user on-calls:
read:ops-config:jira-service-management
string
RequiredReturned if the request is successful.
object
1
2
3
4
curl --request GET \
--url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/schedules/on-calls/{userIdentifier}.ics' \
--user 'email@example.com:<api_token>' \
--header 'Accept: text/calendar'
Rate this page: