Changes to Assets /object/aql and /object/navlist/aql endpoints

JSM Development JSM Cloud
, ,
1

Hello Atlassian Developer Community,

We want to notify you about two upcoming change to the REST API’s for Assets in Jira Service Management cloud.

  1. In the interest of performance, the total attribute (count of objects matching the query) from the response payload of the /object/aql endpoint will be capped at a maximum 1000. This means that if your query matches more than 1000 objects the total will be set to 1000 and a new attribute in the response hasMoreResults will be marked as true to indicate the total objects matching the query is greater than 1000. If you require the full count you can then use the new /object/aql/totalcount endpoint which will provide a total count for any AQL query.

  2. In the interest of simplifying our public API’s we will be removing /object/navlist/aql from our list of supported public endpoints and it should now be considered deprecated. Instead we recommend you migrate to the /object/aql endpoint.

Both of these changes will be made on or after 30 Sept 2024.

We hope these changes will cause minimal disruption and as always please reach out to us if you have any concerns or feedback.

All the best,

Justin King
Senior Product Manager, Jira Service Management