-
Suggestion
-
Resolution: Unresolved
-
17
-
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
- 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
- has action
-
QB-356 Failed to load
POST /object/navlist/aql is being deprecated and the replacement function POST /object/aql only has the boolean option of includeAttributes which means the response will either have ALL the attributes or none.
It is unclear whether there is a mechanism that can use the API to get a subset of the attributes of the assets of interest so it seems like we can only get a large response and then filter through that response rather than just getting the filtered set of attributes of interest.