Class RequestService

See

https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request

Hierarchy

CommonHttpService
- RequestService

Constructors

constructor

new RequestService(getClientInstance): RequestService
Internal
Create a new instance of the service.
Parameters
- getClientInstance: (() => CommonHttpClient)
  - - (): CommonHttpClient
    - Returns CommonHttpClient
Returns RequestService
Inherited from CommonHttpService.constructor

Methods

addRequestParticipants

addRequestParticipants(params): Promise<PagedDtoUserDto>

This method adds participants to a customer request.

Permissions required: Permission to manage participants on the customer request.

Note, participants can be added when creating a customer request using the request resource, by defining the participants in the requestParticipants field.

Parameters

params: {
issueIdOrKey: string;
requestParticipantUpdateDto: RequestParticipantUpdateDto;
}
- issueIdOrKey: string
  The ID or key of the customer request to have participants added.
- requestParticipantUpdateDto: RequestParticipantUpdateDto
  Example

Returns Promise<PagedDtoUserDto>

Returns the participants added to the customer request.

example:

{
  "_expands": [],
  "size": 1,
  "start": 1,
  "limit": 1,
  "isLastPage": false,
  "_links": {
    "base": "https://your-domain.atlassian.net/rest/servicedeskapi",
    "context": "context",
    "next": "https://your-domain.atlassian.net/rest/servicedeskapi/request/1000/participant?start=2&limit=1",
    "prev": "https://your-domain.atlassian.net/rest/servicedeskapi/request/1000/participant?start=0&limit=1"
  },
  "values": [
    {
      "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"
      }
    }
  ]
}

Path

POST /rest/servicedeskapi/request/{issueIdOrKey}/participant @scopes-current write:servicedesk-request @scopes-beta read:request.participant:jira-service-management, write:request.participant:jira-service-management, read:user:jira

See

https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-issueidorkey-participant-post

answerApproval

answerApproval(params): Promise<ApprovalDto>

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.

Parameters

params: {
    approvalDecisionRequestDto: ApprovalDecisionRequestDto;
    approvalId: number;
    issueIdOrKey: string;
}
- approvalDecisionRequestDto: ApprovalDecisionRequestDto
  Example
- approvalId: number
  The ID of the approval to be updated.
- issueIdOrKey: string
  The ID or key of the customer request to be updated.

Returns Promise<ApprovalDto>

Returns the updated approval.

example:

{
  "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"
  }
}

Path

POST /rest/servicedeskapi/request/{issueIdOrKey}/approval/{approvalId} @scopes-current write:servicedesk-request @scopes-beta read:request.approval:jira-service-management, write:request.approval:jira-service-management, read:user:jira

See

https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-issueidorkey-approval-approvalid-post

createCommentWithAttachment

createCommentWithAttachment(params): Promise<AttachmentCreateResultDto>

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

GET servicedeskapi/request/{issueIdOrKey}/attachment
GET servicedeskapi/request/{issueIdOrKey}/comment/{commentId}/attachment

Permissions required: Permission to add an attachment.

Request limitations: Customers can set public visibility only.

Parameters

params: {
attachmentCreateDto: AttachmentCreateDto;
issueIdOrKey: string;
}
- attachmentCreateDto: AttachmentCreateDto
  Example
- issueIdOrKey: string
  The ID or key of the customer request to which the attachment will be added.

Returns Promise<AttachmentCreateResultDto>

Returns the attachments and comment.

example:

{
  "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"
        }
      }
    ]
  }
}

Path

POST /rest/servicedeskapi/request/{issueIdOrKey}/attachment @scopes-current write:servicedesk-request @scopes-beta read:request.attachment:jira-service-management, write:request.attachment:jira-service-management, read:user:jira

See

https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-issueidorkey-attachment-post

createCustomerRequest

createCustomerRequest(params): Promise<CustomerRequestDto>

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.

Parameters

params: {
requestCreateDto: RequestCreateDto;
}
- requestCreateDto: RequestCreateDto
  Example

Returns Promise<CustomerRequestDto>

Returned if the customer request was created.

example:

{
  "_expands": [
    "participant",
    "status",
    "sla",
    "requestType",
    "serviceDesk",
    "attachment",
    "action",
    "comment"
  ],
  "issueId": "107001",
  "issueKey": "HELPDESK-1",
  "summary": "Request JSD help via REST",
  "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",
    "agent": "https://your-domain.atlassian.net/browse/HELPDESK-1",
    "self": "https://your-domain.atlassian.net/rest/servicedeskapi/request/107001"
  }
}

Path

POST /rest/servicedeskapi/request @scopes-current write:servicedesk-request @scopes-beta read:request:jira-service-management, write:request:jira-service-management, read:user:jira

See

https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-post

createRequestComment

createRequestComment(params): Promise<CommentDto>

This method creates a public or private (internal) comment on a customer request, with the comment visibility set by public. The user recorded as the author of the comment.

Permissions required: User has Add Comments permission.

Request limitations: Customers can set comments to public visibility only.

Parameters

params: {
commentCreateDto: CommentCreateDto;
issueIdOrKey: string;
}
- commentCreateDto: CommentCreateDto
  Example
- issueIdOrKey: string
  The ID or key of the customer request to which the comment will be added.

Returns Promise<CommentDto>

Returns the comment.

example:

{
  "_expands": [
    "attachment",
    "renderedBody"
  ],
  "id": "1000",
  "body": "Hello there",
  "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"
  }
}

Path

POST /rest/servicedeskapi/request/{issueIdOrKey}/comment @scopes-current write:servicedesk-request @scopes-beta read:request.comment:jira-service-management, write:request.comment:jira-service-management, read:user:jira

See

https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-issueidorkey-comment-post

deleteFeedback

deleteFeedback(params): Promise<void>
This method deletes the feedback of request using it's requestKey or requestId

Permissions required: User must be the reporter or an Atlassian Connect app.
Parameters
- params: {
  requestIdOrKey: string;
  }
  - requestIdOrKey: string
    The id or the key of the request to post the feedback on
Returns Promise<void>
No content.

