• Alerts
  • Audit Logs
  • Contacts
  • Custom user roles
  • Escalations
  • Forwarding rules
  • Heartbeats
  • Integrations
  • Integration actions
  • Integration outgoing filters
  • Maintenances
  • Notification rules
  • Notification rule steps
  • Routing rules
  • Schedules
  • Schedule on-calls
  • Schedule overrides
  • Schedule rotations
  • Schedule timelines
  • Syncs
  • Sync actions
  • Sync action groups
Cloud
Jira Service Management ops / Reference / REST API

Schedule timelines

Postman Collection
OpenAPI

This resource represents schedule timelines in Jira Service Management. Use it to:

  • calculate the timeline of a schedule.
  • export the timeline of a schedule in calendar format.
Operations
GET/v1/schedules/{scheduleId}/timelineGET/v1/schedules/{scheduleId}.ics
GET

Get schedule timelineExperimental

Returns the timeline of the schedule with given id in the request. The time range of the timeline can go back at most one year from today and as far as two years from today. Therefore, query parameters should be given accordingly.

Permissions required: Permission to access to the schedule:

  • the user has read-only administrative right.
  • the schedule's assigned team is one of the teams that the user belongs to.
  • the user is added to a rotation of the schedule as a responder.
  • a team is added to a rotation of the schedule as a responder, and the user is a member of this team.
  • an escalation is added to a rotation of the schedule as a responder, and the user is a member of this escalation.
  • there is an override to the user in the schedule.
OAuth 2.0 scopes required:
read:ops-config:jira-service-management

Request

Path parameters

scheduleId

string

Required

Query parameters

interval

integer

intervalUnit

string

date

string

expand

array<string>

Responses

Returned if the request is successful.

application/json

