Uploaded image for project: 'Jira Service Management Cloud'
  1. Jira Service Management Cloud
  2. JSDCLOUD-11464

Assets public API returns selected object attributes

    XMLWordPrintable

Details

    • Our product teams collect and evaluate feedback from a number of different sources. To learn more about how we use customer feedback in the planning process, check out our new feature policy.

    Description

      Issue Summary

      Insight API users want /iql/objects to return selected object attributes when fetching Insight objects. So that they can have a much smaller returning payload. Right now, it returns all the attributes. Although a user can paginate the result, it's still inconvenient for objects with a lot of attributes.

      Jira API has similar functionality, returning selected issue fields only. https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-search/#api-rest-api-3-search-post

      Comment from one customer:
      Pagination of the payload is the basics. Without it, your endpoints would likely fail with big data sets.

      This is about the content in the payload. Jira API has it already.

      Considering 25k objects with 50 attributes, You might only want to have a key and email. The data load is quite different between 25k*50 and 25k*2. Imagine we run this daily.

      It is also not only about data load. If you have sensitive data in attributes, you can, with such a filter avoid exporting them.

      Steps to Reproduce

      1. N/A

      Expected Results

      User can pass a list of attribute names to select the attributes they need.

      Actual Results

      Returns all the attributes.

      Workaround

      Users can paginate the result.
      Using the Post object navlist aql, use attributesToDisplayIds in the request body

      Attachments

        Issue Links

          Activity

            People

              Unassigned Unassigned
              9dc65ebe598c James Zhang (Quokkas)
              Votes:
              7 Vote for this issue
              Watchers:
              10 Start watching this issue

              Dates

                Created:
                Updated: