JSM DC /servicedeskapi/servicedesk REST API returns only 100 service desks

XMLWordPrintable

    • 1
    • Severity 3 - Minor
    • 4

      Issue Summary

      The Get service projects (GET /servicedeskapi/servicedesk) endpoint provides service desk entities associated with JSM service projects. It supports pagination using start and limit query parameters.

      While the limit parameter is respected, the results will always be truncated to 100 results. This is a scalability concern for enterprise customers with 101+ service projects.

      This bug has the same root cause as JSDSERVER-5920 (GET /servicedeskapi/request). The recommended solution is to increase the internal hard-coded limit to a reasonable limit. An even better solution includes adding more filtering options to allow REST API consumers to query precise service desks using the project ID/key.

      Steps to Reproduce

      1. Create 101+ service projects in Jira Service Management Data Center.
      2. Make a GET HTTP request to <jira-base-url>/rest/servicedeskapi/servicedesk?limit=200.

      Expected Results

      All 101+ results are returned:

      {
          "size": 101,
          "start": 0,
          "limit": 200,
          "isLastPage": true,
          "_links": {
              "base": "<jira-base-url>",
              "context": "",
              "self": "<jira-base-url>/rest/servicedeskapi/servicedesk?start=0&limit=200"
          },
          "values": [
             ...
          ]
      }
      

      Actual Results

      Only 100 results are returned:

      {
          "size": 100,
          "start": 0,
          "limit": 100,
          "isLastPage": true,
          "_links": {
              "base": "<jira-base-url>",
              "context": "",
              "self": "<jira-base-url>/rest/servicedeskapi/servicedesk?start=0&limit=200"
          },
          "values": [
             ...
          ]
      }
      

      Workaround

      Use the start parameter in conjunction with limit=100 to create a paginated window of 100 service desk entities.

      Versions Tested

      Please confirm all versions that have been tested for this issue, and indicate whether the tested version is affected or not affected, below:

      Testing Requirements Version Affected Version
      Most Recent Bug-Fix Release 10.2.0 Yes
      Most Recent LTS 5.12.15 Yes
      Previous Supported LTS 5.4.28 Yes

            Assignee:
            Zach Loh (Inactive)
            Reporter:
            Benjamin S
            Votes:
            1 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated:
              Resolved: