We strongly recommend customers to use the Execute MQL api to retrieve card data instead of the cards api. This is because Execute MQL API retrieves results faster than the cards api.
Please find below examples:
1. If you would like to retrieve all cards which have their 'completed on' date as 13th july 2012 (Here 'completed on' being a property). You can try the below:
<http/https>://username:password@<host>:8080/api/v2/projects/<project identifier>/cards/execute_mql.xml?mql=SELECT%20Name%20WHERE%20Type%20is%20Stories%20and%20'Modified%20On'%20%3E%20'13%20JUL%202012'
Please refer below link to read more on 'EXECUTE MQL API'
http://www.thoughtworks.com/products/docs/mingle/current/help/mingle_api_execute_mql.html
Again, for cases where you are looking to use version or rendered_description to to get the html of the description you can use the Card API.
Comments
2 comments
Hello,
How do I use HMAC authentication with the MQL API? Will the query be part of the URL that is used to generate the key? Does the query need to be URL encoded? And does it just have to be a query parameter? I have tried some variations but could not successfully authenticate my requests using Postman.
Hello,
There's no direct way to use HMAC authentication in Postman. There are a few prerequisites that need to be addressed before you use the HMAC authentication -
1) Creating a MD5 checksum for the request.
2) Creating a HMAC signature
3) Base64 encoding of the HMAC signature.
We have a script in Ruby for 'Execute MQL API' endpoint using HMAC authentication. I'd advise you to look at this option. In this example, the MQL is passed as a query string in the url.
Please reach out to support@thoughtworks.com in case you have any questions.
Thanks,
Anish
Please sign in to leave a comment.