Cloud

Jira Service Management ops / Reference / REST API

Schedule overrides

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

list all overrides of a schedule.
create a new override.
get an override.
update an override.
delete an override.

Operations

GET/v1/schedules/{scheduleId}/overrides POST/v1/schedules/{scheduleId}/overrides GET/v1/schedules/{scheduleId}/overrides/{alias}PUT/v1/schedules/{scheduleId}/overrides/{alias}DEL/v1/schedules/{scheduleId}/overrides/{alias}

GET

List overridesExperimental

Lists all ongoing and future overrides of the schedule with given id in the request. It optionally takes two parameters - offset and size.

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

size

integer

offset

integer

Responses

Returned if the request is successful.

application/json

ListOverridesResponse

GET/v1/schedules/{scheduleId}/overrides

curl

Node.js

Java

Python

PHP

curl --request GET \
  --url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/schedules/{scheduleId}/overrides' \
  --user 'email@example.com:<api_token>' \
  --header 'Accept: application/json'

200Response

{
  "values": [
    {
      "alias": "c73c3ffa-dcc3-4f28-ad13-d150ec108fc9",
      "responder": {
        "type": "user",
        "id": "1626a3a7-e159-45e0-b067-b99210917b16"
      },
      "startDate": "2023-11-27T05:00:00Z",
      "endDate": "2023-11-28T10:00:00Z",
      "rotationIds": [
        "dec43451-becf-4d2b-99c6-2f98ff2c1eb3",
        "0c829882-7de3-431e-8b64-8edcca7606d8"
      ]
    }
  ],
  "links": {
    "next": "/v1/schedules/f8f2a4ec-54b2-4513-865b-8cb3b81c9544/overrides?offset=50&size=25"
  }
}

POST

Create overrideExperimental

Creates a new override for the schedule with given id and properties.

Permissions required: Permission to create an override:

the user has edit configuration right.
the user is a member of the team that the schedule belongs to.
the user is adding override to themself.
the user exists in the schedule directly or indirectly.

OAuth 2.0 scopes required:

read:ops-config:jira-service-management

write:ops-config:jira-service-management

Request

Path parameters

scheduleId

string

Required

Request bodyapplication/json

responder

OverrideResponderInfo

Required

startDate

string

Required

endDate

string

Required

rotationIds

array<string>

Responses

Returned if the override is created successfully.

application/json

Override

POST/v1/schedules/{scheduleId}/overrides

curl

Node.js

Java

Python

PHP

curl --request POST \
  --url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/schedules/{scheduleId}/overrides' \
  --user 'email@example.com:<api_token>' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "responder": {
    "type": "user",
    "id": "1626a3a7-e159-45e0-b067-b99210917b16"
  },
  "startDate": "2023-11-27T05:00:00Z",
  "endDate": "2023-11-28T10:00:00Z",
  "rotationIds": [
    "dec43451-becf-4d2b-99c6-2f98ff2c1eb3",
    "0c829882-7de3-431e-8b64-8edcca7606d8"
  ]
}'

201Response

{
  "alias": "c73c3ffa-dcc3-4f28-ad13-d150ec108fc9",
  "responder": {
    "type": "user",
    "id": "1626a3a7-e159-45e0-b067-b99210917b16"
  },
  "startDate": "2023-11-27T05:00:00Z",
  "endDate": "2023-11-28T10:00:00Z",
  "rotationIds": [
    "dec43451-becf-4d2b-99c6-2f98ff2c1eb3",
    "0c829882-7de3-431e-8b64-8edcca7606d8"
  ]
}

GET

Get overrideExperimental

Returns the details of the override of a schedule with given IDs in the request.

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

alias

string

Required

Responses

Returned if the request is successful.

application/json

Override

GET/v1/schedules/{scheduleId}/overrides/{alias}

curl

Node.js

Java

Python

PHP

curl --request GET \
  --url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/schedules/{scheduleId}/overrides/{alias}' \
  --user 'email@example.com:<api_token>' \
  --header 'Accept: application/json'

200Response

{
  "alias": "c73c3ffa-dcc3-4f28-ad13-d150ec108fc9",
  "responder": {
    "type": "user",
    "id": "1626a3a7-e159-45e0-b067-b99210917b16"
  },
  "startDate": "2023-11-27T05:00:00Z",
  "endDate": "2023-11-28T10:00:00Z",
  "rotationIds": [
    "dec43451-becf-4d2b-99c6-2f98ff2c1eb3",
    "0c829882-7de3-431e-8b64-8edcca7606d8"
  ]
}

PUT

Update overrideExperimental

Updates the override of a schedule with given IDs in the request.

Permissions required: Permission to update an override:

the user has edit configuration right.
the user is a member of the team that the schedule belongs to.
the user is adding override to themself.
the user exists in the schedule directly or indirectly by flattening.

OAuth 2.0 scopes required:

read:ops-config:jira-service-management

write:ops-config:jira-service-management

Request

Path parameters

scheduleId

string

Required

alias

string

Required

Request bodyapplication/json

responder

OverrideResponderInfo

Required

startDate

string

Required

endDate

string

Required

rotationIds

array<string>

Responses

Returned if the request is successful.

application/json

Override

PUT/v1/schedules/{scheduleId}/overrides/{alias}

curl

Node.js

Java

Python

PHP

curl --request PUT \
  --url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/schedules/{scheduleId}/overrides/{alias}' \
  --user 'email@example.com:<api_token>' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "responder": {
    "type": "user",
    "id": "1626a3a7-e159-45e0-b067-b99210917b16"
  },
  "startDate": "2023-11-27T05:00:00Z",
  "endDate": "2023-11-28T10:00:00Z",
  "rotationIds": [
    "dec43451-becf-4d2b-99c6-2f98ff2c1eb3",
    "0c829882-7de3-431e-8b64-8edcca7606d8"
  ]
}'

200Response

{
  "alias": "c73c3ffa-dcc3-4f28-ad13-d150ec108fc9",
  "responder": {
    "type": "user",
    "id": "1626a3a7-e159-45e0-b067-b99210917b16"
  },
  "startDate": "2023-11-27T05:00:00Z",
  "endDate": "2023-11-28T10:00:00Z",
  "rotationIds": [
    "dec43451-becf-4d2b-99c6-2f98ff2c1eb3",
    "0c829882-7de3-431e-8b64-8edcca7606d8"
  ]
}

DEL

Delete overrideExperimental

Deletes the override of a schedule with given IDs in the request.

Permissions required: Permission to delete the override:

the user is the responder of the override.
the user has edit configuration right.
the user is the admin of the team that the schedule belongs to.

OAuth 2.0 scopes required:

read:ops-config:jira-service-management

delete:ops-config:jira-service-management

Request

Path parameters

scheduleId

string

Required

alias

string

Required

Responses

Returned if the override is deleted successfully.

DEL/v1/schedules/{scheduleId}/overrides/{alias}

curl

Node.js

Java

Python

PHP

1
2
3

curl --request DELETE \
  --url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/schedules/{scheduleId}/overrides/{alias}' \
  --user 'email@example.com:<api_token>'