Path
DELETE /rest/servicedeskapi/request/{requestIdOrKey}/feedback @scopes-current write:servicedesk-request @scopes-beta read:request.feedback:jira-service-management, delete:request.feedback:jira-service-management, read:user:jira

See
https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-requestidorkey-feedback-delete

getApprovalById

getApprovalById(params): Promise<ApprovalDto>

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.

Parameters

params: {
approvalId: number;
issueIdOrKey: string;
}
- approvalId: number
  The ID of the approval to be returned.
- issueIdOrKey: string
  The ID or key of the customer request the approval is on.

Returns Promise<ApprovalDto>

Returns the requested approval.

example:

{
  "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"
  }
}

Path

GET /rest/servicedeskapi/request/{issueIdOrKey}/approval/{approvalId} @scopes-current read:servicedesk-request @scopes-beta read:request.approval:jira-service-management, read:user:jira

See

https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-issueidorkey-approval-approvalid-get

getApprovals

getApprovals(params): Promise<PagedDtoApprovalDto>

This method returns all approvals on a customer request.

Permissions required: Permission to view the customer request.

Parameters

params: {
    issueIdOrKey: string;
    limit?: number;
    start?: number;
}
- issueIdOrKey: string
  The ID or key of the customer request to be queried for its approvals.
- Optionallimit?: number
  The maximum number of approvals to return per page. Default: 50. See the Pagination section for more details.
- Optionalstart?: number
  The starting index of the returned objects. Base index: 0. See the Pagination section for more details.

Returns Promise<PagedDtoApprovalDto>

Returns the customer request's approvals.

example:

{
  "_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"
      }
    }
  ]
}

Path

GET /rest/servicedeskapi/request/{issueIdOrKey}/approval @scopes-current read:servicedesk-request @scopes-beta read:request.approval:jira-service-management, read:user:jira

See

https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-issueidorkey-approval-get

getAttachmentContent

getAttachmentContent(params): Promise<unknown>
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:
- Browse projects project permission for the project that the issue is in.
- If issue-level security is configured, issue-level security permission to view the issue.
Parameters
- params: {
  attachmentId: number;
  issueIdOrKey: string;
  }
  - attachmentId: number
    The ID for the attachment
  - issueIdOrKey: string
    The ID or key for the customer request the attachment is associated with
Returns Promise<unknown>
200 response

Path
GET /rest/servicedeskapi/request/{issueIdOrKey}/attachment/{attachmentId} @scopes-current read:servicedesk-request @scopes-beta read:request.attachment:jira-service-management, read:user:jira

See
https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-issueidorkey-attachment-attachmentid-get

getAttachmentsForRequest

getAttachmentsForRequest(params): Promise<PagedDtoAttachmentDto>

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.

Parameters

params: {
    issueIdOrKey: string;
    limit: number;
    start: number;
}
- issueIdOrKey: string
  The ID or key of the customer request from which the attachments will be listed.
- limit: number
  The maximum number of comments to return per page. Default: 50. See the Pagination section for more details.
- start: number
  The starting index of the returned attachment. Base index: 0. See the Pagination section for more details.

Returns Promise<PagedDtoAttachmentDto>

Returns the visible attachments from the customer request.

example:

{
  "_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"
      }
    }
  ]
}

Path

GET /rest/servicedeskapi/request/{issueIdOrKey}/attachment @scopes-current read:servicedesk-request @scopes-beta read:request.attachment:jira-service-management, read:user:jira

See

https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-issueidorkey-attachment-get

getAttachmentThumbnail

getAttachmentThumbnail(params): Promise<unknown>
Returns the thumbnail of an attachment.

To return the attachment contents, use servicedeskapi/request/{issueIdOrKey}/attachment/{attachmentId}.

Permissions required: For the issue containing the attachment:
- Browse projects project permission for the project that the issue is in.
- If issue-level security is configured, issue-level security permission to view the issue.
Parameters
- params: {
  attachmentId: number;
  issueIdOrKey: string;
  }
  - attachmentId: number
    The ID of the attachment.
  - issueIdOrKey: string
    The ID or key for the customer request the attachment is associated with
Returns Promise<unknown>
200 response

Path
GET /rest/servicedeskapi/request/{issueIdOrKey}/attachment/{attachmentId}/thumbnail @scopes-current read:servicedesk-request @scopes-beta read:request.attachment:jira-service-management, read:user:jira

See
https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-issueidorkey-attachment-attachmentid-thumbnail-get

getCommentAttachments

getCommentAttachments(params): Promise<PagedDtoAttachmentDto>

This method returns the attachments referenced in a comment.

Permissions required: Permission to view the customer request.

Response limitations: Customers can only view public comments, and retrieve their attachments, on requests where they are the reporter or a participant whereas agents can see both internal and public comments.

Parameters

params: {
    commentId: number;
    issueIdOrKey: string;
    limit?: number;
    start?: number;
}
- commentId: number
  The ID of the comment.
- issueIdOrKey: string
  The ID or key of the customer request that contains the comment.
- Optionallimit?: number
  The maximum number of comments to return per page. Default: 50. See the Pagination section for more details.
- Optionalstart?: number
  The starting index of the returned comments. Base index: 0. See the Pagination section for more details.

Returns Promise<PagedDtoAttachmentDto>

Returns the attachments, on the specified page of the results.

example:

{
  "_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"
      }
    }
  ]
}

Path

GET /rest/servicedeskapi/request/{issueIdOrKey}/comment/{commentId}/attachment

See

https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-issueidorkey-comment-commentid-attachment-get

getCustomerRequestByIdOrKey

getCustomerRequestByIdOrKey(params): Promise<CustomerRequestDto>

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

Parameters

params: {
expand?: string[];
issueIdOrKey: string;
}
- Optionalexpand?: string[]
  A multi-value parameter indicating which properties of the customer request to expand, where:
  - serviceDesk returns additional service desk details.
  - requestType returns additional customer request type details.
  - participant returns the participant details.
  - sla returns the SLA information.
  - status returns the status transitions, in chronological order.
  - attachment returns the attachments.
  - action returns the actions that the user can or cannot perform.
  - comment returns the comments.
  - comment.attachment returns the attachment details for each comment.
  - comment.renderedBody (Experimental) return the rendered body in HTML format (in addition to the raw body) for each comment.
- issueIdOrKey: string
  The ID or Key of the customer request to be returned

Returns Promise<CustomerRequestDto>

Returns the customer request.

example:

{
  "_expands": [
    "participant",
    "status",
    "sla",
    "requestType",
    "serviceDesk",
    "attachment",
    "action",
    "comment"
  ],
  "issueId": "107001",
  "issueKey": "HELPDESK-1",
  "summary": "Request JSD help via REST",
  "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",
    "agent": "https://your-domain.atlassian.net/browse/HELPDESK-1",
    "self": "https://your-domain.atlassian.net/rest/servicedeskapi/request/107001"
  }
}

Path

GET /rest/servicedeskapi/request/{issueIdOrKey} @scopes-current read:servicedesk-request @scopes-beta read:request:jira-service-management, read:user:jira

See

https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-issueidorkey-get

getCustomerRequests

getCustomerRequests(params?): Promise<PagedDtoCustomerRequestDto>

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.

Parameters

params: {
    approvalStatus?: string;
    expand?: string[];
    limit?: number;
    organizationId?: number;
    requestOwnership?: string[];
    requestStatus?: string;
    requestTypeId?: number;
    searchTerm?: string;
    serviceDeskId?: number;
    start?: number;
} = {}
- OptionalapprovalStatus?: string
  Filters results to customer requests based on their approval status:
  - MY_PENDING_APPROVAL returns customer requests pending the user's approval.
  - MY_HISTORY_APPROVAL returns customer requests where the user was an approver.
  Note: Valid only when used with requestOwnership=APPROVER.
- Optionalexpand?: string[]
  A multi-value parameter indicating which properties of the customer request to expand, where:
  - serviceDesk returns additional details for each service desk.
  - requestType returns additional details for each request type.
  - participant returns the participant details, if any, for each customer request.
  - sla returns the SLA information on each customer request.
  - status returns the status transitions, in chronological order, for each customer request.
  - attachment returns the attachments for the customer request.
  - action returns the actions that the user can or cannot perform on this customer request.
  - comment returns the comments, if any, for each customer request.
  - comment.attachment returns the attachment details, if any, for each comment.
  - comment.renderedBody (Experimental) returns the rendered body in HTML format (in addition to the raw body) for each comment.
- Optionallimit?: number
  The maximum number of items to return per page. Default: 50. See the Pagination section for more details.
- OptionalorganizationId?: number
  Filters customer requests that belong to a specific organization (note that the user must be a member of that organization). Note: Valid only when used with requestOwnership=ORGANIZATION.
- OptionalrequestOwnership?: string[]
  Filters customer requests using the following values:
  - OWNED_REQUESTS returns customer requests where the user is the creator.
  - PARTICIPATED_REQUESTS returns customer requests where the user is a participant.
  - ORGANIZATION returns customer requests for an organization of which the user is a member when used in conjunction with organizationId.
  - ALL_ORGANIZATIONS returns customer requests that belong to all organizations of which the user is a member.
  - APPROVER returns customer requests where the user is an approver. Can be used in conjunction with approvalStatus to filter pending or complete approvals.
  - ALL_REQUESTS returns all customer requests. Deprecated and will be removed, as the returned requests may change if more values are added in the future. Instead, explicitly list the desired filtering strategies.
  Multiple values of the query parameter are supported. For example, requestOwnership=OWNED_REQUESTS&requestOwnership=PARTICIPATED_REQUESTS will only return customer requests where the user is the creator or a participant. If not specified, filtering defaults to OWNED_REQUESTS, PARTICIPATED_REQUESTS, and ALL_ORGANIZATIONS.
- OptionalrequestStatus?: string
  Filters customer requests where the request is closed, open, or either of the two where:
  - CLOSED_REQUESTS returns customer requests that are closed.
  - OPEN_REQUESTS returns customer requests that are open.
  - ALL_REQUESTS returns all customer requests.
- OptionalrequestTypeId?: number
  Filters customer requests by request type. Note that the serviceDeskId must be specified for the service desk in which the request type belongs.
- OptionalsearchTerm?: string
  Filters customer requests where the request summary matches the searchTerm. Wildcards can be used in the searchTerm parameter.
- OptionalserviceDeskId?: number
  Filters customer requests by service desk.
- Optionalstart?: number
  The starting index of the returned objects. Base index: 0. See the Pagination section for more details.

Returns Promise<PagedDtoCustomerRequestDto>

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

example:

{
  "_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",
      "summary": "Request JSD help via REST",
      "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",
        "agent": "https://your-domain.atlassian.net/browse/HELPDESK-1",
        "self": "https://your-domain.atlassian.net/rest/servicedeskapi/request/107001"
      }
    },
    {
      "_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",
        "agent": "https://your-domain.atlassian.net/browse/HELPDESK-2",
        "self": "https://your-domain.atlassian.net/rest/servicedeskapi/request/107002"
      }
    },
    {
      "_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",
        "agent": "https://your-domain.atlassian.net/browse/SIMPLEDESK-6",
        "self": "https://your-domain.atlassian.net/rest/servicedeskapi/request/109006"
      }
    }
  ]
}

Path

GET /rest/servicedeskapi/request @scopes-current read:servicedesk-request @scopes-beta read:request:jira-service-management, read:user:jira

See

https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-get

getCustomerRequestStatus

getCustomerRequestStatus(params): Promise<PagedDtoCustomerRequestStatusDto>

This method returns a list of all the statuses a customer Request has achieved. A status represents the state of an issue in its workflow. An issue can have one active status only. The list returns the status history in chronological order, most recent (current) status first.

Permissions required: Permission to view the customer request.

Parameters

params: {
    issueIdOrKey: string;
    limit?: number;
    start?: number;
}
- issueIdOrKey: string
  The ID or key of the customer request to be retrieved.
- Optionallimit?: number
  The maximum number of items to return per page. Default: 50. See the Pagination section for more details.
- Optionalstart?: number
  The starting index of the returned objects. Base index: 0. See the Pagination section for more details.

Returns Promise<PagedDtoCustomerRequestStatusDto>

Returns the customer request's status history, on the specified page of the results.

example:

{
  "_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/1/status?start=6&limit=3",
    "prev": "https://your-domain.atlassian.net/rest/servicedeskapi/request/1/status?start=0&limit=3"
  },
  "values": [
    {
      "status": "Waiting for Customer",
      "statusDate": {
        "epochMillis": 1444287900000,
        "friendly": "Today 14:05 PM",
        "iso8601": "2015-10-08T14:05:00+0700",
        "jira": "2015-10-08T14:05:00.000+0700"
      }
    },
    {
      "status": "Waiting for Support",
      "statusDate": {
        "epochMillis": 1444287660000,
        "friendly": "Today 14:01 PM",
        "iso8601": "2015-10-08T14:01:00+0700",
        "jira": "2015-10-08T14:01:00.000+0700"
      }
    },
    {
      "status": "Waiting for Customer",
      "statusDate": {
        "epochMillis": 1444287600000,
        "friendly": "Today 14:00 PM",
        "iso8601": "2015-10-08T14:00:00+0700",
        "jira": "2015-10-08T14:00:00.000+0700"
      }
    }
  ]
}

Path

GET /rest/servicedeskapi/request/{issueIdOrKey}/status @scopes-current read:servicedesk-request @scopes-beta read:request.status:jira-service-management, read:user:jira

See

https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-issueidorkey-status-get

getCustomerTransitions

getCustomerTransitions(params): Promise<PagedDtoCustomerTransitionDto>
This method returns a list of transitions, the workflow processes that moves a customer request from one status to another, that the user can perform on a request. Use this method to provide a user with a list if the actions they can take on a customer request.

Permissions required: Permission to view the customer request.
Parameters
- params: {
      issueIdOrKey: string;
      limit?: number;
      start?: number;
  }
  - issueIdOrKey: string
    The ID or key of the customer request whose transitions will be retrieved.
  - Optionallimit?: number
    The maximum number of items to return per page. Default: 50. See the Pagination section for more details.
  - Optionalstart?: number
    The starting index of the returned objects. Base index: 0. See the Pagination section for more details.
Returns Promise<PagedDtoCustomerTransitionDto>
Returns the transitions available to the user on the customer request.

example:
```
{
  "_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/1/transition?start=4&limit=2",
    "prev": "https://your-domain.atlassian.net/rest/servicedeskapi/request/1/transition?start=0&limit=2"
  },
  "values": [
    {
      "id": "1",
      "name": "Close Request"
    },
    {
      "id": "2",
      "name": "Escalate Request"
    }
  ]
}
```
Path
GET /rest/servicedeskapi/request/{issueIdOrKey}/transition @scopes-current read:servicedesk-request @scopes-beta read:request.status:jira-service-management, read:user:jira

See
https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-issueidorkey-transition-get

getFeedback

getFeedback(params): Promise<CsatFeedbackFullDto>
This method retrieves a feedback of a request using it's requestKey or requestId

Permissions required: User has view request permissions.
Parameters
- params: {
  requestIdOrKey: string;
  }
  - requestIdOrKey: string
    The id or the key of the request to post the feedback on
Returns Promise<CsatFeedbackFullDto>
Returns the comment.

example:
```
{
  "type": "csat",
  "rating": 4,
  "comment": {
    "body": "Great work!"
  }
}
```
Path
GET /rest/servicedeskapi/request/{requestIdOrKey}/feedback @scopes-current read:servicedesk-request @scopes-beta read:request.feedback:jira-service-management, read:user:jira

See
https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-requestidorkey-feedback-get

getRequestCommentById

getRequestCommentById(params): Promise<CommentDto>

This method returns details of a customer request's comment.

Permissions required: Permission to view the customer request.

Response limitations: Customers can only view public comments on requests where they are the reporter or a participant whereas agents can see both internal and public comments.

Parameters

params: {
    commentId: number;
    expand?: string[];
    issueIdOrKey: string;
}
- commentId: number
  The ID of the comment to retrieve.
- Optionalexpand?: string[]
  A multi-value parameter indicating which properties of the comment to expand:
  - attachment returns the attachment details, if any, for the comment. (If you want to get all attachments for a request, use servicedeskapi/request/{issueIdOrKey}/attachment.)
  - renderedBody (Experimental) returns the rendered body in HTML format (in addition to the raw body) of the comment.
- issueIdOrKey: string
  The ID or key of the customer request that contains the comment.

Returns Promise<CommentDto>

Returns the comment.

example:

{
  "_expands": [
    "attachment",
    "renderedBody"
  ],
  "id": "1000",
  "body": "Hello there",
  "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"
  }
}

Path

GET /rest/servicedeskapi/request/{issueIdOrKey}/comment/{commentId} @scopes-current read:servicedesk-request @scopes-beta read:request.comment:jira-service-management, read:user:jira

See

https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-issueidorkey-comment-commentid-get

getRequestComments

getRequestComments(params): Promise<PagedDtoCommentDto>

This method returns all comments on a customer request. No permissions error is provided if, for example, the user doesn't have access to the service desk or request, the method simply returns an empty response.

Permissions required: Permission to view the customer request.

Response limitations: Customers are returned public comments only.

Parameters

params: {
    expand?: string[];
    internal?: boolean;
    issueIdOrKey: string;
    limit?: number;
    public?: boolean;
    start?: number;
}
- Optionalexpand?: string[]
  A multi-value parameter indicating which properties of the comment to expand:
  - attachment returns the attachment details, if any, for each comment. (If you want to get all attachments for a request, use servicedeskapi/request/{issueIdOrKey}/attachment.)
  - renderedBody (Experimental) returns the rendered body in HTML format (in addition to the raw body) for each comment.
- Optionalinternal?: boolean
  Specifies whether to return internal comments or not. Default: true.
- issueIdOrKey: string
  The ID or key of the customer request whose comments will be retrieved.
- Optionallimit?: number
  The maximum number of comments to return per page. Default: 50. See the Pagination section for more details.
- Optionalpublic?: boolean
  Specifies whether to return public comments or not. Default: true.
- Optionalstart?: number
  The starting index of the returned comments. Base index: 0. See the Pagination section for more details.

Returns Promise<PagedDtoCommentDto>

Returns the comments, on the specified page of the results.

example:

{
  "_expands": [],
  "size": 1,
  "start": 1,
  "limit": 1,
  "isLastPage": false,
  "_links": {
    "base": "https://your-domain.atlassian.net/rest/servicedeskapi",
    "context": "context",
    "next": "https://your-domain.atlassian.net/rest/servicedeskapi/request/2000/comment?start=2&limit=1",
    "prev": "https://your-domain.atlassian.net/rest/servicedeskapi/request/2000/comment?start=0&limit=1"
  },
  "values": [
    {
      "_expands": [
        "attachment",
        "renderedBody"
      ],
      "id": "1000",
      "body": "Hello there",
      "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"
      }
    }
  ]
}

Path

GET /rest/servicedeskapi/request/{issueIdOrKey}/comment @scopes-current read:servicedesk-request @scopes-beta read:request.comment:jira-service-management, read:user:jira

See

https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-issueidorkey-comment-get

getRequestParticipants

getRequestParticipants(params): Promise<PagedDtoUserDto>

This method returns a list of all the participants on a customer request.

Permissions required: Permission to view the customer request.

Parameters

params: {
    issueIdOrKey: string;
    limit?: number;
    start?: number;
}
- issueIdOrKey: string
  The ID or key of the customer request to be queried for its participants.
- Optionallimit?: number
  The maximum number of request types to return per page. Default: 50. See the Pagination section for more details.
- Optionalstart?: number
  The starting index of the returned objects. Base index: 0. See the Pagination section for more details.

Returns Promise<PagedDtoUserDto>

Returns the customer request's participants, on the specified page of the results.

example:

{
  "_expands": [],
  "size": 1,
  "start": 1,
  "limit": 1,
  "isLastPage": false,
  "_links": {
    "base": "https://your-domain.atlassian.net/rest/servicedeskapi",
    "context": "context",
    "next": "https://your-domain.atlassian.net/rest/servicedeskapi/request/1000/participant?start=2&limit=1",
    "prev": "https://your-domain.atlassian.net/rest/servicedeskapi/request/1000/participant?start=0&limit=1"
  },
  "values": [
    {
      "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"
      }
    }
  ]
}

Path

GET /rest/servicedeskapi/request/{issueIdOrKey}/participant @scopes-current read:servicedesk-request @scopes-beta read:request.participant:jira-service-management, read:user:jira

See

https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-issueidorkey-participant-get

getSlaInformation

getSlaInformation(params): Promise<PagedDtoSlaInformationDto>

This method returns all the SLA records on a customer request. A customer request can have zero or more SLAs. Each SLA can have recordings for zero or more "completed cycles" and zero or 1 "ongoing cycle". Each cycle includes information on when it started and stopped, and whether it breached the SLA goal.

Permissions required: Agent for the Service Desk containing the queried customer request.

Parameters

params: {
    issueIdOrKey: string;
    limit?: number;
    start?: number;
}
- issueIdOrKey: string
  The ID or key of the customer request whose SLAs will be retrieved.
- Optionallimit?: number
  The maximum number of request types to return per page. Default: 50. See the Pagination section for more details.
- Optionalstart?: number
  The starting index of the returned objects. Base index: 0. See the Pagination section for more details.

Returns Promise<PagedDtoSlaInformationDto>

Returns the SLA records on the customer request, on the specified page of the results.

example:

{
  "_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/101102/sla?start=6&limit=3",
    "prev": "https://your-domain.atlassian.net/rest/servicedeskapi/request/101102/sla?start=0&limit=3"
  },
  "values": [
    {
      "name": "Time To First Response",
      "_links": {
        "self": "https://your-domain.atlassian.net/rest/servicedeskapi/request/101102/sla/10030"
      },
      "completedCycles": [
        {
          "startTime": {
            "epochMillis": 1444362323000,
            "friendly": "Yesterday 10:45 AM",
            "iso8601": "2015-10-09T10:45:23+0700",
            "jira": "2015-10-09T10:45:23.000+0700"
          },
          "stopTime": {
            "epochMillis": 1444362743000,
            "friendly": "Yesterday 10:52 AM",
            "iso8601": "2015-10-09T10:52:23+0700",
            "jira": "2015-10-09T10:52:23.000+0700"
          },
          "breachTime": {
            "epochMillis": 1444362623000,
            "friendly": "Yesterday 10:50 AM",
            "iso8601": "2015-10-09T10:50:23+0700",
            "jira": "2015-10-09T10:50:23.000+0700"
          },
          "breached": false,
          "goalDuration": {
            "millis": 14400000,
            "friendly": "4h 240m"
          },
          "elapsedTime": {
            "millis": 420000,
            "friendly": "0h 7m"
          },
          "remainingTime": {
            "millis": 13980000,
            "friendly": "3h 233m"
          }
        },
        {
          "startTime": {
            "epochMillis": 1444449143000,
            "friendly": "Today 10:52 AM",
            "iso8601": "2015-10-10T10:52:23+0700",
            "jira": "2015-10-10T10:52:23.000+0700"
          },
          "stopTime": {
            "epochMillis": 1444468523000,
            "friendly": "Today 16:15 PM",
            "iso8601": "2015-10-10T16:15:23+0700",
            "jira": "2015-10-10T16:15:23.000+0700"
          },
          "breachTime": {
            "epochMillis": 1444464743000,
            "friendly": "Today 15:12 PM",
            "iso8601": "2015-10-10T15:12:23+0700",
            "jira": "2015-10-10T15:12:23.000+0700"
          },
          "breached": true,
          "goalDuration": {
            "millis": 14400000,
            "friendly": "4h 240m"
          },
          "elapsedTime": {
            "millis": 19380000,
            "friendly": "5h 323m"
          },
          "remainingTime": {
            "millis": -4980000,
            "friendly": "-1h -83m"
          }
        }
      ],
      "ongoingCycle": {
        "startTime": {
          "epochMillis": 1444479323000,
          "friendly": "Today 19:15 PM",
          "iso8601": "2015-10-10T19:15:23+0700",
          "jira": "2015-10-10T19:15:23.000+0700"
        },
        "breached": false,
        "paused": false,
        "withinCalendarHours": false,
        "goalDuration": {
          "millis": 14400000,
          "friendly": "4h 240m"
        },
        "elapsedTime": {
          "millis": 5640000,
          "friendly": "1h 94m"
        },
        "remainingTime": {
          "millis": 8760000,
          "friendly": "2h 146m"
        }
      }
    },
    {
      "name": "Time To Resolution",
      "_links": {
        "self": "https://your-domain.atlassian.net/rest/servicedeskapi/request/101102/sla/10040"
      },
      "completedCycles": [
        {
          "startTime": {
            "epochMillis": 1444362323000,
            "friendly": "Yesterday 10:45 AM",
            "iso8601": "2015-10-09T10:45:23+0700",
            "jira": "2015-10-09T10:45:23.000+0700"
          },
          "stopTime": {
            "epochMillis": 1444398743000,
            "friendly": "Yesterday 20:52 PM",
            "iso8601": "2015-10-09T20:52:23+0700",
            "jira": "2015-10-09T20:52:23.000+0700"
          },
          "breachTime": {
            "epochMillis": 1444398623000,
            "friendly": "Yesterday 20:50 PM",
            "iso8601": "2015-10-09T20:50:23+0700",
            "jira": "2015-10-09T20:50:23.000+0700"
          },
          "breached": false,
          "goalDuration": {
            "millis": 72000000,
            "friendly": "20h 1200m"
          },
          "elapsedTime": {
            "millis": 36420000,
            "friendly": "10h 607m"
          },
          "remainingTime": {
            "millis": 35580000,
            "friendly": "9h 593m"
          }
        },
        {
          "startTime": {
            "epochMillis": 1444485143000,
            "friendly": "Today 20:52 PM",
            "iso8601": "2015-10-10T20:52:23+0700",
            "jira": "2015-10-10T20:52:23.000+0700"
          },
          "stopTime": {
            "epochMillis": 1444504523000,
            "friendly": "Today 02:15 AM",
            "iso8601": "2015-10-11T02:15:23+0700",
            "jira": "2015-10-11T02:15:23.000+0700"
          },
          "breachTime": {
            "epochMillis": 1444500743000,
            "friendly": "Today 01:12 AM",
            "iso8601": "2015-10-11T01:12:23+0700",
            "jira": "2015-10-11T01:12:23.000+0700"
          },
          "breached": true,
          "goalDuration": {
            "millis": 72000000,
            "friendly": "20h 1200m"
          },
          "elapsedTime": {
            "millis": 19380000,
            "friendly": "5h 323m"
          },
          "remainingTime": {
            "millis": 52620000,
            "friendly": "14h 877m"
          }
        }
      ],
      "ongoingCycle": {
        "startTime": {
          "epochMillis": 1444515323000,
          "friendly": "Today 05:15 AM",
          "iso8601": "2015-10-11T05:15:23+0700",
          "jira": "2015-10-11T05:15:23.000+0700"
        },
        "breached": false,
        "paused": false,
        "withinCalendarHours": false,
        "goalDuration": {
          "millis": 72000000,
          "friendly": "20h 1200m"
        },
        "elapsedTime": {
          "millis": 5640000,
          "friendly": "1h 94m"
        },
        "remainingTime": {
          "millis": 66360000,
          "friendly": "18h 1106m"
        }
      }
    },
    {
      "name": "Time To Retrospective",
      "_links": {
        "self": "https://your-domain.atlassian.net/rest/servicedeskapi/request/101102/sla/10050"
      },
      "completedCycles": [
        {
          "startTime": {
            "epochMillis": 1444362323000,
            "friendly": "Yesterday 10:45 AM",
            "iso8601": "2015-10-09T10:45:23+0700",
            "jira": "2015-10-09T10:45:23.000+0700"
          },
          "stopTime": {
            "epochMillis": 1444449143000,
            "friendly": "Yesterday 10:52 AM",
            "iso8601": "2015-10-10T10:52:23+0700",
            "jira": "2015-10-10T10:52:23.000+0700"
          },
          "breachTime": {
            "epochMillis": 1444449023000,
            "friendly": "Yesterday 10:50 AM",
            "iso8601": "2015-10-10T10:50:23+0700",
            "jira": "2015-10-10T10:50:23.000+0700"
          },
          "breached": false,
          "goalDuration": {
            "millis": 144000000,
            "friendly": "40h 2400m"
          },
          "elapsedTime": {
            "millis": 86820000,
            "friendly": "24h 1447m"
          },
          "remainingTime": {
            "millis": 57180000,
            "friendly": "15h 953m"
          }
        },
        {
          "startTime": {
            "epochMillis": 1444535543000,
            "friendly": "Today 10:52 AM",
            "iso8601": "2015-10-11T10:52:23+0700",
            "jira": "2015-10-11T10:52:23.000+0700"
          },
          "stopTime": {
            "epochMillis": 1444554923000,
            "friendly": "Today 16:15 PM",
            "iso8601": "2015-10-11T16:15:23+0700",
            "jira": "2015-10-11T16:15:23.000+0700"
          },
          "breachTime": {
            "epochMillis": 1444551143000,
            "friendly": "Today 15:12 PM",
            "iso8601": "2015-10-11T15:12:23+0700",
            "jira": "2015-10-11T15:12:23.000+0700"
          },
          "breached": true,
          "goalDuration": {
            "millis": 144000000,
            "friendly": "40h 2400m"
          },
          "elapsedTime": {
            "millis": 19380000,
            "friendly": "5h 323m"
          },
          "remainingTime": {
            "millis": 124620000,
            "friendly": "34h 2077m"
          }
        }
      ],
      "ongoingCycle": {
        "startTime": {
          "epochMillis": 1444565723000,
          "friendly": "Today 19:15 PM",
          "iso8601": "2015-10-11T19:15:23+0700",
          "jira": "2015-10-11T19:15:23.000+0700"
        },
        "breached": false,
        "paused": false,
        "withinCalendarHours": false,
        "goalDuration": {
          "millis": 144000000,
          "friendly": "40h 2400m"
        },
        "elapsedTime": {
          "millis": 5640000,
          "friendly": "1h 94m"
        },
        "remainingTime": {
          "millis": 138360000,
          "friendly": "38h 2306m"
        }
      }
    }
  ]
}

Path

GET /rest/servicedeskapi/request/{issueIdOrKey}/sla @scopes-current read:jira-work @scopes-beta read:request.sla:jira-service-management

See

https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-issueidorkey-sla-get

getSlaInformationById

getSlaInformationById(params): Promise<SlaInformationDto>

This method returns the details for an SLA on a customer request.

Permissions required: Agent for the Service Desk containing the queried customer request.

Parameters

params: {
issueIdOrKey: string;
slaMetricId: number;
}
- issueIdOrKey: string
  The ID or key of the customer request whose SLAs will be retrieved.
- slaMetricId: number
  The ID or key of the SLAs metric to be retrieved.

Returns Promise<SlaInformationDto>

Returns the SLA record, on the specified page of the results.

example:

{
  "name": "Time To First Response",
  "_links": {
    "self": "https://your-domain.atlassian.net/rest/servicedeskapi/request/101102/sla/10030"
  },
  "completedCycles": [
    {
      "startTime": {
        "epochMillis": 1444362323000,
        "friendly": "Yesterday 10:45 AM",
        "iso8601": "2015-10-09T10:45:23+0700",
        "jira": "2015-10-09T10:45:23.000+0700"
      },
      "stopTime": {
        "epochMillis": 1444362743000,
        "friendly": "Yesterday 10:52 AM",
        "iso8601": "2015-10-09T10:52:23+0700",
        "jira": "2015-10-09T10:52:23.000+0700"
      },
      "breachTime": {
        "epochMillis": 1444362623000,
        "friendly": "Yesterday 10:50 AM",
        "iso8601": "2015-10-09T10:50:23+0700",
        "jira": "2015-10-09T10:50:23.000+0700"
      },
      "breached": false,
      "goalDuration": {
        "millis": 14400000,
        "friendly": "4h 240m"
      },
      "elapsedTime": {
        "millis": 420000,
        "friendly": "0h 7m"
      },
      "remainingTime": {
        "millis": 13980000,
        "friendly": "3h 233m"
      }
    },
    {
      "startTime": {
        "epochMillis": 1444449143000,
        "friendly": "Today 10:52 AM",
        "iso8601": "2015-10-10T10:52:23+0700",
        "jira": "2015-10-10T10:52:23.000+0700"
      },
      "stopTime": {
        "epochMillis": 1444468523000,
        "friendly": "Today 16:15 PM",
        "iso8601": "2015-10-10T16:15:23+0700",
        "jira": "2015-10-10T16:15:23.000+0700"
      },
      "breachTime": {
        "epochMillis": 1444464743000,
        "friendly": "Today 15:12 PM",
        "iso8601": "2015-10-10T15:12:23+0700",
        "jira": "2015-10-10T15:12:23.000+0700"
      },
      "breached": true,
      "goalDuration": {
        "millis": 14400000,
        "friendly": "4h 240m"
      },
      "elapsedTime": {
        "millis": 19380000,
        "friendly": "5h 323m"
      },
      "remainingTime": {
        "millis": -4980000,
        "friendly": "-1h -83m"
      }
    }
  ],
  "ongoingCycle": {
    "startTime": {
      "epochMillis": 1444479323000,
      "friendly": "Today 19:15 PM",
      "iso8601": "2015-10-10T19:15:23+0700",
      "jira": "2015-10-10T19:15:23.000+0700"
    },
    "breached": false,
    "paused": false,
    "withinCalendarHours": false,
    "goalDuration": {
      "millis": 14400000,
      "friendly": "4h 240m"
    },
    "elapsedTime": {
      "millis": 5640000,
      "friendly": "1h 94m"
    },
    "remainingTime": {
      "millis": 8760000,
      "friendly": "2h 146m"
    }
  }
}

Path

GET /rest/servicedeskapi/request/{issueIdOrKey}/sla/{slaMetricId} @scopes-current read:jira-work @scopes-beta read:request.sla:jira-service-management

See

https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-issueidorkey-sla-slametricid-get

getSubscriptionStatus

getSubscriptionStatus(params): Promise<RequestNotificationSubscriptionDto>
This method returns the notification subscription status of the user making the request. Use this method to determine if the user is subscribed to a customer request's notifications.

Permissions required: Permission to view the customer request.
Parameters
- params: {
  issueIdOrKey: string;
  }
  - issueIdOrKey: string
    The ID or key of the customer request to be queried for subscription status.
Returns Promise<RequestNotificationSubscriptionDto>
Returns the status of the notification subscription.

example:
```
{
  "subscribed": true
}
```
Path
GET /rest/servicedeskapi/request/{issueIdOrKey}/notification @scopes-current read:servicedesk-request @scopes-beta read:request.notification:jira-service-management, read:user:jira

See
https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-issueidorkey-notification-get

performCustomerTransition

performCustomerTransition(params): Promise<void>
This method performs a customer transition for a given request and transition. An optional comment can be included to provide a reason for the transition.

Permissions required: The user must be able to view the request and have the Transition Issues permission. If a comment is passed the user must have the Add Comments permission.
Parameters
- params: {
  customerTransitionExecutionDto: CustomerTransitionExecutionDto;
  issueIdOrKey: string;
  }
  - customerTransitionExecutionDto: CustomerTransitionExecutionDto
    Example
  - issueIdOrKey: string
    ID or key of the issue to transition
Returns Promise<void>
Path
POST /rest/servicedeskapi/request/{issueIdOrKey}/transition @scopes-current write:servicedesk-request @scopes-beta read:request.status:jira-service-management, write:request.status:jira-service-management, read:user:jira

See
https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-issueidorkey-transition-post

postFeedback

postFeedback(params): Promise<CsatFeedbackFullDto>
This method adds a feedback on an request using it's requestKey or requestId

Permissions required: User must be the reporter or an Atlassian Connect app.
Parameters
- params: {
  csatFeedbackFullDto: CsatFeedbackFullDto;
  requestIdOrKey: string;
  }
  - csatFeedbackFullDto: CsatFeedbackFullDto
    The feedback to be added on the request
    
    Example
  - requestIdOrKey: string
    The id or the key of the request to post the feedback on
Returns Promise<CsatFeedbackFullDto>
Returns the comment.

example:
```
{
  "type": "csat",
  "rating": 4,
  "comment": {
    "body": "Great work!"
  }
}
```
Path
POST /rest/servicedeskapi/request/{requestIdOrKey}/feedback @scopes-current write:servicedesk-request @scopes-beta read:request.feedback:jira-service-management, write:request.feedback:jira-service-management, read:user:jira

See
https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-requestidorkey-feedback-post

removeRequestParticipants

removeRequestParticipants(params): Promise<PagedDtoUserDto>

This method removes participants from a customer request.

Permissions required: Permission to manage participants on the customer request.

Parameters

params: {
issueIdOrKey: string;
requestParticipantUpdateDto: RequestParticipantUpdateDto;
}
- issueIdOrKey: string
  The ID or key of the customer request to have participants removed.
- requestParticipantUpdateDto: RequestParticipantUpdateDto
  Example

Returns Promise<PagedDtoUserDto>

Returns the first page of the customer request's participants (after removal of the users).

example:

{
  "_expands": [],
  "size": 1,
  "start": 1,
  "limit": 1,
  "isLastPage": false,
  "_links": {
    "base": "https://your-domain.atlassian.net/rest/servicedeskapi",
    "context": "context",
    "next": "https://your-domain.atlassian.net/rest/servicedeskapi/request/1000/participant?start=2&limit=1",
    "prev": "https://your-domain.atlassian.net/rest/servicedeskapi/request/1000/participant?start=0&limit=1"
  },
  "values": [
    {
      "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"
      }
    }
  ]
}

Path

DELETE /rest/servicedeskapi/request/{issueIdOrKey}/participant @scopes-current write:servicedesk-request @scopes-beta read:request.participant:jira-service-management, delete:request.participant:jira-service-management, read:user:jira

See

https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-issueidorkey-participant-delete

subscribe(params): Promise<void>
This method subscribes the user to receiving notifications from a customer request.

Permissions required: Permission to view the customer request.
Parameters
- params: {
  issueIdOrKey: string;
  }
  - issueIdOrKey: string
    The ID or key of the customer request to be subscribed to.
Returns Promise<void>
Path
PUT /rest/servicedeskapi/request/{issueIdOrKey}/notification @scopes-current write:servicedesk-request @scopes-beta read:request.notification:jira-service-management, write:request.notification:jira-service-management, read:user:jira

See
https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-issueidorkey-notification-put

unsubscribe

unsubscribe(params): Promise<void>
This method unsubscribes the user from notifications from a customer request.

Permissions required: Permission to view the customer request.
Parameters
- params: {
  issueIdOrKey: string;
  }
  - issueIdOrKey: string
    The ID or key of the customer request to be unsubscribed from.
Returns Promise<void>
Path
DELETE /rest/servicedeskapi/request/{issueIdOrKey}/notification @scopes-current write:servicedesk-request @scopes-beta read:request.notification:jira-service-management, delete:request.notification:jira-service-management, read:user:jira

See
https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-issueidorkey-notification-delete

`Protected` `Static`initialize

initialize(): void
Method to initialize the class. Normally used to set up validation rules.

Returns void
Overrides CommonHttpService.initialize

Class RequestService

See

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns CommonHttpClient

Returns RequestService

Methods

addRequestParticipants

Parameters

issueIdOrKey: string

requestParticipantUpdateDto: RequestParticipantUpdateDto

Example

Returns Promise<PagedDtoUserDto>

Path

See

answerApproval

Parameters

approvalDecisionRequestDto: ApprovalDecisionRequestDto

Example

approvalId: number

issueIdOrKey: string

Returns Promise<ApprovalDto>

Path

See

createCommentWithAttachment

Parameters

attachmentCreateDto: AttachmentCreateDto

Example

issueIdOrKey: string

Returns Promise<AttachmentCreateResultDto>

Path

See

createCustomerRequest

Parameters

requestCreateDto: RequestCreateDto

Example

Returns Promise<CustomerRequestDto>

Path

See

createRequestComment

Parameters

commentCreateDto: CommentCreateDto

Example

issueIdOrKey: string

Returns Promise<CommentDto>

Path

See

deleteFeedback

Parameters

requestIdOrKey: string

Returns Promise<void>

Path

See

getApprovalById

Parameters

approvalId: number

issueIdOrKey: string

Returns Promise<ApprovalDto>

Path

See

getApprovals

Parameters

issueIdOrKey: string

Optionallimit?: number

Optionalstart?: number

Returns Promise<PagedDtoApprovalDto>

Path

See

getAttachmentContent

Parameters

attachmentId: number

issueIdOrKey: string

Returns Promise<unknown>

Path

See

`Optional`limit?: number

`Optional`start?: number

`Optional`limit?: number

`Optional`start?: number

`Optional`expand?: string[]

`Optional`approvalStatus?: string

`Optional`expand?: string[]

`Optional`limit?: number

`Optional`organizationId?: number

`Optional`requestOwnership?: string[]

`Optional`requestStatus?: string

`Optional`requestTypeId?: number

`Optional`searchTerm?: string

`Optional`serviceDeskId?: number

`Optional`start?: number

`Optional`limit?: number

`Optional`start?: number

`Optional`limit?: number

`Optional`start?: number