Cloud
Jira Service Management Cloud / Reference / REST API

Request

Postman Collection
OpenAPI
Operations
GET/rest/servicedeskapi/requestPOST/rest/servicedeskapi/requestGET/rest/servicedeskapi/request/{issueIdOrKey}GET/rest/servicedeskapi/request/{issueIdOrKey}/approvalGET/rest/servicedeskapi/request/{issueIdOrKey}/approval/{approvalId}POST/rest/servicedeskapi/request/{issueIdOrKey}/approval/{approvalId}GET/rest/servicedeskapi/request/{issueIdOrKey}/attachmentPOST/rest/servicedeskapi/request/{issueIdOrKey}/attachmentGET/rest/servicedeskapi/request/{issueIdOrKey}/attachment/{attachmentId}GET/rest/servicedeskapi/request/{issueIdOrKey}/attachment/{attachmentId}/thumbnailGET/rest/servicedeskapi/request/{issueIdOrKey}/commentPOST/rest/servicedeskapi/request/{issueIdOrKey}/commentGET/rest/servicedeskapi/request/{issueIdOrKey}/comment/{commentId}GET/rest/servicedeskapi/request/{issueIdOrKey}/comment/{commentId}/attachmentGET/rest/servicedeskapi/request/{issueIdOrKey}/notificationPUT/rest/servicedeskapi/request/{issueIdOrKey}/notificationDEL/rest/servicedeskapi/request/{issueIdOrKey}/notificationGET/rest/servicedeskapi/request/{issueIdOrKey}/participantPOST/rest/servicedeskapi/request/{issueIdOrKey}/participantDEL/rest/servicedeskapi/request/{issueIdOrKey}/participantGET/rest/servicedeskapi/request/{issueIdOrKey}/slaGET/rest/servicedeskapi/request/{issueIdOrKey}/sla/{slaMetricId}GET/rest/servicedeskapi/request/{issueIdOrKey}/statusGET/rest/servicedeskapi/request/{issueIdOrKey}/transitionPOST/rest/servicedeskapi/request/{issueIdOrKey}/transitionGET/rest/servicedeskapi/request/{requestIdOrKey}/feedbackPOST/rest/servicedeskapi/request/{requestIdOrKey}/feedbackDEL/rest/servicedeskapi/request/{requestIdOrKey}/feedback
GET

Get customer requests

This method returns all customer requests for the user executing the query.

The returned customer requests are ordered chronologically by the latest activity on each request. For example, the latest status transition or comment.

Permissions required: Permission to access the specified service desk.

Response limitations: For customers, the list returned will include request they created (or were created on their behalf) or are participating in only.

Data Security Policy: Not exempt from app access rules
Scopes

Connect app scope requiredREAD

ClassicRECOMMENDED:read:servicedesk-request
Granular:read:request:jira-service-management, read:user:jira

Request

Query parameters

searchTerm

string

requestOwnership

array<string>

requestStatus

string

approvalStatus

string

organizationId

integer

serviceDeskId

integer

requestTypeId

integer

expand

array<string>

start

integer

limit

integer

Responses

Returns the customer requests, on the specified page of the results.

application/json

PagedDTOCustomerRequestDTO
GET/rest/servicedeskapi/request
1 2 3 4 curl --request GET \ --url 'https://your-domain.atlassian.net/rest/servicedeskapi/request' \ --header 'Authorization: Bearer <access_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 { "_expands": [ "participant", "status", "sla", "requestType", "serviceDesk", "attachment", "action", "comment" ], "size": 3, "start": 3, "limit": 3, "isLastPage": false, "_links": { "base": "https://your-domain.atlassian.net/rest/servicedeskapi", "context": "context", "next": "https://your-domain.atlassian.net/rest/servicedeskapi/request?start=6&limit=3", "prev": "https://your-domain.atlassian.net/rest/servicedeskapi/request?start=0&limit=3" }, "values": [ { "_expands": [ "participant", "status", "sla", "requestType", "serviceDesk", "attachment", "action", "comment" ], "issueId": "107001", "issueKey": "HELPDESK-1", "requestTypeId": "25", "serviceDeskId": "10", "createdDate": { "epochMillis": 1444290120000, "friendly": "Monday 14:42 PM", "iso8601": "2015-10-08T14:42:00+0700", "jira": "2015-10-08T14:42:00.000+0700" }, "reporter": { "accountId": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b", "name": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b", "key": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b", "emailAddress": "fred@example.com", "displayName": "Fred F. User", "active": true, "timeZone": "Australia/Sydney", "_links": { "jiraRest": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b", "avatarUrls": { "16x16": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue", "24x24": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue", "32x32": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue", "48x48": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue" }, "self": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b" } }, "requestFieldValues": [ { "fieldId": "summary", "label": "What do you need?", "value": "Request JSD help via REST" }, { "fieldId": "description", "label": "Why do you need this?", "renderedValue": { "html": "<p>I need a new <b>mouse</b> for my Mac</p>" }, "value": "I need a new *mouse* for my Mac" } ], "currentStatus": { "status": "Waiting for Support", "statusCategory": "NEW", "statusDate": { "epochMillis": 1444287660000, "friendly": "Today 14:01 PM", "iso8601": "2015-10-08T14:01:00+0700", "jira": "2015-10-08T14:01:00.000+0700" } }, "_links": { "jiraRest": "https://your-domain.atlassian.net/rest/api/2/issue/107001", "web": "https://your-domain.atlassian.net/servicedesk/customer/portal/10/HELPDESK-1", "self": "https://your-domain.atlassian.net/rest/servicedeskapi/request/107001", "agent": "https://your-domain.atlassian.net/browse/HELPDESK-1" } }, { "_expands": [ "participant", "status", "sla", "requestType", "serviceDesk", "attachment", "action", "comment" ], "issueId": "107002", "issueKey": "HELPDESK-2", "requestTypeId": "25", "serviceDeskId": "10", "createdDate": { "epochMillis": 1444289400000, "friendly": "Monday 14:30 PM", "iso8601": "2015-10-08T14:30:00+0700", "jira": "2015-10-08T14:30:00.000+0700" }, "reporter": { "accountId": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b", "name": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b", "key": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b", "emailAddress": "fred@example.com", "displayName": "Fred F. User", "active": true, "timeZone": "Australia/Sydney", "_links": { "jiraRest": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b", "avatarUrls": { "16x16": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue", "24x24": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue", "32x32": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue", "48x48": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue" }, "self": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b" } }, "requestFieldValues": [ { "fieldId": "summary", "label": "What do you need?", "value": "Request a new account" }, { "fieldId": "description", "label": "Why do you need this?", "value": "Create an account on Jira" } ], "currentStatus": { "status": "Waiting for Support", "statusCategory": "NEW", "statusDate": { "epochMillis": 1444287660000, "friendly": "Today 14:01 PM", "iso8601": "2015-10-08T14:01:00+0700", "jira": "2015-10-08T14:01:00.000+0700" } }, "_links": { "jiraRest": "https://your-domain.atlassian.net/rest/api/2/issue/107002", "web": "https://your-domain.atlassian.net/servicedesk/customer/portal/10/HELPDESK-2", "self": "https://your-domain.atlassian.net/rest/servicedeskapi/request/107002", "agent": "https://your-domain.atlassian.net/browse/HELPDESK-2" } }, { "_expands": [ "participant", "status", "sla", "requestType", "serviceDesk", "attachment", "action", "comment" ], "issueId": "109006", "issueKey": "SIMPLEDESK-6", "requestTypeId": "33", "serviceDeskId": "12", "createdDate": { "epochMillis": 1444030200000, "friendly": "Monday 14:30 PM", "iso8601": "2015-10-05T14:30:00+0700", "jira": "2015-10-05T14:30:00.000+0700" }, "reporter": { "accountId": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b", "name": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b", "key": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b", "emailAddress": "fred@example.com", "displayName": "Fred F. User", "active": true, "timeZone": "Australia/Sydney", "_links": { "jiraRest": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b", "avatarUrls": { "16x16": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue", "24x24": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue", "32x32": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue", "48x48": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue" }, "self": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b" } }, "requestFieldValues": [ { "fieldId": "summary", "label": "Summarize the problem", "value": "Printer on level 3 did not work" }, { "fieldId": "description", "value": "Ink cartridge is empty" } ], "currentStatus": { "status": "Waiting for Support", "statusCategory": "NEW", "statusDate": { "epochMillis": 1444287600000, "friendly": "Today 14:00 PM", "iso8601": "2015-10-08T14:00:00+0700", "jira": "2015-10-08T14:00:00.000+0700" } }, "_links": { "jiraRest": "https://your-domain.atlassian.net/rest/api/2/issue/109006", "web": "https://your-domain.atlassian.net/servicedesk/customer/portal/12/SIMPLEDESK-6", "self": "https://your-domain.atlassian.net/rest/servicedeskapi/request/109006", "agent": "https://your-domain.atlassian.net/browse/SIMPLEDESK-6" } } ] }
POST

Create customer request

This method creates a customer request in a service desk.

The JSON request must include the service desk and customer request type, as well as any fields that are required for the request type. A list of the fields required by a customer request type can be obtained using servicedesk/{serviceDeskId}/requesttype/{requestTypeId}/field.

The fields required for a customer request type depend on the user's permissions:

  • raiseOnBehalfOf is not available to Users who have the customer permission only.
  • requestParticipants is not available to Users who have the customer permission only or if the feature is turned off for customers.

requestFieldValues is a map of Jira field IDs and their values. See Field input formats, for details of each field's JSON semantics and the values they can take.

Permissions required: Permission to create requests in the specified service desk.

Data Security Policy: Not exempt from app access rules
Scopes

Connect app scope requiredWRITE

ClassicRECOMMENDED:write:servicedesk-request
Granular:read:request:jira-service-management, write:request:jira-service-management, read:user:jira

Request

Request bodyapplication/json

channel

string

form

Form

isAdfRequest

boolean

raiseOnBehalfOf

string

requestFieldValues

object

requestParticipants

array<string>

requestTypeId

string

serviceDeskId

string

Responses

Returned if the customer request was created.

application/json

CustomerRequestDTO
POST/rest/servicedeskapi/request
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 curl --request POST \ --url 'https://your-domain.atlassian.net/rest/servicedeskapi/request' \ --header 'Authorization: Bearer <access_token>' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "form": { "answers": { "1": { "text": "Answer to a text form field" }, "2": { "date": "2023-07-06" }, "3": { "time": "14:35" }, "4": { "choices": [ "5" ] }, "5": { "users": [ "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d69abfa3980ce712caae" ] } } }, "isAdfRequest": false, "requestFieldValues": { "description": "I need a new *mouse* for my Mac", "summary": "Request JSD help via REST" }, "requestParticipants": [ "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d69abfa3980ce712caae" ], "requestTypeId": "25", "serviceDeskId": "10" }'
201Response
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 { "_expands": [ "participant", "status", "sla", "requestType", "serviceDesk", "attachment", "action", "comment" ], "issueId": "107001", "issueKey": "HELPDESK-1", "requestTypeId": "25", "serviceDeskId": "10", "createdDate": { "epochMillis": 1444290120000, "friendly": "Monday 14:42 PM", "iso8601": "2015-10-08T14:42:00+0700", "jira": "2015-10-08T14:42:00.000+0700" }, "reporter": { "accountId": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b", "name": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b", "key": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b", "emailAddress": "fred@example.com", "displayName": "Fred F. User", "active": true, "timeZone": "Australia/Sydney", "_links": { "jiraRest": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b", "avatarUrls": { "16x16": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue", "24x24": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue", "32x32": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue", "48x48": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue" }, "self": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b" } }, "requestFieldValues": [ { "fieldId": "summary", "label": "What do you need?", "value": "Request JSD help via REST" }, { "fieldId": "description", "label": "Why do you need this?", "renderedValue": { "html": "<p>I need a new <b>mouse</b> for my Mac</p>" }, "value": "I need a new *mouse* for my Mac" } ], "currentStatus": { "status": "Waiting for Support", "statusCategory": "NEW", "statusDate": { "epochMillis": 1444287660000, "friendly": "Today 14:01 PM", "iso8601": "2015-10-08T14:01:00+0700", "jira": "2015-10-08T14:01:00.000+0700" } }, "_links": { "jiraRest": "https://your-domain.atlassian.net/rest/api/2/issue/107001", "web": "https://your-domain.atlassian.net/servicedesk/customer/portal/10/HELPDESK-1", "self": "https://your-domain.atlassian.net/rest/servicedeskapi/request/107001", "agent": "https://your-domain.atlassian.net/browse/HELPDESK-1" } }
GET

Get customer request by id or key

This method returns a customer request.

Permissions required: Permission to access the specified service desk.

Response limitations: For customers, only a request they created, was created on their behalf, or they are participating in will be returned.

Note: requestFieldValues does not include hidden fields. To get a list of request type fields that includes hidden fields, see /rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttype/{requestTypeId}/field

Data Security Policy: Not exempt from app access rules
Scopes

Connect app scope requiredREAD

ClassicRECOMMENDED:read:servicedesk-request
Granular:read:request:jira-service-management, read:user:jira

Request

Path parameters

issueIdOrKey

string

Required

Query parameters

expand

array<string>

Responses

Returns the customer request.

application/json

CustomerRequestDTO
GET/rest/servicedeskapi/request/{issueIdOrKey}
1 2 3 4 curl --request GET \ --url 'https://your-domain.atlassian.net/rest/servicedeskapi/request/{issueIdOrKey}' \ --header 'Authorization: Bearer <access_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 { "_expands": [ "participant", "status", "sla", "requestType", "serviceDesk", "attachment", "action", "comment" ], "issueId": "107001", "issueKey": "HELPDESK-1", "requestTypeId": "25", "serviceDeskId": "10", "createdDate": { "epochMillis": 1444290120000, "friendly": "Monday 14:42 PM", "iso8601": "2015-10-08T14:42:00+0700", "jira": "2015-10-08T14:42:00.000+0700" }, "reporter": { "accountId": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b", "name": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b", "key": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b", "emailAddress": "fred@example.com", "displayName": "Fred F. User", "active": true, "timeZone": "Australia/Sydney", "_links": { "jiraRest": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b", "avatarUrls": { "16x16": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue", "24x24": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue", "32x32": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue", "48x48": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue" }, "self": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b" } }, "requestFieldValues": [ { "fieldId": "summary", "label": "What do you need?", "value": "Request JSD help via REST" }, { "fieldId": "description", "label": "Why do you need this?", "renderedValue": { "html": "<p>I need a new <b>mouse</b> for my Mac</p>" }, "value": "I need a new *mouse* for my Mac" } ], "currentStatus": { "status": "Waiting for Support", "statusCategory": "NEW", "statusDate": { "epochMillis": 1444287660000, "friendly": "Today 14:01 PM", "iso8601": "2015-10-08T14:01:00+0700", "jira": "2015-10-08T14:01:00.000+0700" } }, "_links": { "jiraRest": "https://your-domain.atlassian.net/rest/api/2/issue/107001", "web": "https://your-domain.atlassian.net/servicedesk/customer/portal/10/HELPDESK-1", "self": "https://your-domain.atlassian.net/rest/servicedeskapi/request/107001", "agent": "https://your-domain.atlassian.net/browse/HELPDESK-1" } }
GET

Get approvals

This method returns all approvals on a customer request.

Permissions required: Permission to view the customer request.

Data Security Policy: Not exempt from app access rules
Scopes

Connect app scope requiredREAD

ClassicRECOMMENDED:read:servicedesk-request
Granular:read:request.approval:jira-service-management, read:user:jira

Request

Path parameters

issueIdOrKey

string

Required

Query parameters

start

integer

limit

integer

Responses

Returns the customer request's approvals.

application/json

PagedDTOApprovalDTO
GET/rest/servicedeskapi/request/{issueIdOrKey}/approval
1 2 3 4 curl --request GET \ --url 'https://your-domain.atlassian.net/rest/servicedeskapi/request/{issueIdOrKey}/approval' \ --header 'Authorization: Bearer <access_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 { "_expands": [], "size": 3, "start": 3, "limit": 3, "isLastPage": false, "_links": { "base": "https://your-domain.atlassian.net/rest/servicedeskapi", "context": "context", "next": "https://your-domain.atlassian.net/rest/servicedeskapi/request/2/approval?start=6&limit=3", "prev": "https://your-domain.atlassian.net/rest/servicedeskapi/request/2/approval?start=0&limit=3" }, "values": [ { "id": "1", "name": "Please approve this request", "finalDecision": "approved", "canAnswerApproval": false, "approvers": [ { "approver": { "accountId": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b", "name": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b", "key": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b", "emailAddress": "fred@example.com", "displayName": "Fred F. User", "active": true, "timeZone": "Australia/Sydney", "_links": { "jiraRest": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b", "avatarUrls": { "16x16": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue", "24x24": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue", "32x32": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue", "48x48": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue" }, "self": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b" } }, "approverDecision": "approved" } ], "createdDate": { "epochMillis": 1475046060000, "friendly": "Monday 14:01 PM", "iso8601": "2016-09-28T14:01:00+0700", "jira": "2016-09-28T14:01:00.000+0700" }, "completedDate": { "epochMillis": 1475134200000, "friendly": "Today 14:30 PM", "iso8601": "2016-09-29T14:30:00+0700", "jira": "2016-09-29T14:30:00.000+0700" }, "_links": { "self": "https://your-domain.atlassian.net/rest/servicedeskapi/request/2/approval/1" } }, { "id": "2", "name": "Waiting for approval", "finalDecision": "declined", "canAnswerApproval": false, "approvers": [ { "approver": { "accountId": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b", "name": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b", "key": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b", "emailAddress": "fred@example.com", "displayName": "Fred F. User", "active": true, "timeZone": "Australia/Sydney", "_links": { "jiraRest": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b", "avatarUrls": { "16x16": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue", "24x24": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue", "32x32": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue", "48x48": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue" }, "self": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b" } }, "approverDecision": "approved" } ], "createdDate": { "epochMillis": 1475650860000, "friendly": "Wednesday 14:01 PM", "iso8601": "2016-10-05T14:01:00+0700", "jira": "2016-10-05T14:01:00.000+0700" }, "completedDate": { "epochMillis": 1475739000000, "friendly": "Thursday 14:30 PM", "iso8601": "2016-10-06T14:30:00+0700", "jira": "2016-10-06T14:30:00.000+0700" }, "_links": { "self": "https://your-domain.atlassian.net/rest/servicedeskapi/request/2/approval/2" } } ] }
GET

Get approval by id

This method returns an approval. Use this method to determine the status of an approval and the list of approvers.

Permissions required: Permission to view the customer request.

Data Security Policy: Not exempt from app access rules
Scopes

Connect app scope requiredREAD

ClassicRECOMMENDED:read:servicedesk-request
Granular:read:request.approval:jira-service-management, read:user:jira

Request

Path parameters

issueIdOrKey

string

Required
approvalId

integer

Required

Responses

Returns the requested approval.

application/json

ApprovalDTO
GET/rest/servicedeskapi/request/{issueIdOrKey}/approval/{approvalId}
1 2 3 4 curl --request GET \ --url 'https://your-domain.atlassian.net/rest/servicedeskapi/request/{issueIdOrKey}/approval/{approvalId}' \ --header 'Authorization: Bearer <access_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 { "id": "1", "name": "Please approve this request", "finalDecision": "approved", "canAnswerApproval": false, "approvers": [ { "approver": { "accountId": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b", "name": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b", "key": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b", "emailAddress": "fred@example.com", "displayName": "Fred F. User", "active": true, "timeZone": "Australia/Sydney", "_links": { "jiraRest": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b", "avatarUrls": { "16x16": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue", "24x24": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue", "32x32": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue", "48x48": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue" }, "self": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b" } }, "approverDecision": "approved" } ], "createdDate": { "epochMillis": 1475046060000, "friendly": "Monday 14:01 PM", "iso8601": "2016-09-28T14:01:00+0700", "jira": "2016-09-28T14:01:00.000+0700" }, "completedDate": { "epochMillis": 1475134200000, "friendly": "Today 14:30 PM", "iso8601": "2016-09-29T14:30:00+0700", "jira": "2016-09-29T14:30:00.000+0700" }, "_links": { "self": "https://your-domain.atlassian.net/rest/servicedeskapi/request/2/approval/1" } }
POST

Answer approval

This method enables a user to Approve or Decline an approval on a customer request. The approval is assumed to be owned by the user making the call.

Permissions required: User is assigned to the approval request.

Data Security Policy: Not exempt from app access rules
Scopes

Connect app scope requiredWRITE

ClassicRECOMMENDED:write:servicedesk-request
Granular:read:request.approval:jira-service-management, write:request.approval:jira-service-management, read:user:jira

Request

Path parameters

issueIdOrKey

string

Required
approvalId

integer

Required

Request bodyapplication/json

decision

string

Responses

Returns the updated approval.

application/json

ApprovalDTO
POST/rest/servicedeskapi/request/{issueIdOrKey}/approval/{approvalId}
1 2 3 4 5 6 7 8 curl --request POST \ --url 'https://your-domain.atlassian.net/rest/servicedeskapi/request/{issueIdOrKey}/approval/{approvalId}' \ --header 'Authorization: Bearer <access_token>' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "decision": "approve" }'
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 { "id": "1", "name": "Please approve this request", "finalDecision": "approved", "canAnswerApproval": false, "approvers": [ { "approver": { "accountId": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b", "name": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b", "key": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b", "emailAddress": "fred@example.com", "displayName": "Fred F. User", "active": true, "timeZone": "Australia/Sydney", "_links": { "jiraRest": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b", "avatarUrls": { "16x16": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue", "24x24": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue", "32x32": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue", "48x48": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue" }, "self": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b" } }, "approverDecision": "approved" } ], "createdDate": { "epochMillis": 1475046060000, "friendly": "Monday 14:01 PM", "iso8601": "2016-09-28T14:01:00+0700", "jira": "2016-09-28T14:01:00.000+0700" }, "completedDate": { "epochMillis": 1475134200000, "friendly": "Today 14:30 PM", "iso8601": "2016-09-29T14:30:00+0700", "jira": "2016-09-29T14:30:00.000+0700" }, "_links": { "self": "https://your-domain.atlassian.net/rest/servicedeskapi/request/2/approval/1" } }
GET

Get attachments for request

This method returns all the attachments for a customer requests.

Permissions required: Permission to view the customer request.

Response limitations: Customers will only get a list of public attachments.

Data Security Policy: Not exempt from app access rules
Scopes

Connect app scope requiredREAD

ClassicRECOMMENDED:read:servicedesk-request
Granular:read:request.attachment:jira-service-management, read:user:jira

Request

Path parameters

issueIdOrKey

string

Required

Query parameters

start

integer

Required
limit

integer

Required

Responses

Returns the visible attachments from the customer request.

application/json

PagedDTOAttachmentDTO
GET/rest/servicedeskapi/request/{issueIdOrKey}/attachment
1 2 3 4 curl --request GET \ --url 'https://your-domain.atlassian.net/rest/servicedeskapi/request/{issueIdOrKey}/attachment?start={start}&limit={limit}' \ --header 'Authorization: Bearer <access_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 { "_expands": [], "size": 2, "start": 2, "limit": 2, "isLastPage": false, "_links": { "base": "https://your-domain.atlassian.net/rest/servicedeskapi", "context": "context", "next": "https://your-domain.atlassian.net/rest/servicedeskapi/request/IT-15/comment/1001/attachment?start=4&limit=2", "prev": "https://your-domain.atlassian.net/rest/servicedeskapi/request/IT-15/comment/1001/attachment?start=0&limit=2" }, "values": [ { "filename": "screenshot.png", "author": { "accountId": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b", "name": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b", "key": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b", "emailAddress": "fred@example.com", "displayName": "Fred F. User", "active": true, "timeZone": "Australia/Sydney", "_links": { "jiraRest": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b", "avatarUrls": { "16x16": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue", "24x24": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue", "32x32": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue", "48x48": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue" }, "self": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b" } }, "created": { "epochMillis": 1444360920000, "friendly": "Today 10:22 AM", "iso8601": "2015-10-09T10:22:00+0700", "jira": "2015-10-09T10:22:00.000+0700" }, "size": 23123, "mimeType": "image/png", "_links": { "jiraRest": "https://your-domain.atlassian.net/rest/api/2/attachment/10000", "content": "https://your-domain.atlassian.net/servicedesk/customershim/secure/attachment/10000/screenshot.png", "thumbnail": "https://your-domain.atlassian.net/servicedesk/customershim/secure/thumbnail/10000/_thumb_10000.png" } }, { "filename": "log.txt", "author": { "accountId": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b", "name": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b", "key": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b", "emailAddress": "fred@example.com", "displayName": "Fred F. User", "active": true, "timeZone": "Australia/Sydney", "_links": { "jiraRest": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b", "avatarUrls": { "16x16": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue", "24x24": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue", "32x32": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue", "48x48": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue" }, "self": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b" } }, "created": { "epochMillis": 1444360920000, "friendly": "Today 10:22 AM", "iso8601": "2015-10-09T10:22:00+0700", "jira": "2015-10-09T10:22:00.000+0700" }, "size": 32132, "mimeType": "text/plain", "_links": { "jiraRest": "https://your-domain.atlassian.net/rest/api/2/attachment/10001", "content": "https://your-domain.atlassian.net/servicedesk/customershim/secure/attachment/10001/log.txt" } } ] }
POST

Create comment with attachment

This method creates a comment on a customer request using one or more attachment files (uploaded using servicedeskapi/servicedesk/{serviceDeskId}/attachTemporaryFile), with the visibility set by public. See

Permissions required: Permission to add an attachment.

Request limitations: Customers can set public visibility only.

Data Security Policy: Not exempt from app access rules
Scopes

Connect app scope requiredWRITE

ClassicRECOMMENDED:write:servicedesk-request
Granular:read:request.attachment:jira-service-management, write:request.attachment:jira-service-management, read:user:jira

Request

Path parameters

issueIdOrKey

string

Required

Request bodyapplication/json

additionalComment

AdditionalCommentDTO

public

boolean

temporaryAttachmentIds

array<string>

Responses

Returns the attachments and comment.

application/json

AttachmentCreateResultDTO
POST/rest/servicedeskapi/request/{issueIdOrKey}/attachment
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 curl --request POST \ --url 'https://your-domain.atlassian.net/rest/servicedeskapi/request/{issueIdOrKey}/attachment' \ --header 'Authorization: Bearer <access_token>' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "additionalComment": { "body": "Please find the screenshot and the log file attached." }, "public": true, "temporaryAttachmentIds": [ "temp910441317820424274", "temp3600755449679003114" ] }'
201Response
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 { "comment": { "_expands": [ "attachment", "renderedBody" ], "id": "1000", "body": "Please find the screenshot and the log file attached. !screenshot.png|thumbnail! [^log.txt] _(32 kB)_", "public": true, "author": { "accountId": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b", "name": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b", "key": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b", "emailAddress": "fred@example.com", "displayName": "Fred F. User", "active": true, "timeZone": "Australia/Sydney", "_links": { "jiraRest": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b", "avatarUrls": { "16x16": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue", "24x24": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue", "32x32": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue", "48x48": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue" }, "self": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b" } }, "created": { "epochMillis": 1444360920000, "friendly": "Today 10:22 AM", "iso8601": "2015-10-09T10:22:00+0700", "jira": "2015-10-09T10:22:00.000+0700" }, "_links": { "self": "https://your-domain.atlassian.net/rest/servicedeskapi/request/2000/comment/1000" } }, "attachments": { "_expands": [], "size": 2, "start": 2, "limit": 2, "isLastPage": false, "_links": { "base": "https://your-domain.atlassian.net/rest/servicedeskapi", "context": "context", "next": "https://your-domain.atlassian.net/rest/servicedeskapi/request/IT-15/comment/1001/attachment?start=4&limit=2", "prev": "https://your-domain.atlassian.net/rest/servicedeskapi/request/IT-15/comment/1001/attachment?start=0&limit=2" }, "values": [ { "filename": "screenshot.png", "author": { "accountId": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b", "name": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b", "key": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b", "emailAddress": "fred@example.com", "displayName": "Fred F. User", "active": true, "timeZone": "Australia/Sydney", "_links": { "jiraRest": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b", "avatarUrls": { "16x16": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue", "24x24": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue", "32x32": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue", "48x48": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue" }, "self": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b" } }, "created": { "epochMillis": 1444360920000, "friendly": "Today 10:22 AM", "iso8601": "2015-10-09T10:22:00+0700", "jira": "2015-10-09T10:22:00.000+0700" }, "size": 23123, "mimeType": "image/png", "_links": { "jiraRest": "https://your-domain.atlassian.net/rest/api/2/attachment/10000", "content": "https://your-domain.atlassian.net/servicedesk/customershim/secure/attachment/10000/screenshot.png", "thumbnail": "https://your-domain.atlassian.net/servicedesk/customershim/secure/thumbnail/10000/_thumb_10000.png" } }, { "filename": "log.txt", "author": { "accountId": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b", "name": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b", "key": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b", "emailAddress": "fred@example.com", "displayName": "Fred F. User", "active": true, "timeZone": "Australia/Sydney", "_links": { "jiraRest": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b", "avatarUrls": { "16x16": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue", "24x24": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue", "32x32": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue", "48x48": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue" }, "self": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b" } }, "created": { "epochMillis": 1444360920000, "friendly": "Today 10:22 AM", "iso8601": "2015-10-09T10:22:00+0700", "jira": "2015-10-09T10:22:00.000+0700" }, "size": 32132, "mimeType": "text/plain", "_links": { "jiraRest": "https://your-domain.atlassian.net/rest/api/2/attachment/10001", "content": "https://your-domain.atlassian.net/servicedesk/customershim/secure/attachment/10001/log.txt" } } ] } }
GET

Get attachment content

Returns the contents of an attachment.

To return a thumbnail of the attachment, use servicedeskapi/request/{issueIdOrKey}/attachment/{attachmentId}/thumbnail.

Permissions required: For the issue containing the attachment:

Data Security Policy: Not exempt from app access rules
Scopes

Connect app scope requiredREAD

ClassicRECOMMENDED:read:servicedesk-request
Granular:read:request.attachment:jira-service-management, read:user:jira

Request

Path parameters

issueIdOrKey

string