Retrieving comments from Bitbucket server via REST API

Hi,

I'm using Bitbucket server and I want to get the general comments of a pull request via the REST API. But somehow it does not work.

I've used https://bitbucket/rest/api/1.0/projects/MYPROJ/repos/myrepo/pull-requests but the response is a JSON object, with a lot of data, but the only reference to comments is: 

"properties": { "commentCount": 12,"openTaskCount": 0,"resolvedTaskCount": 0}, 

When I take a specifc pull request using: https://bitbucket/rest/api/1.0/projects/MYPROJ/repos/myrepo/pull-requests/2 then I will get another JSON object wit a lot of data, but no reference to any of the comments at all.

I only get the particulars of a comment using  https://bitbucket/rest/api/1.0/projects/MYPROJ/repos/myrepo/pull-requests/2/comments gives me an error: "The path query parameter is required when retrieving comments."

 Explicitly querying for comments with https://bitbucket/rest/api/1.0/projects/MYPROJ/repos/myrepo/pull-requests/2/comments/2916  does give me all the details of that specific comment, but I can only get the commentid by looking in the UI.

So can somebody explain how to get all general comments of a pull request?

Thanks,
Rudy

1 answer

1 accepted

1 vote

Hi Rudy, 

I believe the best way for you to get all the comments of a pull request is to use the activities endpoint.

You'll have to filter out anything that is not a comment, but it's going to be easier to do than grabbing comments individually for every file. 

As you discovered, the comments endpoint requires specifying a path as a query parameter, so only allows retrieving comments per file.

An example of this would be:

https://bitbucket.example.com/rest/api/1.0/projects/EXMP/repos/example/pull-requests/1/comments?path=path/to/file.java

 

I hope this helps, 

Felix Haehnel
Graduate Developer
Bitbucket Server 

Thanks Felix, The activities endpoint will do it for me. It is way more data then I need, but better then nothing!

Can we do this without specifying path to the file

Suggest an answer

Log in or Sign up to answer
How to earn badges on the Atlassian Community

How to earn badges on the Atlassian Community

Badges are a great way to show off community activity, whether you’re a newbie or a Champion.

Learn more
Community showcase
Posted Jun 12, 2018 in Bitbucket

Do you use any Atlassian products for your personal projects?

After spinning my wheels trying to get organized enough to write a book for National Novel Writing Month (NaNoWriMo) I took my affinity for Atlassian products from my work life and decided to tr...

24,005 views 26 12
Join discussion

Atlassian User Groups

Connect with like-minded Atlassian users at free events near you!

Find a group

Connect with like-minded Atlassian users at free events near you!

Find my local user group

Unfortunately there are no AUG chapters near you at the moment.

Start an AUG

You're one step closer to meeting fellow Atlassian users at your local meet up. Learn more about AUGs

Groups near you