REST API not including versionedComment data (inline comments, file level comments) when response is JSON

XMLWordPrintable

    • Severity 3 - Minor

      The following REST request will not return any versionedComments.

      /reviews-v1/CR-1/details.json

      Example response:

      {
    "stats"
:
    [
        {"user":"joe","published":2,"drafts":0,"defects":0,"unread":0,"leaveUnread":0,"read":2}
    ],"actions"
:
    {
        "actionData"
    :
        [
            {"name":"action:abandonReview","displayName":"Abandon"},
            {"name":"action:closeReview","displayName":"Close"},
            {"name":"action:viewReview","displayName":"View"},
            {"name":"action:reopenReview","displayName":"Re-Open"},
            {"name":"action:commentOnReview","displayName":"Comment"},
            {"name":"action:createReview","displayName":"Create"},
            {"name":"action:summarizeReview","displayName":"Summarize"},
            {"name":"action:rejectReview","displayName":"Reject"},
            {"name":"action:submitReview","displayName":"Submit"},
            {"name":"action:recoverReview","displayName":"Recover"},
            {"name":"action:modifyReviewFiles","displayName":"Edit Review Details"},
            {"name":"action:approveReview","displayName":"Approve"},
            {"name":"action:deleteReview","displayName":"Delete"}
        ]
    }
,
    "generalComments"
:
    {
        "comments"
    :
        [
            {"permaId":{"id":"CMT:7"},"permId":{"id":"CMT:7"},"message":"General comment, to test REST Perma-Ids","metrics":{},"user":{"displayName":"joe lowercase","userName":"joe","avatarUrl":"http://astra.sydney.atlassian.com:6060/foo/avatar/joe?s=48"},"deleted":false,"draft":false,"createDate":"2010-11-01T15:55:55.316+1100","defectRaised":false,"replies":[],"readStatus":"READ","defectApproved":false,"messageAsHtml":"<p>General comment, to test REST Perma-Ids</p>","parentCommentId":{}}
        ]
    }
,
    "versionedComments"
:
    {
        "comments"
    :
        [
            {"replies":[]}
        ]
    }
,
    "reviewers"
:
    {
        "reviewer"
    :
        []
    }
,
    "reviewItems"
:
    {
        "reviewItem"
    :
        [
            {"repositoryName":"SVN","fromRevision":"2","toRevision":"3","fileType":"File","authorName":"ervzijst","commitDate":1224200614996,"fromPath":"CRUC-694/gpl-2.0.txt","toPath":"CRUC-694/gpl-2.0.txt","commitType":"Modified","expandedRevisions":[
                {"addDate":1288587355180,"revision":"2","path":"CRUC-694/gpl-2.0.txt","contentUrl":"foo/cru/CR-6/rawcontent/4/CRUC-694/gpl-2.0.txt","source":"SVN","fileType":"File","commitType":"Added"},
                {"addDate":1288587355163,"revision":"3","path":"CRUC-694/gpl-2.0.txt","contentUrl":"foo/cru/CR-6/rawcontent/1/CRUC-694/gpl-2.0.txt","source":"SVN","fileType":"File","commitType":"Modified"}
            ],"showAsDiff":true,"fromContentUrl":"foo/cru/CR-6/rawcontent/4/CRUC-694/gpl-2.0.txt","toContentUrl":"foo/cru/CR-6/rawcontent/1/CRUC-694/gpl-2.0.txt","participants":[
                {"user":{"displayName":"joe lowercase","userName":"joe","avatarUrl":"http://astra.sydney.atlassian.com:6060/foo/avatar/joe?s=48"},"completed":false}
            ],"permId":{"id":"CFR-3"}},
            {"repositoryName":"SVN","fromRevision":"2","toRevision":"3","fileType":"File","authorName":"ervzijst","commitDate":1224200614996,"fromPath":"CRUC-694/gpl-3.0.txt","toPath":"CRUC-694/gpl-3.0.txt","commitType":"Modified","expandedRevisions":[
                {"addDate":1288587355188,"revision":"2","path":"CRUC-694/gpl-3.0.txt","contentUrl":"foo/cru/CR-6/rawcontent/3/CRUC-694/gpl-3.0.txt","source":"SVN","fileType":"File","commitType":"Added"},
                {"addDate":1288587355185,"revision":"3","path":"CRUC-694/gpl-3.0.txt","contentUrl":"foo/cru/CR-6/rawcontent/2/CRUC-694/gpl-3.0.txt","source":"SVN","fileType":"File","commitType":"Modified"}
            ],"showAsDiff":true,"fromContentUrl":"foo/cru/CR-6/rawcontent/3/CRUC-694/gpl-3.0.txt","toContentUrl":"foo/cru/CR-6/rawcontent/2/CRUC-694/gpl-3.0.txt","participants":[
                {"user":{"displayName":"joe lowercase","userName":"joe","avatarUrl":"http://astra.sydney.atlassian.com:6060/foo/avatar/joe?s=48"},"completed":false}
            ],"permId":{"id":"CFR-4"}}
        ]
    }
,
    "transitions"
:
    {
        "transitionData"
    :
        [
            {"name":"action:summarizeReview","displayName":"Summarize"},
            {"name":"action:abandonReview","displayName":"Abandon"}
        ]
    }
,
    "name"
:
    "Review for testing JSON REST response.","state"
:
    "Review","type"
:
    "REVIEW","description"
:
    "Description...","creator"
:
    {
        "displayName"
    :
        "joe lowercase","userName"
    :
        "joe","avatarUrl"
    :
        "http://astra.sydney.atlassian.com:6060/foo/avatar/joe?s=48"
    }
,
    "author"
:
    {
        "displayName"
    :
        "joe lowercase","userName"
    :
        "joe","avatarUrl"
    :
        "http://astra.sydney.atlassian.com:6060/foo/avatar/joe?s=48"
    }
,
    "permaId"
:
    {
        "id"
    :
        "CR-6"
    }
,
    "createDate"
:
    "2010-11-01T15:55:55.117+1100","allowReviewersToJoin"
:
    false,"projectKey"
:
    "CR","moderator"
:
    {
        "displayName"
    :
        "joe lowercase","userName"
    :
        "joe","avatarUrl"
    :
        "http://astra.sydney.atlassian.com:6060/foo/avatar/joe?s=48"
    }
,
    "metricsVersion"
:
    1
}

      however, the XML response for the same review contains the comment data:

      <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<detailedReviewData>
    <allowReviewersToJoin>false</allowReviewersToJoin>
    <author>
        <avatarUrl>http://astra.sydney.atlassian.com:6060/foo/avatar/joe?s=48</avatarUrl>
        <displayName>joe lowercase</displayName>
        <userName>joe</userName>
    </author>
    <createDate>2010-11-01T16:04:15.683+1100</createDate>
    <creator>
        <avatarUrl>http://astra.sydney.atlassian.com:6060/foo/avatar/joe?s=48</avatarUrl>
        <displayName>joe lowercase</displayName>
        <userName>joe</userName>
    </creator>
    <description>Description...</description>
    <metricsVersion>1</metricsVersion>
    <moderator>
        <avatarUrl>http://astra.sydney.atlassian.com:6060/foo/avatar/joe?s=48</avatarUrl>
        <displayName>joe lowercase</displayName>
        <userName>joe</userName>
    </moderator>
    <name>Review for testing JSON REST response.</name>
    <permaId>
        <id>CR-1</id>
    </permaId>
    <projectKey>CR</projectKey>
    <state>Review</state>
    <type>REVIEW</type>
    <stats>
        <comments>
            <user>joe</user>
            <published>2</published>
            <drafts>0</drafts>
            <defects>0</defects>
            <unread>0</unread>
            <leaveUnread>0</leaveUnread>
            <read>2</read>
        </comments>
    </stats>
    <actions>
        <actionData>
            <displayName>Abandon</displayName>
            <name>action:abandonReview</name>
        </actionData>
        <actionData>
            <displayName>Create</displayName>
            <name>action:createReview</name>
        </actionData>
        <actionData>
            <displayName>View</displayName>
            <name>action:viewReview</name>
        </actionData>
        <actionData>
            <displayName>Re-Open</displayName>
            <name>action:reopenReview</name>
        </actionData>
        <actionData>
            <displayName>Close</displayName>
            <name>action:closeReview</name>
        </actionData>
        <actionData>
            <displayName>Reject</displayName>
            <name>action:rejectReview</name>
        </actionData>
        <actionData>
            <displayName>Comment</displayName>
            <name>action:commentOnReview</name>
        </actionData>
        <actionData>
            <displayName>Summarize</displayName>
            <name>action:summarizeReview</name>
        </actionData>
        <actionData>
            <displayName>Edit Review Details</displayName>
            <name>action:modifyReviewFiles</name>
        </actionData>
        <actionData>
            <displayName>Approve</displayName>
            <name>action:approveReview</name>
        </actionData>
        <actionData>
            <displayName>Recover</displayName>
            <name>action:recoverReview</name>
        </actionData>
        <actionData>
            <displayName>Delete</displayName>
            <name>action:deleteReview</name>
        </actionData>
        <actionData>
            <displayName>Submit</displayName>
            <name>action:submitReview</name>
        </actionData>
    </actions>
    <generalComments>
        <generalCommentData>
            <createDate>2010-11-01T16:04:16.607+1100</createDate>
            <defectApproved>false</defectApproved>
            <defectRaised>false</defectRaised>
            <deleted>false</deleted>
            <draft>false</draft>
            <message>General comment, to test REST Perma-Ids</message>
            <messageAsHtml>&lt;p&gt;General comment, to test REST Perma-Ids&lt;/p&gt;</messageAsHtml>
            <metrics/>
            <parentCommentId/>
            <readStatus>READ</readStatus>
            <replies/>
            <user>
                <avatarUrl>http://astra.sydney.atlassian.com:6060/foo/avatar/joe?s=48</avatarUrl>
                <displayName>joe lowercase</displayName>
                <userName>joe</userName>
            </user>
            <permId>
                <id>CMT:1</id>
            </permId>
            <permaId>
                <id>CMT:1</id>
            </permaId>
        </generalCommentData>
    </generalComments>
    <reviewItems>
        <reviewItem>
            <participants>
                <participant>
                    <user>
                        <avatarUrl>http://astra.sydney.atlassian.com:6060/foo/avatar/joe?s=48</avatarUrl>
                        <displayName>joe lowercase</displayName>
                        <userName>joe</userName>
                    </user>
                    <completed>false</completed>
                </participant>
            </participants>
            <permId>
                <id>CFR-1</id>
            </permId>
            <permaId>
                <id>CFR-1</id>
            </permaId>
            <authorName>ervzijst</authorName>
            <commitDate>2008-10-17T10:43:34.996+11:00</commitDate>
            <commitType>Modified</commitType>
            <expandedRevisions>
                <addDate>2010-11-01T16:04:16.281+11:00</addDate>
                <revision>2</revision>
                <path>CRUC-694/gpl-2.0.txt</path>
                <contentUrl>foo/cru/CR-1/rawcontent/4/CRUC-694/gpl-2.0.txt</contentUrl>
                <source>SVN</source>
                <fileType>Unknown</fileType>
                <commitType>Unknown</commitType>
            </expandedRevisions>
            <expandedRevisions>
                <addDate>2010-11-01T16:04:16.270+11:00</addDate>
                <revision>3</revision>
                <path>CRUC-694/gpl-2.0.txt</path>
                <contentUrl>foo/cru/CR-1/rawcontent/1/CRUC-694/gpl-2.0.txt</contentUrl>
                <source>SVN</source>
                <fileType>File</fileType>
                <commitType>Modified</commitType>
            </expandedRevisions>
            <fileType>File</fileType>
            <fromContentUrl>foo/cru/CR-1/rawcontent/4/CRUC-694/gpl-2.0.txt</fromContentUrl>
            <fromPath>CRUC-694/gpl-2.0.txt</fromPath>
            <fromRevision>2</fromRevision>
            <repositoryName>SVN</repositoryName>
            <showAsDiff>true</showAsDiff>
            <toContentUrl>foo/cru/CR-1/rawcontent/1/CRUC-694/gpl-2.0.txt</toContentUrl>
            <toPath>CRUC-694/gpl-2.0.txt</toPath>
            <toRevision>3</toRevision>
        </reviewItem>
        <reviewItem>
            <participants>
                <participant>
                    <user>
                        <avatarUrl>http://astra.sydney.atlassian.com:6060/foo/avatar/joe?s=48</avatarUrl>
                        <displayName>joe lowercase</displayName>
                        <userName>joe</userName>
                    </user>
                    <completed>false</completed>
                </participant>
            </participants>
            <permId>
                <id>CFR-2</id>
            </permId>
            <permaId>
                <id>CFR-2</id>
            </permaId>
            <authorName>ervzijst</authorName>
            <commitDate>2008-10-17T10:43:34.996+11:00</commitDate>
            <commitType>Modified</commitType>
            <expandedRevisions>
                <addDate>2010-11-01T16:04:16.343+11:00</addDate>
                <revision>2</revision>
                <path>CRUC-694/gpl-3.0.txt</path>
                <contentUrl>foo/cru/CR-1/rawcontent/3/CRUC-694/gpl-3.0.txt</contentUrl>
                <source>SVN</source>
                <fileType>Unknown</fileType>
                <commitType>Unknown</commitType>
            </expandedRevisions>
            <expandedRevisions>
                <addDate>2010-11-01T16:04:16.338+11:00</addDate>
                <revision>3</revision>
                <path>CRUC-694/gpl-3.0.txt</path>
                <contentUrl>foo/cru/CR-1/rawcontent/2/CRUC-694/gpl-3.0.txt</contentUrl>
                <source>SVN</source>
                <fileType>File</fileType>
                <commitType>Modified</commitType>
            </expandedRevisions>
            <fileType>File</fileType>
            <fromContentUrl>foo/cru/CR-1/rawcontent/3/CRUC-694/gpl-3.0.txt</fromContentUrl>
            <fromPath>CRUC-694/gpl-3.0.txt</fromPath>
            <fromRevision>2</fromRevision>
            <repositoryName>SVN</repositoryName>
            <showAsDiff>true</showAsDiff>
            <toContentUrl>foo/cru/CR-1/rawcontent/2/CRUC-694/gpl-3.0.txt</toContentUrl>
            <toPath>CRUC-694/gpl-3.0.txt</toPath>
            <toRevision>3</toRevision>
        </reviewItem>
    </reviewItems>
    <reviewers/>
    <transitions>
        <transitionData>
            <displayName>Summarize</displayName>
            <name>action:summarizeReview</name>
        </transitionData>
        <transitionData>
            <displayName>Abandon</displayName>
            <name>action:abandonReview</name>
        </transitionData>
    </transitions>
    <versionedComments>
        <versionedLineCommentData>
            <createDate>2010-11-01T16:04:16.843+1100</createDate>
            <defectApproved>false</defectApproved>
            <defectRaised>false</defectRaised>
            <deleted>false</deleted>
            <draft>false</draft>
            <message>Testing an inline comment.</message>
            <messageAsHtml>&lt;p&gt;Testing an inline comment.&lt;/p&gt;</messageAsHtml>
            <metrics/>
            <parentCommentId/>
            <readStatus>READ</readStatus>
            <replies/>
            <user>
                <avatarUrl>http://astra.sydney.atlassian.com:6060/foo/avatar/joe?s=48</avatarUrl>
                <displayName>joe lowercase</displayName>
                <userName>joe</userName>
            </user>
            <permaId>
                <id>CMT:2</id>
            </permaId>
            <reviewItemId>
                <id>CFR-1</id>
            </reviewItemId>
        </versionedLineCommentData>
    </versionedComments>
</detailedReviewData>

            Assignee:
            Unassigned
            Reporter:
            Nick
            Votes:
            1 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated:
              Resolved: