Alternative to IncludeAttributesDeep query param after deprecation?

Christopher Pugh
I'm New Here
I'm New Here
Those new to the Atlassian Community have posted less than three times. Give them a warm welcome!
November 15, 2023

My organization frequently uses the /iql/objects endpoint in the Assets REST API and specifies the includeAttributesDeep query parameter to be more than 1. Getting multiple levels in the single search result is highly convenient. Documentation now shows that calls that contain includeAttributesDeep are deprecated. Is there any alternative to this functionality besides making several API calls to get each object?

 

Link to documentation:

https://developer.atlassian.com/cloud/assets/rest/api-group-iql/#api-iql-objects-get

1 answer

0 votes
Pablo Brincat November 17, 2023

Hi Christopher,

 

The deprecation of includeAttributesDeep in the Assets REST API of Atlassian presents a challenge, especially since you’re relying on it to fetch multiple levels in a single search result. Here are a few potential alternatives and workarounds to consider:

 

1. Review Updated API Documentation

 

First and foremost, review the most recent version of the Atlassian API documentation. Atlassian might have introduced new query parameters or endpoint features that could serve as a replacement for includeAttributesDeep. Sometimes, API updates include new functionalities that are meant to replace deprecated features.

 

2. Multiple API Calls (The Obvious Alternative)

 

While this isn’t the most efficient method, making several API calls to retrieve each object level is the most straightforward workaround. You can optimize this approach by:

 

  • Batch Processing: Collecting all necessary IDs in one call and then fetching their details in subsequent calls in batches.
  • Asynchronous Calls: If your technology stack allows, making these API calls asynchronously can improve performance.

 

3. Custom Aggregation Logic

 

Implement custom logic in your application to aggregate data from multiple API calls. While this increases complexity on your end, it allows for more control over data handling and aggregation.

 

4. Check for New Features in Assets API

 

Atlassian might have introduced new features or endpoints in the Assets API that could replicate the functionality of includeAttributesDeep. Look for features like expanded objects, nested queries, or advanced filtering options.

 

5. Explore Atlassian Marketplace

 

Sometimes third-party plugins or tools available in the Atlassian Marketplace offer extended functionalities or alternative ways to interact with Jira data. These tools might provide a workaround for the deprecated feature.

 

6. Reach Out to Atlassian Support

 

If the documentation isn’t clear or you’re unable to find a suitable alternative, consider reaching out to Atlassian Support. They might provide insights into upcoming features or recommend best practices post-deprecation.

 

7. Monitor Atlassian Community and Forums

 

Keep an eye on discussions in the Atlassian Community forums. Other users might be facing similar challenges and could share their solutions or workarounds.

 

8. Feedback to Atlassian

 

Provide feedback to Atlassian about the impact of deprecating includeAttributesDeep. User feedback can sometimes influence product updates or lead to the introduction of alternative features.

 

It’s crucial to plan for changes in your implementation strategy to accommodate these API updates. While direct replacements may not always be available, these alternatives can help maintain the functionality of your system with some adjustments. Good luck, and I hope one of these suggestions helps you navigate this transition! 🚀🔧📊

Suggest an answer

Log in or Sign up to answer
DEPLOYMENT TYPE
CLOUD
PRODUCT PLAN
PREMIUM
PERMISSIONS LEVEL
Product Admin
TAGS
AUG Leaders

Atlassian Community Events