Retrieving comments from Bitbucket server via REST API

[Rudy Holtkamp]

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

[Felix · Accepted solution]

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 

[Rudy Holtkamp]

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

[Paramanand Dhuri]

Can we do this without specifying path to the file

[piyush_kumar_singh]

how can we fetch all comments in a PR irrespective of file.

[avsaditya]

Hello @piyush_kumar_singh @Paramanand Dhur1

Unfortunately, there is no end point to get all comments in a single shot.

But you could use the mechanism suggested by Felix above.

For retrieving the changes in the PR, please use

https://docs.atlassian.com/bitbucket-server/rest/7.14.0/bitbucket-rest.html#idp323

Thanks and Regards

Aditya