Expansion

In order to simplify API responses, the Jira Service Management REST API uses resource expansion. This means the API will only return parts of the resource when explicitly requested.

You can use the expand query parameter to specify the list of entities that you want expanded, identifying each of them by name. For example, appending ?expand=serviceDesk&expand=requestType to a customer request's URI requests the inclusion of the service project and request type details in the response. We would use the following URL to get that information for JSD-1:

http://host:port/context/rest/servicedeskapi/request/JSD-1?expand=serviceDesk&expand=requestType

Alternatively, the list of expansions can be passed as a single comma-separated parameter, e.g:

http://host:port/context/rest/servicedeskapi/request/JSD-1?expand=serviceDesk,requestType

To discover the identifiers for each entity, look at the _expands property in the parent object. In the JSON example below, the resource declares participant, status, sla, requestType and serviceDesk as being expandable.

Copy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
  "_expands": [
    "participant",
    "status",
    "sla",
    "requestType",
    "serviceDesk"
  ],
  "issueId": "107001",
  "issueKey": "HELPDESK-1",
  "requestTypeId": "11001",
  "serviceDeskId": "10001",
  ...
}