openapi: 3.2.0
info:
  description: Public REST API for Jira Service Management
  termsOfService: https://www.atlassian.com/legal/customer-agreement
  title: Service Management Public REST Request API
  version: 1001.0.0-SNAPSHOT-82b018affa468e58f284fbe4df33536469d757df
servers:
- url: https://your-domain.atlassian.net
tags:
- name: Request
paths:
  /rest/servicedeskapi/request:
    get:
      deprecated: false
      description: '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.'
      operationId: getCustomerRequests
      parameters:
      - description: Filters customer requests where the request summary matches the `searchTerm`. [Wildcards](https://confluence.atlassian.com/display/JIRACORECLOUD/Search+syntax+for+text+fields) can be used in the `searchTerm` parameter.
        in: query
        name: searchTerm
        schema:
          type: string
      - description: "Filters customer requests using the following values:\n\n *  `OWNED_REQUESTS` returns customer requests where the user is the creator.\n *  `PARTICIPATED_REQUESTS` returns customer requests where the user is a participant.\n *  `ORGANIZATION` returns customer requests for an organization of which the user is a member when used in conjunction with `organizationId`.\n *  `ALL_ORGANIZATIONS` returns customer requests that belong to all organizations of which the user is a member.\n *  `APPROVER` returns customer requests where the user is an approver. Can be used in conjunction with `approvalStatus` to filter pending or complete approvals.\n *  `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.**\n\nMultiple 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`."
        in: query
        name: requestOwnership
        schema:
          items:
            default: ''
            type: string
          type: array
      - description: "Filters customer requests where the request is closed, open, or either of the two where:\n\n *  `CLOSED_REQUESTS` returns customer requests that are closed.\n *  `OPEN_REQUESTS` returns customer requests that are open.\n *  `ALL_REQUESTS` returns all customer requests."
        in: query
        name: requestStatus
        schema:
          type: string
      - description: "Filters results to customer requests based on their approval status:\n\n *  `MY_PENDING_APPROVAL` returns customer requests pending the user's approval.\n *  `MY_HISTORY_APPROVAL` returns customer requests where the user was an approver.\n\n**Note**: Valid only when used with requestOwnership=APPROVER."
        in: query
        name: approvalStatus
        schema:
          type: string
      - description: '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.'
        in: query
        name: organizationId
        schema:
          format: int32
          type: integer
      - description: Filters customer requests by service desk.
        in: query
        name: serviceDeskId
        schema:
          format: int32
          type: integer
      - description: Filters customer requests by request type. Note that the `serviceDeskId` must be specified for the service desk in which the request type belongs.
        in: query
        name: requestTypeId
        schema:
          format: int32
          type: integer
      - description: "A multi-value parameter indicating which properties of the customer request to expand, where:\n\n *  `serviceDesk` returns additional details for each service desk.\n *  `requestType` returns additional details for each request type.\n *  `participant` returns the participant details, if any, for each customer request.\n *  `sla` returns the SLA information on each customer request.\n *  `status` returns the status transitions, in chronological order, for each customer request.\n *  `attachment` returns the attachments for the customer request.\n *  `action` returns the actions that the user can or cannot perform on this customer request.\n *  `comment` returns the comments, if any, for each customer request.\n *  `comment.attachment` returns the attachment details, if any, for each comment.\n *  `comment.renderedBody` (Experimental) returns the rendered body in HTML format (in addition to the raw body) for each comment."
        in: query
        name: expand
        schema:
          items:
            default: ''
            type: string
          type: array
      - description: 'The starting index of the returned objects. Base index: 0. See the [Pagination](#pagination) section for more details.'
        in: query
        name: start
        schema:
          format: int32
          type: integer
      - description: 'The maximum number of items to return per page. Default: 50. See the [Pagination](#pagination) section for more details.'
        in: query
        name: limit
        schema:
          format: int32
          type: integer
      responses:
        '200':
          content:
            application/json:
              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"}}]}'
              schema:
                $ref: '#/components/schemas/PagedDTOCustomerRequestDTO'
          description: Returns the customer requests, on the specified page of the results.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Returned if the user is not logged in.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Returned if the user does not have permission to access the service desk, the service desk does not exist, or the service desk does not support the request type.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error.
      security:
      - OAuth2:
        - read:servicedesk-request
      summary: Get customer requests
      tags:
      - Request
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: false
      x-atlassian-oauth2-scopes:
      - scheme: OAuth2
        scopes:
        - read:servicedesk-request
        state: Current
      - scheme: OAuth2
        scopes:
        - read:request:jira-service-management
        - read:user:jira
        state: Beta
      x-atlassian-connect-scope: READ
    post:
      deprecated: false
      description: '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.'
      operationId: createCustomerRequest
      requestBody:
        content:
          application/json:
            example:
              form:
                answers:
                  '1':
                    text: Answer to a text form field
                  '2':
                    date: '2023-07-06'
                  '3':
                    time: '14:35'
                  '4':
                    choices:
                    - '5'
                  '5':
                    users:
                    - qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d69abfa3980ce712caae
              isAdfRequest: false
              requestFieldValues:
                description: I need a new *mouse* for my Mac
                summary: Request JSD help via REST
              requestParticipants:
              - qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d69abfa3980ce712caae
              requestTypeId: '25'
              serviceDeskId: '10'
            schema:
              $ref: '#/components/schemas/RequestCreateDTO'
        required: true
      responses:
        '201':
          content:
            application/json:
              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"}}'
              schema:
                $ref: '#/components/schemas/CustomerRequestDTO'
          description: Returned if the customer request was created.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Returned if the HTTP request call is invalid.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Returned if the user is not logged in.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Returned if the user does not have permission to complete this request.
        '422':
          content:
            application/json:
              example: '{"errorMessage":"Invalid request","errors":[{"code":"VALIDATION_ERROR","context":[{"id":"q123","type":"question"}],"detail":"The field is required","status":422,"title":"Validation failed"}],"i18nErrorMessage":{"i18nKey":"sd.request.create.error.proforma.form.validation.error","parameters":[]}}'
              schema:
                $ref: '#/components/schemas/FormValidationErrorResponseDTO'
          description: Returned if one or more form answers fail validation rules configured by Jira admins.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error.
      security:
      - OAuth2:
        - write:servicedesk-request
      summary: Create customer request
      tags:
      - Request
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: false
      x-atlassian-oauth2-scopes:
      - scheme: OAuth2
        scopes:
        - write:servicedesk-request
        state: Current
      - scheme: OAuth2
        scopes:
        - read:request:jira-service-management
        - write:request:jira-service-management
        - read:user:jira
        state: Beta
      x-atlassian-connect-scope: WRITE
  /rest/servicedeskapi/request/validate:
    post:
      deprecated: false
      description: 'Validates a customer request payload without creating (persisting) a request.


        This endpoint runs exactly the same structural and semantic validations as Create customer request \\u2014 including ProForma form validation \\u2014 but performs **no mutation**: no issue is created and no side effects (attachments, comments, analytics) run.


        The response is intentionally verbose and structured so that it can be consumed by automated agents (for example an LLM repairing an invalid payload): every failure carries a machine-readable location (field id / form entity) and a human-readable reason. A valid payload returns HTTP 200 with \{@code valid: true\}; an invalid payload returns HTTP 400 with \{@code valid: false\} together with the field, form and general validation errors.


        **Permissions required**: Permission to create requests in the specified service desk.'
      operationId: validateCustomerRequest
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestCreateDTO'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequestValidationResultDTO'
          description: Returned with the validation result. \{@code valid\} is true when the payload is valid.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequestValidationResultDTO'
          description: Returned when the payload is invalid; the body describes why validation failed.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Returned if the user is not logged in.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Returned if the user does not have permission to complete this request.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error.
      security:
      - OAuth2:
        - write:servicedesk-request
      summary: Validate customer request
      tags:
      - Request
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: false
      x-atlassian-oauth2-scopes:
      - scheme: OAuth2
        scopes:
        - write:servicedesk-request
        state: Current
      - scheme: OAuth2
        scopes:
        - read:request:jira-service-management
        - write:request:jira-service-management
        - read:user:jira
        state: Beta
      x-atlassian-connect-scope: WRITE
  /rest/servicedeskapi/request/{issueIdOrKey}:
    get:
      deprecated: false
      description: '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'
      operationId: getCustomerRequestByIdOrKey
      parameters:
      - description: The ID or Key of the customer request to be returned
        in: path
        name: issueIdOrKey
        required: true
        schema:
          type: string
      - description: "A multi-value parameter indicating which properties of the customer request to expand, where:\n\n *  `serviceDesk` returns additional service desk details.\n *  `requestType` returns additional customer request type details.\n *  `participant` returns the participant details.\n *  `sla` returns the SLA information.\n *  `status` returns the status transitions, in chronological order.\n *  `attachment` returns the attachments.\n *  `action` returns the actions that the user can or cannot perform.\n *  `comment` returns the comments.\n *  `comment.attachment` returns the attachment details for each comment.\n *  `comment.renderedBody` (Experimental) return the rendered body in HTML format (in addition to the raw body) for each comment."
        in: query
        name: expand
        schema:
          items:
            default: ''
            type: string
          type: array
      responses:
        '200':
          content:
            application/json:
              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"}}'
              schema:
                $ref: '#/components/schemas/CustomerRequestDTO'
          description: Returns the customer request.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Returned if the user is not logged in.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Returned if the user does not have permission to complete this request.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Returned if the customer request does not exist.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error.
      security:
      - OAuth2:
        - read:servicedesk-request
      summary: Get customer request by id or key
      tags:
      - Request
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: false
      x-atlassian-oauth2-scopes:
      - scheme: OAuth2
        scopes:
        - read:servicedesk-request
        state: Current
      - scheme: OAuth2
        scopes:
        - read:request:jira-service-management
        - read:user:jira
        state: Beta
      x-atlassian-connect-scope: READ
  /rest/servicedeskapi/request/{issueIdOrKey}/approval:
    get:
      deprecated: false
      description: 'This method returns all approvals on a customer request.


        **Permissions required**: Permission to view the customer request.'
      operationId: getApprovals
      parameters:
      - description: 'The starting index of the returned objects. Base index: 0. See the [Pagination](#pagination) section for more details.'
        in: query
        name: start
        schema:
          format: int32
          type: integer
      - description: 'The maximum number of approvals to return per page. Default: 50. See the [Pagination](#pagination) section for more details.'
        in: query
        name: limit
        schema:
          format: int32
          type: integer
      - description: The ID or key of the customer request to be queried for its approvals.
        in: path
        name: issueIdOrKey
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              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"}}]}'
              schema:
                $ref: '#/components/schemas/PagedDTOApprovalDTO'
          description: Returns the customer request's approvals.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Returned if the user is not logged in.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Returned if the user does not have permission to complete this request.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Returned if the customer request does not exist.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error.
      security:
      - OAuth2:
        - read:servicedesk-request
      summary: Get approvals
      tags:
      - Request
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: false
      x-atlassian-oauth2-scopes:
      - scheme: OAuth2
        scopes:
        - read:servicedesk-request
        state: Current
      - scheme: OAuth2
        scopes:
        - read:request.approval:jira-service-management
        - read:user:jira
        state: Beta
      x-atlassian-connect-scope: READ
  /rest/servicedeskapi/request/{issueIdOrKey}/approval/{approvalId}:
    get:
      deprecated: false
      description: '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.'
      operationId: getApprovalById
      parameters:
      - description: The ID or key of the customer request the approval is on.
        in: path
        name: issueIdOrKey
        required: true
        schema:
          type: string
      - description: The ID of the approval to be returned.
        in: path
        name: approvalId
        required: true
        schema:
          format: int32
          type: integer
      responses:
        '200':
          content:
            application/json:
              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"}}'
              schema:
                $ref: '#/components/schemas/ApprovalDTO'
          description: Returns the requested approval.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Returned if the user is not logged in.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Returned if the user does not have permission to complete this request.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Returned if the customer request or approval do not exist.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error.
      security:
      - OAuth2:
        - read:servicedesk-request
      summary: Get approval by id
      tags:
      - Request
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: false
      x-atlassian-oauth2-scopes:
      - scheme: OAuth2
        scopes:
        - read:servicedesk-request
        state: Current
      - scheme: OAuth2
        scopes:
        - read:request.approval:jira-service-management
        - read:user:jira
        state: Beta
      x-atlassian-connect-scope: READ
    post:
      deprecated: false
      description: '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.'
      operationId: answerApproval
      parameters:
      - description: The ID or key of the customer request to be updated.
        in: path
        name: issueIdOrKey
        required: true
        schema:
          type: string
      - description: The ID of the approval to be updated.
        in: path
        name: approvalId
        required: true
        schema:
          format: int32
          type: integer
      requestBody:
        content:
          application/json:
            example:
              decision: approve
            schema:
              $ref: '#/components/schemas/ApprovalDecisionRequestDTO'
        required: true
      responses:
        '200':
          content:
            application/json:
              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"}}'
              schema:
                $ref: '#/components/schemas/ApprovalDTO'
          description: Returns the updated approval.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Returned if the request is not valid.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Returned if the user is not logged in.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Returned if the user does not have permission to complete this request.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Returned if the customer request or the approval do not exist.
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Returned if the customer has already submitted a decision or the approval has already been completed.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error.
      security:
      - OAuth2:
        - write:servicedesk-request
      summary: Answer approval
      tags:
      - Request
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: false
      x-atlassian-oauth2-scopes:
      - scheme: OAuth2
        scopes:
        - write:servicedesk-request
        state: Current
      - scheme: OAuth2
        scopes:
        - read:request.approval:jira-service-management
        - write:request.approval:jira-service-management
        - read:user:jira
        state: Beta
      x-atlassian-connect-scope: WRITE
  /rest/servicedeskapi/request/{issueIdOrKey}/attachment:
    get:
      deprecated: false
      description: '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.'
      operationId: getAttachmentsForRequest
      parameters:
      - description: The ID or key of the customer request from which the attachments will be listed.
        in: path
        name: issueIdOrKey
        required: true
        schema:
          type: string
      - description: 'The starting index of the returned attachment. Base index: 0. See the [Pagination](#pagination) section for more details.'
        in: query
        name: start
        required: true
        schema:
          default: 0
          format: int32
          type: integer
      - description: 'The maximum number of comments to return per page. Default: 50. See the [Pagination](#pagination) section for more details.'
        in: query
        name: limit
        required: true
        schema:
          default: 50
          format: int32
          type: integer
      responses:
        '200':
          content:
            application/json:
              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"}}]}'
              schema:
                $ref: '#/components/schemas/PagedDTOAttachmentDTO'
          description: Returns the visible attachments from the customer request.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Returned if the user is not logged in.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Returned if the user does not have permission to complete this request.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Returned if the customer request does not exist.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error.
      security:
      - OAuth2:
        - read:servicedesk-request
      summary: Get attachments for request
      tags:
      - Request
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: false
      x-atlassian-oauth2-scopes:
      - scheme: OAuth2
        scopes:
        - read:servicedesk-request
        state: Current
      - scheme: OAuth2
        scopes:
        - read:request.attachment:jira-service-management
        - read:user:jira
        state: Beta
      x-atlassian-connect-scope: READ
    post:
      deprecated: false
      description: '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.'
      operationId: createCommentWithAttachment
      parameters:
      - description: The ID or key of the customer request to which the attachment will be added.
        in: path
        name: issueIdOrKey
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            example:
              additionalComment:
                body: Please find the screenshot and the log file attached.
              public: true
              temporaryAttachmentIds:
              - temp910441317820424274
              - temp3600755449679003114
            schema:
              $ref: '#/components/schemas/AttachmentCreateDTO'
        required: true
      responses:
        '201':
          content:
            application/json:
              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"}}]}}'
              schema:
                $ref: '#/components/schemas/AttachmentCreateResultDTO'
          description: Returns the attachments and comment.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Returned if the HTTP request is invalid, including missing the required `public` field or list of temporary file IDs, or if the temporary files have expired.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Returned if the user is not logged in.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Returned if the user does not have permission to complete this request.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Returned if the customer request does not exist.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error.
      security:
      - OAuth2:
        - write:servicedesk-request
      summary: Create comment with attachment
      tags:
      - Request
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: false
      x-atlassian-oauth2-scopes:
      - scheme: OAuth2
        scopes:
        - write:servicedesk-request
        state: Current
      - scheme: OAuth2
        scopes:
        - read:request.attachment:jira-service-management
        - write:request.attachment:jira-service-management
        - read:user:jira
        state: Beta
      x-atlassian-connect-scope: WRITE
  /rest/servicedeskapi/request/{issueIdOrKey}/attachment/{attachmentId}:
    get:
      deprecated: false
      description: '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.'
      operationId: getAttachmentContent
      parameters:
      - description: The ID or key for the customer request the attachment is associated with
        in: path
        name: issueIdOrKey
        required: true
        schema:
          type: string
      - description: The ID for the attachment
        in: path
        name: attachmentId
        required: true
        schema:
          format: int64
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema: {}
          description: 200 response
        '303':
          description: Returned if the request is successful. See the `Location` header for the download URL.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Returned if the authentication credentials are incorrect.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: The user does not have the necessary permission.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: "Returned if:\n\n *  the attachment is not found.\n *  attachments are disabled in the Jira settings."
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error.
      security:
      - OAuth2:
        - read:servicedesk-request
      summary: Get attachment content
      tags:
      - Request
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: false
      x-atlassian-oauth2-scopes:
      - scheme: OAuth2
        scopes:
        - read:servicedesk-request
        state: Current
      - scheme: OAuth2
        scopes:
        - read:request.attachment:jira-service-management
        - read:user:jira
        state: Beta
      x-atlassian-connect-scope: READ
  /rest/servicedeskapi/request/{issueIdOrKey}/attachment/{attachmentId}/thumbnail:
    get:
      deprecated: false
      description: '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.'
      operationId: getAttachmentThumbnail
      parameters:
      - description: The ID or key for the customer request the attachment is associated with
        in: path
        name: issueIdOrKey
        required: true
        schema:
          type: string
      - description: The ID of the attachment.
        in: path
        name: attachmentId
        required: true
        schema:
          format: int64
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema: {}
          description: 200 response
        '303':
          description: Returned if the request is successful. See the `Location` header for the download URL.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Returned if the request is invalid.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Returned if the authentication credentials are incorrect.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: The user does not have the necessary permission.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: "Returned if:\n\n *  the attachment is not found.\n *  attachments are disabled in the Jira settings."
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error.
      security:
      - OAuth2:
        - read:servicedesk-request
      summary: Get attachment thumbnail
      tags:
      - Request
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: false
      x-atlassian-oauth2-scopes:
      - scheme: OAuth2
        scopes:
        - read:servicedesk-request
        state: Current
      - scheme: OAuth2
        scopes:
        - read:request.attachment:jira-service-management
        - read:user:jira
        state: Beta
      x-atlassian-connect-scope: READ
  /rest/servicedeskapi/request/{issueIdOrKey}/comment:
    get:
      deprecated: false
      description: '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.'
      operationId: getRequestComments
      parameters:
      - description: The ID or key of the customer request whose comments will be retrieved.
        in: path
        name: issueIdOrKey
        required: true
        schema:
          type: string
      - description: 'Specifies whether to return public comments or not. Default: true.'
        in: query
        name: public
        schema:
          type: boolean
      - description: 'Specifies whether to return internal comments or not. Default: true.'
        in: query
        name: internal
        schema:
          type: boolean
      - description: "A multi-value parameter indicating which properties of the comment to expand:\n\n *  `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](#api-request-issueIdOrKey-attachment-get).)\n *  `renderedBody` (Experimental) returns the rendered body in HTML format (in addition to the raw body) for each comment."
        in: query
        name: expand
        schema:
          items:
            default: ''
            type: string
          type: array
      - description: 'The starting index of the returned comments. Base index: 0. See the [Pagination](#pagination) section for more details.'
        in: query
        name: start
        schema:
          format: int32
          type: integer
      - description: 'The maximum number of comments to return per page. Default: 50. See the [Pagination](#pagination) section for more details.'
        in: query
        name: limit
        schema:
          format: int32
          type: integer
      responses:
        '200':
          content:
            application/json:
              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"}}]}'
              schema:
                $ref: '#/components/schemas/PagedDTOCommentDTO'
          description: Returns the comments, on the specified page of the results.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Returned if the user is not logged in.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Returned if the customer request does not exist.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error.
      security:
      - OAuth2:
        - read:servicedesk-request
      summary: Get request comments
      tags:
      - Request
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: false
      x-atlassian-oauth2-scopes:
      - scheme: OAuth2
        scopes:
        - read:servicedesk-request
        state: Current
      - scheme: OAuth2
        scopes:
        - read:request.comment:jira-service-management
        - read:user:jira
        state: Beta
      x-atlassian-connect-scope: READ
    post:
      deprecated: false
      description: '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.'
      operationId: createRequestComment
      parameters:
      - description: The ID or key of the customer request to which the comment will be added.
        in: path
        name: issueIdOrKey
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            example:
              body: Hello there
              public: true
            schema:
              $ref: '#/components/schemas/CommentCreateDTO'
        required: true
      responses:
        '201':
          content:
            application/json:
              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"}}'
              schema:
                $ref: '#/components/schemas/CommentDTO'
          description: Returns the comment.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Returned if the HTTP request is invalid, e.g. missing the required `public`.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Returned if the user is not logged in.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Returned if the user does not have permission to complete this request.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Returned if the customer request does not exist.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error.
      security:
      - OAuth2:
        - write:servicedesk-request
      summary: Create request comment
      tags:
      - Request
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: false
      x-atlassian-oauth2-scopes:
      - scheme: OAuth2
        scopes:
        - write:servicedesk-request
        state: Current
      - scheme: OAuth2
        scopes:
        - read:request.comment:jira-service-management
        - write:request.comment:jira-service-management
        - read:user:jira
        state: Beta
      x-atlassian-connect-scope: WRITE
  /rest/servicedeskapi/request/{issueIdOrKey}/comment/{commentId}:
    get:
      deprecated: false
      description: '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.'
      operationId: getRequestCommentById
      parameters:
      - description: The ID or key of the customer request that contains the comment.
        in: path
        name: issueIdOrKey
        required: true
        schema:
          type: string
      - description: The ID of the comment to retrieve.
        in: path
        name: commentId
        required: true
        schema:
          format: int64
          type: integer
      - description: "A multi-value parameter indicating which properties of the comment to expand:\n\n *  `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](#api-request-issueIdOrKey-attachment-get).)\n *  `renderedBody` (Experimental) returns the rendered body in HTML format (in addition to the raw body) of the comment."
        in: query
        name: expand
        schema:
          items:
            default: ''
            type: string
          type: array
      responses:
        '200':
          content:
            application/json:
              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"}}'
              schema:
                $ref: '#/components/schemas/CommentDTO'
          description: Returns the comment.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Returned if the user is not logged in.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Returned if the user does not have permission to complete this request.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Returned if the customer request or comment do not exist.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error.
      security:
      - OAuth2:
        - read:servicedesk-request
      summary: Get request comment by id
      tags:
      - Request
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: false
      x-atlassian-oauth2-scopes:
      - scheme: OAuth2
        scopes:
        - read:servicedesk-request
        state: Current
      - scheme: OAuth2
        scopes:
        - read:request.comment:jira-service-management
        - read:user:jira
        state: Beta
      x-atlassian-connect-scope: READ
  /rest/servicedeskapi/request/{issueIdOrKey}/comment/{commentId}/attachment:
    get:
      deprecated: false
      description: '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.'
      operationId: getCommentAttachments
      parameters:
      - description: The ID or key of the customer request that contains the comment.
        in: path
        name: issueIdOrKey
        required: true
        schema:
          type: string
      - description: The ID of the comment.
        in: path
        name: commentId
        required: true
        schema:
          format: int64
          type: integer
      - description: 'The starting index of the returned comments. Base index: 0. See the [Pagination](#pagination) section for more details.'
        in: query
        name: start
        schema:
          format: int32
          type: integer
      - description: 'The maximum number of comments to return per page. Default: 50. See the [Pagination](#pagination) section for more details.'
        in: query
        name: limit
        schema:
          format: int32
          type: integer
      responses:
        '200':
          content:
            application/json:
              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"}}]}'
              schema:
                $ref: '#/components/schemas/PagedDTOAttachmentDTO'
          description: Returns the attachments, on the specified page of the results.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Returned if the user is not logged in.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Returned if the user does not have permission to complete this request.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Returned if the customer request or the comment do not exist.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error.
      security:
      - OAuth2:
        - read:request.attachment:jira-service-management
        - read:request.comment:jira-service-management
        - read:user:jira
      summary: Get comment attachments
      tags:
      - Request
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: false
      x-experimental: true
      x-atlassian-connect-scope: INACCESSIBLE
  /rest/servicedeskapi/request/{issueIdOrKey}/notification:
    delete:
      deprecated: false
      description: 'This method unsubscribes the user from notifications from a customer request.


        **Permissions required**: Permission to view the customer request.'
      operationId: unsubscribe
      parameters:
      - description: The ID or key of the customer request to be unsubscribed from.
        in: path
        name: issueIdOrKey
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Returns if the user was unsubscribed.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Returned if the user is not logged in.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Returned if the user does not have permission to complete this request.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Returned if the customer request does not exist.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error.
      security:
      - OAuth2:
        - write:servicedesk-request
      summary: Unsubscribe
      tags:
      - Request
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: false
      x-atlassian-oauth2-scopes:
      - scheme: OAuth2
        scopes:
        - write:servicedesk-request
        state: Current
      - scheme: OAuth2
        scopes:
        - read:request.notification:jira-service-management
        - delete:request.notification:jira-service-management
        - read:user:jira
        state: Beta
      x-atlassian-connect-scope: WRITE
    get:
      deprecated: false
      description: '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.'
      operationId: getSubscriptionStatus
      parameters:
      - description: The ID or key of the customer request to be queried for subscription status.
        in: path
        name: issueIdOrKey
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              example: '{"subscribed":true}'
              schema:
                $ref: '#/components/schemas/RequestNotificationSubscriptionDTO'
          description: Returns the status of the notification subscription.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Returned if the user is not logged in.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Returned if the user does not have permission to complete this request.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Returned if the customer request does not exist.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error.
      security:
      - OAuth2:
        - read:servicedesk-request
      summary: Get subscription status
      tags:
      - Request
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: false
      x-atlassian-oauth2-scopes:
      - scheme: OAuth2
        scopes:
        - read:servicedesk-request
        state: Current
      - scheme: OAuth2
        scopes:
        - read:request.notification:jira-service-management
        - read:user:jira
        state: Beta
      x-atlassian-connect-scope: READ
    put:
      deprecated: false
      description: 'This method subscribes the user to receiving notifications from a customer request.


        **Permissions required**: Permission to view the customer request.'
      operationId: subscribe
      parameters:
      - description: The ID or key of the customer request to be subscribed to.
        in: path
        name: issueIdOrKey
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Returns if the user was subscribed.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Returned if the user is not logged in.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Returned if the user does not have permission to complete this request.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Returned if the customer request does not exist.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error.
      security:
      - OAuth2:
        - write:servicedesk-request
      summary: Subscribe
      tags:
      - Request
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: false
      x-atlassian-oauth2-scopes:
      - scheme: OAuth2
        scopes:
        - write:servicedesk-request
        state: Current
      - scheme: OAuth2
        scopes:
        - read:request.notification:jira-service-management
        - write:request.notification:jira-service-management
        - read:user:jira
        state: Beta
      x-atlassian-connect-scope: WRITE
  /rest/servicedeskapi/request/{issueIdOrKey}/participant:
    delete:
      deprecated: false
      description: 'This method removes participants from a customer request.


        **Permissions required**: Permission to manage participants on the customer request.'
      operationId: removeRequestParticipants
      parameters:
      - description: The ID or key of the customer request to have participants removed.
        in: path
        name: issueIdOrKey
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            example:
              accountIds: []
              usernames:
              - qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b
              - qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3a01db05e2a66fa80bd
              - qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d69abfa3980ce712caae
            schema:
              $ref: '#/components/schemas/RequestParticipantUpdateDTO'
        required: true
      responses:
        '200':
          content:
            application/json:
              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"}}]}'
              schema:
                $ref: '#/components/schemas/PagedDTOUserDTO'
          description: Returns the first page of the customer request's participants (after removal of the users).
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Returned if any user to be removed as a participant does not exist, is not a participant in the customer request, or is the reporter of the request.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Returned if the user is not logged in.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Returned if the user does not have permission to complete this request.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Returned if the customer request does not exist.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error.
      security:
      - OAuth2:
        - write:servicedesk-request
      summary: Remove request participants
      tags:
      - Request
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: false
      x-atlassian-oauth2-scopes:
      - scheme: OAuth2
        scopes:
        - write:servicedesk-request
        state: Current
      - scheme: OAuth2
        scopes:
        - read:request.participant:jira-service-management
        - delete:request.participant:jira-service-management
        - read:user:jira
        state: Beta
      x-atlassian-connect-scope: DELETE
    get:
      deprecated: false
      description: 'This method returns a list of all the participants on a customer request.


        **Permissions required**: Permission to view the customer request.'
      operationId: getRequestParticipants
      parameters:
      - description: The ID or key of the customer request to be queried for its participants.
        in: path
        name: issueIdOrKey
        required: true
        schema:
          type: string
      - description: 'The starting index of the returned objects. Base index: 0. See the [Pagination](#pagination) section for more details.'
        in: query
        name: start
        schema:
          format: int32
          type: integer
      - description: 'The maximum number of request types to return per page. Default: 50. See the [Pagination](#pagination) section for more details.'
        in: query
        name: limit
        schema:
          format: int32
          type: integer
      responses:
        '200':
          content:
            application/json:
              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"}}]}'
              schema:
                $ref: '#/components/schemas/PagedDTOUserDTO'
          description: Returns the customer request's participants, on the specified page of the results.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Returned if the user is not logged in.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Returned if the user does not have permission to complete this request.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Returned if the customer request does not exist.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error.
      security:
      - OAuth2:
        - read:servicedesk-request
      summary: Get request participants
      tags:
      - Request
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: false
      x-atlassian-oauth2-scopes:
      - scheme: OAuth2
        scopes:
        - read:servicedesk-request
        state: Current
      - scheme: OAuth2
        scopes:
        - read:request.participant:jira-service-management
        - read:user:jira
        state: Beta
      x-atlassian-connect-scope: READ
    post:
      deprecated: false
      description: '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.'
      operationId: addRequestParticipants
      parameters:
      - description: The ID or key of the customer request to have participants added.
        in: path
        name: issueIdOrKey
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            example:
              accountIds: []
              usernames:
              - qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b
              - qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3a01db05e2a66fa80bd
              - qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d69abfa3980ce712caae
            schema:
              $ref: '#/components/schemas/RequestParticipantUpdateDTO'
        required: true
      responses:
        '200':
          content:
            application/json:
              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"}}]}'
              schema:
                $ref: '#/components/schemas/PagedDTOUserDTO'
          description: Returns the participants added to the customer request.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Returned if any user to be added as a participant does not exist.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Returned if the user is not logged in.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Returned if the user does not have permission to complete this request.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Returned if the customer request does not exist.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error.
      security:
      - OAuth2:
        - write:servicedesk-request
      summary: Add request participants
      tags:
      - Request
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: false
      x-atlassian-oauth2-scopes:
      - scheme: OAuth2
        scopes:
        - write:servicedesk-request
        state: Current
      - scheme: OAuth2
        scopes:
        - read:request.participant:jira-service-management
        - write:request.participant:jira-service-management
        - read:user:jira
        state: Beta
      x-atlassian-connect-scope: WRITE
  /rest/servicedeskapi/request/{issueIdOrKey}/sla:
    get:
      deprecated: false
      description: '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, AND

        * Browse Projects permission on the project containing the customer request, including any restrictions imposed by issue security schemes or custom permission schemes on the specific issue.'
      operationId: getSlaInformation
      parameters:
      - description: The ID or key of the customer request whose SLAs will be retrieved.
        in: path
        name: issueIdOrKey
        required: true
        schema:
          type: string
      - description: 'The starting index of the returned objects. Base index: 0. See the [Pagination](#pagination) section for more details.'
        in: query
        name: start
        schema:
          format: int32
          type: integer
      - description: 'The maximum number of request types to return per page. Default: 50. See the [Pagination](#pagination) section for more details.'
        in: query
        name: limit
        schema:
          format: int32
          type: integer
      responses:
        '200':
          content:
            application/json:
              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"}}}]}'
              schema:
                $ref: '#/components/schemas/PagedDTOSlaInformationDTO'
          description: Returns the SLA records on the customer request, on the specified page of the results.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Returned if the user is not logged in.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Returned if the user does not have permission to view this customer request. This includes the case where the user is not an agent on the Service Desk, or where the user lacks Browse Projects permission on the issue (for example, due to an issue security scheme or a custom permission scheme).
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Returned if the customer request does not exist.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error.
      security:
      - OAuth2:
        - read:jira-work
      summary: Get sla information
      tags:
      - Request
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: false
      x-atlassian-oauth2-scopes:
      - scheme: OAuth2
        scopes:
        - read:jira-work
        state: Current
      - scheme: OAuth2
        scopes:
        - read:request.sla:jira-service-management
        state: Beta
      x-atlassian-connect-scope: READ
  /rest/servicedeskapi/request/{issueIdOrKey}/sla/{slaMetricId}:
    get:
      deprecated: false
      description: 'This method returns the details for an SLA on a customer request.


        **Permissions required**:


        * Agent for the Service Desk containing the queried customer request, AND

        * Browse Projects permission on the project containing the customer request, including any restrictions imposed by issue security schemes or custom permission schemes on the specific issue.'
      operationId: getSlaInformationById
      parameters:
      - description: The ID or key of the customer request whose SLAs will be retrieved.
        in: path
        name: issueIdOrKey
        required: true
        schema:
          type: string
      - description: The ID or key of the SLAs metric to be retrieved.
        in: path
        name: slaMetricId
        required: true
        schema:
          format: int64
          type: integer
      responses:
        '200':
          content:
            application/json:
              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"}}}'
              schema:
                $ref: '#/components/schemas/SlaInformationDTO'
          description: Returns the SLA record, on the specified page of the results.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Returned if the user is not logged in.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Returned if the user does not have permission to view this customer request. This includes the case where the user is not an agent on the Service Desk, or where the user lacks Browse Projects permission on the issue (for example, due to an issue security scheme or a custom permission scheme).
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Returned if the customer request does not exist.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error.
      security:
      - OAuth2:
        - read:jira-work
      summary: Get sla information by id
      tags:
      - Request
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: false
      x-atlassian-oauth2-scopes:
      - scheme: OAuth2
        scopes:
        - read:jira-work
        state: Current
      - scheme: OAuth2
        scopes:
        - read:request.sla:jira-service-management
        state: Beta
      x-atlassian-connect-scope: READ
  /rest/servicedeskapi/request/{issueIdOrKey}/status:
    get:
      deprecated: false
      description: '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.'
      operationId: getCustomerRequestStatus
      parameters:
      - description: The ID or key of the customer request to be retrieved.
        in: path
        name: issueIdOrKey
        required: true
        schema:
          type: string
      - description: 'The starting index of the returned objects. Base index: 0. See the [Pagination](#pagination) section for more details.'
        in: query
        name: start
        schema:
          format: int32
          type: integer
      - description: 'The maximum number of items to return per page. Default: 50. See the [Pagination](#pagination) section for more details.'
        in: query
        name: limit
        schema:
          format: int32
          type: integer
      responses:
        '200':
          content:
            application/json:
              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"}}]}'
              schema:
                $ref: '#/components/schemas/PagedDTOCustomerRequestStatusDTO'
          description: Returns the customer request's status history, on the specified page of the results.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Returned if the user is not logged in.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Returned if the user does not have permission to complete this request.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Returned if the customer request is not found.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error.
      security:
      - OAuth2:
        - read:servicedesk-request
      summary: Get customer request status
      tags:
      - Request
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: false
      x-atlassian-oauth2-scopes:
      - scheme: OAuth2
        scopes:
        - read:servicedesk-request
        state: Current
      - scheme: OAuth2
        scopes:
        - read:request.status:jira-service-management
        - read:user:jira
        state: Beta
      x-atlassian-connect-scope: READ
  /rest/servicedeskapi/request/{issueIdOrKey}/transition:
    get:
      deprecated: false
      description: '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.'
      operationId: getCustomerTransitions
      parameters:
      - description: The ID or key of the customer request whose transitions will be retrieved.
        in: path
        name: issueIdOrKey
        required: true
        schema:
          type: string
      - description: 'The starting index of the returned objects. Base index: 0. See the [Pagination](#pagination) section for more details.'
        in: query
        name: start
        schema:
          format: int32
          type: integer
      - description: 'The maximum number of items to return per page. Default: 50. See the [Pagination](#pagination) section for more details.'
        in: query
        name: limit
        schema:
          format: int32
          type: integer
      responses:
        '200':
          content:
            application/json:
              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"}]}'
              schema:
                $ref: '#/components/schemas/PagedDTOCustomerTransitionDTO'
          description: Returns the transitions available to the user on the customer request.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Returned if the user is not logged in.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Returned if the user does not have permission to complete this request.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Returned if the customer request does not exist.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error.
      security:
      - OAuth2:
        - read:servicedesk-request
      summary: Get customer transitions
      tags:
      - Request
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: false
      x-atlassian-oauth2-scopes:
      - scheme: OAuth2
        scopes:
        - read:servicedesk-request
        state: Current
      - scheme: OAuth2
        scopes:
        - read:request.status:jira-service-management
        - read:user:jira
        state: Beta
      x-atlassian-connect-scope: READ
    post:
      deprecated: false
      description: '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.'
      operationId: performCustomerTransition
      parameters:
      - description: ID or key of the issue to transition
        in: path
        name: issueIdOrKey
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            example:
              additionalComment:
                body: I have fixed the problem.
              id: '1'
            schema:
              $ref: '#/components/schemas/CustomerTransitionExecutionDTO'
        required: true
      responses:
        '204':
          description: Returned if the request is transitioned.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Returned if the transition ID is invalid or the comment is too long.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Returned if the user is not logged in.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Returned if the user does not have permission to complete this request.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Returned if the request does not exist.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error.
      security:
      - OAuth2:
        - write:servicedesk-request
      summary: Perform customer transition
      tags:
      - Request
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: false
      x-atlassian-oauth2-scopes:
      - scheme: OAuth2
        scopes:
        - write:servicedesk-request
        state: Current
      - scheme: OAuth2
        scopes:
        - read:request.status:jira-service-management
        - write:request.status:jira-service-management
        - read:user:jira
        state: Beta
      x-atlassian-connect-scope: WRITE
  /rest/servicedeskapi/request/{requestIdOrKey}/feedback:
    delete:
      deprecated: false
      description: '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.'
      operationId: deleteFeedback
      parameters:
      - description: The id or the key of the request to post the feedback on
        in: path
        name: requestIdOrKey
        required: true
        schema:
          type: string
      responses:
        '204':
          content:
            application/json:
              schema: {}
          description: No content.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Returned if no logged in user/app.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Returned if the user/app does not have permission to complete this request.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Returned if the customer request does not exist.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error.
      security:
      - OAuth2:
        - write:servicedesk-request
      summary: Delete feedback
      tags:
      - Request
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: false
      x-atlassian-oauth2-scopes:
      - scheme: OAuth2
        scopes:
        - write:servicedesk-request
        state: Current
      - scheme: OAuth2
        scopes:
        - read:request.feedback:jira-service-management
        - delete:request.feedback:jira-service-management
        - read:user:jira
        state: Beta
      x-experimental: true
      x-atlassian-connect-scope: DELETE
    get:
      deprecated: false
      description: 'This method retrieves a feedback of a request using it''s `requestKey` or `requestId`


        **Permissions required**: User has view request permissions.'
      operationId: getFeedback
      parameters:
      - description: The id or the key of the request to post the feedback on
        in: path
        name: requestIdOrKey
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              example: '{"type":"csat","rating":4,"comment":{"body":"Great work!"}}'
              schema:
                $ref: '#/components/schemas/CSATFeedbackFullDTO'
          description: Returns the comment.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Returned if the HTTP request is invalid.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Returned if no logged in user/app.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Returned if the user/app does not have permission to complete this request.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Returned if the customer request does not exist.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error.
      security:
      - OAuth2:
        - read:servicedesk-request
      summary: Get feedback
      tags:
      - Request
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: false
      x-atlassian-oauth2-scopes:
      - scheme: OAuth2
        scopes:
        - read:servicedesk-request
        state: Current
      - scheme: OAuth2
        scopes:
        - read:request.feedback:jira-service-management
        - read:user:jira
        state: Beta
      x-experimental: true
      x-atlassian-connect-scope: READ
    post:
      deprecated: false
      description: '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.'
      operationId: postFeedback
      parameters:
      - description: The id or the key of the request to post the feedback on
        in: path
        name: requestIdOrKey
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            example:
              comment:
                body: Great work!
              rating: 4
              type: csat
            schema:
              $ref: '#/components/schemas/CSATFeedbackFullDTO'
        description: The feedback to be added on the request
        required: true
      responses:
        '201':
          content:
            application/json:
              example: '{"type":"csat","rating":4,"comment":{"body":"Great work!"}}'
              schema:
                $ref: '#/components/schemas/CSATFeedbackFullDTO'
          description: Returns the comment.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Returned if the HTTP request is invalid.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Returned if no logged in user/app.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Returned if the user/app does not have permission to complete this request.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Returned if the customer request does not exist.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error.
      security:
      - OAuth2:
        - write:servicedesk-request
      summary: Post feedback
      tags:
      - Request
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: false
      x-atlassian-oauth2-scopes:
      - scheme: OAuth2
        scopes:
        - write:servicedesk-request
        state: Current
      - scheme: OAuth2
        scopes:
        - read:request.feedback:jira-service-management
        - write:request.feedback:jira-service-management
        - read:user:jira
        state: Beta
      x-experimental: true
      x-atlassian-connect-scope: WRITE
components:
  schemas:
    CommentDTO:
      additionalProperties: false
      properties:
        _expands:
          description: List of items that can be expanded in the response by specifying the expand query parameter.
          items:
            type: string
          type: array
        _links:
          allOf:
          - $ref: '#/components/schemas/SelfLinkDTO'
          description: REST API URL link to the comment.
        attachments:
          allOf:
          - $ref: '#/components/schemas/PagedDTOAttachmentDTO'
          description: List of the attachments included in the comment.
        author:
          allOf:
          - $ref: '#/components/schemas/UserDTO'
          description: Details of the customer who authored the comment.
        body:
          description: Content of the comment.
          type: string
        created:
          allOf:
          - $ref: '#/components/schemas/DateDTO'
          description: Date the comment was created.
        id:
          description: ID of the comment.
          type: string
        public:
          description: Indicates whether the comment is public (true) or private/internal (false).
          type: boolean
        renderedBody:
          allOf:
          - $ref: '#/components/schemas/RenderedValueDTO'
          description: The rendered body of the comment.
      type: object
    ServiceDeskDTO:
      additionalProperties: false
      properties:
        _links:
          allOf:
          - $ref: '#/components/schemas/SelfLinkDTO'
          description: REST API URL to the service desk.
        id:
          description: ID of the service desk.
          type: string
        projectId:
          description: ID of the peer project for the service desk.
          type: string
        projectKey:
          description: Key of the peer project of the service desk.
          type: string
        projectName:
          description: Name of the project and service desk.
          type: string
        projectTypeKey:
          description: Key of the project type.
          type: string
      type: object
    UserDTO:
      additionalProperties: false
      properties:
        _links:
          allOf:
          - $ref: '#/components/schemas/UserLinkDTO'
          description: URLs for the customer record and related items.
        accountId:
          description: The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.
          type: string
        active:
          description: Indicates if the customer is active (true) or inactive (false)
          type: boolean
        displayName:
          description: Customer's name for display in a UI. Depending on the customer’s privacy settings, this may return an alternative value.
          type: string
        emailAddress:
          description: Customer's email address. Depending on the customer’s privacy settings, this may be returned as null.
          type: string
        key:
          description: This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.
          type: string
        name:
          description: This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.
          type: string
        timeZone:
          description: Customer time zone. Depending on the customer’s privacy settings, this may be returned as null.
          type: string
      type: object
    SlaInformationOngoingCycleDTO:
      additionalProperties: false
      properties:
        breachTime:
          allOf:
          - $ref: '#/components/schemas/DateDTO'
          description: Time and date at which the SLA cycle would have breached its limit.
        breached:
          description: Indicates whether the SLA has been breached (true) or not (false).
          type: boolean
        elapsedTime:
          allOf:
          - $ref: '#/components/schemas/DurationDTO'
          description: Duration of the service.
        goalDuration:
          allOf:
          - $ref: '#/components/schemas/DurationDTO'
          description: Duration within which the service should be completed.
        paused:
          description: Indicates whether the SLA is paused (true) or not (false).
          type: boolean
        remainingTime:
          allOf:
          - $ref: '#/components/schemas/DurationDTO'
          description: Duration remaining in which to complete the service.
        startTime:
          allOf:
          - $ref: '#/components/schemas/DateDTO'
          description: Time and date at which the SLA cycle started.
        withinCalendarHours:
          description: Indicates whether the SLA it timed during calendared working hours only (true) or not (false).
          type: boolean
      type: object
    PagedDTOCustomerTransitionDTO:
      additionalProperties: false
      properties:
        _expands:
          items:
            type: string
          type: array
        _links:
          allOf:
          - $ref: '#/components/schemas/PagedLinkDTO'
          description: List of the links relating to the page.
        isLastPage:
          description: Indicates if this is the last page of records (true) or not (false).
          type: boolean
        limit:
          description: Number of items to be returned per page, up to the maximum set for these objects in the current implementation.
          format: int32
          type: integer
        size:
          description: Number of items returned in the page.
          format: int32
          type: integer
        start:
          description: Index of the first item returned in the page.
          format: int32
          type: integer
        values:
          description: Details of the items included in the page.
          items:
            $ref: '#/components/schemas/CustomerTransitionDTO'
          type: array
      type: object
    CustomerTransitionDTO:
      additionalProperties: false
      properties:
        id:
          description: ID of the transition.
          type: string
        name:
          description: Name of the transition.
          type: string
      type: object
    RequestParticipantUpdateDTO:
      additionalProperties: false
      properties:
        accountIds:
          description: List of users, specified by account IDs, to add to or remove as participants in the request.
          items:
            type: string
          type: array
        usernames:
          description: This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. Use `accountIds` instead.
          items:
            type: string
          type: array
      type: object
    AttachmentCreateResultDTO:
      additionalProperties: false
      properties:
        attachments:
          allOf:
          - $ref: '#/components/schemas/PagedDTOAttachmentDTO'
          description: List of the attachments added.
        comment:
          allOf:
          - $ref: '#/components/schemas/CommentDTO'
          description: Details of the comment included with the attachments.
      type: object
    FormValidationErrorDTO:
      additionalProperties: false
      properties:
        code:
          description: Machine-readable validation error code.
          type: string
        context:
          description: Identifies the form entity that caused the validation error.
          items:
            $ref: '#/components/schemas/FormValidationErrorContextDTO'
          type: array
        detail:
          description: Detailed validation error message.
          type: string
        status:
          description: The HTTP status code.
          format: int32
          type: integer
        title:
          description: Short summary of the validation error.
          type: string
      type: object
    PagedDTOAttachmentDTO:
      additionalProperties: false
      properties:
        _expands:
          items:
            type: string
          type: array
        _links:
          allOf:
          - $ref: '#/components/schemas/PagedLinkDTO'
          description: List of the links relating to the page.
        isLastPage:
          description: Indicates if this is the last page of records (true) or not (false).
          type: boolean
        limit:
          description: Number of items to be returned per page, up to the maximum set for these objects in the current implementation.
          format: int32
          type: integer
        size:
          description: Number of items returned in the page.
          format: int32
          type: integer
        start:
          description: Index of the first item returned in the page.
          format: int32
          type: integer
        values:
          description: Details of the items included in the page.
          items:
            $ref: '#/components/schemas/AttachmentDTO'
          type: array
      type: object
    DurationDTO:
      additionalProperties: false
      properties:
        friendly:
          description: Duration in a user-friendly text format.
          type: string
        millis:
          description: Duration in milliseconds.
          format: int64
          type: integer
      type: object
    CommentCreateDTO:
      additionalProperties: false
      properties:
        body:
          description: Content of the comment.
          type: string
        public:
          description: Indicates whether the comment is public (true) or private/internal (false).
          type: boolean
      type: object
    CustomerRequestFieldValueDTO:
      additionalProperties: false
      properties:
        fieldId:
          description: ID of the field.
          type: string
        label:
          description: Text label for the field.
          type: string
        renderedValue:
          description: Value of the field rendered in the UI.
          type: object
        value:
          description: Value of the field.
      type: object
    CustomerRequestDTO:
      additionalProperties: false
      properties:
        _expands:
          description: List of items that can be expanded in the response by specifying the expand query parameter.
          items:
            type: string
          type: array
        _links:
          allOf:
          - $ref: '#/components/schemas/CustomerRequestLinkDTO'
          description: List of links associated with the request.
        actions:
          allOf:
          - $ref: '#/components/schemas/CustomerRequestActionsDTO'
          description: List of actions that the user can take on the request.
        attachments:
          allOf:
          - $ref: '#/components/schemas/PagedDTOAttachmentDTO'
          description: List of attachments included with the request.
        comments:
          allOf:
          - $ref: '#/components/schemas/PagedDTOCommentDTO'
          description: List of comments included with the request.
        createdDate:
          allOf:
          - $ref: '#/components/schemas/DateDTO'
          description: Date on which the request was created.
        currentStatus:
          allOf:
          - $ref: '#/components/schemas/CustomerRequestStatusDTO'
          description: Status of the request.
        issueId:
          description: ID of the request, as the peer issue ID.
          type: string
        issueKey:
          description: Key of the request, as the peer issue key.
          type: string
        participants:
          allOf:
          - $ref: '#/components/schemas/PagedDTOUserDTO'
          description: Expandable details of the customers participating in the request.
        reporter:
          allOf:
          - $ref: '#/components/schemas/UserDTO'
          description: Details of the customer reporting the request.
        requestFieldValues:
          description: JSON map of Jira field IDs and their values representing the content of the request. This list does not include hidden fields.
          items:
            $ref: '#/components/schemas/CustomerRequestFieldValueDTO'
          type: array
        requestType:
          allOf:
          - $ref: '#/components/schemas/RequestTypeDTO'
          description: Expandable details of the request type.
        requestTypeId:
          description: ID of the request type for the request.
          type: string
        serviceDesk:
          allOf:
          - $ref: '#/components/schemas/ServiceDeskDTO'
          description: Expandable details of the service desk.
        serviceDeskId:
          description: ID of the service desk the request belongs to.
          type: string
        sla:
          allOf:
          - $ref: '#/components/schemas/PagedDTOSlaInformationDTO'
          description: Expandable details of the SLAs relating to the request.
        status:
          allOf:
          - $ref: '#/components/schemas/PagedDTOCustomerRequestStatusDTO'
          description: Expandable details of the request's status history.
        summary:
          description: Summary of the request created
          type: string
      type: object
    CustomerRequestCreateMetaDTO:
      additionalProperties: false
      properties:
        canAddRequestParticipants:
          description: Flag indicating if participants can be added to a request (true) or not.
          type: boolean
        canRaiseOnBehalfOf:
          description: Flag indicating if a request can be raised on behalf of another user (true) or not.
          type: boolean
        requestTypeFields:
          description: List of the fields included in this request.
          items:
            $ref: '#/components/schemas/RequestTypeFieldDTO'
          type: array
      type: object
    RenderedValueDTO:
      additionalProperties: false
      properties:
        html:
          type: string
      type: object
    I18nErrorMessage:
      additionalProperties: false
      properties:
        i18nKey:
          type: string
        parameters:
          items:
            type: string
          type: array
      type: object
    CustomerRequestStatusDTO:
      additionalProperties: false
      properties:
        status:
          description: Name of the status condition.
          type: string
        statusCategory:
          description: Status category the status belongs to.
          enum:
          - UNDEFINED
          - NEW
          - INDETERMINATE
          - DONE
          type: string
        statusDate:
          allOf:
          - $ref: '#/components/schemas/DateDTO'
          description: Date on which the status was attained.
      type: object
    AttachmentLinkDTO:
      additionalProperties: false
      properties:
        content:
          description: URL for the attachment.
          format: uri
          type: string
        jiraRest:
          description: REST API URL for the attachment
          format: uri
          type: string
        self:
          format: uri
          type: string
        thumbnail:
          description: URL for the attachment's thumbnail image.
          format: uri
          type: string
      type: object
    Form:
      additionalProperties: true
      properties:
        answers:
          additionalProperties:
            $ref: '#/components/schemas/FormAnswer'
          description: JSON mapping of form field answers containing form field IDs and corresponding values.
          type: object
      type: object
    PagedDTOApprovalDTO:
      additionalProperties: false
      properties:
        _expands:
          items:
            type: string
          type: array
        _links:
          allOf:
          - $ref: '#/components/schemas/PagedLinkDTO'
          description: List of the links relating to the page.
        isLastPage:
          description: Indicates if this is the last page of records (true) or not (false).
          type: boolean
        limit:
          description: Number of items to be returned per page, up to the maximum set for these objects in the current implementation.
          format: int32
          type: integer
        size:
          description: Number of items returned in the page.
          format: int32
          type: integer
        start:
          description: Index of the first item returned in the page.
          format: int32
          type: integer
        values:
          description: Details of the items included in the page.
          items:
            $ref: '#/components/schemas/ApprovalDTO'
          type: array
      type: object
    RequestTypeFieldDTO:
      additionalProperties: false
      properties:
        defaultValues:
          description: List of default values for the field.
          items:
            $ref: '#/components/schemas/RequestTypeFieldValueDTO'
          type: array
        description:
          description: Description of the field.
          type: string
        fieldId:
          description: ID of the field.
          type: string
        jiraSchema:
          allOf:
          - $ref: '#/components/schemas/JsonTypeBean'
          description: Jira specific implementation details for the field in the UI.
        name:
          description: Name of the field.
          type: string
        presetValues:
          description: List of preset values for the field.
          items:
            type: string
          type: array
        required:
          description: Indicates if the field is required (true) or not (false).
          type: boolean
        validValues:
          description: List of valid values for the field.
          items:
            $ref: '#/components/schemas/RequestTypeFieldValueDTO'
          type: array
        visible:
          type: boolean
      type: object
    CSATFeedbackFullDTO:
      additionalProperties: false
      properties:
        comment:
          allOf:
          - $ref: '#/components/schemas/AdditionalCommentDTO'
          description: (Optional) The comment provided with this feedback.
        rating:
          description: A numeric representation of the rating, this must be an integer value between 1 and 5.
          format: int32
          type: integer
        type:
          description: 'Indicates the type of feedback, supported values: `csat`.'
          type: string
      type: object
    AdditionalCommentDTO:
      additionalProperties: false
      properties:
        body:
          description: Content of the comment.
          type: string
      type: object
    AttachmentCreateDTO:
      additionalProperties: false
      properties:
        additionalComment:
          allOf:
          - $ref: '#/components/schemas/AdditionalCommentDTO'
          description: Additional content of the comment
        public:
          description: Controls whether the comment and its attachments are visible to customers
          type: boolean
        temporaryAttachmentIds:
          description: List of IDs for the temporary attachments to be added to the customer request.
          items:
            type: string
          type: array
      type: object
    RequestTypeFieldValueDTO:
      additionalProperties: false
      properties:
        children:
          description: List of child fields.
          items:
            $ref: '#/components/schemas/RequestTypeFieldValueDTO'
          type: array
        label:
          description: Label for the field.
          type: string
        value:
          description: Value of the field.
          type: string
      type: object
    RequestFieldValidationErrorDTO:
      additionalProperties: false
      properties:
        field:
          description: The id of the request field that failed validation (matches a key in 'requestFieldValues').
          type: string
        message:
          description: A human-readable explanation of why this field failed validation.
          type: string
      type: object
    RequestTypeIconLinkDTO:
      additionalProperties: false
      properties:
        iconUrls:
          additionalProperties:
            format: uri
            type: string
          description: URLs for the request type icons.
          type: object
      type: object
    PagedDTOSlaInformationDTO:
      additionalProperties: false
      properties:
        _expands:
          items:
            type: string
          type: array
        _links:
          allOf:
          - $ref: '#/components/schemas/PagedLinkDTO'
          description: List of the links relating to the page.
        isLastPage:
          description: Indicates if this is the last page of records (true) or not (false).
          type: boolean
        limit:
          description: Number of items to be returned per page, up to the maximum set for these objects in the current implementation.
          format: int32
          type: integer
        size:
          description: Number of items returned in the page.
          format: int32
          type: integer
        start:
          description: Index of the first item returned in the page.
          format: int32
          type: integer
        values:
          description: Details of the items included in the page.
          items:
            $ref: '#/components/schemas/SlaInformationDTO'
          type: array
      type: object
    RequestTypeIconDTO:
      additionalProperties: false
      properties:
        _links:
          allOf:
          - $ref: '#/components/schemas/RequestTypeIconLinkDTO'
          description: Map of the URLs for the request type icons.
        id:
          description: ID of the request type icon.
          type: string
      type: object
    RequestNotificationSubscriptionDTO:
      additionalProperties: false
      properties:
        subscribed:
          description: Indicates whether the user is subscribed (true) or not (false) to the request's notifications.
          type: boolean
      type: object
    FormValidationErrorResponseDTO:
      additionalProperties: false
      properties:
        errorMessage:
          description: Description of the error.
          type: string
        errors:
          description: A list of validation errors.
          items:
            $ref: '#/components/schemas/FormValidationErrorDTO'
          type: array
        i18nErrorMessage:
          allOf:
          - $ref: '#/components/schemas/I18nErrorMessageDTO'
          description: Internationalized error message details.
      type: object
    SlaInformationCompletedCycleDTO:
      additionalProperties: false
      properties:
        breachTime:
          allOf:
          - $ref: '#/components/schemas/DateDTO'
          description: Time and date at which the SLA cycle breached in case of completed breached cycle or would have breached in case of non-breached completed cycle.
        breached:
          description: Indicates if the SLA (duration) was exceeded (true) or not (false).
          type: boolean
        elapsedTime:
          allOf:
          - $ref: '#/components/schemas/DurationDTO'
          description: Duration in which the service was completed.
        goalDuration:
          allOf:
          - $ref: '#/components/schemas/DurationDTO'
          description: Duration within which the service should have been completed.
        remainingTime:
          allOf:
          - $ref: '#/components/schemas/DurationDTO'
          description: Duration remaining after the service was completed.
        startTime:
          allOf:
          - $ref: '#/components/schemas/DateDTO'
          description: Time and date at which the SLA cycle started.
        stopTime:
          allOf:
          - $ref: '#/components/schemas/DateDTO'
          description: Time and date at which the SLA cycle completed.
      type: object
    CustomerTransitionExecutionDTO:
      additionalProperties: false
      properties:
        additionalComment:
          allOf:
          - $ref: '#/components/schemas/AdditionalCommentDTO'
          description: Comment explaining the reason for the transition.
        id:
          description: ID of the transition to be performed.
          type: string
      type: object
    AttachmentDTO:
      additionalProperties: false
      properties:
        _links:
          allOf:
          - $ref: '#/components/schemas/AttachmentLinkDTO'
          description: Various URLs for the attachment.
        author:
          allOf:
          - $ref: '#/components/schemas/UserDTO'
          description: Details of the user who attached the file.
        created:
          allOf:
          - $ref: '#/components/schemas/DateDTO'
          description: Date the attachment was added.
        filename:
          description: Filename of the item attached.
          type: string
        mimeType:
          description: MIME type of the attachment.
          type: string
        size:
          description: Size of the attachment in bytes.
          format: int64
          type: integer
      type: object
    I18nErrorMessageDTO:
      additionalProperties: false
      properties:
        i18nKey:
          description: Internationalization key for the error message.
          type: string
        parameters:
          description: Parameters used to render the internationalized error message.
          items:
            type: string
          type: array
      type: object
    PagedLinkDTO:
      additionalProperties: false
      properties:
        base:
          description: Base URL for the REST API calls.
          format: uri
          type: string
        context:
          type: string
        next:
          description: REST API URL for the next page, if there is one.
          format: uri
          type: string
        prev:
          description: REST API URL for the previous page, if there is one.
          format: uri
          type: string
        self:
          description: REST API URL for the current page.
          format: uri
          type: string
      type: object
    DateDTO:
      additionalProperties: false
      properties:
        epochMillis:
          description: Date as the number of milliseconds that have elapsed since 00:00:00 Coordinated Universal Time (UTC), 1 January 1970.
          format: int64
          type: integer
        friendly:
          description: Date in a user-friendly text format.
          type: string
        iso8601:
          description: Date in ISO8601 format.
          type: string
        jira:
          description: Date in the format used in the Jira REST APIs, which is ISO8601 format but extended with milliseconds. For example, 2016-09-28T23:08:32.097+1000.
          type: string
      type: object
    CustomerRequestActionsDTO:
      additionalProperties: false
      properties:
        addAttachment:
          allOf:
          - $ref: '#/components/schemas/CustomerRequestActionDTO'
          description: Action of adding attachments to a request.
        addComment:
          allOf:
          - $ref: '#/components/schemas/CustomerRequestActionDTO'
          description: Action of adding comments to a request.
        addParticipant:
          allOf:
          - $ref: '#/components/schemas/CustomerRequestActionDTO'
          description: Action of adding participants to a request.
        removeParticipant:
          allOf:
          - $ref: '#/components/schemas/CustomerRequestActionDTO'
          description: Action of removing participants from a request.
      type: object
    ApproverDTO:
      additionalProperties: false
      properties:
        approver:
          allOf:
          - $ref: '#/components/schemas/UserDTO'
          description: Details of the User who is providing approval.
        approverDecision:
          description: Decision made by the approver.
          enum:
          - approved
          - declined
          - pending
          type: string
      type: object
    PagedDTOCustomerRequestDTO:
      additionalProperties: false
      properties:
        _expands:
          items:
            type: string
          type: array
        _links:
          allOf:
          - $ref: '#/components/schemas/PagedLinkDTO'
          description: List of the links relating to the page.
        isLastPage:
          description: Indicates if this is the last page of records (true) or not (false).
          type: boolean
        limit:
          description: Number of items to be returned per page, up to the maximum set for these objects in the current implementation.
          format: int32
          type: integer
        size:
          description: Number of items returned in the page.
          format: int32
          type: integer
        start:
          description: Index of the first item returned in the page.
          format: int32
          type: integer
        values:
          description: Details of the items included in the page.
          items:
            $ref: '#/components/schemas/CustomerRequestDTO'
          type: array
      type: object
    CustomerRequestLinkDTO:
      additionalProperties: false
      properties:
        agent:
          description: Jira agent view URL for the request.
          format: uri
          type: string
        jiraRest:
          description: REST API URL for the request.
          format: uri
          type: string
        self:
          format: uri
          type: string
        web:
          description: Web URL for the request.
          format: uri
          type: string
      type: object
    SelfLinkDTO:
      additionalProperties: false
      properties:
        self:
          format: uri
          type: string
      type: object
    ApprovalDecisionRequestDTO:
      additionalProperties: false
      properties:
        decision:
          description: Response to the approval request.
          enum:
          - approve
          - decline
          type: string
      type: object
    UserLinkDTO:
      additionalProperties: false
      properties:
        avatarUrls:
          additionalProperties:
            type: string
          description: Links to the various sizes of the customer's avatar. Note that this property is deprecated, and will be removed in future versions.
          type: object
        jiraRest:
          description: REST API URL for the customer.
          format: uri
          type: string
        self:
          format: uri
          type: string
      type: object
    JsonNode:
      additionalProperties: false
      properties:
        array:
          type: boolean
        bigDecimal:
          type: boolean
        bigInteger:
          type: boolean
        bigIntegerValue:
          type: integer
        binary:
          type: boolean
        binaryValue:
          items:
            format: byte
            type: string
          type: array
        boolean:
          type: boolean
        booleanValue:
          type: boolean
        containerNode:
          type: boolean
        decimalValue:
          type: number
        double:
          type: boolean
        doubleValue:
          format: double
          type: number
        elements:
          type: object
        fieldNames:
          type: object
        fields:
          type: object
        floatingPointNumber:
          type: boolean
        int:
          type: boolean
        intValue:
          format: int32
          type: integer
        integralNumber:
          type: boolean
        long:
          type: boolean
        longValue:
          format: int64
          type: integer
        missingNode:
          type: boolean
        'null':
          type: boolean
        number:
          type: boolean
        numberType:
          enum:
          - INT
          - LONG
          - BIG_INTEGER
          - FLOAT
          - DOUBLE
          - BIG_DECIMAL
          type: string
        numberValue:
          type: number
        object:
          type: boolean
        pojo:
          type: boolean
        textValue:
          type: string
        textual:
          type: boolean
        valueAsBoolean:
          type: boolean
        valueAsDouble:
          format: double
          type: number
        valueAsInt:
          format: int32
          type: integer
        valueAsLong:
          format: int64
          type: integer
        valueAsText:
          type: string
        valueNode:
          type: boolean
      type: object
    PagedDTOCustomerRequestStatusDTO:
      additionalProperties: false
      properties:
        _expands:
          items:
            type: string
          type: array
        _links:
          allOf:
          - $ref: '#/components/schemas/PagedLinkDTO'
          description: List of the links relating to the page.
        isLastPage:
          description: Indicates if this is the last page of records (true) or not (false).
          type: boolean
        limit:
          description: Number of items to be returned per page, up to the maximum set for these objects in the current implementation.
          format: int32
          type: integer
        size:
          description: Number of items returned in the page.
          format: int32
          type: integer
        start:
          description: Index of the first item returned in the page.
          format: int32
          type: integer
        values:
          description: Details of the items included in the page.
          items:
            $ref: '#/components/schemas/CustomerRequestStatusDTO'
          type: array
      type: object
    SlaInformationDTO:
      additionalProperties: false
      properties:
        _links:
          allOf:
          - $ref: '#/components/schemas/SelfLinkDTO'
          description: REST API URL for the SLA.
        completedCycles:
          description: List of completed cycles for the SLA.
          items:
            $ref: '#/components/schemas/SlaInformationCompletedCycleDTO'
          type: array
        id:
          description: ID of the Service Level Agreement (SLA).
          type: string
        name:
          description: Description of the SLA.
          type: string
        ongoingCycle:
          allOf:
          - $ref: '#/components/schemas/SlaInformationOngoingCycleDTO'
          description: Details of the active cycle for the SLA.
        slaDisplayFormat:
          description: Format in which SLA is to be displayed in the UI
          type: string
      type: object
    FormValidationErrorContextDTO:
      additionalProperties: false
      properties:
        id:
          description: ID of the form entity related to the validation error.
          type: string
        type:
          description: Type of form entity related to the validation error.
          type: string
      type: object
    PagedDTOUserDTO:
      additionalProperties: false
      properties:
        _expands:
          items:
            type: string
          type: array
        _links:
          allOf:
          - $ref: '#/components/schemas/PagedLinkDTO'
          description: List of the links relating to the page.
        isLastPage:
          description: Indicates if this is the last page of records (true) or not (false).
          type: boolean
        limit:
          description: Number of items to be returned per page, up to the maximum set for these objects in the current implementation.
          format: int32
          type: integer
        size:
          description: Number of items returned in the page.
          format: int32
          type: integer
        start:
          description: Index of the first item returned in the page.
          format: int32
          type: integer
        values:
          description: Details of the items included in the page.
          items:
            $ref: '#/components/schemas/UserDTO'
          type: array
      type: object
    CustomerRequestActionDTO:
      additionalProperties: false
      properties:
        allowed:
          description: Indicates whether the user can undertake the action (true) or not (false).
          type: boolean
      type: object
    RequestTypeDTO:
      additionalProperties: false
      properties:
        _expands:
          description: List of items that can be expanded in the response by specifying the expand query parameter.
          items:
            type: string
          type: array
        _links:
          allOf:
          - $ref: '#/components/schemas/SelfLinkDTO'
          description: REST API URL for the request type.
        canCreateRequest:
          description: Whether the user has permission to create a request with this request type.
          type: boolean
        description:
          description: Description of the request type.
          type: string
        fields:
          allOf:
          - $ref: '#/components/schemas/CustomerRequestCreateMetaDTO'
          description: Fields and additional metadata for creating a request that uses the request type
        groupIds:
          description: List of the request type groups the request type belongs to.
          items:
            type: string
          type: array
        helpText:
          description: Help text for the request type.
          type: string
        icon:
          allOf:
          - $ref: '#/components/schemas/RequestTypeIconDTO'
          description: Links to the request type's icons.
        id:
          description: ID for the request type.
          type: string
        issueTypeId:
          description: ID of the issue type the request type is based upon.
          type: string
        name:
          description: Short name for the request type.
          type: string
        portalId:
          description: ID of the customer portal associated with the service desk project.
          type: string
        practice:
          description: The request type's practice
          type: string
        restrictionStatus:
          description: Whether request type is restricted or not.
          enum:
          - OPEN
          - RESTRICTED
          type: string
        serviceDeskId:
          description: ID of the service desk the request type belongs to.
          type: string
      type: object
    RequestCreateDTO:
      additionalProperties: false
      properties:
        channel:
          description: (Experimental) Shows extra information for the request channel.
          type: string
        form:
          allOf:
          - $ref: '#/components/schemas/Form'
          description: Provides answers to the form associated with a request type. Omit Jira fields from `requestFieldValues` if they're linked to form answers. For form answers in ADF format, set `isAdfRequest` to true.
        isAdfRequest:
          description: (Experimental) Whether to accept rich text fields in Atlassian Document Format (ADF).
          type: boolean
        raiseOnBehalfOf:
          description: The `accountId` of the customer that the request is being raised on behalf of.
          type: string
        requestFieldValues:
          additionalProperties: {}
          description: JSON map of Jira field IDs and their values representing the content of the request.
          type: object
        requestParticipants:
          description: List of customers to participate in the request, as a list of `accountId` values.
          items:
            type: string
          type: array
        requestTypeId:
          description: ID of the request type for the request.
          type: string
        serviceDeskId:
          description: ID of the service desk in which to create the request.
          type: string
      type: object
    PagedDTOCommentDTO:
      additionalProperties: false
      properties:
        _expands:
          items:
            type: string
          type: array
        _links:
          allOf:
          - $ref: '#/components/schemas/PagedLinkDTO'
          description: List of the links relating to the page.
        isLastPage:
          description: Indicates if this is the last page of records (true) or not (false).
          type: boolean
        limit:
          description: Number of items to be returned per page, up to the maximum set for these objects in the current implementation.
          format: int32
          type: integer
        size:
          description: Number of items returned in the page.
          format: int32
          type: integer
        start:
          description: Index of the first item returned in the page.
          format: int32
          type: integer
        values:
          description: Details of the items included in the page.
          items:
            $ref: '#/components/schemas/CommentDTO'
          type: array
      type: object
    ApprovalDTO:
      additionalProperties: false
      properties:
        _links:
          allOf:
          - $ref: '#/components/schemas/SelfLinkDTO'
          description: The REST API URL of the approval.
        approvers:
          description: Detailed list of the users who must provide a response to the approval.
          items:
            $ref: '#/components/schemas/ApproverDTO'
          type: array
        canAnswerApproval:
          description: Indicates whether the user making the request is one of the approvers and can respond to the approval (true) or not (false).
          type: boolean
        completedDate:
          allOf:
          - $ref: '#/components/schemas/DateDTO'
          description: Date the approval was completed.
        createdDate:
          allOf:
          - $ref: '#/components/schemas/DateDTO'
          description: Date the approval was created.
        finalDecision:
          description: Outcome of the approval, based on the approvals provided by all approvers.
          enum:
          - approved
          - declined
          - pending
          type: string
        id:
          description: ID of the approval.
          type: string
        name:
          description: Description of the approval being sought or provided.
          type: string
      type: object
    ErrorResponse:
      additionalProperties: false
      properties:
        errorMessage:
          type: string
        i18nErrorMessage:
          $ref: '#/components/schemas/I18nErrorMessage'
      type: object
    FormAnswer:
      additionalProperties: false
      properties:
        adf:
          allOf:
          - $ref: '#/components/schemas/JsonNode'
          description: Answer in Atlassian Document Format (ADF)
        choices:
          description: IDs of selected choices
          items:
            type: string
          type: array
        date:
          description: Answer in date format (yyyy-MM-dd)
          type: string
        files:
          description: The IDs of files to be attached to the form that are obtained by calling the ‘attach temporary file’ endpoint on the corresponding service desk.
          items:
            type: string
          type: array
        text:
          description: Answer in free text format
          type: string
        time:
          description: Answer in timestamp format (HH:mm)
          type: string
        users:
          description: IDs of selected users
          items:
            type: string
          type: array
      type: object
    RequestValidationResultDTO:
      additionalProperties: false
      properties:
        errorMessage:
          description: A single, human-readable summary describing why validation failed. Null when valid.
          type: string
        errorMessages:
          description: General validation errors that are not attributable to a single field. Empty when valid.
          items:
            type: string
          type: array
        fieldErrors:
          description: Field-level validation errors, keyed by the failing request field id. Empty when valid.
          items:
            $ref: '#/components/schemas/RequestFieldValidationErrorDTO'
          type: array
        formErrors:
          description: ProForma form validation errors, if a form was supplied. Empty when valid or no form was present.
          items:
            $ref: '#/components/schemas/FormValidationErrorDTO'
          type: array
        reasonKey:
          description: A machine-readable reason key categorising the overall failure. Null when valid.
          type: string
        valid:
          description: True when the payload is both structurally and semantically valid and safe to create.
          type: boolean
      type: object
    JsonTypeBean:
      additionalProperties: false
      description: The schema of a field.
      properties:
        configuration:
          additionalProperties:
            readOnly: true
          description: If the field is a custom field, the configuration of the field.
          readOnly: true
          type: object
        custom:
          description: If the field is a custom field, the URI of the field.
          readOnly: true
          type: string
        customId:
          description: If the field is a custom field, the custom ID of the field.
          format: int64
          readOnly: true
          type: integer
        items:
          description: When the data type is an array, the name of the field items within the array.
          readOnly: true
          type: string
        system:
          description: If the field is a system field, the name of the field.
          readOnly: true
          type: string
        type:
          description: The data type of the field.
          readOnly: true
          type: string
      required:
      - type
      type: object
  securitySchemes:
    OAuth2:
      description: OAuth2 scopes for Jira
      flows:
        authorizationCode:
          authorizationUrl: https://auth.atlassian.com/authorize
          scopes:
            delete:organization.property:jira-service-management: Allows the app to delete organisation entity properties
            delete:organization.user:jira-service-management: Allows the app to remove members from organisations
            delete:organization:jira-service-management: Allows the app to delete organisations
            delete:request.feedback:jira-service-management: Allows the app to remove feedback data from requests
            delete:request.notification:jira-service-management: Allows the app to remove the subscription status of the user from requests
            delete:request.participant:jira-service-management: Allows the app to remove participants (user) data from requests
            delete:requesttype.property:jira-service-management: Allows the app to delete request type entity properties
            delete:servicedesk.customer:jira-service-management: Allows the app the delete customers from service desks
            delete:servicedesk.organization:jira-service-management: Allows the app the delete organisations from service desks
            delete:servicedesk.property:jira-service-management: Allows the app to delete service desk entity properties
            manage:jira-configuration: Configure Jira settings that require the Jira administrators permission, for example, create projects and custom fields, view workflows, manage issue link types.
            manage:jira-project: Create and edit project settings and create new project-level objects, for example, versions, components.
            manage:jira-webhook: Manage Jira webhooks. Enables an OAuth app to register and unregister dynamic webhooks in Jira. It also provides for fetching of registered webhooks.
            manage:servicedesk-customer: Manage Jira Service Management customers and organizations | Create, manage and delete customers and organizations.<br>Add and remove customers and organizations from service desks.
            read:customer:jira-service-management: Allows the app to read customer accounts information
            read:jira-user: View user information in Jira that you have access to, including usernames, email addresses, and avatars.
            read:jira-work: Read project and issue data. Search for issues and objects associated with issues (such as attachments and worklogs).
            read:knowledgebase:jira-service-management: Allows the app to search and list KB articles
            read:mail-logs.connectivity:jira-service-management: Allows the app to read email connectivity logs
            read:mail-logs.processing:jira-service-management: Allows the app to read incoming email processing logs
            read:organization.property:jira-service-management: Allows the app to read organisation entity properties
            read:organization.user:jira-service-management: Allows the app to read organisation membership information
            read:organization:jira-service-management: Allows the app to read organisation information
            read:queue:jira-service-management: Allows the app to list queues
            read:request.action:jira-service-management: Allows the app to read which actions can be performed on requests
            read:request.approval:jira-service-management: Allows the app to read approval data from requests
            read:request.attachment:jira-service-management: Allows the app to read attachment data from requests
            read:request.comment:jira-service-management: Allows the app to read comment data from requests
            read:request.feedback:jira-service-management: Allows the app to read feedback data from requests
            read:request.notification:jira-service-management: Allows the app to read the subscription status of the user for requests
            read:request.participant:jira-service-management: Allows the app to read participant (user) data from requests
            read:request.sla:jira-service-management: Allows the app to read SLA data from requests
            read:request.status:jira-service-management: Allows the app to read status/transition data from requests
            read:request:jira-service-management: Allows the app to list & search requests
            read:requesttype.property:jira-service-management: Allows the app to read request type desk entity properties
            read:requesttype:jira-service-management: Allows the app to list & search request types
            read:servicedesk-request: Read customer request data, including approvals, attachments, comments, request participants, and status/transitions.<br>Read service desk and request types, including searching for request types and reading request type fields, properties and groups.
            read:servicedesk.customer:jira-service-management: Allows the app the list customers of service desks
            read:servicedesk.organization:jira-service-management: Allows the app to list organisations to service desks
            read:servicedesk.property:jira-service-management: Allows the app to read service desk entity properties
            read:servicedesk:jira-service-management: Allows the app to list & search service desks
            write:customer:jira-service-management: Allows the app to create customer accounts (user)
            write:jira-work: Create and edit issues in Jira, post comments, create worklogs, and delete issues.
            write:organization.property:jira-service-management: Allows the app to write organisation entity properties
            write:organization.user:jira-service-management: Allows the app to add members to organisations
            write:organization:jira-service-management: Allows the app to create organisations
            write:request.approval:jira-service-management: Allows the app to act on approvals of requests (e.g approve, deny, …)
            write:request.attachment:jira-service-management: Allows the app to add attachments to requests
            write:request.comment:jira-service-management: Allows the app to add comments to requests
            write:request.feedback:jira-service-management: Allows the app to write feedback data on requests
            write:request.notification:jira-service-management: Allows the app to change the subscription status of the user for requests
            write:request.participant:jira-service-management: Allows the app to add participants (user) data from requests
            write:request.status:jira-service-management: Allows the app to execute transitions on requests
            write:request:jira-service-management: Allows the app to create requests
            write:requesttype.property:jira-service-management: Allows the app to write request type entity properties
            write:requesttype:jira-service-management: Allows the app to create or modify request types
            write:servicedesk-request: Create and manage Jira Service Management requests | Create and edit customer requests, including add comments and attachments, approve, share (add request participants), subscribe, and transition.
            write:servicedesk.customer:jira-service-management: Allows the app the add customers to service desks
            write:servicedesk.organization:jira-service-management: Allows the app the add organisations to service desks
            write:servicedesk.property:jira-service-management: Allows the app to write service desk entity properties
            write:servicedesk:jira-service-management: Allows the app the add organisations, customers and request types to service desks
          tokenUrl: https://auth.atlassian.com/oauth/token
      type: oauth2
    basicAuth:
      description: You can access this resource via basic auth.
      scheme: basic
      type: http
x-atlassian-narrative:
  documents:
  - anchor: about
    body: 'The REST APIs are for developers who want to integrate Jira Service Management with other applications or administrators who want to automate their workflows and processes.

      '
    title: About
  - anchor: jira-cloud-platform-apis
    body: "Jira Service Management is built upon the Jira platform. As such, in Jira Service Management you have access to the Jira platform REST APIs.\n\n * [Browse the Jira platform REST APIs](/cloud/jira/platform/rest/)\n"
    title: Jira Cloud Platform APIs
  - anchor: permissions
    body: 'Permissions control the level of a user''s access to the Jira Service Management instance, while roles are how the permissions are assigned to individual users.


      For detailed information on roles and permissions, see [Permissions overview](https://support.atlassian.com/jira-service-management-cloud/docs/overview-of-jira-cloud-permissions/)

      and [Setting up service management users](https://support.atlassian.com/jira-service-management-cloud/docs/set-up-service-desk-users-to-work-on-requests/).

      '
    title: Permissions and roles
  - anchor: authentication
    body: 'The Jira Service Management REST API uses the same authentication methods as Jira Cloud platform.


      ### Forge apps


      Forge apps use [REST API scopes](https://developer.atlassian.com/cloud/jira/service-desk/scopes-for-oauth-2-3LO-and-forge-apps/) when authenticating with Jira Service Management Cloud. For details see [Add scopes to call an Atlassian REST API](https://developer.atlassian.com/platform/forge/add-scopes-to-call-an-atlassian-rest-api/).


      The URIs for Forge app REST API calls have this structure:


      `https://<site-url>/rest/servicedeskapi/<resource-name>`


      For example, `https://<site-url>/rest/servicedeskapi/request/DEMO-1`



      ### Connect apps


      For Connect apps, authentication (JWT-based) is built into the Connect libraries. Authorization is implemented using either scopes (shown as App scope required for operations on this page) or user impersonation. For details, see [Security for Connect apps](https://developer.atlassian.com/cloud/jira/service-desk/security-for-connect-apps/).


      The URIs for Connect app REST API calls have this structure:


      `https://<site-url>/rest/servicedeskapi/<resource-name>`


      For example, `https://<site-url>/rest/servicedeskapi/request/DEMO-1`


      ### Other integrations

      For integrations that are not Forge or Connect apps, use OAuth 2.0 authorization code grants (3LO) for security (3LO scopes are shown as for operations OAuth scopes required). For details, see [OAuth 2.0 (3LO) apps](https://developer.atlassian.com/cloud/jira/service-desk/oauth-2-authorization-code-grants-3lo-for-apps/).


      The URIs for OAuth 2.0 (3LO) app REST API calls have this structure:


      `https://api.atlassian.com/ex/jira/<cloudId>/rest/servicedeskapi/<resource-name>`


      For example, `https://api.atlassian.com/ex/jira/35273b54-3f06-40d2-880f-dd28cf8daafa/rest/servicedeskapi/request/DEMO-1`



      ### Ad-hoc API calls


      For personal scripts, bots, and ad-hoc execution of the REST APIs use basic authentication. For details, see [Basic auth for REST APIs](https://developer.atlassian.com/cloud/jira/service-desk/basic-auth-for-rest-apis/).


      The URIs for basic authentication REST API calls have this structure:


      `https://<site-url>/rest/servicedeskapi/<resource-name>`


      For example, `https://your-domain.atlassian.net/rest/servicedeskapi/request/DEMO-1`



      '
    title: Authentication and authorization
  - anchor: scopes
    body: 'Your app can request access to the Jira Service Management REST APIs by using the correct scopes.




      * [Scopes for Forge and 3LO apps](https://developer.atlassian.com/cloud/jira/service-desk/scopes-for-oauth-2-3LO-and-forge-apps/)

      * [Scopes for Connect apps](https://developer.atlassian.com/cloud/jira/service-desk/scopes-for-connect-apps/).

      '
    title: Scopes
  - anchor: desks
    body: "It is also worth noting that the ability of Customers to raise Requests depends on the service desk type, which can be:\n\n -   Public (sign up): Anyone who has the service desk URL can submit requests, and a user (customer) is created for them when a request is submitted.\n -   Open: Any user in the system can submit requests, they don’t need to be associated with the service desk.\n -   Closed: Only users associated with the service desk can submit requests.\n\nFor more details, see [How to manage access to your Jira Service Management Cloud](https://confluence.atlassian.com/jirakb/how-to-manage-access-to-your-jira-service-desk-cloud-967872675.html) in the Jira Service Management Cloud documentation.\n\n"
    title: Service desk types
  - anchor: status
    body: "\n -   <span class=\"aui-lozenge aui-lozenge-success\">Status 200</span> Returned if the requested content (GET) is returned or content is updated (PUT).\n -   <span class=\"aui-lozenge aui-lozenge-success\">Status 201</span> Returned if new records are created (PUT).\n -   <span class=\"aui-lozenge aui-lozenge-success\">Status 204</span> Returned where the request may or may not have been actioned, but the outcome is as expected. For example, the request was to remove a customer from an organization, but the customer was not associated with the organization.\n -   <span class=\"aui-lozenge aui-lozenge-error\">Status 400</span> Returned if the request was invalid.\n -   <span class=\"aui-lozenge aui-lozenge-error\">Status 401</span> Returned if the user is not logged in. Resolve by logging the user in and reissuing the call.\n -   <span class=\"aui-lozenge aui-lozenge-error\">Status 403</span> Returned if the user does not have the necessary permission to access the resource or run the method.\n -   <span class=\"aui-lozenge aui-lozenge-error\">Status 404</span> Returned if the passed path parameters do not correspond to an object in the instance, for example, no Organization exists for a passed ID.\n -   <span class=\"aui-lozenge aui-lozenge-error\">Status 412</span> Returned if the API is experimental but the `X-ExperimentalApi: opt-in` header was not passed. For more details, see [Experimental methods](#experimental).\n\nResources will return a response body in addition to the error status codes. The returned entity for errors is as follows:\n\n```json\n{\n  \"errorMessage\": \"Here is an error message\",\n  \"i18nErrorMessage\": {\n    \"i18nKey\": \"some.error.key\",\n    \"parameters\": []\n  }\n}\n```\n"
    title: Status codes and responses
  - anchor: experimental
    body: 'Methods marked as <span class="aui-lozenge aui-lozenge-subtle aui-lozenge-current">experimental</span> may change without notice. To use experimental methods, you must include the `X-ExperimentalApi: opt-in` header in your requests. Use of this header indicates that you are opting into the experimental preview. Once a resource or method moves out of the experimental phase, then the header will no longer be required or checked.


      Feedback on the experimental APIs is welcome and can be provided by submitting a feature request or suggestion through the [Atlassian Ecosystem Help Center](https://ecosystem.atlassian.net/servicedesk/customer/portals) or the [Jira Service Management Ecosystem](https://ecosystem.atlassian.net/browse/JSDECO).

      '
    title: Experimental methods
  - anchor: expansion
    body: "The Jira Service Management REST API uses resource expansion, which means that some parts of a resource are not returned unless specified in the request. This simplifies responses and minimizes network traffic.\n\nUse the `expand` query parameter to specify the list of entities that you want to be expanded, identifying each of them by name. For example, appending `?expand=serviceDesk&expand=requestType` to a request’s URI results in the inclusion of the service desk and request type details in the response. The following URL would be used to get that information for the request with the ID JSD-1:\n```\nhttp://host:port/context/rest/servicedeskapi/request/JSD-1?expand=serviceDesk&expand=requestType\n```\n\nAlternatively, you can pass the list of entities you want to be expanded as a single comma-separated parameter, as in:\n\n```\nhttp://host:port/context/rest/servicedeskapi/request/JSD-1?expand=serviceDesk,requestType\n```\n\nTo discover the expansion identifiers for each entity, look at the `_expands` property in the parent object. In the JSON example below, the resource declares `participant`, `status`, `sla`, `requestType`, and `serviceDesk` as expandable.\n\n```json\n{\n    \"_expands\": [\n        \"participant\",\n        \"status\",\n        \"sla\",\n        \"requestType\",\n        \"serviceDesk\"\n    ],\n    \"issueId\": \"107001\",\n    \"issueKey\": \"HELPDESK-1\",\n    \"requestTypeId\": \"11001\",\n    \"serviceDeskId\": \"10001\",\n    ...\n```\n\n"
    title: Expansion
  - anchor: pagination
    body: "The Jira Service Management REST API uses pagination to improve performance. Pagination is enforced for operations that could return a large collection of items. When you make a request to a paginated resource, the response wraps the returned array of values in a JSON object with paging metadata as follows:\n**Request**\n\n```\nhttp://host:port/context/rest/api-name/resource-name?start=0&limit=10\n```\n\n**Response**\n\n```json\n{\n    \"start\" : 0,\n    \"limit\" : 10,\n    \"size\" : 7,\n    \"isLastPage\" : true,\n    \"values\": [\n        { /* result 0 */ },\n        { /* result 1 */ },\n        { /* result 2 */ }\n        { /* result 3 */ }\n        { /* result 4 */ }\n        { /* result 5 */ }\n        { /* result 6 */ }\n    ]\n}\n```\n\nWhere:\n\n - `start` is the index of the first item returned in the page of results.\n - `limit` is the total number of items that could be returned per page, subject to the maximum server enforced limit for the resource’s method. If `limit` isn’t specified the default value of the resource is used.\n - `size` is the number of items returned on this page.\n - `isLastPage` indicates whether the page is the last page of results.\n\nClients can use the `start`, `limit`, and `size` parameters to retrieve the desired number of results. Each resource or method has a unique limit on the maximum number of items returned, which cannot be exceeded. If you request `size` which is larger than the limit, the number of items returned will be capped at the limit for that resource’s method. This behavior can be identified when the first page shows `size` is less than `limit` and `isLastPage` is `false`.\n\nThe limits set for each resource’s method is an implementation detail and may be changed.\n"
    title: Pagination
  - anchor: request-language
    body: "By default, responses are translated based on the requesting user's language preference, or the Jira site default \nlanguage if anonymous.\n\nUse the `requestLanguage` query parameter to have responses translated in a specific language, providing an \n[IETF BCP 47](https://tools.ietf.org/html/bcp47) language tag in the form `(language code)-(country code)` as the value. \nE.g. `?requestLanguage=en-US` for English (United States). Both static text (e.g. error messages) and dynamic \nuser-entered text (e.g. workflow status names) will be translated, if available.\n\nThe languages available are based on the installed languages in Jira. If the language tag specified does not match one \nof Jira's languages, then the query parameter will have no effect.\n\nDynamic user-entered translations can be edited in Jira administration for global objects (e.g. priority names) and \nin **Language support** under project administration for Service Desk projects (e.g. request type names)."
    title: Request language
  - anchor: special-headers
    body: "The following request and response headers define important metadata for the Jira Service Management REST API resources.\n\n -   **X-Atlassian-Token** (request): Operations that accept multipart/form-data must include the `X-Atlassian-Token: no-check` header in requests.\nOtherwise the request will be blocked by XSRF protection.\n -   **X-ExperimentalApi** (request): Experimental operations must include the `X-ExperimentalApi: opt-in` header in requests.\n Otherwise the request will not be processed. See [Experimental methods](#experimental) for more details.\n-   **X-AACCOUNTID** (response): This response header contains the Atlassian account ID of the authenticated user.\n"
    title: Special headers
  - anchor: project-identifiers
    body: "For convenience, any of the resources that require a `{serviceDeskId}` path parameter also accept other identifiers.\n\nFor example, if a `ServiceDesk(id: 15)` corresponds to a `Project(id: 10012, key: ABC)`, then issuing a request to any of:\n\n    /rest/servicedeskapi/servicedesk/ABC\n\n    /rest/servicedeskapi/servicedesk/projectKey:ABC\n\n    /rest/servicedeskapi/servicedesk/projectId:10012\n\n    /rest/servicedeskapi/servicedesk/serviceDeskId:15\n\nis equivalent to issuing a request to:\n\n    /rest/servicedeskapi/servicedesk/15\n"
    title: Using project identifiers
  - anchor: fieldformats
    body: '**Summary** - _A single line of text._


      ```json


      "summary": "An explanation is one line of text."


      ```


      **Description** - _Multiple lines of text._


      ```json


      "description": "A description is multiples lines of text\n separated by\n line feeds.",


      ```


      **Components** - _Multiple values addressed by ''name''._


      ```json


      "components" : [ { "name": "Active Directory"} , { "name": "Network Switch" } ]


      ```


      **Due date** - _A date in ''YYYY-MM-DD'' format._


      ```json


      "duedate" : "2015-11-18"


      ```


      **Labels** - _An array of string values._


      ```json


      "labels" : ["examplelabelnumber1", "examplelabelnumber2"]


      ```


      **Checkbox custom field** - _A custom UI field that enables multiple values to be selected from a defined list of values, with values addressed by ''value'' or `id`._


      ```json


      "customfield_11440" : [{ "value" : "option1"}, {"value" : "option2"}]


      or


      "customfield_11440" : [{ "id" : 10112}, {"id" : 10115}]


      ```


      **Date picker custom field** - _A custom UI field that enables a date in ''YYYY-MM-DD'' format to be picked._


      ```json


      "customfield_11441" : "2015-11-18"


      ```


      **Date time picker custom field** - _A custom UI field enables a datetime in ISO 8601 (''YYYY-MM-DDThh:mm:ss.sTZD'') format to be picked._


      ```json


      "customfield_11442" : "2015-11-18T14:39:00.000+1100"


      ```


      **Labels custom field** - _A custom UI field that is an array of strings._


      ```json


      "customfield_11443" : [ "rest_label1", "rest_label2" ]


      ```


      **Number custom field** - _A custom UI field that enables a number to be entered._


      ```json


      "customfield_11444" : 666


      ```


      **Radio button custom field** - _A custom UI field that enables a single value to be selected from a defined list of values, with values addressed by `value` or `id`._


      ```json


      "customfield_11445" : { "value": "option2" }


      or


      "customfield_11445" : { "id": 10112 }


      ```


      **Cascading select custom field** - _A custom UI field that enables a single parent value and then a related child value to be selected, with values addressed by `value` or `id`._


      ```json


      "customfield_11447" : { "value": "parent_option1", "child": { "value" : "p1_child1"} }


      or


      "customfield_11447" : { "id": 10112, "child": { "id" : 10115 } }


      ```


      **Multi-select custom field** - _A custom UI field that enables multiple values to be selected from a defined list of values, with values addressed by `value` or `id`._


      ```json


      "customfield_11448" : [ { "value": "option1" }, { "value": "option2" } ]


      or


      "customfield_11448" : [ { "id": 10112 }, { "id": 10115 } ]


      ```


      **Single-select custom field** - _A custom UI field that enables a single value to be selected from a defined list of values, with values address by `value` or `id`._


      ```json


      "customfield_11449" : { "value": "option3" }


      or


      "customfield_11449" : { "id": 10112 }


      ```


      **Multi-line text custom field** - _A custom UI field that enables multiple lines of text to be entered._


      ```json


      "customfield_11450": "Multiples lines of text\n separated by\n line feeds"


      ```


      **Text custom field** - _A custom UI field that enables a single line of text to be entered._


      ```json


      "customfield_11450": "A single line of text."


      ```


      **URL custom field** - _A custom UI field that enables a URL to be entered._


      ```json


      "customfield_11452" : "http://www.atlassian.com",


      ```


      **Single-user picker custom field** - _A custom UI field that enables a single user to be selected._


      ```json


      "customfield_11453" : { "name":"tommytomtomahawk" },


      ```


      **Multi-user picker custom field** - _A custom UI field that enables multiple users to be selected._


      ```json


      "customfield_11458" : [ { "name":"inigomontoya" }, { "name":"tommytomtomahawk" }]


      ```


      **Attachment** - _Attachments, using IDs of temporary attachments as provided by the /attachTemporaryFile API._


      ````json

      "attachment" : ["4786e3a5-52be-4d5b-bf3d-5f53e54f4559", "1187b2b7-8a75-4eac-88b2-b6e43129ef5c"]


      ````'
    title: Field input formats
  - anchor: overshort
    body: 'The Jira Service Management REST API enable you to work with a range of objects from Jira Service Management. The main resources provided are:


      | Resource      | Description                                                                                                                                                                                                                                    |

      |---------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|

      | customer      | This resource represents customers within your Jira instance. Use it to create new customers.                                                                                                                                                  |

      | info          | This resource provides details of the Jira Service Management software version, builds, and related links.                                                                                                                                     |

      | organization  | This resource enables you to group Jira Service Management customers together. Use it to create and delete organizations, and add and remove customers from them.                                                                              |

      | request       | This resource represents the customer requests in your service desks. Use it to create new requests and update request details, such as attachments and comments as well as take actions to update request status or review SLA performance.   |

      | requesttype   | This resource enables a list of customer request types, a way to categorize requests in a service desk, to be obtained.                                                                                                                        |

      | servicedesk   | This resource represents a service desk. Use it to retrieve the service desks in your Jira instance, managed the requests service desks can handle, manage the associated customers and organizations, and retrieve details of request queues. |

      '
    title: Resource summary