ScheduleTimelineResponse
GET/v1/schedules/{scheduleId}/timeline
1 2 3 4 curl --request GET \ --url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/schedules/{scheduleId}/timeline' \ --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 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 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 { "startDate": "2024-01-29T00:00:00Z", "endDate": "2024-02-12T00:00:00Z", "finalTimeline": { "rotations": [ { "id": "072cb9c1-698e-49fa-b1dc-1e8c190a76a6", "name": "Primary Rotation", "order": 1, "deleted": false, "periods": [ { "startDate": "2024-01-29T00:00:00Z", "endDate": "2024-02-01T08:11:21.263Z", "type": "historical", "responder": { "id": "153c98d1-ca2c-44d8-b8ea-10280f7c2c75", "type": "team" }, "flattenedResponders": [ { "id": "153c98d1-ca2c-44d8-b8ea-10280f7c2c75", "type": "team" } ] }, { "startDate": "2024-02-01T08:11:21.263Z", "endDate": "2024-02-01T08:12:19.866Z", "type": "historical", "responder": { "id": "5b2b0e011b3a756623f4e25e", "type": "user" }, "flattenedResponders": [ { "id": "5b2b0e011b3a756623f4e25e", "type": "user" } ] }, { "startDate": "2024-02-01T08:12:19.866Z", "endDate": "2024-02-02T00:00:00Z", "type": "override", "responder": { "id": "5b2b0e011b3a756623f4e25e", "type": "user" } }, { "startDate": "2024-02-02T00:00:00Z", "endDate": "2024-02-03T07:00:00Z", "type": "base", "responder": { "id": "153c98d1-ca2c-44d8-b8ea-10280f7c2c75", "type": "team" } }, { "startDate": "2024-02-03T07:00:00Z", "endDate": "2024-02-05T21:00:00Z", "type": "base", "responder": { "id": "5b2b0e011b3a756623f4e25e", "type": "user" } }, { "startDate": "2024-02-05T21:00:00Z", "endDate": "2024-02-06T21:00:00Z", "type": "forwarding", "from": { "id": "40973cb0-6990-4997-aac3-46f8a6031f0f", "type": "user", "deleted": false }, "responder": { "id": "e75fed1b-4234-45bc-b5b3-b936979f3cc0", "type": "user" } }, { "startDate": "2024-02-06T21:00:00Z", "endDate": "2024-02-10T07:00:00Z", "type": "base", "responder": { "id": "5b2b0e011b3a756623f4e25e", "type": "user" } }, { "startDate": "2024-02-10T07:00:00Z", "endDate": "2024-02-12T00:00:00Z", "type": "base", "responder": { "id": "153c98d1-ca2c-44d8-b8ea-10280f7c2c75", "type": "team" } } ] }, { "id": "18b6b7e7-b83b-4b18-81c2-e3f7ceb9ef7b", "name": "Secondary Rotation", "order": 4, "deleted": false, "periods": [ { "startDate": "2024-01-29T00:00:00Z", "endDate": "2024-02-01T07:00:00Z", "type": "historical", "responder": { "id": "ab73148c-afa6-4604-ae04-7dc5daea6c8b", "type": "escalation" }, "flattenedResponders": [ { "id": "e75fed1b-4234-45bc-b5b3-b936979f3cc0", "type": "user" }, { "id": "5b2b0e011b3a756623f4e25e", "type": "user" } ] }, { "startDate": "2024-02-01T07:00:00Z", "endDate": "2024-02-01T08:12:19.866Z", "type": "historical", "responder": { "id": "5b2b0e011b3a756623f4e25e", "type": "user" }, "flattenedResponders": [ { "id": "5b2b0e011b3a756623f4e25e", "type": "user" } ] }, { "startDate": "2024-02-01T08:12:19.866Z", "endDate": "2024-02-04T00:00:00Z", "type": "base", "responder": { "id": "5b2b0e011b3a756623f4e25e", "type": "user" } }, { "startDate": "2024-02-04T00:00:00Z", "endDate": "2024-02-05T00:00:00Z", "type": "override", "responder": { "id": "e75fed1b-4234-45bc-b5b3-b936979f3cc0", "type": "user" } }, { "startDate": "2024-02-05T00:00:00Z", "endDate": "2024-02-05T21:00:00Z", "type": "base", "responder": { "id": "5b2b0e011b3a756623f4e25e", "type": "user" } }, { "startDate": "2024-02-05T21:00:00Z", "endDate": "2024-02-06T21:00:00Z", "type": "forwarding", "from": { "id": "40973cb0-6990-4997-aac3-46f8a6031f0f", "type": "user", "deleted": false }, "responder": { "id": "e75fed1b-4234-45bc-b5b3-b936979f3cc0", "type": "user" } }, { "startDate": "2024-02-06T21:00:00Z", "endDate": "2024-02-12T00:00:00Z", "type": "base", "responder": { "id": "5b2b0e011b3a756623f4e25e", "type": "user" } } ] }, { "id": "9625a842-18b0-464f-8d6e-b5ea33af8a13", "name": "Backup Rotation", "order": null, "deleted": true, "periods": [ { "startDate": "2024-01-29T00:00:00Z", "endDate": "2024-01-29T12:00:00Z", "type": "historical", "responder": { "type": "noone" } }, { "startDate": "2024-01-29T12:00:00Z", "endDate": "2024-01-30T12:00:00Z", "type": "historical", "responder": { "id": "ab73148c-afa6-4604-ae04-7dc5daea6c8b", "type": "escalation" }, "flattenedResponders": [ { "id": "e75fed1b-4234-45bc-b5b3-b936979f3cc0", "type": "user" }, { "id": "5b2b0e011b3a756623f4e25e", "type": "user" } ] }, { "startDate": "2024-01-30T12:00:00Z", "endDate": "2024-01-31T12:00:00Z", "type": "historical", "responder": { "type": "noone" } }, { "startDate": "2024-01-31T12:00:00Z", "endDate": "2024-02-01T07:59:12.993Z", "type": "historical", "responder": { "id": "ab73148c-afa6-4604-ae04-7dc5daea6c8b", "type": "escalation" }, "flattenedResponders": [ { "id": "e75fed1b-4234-45bc-b5b3-b936979f3cc0", "type": "user" }, { "id": "5b2b0e011b3a756623f4e25e", "type": "user" } ] } ] }, { "id": "2adfb43b-dfdf-455d-9e67-6bd4cce76d11", "name": "Old Rotation", "order": null, "deleted": true, "periods": [ { "startDate": "2024-01-29T08:00:00Z", "endDate": "2024-01-30T18:30:00Z", "type": "historical", "responder": { "type": "noone" } }, { "startDate": "2024-01-31T09:00:00Z", "endDate": "2024-02-01T07:59:17.791Z", "type": "historical", "responder": { "type": "noone" } } ] } ] }, "baseTimeline": { "rotations": [ { "id": "072cb9c1-698e-49fa-b1dc-1e8c190a76a6", "name": "Primary Rotation", "order": 1, "deleted": false, "periods": [ { "startDate": "2024-01-29T00:00:00Z", "endDate": "2024-02-03T07:00:00Z", "type": "base", "responder": { "id": "153c98d1-ca2c-44d8-b8ea-10280f7c2c75", "type": "team" } }, { "startDate": "2024-02-03T07:00:00Z", "endDate": "2024-02-10T07:00:00Z", "type": "base", "responder": { "id": "5b2b0e011b3a756623f4e25e", "type": "user" } }, { "startDate": "2024-02-10T07:00:00Z", "endDate": "2024-02-12T00:00:00Z", "type": "base", "responder": { "id": "153c98d1-ca2c-44d8-b8ea-10280f7c2c75", "type": "team" } } ] }, { "id": "18b6b7e7-b83b-4b18-81c2-e3f7ceb9ef7b", "name": "Secondary Rotation", "order": 4, "deleted": false, "periods": [ { "startDate": "2024-01-29T00:00:00Z", "endDate": "2024-02-01T07:00:00Z", "type": "base", "responder": { "id": "ab73148c-afa6-4604-ae04-7dc5daea6c8b", "type": "escalation" } }, { "startDate": "2024-02-01T07:00:00Z", "endDate": "2024-02-12T00:00:00Z", "type": "base", "responder": { "id": "5b2b0e011b3a756623f4e25e", "type": "user" } } ] } ] }, "overrideTimeline": { "rotations": [ { "id": "072cb9c1-698e-49fa-b1dc-1e8c190a76a6", "name": "Primary Rotation", "order": 1, "deleted": false, "periods": [ { "startDate": "2024-02-01T08:11:21.263Z", "endDate": "2024-02-02T00:00:00Z", "type": "override", "responder": { "id": "5b2b0e011b3a756623f4e25e", "type": "user" } } ] }, { "id": "18b6b7e7-b83b-4b18-81c2-e3f7ceb9ef7b", "name": "Secondary Rotation", "order": 4, "deleted": false, "periods": [ { "startDate": "2024-02-04T00:00:00Z", "endDate": "2024-02-05T00:00:00Z", "type": "override", "responder": { "id": "e75fed1b-4234-45bc-b5b3-b936979f3cc0", "type": "user" } } ] } ] }, "forwardingTimeline": { "rotations": [ { "id": "072cb9c1-698e-49fa-b1dc-1e8c190a76a6", "name": "Primary Rotation", "order": 1, "deleted": false, "periods": [ { "startDate": "2024-02-05T21:00:00Z", "endDate": "2024-02-06T21:00:00Z", "type": "forwarding", "from": { "id": "40973cb0-6990-4997-aac3-46f8a6031f0f", "type": "user", "deleted": false }, "responder": { "id": "e75fed1b-4234-45bc-b5b3-b936979f3cc0", "type": "user" } } ] }, { "id": "18b6b7e7-b83b-4b18-81c2-e3f7ceb9ef7b", "name": "Secondary Rotation", "order": 4, "deleted": false, "periods": [ { "startDate": "2024-02-05T21:00:00Z", "endDate": "2024-02-06T21:00:00Z", "type": "forwarding", "from": { "id": "40973cb0-6990-4997-aac3-46f8a6031f0f", "type": "user", "deleted": false }, "responder": { "id": "e75fed1b-4234-45bc-b5b3-b936979f3cc0", "type": "user" } } ] } ] }, "_expands": [ "base", "forwarding", "override" ] }
GET

Export schedule timelineExperimental

Exports the timeline in the calendar (.ics) format for the schedule with given id in the request. The time range of the export starts from the beginning of the current month and ends one year after the start date.

Permissions required: Permission to access to the schedule:

  • the user has read-only administrative right.
  • the schedule's assigned team is one of the teams that the user belongs to.
  • the user is added to a rotation of the schedule as a responder.
  • a team is added to a rotation of the schedule as a responder, and the user is a member of this team.
  • an escalation is added to a rotation of the schedule as a responder, and the user is a member of this escalation.
  • there is an override to the user in the schedule.
OAuth 2.0 scopes required:
read:ops-config:jira-service-management

Request

Path parameters

scheduleId

string

Required

Responses

Returned if the request is successful.

text/calendar

object

GET/v1/schedules/{scheduleId}.ics
1 2 3 4 curl --request GET \ --url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/schedules/{scheduleId}.ics' \ --user 'email@example.com:<api_token>' \ --header 'Accept: text/calendar'

Rate this page: