This is the reference section of the Crucible REST API.
For information about Crucible Plugin Development, visit the Development Hub.
This documentation was automatically generated from the WADL.
The REST resources described on this page produce and consume serialized objects whose structure is described in XML Schema: crucible.xsd.
Please have a look at python examples that demonstrate the capabilities of FishEye & Crucible REST API: bitbucket.org/atlassian/fecru-rest-examples/src/master/python
FishEye uses paging to conserve server resources and limit response size for resources that return potentially large
collections of items. A request to a paged API will result in a values array wrapped in a JSON object
with some paging metadata, like this:
{
"start": 3,
"size": 3,
"limit": 100,
"lastPage": true,
"values": [
{ /* result 0 */ },
{ /* result 1 */ },
{ /* result 2 */ }
]
}
Clients can use the limit and start query parameters to retrieve the desired number of
results.
The limit parameter indicates how many results to return per page. Most APIs default to returning
100 if the limit is left unspecified. A resource can have a hard limit. It's always best practice to
check the limit attribute on the response to see what limit has been applied.
The request to get a page with desired size should look like this:
http://host:port/context/rest/api/api-version/path/to/resource?limit={desired size of page}
For example:
http://fecru.atlassian.com/rest/api/1.0/rest-service-fecru/users?limit=50
The start parameter indicates which item should be used as the first item in the page of results. All
paged responses contain a lastPage attribute indicating whether another page of items exists.
If a paged response has a property lastPage set to false, the next page start should be calculated
by adding current page start and size.
The request to get a subsequent page should look like this:
http://host:port/context/path/to/resource?start={start of last page}+{size of last page}&limit={desired size of page}
For example:
http://fecru.atlassian.com/rest/api/1.0/rest-service-fecru/users?size=50&limit=50
Provides an API for working with Projects.
Deprecated since FishEye 3.5.0 for removal in 4.0. Use GET /rest-service-fecru/admin/projects instead.
Get the list of projects that the authenticated user is entitled to access.| parameter | value | description |
|---|---|---|
|
excludeAllowedReviewers |
Default: false |
if set to true, user data (e.g. allowedReviewers) which is expensive to compute, will not be included in the response data. Defaults to false so allowedReviewers are included in the response. |
available response representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<projects>
<projectData>
<allowedReviewers size="2"/>
<allowReviewersToJoin>true</allowReviewersToJoin>
<defaultDuration>5</defaultDuration>
<defaultModerator>joe</defaultModerator>
<defaultObjectives>default objectives</defaultObjectives>
<defaultRepositoryName>FOOREPO</defaultRepositoryName>
<defaultReviewers>
<userName>joe</userName>
<userName>fred</userName>
</defaultReviewers>
<id>5</id>
<key>CR-FOO</key>
<moderatorEnabled>true</moderatorEnabled>
<name>Foo Project</name>
<permissionSchemeId>32</permissionSchemeId>
</projectData>
<projectData>
<allowedReviewers size="2"/>
<allowReviewersToJoin>true</allowReviewersToJoin>
<defaultDuration>5</defaultDuration>
<defaultModerator>joe</defaultModerator>
<defaultObjectives>default objectives</defaultObjectives>
<defaultRepositoryName>FOOREPO</defaultRepositoryName>
<defaultReviewers>
<userName>joe</userName>
<userName>fred</userName>
</defaultReviewers>
<id>5</id>
<key>CR-FOO</key>
<moderatorEnabled>true</moderatorEnabled>
<name>Foo Project</name>
<permissionSchemeId>32</permissionSchemeId>
</projectData>
</projects>
A list of all Crucible projects that the caller is entitled to access.
{
"projectData" : [ {
"allowedReviewers" : {
"size" : 2
},
"name" : "Foo Project",
"key" : "CR-FOO",
"id" : 5,
"allowReviewersToJoin" : true,
"defaultRepositoryName" : "FOOREPO",
"permissionSchemeId" : 32,
"defaultDuration" : 5,
"defaultModerator" : "joe",
"moderatorEnabled" : true,
"defaultObjectives" : "default objectives",
"defaultReviewers" : [ "joe", "fred" ]
}, {
"allowedReviewers" : {
"size" : 2
},
"name" : "Foo Project",
"key" : "CR-FOO",
"id" : 5,
"allowReviewersToJoin" : true,
"defaultRepositoryName" : "FOOREPO",
"permissionSchemeId" : 32,
"defaultDuration" : 5,
"defaultModerator" : "joe",
"moderatorEnabled" : true,
"defaultObjectives" : "default objectives",
"defaultReviewers" : [ "joe", "fred" ]
} ]
}A list of all Crucible projects that the caller is entitled to access.
| parameter | value | description |
|---|---|---|
|
key |
the key of a Crucible project. |
Deprecated since FishEye 3.5.0 for removal in 4.0. Use GET /rest-service-fecru/admin/projects/[key] instead.
Returns a project description.If the specified project does not exist, or the caller does not have permission to access the project, 404 is returned.
| parameter | value | description |
|---|---|---|
|
excludeAllowedReviewers |
Default: false |
available response representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<projectData>
<allowedReviewers size="2"/>
<allowReviewersToJoin>true</allowReviewersToJoin>
<defaultDuration>5</defaultDuration>
<defaultModerator>joe</defaultModerator>
<defaultObjectives>default objectives</defaultObjectives>
<defaultRepositoryName>FOOREPO</defaultRepositoryName>
<defaultReviewers>
<userName>joe</userName>
<userName>fred</userName>
</defaultReviewers>
<id>5</id>
<key>CR-FOO</key>
<moderatorEnabled>true</moderatorEnabled>
<name>Foo Project</name>
<permissionSchemeId>32</permissionSchemeId>
</projectData>
A detailed description of a Crucible project.
Source: crucible.xsd
<xs:complexType name="projectData">
<xs:sequence>
<xs:element name="allowReviewersToJoin" type="xs:boolean"/>
<xs:element name="allowedReviewerGroups" type="xs:string" nillable="true" minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="allowedReviewerUsers" type="xs:string" nillable="true" minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="allowedReviewers" type="xs:string" nillable="true" minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="defaultDuration" type="xs:int" minOccurs="0"/>
<xs:element name="defaultModerator" type="xs:string" minOccurs="0"/>
<xs:element name="defaultObjectives" type="xs:string" minOccurs="0"/>
<xs:element name="defaultRepositoryName" type="xs:string" minOccurs="0"/>
<xs:element name="defaultReviewerGroups" type="xs:string" nillable="true" minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="defaultReviewerUsers" type="xs:string" nillable="true" minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="id" type="xs:int"/>
<xs:element name="key" type="xs:string" minOccurs="0"/>
<xs:element name="moderatorEnabled" type="xs:boolean"/>
<xs:element name="name" type="xs:string" minOccurs="0"/>
<xs:element name="permissionSchemeId" type="xs:int"/>
<xs:element name="permissionSchemeName" type="xs:string" minOccurs="0"/>
<xs:element name="storeRevisions" type="xs:boolean" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
{
"allowedReviewers" : {
"size" : 2
},
"name" : "Foo Project",
"key" : "CR-FOO",
"id" : 5,
"allowReviewersToJoin" : true,
"defaultRepositoryName" : "FOOREPO",
"permissionSchemeId" : 32,
"defaultDuration" : 5,
"defaultModerator" : "joe",
"moderatorEnabled" : true,
"defaultObjectives" : "default objectives",
"defaultReviewers" : [ "joe", "fred" ]
}A detailed description of a Crucible project.
Source: crucible.xsd
<xs:complexType name="projectData">
<xs:sequence>
<xs:element name="allowReviewersToJoin" type="xs:boolean"/>
<xs:element name="allowedReviewerGroups" type="xs:string" nillable="true" minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="allowedReviewerUsers" type="xs:string" nillable="true" minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="allowedReviewers" type="xs:string" nillable="true" minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="defaultDuration" type="xs:int" minOccurs="0"/>
<xs:element name="defaultModerator" type="xs:string" minOccurs="0"/>
<xs:element name="defaultObjectives" type="xs:string" minOccurs="0"/>
<xs:element name="defaultRepositoryName" type="xs:string" minOccurs="0"/>
<xs:element name="defaultReviewerGroups" type="xs:string" nillable="true" minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="defaultReviewerUsers" type="xs:string" nillable="true" minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="id" type="xs:int"/>
<xs:element name="key" type="xs:string" minOccurs="0"/>
<xs:element name="moderatorEnabled" type="xs:boolean"/>
<xs:element name="name" type="xs:string" minOccurs="0"/>
<xs:element name="permissionSchemeId" type="xs:int"/>
<xs:element name="permissionSchemeName" type="xs:string" minOccurs="0"/>
<xs:element name="storeRevisions" type="xs:boolean" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<error>
<code>NotFound</code>
<message>Requested resource not found.</message>
<stacktrace>com.atlassian.crucible.spi.services.NotFoundException: Requested resource not found.
at com.atlassian.crucible.spi.rpc.ExampleDocuments.<clinit>(ExampleDocuments.java:27)
at sun.misc.Unsafe.ensureClassInitialized(Native Method)
at sun.reflect.UnsafeFieldAccessorFactory.newFieldAccessor(UnsafeFieldAccessorFactory.java:25)
at sun.reflect.ReflectionFactory.newFieldAccessor(ReflectionFactory.java:122)
at java.lang.reflect.Field.acquireFieldAccessor(Field.java:918)
at java.lang.reflect.Field.getFieldAccessor(Field.java:899)
at java.lang.reflect.Field.get(Field.java:358)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedLinkFromTag(ResourceDocletJsonXml.java:649)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedExample(ResourceDocletJsonXml.java:542)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.createRepresentationDocTypes(ResourceDocletJsonXml.java:453)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.addResponseDoc(ResourceDocletJsonXml.java:428)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.start(ResourceDocletJsonXml.java:196)
at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)
at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
at java.lang.reflect.Method.invoke(Method.java:597)
at com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:269)
at com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:143)
at com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)
at com.sun.tools.javadoc.Start.begin(Start.java:128)
at com.sun.tools.javadoc.Main.execute(Main.java:41)
at com.sun.tools.javadoc.Main.main(Main.java:31)
</stacktrace>
</error>
Response when the requested Crucible project does not exist.
{
"code" : "NotFound",
"message" : "Requested resource not found.",
"stacktrace" : "com.atlassian.crucible.spi.services.NotFoundException: Requested resource not found.\n\tat com.atlassian.crucible.spi.rpc.ExampleDocuments.<clinit>(ExampleDocuments.java:27)\n\tat sun.misc.Unsafe.ensureClassInitialized(Native Method)\n\tat sun.reflect.UnsafeFieldAccessorFactory.newFieldAccessor(UnsafeFieldAccessorFactory.java:25)\n\tat sun.reflect.ReflectionFactory.newFieldAccessor(ReflectionFactory.java:122)\n\tat java.lang.reflect.Field.acquireFieldAccessor(Field.java:918)\n\tat java.lang.reflect.Field.getFieldAccessor(Field.java:899)\n\tat java.lang.reflect.Field.get(Field.java:358)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedLinkFromTag(ResourceDocletJsonXml.java:649)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedExample(ResourceDocletJsonXml.java:542)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.createRepresentationDocTypes(ResourceDocletJsonXml.java:453)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.addResponseDoc(ResourceDocletJsonXml.java:428)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.start(ResourceDocletJsonXml.java:196)\n\tat sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)\n\tat sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)\n\tat sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)\n\tat java.lang.reflect.Method.invoke(Method.java:597)\n\tat com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:269)\n\tat com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:143)\n\tat com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)\n\tat com.sun.tools.javadoc.Start.begin(Start.java:128)\n\tat com.sun.tools.javadoc.Main.execute(Main.java:41)\n\tat com.sun.tools.javadoc.Main.main(Main.java:31)\n"
}Response when the requested Crucible project does not exist.
Provides an API for searching reviews.
Search for reviews where the name, description, state or permaId contain the specified term.
| parameter | value | description |
|---|---|---|
|
term |
a search term. |
|
|
maxReturn |
the maximum number of reviews to return. |
available response representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<reviews>
<reviewData>
<allowReviewersToJoin>true</allowReviewersToJoin>
<author>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Joe Krustofski</displayName>
<userName>joe</userName>
</author>
<createDate>2015-04-28T09:47:56.272+0200</createDate>
<creator>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Joe Krustofski</displayName>
<userName>joe</userName>
</creator>
<description>Description or statement of objectives for this example review.</description>
<dueDate>2015-04-29T09:47:56.272+0200</dueDate>
<jiraIssueKey>FOO-6754</jiraIssueKey>
<metricsVersion>4</metricsVersion>
<moderator>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Scott the Moderator</displayName>
<userName>scott</userName>
</moderator>
<name>Example review.</name>
<permaId>
<id>CR-FOO-21</id>
</permaId>
<permaIdHistory>CR-FOO-21</permaIdHistory>
<projectKey>CR-FOO</projectKey>
<type>REVIEW</type>
</reviewData>
</reviews>
The result of a review search action.
{
"reviewData" : [ {
"projectKey" : "CR-FOO",
"name" : "Example review.",
"description" : "Description or statement of objectives for this example review.",
"author" : {
"userName" : "joe",
"displayName" : "Joe Krustofski",
"avatarUrl" : "http://foo.com/avatar"
},
"moderator" : {
"userName" : "scott",
"displayName" : "Scott the Moderator",
"avatarUrl" : "http://foo.com/avatar"
},
"creator" : {
"userName" : "joe",
"displayName" : "Joe Krustofski",
"avatarUrl" : "http://foo.com/avatar"
},
"permaId" : {
"id" : "CR-FOO-21"
},
"permaIdHistory" : [ "CR-FOO-21" ],
"type" : "REVIEW",
"allowReviewersToJoin" : true,
"metricsVersion" : 4,
"createDate" : "2015-04-28T09:47:56.272+0200",
"dueDate" : "2015-04-29T09:47:56.272+0200",
"jiraIssueKey" : "FOO-6754"
} ]
}The result of a review search action.
Get a list of all reviews that have been linked to the specified JIRA issue key.
| parameter | value | description |
|---|---|---|
|
jiraKey |
a Jira issue key (e.g. "FOO-3453") |
|
|
maxReturn |
the maximum number of reviews to return. |
available response representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<reviews>
<reviewData>
<allowReviewersToJoin>true</allowReviewersToJoin>
<author>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Joe Krustofski</displayName>
<userName>joe</userName>
</author>
<createDate>2015-04-28T09:47:56.272+0200</createDate>
<creator>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Joe Krustofski</displayName>
<userName>joe</userName>
</creator>
<description>Description or statement of objectives for this example review.</description>
<dueDate>2015-04-29T09:47:56.272+0200</dueDate>
<jiraIssueKey>FOO-6754</jiraIssueKey>
<metricsVersion>4</metricsVersion>
<moderator>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Scott the Moderator</displayName>
<userName>scott</userName>
</moderator>
<name>Example review.</name>
<permaId>
<id>CR-FOO-21</id>
</permaId>
<permaIdHistory>CR-FOO-21</permaIdHistory>
<projectKey>CR-FOO</projectKey>
<type>REVIEW</type>
</reviewData>
</reviews>
The result of a search action for reviews that are linked to a specific Jira issue.
{
"reviewData" : [ {
"projectKey" : "CR-FOO",
"name" : "Example review.",
"description" : "Description or statement of objectives for this example review.",
"author" : {
"userName" : "joe",
"displayName" : "Joe Krustofski",
"avatarUrl" : "http://foo.com/avatar"
},
"moderator" : {
"userName" : "scott",
"displayName" : "Scott the Moderator",
"avatarUrl" : "http://foo.com/avatar"
},
"creator" : {
"userName" : "joe",
"displayName" : "Joe Krustofski",
"avatarUrl" : "http://foo.com/avatar"
},
"permaId" : {
"id" : "CR-FOO-21"
},
"permaIdHistory" : [ "CR-FOO-21" ],
"type" : "REVIEW",
"allowReviewersToJoin" : true,
"metricsVersion" : 4,
"createDate" : "2015-04-28T09:47:56.272+0200",
"dueDate" : "2015-04-29T09:47:56.272+0200",
"jiraIssueKey" : "FOO-6754"
} ]
}The result of a search action for reviews that are linked to a specific Jira issue.
Get a list of all the groups.
available response representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<groups>
<groupData>
<name>group1</name>
</groupData>
<groupData>
<name>group2</name>
</groupData>
<groupData>
<externalSource>crowd</externalSource>
<name>crowd-group1</name>
</groupData>
</groups>
a list of groups
{
"groupData" : [ {
"name" : "group1"
}, {
"name" : "group2"
}, {
"name" : "crowd-group1",
"externalSource" : "crowd"
} ]
}a list of groups
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<error>
<code>NotPermitted</code>
<message>Access denied.</message>
<stacktrace>com.atlassian.crucible.spi.services.NotPermittedException: Access denied.
at com.atlassian.crucible.spi.rpc.ExampleDocuments.<clinit>(ExampleDocuments.java:21)
at sun.misc.Unsafe.ensureClassInitialized(Native Method)
at sun.reflect.UnsafeFieldAccessorFactory.newFieldAccessor(UnsafeFieldAccessorFactory.java:25)
at sun.reflect.ReflectionFactory.newFieldAccessor(ReflectionFactory.java:122)
at java.lang.reflect.Field.acquireFieldAccessor(Field.java:918)
at java.lang.reflect.Field.getFieldAccessor(Field.java:899)
at java.lang.reflect.Field.get(Field.java:358)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedLinkFromTag(ResourceDocletJsonXml.java:649)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedExample(ResourceDocletJsonXml.java:542)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.createRepresentationDocTypes(ResourceDocletJsonXml.java:453)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.addResponseDoc(ResourceDocletJsonXml.java:428)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.start(ResourceDocletJsonXml.java:196)
at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)
at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
at java.lang.reflect.Method.invoke(Method.java:597)
at com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:269)
at com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:143)
at com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)
at com.sun.tools.javadoc.Start.begin(Start.java:128)
at com.sun.tools.javadoc.Main.execute(Main.java:41)
at com.sun.tools.javadoc.Main.main(Main.java:31)
</stacktrace>
</error>
if you are not logged in or anonymous access is not allowed
{
"code" : "NotPermitted",
"message" : "Access denied.",
"stacktrace" : "com.atlassian.crucible.spi.services.NotPermittedException: Access denied.\n\tat com.atlassian.crucible.spi.rpc.ExampleDocuments.<clinit>(ExampleDocuments.java:21)\n\tat sun.misc.Unsafe.ensureClassInitialized(Native Method)\n\tat sun.reflect.UnsafeFieldAccessorFactory.newFieldAccessor(UnsafeFieldAccessorFactory.java:25)\n\tat sun.reflect.ReflectionFactory.newFieldAccessor(ReflectionFactory.java:122)\n\tat java.lang.reflect.Field.acquireFieldAccessor(Field.java:918)\n\tat java.lang.reflect.Field.getFieldAccessor(Field.java:899)\n\tat java.lang.reflect.Field.get(Field.java:358)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedLinkFromTag(ResourceDocletJsonXml.java:649)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedExample(ResourceDocletJsonXml.java:542)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.createRepresentationDocTypes(ResourceDocletJsonXml.java:453)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.addResponseDoc(ResourceDocletJsonXml.java:428)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.start(ResourceDocletJsonXml.java:196)\n\tat sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)\n\tat sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)\n\tat sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)\n\tat java.lang.reflect.Method.invoke(Method.java:597)\n\tat com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:269)\n\tat com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:143)\n\tat com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)\n\tat com.sun.tools.javadoc.Start.begin(Start.java:128)\n\tat com.sun.tools.javadoc.Main.execute(Main.java:41)\n\tat com.sun.tools.javadoc.Main.main(Main.java:31)\n"
}if you are not logged in or anonymous access is not allowed
Get a list of all the users. You can also ask for a set of users.
| parameter | value | description |
|---|---|---|
|
username |
a username (or a few) to limit the number of returned entries. It will return only existing users. |
available response representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<users>
<userData>
<avatarUrl>http://foo.com/avatarfred</avatarUrl>
<displayName>Fred Nurk</displayName>
<userName>fred</userName>
</userData>
<userData>
<avatarUrl>http://foo.com/avatarjoe</avatarUrl>
<displayName>Joe Bloggs</displayName>
<userName>joe</userName>
</userData>
<errors>
<entry>
<key>adam</key>
<value>No user named 'adam'</value>
</entry>
</errors>
</users>
a list of users
{
"userData" : [ {
"userName" : "fred",
"displayName" : "Fred Nurk",
"avatarUrl" : "http://foo.com/avatarfred"
}, {
"userName" : "joe",
"displayName" : "Joe Bloggs",
"avatarUrl" : "http://foo.com/avatarjoe"
} ],
"errors" : {
"adam" : "No user named 'adam'"
}
}a list of users
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<error>
<code>NotPermitted</code>
<message>Access denied.</message>
<stacktrace>com.atlassian.crucible.spi.services.NotPermittedException: Access denied.
at com.atlassian.crucible.spi.rpc.ExampleDocuments.<clinit>(ExampleDocuments.java:21)
at sun.misc.Unsafe.ensureClassInitialized(Native Method)
at sun.reflect.UnsafeFieldAccessorFactory.newFieldAccessor(UnsafeFieldAccessorFactory.java:25)
at sun.reflect.ReflectionFactory.newFieldAccessor(ReflectionFactory.java:122)
at java.lang.reflect.Field.acquireFieldAccessor(Field.java:918)
at java.lang.reflect.Field.getFieldAccessor(Field.java:899)
at java.lang.reflect.Field.get(Field.java:358)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedLinkFromTag(ResourceDocletJsonXml.java:649)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedExample(ResourceDocletJsonXml.java:542)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.createRepresentationDocTypes(ResourceDocletJsonXml.java:453)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.addResponseDoc(ResourceDocletJsonXml.java:428)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.start(ResourceDocletJsonXml.java:196)
at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)
at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
at java.lang.reflect.Method.invoke(Method.java:597)
at com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:269)
at com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:143)
at com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)
at com.sun.tools.javadoc.Start.begin(Start.java:128)
at com.sun.tools.javadoc.Main.execute(Main.java:41)
at com.sun.tools.javadoc.Main.main(Main.java:31)
</stacktrace>
</error>
if you are not permitted to view the user list
{
"code" : "NotPermitted",
"message" : "Access denied.",
"stacktrace" : "com.atlassian.crucible.spi.services.NotPermittedException: Access denied.\n\tat com.atlassian.crucible.spi.rpc.ExampleDocuments.<clinit>(ExampleDocuments.java:21)\n\tat sun.misc.Unsafe.ensureClassInitialized(Native Method)\n\tat sun.reflect.UnsafeFieldAccessorFactory.newFieldAccessor(UnsafeFieldAccessorFactory.java:25)\n\tat sun.reflect.ReflectionFactory.newFieldAccessor(ReflectionFactory.java:122)\n\tat java.lang.reflect.Field.acquireFieldAccessor(Field.java:918)\n\tat java.lang.reflect.Field.getFieldAccessor(Field.java:899)\n\tat java.lang.reflect.Field.get(Field.java:358)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedLinkFromTag(ResourceDocletJsonXml.java:649)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedExample(ResourceDocletJsonXml.java:542)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.createRepresentationDocTypes(ResourceDocletJsonXml.java:453)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.addResponseDoc(ResourceDocletJsonXml.java:428)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.start(ResourceDocletJsonXml.java:196)\n\tat sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)\n\tat sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)\n\tat sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)\n\tat java.lang.reflect.Method.invoke(Method.java:597)\n\tat com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:269)\n\tat com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:143)\n\tat com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)\n\tat com.sun.tools.javadoc.Start.begin(Start.java:128)\n\tat com.sun.tools.javadoc.Main.execute(Main.java:41)\n\tat com.sun.tools.javadoc.Main.main(Main.java:31)\n"
}if you are not permitted to view the user list
| parameter | value | description |
|---|---|---|
|
username |
the name of the committer |
|
|
repository |
the name of the repository |
Returns the user details of the user mapped to a committer in a repository.
available response representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<userData>
<avatarUrl>http://foo.com/avatarfred</avatarUrl>
<displayName>Fred Nurk</displayName>
<userName>fred</userName>
</userData>
user data for a for a user that is mapped to a committer in a FishEye repository
{
"userName" : "fred",
"displayName" : "Fred Nurk",
"avatarUrl" : "http://foo.com/avatarfred"
}user data for a for a user that is mapped to a committer in a FishEye repository
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<error>
<code>NotPermitted</code>
<message>Access denied.</message>
<stacktrace>com.atlassian.crucible.spi.services.NotPermittedException: Access denied.
at com.atlassian.crucible.spi.rpc.ExampleDocuments.<clinit>(ExampleDocuments.java:21)
at sun.misc.Unsafe.ensureClassInitialized(Native Method)
at sun.reflect.UnsafeFieldAccessorFactory.newFieldAccessor(UnsafeFieldAccessorFactory.java:25)
at sun.reflect.ReflectionFactory.newFieldAccessor(ReflectionFactory.java:122)
at java.lang.reflect.Field.acquireFieldAccessor(Field.java:918)
at java.lang.reflect.Field.getFieldAccessor(Field.java:899)
at java.lang.reflect.Field.get(Field.java:358)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedLinkFromTag(ResourceDocletJsonXml.java:649)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedExample(ResourceDocletJsonXml.java:542)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.createRepresentationDocTypes(ResourceDocletJsonXml.java:453)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.addResponseDoc(ResourceDocletJsonXml.java:428)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.start(ResourceDocletJsonXml.java:196)
at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)
at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
at java.lang.reflect.Method.invoke(Method.java:597)
at com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:269)
at com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:143)
at com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)
at com.sun.tools.javadoc.Start.begin(Start.java:128)
at com.sun.tools.javadoc.Main.execute(Main.java:41)
at com.sun.tools.javadoc.Main.main(Main.java:31)
</stacktrace>
</error>
if you are not logged in or anonymous access is not allowed, or you are not allowed to access the repository
{
"code" : "NotPermitted",
"message" : "Access denied.",
"stacktrace" : "com.atlassian.crucible.spi.services.NotPermittedException: Access denied.\n\tat com.atlassian.crucible.spi.rpc.ExampleDocuments.<clinit>(ExampleDocuments.java:21)\n\tat sun.misc.Unsafe.ensureClassInitialized(Native Method)\n\tat sun.reflect.UnsafeFieldAccessorFactory.newFieldAccessor(UnsafeFieldAccessorFactory.java:25)\n\tat sun.reflect.ReflectionFactory.newFieldAccessor(ReflectionFactory.java:122)\n\tat java.lang.reflect.Field.acquireFieldAccessor(Field.java:918)\n\tat java.lang.reflect.Field.getFieldAccessor(Field.java:899)\n\tat java.lang.reflect.Field.get(Field.java:358)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedLinkFromTag(ResourceDocletJsonXml.java:649)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedExample(ResourceDocletJsonXml.java:542)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.createRepresentationDocTypes(ResourceDocletJsonXml.java:453)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.addResponseDoc(ResourceDocletJsonXml.java:428)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.start(ResourceDocletJsonXml.java:196)\n\tat sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)\n\tat sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)\n\tat sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)\n\tat java.lang.reflect.Method.invoke(Method.java:597)\n\tat com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:269)\n\tat com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:143)\n\tat com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)\n\tat com.sun.tools.javadoc.Start.begin(Start.java:128)\n\tat com.sun.tools.javadoc.Main.execute(Main.java:41)\n\tat com.sun.tools.javadoc.Main.main(Main.java:31)\n"
}if you are not logged in or anonymous access is not allowed, or you are not allowed to access the repository
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<error>
<code>NotFound</code>
<message>Requested resource not found.</message>
<stacktrace>com.atlassian.crucible.spi.services.NotFoundException: Requested resource not found.
at com.atlassian.crucible.spi.rpc.ExampleDocuments.<clinit>(ExampleDocuments.java:27)
at sun.misc.Unsafe.ensureClassInitialized(Native Method)
at sun.reflect.UnsafeFieldAccessorFactory.newFieldAccessor(UnsafeFieldAccessorFactory.java:25)
at sun.reflect.ReflectionFactory.newFieldAccessor(ReflectionFactory.java:122)
at java.lang.reflect.Field.acquireFieldAccessor(Field.java:918)
at java.lang.reflect.Field.getFieldAccessor(Field.java:899)
at java.lang.reflect.Field.get(Field.java:358)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedLinkFromTag(ResourceDocletJsonXml.java:649)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedExample(ResourceDocletJsonXml.java:542)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.createRepresentationDocTypes(ResourceDocletJsonXml.java:453)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.addResponseDoc(ResourceDocletJsonXml.java:428)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.start(ResourceDocletJsonXml.java:196)
at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)
at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
at java.lang.reflect.Method.invoke(Method.java:597)
at com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:269)
at com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:143)
at com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)
at com.sun.tools.javadoc.Start.begin(Start.java:128)
at com.sun.tools.javadoc.Main.execute(Main.java:41)
at com.sun.tools.javadoc.Main.main(Main.java:31)
</stacktrace>
</error>
if the committer does not exist
{
"code" : "NotFound",
"message" : "Requested resource not found.",
"stacktrace" : "com.atlassian.crucible.spi.services.NotFoundException: Requested resource not found.\n\tat com.atlassian.crucible.spi.rpc.ExampleDocuments.<clinit>(ExampleDocuments.java:27)\n\tat sun.misc.Unsafe.ensureClassInitialized(Native Method)\n\tat sun.reflect.UnsafeFieldAccessorFactory.newFieldAccessor(UnsafeFieldAccessorFactory.java:25)\n\tat sun.reflect.ReflectionFactory.newFieldAccessor(ReflectionFactory.java:122)\n\tat java.lang.reflect.Field.acquireFieldAccessor(Field.java:918)\n\tat java.lang.reflect.Field.getFieldAccessor(Field.java:899)\n\tat java.lang.reflect.Field.get(Field.java:358)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedLinkFromTag(ResourceDocletJsonXml.java:649)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedExample(ResourceDocletJsonXml.java:542)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.createRepresentationDocTypes(ResourceDocletJsonXml.java:453)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.addResponseDoc(ResourceDocletJsonXml.java:428)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.start(ResourceDocletJsonXml.java:196)\n\tat sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)\n\tat sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)\n\tat sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)\n\tat java.lang.reflect.Method.invoke(Method.java:597)\n\tat com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:269)\n\tat com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:143)\n\tat com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)\n\tat com.sun.tools.javadoc.Start.begin(Start.java:128)\n\tat com.sun.tools.javadoc.Main.execute(Main.java:41)\n\tat com.sun.tools.javadoc.Main.main(Main.java:31)\n"
}if the committer does not exist
| parameter | value | description |
|---|---|---|
|
username |
the username of the user |
Returns the user's profile details.
available response representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<restUserProfileData>
<avatarUrl>/foo/avatar/j_doe</avatarUrl>
<email>joe@example.org</email>
<mappedCommitters>
<committers>
<committerName>jbloggs</committerName>
<repositoryName>svnrepo</repositoryName>
</committers>
<committers>
<committerName>joe</committerName>
<repositoryName>cvsrepo</repositoryName>
</committers>
<committers>
<committerName>jbloggs</committerName>
<repositoryName>cvsrepo</repositoryName>
</committers>
</mappedCommitters>
<preferences>
<elements value="100" key="maxFilesPerChangeset"/>
<elements value="UTF-8" key="uploadcharset"/>
<elements value="patch" key="uploadtype"/>
<elements value="3" key="context"/>
<elements value="true" key="enableIde"/>
<elements value="30" key="changesetsPerPage"/>
<elements value="4" key="tabWidth"/>
<elements value="51235" key="ideConnectorPort"/>
<elements value="file" key="uploadmethod"/>
<elements value="instant" key="watchMode"/>
<elements value="html" key="emailFormat"/>
</preferences>
<timeZone>
<name>Europe/Warsaw</name>
<rawOffset>3600000</rawOffset>
</timeZone>
<userData>
<avatarUrl>http://foo.com/avatarjoe</avatarUrl>
<displayName>Joe Bloggs</displayName>
<userName>joe</userName>
</userData>
</restUserProfileData>
profile data for a crucible user
{
"userData" : {
"userName" : "joe",
"displayName" : "Joe Bloggs",
"avatarUrl" : "http://foo.com/avatarjoe"
},
"timeZone" : {
"name" : "Europe/Warsaw",
"rawOffset" : 3600000
},
"mappedCommitters" : {
"committers" : [ {
"committerName" : "jbloggs",
"repositoryName" : "svnrepo"
}, {
"committerName" : "joe",
"repositoryName" : "cvsrepo"
}, {
"committerName" : "jbloggs",
"repositoryName" : "cvsrepo"
} ]
},
"email" : "joe@example.org",
"avatarUrl" : "/foo/avatar/j_doe",
"preferences" : {
"elements" : [ {
"key" : "maxFilesPerChangeset",
"value" : "100"
}, {
"key" : "uploadcharset",
"value" : "UTF-8"
}, {
"key" : "uploadtype",
"value" : "patch"
}, {
"key" : "context",
"value" : "3"
}, {
"key" : "enableIde",
"value" : "true"
}, {
"key" : "changesetsPerPage",
"value" : "30"
}, {
"key" : "tabWidth",
"value" : "4"
}, {
"key" : "ideConnectorPort",
"value" : "51235"
}, {
"key" : "uploadmethod",
"value" : "file"
}, {
"key" : "watchMode",
"value" : "instant"
}, {
"key" : "emailFormat",
"value" : "html"
} ]
}
}profile data for a crucible user
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<error>
<code>NotPermitted</code>
<message>Access denied.</message>
<stacktrace>com.atlassian.crucible.spi.services.NotPermittedException: Access denied.
at com.atlassian.crucible.spi.rpc.ExampleDocuments.<clinit>(ExampleDocuments.java:21)
at sun.misc.Unsafe.ensureClassInitialized(Native Method)
at sun.reflect.UnsafeFieldAccessorFactory.newFieldAccessor(UnsafeFieldAccessorFactory.java:25)
at sun.reflect.ReflectionFactory.newFieldAccessor(ReflectionFactory.java:122)
at java.lang.reflect.Field.acquireFieldAccessor(Field.java:918)
at java.lang.reflect.Field.getFieldAccessor(Field.java:899)
at java.lang.reflect.Field.get(Field.java:358)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedLinkFromTag(ResourceDocletJsonXml.java:649)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedExample(ResourceDocletJsonXml.java:542)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.createRepresentationDocTypes(ResourceDocletJsonXml.java:453)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.addResponseDoc(ResourceDocletJsonXml.java:428)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.start(ResourceDocletJsonXml.java:196)
at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)
at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
at java.lang.reflect.Method.invoke(Method.java:597)
at com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:269)
at com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:143)
at com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)
at com.sun.tools.javadoc.Start.begin(Start.java:128)
at com.sun.tools.javadoc.Main.execute(Main.java:41)
at com.sun.tools.javadoc.Main.main(Main.java:31)
</stacktrace>
</error>
when you are not permitted to view the user's profile, either because
{
"code" : "NotPermitted",
"message" : "Access denied.",
"stacktrace" : "com.atlassian.crucible.spi.services.NotPermittedException: Access denied.\n\tat com.atlassian.crucible.spi.rpc.ExampleDocuments.<clinit>(ExampleDocuments.java:21)\n\tat sun.misc.Unsafe.ensureClassInitialized(Native Method)\n\tat sun.reflect.UnsafeFieldAccessorFactory.newFieldAccessor(UnsafeFieldAccessorFactory.java:25)\n\tat sun.reflect.ReflectionFactory.newFieldAccessor(ReflectionFactory.java:122)\n\tat java.lang.reflect.Field.acquireFieldAccessor(Field.java:918)\n\tat java.lang.reflect.Field.getFieldAccessor(Field.java:899)\n\tat java.lang.reflect.Field.get(Field.java:358)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedLinkFromTag(ResourceDocletJsonXml.java:649)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedExample(ResourceDocletJsonXml.java:542)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.createRepresentationDocTypes(ResourceDocletJsonXml.java:453)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.addResponseDoc(ResourceDocletJsonXml.java:428)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.start(ResourceDocletJsonXml.java:196)\n\tat sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)\n\tat sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)\n\tat sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)\n\tat java.lang.reflect.Method.invoke(Method.java:597)\n\tat com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:269)\n\tat com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:143)\n\tat com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)\n\tat com.sun.tools.javadoc.Start.begin(Start.java:128)\n\tat com.sun.tools.javadoc.Main.execute(Main.java:41)\n\tat com.sun.tools.javadoc.Main.main(Main.java:31)\n"
}when you are not permitted to view the user's profile, either because
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<error>
<code>NotFound</code>
<message>Requested resource not found.</message>
<stacktrace>com.atlassian.crucible.spi.services.NotFoundException: Requested resource not found.
at com.atlassian.crucible.spi.rpc.ExampleDocuments.<clinit>(ExampleDocuments.java:27)
at sun.misc.Unsafe.ensureClassInitialized(Native Method)
at sun.reflect.UnsafeFieldAccessorFactory.newFieldAccessor(UnsafeFieldAccessorFactory.java:25)
at sun.reflect.ReflectionFactory.newFieldAccessor(ReflectionFactory.java:122)
at java.lang.reflect.Field.acquireFieldAccessor(Field.java:918)
at java.lang.reflect.Field.getFieldAccessor(Field.java:899)
at java.lang.reflect.Field.get(Field.java:358)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedLinkFromTag(ResourceDocletJsonXml.java:649)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedExample(ResourceDocletJsonXml.java:542)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.createRepresentationDocTypes(ResourceDocletJsonXml.java:453)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.addResponseDoc(ResourceDocletJsonXml.java:428)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.start(ResourceDocletJsonXml.java:196)
at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)
at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
at java.lang.reflect.Method.invoke(Method.java:597)
at com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:269)
at com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:143)
at com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)
at com.sun.tools.javadoc.Start.begin(Start.java:128)
at com.sun.tools.javadoc.Main.execute(Main.java:41)
at com.sun.tools.javadoc.Main.main(Main.java:31)
</stacktrace>
</error>
if the user does not exist
{
"code" : "NotFound",
"message" : "Requested resource not found.",
"stacktrace" : "com.atlassian.crucible.spi.services.NotFoundException: Requested resource not found.\n\tat com.atlassian.crucible.spi.rpc.ExampleDocuments.<clinit>(ExampleDocuments.java:27)\n\tat sun.misc.Unsafe.ensureClassInitialized(Native Method)\n\tat sun.reflect.UnsafeFieldAccessorFactory.newFieldAccessor(UnsafeFieldAccessorFactory.java:25)\n\tat sun.reflect.ReflectionFactory.newFieldAccessor(ReflectionFactory.java:122)\n\tat java.lang.reflect.Field.acquireFieldAccessor(Field.java:918)\n\tat java.lang.reflect.Field.getFieldAccessor(Field.java:899)\n\tat java.lang.reflect.Field.get(Field.java:358)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedLinkFromTag(ResourceDocletJsonXml.java:649)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedExample(ResourceDocletJsonXml.java:542)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.createRepresentationDocTypes(ResourceDocletJsonXml.java:453)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.addResponseDoc(ResourceDocletJsonXml.java:428)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.start(ResourceDocletJsonXml.java:196)\n\tat sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)\n\tat sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)\n\tat sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)\n\tat java.lang.reflect.Method.invoke(Method.java:597)\n\tat com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:269)\n\tat com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:143)\n\tat com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)\n\tat com.sun.tools.javadoc.Start.begin(Start.java:128)\n\tat com.sun.tools.javadoc.Main.execute(Main.java:41)\n\tat com.sun.tools.javadoc.Main.main(Main.java:31)\n"
}if the user does not exist
This resource offers the ability for client applications to authenticate with Crucible and use the returned session identifier to make further calls without the need to send the caller's username and password every time.
The received token should be used as a FEAUTH query parameter for subsequent REST requests.
Usage of this resource is not required, as Crucible's REST API also supports basic HTTP authentication whereby the caller embeds the username and password in the HTTP request headers of every call, making the process completely stateless.
See https://developer.atlassian.com/display/FECRUDEV/Authenticating+REST+Requests for more details.Deprecated since FishEye 3.5.0 for removal in 4.0. Use POST /rest-service-fecru/auth/login instead.
Get the user authentication token.| parameter | value | description |
|---|---|---|
|
userName |
the username of the user to get the token for |
|
|
password |
the password for the user to get the token for |
available response representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<loginResult>
<token>evzijst:3319:bb51658323e4927ca7669e9b439bfe21</token>
</loginResult>
Result of a successful login.
{
"token" : "evzijst:3319:bb51658323e4927ca7669e9b439bfe21"
}Result of a successful login.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<loginResult>
<error>authentication failed</error>
</loginResult>
Result of an unsuccessful login.
{
"error" : "authentication failed"
}Result of an unsuccessful login.
Deprecated since FishEye 3.5.0 for removal in 4.0. Use POST /rest-service-fecru/auth/login instead.
Get the user authentication token.acceptable request representations:
| parameter | value | description |
|---|---|---|
|
userName |
the username of the user to get the token for |
|
|
password |
the password for the user to get the token for |
available response representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<loginResult>
<token>evzijst:3319:bb51658323e4927ca7669e9b439bfe21</token>
</loginResult>
Result of a successful login.
{
"token" : "evzijst:3319:bb51658323e4927ca7669e9b439bfe21"
}Result of a successful login.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<loginResult>
<error>authentication failed</error>
</loginResult>
Result of an unsuccessful login.
{
"error" : "authentication failed"
}Result of an unsuccessful login.
Get all reviews as a list of ReviewData structures. Note
that this may return a lot of data, so using
/reviews-v1/filter/<filter> is usually better.
The state parameter is a comma separated list of state names from the
set Draft, Approval, Review,
Summarize, Closed, Dead,
Rejected, Unknown.
| parameter | value | description |
|---|---|---|
|
state |
only return reviews that are in these states. |
available response representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<reviews>
<reviewData>
<allowReviewersToJoin>true</allowReviewersToJoin>
<author>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Joe Krustofski</displayName>
<userName>joe</userName>
</author>
<createDate>2015-04-28T09:47:56.272+0200</createDate>
<creator>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Joe Krustofski</displayName>
<userName>joe</userName>
</creator>
<description>Description or statement of objectives for this example review.</description>
<dueDate>2015-04-29T09:47:56.272+0200</dueDate>
<jiraIssueKey>FOO-6754</jiraIssueKey>
<metricsVersion>4</metricsVersion>
<moderator>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Scott the Moderator</displayName>
<userName>scott</userName>
</moderator>
<name>Example review.</name>
<permaId>
<id>CR-FOO-21</id>
</permaId>
<permaIdHistory>CR-FOO-21</permaIdHistory>
<projectKey>CR-FOO</projectKey>
<type>REVIEW</type>
</reviewData>
<reviewData>
<allowReviewersToJoin>true</allowReviewersToJoin>
<author>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Joe Krustofski</displayName>
<userName>joe</userName>
</author>
<createDate>2015-04-28T09:47:56.272+0200</createDate>
<creator>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Joe Krustofski</displayName>
<userName>joe</userName>
</creator>
<description>Description or statement of objectives for this example review.</description>
<dueDate>2015-04-29T09:47:56.272+0200</dueDate>
<jiraIssueKey>FOO-6754</jiraIssueKey>
<metricsVersion>4</metricsVersion>
<moderator>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Scott the Moderator</displayName>
<userName>scott</userName>
</moderator>
<name>Example review.</name>
<permaId>
<id>CR-FOO-21</id>
</permaId>
<permaIdHistory>CR-FOO-21</permaIdHistory>
<projectKey>CR-FOO</projectKey>
<type>REVIEW</type>
</reviewData>
</reviews>
A list of reviews, without any details such as comments or review items.
{
"reviewData" : [ {
"projectKey" : "CR-FOO",
"name" : "Example review.",
"description" : "Description or statement of objectives for this example review.",
"author" : {
"userName" : "joe",
"displayName" : "Joe Krustofski",
"avatarUrl" : "http://foo.com/avatar"
},
"moderator" : {
"userName" : "scott",
"displayName" : "Scott the Moderator",
"avatarUrl" : "http://foo.com/avatar"
},
"creator" : {
"userName" : "joe",
"displayName" : "Joe Krustofski",
"avatarUrl" : "http://foo.com/avatar"
},
"permaId" : {
"id" : "CR-FOO-21"
},
"permaIdHistory" : [ "CR-FOO-21" ],
"type" : "REVIEW",
"allowReviewersToJoin" : true,
"metricsVersion" : 4,
"createDate" : "2015-04-28T09:47:56.272+0200",
"dueDate" : "2015-04-29T09:47:56.272+0200",
"jiraIssueKey" : "FOO-6754"
}, {
"projectKey" : "CR-FOO",
"name" : "Example review.",
"description" : "Description or statement of objectives for this example review.",
"author" : {
"userName" : "joe",
"displayName" : "Joe Krustofski",
"avatarUrl" : "http://foo.com/avatar"
},
"moderator" : {
"userName" : "scott",
"displayName" : "Scott the Moderator",
"avatarUrl" : "http://foo.com/avatar"
},
"creator" : {
"userName" : "joe",
"displayName" : "Joe Krustofski",
"avatarUrl" : "http://foo.com/avatar"
},
"permaId" : {
"id" : "CR-FOO-21"
},
"permaIdHistory" : [ "CR-FOO-21" ],
"type" : "REVIEW",
"allowReviewersToJoin" : true,
"metricsVersion" : 4,
"createDate" : "2015-04-28T09:47:56.272+0200",
"dueDate" : "2015-04-29T09:47:56.272+0200",
"jiraIssueKey" : "FOO-6754"
} ]
}A list of reviews, without any details such as comments or review items.
Create a review from the given createReview element.
The sub-elements of the createReview element determine what type of review is created and how it is populated. The following rules govern which sub-elemnts can be present and how they are used in the review creation process
The reponse includes the Location header that contains the URL of the newly created entity.
acceptable request representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<createReview>
<reviewData>
<allowReviewersToJoin>true</allowReviewersToJoin>
<author>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Joe Krustofski</displayName>
<userName>joe</userName>
</author>
<createDate>2015-04-28T09:47:56.272+0200</createDate>
<creator>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Joe Krustofski</displayName>
<userName>joe</userName>
</creator>
<description>Description or statement of objectives for this example review.</description>
<dueDate>2015-04-29T09:47:56.272+0200</dueDate>
<jiraIssueKey>FOO-6754</jiraIssueKey>
<metricsVersion>4</metricsVersion>
<moderator>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Scott the Moderator</displayName>
<userName>scott</userName>
</moderator>
<name>Example review.</name>
<permaId>
<id>CR-FOO-21</id>
</permaId>
<permaIdHistory>CR-FOO-21</permaIdHistory>
<projectKey>CR-FOO</projectKey>
<type>REVIEW</type>
</reviewData>
<patch>Index: emptytests/notempty/a.txt
===================================================================
diff -u -N -r1.31 -r1.32
--- emptytests/notempty/a.txt 22 Sep 2004 00:38:15 -0000 1.31
+++ emptytests/notempty/a.txt 5 Dec 2004 01:04:25 -0000 1.32
@@ -4,4 +4,5 @@
hello there :D
CRU-123
http://madbean.com/blog/
-!
\ No newline at end of file
+!
+foobie
\ No newline at end of file
Index: test/a.txt
===================================================================
diff -u -N -r1.31 -r1.32
--- test/a.txt 22 Sep 2004 00:38:15 -0000 1.31
+++ test/a.txt 5 Dec 2004 01:04:25 -0000 1.32
@@ -4,4 +4,5 @@
hello there :D
CRU-123
http://madbean.com/blog/
-!
\ No newline at end of file
+!
+foobie
\ No newline at end of file</patch>
<anchor>
<anchorPath>/</anchorPath>
<anchorRepository>REPO</anchorRepository>
<stripCount>2</stripCount>
</anchor>
<changesets>
<changesetData>
<id>63452</id>
</changesetData>
<repository>REPO</repository>
</changesets>
</createReview>
Example of a request document used to create a new review from a changeset.
{
"reviewData" : {
"projectKey" : "CR-FOO",
"name" : "Example review.",
"description" : "Description or statement of objectives for this example review.",
"author" : {
"userName" : "joe",
"displayName" : "Joe Krustofski",
"avatarUrl" : "http://foo.com/avatar"
},
"moderator" : {
"userName" : "scott",
"displayName" : "Scott the Moderator",
"avatarUrl" : "http://foo.com/avatar"
},
"creator" : {
"userName" : "joe",
"displayName" : "Joe Krustofski",
"avatarUrl" : "http://foo.com/avatar"
},
"permaId" : {
"id" : "CR-FOO-21"
},
"permaIdHistory" : [ "CR-FOO-21" ],
"type" : "REVIEW",
"allowReviewersToJoin" : true,
"metricsVersion" : 4,
"createDate" : "2015-04-28T09:47:56.272+0200",
"dueDate" : "2015-04-29T09:47:56.272+0200",
"jiraIssueKey" : "FOO-6754"
},
"patch" : "Index: emptytests/notempty/a.txt\n===================================================================\ndiff -u -N -r1.31 -r1.32\n--- emptytests/notempty/a.txt\t22 Sep 2004 00:38:15 -0000\t1.31\n+++ emptytests/notempty/a.txt\t5 Dec 2004 01:04:25 -0000\t1.32\n@@ -4,4 +4,5 @@\n hello there :D\n CRU-123\n http://madbean.com/blog/\n-!\n\\ No newline at end of file\n+!\n+foobie\n\\ No newline at end of file\nIndex: test/a.txt\n===================================================================\ndiff -u -N -r1.31 -r1.32\n--- test/a.txt\t22 Sep 2004 00:38:15 -0000\t1.31\n+++ test/a.txt\t5 Dec 2004 01:04:25 -0000\t1.32\n@@ -4,4 +4,5 @@\n hello there :D\n CRU-123\n http://madbean.com/blog/\n-!\n\\ No newline at end of file\n+!\n+foobie\n\\ No newline at end of file",
"anchor" : {
"anchorPath" : "/",
"anchorRepository" : "REPO",
"stripCount" : 2
},
"changesets" : {
"changesetData" : [ {
"id" : "63452"
} ],
"repository" : "REPO"
}
}Example of a request document used to create a new review from a changeset.
available response representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<reviewData>
<allowReviewersToJoin>true</allowReviewersToJoin>
<author>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Joe Krustofski</displayName>
<userName>joe</userName>
</author>
<createDate>2015-04-28T09:47:56.272+0200</createDate>
<creator>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Joe Krustofski</displayName>
<userName>joe</userName>
</creator>
<description>Description or statement of objectives for this example review.</description>
<dueDate>2015-04-29T09:47:56.272+0200</dueDate>
<jiraIssueKey>FOO-6754</jiraIssueKey>
<metricsVersion>4</metricsVersion>
<moderator>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Scott the Moderator</displayName>
<userName>scott</userName>
</moderator>
<name>Example review.</name>
<permaId>
<id>CR-FOO-21</id>
</permaId>
<permaIdHistory>CR-FOO-21</permaIdHistory>
<projectKey>CR-FOO</projectKey>
<type>REVIEW</type>
</reviewData>
A reviewData element with the permId attribute set to the id of the review which was just created.
{
"projectKey" : "CR-FOO",
"name" : "Example review.",
"description" : "Description or statement of objectives for this example review.",
"author" : {
"userName" : "joe",
"displayName" : "Joe Krustofski",
"avatarUrl" : "http://foo.com/avatar"
},
"moderator" : {
"userName" : "scott",
"displayName" : "Scott the Moderator",
"avatarUrl" : "http://foo.com/avatar"
},
"creator" : {
"userName" : "joe",
"displayName" : "Joe Krustofski",
"avatarUrl" : "http://foo.com/avatar"
},
"permaId" : {
"id" : "CR-FOO-21"
},
"permaIdHistory" : [ "CR-FOO-21" ],
"type" : "REVIEW",
"allowReviewersToJoin" : true,
"metricsVersion" : 4,
"createDate" : "2015-04-28T09:47:56.272+0200",
"dueDate" : "2015-04-29T09:47:56.272+0200",
"jiraIssueKey" : "FOO-6754"
}A reviewData element with the permId attribute set to the id of the review which was just created.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<error>
<code>ReviewContentTooLarge</code>
<message>Attempt to add too many revisions to a review - no more than 800 file revisions are allowed.</message>
<stacktrace>com.atlassian.crucible.spi.services.ReviewContentTooLargeException: Attempt to add too many revisions to a review - no more than 800 file revisions are allowed.
at com.atlassian.crucible.spi.rpc.ReviewExampleDocuments.<clinit>(ReviewExampleDocuments.java:126)
at com.atlassian.fisheye.spi.rpc.ServerExampleDocuments.<clinit>(ServerExampleDocuments.java:10)
at sun.misc.Unsafe.ensureClassInitialized(Native Method)
at sun.reflect.UnsafeFieldAccessorFactory.newFieldAccessor(UnsafeFieldAccessorFactory.java:25)
at sun.reflect.ReflectionFactory.newFieldAccessor(ReflectionFactory.java:122)
at java.lang.reflect.Field.acquireFieldAccessor(Field.java:918)
at java.lang.reflect.Field.getFieldAccessor(Field.java:899)
at java.lang.reflect.Field.get(Field.java:358)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedLinkFromTag(ResourceDocletJsonXml.java:649)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedExample(ResourceDocletJsonXml.java:542)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.createRepresentationDocTypes(ResourceDocletJsonXml.java:453)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.addResponseDoc(ResourceDocletJsonXml.java:428)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.start(ResourceDocletJsonXml.java:196)
at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)
at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
at java.lang.reflect.Method.invoke(Method.java:597)
at com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:269)
at com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:143)
at com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)
at com.sun.tools.javadoc.Start.begin(Start.java:128)
at com.sun.tools.javadoc.Main.execute(Main.java:41)
at com.sun.tools.javadoc.Main.main(Main.java:31)
</stacktrace>
</error>
If the review is at or over allowed content size limit so new changes cannot be added until some other content is removed from review first. Also if the given patch is too large (contains too many files) for a single review.
{
"code" : "ReviewContentTooLarge",
"message" : "Attempt to add too many revisions to a review - no more than 800 file revisions are allowed.",
"stacktrace" : "com.atlassian.crucible.spi.services.ReviewContentTooLargeException: Attempt to add too many revisions to a review - no more than 800 file revisions are allowed.\n\tat com.atlassian.crucible.spi.rpc.ReviewExampleDocuments.<clinit>(ReviewExampleDocuments.java:126)\n\tat com.atlassian.fisheye.spi.rpc.ServerExampleDocuments.<clinit>(ServerExampleDocuments.java:10)\n\tat sun.misc.Unsafe.ensureClassInitialized(Native Method)\n\tat sun.reflect.UnsafeFieldAccessorFactory.newFieldAccessor(UnsafeFieldAccessorFactory.java:25)\n\tat sun.reflect.ReflectionFactory.newFieldAccessor(ReflectionFactory.java:122)\n\tat java.lang.reflect.Field.acquireFieldAccessor(Field.java:918)\n\tat java.lang.reflect.Field.getFieldAccessor(Field.java:899)\n\tat java.lang.reflect.Field.get(Field.java:358)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedLinkFromTag(ResourceDocletJsonXml.java:649)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedExample(ResourceDocletJsonXml.java:542)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.createRepresentationDocTypes(ResourceDocletJsonXml.java:453)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.addResponseDoc(ResourceDocletJsonXml.java:428)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.start(ResourceDocletJsonXml.java:196)\n\tat sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)\n\tat sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)\n\tat sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)\n\tat java.lang.reflect.Method.invoke(Method.java:597)\n\tat com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:269)\n\tat com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:143)\n\tat com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)\n\tat com.sun.tools.javadoc.Start.begin(Start.java:128)\n\tat com.sun.tools.javadoc.Main.execute(Main.java:41)\n\tat com.sun.tools.javadoc.Main.main(Main.java:31)\n"
}If the review is at or over allowed content size limit so new changes cannot be added until some other content is removed from review first. Also if the given patch is too large (contains too many files) for a single review.
| parameter | value | description |
|---|---|---|
|
id |
the review perma id |
|
|
cId |
the comment perma id |
Gets the given comment.
| parameter | value | description |
|---|---|---|
|
render |
Default: false |
true if the wiki text should be rendered into html, into the field <messageAsHtml>. |
available response representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<versionedLineCommentData>
<createDate>2015-04-28T09:47:56.313+0200</createDate>
<defectApproved>false</defectApproved>
<defectRaised>false</defectRaised>
<deleted>false</deleted>
<draft>false</draft>
<message>*bold* message</message>
<messageAsHtml><p><b>bold</b> message</p></messageAsHtml>
<parentCommentId/>
<readStatus>READ</readStatus>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Fred Veiligheidspet</displayName>
<userName>fred</userName>
</user>
<permaId/>
<reviewItemId>
<id>CRFX-1234</id>
</reviewItemId>
<fromLineRange>10</fromLineRange>
<toLineRange>20</toLineRange>
</versionedLineCommentData>
comment
{
"message" : "*bold* message",
"draft" : false,
"deleted" : false,
"defectRaised" : false,
"defectApproved" : false,
"readStatus" : "READ",
"user" : {
"userName" : "fred",
"displayName" : "Fred Veiligheidspet",
"avatarUrl" : "http://foo.com/avatar"
},
"createDate" : 1430207276313,
"messageAsHtml" : "<p><b>bold</b> message</p>",
"reviewItemId" : {
"id" : "CRFX-1234"
},
"fromLineRange" : "10",
"toLineRange" : "20"
}comment
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<error>
<code>PermaIdFormat</code>
<message>Malformed PermId.</message>
<stacktrace>com.cenqua.crucible.model.PermaIdFormatException: Malformed PermId.
at com.atlassian.crucible.spi.rpc.ExampleDocuments.<clinit>(ExampleDocuments.java:33)
at sun.misc.Unsafe.ensureClassInitialized(Native Method)
at sun.reflect.UnsafeFieldAccessorFactory.newFieldAccessor(UnsafeFieldAccessorFactory.java:25)
at sun.reflect.ReflectionFactory.newFieldAccessor(ReflectionFactory.java:122)
at java.lang.reflect.Field.acquireFieldAccessor(Field.java:918)
at java.lang.reflect.Field.getFieldAccessor(Field.java:899)
at java.lang.reflect.Field.get(Field.java:358)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedLinkFromTag(ResourceDocletJsonXml.java:649)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedExample(ResourceDocletJsonXml.java:542)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.createRepresentationDocTypes(ResourceDocletJsonXml.java:453)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.addResponseDoc(ResourceDocletJsonXml.java:428)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.start(ResourceDocletJsonXml.java:196)
at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)
at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
at java.lang.reflect.Method.invoke(Method.java:597)
at com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:269)
at com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:143)
at com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)
at com.sun.tools.javadoc.Start.begin(Start.java:128)
at com.sun.tools.javadoc.Main.execute(Main.java:41)
at com.sun.tools.javadoc.Main.main(Main.java:31)
</stacktrace>
</error>
if the review perma-id is not well-formed
{
"code" : "PermaIdFormat",
"message" : "Malformed PermId.",
"stacktrace" : "com.cenqua.crucible.model.PermaIdFormatException: Malformed PermId.\n\tat com.atlassian.crucible.spi.rpc.ExampleDocuments.<clinit>(ExampleDocuments.java:33)\n\tat sun.misc.Unsafe.ensureClassInitialized(Native Method)\n\tat sun.reflect.UnsafeFieldAccessorFactory.newFieldAccessor(UnsafeFieldAccessorFactory.java:25)\n\tat sun.reflect.ReflectionFactory.newFieldAccessor(ReflectionFactory.java:122)\n\tat java.lang.reflect.Field.acquireFieldAccessor(Field.java:918)\n\tat java.lang.reflect.Field.getFieldAccessor(Field.java:899)\n\tat java.lang.reflect.Field.get(Field.java:358)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedLinkFromTag(ResourceDocletJsonXml.java:649)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedExample(ResourceDocletJsonXml.java:542)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.createRepresentationDocTypes(ResourceDocletJsonXml.java:453)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.addResponseDoc(ResourceDocletJsonXml.java:428)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.start(ResourceDocletJsonXml.java:196)\n\tat sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)\n\tat sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)\n\tat sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)\n\tat java.lang.reflect.Method.invoke(Method.java:597)\n\tat com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:269)\n\tat com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:143)\n\tat com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)\n\tat com.sun.tools.javadoc.Start.begin(Start.java:128)\n\tat com.sun.tools.javadoc.Main.execute(Main.java:41)\n\tat com.sun.tools.javadoc.Main.main(Main.java:31)\n"
}if the review perma-id is not well-formed
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<error>
<code>NotPermitted</code>
<message>Access denied.</message>
<stacktrace>com.atlassian.crucible.spi.services.NotPermittedException: Access denied.
at com.atlassian.crucible.spi.rpc.ExampleDocuments.<clinit>(ExampleDocuments.java:21)
at sun.misc.Unsafe.ensureClassInitialized(Native Method)
at sun.reflect.UnsafeFieldAccessorFactory.newFieldAccessor(UnsafeFieldAccessorFactory.java:25)
at sun.reflect.ReflectionFactory.newFieldAccessor(ReflectionFactory.java:122)
at java.lang.reflect.Field.acquireFieldAccessor(Field.java:918)
at java.lang.reflect.Field.getFieldAccessor(Field.java:899)
at java.lang.reflect.Field.get(Field.java:358)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedLinkFromTag(ResourceDocletJsonXml.java:649)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedExample(ResourceDocletJsonXml.java:542)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.createRepresentationDocTypes(ResourceDocletJsonXml.java:453)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.addResponseDoc(ResourceDocletJsonXml.java:428)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.start(ResourceDocletJsonXml.java:196)
at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)
at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
at java.lang.reflect.Method.invoke(Method.java:597)
at com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:269)
at com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:143)
at com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)
at com.sun.tools.javadoc.Start.begin(Start.java:128)
at com.sun.tools.javadoc.Main.execute(Main.java:41)
at com.sun.tools.javadoc.Main.main(Main.java:31)
</stacktrace>
</error>
if you are not permitted to view the review
{
"code" : "NotPermitted",
"message" : "Access denied.",
"stacktrace" : "com.atlassian.crucible.spi.services.NotPermittedException: Access denied.\n\tat com.atlassian.crucible.spi.rpc.ExampleDocuments.<clinit>(ExampleDocuments.java:21)\n\tat sun.misc.Unsafe.ensureClassInitialized(Native Method)\n\tat sun.reflect.UnsafeFieldAccessorFactory.newFieldAccessor(UnsafeFieldAccessorFactory.java:25)\n\tat sun.reflect.ReflectionFactory.newFieldAccessor(ReflectionFactory.java:122)\n\tat java.lang.reflect.Field.acquireFieldAccessor(Field.java:918)\n\tat java.lang.reflect.Field.getFieldAccessor(Field.java:899)\n\tat java.lang.reflect.Field.get(Field.java:358)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedLinkFromTag(ResourceDocletJsonXml.java:649)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedExample(ResourceDocletJsonXml.java:542)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.createRepresentationDocTypes(ResourceDocletJsonXml.java:453)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.addResponseDoc(ResourceDocletJsonXml.java:428)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.start(ResourceDocletJsonXml.java:196)\n\tat sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)\n\tat sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)\n\tat sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)\n\tat java.lang.reflect.Method.invoke(Method.java:597)\n\tat com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:269)\n\tat com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:143)\n\tat com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)\n\tat com.sun.tools.javadoc.Start.begin(Start.java:128)\n\tat com.sun.tools.javadoc.Main.execute(Main.java:41)\n\tat com.sun.tools.javadoc.Main.main(Main.java:31)\n"
}if you are not permitted to view the review
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<error>
<code>NotFound</code>
<message>Requested resource not found.</message>
<stacktrace>com.atlassian.crucible.spi.services.NotFoundException: Requested resource not found.
at com.atlassian.crucible.spi.rpc.ExampleDocuments.<clinit>(ExampleDocuments.java:27)
at sun.misc.Unsafe.ensureClassInitialized(Native Method)
at sun.reflect.UnsafeFieldAccessorFactory.newFieldAccessor(UnsafeFieldAccessorFactory.java:25)
at sun.reflect.ReflectionFactory.newFieldAccessor(ReflectionFactory.java:122)
at java.lang.reflect.Field.acquireFieldAccessor(Field.java:918)
at java.lang.reflect.Field.getFieldAccessor(Field.java:899)
at java.lang.reflect.Field.get(Field.java:358)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedLinkFromTag(ResourceDocletJsonXml.java:649)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedExample(ResourceDocletJsonXml.java:542)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.createRepresentationDocTypes(ResourceDocletJsonXml.java:453)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.addResponseDoc(ResourceDocletJsonXml.java:428)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.start(ResourceDocletJsonXml.java:196)
at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)
at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
at java.lang.reflect.Method.invoke(Method.java:597)
at com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:269)
at com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:143)
at com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)
at com.sun.tools.javadoc.Start.begin(Start.java:128)
at com.sun.tools.javadoc.Main.execute(Main.java:41)
at com.sun.tools.javadoc.Main.main(Main.java:31)
</stacktrace>
</error>
if the review does not exist
{
"code" : "NotFound",
"message" : "Requested resource not found.",
"stacktrace" : "com.atlassian.crucible.spi.services.NotFoundException: Requested resource not found.\n\tat com.atlassian.crucible.spi.rpc.ExampleDocuments.<clinit>(ExampleDocuments.java:27)\n\tat sun.misc.Unsafe.ensureClassInitialized(Native Method)\n\tat sun.reflect.UnsafeFieldAccessorFactory.newFieldAccessor(UnsafeFieldAccessorFactory.java:25)\n\tat sun.reflect.ReflectionFactory.newFieldAccessor(ReflectionFactory.java:122)\n\tat java.lang.reflect.Field.acquireFieldAccessor(Field.java:918)\n\tat java.lang.reflect.Field.getFieldAccessor(Field.java:899)\n\tat java.lang.reflect.Field.get(Field.java:358)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedLinkFromTag(ResourceDocletJsonXml.java:649)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedExample(ResourceDocletJsonXml.java:542)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.createRepresentationDocTypes(ResourceDocletJsonXml.java:453)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.addResponseDoc(ResourceDocletJsonXml.java:428)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.start(ResourceDocletJsonXml.java:196)\n\tat sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)\n\tat sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)\n\tat sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)\n\tat java.lang.reflect.Method.invoke(Method.java:597)\n\tat com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:269)\n\tat com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:143)\n\tat com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)\n\tat com.sun.tools.javadoc.Start.begin(Start.java:128)\n\tat com.sun.tools.javadoc.Main.execute(Main.java:41)\n\tat com.sun.tools.javadoc.Main.main(Main.java:31)\n"
}if the review does not exist
Updates the comment given by the perma id to the new comment posted.
acceptable request representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<generalCommentData>
<defectApproved>false</defectApproved>
<defectRaised>false</defectRaised>
<deleted>false</deleted>
<draft>true</draft>
<message>I thought you said you were going to remove this line?</message>
<parentCommentId/>
<permId/>
<permaId/>
</generalCommentData>
{
"message" : "I thought you said you were going to remove this line?",
"draft" : true,
"deleted" : false,
"defectRaised" : false,
"defectApproved" : false,
"permaId" : {
},
"permId" : {
},
"parentCommentId" : {
}
}Deletes the given comment.
| parameter | value | description |
|---|---|---|
|
id |
the review perma id to add the file |
Adds a file to the review, optionally diff'ed to a second file.
In contrast to a patch, files can be either binary or text. Depending on the filetype, size and contents, Crucible may be able to display either parts, or the entire file in the review. It is possible to upload two versions of the file, in which case Crucible will display a diff and report that the file was modified. When only a single file is uploaded, Crucible treats the file as newly added.
This action returns the ReviewData document on success.
This resources uses multipart form-data to receive the file(s), character set indication and optional comments (it does not expect an XML document with embedded files, as that would require the client to first encode the files in Base64). Making a multipart form-data request can be done manually, but you will probably want to use a library.
During testing it is convenient to let your browser generate the requests using the test html form below:
<html>
<head><title>Rest File Upload Test</title></head>
<body>
<form action="http://localhost:8060/rest-service/reviews-v1/CR-4/addFile" enctype="multipart/form-data" method="POST">
<table>
<tr>
<td>File (required):</td>
<td><input name="file" type="file"/></td>
</tr>
<tr>
<td>Diff to (optional):</td>
<td><input name="diffFile" type="file"/></td>
</tr>
<tr>
<td>Character Set (optional):</td>
<td><input name="charset" type="text" value="UTF-8"/></td>
</tr>
<tr>
<td>Comments (optional):</td>
<td><input type="text" name="comments"/></td>
</tr>
<tr><td><input type="submit" value="Upload"/></td></tr>
</table>
</form>
</body>
</html>
available response representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<reviewItem>
<participants>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Fred Eaglesmith</displayName>
<userName>fred</userName>
</user>
<completed>false</completed>
</participant>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Corb Lund</displayName>
<userName>clund</userName>
</user>
<completed>false</completed>
</participant>
</participants>
<permId>
<id>CFR-7453</id>
</permId>
<authorName>evzijst</authorName>
<commitDate>2015-04-28T09:47:56.304+02:00</commitDate>
<commitType>Modified</commitType>
<fileType>File</fileType>
<fromContentUrl>/context/cru/CR-123/rawcontent/5622//project/trunk/pom.xml</fromContentUrl>
<fromPath>/project/trunk/pom.xml</fromPath>
<fromRevision>688</fromRevision>
<repositoryName>REPO</repositoryName>
<showAsDiff>true</showAsDiff>
<toContentUrl>/context/cru/CR-123/rawcontent/5656//project/trunk/pom.xml</toContentUrl>
<toPath>/project/trunk/pom.xml</toPath>
<toRevision>6881</toRevision>
</reviewItem>
The response is the reviewItemData structure describing the new item. Also, the Location response header is present and contains the PermId URL of the new item.
{
"permId" : {
"id" : "CFR-7453"
},
"participants" : [ {
"user" : {
"userName" : "fred",
"displayName" : "Fred Eaglesmith",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
}, {
"user" : {
"userName" : "clund",
"displayName" : "Corb Lund",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
} ],
"repositoryName" : "REPO",
"fromPath" : "/project/trunk/pom.xml",
"fromRevision" : "688",
"fromContentUrl" : "/context/cru/CR-123/rawcontent/5622//project/trunk/pom.xml",
"toPath" : "/project/trunk/pom.xml",
"toRevision" : "6881",
"toContentUrl" : "/context/cru/CR-123/rawcontent/5656//project/trunk/pom.xml",
"fileType" : "File",
"commitType" : "Modified",
"authorName" : "evzijst",
"showAsDiff" : true,
"commitDate" : 1430207276304
}The response is the reviewItemData structure describing the new item. Also, the Location response header is present and contains the PermId URL of the new item.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<error>
<code>ReviewContentTooLarge</code>
<message>Attempt to add too many revisions to a review - no more than 800 file revisions are allowed.</message>
<stacktrace>com.atlassian.crucible.spi.services.ReviewContentTooLargeException: Attempt to add too many revisions to a review - no more than 800 file revisions are allowed.
at com.atlassian.crucible.spi.rpc.ReviewExampleDocuments.<clinit>(ReviewExampleDocuments.java:126)
at com.atlassian.fisheye.spi.rpc.ServerExampleDocuments.<clinit>(ServerExampleDocuments.java:10)
at sun.misc.Unsafe.ensureClassInitialized(Native Method)
at sun.reflect.UnsafeFieldAccessorFactory.newFieldAccessor(UnsafeFieldAccessorFactory.java:25)
at sun.reflect.ReflectionFactory.newFieldAccessor(ReflectionFactory.java:122)
at java.lang.reflect.Field.acquireFieldAccessor(Field.java:918)
at java.lang.reflect.Field.getFieldAccessor(Field.java:899)
at java.lang.reflect.Field.get(Field.java:358)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedLinkFromTag(ResourceDocletJsonXml.java:649)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedExample(ResourceDocletJsonXml.java:542)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.createRepresentationDocTypes(ResourceDocletJsonXml.java:453)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.addResponseDoc(ResourceDocletJsonXml.java:428)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.start(ResourceDocletJsonXml.java:196)
at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)
at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
at java.lang.reflect.Method.invoke(Method.java:597)
at com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:269)
at com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:143)
at com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)
at com.sun.tools.javadoc.Start.begin(Start.java:128)
at com.sun.tools.javadoc.Main.execute(Main.java:41)
at com.sun.tools.javadoc.Main.main(Main.java:31)
</stacktrace>
</error>
If the review is at or over allowed content size limit so new changes cannot be added until some other content is removed from review first.
{
"code" : "ReviewContentTooLarge",
"message" : "Attempt to add too many revisions to a review - no more than 800 file revisions are allowed.",
"stacktrace" : "com.atlassian.crucible.spi.services.ReviewContentTooLargeException: Attempt to add too many revisions to a review - no more than 800 file revisions are allowed.\n\tat com.atlassian.crucible.spi.rpc.ReviewExampleDocuments.<clinit>(ReviewExampleDocuments.java:126)\n\tat com.atlassian.fisheye.spi.rpc.ServerExampleDocuments.<clinit>(ServerExampleDocuments.java:10)\n\tat sun.misc.Unsafe.ensureClassInitialized(Native Method)\n\tat sun.reflect.UnsafeFieldAccessorFactory.newFieldAccessor(UnsafeFieldAccessorFactory.java:25)\n\tat sun.reflect.ReflectionFactory.newFieldAccessor(ReflectionFactory.java:122)\n\tat java.lang.reflect.Field.acquireFieldAccessor(Field.java:918)\n\tat java.lang.reflect.Field.getFieldAccessor(Field.java:899)\n\tat java.lang.reflect.Field.get(Field.java:358)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedLinkFromTag(ResourceDocletJsonXml.java:649)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedExample(ResourceDocletJsonXml.java:542)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.createRepresentationDocTypes(ResourceDocletJsonXml.java:453)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.addResponseDoc(ResourceDocletJsonXml.java:428)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.start(ResourceDocletJsonXml.java:196)\n\tat sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)\n\tat sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)\n\tat sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)\n\tat java.lang.reflect.Method.invoke(Method.java:597)\n\tat com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:269)\n\tat com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:143)\n\tat com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)\n\tat com.sun.tools.javadoc.Start.begin(Start.java:128)\n\tat com.sun.tools.javadoc.Main.execute(Main.java:41)\n\tat com.sun.tools.javadoc.Main.main(Main.java:31)\n"
}If the review is at or over allowed content size limit so new changes cannot be added until some other content is removed from review first.
| parameter | value | description |
|---|---|---|
|
version |
a metrics version. |
Get comment metrics metadata for the specified metrics version.
available response representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<metrics>
<metricsData>
<configVersion>4</configVersion>
<defaultValue>
<name>Major</name>
<value xsi:type="xs:int" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">0</value>
</defaultValue>
<label>Rank</label>
<type>INTEGER</type>
<values>
<name>Major</name>
<value xsi:type="xs:int" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">0</value>
</values>
<values>
<name>Minor</name>
<value xsi:type="xs:int" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">1</value>
</values>
</metricsData>
<metricsData>
<configVersion>4</configVersion>
<defaultValue>
<name>Inconsistent</name>
<value xsi:type="xs:int" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">3</value>
</defaultValue>
<label>Classification</label>
<type>INTEGER</type>
<values>
<name>Missing</name>
<value xsi:type="xs:int" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">0</value>
</values>
<values>
<name>Extra (superfluous)</name>
<value xsi:type="xs:int" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">1</value>
</values>
<values>
<name>Ambiguous</name>
<value xsi:type="xs:int" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">2</value>
</values>
<values>
<name>Inconsistent</name>
<value xsi:type="xs:int" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">3</value>
</values>
<values>
<name>Improvement desirable</name>
<value xsi:type="xs:int" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">4</value>
</values>
<values>
<name>Not conforming to standards</name>
<value xsi:type="xs:int" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">5</value>
</values>
<values>
<name>Risk-Prone</name>
<value xsi:type="xs:int" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">6</value>
</values>
<values>
<name>Factually incorrect</name>
<value xsi:type="xs:int" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">7</value>
</values>
</metricsData>
</metrics>
A comment metrics configuration.
{
"metricsData" : [ {
"type" : "INTEGER",
"configVersion" : 4,
"label" : "Rank",
"defaultValue" : {
"name" : "Major",
"value" : 0
},
"values" : [ {
"name" : "Major",
"value" : 0
}, {
"name" : "Minor",
"value" : 1
} ]
}, {
"type" : "INTEGER",
"configVersion" : 4,
"label" : "Classification",
"defaultValue" : {
"name" : "Inconsistent",
"value" : 3
},
"values" : [ {
"name" : "Missing",
"value" : 0
}, {
"name" : "Extra (superfluous)",
"value" : 1
}, {
"name" : "Ambiguous",
"value" : 2
}, {
"name" : "Inconsistent",
"value" : 3
}, {
"name" : "Improvement desirable",
"value" : 4
}, {
"name" : "Not conforming to standards",
"value" : 5
}, {
"name" : "Risk-Prone",
"value" : 6
}, {
"name" : "Factually incorrect",
"value" : 7
} ]
} ]
}A comment metrics configuration.
Returns Crucible version information.
available response representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<versionInfo>
<releaseNumber>3.8.0</releaseNumber>
<buildDate>2015-04-27</buildDate>
</versionInfo>
The product version.
{
"releaseNumber" : "3.8.0",
"buildDate" : "2015-04-27"
}The product version.
Retrieves all reviews that are in one of the the specified states. For each review all details are included (review items + comments). The wiki rendered comments will be available via the <messageAsHtml> element
| parameter | value | description |
|---|---|---|
|
state |
the review states to match. |
available response representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<detailedReviewData>
<allowReviewersToJoin>true</allowReviewersToJoin>
<author>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Joe Krustofski</displayName>
<userName>joe</userName>
</author>
<createDate>2015-04-28T09:47:56.272+0200</createDate>
<creator>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Joe Krustofski</displayName>
<userName>joe</userName>
</creator>
<description>Description or statement of objectives for this example review.</description>
<dueDate>2015-04-29T09:47:56.272+0200</dueDate>
<jiraIssueKey>FOO-6754</jiraIssueKey>
<metricsVersion>4</metricsVersion>
<moderator>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Scott the Moderator</displayName>
<userName>scott</userName>
</moderator>
<name>Example review.</name>
<permaId>
<id>CR-FOO-21</id>
</permaId>
<permaIdHistory>CR-FOO-21</permaIdHistory>
<projectKey>CR-FOO</projectKey>
<type>REVIEW</type>
<actions>
<actionData>
<displayName>Abandon</displayName>
<name>action:abandonReview</name>
</actionData>
<actionData>
<displayName>Approve</displayName>
<name>action:approveReview</name>
</actionData>
<actionData>
<displayName>Comment</displayName>
<name>action:commentOnReview</name>
</actionData>
<actionData>
<displayName>Complete</displayName>
<name>action:completeReview</name>
</actionData>
<actionData>
<displayName>Edit Review Details</displayName>
<name>action:modifyReviewFiles</name>
</actionData>
</actions>
<generalComments>
<generalCommentData>
<createDate>2015-04-28T09:47:56.281+0200</createDate>
<defectApproved>false</defectApproved>
<defectRaised>false</defectRaised>
<deleted>false</deleted>
<draft>false</draft>
<message>I thought you said you were going to *remove* this line?</message>
<messageAsHtml>I thought you said you were going to <b>remove</b> this line?</messageAsHtml>
<metrics/>
<parentCommentId/>
<readStatus>UNREAD</readStatus>
<replies/>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Joe Bloggs</displayName>
<userName>joe</userName>
</user>
<permId>
<id>CR:1</id>
</permId>
<permaId>
<id>CR:1</id>
</permaId>
</generalCommentData>
</generalComments>
<reviewItems>
<reviewItem>
<participants>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Fred Eaglesmith</displayName>
<userName>fred</userName>
</user>
<completed>false</completed>
</participant>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Corb Lund</displayName>
<userName>clund</userName>
</user>
<completed>false</completed>
</participant>
</participants>
<permId>
<id>CFR-65</id>
</permId>
<anchorData>
<anchorPath>trunk</anchorPath>
<anchorRepository>REPO</anchorRepository>
<stripCount>0</stripCount>
</anchorData>
<authorName>evzijst</authorName>
<commitDate>2015-04-28T09:47:56.310+02:00</commitDate>
<commitType>Modified</commitType>
<fileType>File</fileType>
<fromContentUrl>/context/cru/CR-FOO-21/rawcontent/5687/dir64/a.txt</fromContentUrl>
<fromPath>dir64/a.txt</fromPath>
<fromRevision>65</fromRevision>
<patchUrl>/contextcru/CR-FOO-21/downloadpatch/6238/patch-7126.patch</patchUrl>
<repositoryName>REPO</repositoryName>
<showAsDiff>false</showAsDiff>
<toContentUrl>/context/cru/CR-FOO-21/rawcontent/6675/dir64/a.txt</toContentUrl>
<toPath>dir64/a.txt</toPath>
<toRevision>651</toRevision>
</reviewItem>
<reviewItem>
<participants>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Fred Eaglesmith</displayName>
<userName>fred</userName>
</user>
<completed>false</completed>
</participant>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Corb Lund</displayName>
<userName>clund</userName>
</user>
<completed>false</completed>
</participant>
</participants>
<permId>
<id>CFR-66</id>
</permId>
<anchorData>
<anchorPath>branches/branch1</anchorPath>
<anchorRepository>REPO</anchorRepository>
<stripCount>0</stripCount>
</anchorData>
<authorName>evzijst</authorName>
<commitDate>2015-04-28T09:47:56.310+02:00</commitDate>
<commitType>Modified</commitType>
<fileType>File</fileType>
<fromContentUrl>/context/cru/CR-FOO-21/rawcontent/5690/dir65/d.txt</fromContentUrl>
<fromPath>dir65/d.txt</fromPath>
<fromRevision>66</fromRevision>
<patchUrl>/contextcru/CR-FOO-21/downloadpatch/6273/patch-6173.patch</patchUrl>
<repositoryName>REPO</repositoryName>
<showAsDiff>true</showAsDiff>
<toContentUrl>/context/cru/CR-FOO-21/rawcontent/6085/dir65/d.txt</toContentUrl>
<toPath>dir65/d.txt</toPath>
<toRevision>661</toRevision>
</reviewItem>
<reviewItem>
<participants>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Fred Eaglesmith</displayName>
<userName>fred</userName>
</user>
<completed>false</completed>
</participant>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Corb Lund</displayName>
<userName>clund</userName>
</user>
<completed>false</completed>
</participant>
</participants>
<permId>
<id>CFR-67</id>
</permId>
<anchorData>
<anchorPath>branches/branch1</anchorPath>
<anchorRepository>REPO</anchorRepository>
<stripCount>0</stripCount>
</anchorData>
<authorName>evzijst</authorName>
<commitDate>2015-04-28T09:47:56.310+02:00</commitDate>
<commitType>Modified</commitType>
<fileType>File</fileType>
<fromContentUrl>/context/cru/CR-FOO-21/rawcontent/5693/dir66/c.txt</fromContentUrl>
<fromPath>dir66/c.txt</fromPath>
<fromRevision>67</fromRevision>
<patchUrl>/contextcru/CR-FOO-21/downloadpatch/6281/patch-9135.patch</patchUrl>
<repositoryName>REPO</repositoryName>
<showAsDiff>false</showAsDiff>
<toContentUrl>/context/cru/CR-FOO-21/rawcontent/5909/dir66/c.txt</toContentUrl>
<toPath>dir66/c.txt</toPath>
<toRevision>671</toRevision>
</reviewItem>
<reviewItem>
<participants>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Fred Eaglesmith</displayName>
<userName>fred</userName>
</user>
<completed>false</completed>
</participant>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Corb Lund</displayName>
<userName>clund</userName>
</user>
<completed>false</completed>
</participant>
</participants>
<permId>
<id>CFR-68</id>
</permId>
<anchorData>
<anchorPath>tags/tag1</anchorPath>
<anchorRepository>REPO</anchorRepository>
<stripCount>0</stripCount>
</anchorData>
<authorName>evzijst</authorName>
<commitDate>2015-04-28T09:47:56.310+02:00</commitDate>
<commitType>Modified</commitType>
<fileType>File</fileType>
<fromContentUrl>/context/cru/CR-FOO-21/rawcontent/5696/dir67/b.txt</fromContentUrl>
<fromPath>dir67/b.txt</fromPath>
<fromRevision>68</fromRevision>
<patchUrl>/contextcru/CR-FOO-21/downloadpatch/6394/patch-6062.patch</patchUrl>
<repositoryName>REPO</repositoryName>
<showAsDiff>true</showAsDiff>
<toContentUrl>/context/cru/CR-FOO-21/rawcontent/5789/dir67/b.txt</toContentUrl>
<toPath>dir67/b.txt</toPath>
<toRevision>681</toRevision>
</reviewItem>
<reviewItem>
<participants>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Fred Eaglesmith</displayName>
<userName>fred</userName>
</user>
<completed>false</completed>
</participant>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Corb Lund</displayName>
<userName>clund</userName>
</user>
<completed>false</completed>
</participant>
</participants>
<permId>
<id>CFR-69</id>
</permId>
<authorName>evzijst</authorName>
<commitDate>2015-04-28T09:47:56.310+02:00</commitDate>
<commitType>Modified</commitType>
<fileType>File</fileType>
<fromContentUrl>/context/cru/CR-FOO-21/rawcontent/5698/dir68/d.txt</fromContentUrl>
<fromPath>dir68/d.txt</fromPath>
<fromRevision>69</fromRevision>
<repositoryName>REPO</repositoryName>
<showAsDiff>false</showAsDiff>
<toContentUrl>/context/cru/CR-FOO-21/rawcontent/6394/dir68/d.txt</toContentUrl>
<toPath>dir68/d.txt</toPath>
<toRevision>691</toRevision>
</reviewItem>
<reviewItem>
<participants>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Fred Eaglesmith</displayName>
<userName>fred</userName>
</user>
<completed>false</completed>
</participant>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Corb Lund</displayName>
<userName>clund</userName>
</user>
<completed>false</completed>
</participant>
</participants>
<permId>
<id>CFR-70</id>
</permId>
<authorName>evzijst</authorName>
<commitDate>2015-04-28T09:47:56.311+02:00</commitDate>
<commitType>Modified</commitType>
<fileType>File</fileType>
<fromContentUrl>/context/cru/CR-FOO-21/rawcontent/5700/dir69/e.txt</fromContentUrl>
<fromPath>dir69/e.txt</fromPath>
<fromRevision>70</fromRevision>
<repositoryName>REPO</repositoryName>
<showAsDiff>true</showAsDiff>
<toContentUrl>/context/cru/CR-FOO-21/rawcontent/6164/dir69/e.txt</toContentUrl>
<toPath>dir69/e.txt</toPath>
<toRevision>701</toRevision>
</reviewItem>
<reviewItem>
<participants>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Fred Eaglesmith</displayName>
<userName>fred</userName>
</user>
<completed>false</completed>
</participant>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Corb Lund</displayName>
<userName>clund</userName>
</user>
<completed>false</completed>
</participant>
</participants>
<permId>
<id>CFR-71</id>
</permId>
<authorName>evzijst</authorName>
<commitDate>2015-04-28T09:47:56.311+02:00</commitDate>
<commitType>Modified</commitType>
<fileType>File</fileType>
<fromContentUrl>/context/cru/CR-FOO-21/rawcontent/5702/dir70/f.txt</fromContentUrl>
<fromPath>dir70/f.txt</fromPath>
<fromRevision>71</fromRevision>
<repositoryName>REPO</repositoryName>
<showAsDiff>false</showAsDiff>
<toContentUrl>/context/cru/CR-FOO-21/rawcontent/6679/dir70/f.txt</toContentUrl>
<toPath>dir70/f.txt</toPath>
<toRevision>711</toRevision>
</reviewItem>
</reviewItems>
<transitions>
<transitionData>
<displayName>Summarize</displayName>
<name>action:summarizeReview</name>
</transitionData>
</transitions>
</detailedReviewData>
Reviews which are in a particular state. These reviews contains the details, such as the comments (and also the wiki rendered html), the review items and other information.
{
"projectKey" : "CR-FOO",
"name" : "Example review.",
"description" : "Description or statement of objectives for this example review.",
"author" : {
"userName" : "joe",
"displayName" : "Joe Krustofski",
"avatarUrl" : "http://foo.com/avatar"
},
"moderator" : {
"userName" : "scott",
"displayName" : "Scott the Moderator",
"avatarUrl" : "http://foo.com/avatar"
},
"creator" : {
"userName" : "joe",
"displayName" : "Joe Krustofski",
"avatarUrl" : "http://foo.com/avatar"
},
"permaId" : {
"id" : "CR-FOO-21"
},
"permaIdHistory" : [ "CR-FOO-21" ],
"type" : "REVIEW",
"allowReviewersToJoin" : true,
"metricsVersion" : 4,
"createDate" : "2015-04-28T09:47:56.272+0200",
"dueDate" : "2015-04-29T09:47:56.272+0200",
"jiraIssueKey" : "FOO-6754",
"reviewItems" : {
"reviewItem" : [ {
"permId" : {
"id" : "CFR-65"
},
"participants" : [ {
"user" : {
"userName" : "fred",
"displayName" : "Fred Eaglesmith",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
}, {
"user" : {
"userName" : "clund",
"displayName" : "Corb Lund",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
} ],
"repositoryName" : "REPO",
"fromPath" : "dir64/a.txt",
"fromRevision" : "65",
"fromContentUrl" : "/context/cru/CR-FOO-21/rawcontent/5687/dir64/a.txt",
"toPath" : "dir64/a.txt",
"toRevision" : "651",
"toContentUrl" : "/context/cru/CR-FOO-21/rawcontent/6675/dir64/a.txt",
"patchUrl" : "/contextcru/CR-FOO-21/downloadpatch/6238/patch-7126.patch",
"fileType" : "File",
"commitType" : "Modified",
"authorName" : "evzijst",
"showAsDiff" : false,
"anchorData" : {
"anchorPath" : "trunk",
"anchorRepository" : "REPO",
"stripCount" : 0
},
"commitDate" : 1430207276310,
"expandedRevisions" : [ ]
}, {
"permId" : {
"id" : "CFR-66"
},
"participants" : [ {
"user" : {
"userName" : "fred",
"displayName" : "Fred Eaglesmith",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
}, {
"user" : {
"userName" : "clund",
"displayName" : "Corb Lund",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
} ],
"repositoryName" : "REPO",
"fromPath" : "dir65/d.txt",
"fromRevision" : "66",
"fromContentUrl" : "/context/cru/CR-FOO-21/rawcontent/5690/dir65/d.txt",
"toPath" : "dir65/d.txt",
"toRevision" : "661",
"toContentUrl" : "/context/cru/CR-FOO-21/rawcontent/6085/dir65/d.txt",
"patchUrl" : "/contextcru/CR-FOO-21/downloadpatch/6273/patch-6173.patch",
"fileType" : "File",
"commitType" : "Modified",
"authorName" : "evzijst",
"showAsDiff" : true,
"anchorData" : {
"anchorPath" : "branches/branch1",
"anchorRepository" : "REPO",
"stripCount" : 0
},
"commitDate" : 1430207276310,
"expandedRevisions" : [ ]
}, {
"permId" : {
"id" : "CFR-67"
},
"participants" : [ {
"user" : {
"userName" : "fred",
"displayName" : "Fred Eaglesmith",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
}, {
"user" : {
"userName" : "clund",
"displayName" : "Corb Lund",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
} ],
"repositoryName" : "REPO",
"fromPath" : "dir66/c.txt",
"fromRevision" : "67",
"fromContentUrl" : "/context/cru/CR-FOO-21/rawcontent/5693/dir66/c.txt",
"toPath" : "dir66/c.txt",
"toRevision" : "671",
"toContentUrl" : "/context/cru/CR-FOO-21/rawcontent/5909/dir66/c.txt",
"patchUrl" : "/contextcru/CR-FOO-21/downloadpatch/6281/patch-9135.patch",
"fileType" : "File",
"commitType" : "Modified",
"authorName" : "evzijst",
"showAsDiff" : false,
"anchorData" : {
"anchorPath" : "branches/branch1",
"anchorRepository" : "REPO",
"stripCount" : 0
},
"commitDate" : 1430207276310,
"expandedRevisions" : [ ]
}, {
"permId" : {
"id" : "CFR-68"
},
"participants" : [ {
"user" : {
"userName" : "fred",
"displayName" : "Fred Eaglesmith",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
}, {
"user" : {
"userName" : "clund",
"displayName" : "Corb Lund",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
} ],
"repositoryName" : "REPO",
"fromPath" : "dir67/b.txt",
"fromRevision" : "68",
"fromContentUrl" : "/context/cru/CR-FOO-21/rawcontent/5696/dir67/b.txt",
"toPath" : "dir67/b.txt",
"toRevision" : "681",
"toContentUrl" : "/context/cru/CR-FOO-21/rawcontent/5789/dir67/b.txt",
"patchUrl" : "/contextcru/CR-FOO-21/downloadpatch/6394/patch-6062.patch",
"fileType" : "File",
"commitType" : "Modified",
"authorName" : "evzijst",
"showAsDiff" : true,
"anchorData" : {
"anchorPath" : "tags/tag1",
"anchorRepository" : "REPO",
"stripCount" : 0
},
"commitDate" : 1430207276310,
"expandedRevisions" : [ ]
}, {
"permId" : {
"id" : "CFR-69"
},
"participants" : [ {
"user" : {
"userName" : "fred",
"displayName" : "Fred Eaglesmith",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
}, {
"user" : {
"userName" : "clund",
"displayName" : "Corb Lund",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
} ],
"repositoryName" : "REPO",
"fromPath" : "dir68/d.txt",
"fromRevision" : "69",
"fromContentUrl" : "/context/cru/CR-FOO-21/rawcontent/5698/dir68/d.txt",
"toPath" : "dir68/d.txt",
"toRevision" : "691",
"toContentUrl" : "/context/cru/CR-FOO-21/rawcontent/6394/dir68/d.txt",
"fileType" : "File",
"commitType" : "Modified",
"authorName" : "evzijst",
"showAsDiff" : false,
"commitDate" : 1430207276310,
"expandedRevisions" : [ ]
}, {
"permId" : {
"id" : "CFR-70"
},
"participants" : [ {
"user" : {
"userName" : "fred",
"displayName" : "Fred Eaglesmith",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
}, {
"user" : {
"userName" : "clund",
"displayName" : "Corb Lund",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
} ],
"repositoryName" : "REPO",
"fromPath" : "dir69/e.txt",
"fromRevision" : "70",
"fromContentUrl" : "/context/cru/CR-FOO-21/rawcontent/5700/dir69/e.txt",
"toPath" : "dir69/e.txt",
"toRevision" : "701",
"toContentUrl" : "/context/cru/CR-FOO-21/rawcontent/6164/dir69/e.txt",
"fileType" : "File",
"commitType" : "Modified",
"authorName" : "evzijst",
"showAsDiff" : true,
"commitDate" : 1430207276311,
"expandedRevisions" : [ ]
}, {
"permId" : {
"id" : "CFR-71"
},
"participants" : [ {
"user" : {
"userName" : "fred",
"displayName" : "Fred Eaglesmith",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
}, {
"user" : {
"userName" : "clund",
"displayName" : "Corb Lund",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
} ],
"repositoryName" : "REPO",
"fromPath" : "dir70/f.txt",
"fromRevision" : "71",
"fromContentUrl" : "/context/cru/CR-FOO-21/rawcontent/5702/dir70/f.txt",
"toPath" : "dir70/f.txt",
"toRevision" : "711",
"toContentUrl" : "/context/cru/CR-FOO-21/rawcontent/6679/dir70/f.txt",
"fileType" : "File",
"commitType" : "Modified",
"authorName" : "evzijst",
"showAsDiff" : false,
"commitDate" : 1430207276311,
"expandedRevisions" : [ ]
} ]
},
"generalComments" : {
"comments" : [ {
"metrics" : {
},
"message" : "I thought you said you were going to *remove* this line?",
"draft" : false,
"deleted" : false,
"defectRaised" : false,
"defectApproved" : false,
"readStatus" : "UNREAD",
"user" : {
"userName" : "joe",
"displayName" : "Joe Bloggs",
"avatarUrl" : "http://foo.com/avatar"
},
"createDate" : "2015-04-28T09:47:56.281+0200",
"permaId" : {
"id" : "CR:1"
},
"replies" : [ ],
"messageAsHtml" : "I thought you said you were going to <b>remove</b> this line?",
"permId" : {
"id" : "CR:1"
},
"parentCommentId" : {
}
} ]
},
"transitions" : {
"transitionData" : [ {
"name" : "action:summarizeReview",
"displayName" : "Summarize"
} ]
},
"actions" : {
"actionData" : [ {
"name" : "action:abandonReview",
"displayName" : "Abandon"
}, {
"name" : "action:approveReview",
"displayName" : "Approve"
}, {
"name" : "action:commentOnReview",
"displayName" : "Comment"
}, {
"name" : "action:completeReview",
"displayName" : "Complete"
}, {
"name" : "action:modifyReviewFiles",
"displayName" : "Edit Review Details"
} ]
}
}Reviews which are in a particular state. These reviews contains the details, such as the comments (and also the wiki rendered html), the review items and other information.
| parameter | value | description |
|---|---|---|
|
filter |
a predefined filter type. Available filter names are:
|
Get all the reviews which match the given filter, for the current user.
available response representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<reviews>
<reviewData>
<allowReviewersToJoin>true</allowReviewersToJoin>
<author>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Joe Krustofski</displayName>
<userName>joe</userName>
</author>
<createDate>2015-04-28T09:47:56.272+0200</createDate>
<creator>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Joe Krustofski</displayName>
<userName>joe</userName>
</creator>
<description>Description or statement of objectives for this example review.</description>
<dueDate>2015-04-29T09:47:56.272+0200</dueDate>
<jiraIssueKey>FOO-6754</jiraIssueKey>
<metricsVersion>4</metricsVersion>
<moderator>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Scott the Moderator</displayName>
<userName>scott</userName>
</moderator>
<name>Example review.</name>
<permaId>
<id>CR-FOO-21</id>
</permaId>
<permaIdHistory>CR-FOO-21</permaIdHistory>
<projectKey>CR-FOO</projectKey>
<type>REVIEW</type>
</reviewData>
<reviewData>
<allowReviewersToJoin>true</allowReviewersToJoin>
<author>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Joe Krustofski</displayName>
<userName>joe</userName>
</author>
<createDate>2015-04-28T09:47:56.272+0200</createDate>
<creator>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Joe Krustofski</displayName>
<userName>joe</userName>
</creator>
<description>Description or statement of objectives for this example review.</description>
<dueDate>2015-04-29T09:47:56.272+0200</dueDate>
<jiraIssueKey>FOO-6754</jiraIssueKey>
<metricsVersion>4</metricsVersion>
<moderator>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Scott the Moderator</displayName>
<userName>scott</userName>
</moderator>
<name>Example review.</name>
<permaId>
<id>CR-FOO-21</id>
</permaId>
<permaIdHistory>CR-FOO-21</permaIdHistory>
<projectKey>CR-FOO</projectKey>
<type>REVIEW</type>
</reviewData>
</reviews>
The list of reviews that match the specified pre-defined filter. Does not contain the review details (such as comments, review items etc).
{
"reviewData" : [ {
"projectKey" : "CR-FOO",
"name" : "Example review.",
"description" : "Description or statement of objectives for this example review.",
"author" : {
"userName" : "joe",
"displayName" : "Joe Krustofski",
"avatarUrl" : "http://foo.com/avatar"
},
"moderator" : {
"userName" : "scott",
"displayName" : "Scott the Moderator",
"avatarUrl" : "http://foo.com/avatar"
},
"creator" : {
"userName" : "joe",
"displayName" : "Joe Krustofski",
"avatarUrl" : "http://foo.com/avatar"
},
"permaId" : {
"id" : "CR-FOO-21"
},
"permaIdHistory" : [ "CR-FOO-21" ],
"type" : "REVIEW",
"allowReviewersToJoin" : true,
"metricsVersion" : 4,
"createDate" : "2015-04-28T09:47:56.272+0200",
"dueDate" : "2015-04-29T09:47:56.272+0200",
"jiraIssueKey" : "FOO-6754"
}, {
"projectKey" : "CR-FOO",
"name" : "Example review.",
"description" : "Description or statement of objectives for this example review.",
"author" : {
"userName" : "joe",
"displayName" : "Joe Krustofski",
"avatarUrl" : "http://foo.com/avatar"
},
"moderator" : {
"userName" : "scott",
"displayName" : "Scott the Moderator",
"avatarUrl" : "http://foo.com/avatar"
},
"creator" : {
"userName" : "joe",
"displayName" : "Joe Krustofski",
"avatarUrl" : "http://foo.com/avatar"
},
"permaId" : {
"id" : "CR-FOO-21"
},
"permaIdHistory" : [ "CR-FOO-21" ],
"type" : "REVIEW",
"allowReviewersToJoin" : true,
"metricsVersion" : 4,
"createDate" : "2015-04-28T09:47:56.272+0200",
"dueDate" : "2015-04-29T09:47:56.272+0200",
"jiraIssueKey" : "FOO-6754"
} ]
}The list of reviews that match the specified pre-defined filter. Does not contain the review details (such as comments, review items etc).
| parameter | value | description |
|---|---|---|
|
filter |
a predefined filter type. Available filter names are:
|
Gets a list of all the reviews that match the specified filter criteria.
For each review all details are included (review items + comments).
available response representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<detailedReviews>
<detailedReviewData>
<allowReviewersToJoin>true</allowReviewersToJoin>
<author>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Joe Krustofski</displayName>
<userName>joe</userName>
</author>
<createDate>2015-04-28T09:47:56.272+0200</createDate>
<creator>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Joe Krustofski</displayName>
<userName>joe</userName>
</creator>
<description>Description or statement of objectives for this example review.</description>
<dueDate>2015-04-29T09:47:56.272+0200</dueDate>
<jiraIssueKey>FOO-6754</jiraIssueKey>
<metricsVersion>4</metricsVersion>
<moderator>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Scott the Moderator</displayName>
<userName>scott</userName>
</moderator>
<name>Example review.</name>
<permaId>
<id>CR-FOO-21</id>
</permaId>
<permaIdHistory>CR-FOO-21</permaIdHistory>
<projectKey>CR-FOO</projectKey>
<type>REVIEW</type>
<actions>
<actionData>
<displayName>Abandon</displayName>
<name>action:abandonReview</name>
</actionData>
<actionData>
<displayName>Approve</displayName>
<name>action:approveReview</name>
</actionData>
<actionData>
<displayName>Comment</displayName>
<name>action:commentOnReview</name>
</actionData>
<actionData>
<displayName>Complete</displayName>
<name>action:completeReview</name>
</actionData>
<actionData>
<displayName>Edit Review Details</displayName>
<name>action:modifyReviewFiles</name>
</actionData>
</actions>
<generalComments>
<generalCommentData>
<createDate>2015-04-28T09:47:56.281+0200</createDate>
<defectApproved>false</defectApproved>
<defectRaised>false</defectRaised>
<deleted>false</deleted>
<draft>false</draft>
<message>I thought you said you were going to *remove* this line?</message>
<messageAsHtml>I thought you said you were going to <b>remove</b> this line?</messageAsHtml>
<metrics/>
<parentCommentId/>
<readStatus>UNREAD</readStatus>
<replies/>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Joe Bloggs</displayName>
<userName>joe</userName>
</user>
<permId>
<id>CR:1</id>
</permId>
<permaId>
<id>CR:1</id>
</permaId>
</generalCommentData>
</generalComments>
<reviewItems>
<reviewItem>
<participants>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Fred Eaglesmith</displayName>
<userName>fred</userName>
</user>
<completed>false</completed>
</participant>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Corb Lund</displayName>
<userName>clund</userName>
</user>
<completed>false</completed>
</participant>
</participants>
<permId>
<id>CFR-65</id>
</permId>
<anchorData>
<anchorPath>trunk</anchorPath>
<anchorRepository>REPO</anchorRepository>
<stripCount>0</stripCount>
</anchorData>
<authorName>evzijst</authorName>
<commitDate>2015-04-28T09:47:56.310+02:00</commitDate>
<commitType>Modified</commitType>
<fileType>File</fileType>
<fromContentUrl>/context/cru/CR-FOO-21/rawcontent/5687/dir64/a.txt</fromContentUrl>
<fromPath>dir64/a.txt</fromPath>
<fromRevision>65</fromRevision>
<patchUrl>/contextcru/CR-FOO-21/downloadpatch/6238/patch-7126.patch</patchUrl>
<repositoryName>REPO</repositoryName>
<showAsDiff>false</showAsDiff>
<toContentUrl>/context/cru/CR-FOO-21/rawcontent/6675/dir64/a.txt</toContentUrl>
<toPath>dir64/a.txt</toPath>
<toRevision>651</toRevision>
</reviewItem>
<reviewItem>
<participants>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Fred Eaglesmith</displayName>
<userName>fred</userName>
</user>
<completed>false</completed>
</participant>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Corb Lund</displayName>
<userName>clund</userName>
</user>
<completed>false</completed>
</participant>
</participants>
<permId>
<id>CFR-66</id>
</permId>
<anchorData>
<anchorPath>branches/branch1</anchorPath>
<anchorRepository>REPO</anchorRepository>
<stripCount>0</stripCount>
</anchorData>
<authorName>evzijst</authorName>
<commitDate>2015-04-28T09:47:56.310+02:00</commitDate>
<commitType>Modified</commitType>
<fileType>File</fileType>
<fromContentUrl>/context/cru/CR-FOO-21/rawcontent/5690/dir65/d.txt</fromContentUrl>
<fromPath>dir65/d.txt</fromPath>
<fromRevision>66</fromRevision>
<patchUrl>/contextcru/CR-FOO-21/downloadpatch/6273/patch-6173.patch</patchUrl>
<repositoryName>REPO</repositoryName>
<showAsDiff>true</showAsDiff>
<toContentUrl>/context/cru/CR-FOO-21/rawcontent/6085/dir65/d.txt</toContentUrl>
<toPath>dir65/d.txt</toPath>
<toRevision>661</toRevision>
</reviewItem>
<reviewItem>
<participants>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Fred Eaglesmith</displayName>
<userName>fred</userName>
</user>
<completed>false</completed>
</participant>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Corb Lund</displayName>
<userName>clund</userName>
</user>
<completed>false</completed>
</participant>
</participants>
<permId>
<id>CFR-67</id>
</permId>
<anchorData>
<anchorPath>branches/branch1</anchorPath>
<anchorRepository>REPO</anchorRepository>
<stripCount>0</stripCount>
</anchorData>
<authorName>evzijst</authorName>
<commitDate>2015-04-28T09:47:56.310+02:00</commitDate>
<commitType>Modified</commitType>
<fileType>File</fileType>
<fromContentUrl>/context/cru/CR-FOO-21/rawcontent/5693/dir66/c.txt</fromContentUrl>
<fromPath>dir66/c.txt</fromPath>
<fromRevision>67</fromRevision>
<patchUrl>/contextcru/CR-FOO-21/downloadpatch/6281/patch-9135.patch</patchUrl>
<repositoryName>REPO</repositoryName>
<showAsDiff>false</showAsDiff>
<toContentUrl>/context/cru/CR-FOO-21/rawcontent/5909/dir66/c.txt</toContentUrl>
<toPath>dir66/c.txt</toPath>
<toRevision>671</toRevision>
</reviewItem>
<reviewItem>
<participants>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Fred Eaglesmith</displayName>
<userName>fred</userName>
</user>
<completed>false</completed>
</participant>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Corb Lund</displayName>
<userName>clund</userName>
</user>
<completed>false</completed>
</participant>
</participants>
<permId>
<id>CFR-68</id>
</permId>
<anchorData>
<anchorPath>tags/tag1</anchorPath>
<anchorRepository>REPO</anchorRepository>
<stripCount>0</stripCount>
</anchorData>
<authorName>evzijst</authorName>
<commitDate>2015-04-28T09:47:56.310+02:00</commitDate>
<commitType>Modified</commitType>
<fileType>File</fileType>
<fromContentUrl>/context/cru/CR-FOO-21/rawcontent/5696/dir67/b.txt</fromContentUrl>
<fromPath>dir67/b.txt</fromPath>
<fromRevision>68</fromRevision>
<patchUrl>/contextcru/CR-FOO-21/downloadpatch/6394/patch-6062.patch</patchUrl>
<repositoryName>REPO</repositoryName>
<showAsDiff>true</showAsDiff>
<toContentUrl>/context/cru/CR-FOO-21/rawcontent/5789/dir67/b.txt</toContentUrl>
<toPath>dir67/b.txt</toPath>
<toRevision>681</toRevision>
</reviewItem>
<reviewItem>
<participants>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Fred Eaglesmith</displayName>
<userName>fred</userName>
</user>
<completed>false</completed>
</participant>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Corb Lund</displayName>
<userName>clund</userName>
</user>
<completed>false</completed>
</participant>
</participants>
<permId>
<id>CFR-69</id>
</permId>
<authorName>evzijst</authorName>
<commitDate>2015-04-28T09:47:56.310+02:00</commitDate>
<commitType>Modified</commitType>
<fileType>File</fileType>
<fromContentUrl>/context/cru/CR-FOO-21/rawcontent/5698/dir68/d.txt</fromContentUrl>
<fromPath>dir68/d.txt</fromPath>
<fromRevision>69</fromRevision>
<repositoryName>REPO</repositoryName>
<showAsDiff>false</showAsDiff>
<toContentUrl>/context/cru/CR-FOO-21/rawcontent/6394/dir68/d.txt</toContentUrl>
<toPath>dir68/d.txt</toPath>
<toRevision>691</toRevision>
</reviewItem>
<reviewItem>
<participants>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Fred Eaglesmith</displayName>
<userName>fred</userName>
</user>
<completed>false</completed>
</participant>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Corb Lund</displayName>
<userName>clund</userName>
</user>
<completed>false</completed>
</participant>
</participants>
<permId>
<id>CFR-70</id>
</permId>
<authorName>evzijst</authorName>
<commitDate>2015-04-28T09:47:56.311+02:00</commitDate>
<commitType>Modified</commitType>
<fileType>File</fileType>
<fromContentUrl>/context/cru/CR-FOO-21/rawcontent/5700/dir69/e.txt</fromContentUrl>
<fromPath>dir69/e.txt</fromPath>
<fromRevision>70</fromRevision>
<repositoryName>REPO</repositoryName>
<showAsDiff>true</showAsDiff>
<toContentUrl>/context/cru/CR-FOO-21/rawcontent/6164/dir69/e.txt</toContentUrl>
<toPath>dir69/e.txt</toPath>
<toRevision>701</toRevision>
</reviewItem>
<reviewItem>
<participants>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Fred Eaglesmith</displayName>
<userName>fred</userName>
</user>
<completed>false</completed>
</participant>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Corb Lund</displayName>
<userName>clund</userName>
</user>
<completed>false</completed>
</participant>
</participants>
<permId>
<id>CFR-71</id>
</permId>
<authorName>evzijst</authorName>
<commitDate>2015-04-28T09:47:56.311+02:00</commitDate>
<commitType>Modified</commitType>
<fileType>File</fileType>
<fromContentUrl>/context/cru/CR-FOO-21/rawcontent/5702/dir70/f.txt</fromContentUrl>
<fromPath>dir70/f.txt</fromPath>
<fromRevision>71</fromRevision>
<repositoryName>REPO</repositoryName>
<showAsDiff>false</showAsDiff>
<toContentUrl>/context/cru/CR-FOO-21/rawcontent/6679/dir70/f.txt</toContentUrl>
<toPath>dir70/f.txt</toPath>
<toRevision>711</toRevision>
</reviewItem>
</reviewItems>
<transitions>
<transitionData>
<displayName>Summarize</displayName>
<name>action:summarizeReview</name>
</transitionData>
</transitions>
</detailedReviewData>
</detailedReviews>
The detailed list of reviews that match the specified pre-defined filter, with the details of the review, such as comments (and its wiki rendered html), and review items.
{
"detailedReviewData" : [ {
"projectKey" : "CR-FOO",
"name" : "Example review.",
"description" : "Description or statement of objectives for this example review.",
"author" : {
"userName" : "joe",
"displayName" : "Joe Krustofski",
"avatarUrl" : "http://foo.com/avatar"
},
"moderator" : {
"userName" : "scott",
"displayName" : "Scott the Moderator",
"avatarUrl" : "http://foo.com/avatar"
},
"creator" : {
"userName" : "joe",
"displayName" : "Joe Krustofski",
"avatarUrl" : "http://foo.com/avatar"
},
"permaId" : {
"id" : "CR-FOO-21"
},
"permaIdHistory" : [ "CR-FOO-21" ],
"type" : "REVIEW",
"allowReviewersToJoin" : true,
"metricsVersion" : 4,
"createDate" : "2015-04-28T09:47:56.272+0200",
"dueDate" : "2015-04-29T09:47:56.272+0200",
"jiraIssueKey" : "FOO-6754",
"reviewItems" : {
"reviewItem" : [ {
"permId" : {
"id" : "CFR-65"
},
"participants" : [ {
"user" : {
"userName" : "fred",
"displayName" : "Fred Eaglesmith",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
}, {
"user" : {
"userName" : "clund",
"displayName" : "Corb Lund",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
} ],
"repositoryName" : "REPO",
"fromPath" : "dir64/a.txt",
"fromRevision" : "65",
"fromContentUrl" : "/context/cru/CR-FOO-21/rawcontent/5687/dir64/a.txt",
"toPath" : "dir64/a.txt",
"toRevision" : "651",
"toContentUrl" : "/context/cru/CR-FOO-21/rawcontent/6675/dir64/a.txt",
"patchUrl" : "/contextcru/CR-FOO-21/downloadpatch/6238/patch-7126.patch",
"fileType" : "File",
"commitType" : "Modified",
"authorName" : "evzijst",
"showAsDiff" : false,
"anchorData" : {
"anchorPath" : "trunk",
"anchorRepository" : "REPO",
"stripCount" : 0
},
"commitDate" : 1430207276310,
"expandedRevisions" : [ ]
}, {
"permId" : {
"id" : "CFR-66"
},
"participants" : [ {
"user" : {
"userName" : "fred",
"displayName" : "Fred Eaglesmith",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
}, {
"user" : {
"userName" : "clund",
"displayName" : "Corb Lund",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
} ],
"repositoryName" : "REPO",
"fromPath" : "dir65/d.txt",
"fromRevision" : "66",
"fromContentUrl" : "/context/cru/CR-FOO-21/rawcontent/5690/dir65/d.txt",
"toPath" : "dir65/d.txt",
"toRevision" : "661",
"toContentUrl" : "/context/cru/CR-FOO-21/rawcontent/6085/dir65/d.txt",
"patchUrl" : "/contextcru/CR-FOO-21/downloadpatch/6273/patch-6173.patch",
"fileType" : "File",
"commitType" : "Modified",
"authorName" : "evzijst",
"showAsDiff" : true,
"anchorData" : {
"anchorPath" : "branches/branch1",
"anchorRepository" : "REPO",
"stripCount" : 0
},
"commitDate" : 1430207276310,
"expandedRevisions" : [ ]
}, {
"permId" : {
"id" : "CFR-67"
},
"participants" : [ {
"user" : {
"userName" : "fred",
"displayName" : "Fred Eaglesmith",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
}, {
"user" : {
"userName" : "clund",
"displayName" : "Corb Lund",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
} ],
"repositoryName" : "REPO",
"fromPath" : "dir66/c.txt",
"fromRevision" : "67",
"fromContentUrl" : "/context/cru/CR-FOO-21/rawcontent/5693/dir66/c.txt",
"toPath" : "dir66/c.txt",
"toRevision" : "671",
"toContentUrl" : "/context/cru/CR-FOO-21/rawcontent/5909/dir66/c.txt",
"patchUrl" : "/contextcru/CR-FOO-21/downloadpatch/6281/patch-9135.patch",
"fileType" : "File",
"commitType" : "Modified",
"authorName" : "evzijst",
"showAsDiff" : false,
"anchorData" : {
"anchorPath" : "branches/branch1",
"anchorRepository" : "REPO",
"stripCount" : 0
},
"commitDate" : 1430207276310,
"expandedRevisions" : [ ]
}, {
"permId" : {
"id" : "CFR-68"
},
"participants" : [ {
"user" : {
"userName" : "fred",
"displayName" : "Fred Eaglesmith",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
}, {
"user" : {
"userName" : "clund",
"displayName" : "Corb Lund",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
} ],
"repositoryName" : "REPO",
"fromPath" : "dir67/b.txt",
"fromRevision" : "68",
"fromContentUrl" : "/context/cru/CR-FOO-21/rawcontent/5696/dir67/b.txt",
"toPath" : "dir67/b.txt",
"toRevision" : "681",
"toContentUrl" : "/context/cru/CR-FOO-21/rawcontent/5789/dir67/b.txt",
"patchUrl" : "/contextcru/CR-FOO-21/downloadpatch/6394/patch-6062.patch",
"fileType" : "File",
"commitType" : "Modified",
"authorName" : "evzijst",
"showAsDiff" : true,
"anchorData" : {
"anchorPath" : "tags/tag1",
"anchorRepository" : "REPO",
"stripCount" : 0
},
"commitDate" : 1430207276310,
"expandedRevisions" : [ ]
}, {
"permId" : {
"id" : "CFR-69"
},
"participants" : [ {
"user" : {
"userName" : "fred",
"displayName" : "Fred Eaglesmith",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
}, {
"user" : {
"userName" : "clund",
"displayName" : "Corb Lund",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
} ],
"repositoryName" : "REPO",
"fromPath" : "dir68/d.txt",
"fromRevision" : "69",
"fromContentUrl" : "/context/cru/CR-FOO-21/rawcontent/5698/dir68/d.txt",
"toPath" : "dir68/d.txt",
"toRevision" : "691",
"toContentUrl" : "/context/cru/CR-FOO-21/rawcontent/6394/dir68/d.txt",
"fileType" : "File",
"commitType" : "Modified",
"authorName" : "evzijst",
"showAsDiff" : false,
"commitDate" : 1430207276310,
"expandedRevisions" : [ ]
}, {
"permId" : {
"id" : "CFR-70"
},
"participants" : [ {
"user" : {
"userName" : "fred",
"displayName" : "Fred Eaglesmith",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
}, {
"user" : {
"userName" : "clund",
"displayName" : "Corb Lund",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
} ],
"repositoryName" : "REPO",
"fromPath" : "dir69/e.txt",
"fromRevision" : "70",
"fromContentUrl" : "/context/cru/CR-FOO-21/rawcontent/5700/dir69/e.txt",
"toPath" : "dir69/e.txt",
"toRevision" : "701",
"toContentUrl" : "/context/cru/CR-FOO-21/rawcontent/6164/dir69/e.txt",
"fileType" : "File",
"commitType" : "Modified",
"authorName" : "evzijst",
"showAsDiff" : true,
"commitDate" : 1430207276311,
"expandedRevisions" : [ ]
}, {
"permId" : {
"id" : "CFR-71"
},
"participants" : [ {
"user" : {
"userName" : "fred",
"displayName" : "Fred Eaglesmith",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
}, {
"user" : {
"userName" : "clund",
"displayName" : "Corb Lund",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
} ],
"repositoryName" : "REPO",
"fromPath" : "dir70/f.txt",
"fromRevision" : "71",
"fromContentUrl" : "/context/cru/CR-FOO-21/rawcontent/5702/dir70/f.txt",
"toPath" : "dir70/f.txt",
"toRevision" : "711",
"toContentUrl" : "/context/cru/CR-FOO-21/rawcontent/6679/dir70/f.txt",
"fileType" : "File",
"commitType" : "Modified",
"authorName" : "evzijst",
"showAsDiff" : false,
"commitDate" : 1430207276311,
"expandedRevisions" : [ ]
} ]
},
"generalComments" : {
"comments" : [ {
"metrics" : {
},
"message" : "I thought you said you were going to *remove* this line?",
"draft" : false,
"deleted" : false,
"defectRaised" : false,
"defectApproved" : false,
"readStatus" : "UNREAD",
"user" : {
"userName" : "joe",
"displayName" : "Joe Bloggs",
"avatarUrl" : "http://foo.com/avatar"
},
"createDate" : "2015-04-28T09:47:56.281+0200",
"permaId" : {
"id" : "CR:1"
},
"replies" : [ ],
"messageAsHtml" : "I thought you said you were going to <b>remove</b> this line?",
"permId" : {
"id" : "CR:1"
},
"parentCommentId" : {
}
} ]
},
"transitions" : {
"transitionData" : [ {
"name" : "action:summarizeReview",
"displayName" : "Summarize"
} ]
},
"actions" : {
"actionData" : [ {
"name" : "action:abandonReview",
"displayName" : "Abandon"
}, {
"name" : "action:approveReview",
"displayName" : "Approve"
}, {
"name" : "action:commentOnReview",
"displayName" : "Comment"
}, {
"name" : "action:completeReview",
"displayName" : "Complete"
}, {
"name" : "action:modifyReviewFiles",
"displayName" : "Edit Review Details"
} ]
}
} ]
}The detailed list of reviews that match the specified pre-defined filter, with the details of the review, such as comments (and its wiki rendered html), and review items.
Returns all reviews that satisfy the specified filter parameters and are accessible under the provided credentials.
To ignore a property, omit it from the query string.| parameter | value | description |
|---|---|---|
|
title |
a string that will be searched for in review titles. |
|
|
author |
reviews authored by this user. |
|
|
moderator |
reviews moderated by this user. |
|
|
creator |
reviews created by this user. |
|
|
states |
comma-separated list of amy of the following strings: (Draft, Approval, Review, Summarize, Closed, Dead, Rejected, Unknown). |
|
|
reviewer |
reviews reviewed by this user. |
|
|
orRoles |
whether the value of |
|
|
complete |
reviews that the specified reviewer has completed. |
|
|
allReviewersComplete |
Reviews that all reviewers have completed. |
|
|
project |
reviews for the specified project. |
|
|
fromDate |
reviews with last activity date after the specified timestamp, in milliseconds. Inclusive. |
|
|
toDate |
reviews with last activity date before the specified timestamp, in milliseconds. Inclusive. |
available response representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<reviews>
<reviewData>
<allowReviewersToJoin>true</allowReviewersToJoin>
<author>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Joe Krustofski</displayName>
<userName>joe</userName>
</author>
<createDate>2015-04-28T09:47:56.272+0200</createDate>
<creator>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Joe Krustofski</displayName>
<userName>joe</userName>
</creator>
<description>Description or statement of objectives for this example review.</description>
<dueDate>2015-04-29T09:47:56.272+0200</dueDate>
<jiraIssueKey>FOO-6754</jiraIssueKey>
<metricsVersion>4</metricsVersion>
<moderator>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Scott the Moderator</displayName>
<userName>scott</userName>
</moderator>
<name>Example review.</name>
<permaId>
<id>CR-FOO-21</id>
</permaId>
<permaIdHistory>CR-FOO-21</permaIdHistory>
<projectKey>CR-FOO</projectKey>
<type>REVIEW</type>
</reviewData>
<reviewData>
<allowReviewersToJoin>true</allowReviewersToJoin>
<author>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Joe Krustofski</displayName>
<userName>joe</userName>
</author>
<createDate>2015-04-28T09:47:56.272+0200</createDate>
<creator>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Joe Krustofski</displayName>
<userName>joe</userName>
</creator>
<description>Description or statement of objectives for this example review.</description>
<dueDate>2015-04-29T09:47:56.272+0200</dueDate>
<jiraIssueKey>FOO-6754</jiraIssueKey>
<metricsVersion>4</metricsVersion>
<moderator>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Scott the Moderator</displayName>
<userName>scott</userName>
</moderator>
<name>Example review.</name>
<permaId>
<id>CR-FOO-21</id>
</permaId>
<permaIdHistory>CR-FOO-21</permaIdHistory>
<projectKey>CR-FOO</projectKey>
<type>REVIEW</type>
</reviewData>
</reviews>
A set of reviews that matches the filter. Does not contain the review's details.
{
"reviewData" : [ {
"projectKey" : "CR-FOO",
"name" : "Example review.",
"description" : "Description or statement of objectives for this example review.",
"author" : {
"userName" : "joe",
"displayName" : "Joe Krustofski",
"avatarUrl" : "http://foo.com/avatar"
},
"moderator" : {
"userName" : "scott",
"displayName" : "Scott the Moderator",
"avatarUrl" : "http://foo.com/avatar"
},
"creator" : {
"userName" : "joe",
"displayName" : "Joe Krustofski",
"avatarUrl" : "http://foo.com/avatar"
},
"permaId" : {
"id" : "CR-FOO-21"
},
"permaIdHistory" : [ "CR-FOO-21" ],
"type" : "REVIEW",
"allowReviewersToJoin" : true,
"metricsVersion" : 4,
"createDate" : "2015-04-28T09:47:56.272+0200",
"dueDate" : "2015-04-29T09:47:56.272+0200",
"jiraIssueKey" : "FOO-6754"
}, {
"projectKey" : "CR-FOO",
"name" : "Example review.",
"description" : "Description or statement of objectives for this example review.",
"author" : {
"userName" : "joe",
"displayName" : "Joe Krustofski",
"avatarUrl" : "http://foo.com/avatar"
},
"moderator" : {
"userName" : "scott",
"displayName" : "Scott the Moderator",
"avatarUrl" : "http://foo.com/avatar"
},
"creator" : {
"userName" : "joe",
"displayName" : "Joe Krustofski",
"avatarUrl" : "http://foo.com/avatar"
},
"permaId" : {
"id" : "CR-FOO-21"
},
"permaIdHistory" : [ "CR-FOO-21" ],
"type" : "REVIEW",
"allowReviewersToJoin" : true,
"metricsVersion" : 4,
"createDate" : "2015-04-28T09:47:56.272+0200",
"dueDate" : "2015-04-29T09:47:56.272+0200",
"jiraIssueKey" : "FOO-6754"
} ]
}A set of reviews that matches the filter. Does not contain the review's details.
This method should no longer be used, as it uses a POST for a read-only retrieval operation and is provided for backward compatibility only.
Do a GET instead.
acceptable request representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<customFilterData>
<fromDate>0</fromDate>
<orRoles>false</orRoles>
<project>Project 1</project>
<title>title of the review</title>
<toDate>0</toDate>
</customFilterData>
A custom filter definition.
{
"title" : "title of the review",
"orRoles" : false,
"project" : "Project 1",
"fromDate" : 0,
"toDate" : 0
}A custom filter definition.
available response representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<reviews>
<reviewData>
<allowReviewersToJoin>true</allowReviewersToJoin>
<author>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Joe Krustofski</displayName>
<userName>joe</userName>
</author>
<createDate>2015-04-28T09:47:56.272+0200</createDate>
<creator>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Joe Krustofski</displayName>
<userName>joe</userName>
</creator>
<description>Description or statement of objectives for this example review.</description>
<dueDate>2015-04-29T09:47:56.272+0200</dueDate>
<jiraIssueKey>FOO-6754</jiraIssueKey>
<metricsVersion>4</metricsVersion>
<moderator>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Scott the Moderator</displayName>
<userName>scott</userName>
</moderator>
<name>Example review.</name>
<permaId>
<id>CR-FOO-21</id>
</permaId>
<permaIdHistory>CR-FOO-21</permaIdHistory>
<projectKey>CR-FOO</projectKey>
<type>REVIEW</type>
</reviewData>
<reviewData>
<allowReviewersToJoin>true</allowReviewersToJoin>
<author>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Joe Krustofski</displayName>
<userName>joe</userName>
</author>
<createDate>2015-04-28T09:47:56.272+0200</createDate>
<creator>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Joe Krustofski</displayName>
<userName>joe</userName>
</creator>
<description>Description or statement of objectives for this example review.</description>
<dueDate>2015-04-29T09:47:56.272+0200</dueDate>
<jiraIssueKey>FOO-6754</jiraIssueKey>
<metricsVersion>4</metricsVersion>
<moderator>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Scott the Moderator</displayName>
<userName>scott</userName>
</moderator>
<name>Example review.</name>
<permaId>
<id>CR-FOO-21</id>
</permaId>
<permaIdHistory>CR-FOO-21</permaIdHistory>
<projectKey>CR-FOO</projectKey>
<type>REVIEW</type>
</reviewData>
</reviews>
The list of reviews that match the filter criteria.
{
"reviewData" : [ {
"projectKey" : "CR-FOO",
"name" : "Example review.",
"description" : "Description or statement of objectives for this example review.",
"author" : {
"userName" : "joe",
"displayName" : "Joe Krustofski",
"avatarUrl" : "http://foo.com/avatar"
},
"moderator" : {
"userName" : "scott",
"displayName" : "Scott the Moderator",
"avatarUrl" : "http://foo.com/avatar"
},
"creator" : {
"userName" : "joe",
"displayName" : "Joe Krustofski",
"avatarUrl" : "http://foo.com/avatar"
},
"permaId" : {
"id" : "CR-FOO-21"
},
"permaIdHistory" : [ "CR-FOO-21" ],
"type" : "REVIEW",
"allowReviewersToJoin" : true,
"metricsVersion" : 4,
"createDate" : "2015-04-28T09:47:56.272+0200",
"dueDate" : "2015-04-29T09:47:56.272+0200",
"jiraIssueKey" : "FOO-6754"
}, {
"projectKey" : "CR-FOO",
"name" : "Example review.",
"description" : "Description or statement of objectives for this example review.",
"author" : {
"userName" : "joe",
"displayName" : "Joe Krustofski",
"avatarUrl" : "http://foo.com/avatar"
},
"moderator" : {
"userName" : "scott",
"displayName" : "Scott the Moderator",
"avatarUrl" : "http://foo.com/avatar"
},
"creator" : {
"userName" : "joe",
"displayName" : "Joe Krustofski",
"avatarUrl" : "http://foo.com/avatar"
},
"permaId" : {
"id" : "CR-FOO-21"
},
"permaIdHistory" : [ "CR-FOO-21" ],
"type" : "REVIEW",
"allowReviewersToJoin" : true,
"metricsVersion" : 4,
"createDate" : "2015-04-28T09:47:56.272+0200",
"dueDate" : "2015-04-29T09:47:56.272+0200",
"jiraIssueKey" : "FOO-6754"
} ]
}The list of reviews that match the filter criteria.
Returns all (detailed) information of all reviews that satisfy the specified filter parameters and are accessible under the provided credentials.
To ignore a property, omit it from the query string.| parameter | value | description |
|---|---|---|
|
title |
a string that will be searched for in review titles. |
|
|
author |
reviews authored by this user. |
|
|
moderator |
reviews moderated by this user. |
|
|
creator |
reviews created by this user. |
|
|
states |
comma-separated list of amy of the following strings: (Draft, Approval, Review, Summarize, Closed, Dead, Rejected, Unknown). |
|
|
reviewer |
reviews reviewed by this user. |
|
|
orRoles |
whether the value of |
|
|
complete |
reviews that the specified reviewer has completed. |
|
|
allReviewersComplete |
Reviews that all reviewers have completed. |
|
|
project |
reviews for the specified project. |
|
|
fromDate |
reviews with last activity date after the specified timestamp, in milliseconds. Inclusive. |
|
|
toDate |
reviews with last activity date before the specified timestamp, in milliseconds. Inclusive. |
available response representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<detailedReviews>
<detailedReviewData>
<allowReviewersToJoin>true</allowReviewersToJoin>
<author>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Joe Krustofski</displayName>
<userName>joe</userName>
</author>
<createDate>2015-04-28T09:47:56.272+0200</createDate>
<creator>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Joe Krustofski</displayName>
<userName>joe</userName>
</creator>
<description>Description or statement of objectives for this example review.</description>
<dueDate>2015-04-29T09:47:56.272+0200</dueDate>
<jiraIssueKey>FOO-6754</jiraIssueKey>
<metricsVersion>4</metricsVersion>
<moderator>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Scott the Moderator</displayName>
<userName>scott</userName>
</moderator>
<name>Example review.</name>
<permaId>
<id>CR-FOO-21</id>
</permaId>
<permaIdHistory>CR-FOO-21</permaIdHistory>
<projectKey>CR-FOO</projectKey>
<type>REVIEW</type>
<actions>
<actionData>
<displayName>Abandon</displayName>
<name>action:abandonReview</name>
</actionData>
<actionData>
<displayName>Approve</displayName>
<name>action:approveReview</name>
</actionData>
<actionData>
<displayName>Comment</displayName>
<name>action:commentOnReview</name>
</actionData>
<actionData>
<displayName>Complete</displayName>
<name>action:completeReview</name>
</actionData>
<actionData>
<displayName>Edit Review Details</displayName>
<name>action:modifyReviewFiles</name>
</actionData>
</actions>
<generalComments>
<generalCommentData>
<createDate>2015-04-28T09:47:56.281+0200</createDate>
<defectApproved>false</defectApproved>
<defectRaised>false</defectRaised>
<deleted>false</deleted>
<draft>false</draft>
<message>I thought you said you were going to *remove* this line?</message>
<messageAsHtml>I thought you said you were going to <b>remove</b> this line?</messageAsHtml>
<metrics/>
<parentCommentId/>
<readStatus>UNREAD</readStatus>
<replies/>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Joe Bloggs</displayName>
<userName>joe</userName>
</user>
<permId>
<id>CR:1</id>
</permId>
<permaId>
<id>CR:1</id>
</permaId>
</generalCommentData>
</generalComments>
<reviewItems>
<reviewItem>
<participants>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Fred Eaglesmith</displayName>
<userName>fred</userName>
</user>
<completed>false</completed>
</participant>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Corb Lund</displayName>
<userName>clund</userName>
</user>
<completed>false</completed>
</participant>
</participants>
<permId>
<id>CFR-65</id>
</permId>
<anchorData>
<anchorPath>trunk</anchorPath>
<anchorRepository>REPO</anchorRepository>
<stripCount>0</stripCount>
</anchorData>
<authorName>evzijst</authorName>
<commitDate>2015-04-28T09:47:56.310+02:00</commitDate>
<commitType>Modified</commitType>
<fileType>File</fileType>
<fromContentUrl>/context/cru/CR-FOO-21/rawcontent/5687/dir64/a.txt</fromContentUrl>
<fromPath>dir64/a.txt</fromPath>
<fromRevision>65</fromRevision>
<patchUrl>/contextcru/CR-FOO-21/downloadpatch/6238/patch-7126.patch</patchUrl>
<repositoryName>REPO</repositoryName>
<showAsDiff>false</showAsDiff>
<toContentUrl>/context/cru/CR-FOO-21/rawcontent/6675/dir64/a.txt</toContentUrl>
<toPath>dir64/a.txt</toPath>
<toRevision>651</toRevision>
</reviewItem>
<reviewItem>
<participants>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Fred Eaglesmith</displayName>
<userName>fred</userName>
</user>
<completed>false</completed>
</participant>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Corb Lund</displayName>
<userName>clund</userName>
</user>
<completed>false</completed>
</participant>
</participants>
<permId>
<id>CFR-66</id>
</permId>
<anchorData>
<anchorPath>branches/branch1</anchorPath>
<anchorRepository>REPO</anchorRepository>
<stripCount>0</stripCount>
</anchorData>
<authorName>evzijst</authorName>
<commitDate>2015-04-28T09:47:56.310+02:00</commitDate>
<commitType>Modified</commitType>
<fileType>File</fileType>
<fromContentUrl>/context/cru/CR-FOO-21/rawcontent/5690/dir65/d.txt</fromContentUrl>
<fromPath>dir65/d.txt</fromPath>
<fromRevision>66</fromRevision>
<patchUrl>/contextcru/CR-FOO-21/downloadpatch/6273/patch-6173.patch</patchUrl>
<repositoryName>REPO</repositoryName>
<showAsDiff>true</showAsDiff>
<toContentUrl>/context/cru/CR-FOO-21/rawcontent/6085/dir65/d.txt</toContentUrl>
<toPath>dir65/d.txt</toPath>
<toRevision>661</toRevision>
</reviewItem>
<reviewItem>
<participants>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Fred Eaglesmith</displayName>
<userName>fred</userName>
</user>
<completed>false</completed>
</participant>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Corb Lund</displayName>
<userName>clund</userName>
</user>
<completed>false</completed>
</participant>
</participants>
<permId>
<id>CFR-67</id>
</permId>
<anchorData>
<anchorPath>branches/branch1</anchorPath>
<anchorRepository>REPO</anchorRepository>
<stripCount>0</stripCount>
</anchorData>
<authorName>evzijst</authorName>
<commitDate>2015-04-28T09:47:56.310+02:00</commitDate>
<commitType>Modified</commitType>
<fileType>File</fileType>
<fromContentUrl>/context/cru/CR-FOO-21/rawcontent/5693/dir66/c.txt</fromContentUrl>
<fromPath>dir66/c.txt</fromPath>
<fromRevision>67</fromRevision>
<patchUrl>/contextcru/CR-FOO-21/downloadpatch/6281/patch-9135.patch</patchUrl>
<repositoryName>REPO</repositoryName>
<showAsDiff>false</showAsDiff>
<toContentUrl>/context/cru/CR-FOO-21/rawcontent/5909/dir66/c.txt</toContentUrl>
<toPath>dir66/c.txt</toPath>
<toRevision>671</toRevision>
</reviewItem>
<reviewItem>
<participants>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Fred Eaglesmith</displayName>
<userName>fred</userName>
</user>
<completed>false</completed>
</participant>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Corb Lund</displayName>
<userName>clund</userName>
</user>
<completed>false</completed>
</participant>
</participants>
<permId>
<id>CFR-68</id>
</permId>
<anchorData>
<anchorPath>tags/tag1</anchorPath>
<anchorRepository>REPO</anchorRepository>
<stripCount>0</stripCount>
</anchorData>
<authorName>evzijst</authorName>
<commitDate>2015-04-28T09:47:56.310+02:00</commitDate>
<commitType>Modified</commitType>
<fileType>File</fileType>
<fromContentUrl>/context/cru/CR-FOO-21/rawcontent/5696/dir67/b.txt</fromContentUrl>
<fromPath>dir67/b.txt</fromPath>
<fromRevision>68</fromRevision>
<patchUrl>/contextcru/CR-FOO-21/downloadpatch/6394/patch-6062.patch</patchUrl>
<repositoryName>REPO</repositoryName>
<showAsDiff>true</showAsDiff>
<toContentUrl>/context/cru/CR-FOO-21/rawcontent/5789/dir67/b.txt</toContentUrl>
<toPath>dir67/b.txt</toPath>
<toRevision>681</toRevision>
</reviewItem>
<reviewItem>
<participants>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Fred Eaglesmith</displayName>
<userName>fred</userName>
</user>
<completed>false</completed>
</participant>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Corb Lund</displayName>
<userName>clund</userName>
</user>
<completed>false</completed>
</participant>
</participants>
<permId>
<id>CFR-69</id>
</permId>
<authorName>evzijst</authorName>
<commitDate>2015-04-28T09:47:56.310+02:00</commitDate>
<commitType>Modified</commitType>
<fileType>File</fileType>
<fromContentUrl>/context/cru/CR-FOO-21/rawcontent/5698/dir68/d.txt</fromContentUrl>
<fromPath>dir68/d.txt</fromPath>
<fromRevision>69</fromRevision>
<repositoryName>REPO</repositoryName>
<showAsDiff>false</showAsDiff>
<toContentUrl>/context/cru/CR-FOO-21/rawcontent/6394/dir68/d.txt</toContentUrl>
<toPath>dir68/d.txt</toPath>
<toRevision>691</toRevision>
</reviewItem>
<reviewItem>
<participants>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Fred Eaglesmith</displayName>
<userName>fred</userName>
</user>
<completed>false</completed>
</participant>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Corb Lund</displayName>
<userName>clund</userName>
</user>
<completed>false</completed>
</participant>
</participants>
<permId>
<id>CFR-70</id>
</permId>
<authorName>evzijst</authorName>
<commitDate>2015-04-28T09:47:56.311+02:00</commitDate>
<commitType>Modified</commitType>
<fileType>File</fileType>
<fromContentUrl>/context/cru/CR-FOO-21/rawcontent/5700/dir69/e.txt</fromContentUrl>
<fromPath>dir69/e.txt</fromPath>
<fromRevision>70</fromRevision>
<repositoryName>REPO</repositoryName>
<showAsDiff>true</showAsDiff>
<toContentUrl>/context/cru/CR-FOO-21/rawcontent/6164/dir69/e.txt</toContentUrl>
<toPath>dir69/e.txt</toPath>
<toRevision>701</toRevision>
</reviewItem>
<reviewItem>
<participants>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Fred Eaglesmith</displayName>
<userName>fred</userName>
</user>
<completed>false</completed>
</participant>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Corb Lund</displayName>
<userName>clund</userName>
</user>
<completed>false</completed>
</participant>
</participants>
<permId>
<id>CFR-71</id>
</permId>
<authorName>evzijst</authorName>
<commitDate>2015-04-28T09:47:56.311+02:00</commitDate>
<commitType>Modified</commitType>
<fileType>File</fileType>
<fromContentUrl>/context/cru/CR-FOO-21/rawcontent/5702/dir70/f.txt</fromContentUrl>
<fromPath>dir70/f.txt</fromPath>
<fromRevision>71</fromRevision>
<repositoryName>REPO</repositoryName>
<showAsDiff>false</showAsDiff>
<toContentUrl>/context/cru/CR-FOO-21/rawcontent/6679/dir70/f.txt</toContentUrl>
<toPath>dir70/f.txt</toPath>
<toRevision>711</toRevision>
</reviewItem>
</reviewItems>
<transitions>
<transitionData>
<displayName>Summarize</displayName>
<name>action:summarizeReview</name>
</transitionData>
</transitions>
</detailedReviewData>
</detailedReviews>
The detailed list of reviews that match the filter criteria, with the details of the review, such as comments (and its wiki rendered html), and review items.
{
"detailedReviewData" : [ {
"projectKey" : "CR-FOO",
"name" : "Example review.",
"description" : "Description or statement of objectives for this example review.",
"author" : {
"userName" : "joe",
"displayName" : "Joe Krustofski",
"avatarUrl" : "http://foo.com/avatar"
},
"moderator" : {
"userName" : "scott",
"displayName" : "Scott the Moderator",
"avatarUrl" : "http://foo.com/avatar"
},
"creator" : {
"userName" : "joe",
"displayName" : "Joe Krustofski",
"avatarUrl" : "http://foo.com/avatar"
},
"permaId" : {
"id" : "CR-FOO-21"
},
"permaIdHistory" : [ "CR-FOO-21" ],
"type" : "REVIEW",
"allowReviewersToJoin" : true,
"metricsVersion" : 4,
"createDate" : "2015-04-28T09:47:56.272+0200",
"dueDate" : "2015-04-29T09:47:56.272+0200",
"jiraIssueKey" : "FOO-6754",
"reviewItems" : {
"reviewItem" : [ {
"permId" : {
"id" : "CFR-65"
},
"participants" : [ {
"user" : {
"userName" : "fred",
"displayName" : "Fred Eaglesmith",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
}, {
"user" : {
"userName" : "clund",
"displayName" : "Corb Lund",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
} ],
"repositoryName" : "REPO",
"fromPath" : "dir64/a.txt",
"fromRevision" : "65",
"fromContentUrl" : "/context/cru/CR-FOO-21/rawcontent/5687/dir64/a.txt",
"toPath" : "dir64/a.txt",
"toRevision" : "651",
"toContentUrl" : "/context/cru/CR-FOO-21/rawcontent/6675/dir64/a.txt",
"patchUrl" : "/contextcru/CR-FOO-21/downloadpatch/6238/patch-7126.patch",
"fileType" : "File",
"commitType" : "Modified",
"authorName" : "evzijst",
"showAsDiff" : false,
"anchorData" : {
"anchorPath" : "trunk",
"anchorRepository" : "REPO",
"stripCount" : 0
},
"commitDate" : 1430207276310,
"expandedRevisions" : [ ]
}, {
"permId" : {
"id" : "CFR-66"
},
"participants" : [ {
"user" : {
"userName" : "fred",
"displayName" : "Fred Eaglesmith",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
}, {
"user" : {
"userName" : "clund",
"displayName" : "Corb Lund",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
} ],
"repositoryName" : "REPO",
"fromPath" : "dir65/d.txt",
"fromRevision" : "66",
"fromContentUrl" : "/context/cru/CR-FOO-21/rawcontent/5690/dir65/d.txt",
"toPath" : "dir65/d.txt",
"toRevision" : "661",
"toContentUrl" : "/context/cru/CR-FOO-21/rawcontent/6085/dir65/d.txt",
"patchUrl" : "/contextcru/CR-FOO-21/downloadpatch/6273/patch-6173.patch",
"fileType" : "File",
"commitType" : "Modified",
"authorName" : "evzijst",
"showAsDiff" : true,
"anchorData" : {
"anchorPath" : "branches/branch1",
"anchorRepository" : "REPO",
"stripCount" : 0
},
"commitDate" : 1430207276310,
"expandedRevisions" : [ ]
}, {
"permId" : {
"id" : "CFR-67"
},
"participants" : [ {
"user" : {
"userName" : "fred",
"displayName" : "Fred Eaglesmith",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
}, {
"user" : {
"userName" : "clund",
"displayName" : "Corb Lund",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
} ],
"repositoryName" : "REPO",
"fromPath" : "dir66/c.txt",
"fromRevision" : "67",
"fromContentUrl" : "/context/cru/CR-FOO-21/rawcontent/5693/dir66/c.txt",
"toPath" : "dir66/c.txt",
"toRevision" : "671",
"toContentUrl" : "/context/cru/CR-FOO-21/rawcontent/5909/dir66/c.txt",
"patchUrl" : "/contextcru/CR-FOO-21/downloadpatch/6281/patch-9135.patch",
"fileType" : "File",
"commitType" : "Modified",
"authorName" : "evzijst",
"showAsDiff" : false,
"anchorData" : {
"anchorPath" : "branches/branch1",
"anchorRepository" : "REPO",
"stripCount" : 0
},
"commitDate" : 1430207276310,
"expandedRevisions" : [ ]
}, {
"permId" : {
"id" : "CFR-68"
},
"participants" : [ {
"user" : {
"userName" : "fred",
"displayName" : "Fred Eaglesmith",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
}, {
"user" : {
"userName" : "clund",
"displayName" : "Corb Lund",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
} ],
"repositoryName" : "REPO",
"fromPath" : "dir67/b.txt",
"fromRevision" : "68",
"fromContentUrl" : "/context/cru/CR-FOO-21/rawcontent/5696/dir67/b.txt",
"toPath" : "dir67/b.txt",
"toRevision" : "681",
"toContentUrl" : "/context/cru/CR-FOO-21/rawcontent/5789/dir67/b.txt",
"patchUrl" : "/contextcru/CR-FOO-21/downloadpatch/6394/patch-6062.patch",
"fileType" : "File",
"commitType" : "Modified",
"authorName" : "evzijst",
"showAsDiff" : true,
"anchorData" : {
"anchorPath" : "tags/tag1",
"anchorRepository" : "REPO",
"stripCount" : 0
},
"commitDate" : 1430207276310,
"expandedRevisions" : [ ]
}, {
"permId" : {
"id" : "CFR-69"
},
"participants" : [ {
"user" : {
"userName" : "fred",
"displayName" : "Fred Eaglesmith",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
}, {
"user" : {
"userName" : "clund",
"displayName" : "Corb Lund",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
} ],
"repositoryName" : "REPO",
"fromPath" : "dir68/d.txt",
"fromRevision" : "69",
"fromContentUrl" : "/context/cru/CR-FOO-21/rawcontent/5698/dir68/d.txt",
"toPath" : "dir68/d.txt",
"toRevision" : "691",
"toContentUrl" : "/context/cru/CR-FOO-21/rawcontent/6394/dir68/d.txt",
"fileType" : "File",
"commitType" : "Modified",
"authorName" : "evzijst",
"showAsDiff" : false,
"commitDate" : 1430207276310,
"expandedRevisions" : [ ]
}, {
"permId" : {
"id" : "CFR-70"
},
"participants" : [ {
"user" : {
"userName" : "fred",
"displayName" : "Fred Eaglesmith",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
}, {
"user" : {
"userName" : "clund",
"displayName" : "Corb Lund",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
} ],
"repositoryName" : "REPO",
"fromPath" : "dir69/e.txt",
"fromRevision" : "70",
"fromContentUrl" : "/context/cru/CR-FOO-21/rawcontent/5700/dir69/e.txt",
"toPath" : "dir69/e.txt",
"toRevision" : "701",
"toContentUrl" : "/context/cru/CR-FOO-21/rawcontent/6164/dir69/e.txt",
"fileType" : "File",
"commitType" : "Modified",
"authorName" : "evzijst",
"showAsDiff" : true,
"commitDate" : 1430207276311,
"expandedRevisions" : [ ]
}, {
"permId" : {
"id" : "CFR-71"
},
"participants" : [ {
"user" : {
"userName" : "fred",
"displayName" : "Fred Eaglesmith",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
}, {
"user" : {
"userName" : "clund",
"displayName" : "Corb Lund",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
} ],
"repositoryName" : "REPO",
"fromPath" : "dir70/f.txt",
"fromRevision" : "71",
"fromContentUrl" : "/context/cru/CR-FOO-21/rawcontent/5702/dir70/f.txt",
"toPath" : "dir70/f.txt",
"toRevision" : "711",
"toContentUrl" : "/context/cru/CR-FOO-21/rawcontent/6679/dir70/f.txt",
"fileType" : "File",
"commitType" : "Modified",
"authorName" : "evzijst",
"showAsDiff" : false,
"commitDate" : 1430207276311,
"expandedRevisions" : [ ]
} ]
},
"generalComments" : {
"comments" : [ {
"metrics" : {
},
"message" : "I thought you said you were going to *remove* this line?",
"draft" : false,
"deleted" : false,
"defectRaised" : false,
"defectApproved" : false,
"readStatus" : "UNREAD",
"user" : {
"userName" : "joe",
"displayName" : "Joe Bloggs",
"avatarUrl" : "http://foo.com/avatar"
},
"createDate" : "2015-04-28T09:47:56.281+0200",
"permaId" : {
"id" : "CR:1"
},
"replies" : [ ],
"messageAsHtml" : "I thought you said you were going to <b>remove</b> this line?",
"permId" : {
"id" : "CR:1"
},
"parentCommentId" : {
}
} ]
},
"transitions" : {
"transitionData" : [ {
"name" : "action:summarizeReview",
"displayName" : "Summarize"
} ]
},
"actions" : {
"actionData" : [ {
"name" : "action:abandonReview",
"displayName" : "Abandon"
}, {
"name" : "action:approveReview",
"displayName" : "Approve"
}, {
"name" : "action:commentOnReview",
"displayName" : "Comment"
}, {
"name" : "action:completeReview",
"displayName" : "Complete"
}, {
"name" : "action:modifyReviewFiles",
"displayName" : "Edit Review Details"
} ]
}
} ]
}The detailed list of reviews that match the filter criteria, with the details of the review, such as comments (and its wiki rendered html), and review items.
This method should no longer be used, as it uses a POST for a read-only retrieval operation and is provided for backward compatibility only.
Do a GET instead.
acceptable request representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<customFilterData>
<fromDate>0</fromDate>
<orRoles>false</orRoles>
<project>Project 1</project>
<title>title of the review</title>
<toDate>0</toDate>
</customFilterData>
A custom filter definition.
{
"title" : "title of the review",
"orRoles" : false,
"project" : "Project 1",
"fromDate" : 0,
"toDate" : 0
}A custom filter definition.
available response representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<detailedReviews>
<detailedReviewData>
<allowReviewersToJoin>true</allowReviewersToJoin>
<author>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Joe Krustofski</displayName>
<userName>joe</userName>
</author>
<createDate>2015-04-28T09:47:56.272+0200</createDate>
<creator>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Joe Krustofski</displayName>
<userName>joe</userName>
</creator>
<description>Description or statement of objectives for this example review.</description>
<dueDate>2015-04-29T09:47:56.272+0200</dueDate>
<jiraIssueKey>FOO-6754</jiraIssueKey>
<metricsVersion>4</metricsVersion>
<moderator>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Scott the Moderator</displayName>
<userName>scott</userName>
</moderator>
<name>Example review.</name>
<permaId>
<id>CR-FOO-21</id>
</permaId>
<permaIdHistory>CR-FOO-21</permaIdHistory>
<projectKey>CR-FOO</projectKey>
<type>REVIEW</type>
<actions>
<actionData>
<displayName>Abandon</displayName>
<name>action:abandonReview</name>
</actionData>
<actionData>
<displayName>Approve</displayName>
<name>action:approveReview</name>
</actionData>
<actionData>
<displayName>Comment</displayName>
<name>action:commentOnReview</name>
</actionData>
<actionData>
<displayName>Complete</displayName>
<name>action:completeReview</name>
</actionData>
<actionData>
<displayName>Edit Review Details</displayName>
<name>action:modifyReviewFiles</name>
</actionData>
</actions>
<generalComments>
<generalCommentData>
<createDate>2015-04-28T09:47:56.281+0200</createDate>
<defectApproved>false</defectApproved>
<defectRaised>false</defectRaised>
<deleted>false</deleted>
<draft>false</draft>
<message>I thought you said you were going to *remove* this line?</message>
<messageAsHtml>I thought you said you were going to <b>remove</b> this line?</messageAsHtml>
<metrics/>
<parentCommentId/>
<readStatus>UNREAD</readStatus>
<replies/>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Joe Bloggs</displayName>
<userName>joe</userName>
</user>
<permId>
<id>CR:1</id>
</permId>
<permaId>
<id>CR:1</id>
</permaId>
</generalCommentData>
</generalComments>
<reviewItems>
<reviewItem>
<participants>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Fred Eaglesmith</displayName>
<userName>fred</userName>
</user>
<completed>false</completed>
</participant>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Corb Lund</displayName>
<userName>clund</userName>
</user>
<completed>false</completed>
</participant>
</participants>
<permId>
<id>CFR-65</id>
</permId>
<anchorData>
<anchorPath>trunk</anchorPath>
<anchorRepository>REPO</anchorRepository>
<stripCount>0</stripCount>
</anchorData>
<authorName>evzijst</authorName>
<commitDate>2015-04-28T09:47:56.310+02:00</commitDate>
<commitType>Modified</commitType>
<fileType>File</fileType>
<fromContentUrl>/context/cru/CR-FOO-21/rawcontent/5687/dir64/a.txt</fromContentUrl>
<fromPath>dir64/a.txt</fromPath>
<fromRevision>65</fromRevision>
<patchUrl>/contextcru/CR-FOO-21/downloadpatch/6238/patch-7126.patch</patchUrl>
<repositoryName>REPO</repositoryName>
<showAsDiff>false</showAsDiff>
<toContentUrl>/context/cru/CR-FOO-21/rawcontent/6675/dir64/a.txt</toContentUrl>
<toPath>dir64/a.txt</toPath>
<toRevision>651</toRevision>
</reviewItem>
<reviewItem>
<participants>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Fred Eaglesmith</displayName>
<userName>fred</userName>
</user>
<completed>false</completed>
</participant>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Corb Lund</displayName>
<userName>clund</userName>
</user>
<completed>false</completed>
</participant>
</participants>
<permId>
<id>CFR-66</id>
</permId>
<anchorData>
<anchorPath>branches/branch1</anchorPath>
<anchorRepository>REPO</anchorRepository>
<stripCount>0</stripCount>
</anchorData>
<authorName>evzijst</authorName>
<commitDate>2015-04-28T09:47:56.310+02:00</commitDate>
<commitType>Modified</commitType>
<fileType>File</fileType>
<fromContentUrl>/context/cru/CR-FOO-21/rawcontent/5690/dir65/d.txt</fromContentUrl>
<fromPath>dir65/d.txt</fromPath>
<fromRevision>66</fromRevision>
<patchUrl>/contextcru/CR-FOO-21/downloadpatch/6273/patch-6173.patch</patchUrl>
<repositoryName>REPO</repositoryName>
<showAsDiff>true</showAsDiff>
<toContentUrl>/context/cru/CR-FOO-21/rawcontent/6085/dir65/d.txt</toContentUrl>
<toPath>dir65/d.txt</toPath>
<toRevision>661</toRevision>
</reviewItem>
<reviewItem>
<participants>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Fred Eaglesmith</displayName>
<userName>fred</userName>
</user>
<completed>false</completed>
</participant>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Corb Lund</displayName>
<userName>clund</userName>
</user>
<completed>false</completed>
</participant>
</participants>
<permId>
<id>CFR-67</id>
</permId>
<anchorData>
<anchorPath>branches/branch1</anchorPath>
<anchorRepository>REPO</anchorRepository>
<stripCount>0</stripCount>
</anchorData>
<authorName>evzijst</authorName>
<commitDate>2015-04-28T09:47:56.310+02:00</commitDate>
<commitType>Modified</commitType>
<fileType>File</fileType>
<fromContentUrl>/context/cru/CR-FOO-21/rawcontent/5693/dir66/c.txt</fromContentUrl>
<fromPath>dir66/c.txt</fromPath>
<fromRevision>67</fromRevision>
<patchUrl>/contextcru/CR-FOO-21/downloadpatch/6281/patch-9135.patch</patchUrl>
<repositoryName>REPO</repositoryName>
<showAsDiff>false</showAsDiff>
<toContentUrl>/context/cru/CR-FOO-21/rawcontent/5909/dir66/c.txt</toContentUrl>
<toPath>dir66/c.txt</toPath>
<toRevision>671</toRevision>
</reviewItem>
<reviewItem>
<participants>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Fred Eaglesmith</displayName>
<userName>fred</userName>
</user>
<completed>false</completed>
</participant>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Corb Lund</displayName>
<userName>clund</userName>
</user>
<completed>false</completed>
</participant>
</participants>
<permId>
<id>CFR-68</id>
</permId>
<anchorData>
<anchorPath>tags/tag1</anchorPath>
<anchorRepository>REPO</anchorRepository>
<stripCount>0</stripCount>
</anchorData>
<authorName>evzijst</authorName>
<commitDate>2015-04-28T09:47:56.310+02:00</commitDate>
<commitType>Modified</commitType>
<fileType>File</fileType>
<fromContentUrl>/context/cru/CR-FOO-21/rawcontent/5696/dir67/b.txt</fromContentUrl>
<fromPath>dir67/b.txt</fromPath>
<fromRevision>68</fromRevision>
<patchUrl>/contextcru/CR-FOO-21/downloadpatch/6394/patch-6062.patch</patchUrl>
<repositoryName>REPO</repositoryName>
<showAsDiff>true</showAsDiff>
<toContentUrl>/context/cru/CR-FOO-21/rawcontent/5789/dir67/b.txt</toContentUrl>
<toPath>dir67/b.txt</toPath>
<toRevision>681</toRevision>
</reviewItem>
<reviewItem>
<participants>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Fred Eaglesmith</displayName>
<userName>fred</userName>
</user>
<completed>false</completed>
</participant>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Corb Lund</displayName>
<userName>clund</userName>
</user>
<completed>false</completed>
</participant>
</participants>
<permId>
<id>CFR-69</id>
</permId>
<authorName>evzijst</authorName>
<commitDate>2015-04-28T09:47:56.310+02:00</commitDate>
<commitType>Modified</commitType>
<fileType>File</fileType>
<fromContentUrl>/context/cru/CR-FOO-21/rawcontent/5698/dir68/d.txt</fromContentUrl>
<fromPath>dir68/d.txt</fromPath>
<fromRevision>69</fromRevision>
<repositoryName>REPO</repositoryName>
<showAsDiff>false</showAsDiff>
<toContentUrl>/context/cru/CR-FOO-21/rawcontent/6394/dir68/d.txt</toContentUrl>
<toPath>dir68/d.txt</toPath>
<toRevision>691</toRevision>
</reviewItem>
<reviewItem>
<participants>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Fred Eaglesmith</displayName>
<userName>fred</userName>
</user>
<completed>false</completed>
</participant>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Corb Lund</displayName>
<userName>clund</userName>
</user>
<completed>false</completed>
</participant>
</participants>
<permId>
<id>CFR-70</id>
</permId>
<authorName>evzijst</authorName>
<commitDate>2015-04-28T09:47:56.311+02:00</commitDate>
<commitType>Modified</commitType>
<fileType>File</fileType>
<fromContentUrl>/context/cru/CR-FOO-21/rawcontent/5700/dir69/e.txt</fromContentUrl>
<fromPath>dir69/e.txt</fromPath>
<fromRevision>70</fromRevision>
<repositoryName>REPO</repositoryName>
<showAsDiff>true</showAsDiff>
<toContentUrl>/context/cru/CR-FOO-21/rawcontent/6164/dir69/e.txt</toContentUrl>
<toPath>dir69/e.txt</toPath>
<toRevision>701</toRevision>
</reviewItem>
<reviewItem>
<participants>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Fred Eaglesmith</displayName>
<userName>fred</userName>
</user>
<completed>false</completed>
</participant>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Corb Lund</displayName>
<userName>clund</userName>
</user>
<completed>false</completed>
</participant>
</participants>
<permId>
<id>CFR-71</id>
</permId>
<authorName>evzijst</authorName>
<commitDate>2015-04-28T09:47:56.311+02:00</commitDate>
<commitType>Modified</commitType>
<fileType>File</fileType>
<fromContentUrl>/context/cru/CR-FOO-21/rawcontent/5702/dir70/f.txt</fromContentUrl>
<fromPath>dir70/f.txt</fromPath>
<fromRevision>71</fromRevision>
<repositoryName>REPO</repositoryName>
<showAsDiff>false</showAsDiff>
<toContentUrl>/context/cru/CR-FOO-21/rawcontent/6679/dir70/f.txt</toContentUrl>
<toPath>dir70/f.txt</toPath>
<toRevision>711</toRevision>
</reviewItem>
</reviewItems>
<transitions>
<transitionData>
<displayName>Summarize</displayName>
<name>action:summarizeReview</name>
</transitionData>
</transitions>
</detailedReviewData>
</detailedReviews>
The detailed list of reviews that match the filter criteria.
{
"detailedReviewData" : [ {
"projectKey" : "CR-FOO",
"name" : "Example review.",
"description" : "Description or statement of objectives for this example review.",
"author" : {
"userName" : "joe",
"displayName" : "Joe Krustofski",
"avatarUrl" : "http://foo.com/avatar"
},
"moderator" : {
"userName" : "scott",
"displayName" : "Scott the Moderator",
"avatarUrl" : "http://foo.com/avatar"
},
"creator" : {
"userName" : "joe",
"displayName" : "Joe Krustofski",
"avatarUrl" : "http://foo.com/avatar"
},
"permaId" : {
"id" : "CR-FOO-21"
},
"permaIdHistory" : [ "CR-FOO-21" ],
"type" : "REVIEW",
"allowReviewersToJoin" : true,
"metricsVersion" : 4,
"createDate" : "2015-04-28T09:47:56.272+0200",
"dueDate" : "2015-04-29T09:47:56.272+0200",
"jiraIssueKey" : "FOO-6754",
"reviewItems" : {
"reviewItem" : [ {
"permId" : {
"id" : "CFR-65"
},
"participants" : [ {
"user" : {
"userName" : "fred",
"displayName" : "Fred Eaglesmith",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
}, {
"user" : {
"userName" : "clund",
"displayName" : "Corb Lund",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
} ],
"repositoryName" : "REPO",
"fromPath" : "dir64/a.txt",
"fromRevision" : "65",
"fromContentUrl" : "/context/cru/CR-FOO-21/rawcontent/5687/dir64/a.txt",
"toPath" : "dir64/a.txt",
"toRevision" : "651",
"toContentUrl" : "/context/cru/CR-FOO-21/rawcontent/6675/dir64/a.txt",
"patchUrl" : "/contextcru/CR-FOO-21/downloadpatch/6238/patch-7126.patch",
"fileType" : "File",
"commitType" : "Modified",
"authorName" : "evzijst",
"showAsDiff" : false,
"anchorData" : {
"anchorPath" : "trunk",
"anchorRepository" : "REPO",
"stripCount" : 0
},
"commitDate" : 1430207276310,
"expandedRevisions" : [ ]
}, {
"permId" : {
"id" : "CFR-66"
},
"participants" : [ {
"user" : {
"userName" : "fred",
"displayName" : "Fred Eaglesmith",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
}, {
"user" : {
"userName" : "clund",
"displayName" : "Corb Lund",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
} ],
"repositoryName" : "REPO",
"fromPath" : "dir65/d.txt",
"fromRevision" : "66",
"fromContentUrl" : "/context/cru/CR-FOO-21/rawcontent/5690/dir65/d.txt",
"toPath" : "dir65/d.txt",
"toRevision" : "661",
"toContentUrl" : "/context/cru/CR-FOO-21/rawcontent/6085/dir65/d.txt",
"patchUrl" : "/contextcru/CR-FOO-21/downloadpatch/6273/patch-6173.patch",
"fileType" : "File",
"commitType" : "Modified",
"authorName" : "evzijst",
"showAsDiff" : true,
"anchorData" : {
"anchorPath" : "branches/branch1",
"anchorRepository" : "REPO",
"stripCount" : 0
},
"commitDate" : 1430207276310,
"expandedRevisions" : [ ]
}, {
"permId" : {
"id" : "CFR-67"
},
"participants" : [ {
"user" : {
"userName" : "fred",
"displayName" : "Fred Eaglesmith",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
}, {
"user" : {
"userName" : "clund",
"displayName" : "Corb Lund",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
} ],
"repositoryName" : "REPO",
"fromPath" : "dir66/c.txt",
"fromRevision" : "67",
"fromContentUrl" : "/context/cru/CR-FOO-21/rawcontent/5693/dir66/c.txt",
"toPath" : "dir66/c.txt",
"toRevision" : "671",
"toContentUrl" : "/context/cru/CR-FOO-21/rawcontent/5909/dir66/c.txt",
"patchUrl" : "/contextcru/CR-FOO-21/downloadpatch/6281/patch-9135.patch",
"fileType" : "File",
"commitType" : "Modified",
"authorName" : "evzijst",
"showAsDiff" : false,
"anchorData" : {
"anchorPath" : "branches/branch1",
"anchorRepository" : "REPO",
"stripCount" : 0
},
"commitDate" : 1430207276310,
"expandedRevisions" : [ ]
}, {
"permId" : {
"id" : "CFR-68"
},
"participants" : [ {
"user" : {
"userName" : "fred",
"displayName" : "Fred Eaglesmith",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
}, {
"user" : {
"userName" : "clund",
"displayName" : "Corb Lund",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
} ],
"repositoryName" : "REPO",
"fromPath" : "dir67/b.txt",
"fromRevision" : "68",
"fromContentUrl" : "/context/cru/CR-FOO-21/rawcontent/5696/dir67/b.txt",
"toPath" : "dir67/b.txt",
"toRevision" : "681",
"toContentUrl" : "/context/cru/CR-FOO-21/rawcontent/5789/dir67/b.txt",
"patchUrl" : "/contextcru/CR-FOO-21/downloadpatch/6394/patch-6062.patch",
"fileType" : "File",
"commitType" : "Modified",
"authorName" : "evzijst",
"showAsDiff" : true,
"anchorData" : {
"anchorPath" : "tags/tag1",
"anchorRepository" : "REPO",
"stripCount" : 0
},
"commitDate" : 1430207276310,
"expandedRevisions" : [ ]
}, {
"permId" : {
"id" : "CFR-69"
},
"participants" : [ {
"user" : {
"userName" : "fred",
"displayName" : "Fred Eaglesmith",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
}, {
"user" : {
"userName" : "clund",
"displayName" : "Corb Lund",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
} ],
"repositoryName" : "REPO",
"fromPath" : "dir68/d.txt",
"fromRevision" : "69",
"fromContentUrl" : "/context/cru/CR-FOO-21/rawcontent/5698/dir68/d.txt",
"toPath" : "dir68/d.txt",
"toRevision" : "691",
"toContentUrl" : "/context/cru/CR-FOO-21/rawcontent/6394/dir68/d.txt",
"fileType" : "File",
"commitType" : "Modified",
"authorName" : "evzijst",
"showAsDiff" : false,
"commitDate" : 1430207276310,
"expandedRevisions" : [ ]
}, {
"permId" : {
"id" : "CFR-70"
},
"participants" : [ {
"user" : {
"userName" : "fred",
"displayName" : "Fred Eaglesmith",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
}, {
"user" : {
"userName" : "clund",
"displayName" : "Corb Lund",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
} ],
"repositoryName" : "REPO",
"fromPath" : "dir69/e.txt",
"fromRevision" : "70",
"fromContentUrl" : "/context/cru/CR-FOO-21/rawcontent/5700/dir69/e.txt",
"toPath" : "dir69/e.txt",
"toRevision" : "701",
"toContentUrl" : "/context/cru/CR-FOO-21/rawcontent/6164/dir69/e.txt",
"fileType" : "File",
"commitType" : "Modified",
"authorName" : "evzijst",
"showAsDiff" : true,
"commitDate" : 1430207276311,
"expandedRevisions" : [ ]
}, {
"permId" : {
"id" : "CFR-71"
},
"participants" : [ {
"user" : {
"userName" : "fred",
"displayName" : "Fred Eaglesmith",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
}, {
"user" : {
"userName" : "clund",
"displayName" : "Corb Lund",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
} ],
"repositoryName" : "REPO",
"fromPath" : "dir70/f.txt",
"fromRevision" : "71",
"fromContentUrl" : "/context/cru/CR-FOO-21/rawcontent/5702/dir70/f.txt",
"toPath" : "dir70/f.txt",
"toRevision" : "711",
"toContentUrl" : "/context/cru/CR-FOO-21/rawcontent/6679/dir70/f.txt",
"fileType" : "File",
"commitType" : "Modified",
"authorName" : "evzijst",
"showAsDiff" : false,
"commitDate" : 1430207276311,
"expandedRevisions" : [ ]
} ]
},
"generalComments" : {
"comments" : [ {
"metrics" : {
},
"message" : "I thought you said you were going to *remove* this line?",
"draft" : false,
"deleted" : false,
"defectRaised" : false,
"defectApproved" : false,
"readStatus" : "UNREAD",
"user" : {
"userName" : "joe",
"displayName" : "Joe Bloggs",
"avatarUrl" : "http://foo.com/avatar"
},
"createDate" : "2015-04-28T09:47:56.281+0200",
"permaId" : {
"id" : "CR:1"
},
"replies" : [ ],
"messageAsHtml" : "I thought you said you were going to <b>remove</b> this line?",
"permId" : {
"id" : "CR:1"
},
"parentCommentId" : {
}
} ]
},
"transitions" : {
"transitionData" : [ {
"name" : "action:summarizeReview",
"displayName" : "Summarize"
} ]
},
"actions" : {
"actionData" : [ {
"name" : "action:abandonReview",
"displayName" : "Abandon"
}, {
"name" : "action:approveReview",
"displayName" : "Approve"
}, {
"name" : "action:commentOnReview",
"displayName" : "Comment"
}, {
"name" : "action:completeReview",
"displayName" : "Complete"
}, {
"name" : "action:modifyReviewFiles",
"displayName" : "Edit Review Details"
} ]
}
} ]
}The detailed list of reviews that match the filter criteria.
| parameter | value | description |
|---|---|---|
|
repository |
reposiotry to search for file |
Return a list of Reviews which include a particular file.
The path parameter must be the full path name of a file in repository, with no leading slash.
| parameter | value | description |
|---|---|---|
|
path |
path to find in reviews |
available response representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<reviews>
<reviewData>
<allowReviewersToJoin>true</allowReviewersToJoin>
<author>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Joe Krustofski</displayName>
<userName>joe</userName>
</author>
<createDate>2015-04-28T09:47:56.272+0200</createDate>
<creator>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Joe Krustofski</displayName>
<userName>joe</userName>
</creator>
<description>Description or statement of objectives for this example review.</description>
<dueDate>2015-04-29T09:47:56.272+0200</dueDate>
<jiraIssueKey>FOO-6754</jiraIssueKey>
<metricsVersion>4</metricsVersion>
<moderator>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Scott the Moderator</displayName>
<userName>scott</userName>
</moderator>
<name>Example review.</name>
<permaId>
<id>CR-FOO-21</id>
</permaId>
<permaIdHistory>CR-FOO-21</permaIdHistory>
<projectKey>CR-FOO</projectKey>
<type>REVIEW</type>
</reviewData>
<reviewData>
<allowReviewersToJoin>true</allowReviewersToJoin>
<author>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Joe Krustofski</displayName>
<userName>joe</userName>
</author>
<createDate>2015-04-28T09:47:56.272+0200</createDate>
<creator>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Joe Krustofski</displayName>
<userName>joe</userName>
</creator>
<description>Description or statement of objectives for this example review.</description>
<dueDate>2015-04-29T09:47:56.272+0200</dueDate>
<jiraIssueKey>FOO-6754</jiraIssueKey>
<metricsVersion>4</metricsVersion>
<moderator>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Scott the Moderator</displayName>
<userName>scott</userName>
</moderator>
<name>Example review.</name>
<permaId>
<id>CR-FOO-21</id>
</permaId>
<permaIdHistory>CR-FOO-21</permaIdHistory>
<projectKey>CR-FOO</projectKey>
<type>REVIEW</type>
</reviewData>
</reviews>
The list of reviews containing the specified file. Does not contain the review details.
{
"reviewData" : [ {
"projectKey" : "CR-FOO",
"name" : "Example review.",
"description" : "Description or statement of objectives for this example review.",
"author" : {
"userName" : "joe",
"displayName" : "Joe Krustofski",
"avatarUrl" : "http://foo.com/avatar"
},
"moderator" : {
"userName" : "scott",
"displayName" : "Scott the Moderator",
"avatarUrl" : "http://foo.com/avatar"
},
"creator" : {
"userName" : "joe",
"displayName" : "Joe Krustofski",
"avatarUrl" : "http://foo.com/avatar"
},
"permaId" : {
"id" : "CR-FOO-21"
},
"permaIdHistory" : [ "CR-FOO-21" ],
"type" : "REVIEW",
"allowReviewersToJoin" : true,
"metricsVersion" : 4,
"createDate" : "2015-04-28T09:47:56.272+0200",
"dueDate" : "2015-04-29T09:47:56.272+0200",
"jiraIssueKey" : "FOO-6754"
}, {
"projectKey" : "CR-FOO",
"name" : "Example review.",
"description" : "Description or statement of objectives for this example review.",
"author" : {
"userName" : "joe",
"displayName" : "Joe Krustofski",
"avatarUrl" : "http://foo.com/avatar"
},
"moderator" : {
"userName" : "scott",
"displayName" : "Scott the Moderator",
"avatarUrl" : "http://foo.com/avatar"
},
"creator" : {
"userName" : "joe",
"displayName" : "Joe Krustofski",
"avatarUrl" : "http://foo.com/avatar"
},
"permaId" : {
"id" : "CR-FOO-21"
},
"permaIdHistory" : [ "CR-FOO-21" ],
"type" : "REVIEW",
"allowReviewersToJoin" : true,
"metricsVersion" : 4,
"createDate" : "2015-04-28T09:47:56.272+0200",
"dueDate" : "2015-04-29T09:47:56.272+0200",
"jiraIssueKey" : "FOO-6754"
} ]
}The list of reviews containing the specified file. Does not contain the review details.
| parameter | value | description |
|---|---|---|
|
repository |
repository to search for file. |
Return a list of Reviews which include a particular file.
The path parameter must be the full path name of a file in repository, with no leading slash.
For each review all details are included (review items + comments).
| parameter | value | description |
|---|---|---|
|
path |
path to find in reviews. |
available response representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<detailedReviews>
<detailedReviewData>
<allowReviewersToJoin>true</allowReviewersToJoin>
<author>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Joe Krustofski</displayName>
<userName>joe</userName>
</author>
<createDate>2015-04-28T09:47:56.272+0200</createDate>
<creator>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Joe Krustofski</displayName>
<userName>joe</userName>
</creator>
<description>Description or statement of objectives for this example review.</description>
<dueDate>2015-04-29T09:47:56.272+0200</dueDate>
<jiraIssueKey>FOO-6754</jiraIssueKey>
<metricsVersion>4</metricsVersion>
<moderator>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Scott the Moderator</displayName>
<userName>scott</userName>
</moderator>
<name>Example review.</name>
<permaId>
<id>CR-FOO-21</id>
</permaId>
<permaIdHistory>CR-FOO-21</permaIdHistory>
<projectKey>CR-FOO</projectKey>
<type>REVIEW</type>
<actions>
<actionData>
<displayName>Abandon</displayName>
<name>action:abandonReview</name>
</actionData>
<actionData>
<displayName>Approve</displayName>
<name>action:approveReview</name>
</actionData>
<actionData>
<displayName>Comment</displayName>
<name>action:commentOnReview</name>
</actionData>
<actionData>
<displayName>Complete</displayName>
<name>action:completeReview</name>
</actionData>
<actionData>
<displayName>Edit Review Details</displayName>
<name>action:modifyReviewFiles</name>
</actionData>
</actions>
<generalComments>
<generalCommentData>
<createDate>2015-04-28T09:47:56.281+0200</createDate>
<defectApproved>false</defectApproved>
<defectRaised>false</defectRaised>
<deleted>false</deleted>
<draft>false</draft>
<message>I thought you said you were going to *remove* this line?</message>
<messageAsHtml>I thought you said you were going to <b>remove</b> this line?</messageAsHtml>
<metrics/>
<parentCommentId/>
<readStatus>UNREAD</readStatus>
<replies/>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Joe Bloggs</displayName>
<userName>joe</userName>
</user>
<permId>
<id>CR:1</id>
</permId>
<permaId>
<id>CR:1</id>
</permaId>
</generalCommentData>
</generalComments>
<reviewItems>
<reviewItem>
<participants>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Fred Eaglesmith</displayName>
<userName>fred</userName>
</user>
<completed>false</completed>
</participant>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Corb Lund</displayName>
<userName>clund</userName>
</user>
<completed>false</completed>
</participant>
</participants>
<permId>
<id>CFR-65</id>
</permId>
<anchorData>
<anchorPath>trunk</anchorPath>
<anchorRepository>REPO</anchorRepository>
<stripCount>0</stripCount>
</anchorData>
<authorName>evzijst</authorName>
<commitDate>2015-04-28T09:47:56.310+02:00</commitDate>
<commitType>Modified</commitType>
<fileType>File</fileType>
<fromContentUrl>/context/cru/CR-FOO-21/rawcontent/5687/dir64/a.txt</fromContentUrl>
<fromPath>dir64/a.txt</fromPath>
<fromRevision>65</fromRevision>
<patchUrl>/contextcru/CR-FOO-21/downloadpatch/6238/patch-7126.patch</patchUrl>
<repositoryName>REPO</repositoryName>
<showAsDiff>false</showAsDiff>
<toContentUrl>/context/cru/CR-FOO-21/rawcontent/6675/dir64/a.txt</toContentUrl>
<toPath>dir64/a.txt</toPath>
<toRevision>651</toRevision>
</reviewItem>
<reviewItem>
<participants>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Fred Eaglesmith</displayName>
<userName>fred</userName>
</user>
<completed>false</completed>
</participant>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Corb Lund</displayName>
<userName>clund</userName>
</user>
<completed>false</completed>
</participant>
</participants>
<permId>
<id>CFR-66</id>
</permId>
<anchorData>
<anchorPath>branches/branch1</anchorPath>
<anchorRepository>REPO</anchorRepository>
<stripCount>0</stripCount>
</anchorData>
<authorName>evzijst</authorName>
<commitDate>2015-04-28T09:47:56.310+02:00</commitDate>
<commitType>Modified</commitType>
<fileType>File</fileType>
<fromContentUrl>/context/cru/CR-FOO-21/rawcontent/5690/dir65/d.txt</fromContentUrl>
<fromPath>dir65/d.txt</fromPath>
<fromRevision>66</fromRevision>
<patchUrl>/contextcru/CR-FOO-21/downloadpatch/6273/patch-6173.patch</patchUrl>
<repositoryName>REPO</repositoryName>
<showAsDiff>true</showAsDiff>
<toContentUrl>/context/cru/CR-FOO-21/rawcontent/6085/dir65/d.txt</toContentUrl>
<toPath>dir65/d.txt</toPath>
<toRevision>661</toRevision>
</reviewItem>
<reviewItem>
<participants>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Fred Eaglesmith</displayName>
<userName>fred</userName>
</user>
<completed>false</completed>
</participant>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Corb Lund</displayName>
<userName>clund</userName>
</user>
<completed>false</completed>
</participant>
</participants>
<permId>
<id>CFR-67</id>
</permId>
<anchorData>
<anchorPath>branches/branch1</anchorPath>
<anchorRepository>REPO</anchorRepository>
<stripCount>0</stripCount>
</anchorData>
<authorName>evzijst</authorName>
<commitDate>2015-04-28T09:47:56.310+02:00</commitDate>
<commitType>Modified</commitType>
<fileType>File</fileType>
<fromContentUrl>/context/cru/CR-FOO-21/rawcontent/5693/dir66/c.txt</fromContentUrl>
<fromPath>dir66/c.txt</fromPath>
<fromRevision>67</fromRevision>
<patchUrl>/contextcru/CR-FOO-21/downloadpatch/6281/patch-9135.patch</patchUrl>
<repositoryName>REPO</repositoryName>
<showAsDiff>false</showAsDiff>
<toContentUrl>/context/cru/CR-FOO-21/rawcontent/5909/dir66/c.txt</toContentUrl>
<toPath>dir66/c.txt</toPath>
<toRevision>671</toRevision>
</reviewItem>
<reviewItem>
<participants>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Fred Eaglesmith</displayName>
<userName>fred</userName>
</user>
<completed>false</completed>
</participant>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Corb Lund</displayName>
<userName>clund</userName>
</user>
<completed>false</completed>
</participant>
</participants>
<permId>
<id>CFR-68</id>
</permId>
<anchorData>
<anchorPath>tags/tag1</anchorPath>
<anchorRepository>REPO</anchorRepository>
<stripCount>0</stripCount>
</anchorData>
<authorName>evzijst</authorName>
<commitDate>2015-04-28T09:47:56.310+02:00</commitDate>
<commitType>Modified</commitType>
<fileType>File</fileType>
<fromContentUrl>/context/cru/CR-FOO-21/rawcontent/5696/dir67/b.txt</fromContentUrl>
<fromPath>dir67/b.txt</fromPath>
<fromRevision>68</fromRevision>
<patchUrl>/contextcru/CR-FOO-21/downloadpatch/6394/patch-6062.patch</patchUrl>
<repositoryName>REPO</repositoryName>
<showAsDiff>true</showAsDiff>
<toContentUrl>/context/cru/CR-FOO-21/rawcontent/5789/dir67/b.txt</toContentUrl>
<toPath>dir67/b.txt</toPath>
<toRevision>681</toRevision>
</reviewItem>
<reviewItem>
<participants>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Fred Eaglesmith</displayName>
<userName>fred</userName>
</user>
<completed>false</completed>
</participant>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Corb Lund</displayName>
<userName>clund</userName>
</user>
<completed>false</completed>
</participant>
</participants>
<permId>
<id>CFR-69</id>
</permId>
<authorName>evzijst</authorName>
<commitDate>2015-04-28T09:47:56.310+02:00</commitDate>
<commitType>Modified</commitType>
<fileType>File</fileType>
<fromContentUrl>/context/cru/CR-FOO-21/rawcontent/5698/dir68/d.txt</fromContentUrl>
<fromPath>dir68/d.txt</fromPath>
<fromRevision>69</fromRevision>
<repositoryName>REPO</repositoryName>
<showAsDiff>false</showAsDiff>
<toContentUrl>/context/cru/CR-FOO-21/rawcontent/6394/dir68/d.txt</toContentUrl>
<toPath>dir68/d.txt</toPath>
<toRevision>691</toRevision>
</reviewItem>
<reviewItem>
<participants>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Fred Eaglesmith</displayName>
<userName>fred</userName>
</user>
<completed>false</completed>
</participant>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Corb Lund</displayName>
<userName>clund</userName>
</user>
<completed>false</completed>
</participant>
</participants>
<permId>
<id>CFR-70</id>
</permId>
<authorName>evzijst</authorName>
<commitDate>2015-04-28T09:47:56.311+02:00</commitDate>
<commitType>Modified</commitType>
<fileType>File</fileType>
<fromContentUrl>/context/cru/CR-FOO-21/rawcontent/5700/dir69/e.txt</fromContentUrl>
<fromPath>dir69/e.txt</fromPath>
<fromRevision>70</fromRevision>
<repositoryName>REPO</repositoryName>
<showAsDiff>true</showAsDiff>
<toContentUrl>/context/cru/CR-FOO-21/rawcontent/6164/dir69/e.txt</toContentUrl>
<toPath>dir69/e.txt</toPath>
<toRevision>701</toRevision>
</reviewItem>
<reviewItem>
<participants>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Fred Eaglesmith</displayName>
<userName>fred</userName>
</user>
<completed>false</completed>
</participant>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Corb Lund</displayName>
<userName>clund</userName>
</user>
<completed>false</completed>
</participant>
</participants>
<permId>
<id>CFR-71</id>
</permId>
<authorName>evzijst</authorName>
<commitDate>2015-04-28T09:47:56.311+02:00</commitDate>
<commitType>Modified</commitType>
<fileType>File</fileType>
<fromContentUrl>/context/cru/CR-FOO-21/rawcontent/5702/dir70/f.txt</fromContentUrl>
<fromPath>dir70/f.txt</fromPath>
<fromRevision>71</fromRevision>
<repositoryName>REPO</repositoryName>
<showAsDiff>false</showAsDiff>
<toContentUrl>/context/cru/CR-FOO-21/rawcontent/6679/dir70/f.txt</toContentUrl>
<toPath>dir70/f.txt</toPath>
<toRevision>711</toRevision>
</reviewItem>
</reviewItems>
<transitions>
<transitionData>
<displayName>Summarize</displayName>
<name>action:summarizeReview</name>
</transitionData>
</transitions>
</detailedReviewData>
</detailedReviews>
The detailed list of reviews containing the specified file, with the details of the review, such as comments (and its wiki rendered html), and review items.
{
"detailedReviewData" : [ {
"projectKey" : "CR-FOO",
"name" : "Example review.",
"description" : "Description or statement of objectives for this example review.",
"author" : {
"userName" : "joe",
"displayName" : "Joe Krustofski",
"avatarUrl" : "http://foo.com/avatar"
},
"moderator" : {
"userName" : "scott",
"displayName" : "Scott the Moderator",
"avatarUrl" : "http://foo.com/avatar"
},
"creator" : {
"userName" : "joe",
"displayName" : "Joe Krustofski",
"avatarUrl" : "http://foo.com/avatar"
},
"permaId" : {
"id" : "CR-FOO-21"
},
"permaIdHistory" : [ "CR-FOO-21" ],
"type" : "REVIEW",
"allowReviewersToJoin" : true,
"metricsVersion" : 4,
"createDate" : "2015-04-28T09:47:56.272+0200",
"dueDate" : "2015-04-29T09:47:56.272+0200",
"jiraIssueKey" : "FOO-6754",
"reviewItems" : {
"reviewItem" : [ {
"permId" : {
"id" : "CFR-65"
},
"participants" : [ {
"user" : {
"userName" : "fred",
"displayName" : "Fred Eaglesmith",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
}, {
"user" : {
"userName" : "clund",
"displayName" : "Corb Lund",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
} ],
"repositoryName" : "REPO",
"fromPath" : "dir64/a.txt",
"fromRevision" : "65",
"fromContentUrl" : "/context/cru/CR-FOO-21/rawcontent/5687/dir64/a.txt",
"toPath" : "dir64/a.txt",
"toRevision" : "651",
"toContentUrl" : "/context/cru/CR-FOO-21/rawcontent/6675/dir64/a.txt",
"patchUrl" : "/contextcru/CR-FOO-21/downloadpatch/6238/patch-7126.patch",
"fileType" : "File",
"commitType" : "Modified",
"authorName" : "evzijst",
"showAsDiff" : false,
"anchorData" : {
"anchorPath" : "trunk",
"anchorRepository" : "REPO",
"stripCount" : 0
},
"commitDate" : 1430207276310,
"expandedRevisions" : [ ]
}, {
"permId" : {
"id" : "CFR-66"
},
"participants" : [ {
"user" : {
"userName" : "fred",
"displayName" : "Fred Eaglesmith",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
}, {
"user" : {
"userName" : "clund",
"displayName" : "Corb Lund",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
} ],
"repositoryName" : "REPO",
"fromPath" : "dir65/d.txt",
"fromRevision" : "66",
"fromContentUrl" : "/context/cru/CR-FOO-21/rawcontent/5690/dir65/d.txt",
"toPath" : "dir65/d.txt",
"toRevision" : "661",
"toContentUrl" : "/context/cru/CR-FOO-21/rawcontent/6085/dir65/d.txt",
"patchUrl" : "/contextcru/CR-FOO-21/downloadpatch/6273/patch-6173.patch",
"fileType" : "File",
"commitType" : "Modified",
"authorName" : "evzijst",
"showAsDiff" : true,
"anchorData" : {
"anchorPath" : "branches/branch1",
"anchorRepository" : "REPO",
"stripCount" : 0
},
"commitDate" : 1430207276310,
"expandedRevisions" : [ ]
}, {
"permId" : {
"id" : "CFR-67"
},
"participants" : [ {
"user" : {
"userName" : "fred",
"displayName" : "Fred Eaglesmith",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
}, {
"user" : {
"userName" : "clund",
"displayName" : "Corb Lund",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
} ],
"repositoryName" : "REPO",
"fromPath" : "dir66/c.txt",
"fromRevision" : "67",
"fromContentUrl" : "/context/cru/CR-FOO-21/rawcontent/5693/dir66/c.txt",
"toPath" : "dir66/c.txt",
"toRevision" : "671",
"toContentUrl" : "/context/cru/CR-FOO-21/rawcontent/5909/dir66/c.txt",
"patchUrl" : "/contextcru/CR-FOO-21/downloadpatch/6281/patch-9135.patch",
"fileType" : "File",
"commitType" : "Modified",
"authorName" : "evzijst",
"showAsDiff" : false,
"anchorData" : {
"anchorPath" : "branches/branch1",
"anchorRepository" : "REPO",
"stripCount" : 0
},
"commitDate" : 1430207276310,
"expandedRevisions" : [ ]
}, {
"permId" : {
"id" : "CFR-68"
},
"participants" : [ {
"user" : {
"userName" : "fred",
"displayName" : "Fred Eaglesmith",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
}, {
"user" : {
"userName" : "clund",
"displayName" : "Corb Lund",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
} ],
"repositoryName" : "REPO",
"fromPath" : "dir67/b.txt",
"fromRevision" : "68",
"fromContentUrl" : "/context/cru/CR-FOO-21/rawcontent/5696/dir67/b.txt",
"toPath" : "dir67/b.txt",
"toRevision" : "681",
"toContentUrl" : "/context/cru/CR-FOO-21/rawcontent/5789/dir67/b.txt",
"patchUrl" : "/contextcru/CR-FOO-21/downloadpatch/6394/patch-6062.patch",
"fileType" : "File",
"commitType" : "Modified",
"authorName" : "evzijst",
"showAsDiff" : true,
"anchorData" : {
"anchorPath" : "tags/tag1",
"anchorRepository" : "REPO",
"stripCount" : 0
},
"commitDate" : 1430207276310,
"expandedRevisions" : [ ]
}, {
"permId" : {
"id" : "CFR-69"
},
"participants" : [ {
"user" : {
"userName" : "fred",
"displayName" : "Fred Eaglesmith",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
}, {
"user" : {
"userName" : "clund",
"displayName" : "Corb Lund",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
} ],
"repositoryName" : "REPO",
"fromPath" : "dir68/d.txt",
"fromRevision" : "69",
"fromContentUrl" : "/context/cru/CR-FOO-21/rawcontent/5698/dir68/d.txt",
"toPath" : "dir68/d.txt",
"toRevision" : "691",
"toContentUrl" : "/context/cru/CR-FOO-21/rawcontent/6394/dir68/d.txt",
"fileType" : "File",
"commitType" : "Modified",
"authorName" : "evzijst",
"showAsDiff" : false,
"commitDate" : 1430207276310,
"expandedRevisions" : [ ]
}, {
"permId" : {
"id" : "CFR-70"
},
"participants" : [ {
"user" : {
"userName" : "fred",
"displayName" : "Fred Eaglesmith",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
}, {
"user" : {
"userName" : "clund",
"displayName" : "Corb Lund",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
} ],
"repositoryName" : "REPO",
"fromPath" : "dir69/e.txt",
"fromRevision" : "70",
"fromContentUrl" : "/context/cru/CR-FOO-21/rawcontent/5700/dir69/e.txt",
"toPath" : "dir69/e.txt",
"toRevision" : "701",
"toContentUrl" : "/context/cru/CR-FOO-21/rawcontent/6164/dir69/e.txt",
"fileType" : "File",
"commitType" : "Modified",
"authorName" : "evzijst",
"showAsDiff" : true,
"commitDate" : 1430207276311,
"expandedRevisions" : [ ]
}, {
"permId" : {
"id" : "CFR-71"
},
"participants" : [ {
"user" : {
"userName" : "fred",
"displayName" : "Fred Eaglesmith",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
}, {
"user" : {
"userName" : "clund",
"displayName" : "Corb Lund",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
} ],
"repositoryName" : "REPO",
"fromPath" : "dir70/f.txt",
"fromRevision" : "71",
"fromContentUrl" : "/context/cru/CR-FOO-21/rawcontent/5702/dir70/f.txt",
"toPath" : "dir70/f.txt",
"toRevision" : "711",
"toContentUrl" : "/context/cru/CR-FOO-21/rawcontent/6679/dir70/f.txt",
"fileType" : "File",
"commitType" : "Modified",
"authorName" : "evzijst",
"showAsDiff" : false,
"commitDate" : 1430207276311,
"expandedRevisions" : [ ]
} ]
},
"generalComments" : {
"comments" : [ {
"metrics" : {
},
"message" : "I thought you said you were going to *remove* this line?",
"draft" : false,
"deleted" : false,
"defectRaised" : false,
"defectApproved" : false,
"readStatus" : "UNREAD",
"user" : {
"userName" : "joe",
"displayName" : "Joe Bloggs",
"avatarUrl" : "http://foo.com/avatar"
},
"createDate" : "2015-04-28T09:47:56.281+0200",
"permaId" : {
"id" : "CR:1"
},
"replies" : [ ],
"messageAsHtml" : "I thought you said you were going to <b>remove</b> this line?",
"permId" : {
"id" : "CR:1"
},
"parentCommentId" : {
}
} ]
},
"transitions" : {
"transitionData" : [ {
"name" : "action:summarizeReview",
"displayName" : "Summarize"
} ]
},
"actions" : {
"actionData" : [ {
"name" : "action:abandonReview",
"displayName" : "Abandon"
}, {
"name" : "action:approveReview",
"displayName" : "Approve"
}, {
"name" : "action:commentOnReview",
"displayName" : "Comment"
}, {
"name" : "action:completeReview",
"displayName" : "Complete"
}, {
"name" : "action:modifyReviewFiles",
"displayName" : "Edit Review Details"
} ]
}
} ]
}The detailed list of reviews containing the specified file, with the details of the review, such as comments (and its wiki rendered html), and review items.
| parameter | value | description |
|---|---|---|
|
id |
the permId of the review to delete (e.g. "CR-45"). |
Get a single review by its permId (e.g. "CR-45"). If the review does not exist, a 404 is returned.
The moderator element may not exist if the review does not have a Moderator.available response representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<reviewData>
<allowReviewersToJoin>true</allowReviewersToJoin>
<author>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Joe Krustofski</displayName>
<userName>joe</userName>
</author>
<createDate>2015-04-28T09:47:56.272+0200</createDate>
<creator>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Joe Krustofski</displayName>
<userName>joe</userName>
</creator>
<description>Description or statement of objectives for this example review.</description>
<dueDate>2015-04-29T09:47:56.272+0200</dueDate>
<jiraIssueKey>FOO-6754</jiraIssueKey>
<metricsVersion>4</metricsVersion>
<moderator>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Scott the Moderator</displayName>
<userName>scott</userName>
</moderator>
<name>Example review.</name>
<permaId>
<id>CR-FOO-21</id>
</permaId>
<permaIdHistory>CR-FOO-21</permaIdHistory>
<projectKey>CR-FOO</projectKey>
<type>REVIEW</type>
</reviewData>
A ReviewData instance containing the attributes of the review. Does not contain the details of the review.
{
"projectKey" : "CR-FOO",
"name" : "Example review.",
"description" : "Description or statement of objectives for this example review.",
"author" : {
"userName" : "joe",
"displayName" : "Joe Krustofski",
"avatarUrl" : "http://foo.com/avatar"
},
"moderator" : {
"userName" : "scott",
"displayName" : "Scott the Moderator",
"avatarUrl" : "http://foo.com/avatar"
},
"creator" : {
"userName" : "joe",
"displayName" : "Joe Krustofski",
"avatarUrl" : "http://foo.com/avatar"
},
"permaId" : {
"id" : "CR-FOO-21"
},
"permaIdHistory" : [ "CR-FOO-21" ],
"type" : "REVIEW",
"allowReviewersToJoin" : true,
"metricsVersion" : 4,
"createDate" : "2015-04-28T09:47:56.272+0200",
"dueDate" : "2015-04-29T09:47:56.272+0200",
"jiraIssueKey" : "FOO-6754"
}A ReviewData instance containing the attributes of the review. Does not contain the details of the review.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<error>
<code>NotFound</code>
<message>Requested resource not found.</message>
<stacktrace>com.atlassian.crucible.spi.services.NotFoundException: Requested resource not found.
at com.atlassian.crucible.spi.rpc.ExampleDocuments.<clinit>(ExampleDocuments.java:27)
at sun.misc.Unsafe.ensureClassInitialized(Native Method)
at sun.reflect.UnsafeFieldAccessorFactory.newFieldAccessor(UnsafeFieldAccessorFactory.java:25)
at sun.reflect.ReflectionFactory.newFieldAccessor(ReflectionFactory.java:122)
at java.lang.reflect.Field.acquireFieldAccessor(Field.java:918)
at java.lang.reflect.Field.getFieldAccessor(Field.java:899)
at java.lang.reflect.Field.get(Field.java:358)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedLinkFromTag(ResourceDocletJsonXml.java:649)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedExample(ResourceDocletJsonXml.java:542)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.createRepresentationDocTypes(ResourceDocletJsonXml.java:453)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.addResponseDoc(ResourceDocletJsonXml.java:428)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.start(ResourceDocletJsonXml.java:196)
at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)
at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
at java.lang.reflect.Method.invoke(Method.java:597)
at com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:269)
at com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:143)
at com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)
at com.sun.tools.javadoc.Start.begin(Start.java:128)
at com.sun.tools.javadoc.Main.execute(Main.java:41)
at com.sun.tools.javadoc.Main.main(Main.java:31)
</stacktrace>
</error>
If the review does not exist.
{
"code" : "NotFound",
"message" : "Requested resource not found.",
"stacktrace" : "com.atlassian.crucible.spi.services.NotFoundException: Requested resource not found.\n\tat com.atlassian.crucible.spi.rpc.ExampleDocuments.<clinit>(ExampleDocuments.java:27)\n\tat sun.misc.Unsafe.ensureClassInitialized(Native Method)\n\tat sun.reflect.UnsafeFieldAccessorFactory.newFieldAccessor(UnsafeFieldAccessorFactory.java:25)\n\tat sun.reflect.ReflectionFactory.newFieldAccessor(ReflectionFactory.java:122)\n\tat java.lang.reflect.Field.acquireFieldAccessor(Field.java:918)\n\tat java.lang.reflect.Field.getFieldAccessor(Field.java:899)\n\tat java.lang.reflect.Field.get(Field.java:358)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedLinkFromTag(ResourceDocletJsonXml.java:649)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedExample(ResourceDocletJsonXml.java:542)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.createRepresentationDocTypes(ResourceDocletJsonXml.java:453)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.addResponseDoc(ResourceDocletJsonXml.java:428)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.start(ResourceDocletJsonXml.java:196)\n\tat sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)\n\tat sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)\n\tat sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)\n\tat java.lang.reflect.Method.invoke(Method.java:597)\n\tat com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:269)\n\tat com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:143)\n\tat com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)\n\tat com.sun.tools.javadoc.Start.begin(Start.java:128)\n\tat com.sun.tools.javadoc.Main.execute(Main.java:41)\n\tat com.sun.tools.javadoc.Main.main(Main.java:31)\n"
}If the review does not exist.
Permanently deletes the specified review. The review must have been abandoned.
| parameter | value | description |
|---|---|---|
|
id |
the permId of the review (e.g. "CR-45"). |
Returns the specified review.
All details are included (review items + comments).
available response representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<detailedReviewData>
<allowReviewersToJoin>true</allowReviewersToJoin>
<author>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Joe Krustofski</displayName>
<userName>joe</userName>
</author>
<createDate>2015-04-28T09:47:56.272+0200</createDate>
<creator>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Joe Krustofski</displayName>
<userName>joe</userName>
</creator>
<description>Description or statement of objectives for this example review.</description>
<dueDate>2015-04-29T09:47:56.272+0200</dueDate>
<jiraIssueKey>FOO-6754</jiraIssueKey>
<metricsVersion>4</metricsVersion>
<moderator>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Scott the Moderator</displayName>
<userName>scott</userName>
</moderator>
<name>Example review.</name>
<permaId>
<id>CR-FOO-21</id>
</permaId>
<permaIdHistory>CR-FOO-21</permaIdHistory>
<projectKey>CR-FOO</projectKey>
<type>REVIEW</type>
<actions>
<actionData>
<displayName>Abandon</displayName>
<name>action:abandonReview</name>
</actionData>
<actionData>
<displayName>Approve</displayName>
<name>action:approveReview</name>
</actionData>
<actionData>
<displayName>Comment</displayName>
<name>action:commentOnReview</name>
</actionData>
<actionData>
<displayName>Complete</displayName>
<name>action:completeReview</name>
</actionData>
<actionData>
<displayName>Edit Review Details</displayName>
<name>action:modifyReviewFiles</name>
</actionData>
</actions>
<generalComments>
<generalCommentData>
<createDate>2015-04-28T09:47:56.281+0200</createDate>
<defectApproved>false</defectApproved>
<defectRaised>false</defectRaised>
<deleted>false</deleted>
<draft>false</draft>
<message>I thought you said you were going to *remove* this line?</message>
<messageAsHtml>I thought you said you were going to <b>remove</b> this line?</messageAsHtml>
<metrics/>
<parentCommentId/>
<readStatus>UNREAD</readStatus>
<replies/>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Joe Bloggs</displayName>
<userName>joe</userName>
</user>
<permId>
<id>CR:1</id>
</permId>
<permaId>
<id>CR:1</id>
</permaId>
</generalCommentData>
</generalComments>
<reviewItems>
<reviewItem>
<participants>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Fred Eaglesmith</displayName>
<userName>fred</userName>
</user>
<completed>false</completed>
</participant>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Corb Lund</displayName>
<userName>clund</userName>
</user>
<completed>false</completed>
</participant>
</participants>
<permId>
<id>CFR-65</id>
</permId>
<anchorData>
<anchorPath>trunk</anchorPath>
<anchorRepository>REPO</anchorRepository>
<stripCount>0</stripCount>
</anchorData>
<authorName>evzijst</authorName>
<commitDate>2015-04-28T09:47:56.310+02:00</commitDate>
<commitType>Modified</commitType>
<fileType>File</fileType>
<fromContentUrl>/context/cru/CR-FOO-21/rawcontent/5687/dir64/a.txt</fromContentUrl>
<fromPath>dir64/a.txt</fromPath>
<fromRevision>65</fromRevision>
<patchUrl>/contextcru/CR-FOO-21/downloadpatch/6238/patch-7126.patch</patchUrl>
<repositoryName>REPO</repositoryName>
<showAsDiff>false</showAsDiff>
<toContentUrl>/context/cru/CR-FOO-21/rawcontent/6675/dir64/a.txt</toContentUrl>
<toPath>dir64/a.txt</toPath>
<toRevision>651</toRevision>
</reviewItem>
<reviewItem>
<participants>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Fred Eaglesmith</displayName>
<userName>fred</userName>
</user>
<completed>false</completed>
</participant>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Corb Lund</displayName>
<userName>clund</userName>
</user>
<completed>false</completed>
</participant>
</participants>
<permId>
<id>CFR-66</id>
</permId>
<anchorData>
<anchorPath>branches/branch1</anchorPath>
<anchorRepository>REPO</anchorRepository>
<stripCount>0</stripCount>
</anchorData>
<authorName>evzijst</authorName>
<commitDate>2015-04-28T09:47:56.310+02:00</commitDate>
<commitType>Modified</commitType>
<fileType>File</fileType>
<fromContentUrl>/context/cru/CR-FOO-21/rawcontent/5690/dir65/d.txt</fromContentUrl>
<fromPath>dir65/d.txt</fromPath>
<fromRevision>66</fromRevision>
<patchUrl>/contextcru/CR-FOO-21/downloadpatch/6273/patch-6173.patch</patchUrl>
<repositoryName>REPO</repositoryName>
<showAsDiff>true</showAsDiff>
<toContentUrl>/context/cru/CR-FOO-21/rawcontent/6085/dir65/d.txt</toContentUrl>
<toPath>dir65/d.txt</toPath>
<toRevision>661</toRevision>
</reviewItem>
<reviewItem>
<participants>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Fred Eaglesmith</displayName>
<userName>fred</userName>
</user>
<completed>false</completed>
</participant>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Corb Lund</displayName>
<userName>clund</userName>
</user>
<completed>false</completed>
</participant>
</participants>
<permId>
<id>CFR-67</id>
</permId>
<anchorData>
<anchorPath>branches/branch1</anchorPath>
<anchorRepository>REPO</anchorRepository>
<stripCount>0</stripCount>
</anchorData>
<authorName>evzijst</authorName>
<commitDate>2015-04-28T09:47:56.310+02:00</commitDate>
<commitType>Modified</commitType>
<fileType>File</fileType>
<fromContentUrl>/context/cru/CR-FOO-21/rawcontent/5693/dir66/c.txt</fromContentUrl>
<fromPath>dir66/c.txt</fromPath>
<fromRevision>67</fromRevision>
<patchUrl>/contextcru/CR-FOO-21/downloadpatch/6281/patch-9135.patch</patchUrl>
<repositoryName>REPO</repositoryName>
<showAsDiff>false</showAsDiff>
<toContentUrl>/context/cru/CR-FOO-21/rawcontent/5909/dir66/c.txt</toContentUrl>
<toPath>dir66/c.txt</toPath>
<toRevision>671</toRevision>
</reviewItem>
<reviewItem>
<participants>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Fred Eaglesmith</displayName>
<userName>fred</userName>
</user>
<completed>false</completed>
</participant>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Corb Lund</displayName>
<userName>clund</userName>
</user>
<completed>false</completed>
</participant>
</participants>
<permId>
<id>CFR-68</id>
</permId>
<anchorData>
<anchorPath>tags/tag1</anchorPath>
<anchorRepository>REPO</anchorRepository>
<stripCount>0</stripCount>
</anchorData>
<authorName>evzijst</authorName>
<commitDate>2015-04-28T09:47:56.310+02:00</commitDate>
<commitType>Modified</commitType>
<fileType>File</fileType>
<fromContentUrl>/context/cru/CR-FOO-21/rawcontent/5696/dir67/b.txt</fromContentUrl>
<fromPath>dir67/b.txt</fromPath>
<fromRevision>68</fromRevision>
<patchUrl>/contextcru/CR-FOO-21/downloadpatch/6394/patch-6062.patch</patchUrl>
<repositoryName>REPO</repositoryName>
<showAsDiff>true</showAsDiff>
<toContentUrl>/context/cru/CR-FOO-21/rawcontent/5789/dir67/b.txt</toContentUrl>
<toPath>dir67/b.txt</toPath>
<toRevision>681</toRevision>
</reviewItem>
<reviewItem>
<participants>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Fred Eaglesmith</displayName>
<userName>fred</userName>
</user>
<completed>false</completed>
</participant>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Corb Lund</displayName>
<userName>clund</userName>
</user>
<completed>false</completed>
</participant>
</participants>
<permId>
<id>CFR-69</id>
</permId>
<authorName>evzijst</authorName>
<commitDate>2015-04-28T09:47:56.310+02:00</commitDate>
<commitType>Modified</commitType>
<fileType>File</fileType>
<fromContentUrl>/context/cru/CR-FOO-21/rawcontent/5698/dir68/d.txt</fromContentUrl>
<fromPath>dir68/d.txt</fromPath>
<fromRevision>69</fromRevision>
<repositoryName>REPO</repositoryName>
<showAsDiff>false</showAsDiff>
<toContentUrl>/context/cru/CR-FOO-21/rawcontent/6394/dir68/d.txt</toContentUrl>
<toPath>dir68/d.txt</toPath>
<toRevision>691</toRevision>
</reviewItem>
<reviewItem>
<participants>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Fred Eaglesmith</displayName>
<userName>fred</userName>
</user>
<completed>false</completed>
</participant>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Corb Lund</displayName>
<userName>clund</userName>
</user>
<completed>false</completed>
</participant>
</participants>
<permId>
<id>CFR-70</id>
</permId>
<authorName>evzijst</authorName>
<commitDate>2015-04-28T09:47:56.311+02:00</commitDate>
<commitType>Modified</commitType>
<fileType>File</fileType>
<fromContentUrl>/context/cru/CR-FOO-21/rawcontent/5700/dir69/e.txt</fromContentUrl>
<fromPath>dir69/e.txt</fromPath>
<fromRevision>70</fromRevision>
<repositoryName>REPO</repositoryName>
<showAsDiff>true</showAsDiff>
<toContentUrl>/context/cru/CR-FOO-21/rawcontent/6164/dir69/e.txt</toContentUrl>
<toPath>dir69/e.txt</toPath>
<toRevision>701</toRevision>
</reviewItem>
<reviewItem>
<participants>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Fred Eaglesmith</displayName>
<userName>fred</userName>
</user>
<completed>false</completed>
</participant>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Corb Lund</displayName>
<userName>clund</userName>
</user>
<completed>false</completed>
</participant>
</participants>
<permId>
<id>CFR-71</id>
</permId>
<authorName>evzijst</authorName>
<commitDate>2015-04-28T09:47:56.311+02:00</commitDate>
<commitType>Modified</commitType>
<fileType>File</fileType>
<fromContentUrl>/context/cru/CR-FOO-21/rawcontent/5702/dir70/f.txt</fromContentUrl>
<fromPath>dir70/f.txt</fromPath>
<fromRevision>71</fromRevision>
<repositoryName>REPO</repositoryName>
<showAsDiff>false</showAsDiff>
<toContentUrl>/context/cru/CR-FOO-21/rawcontent/6679/dir70/f.txt</toContentUrl>
<toPath>dir70/f.txt</toPath>
<toRevision>711</toRevision>
</reviewItem>
</reviewItems>
<transitions>
<transitionData>
<displayName>Summarize</displayName>
<name>action:summarizeReview</name>
</transitionData>
</transitions>
</detailedReviewData>
A detailedReviewData element containing the attributes of the review, with the details of the review, such as comments (and its wiki rendered html), and review items.
{
"projectKey" : "CR-FOO",
"name" : "Example review.",
"description" : "Description or statement of objectives for this example review.",
"author" : {
"userName" : "joe",
"displayName" : "Joe Krustofski",
"avatarUrl" : "http://foo.com/avatar"
},
"moderator" : {
"userName" : "scott",
"displayName" : "Scott the Moderator",
"avatarUrl" : "http://foo.com/avatar"
},
"creator" : {
"userName" : "joe",
"displayName" : "Joe Krustofski",
"avatarUrl" : "http://foo.com/avatar"
},
"permaId" : {
"id" : "CR-FOO-21"
},
"permaIdHistory" : [ "CR-FOO-21" ],
"type" : "REVIEW",
"allowReviewersToJoin" : true,
"metricsVersion" : 4,
"createDate" : "2015-04-28T09:47:56.272+0200",
"dueDate" : "2015-04-29T09:47:56.272+0200",
"jiraIssueKey" : "FOO-6754",
"reviewItems" : {
"reviewItem" : [ {
"permId" : {
"id" : "CFR-65"
},
"participants" : [ {
"user" : {
"userName" : "fred",
"displayName" : "Fred Eaglesmith",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
}, {
"user" : {
"userName" : "clund",
"displayName" : "Corb Lund",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
} ],
"repositoryName" : "REPO",
"fromPath" : "dir64/a.txt",
"fromRevision" : "65",
"fromContentUrl" : "/context/cru/CR-FOO-21/rawcontent/5687/dir64/a.txt",
"toPath" : "dir64/a.txt",
"toRevision" : "651",
"toContentUrl" : "/context/cru/CR-FOO-21/rawcontent/6675/dir64/a.txt",
"patchUrl" : "/contextcru/CR-FOO-21/downloadpatch/6238/patch-7126.patch",
"fileType" : "File",
"commitType" : "Modified",
"authorName" : "evzijst",
"showAsDiff" : false,
"anchorData" : {
"anchorPath" : "trunk",
"anchorRepository" : "REPO",
"stripCount" : 0
},
"commitDate" : 1430207276310,
"expandedRevisions" : [ ]
}, {
"permId" : {
"id" : "CFR-66"
},
"participants" : [ {
"user" : {
"userName" : "fred",
"displayName" : "Fred Eaglesmith",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
}, {
"user" : {
"userName" : "clund",
"displayName" : "Corb Lund",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
} ],
"repositoryName" : "REPO",
"fromPath" : "dir65/d.txt",
"fromRevision" : "66",
"fromContentUrl" : "/context/cru/CR-FOO-21/rawcontent/5690/dir65/d.txt",
"toPath" : "dir65/d.txt",
"toRevision" : "661",
"toContentUrl" : "/context/cru/CR-FOO-21/rawcontent/6085/dir65/d.txt",
"patchUrl" : "/contextcru/CR-FOO-21/downloadpatch/6273/patch-6173.patch",
"fileType" : "File",
"commitType" : "Modified",
"authorName" : "evzijst",
"showAsDiff" : true,
"anchorData" : {
"anchorPath" : "branches/branch1",
"anchorRepository" : "REPO",
"stripCount" : 0
},
"commitDate" : 1430207276310,
"expandedRevisions" : [ ]
}, {
"permId" : {
"id" : "CFR-67"
},
"participants" : [ {
"user" : {
"userName" : "fred",
"displayName" : "Fred Eaglesmith",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
}, {
"user" : {
"userName" : "clund",
"displayName" : "Corb Lund",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
} ],
"repositoryName" : "REPO",
"fromPath" : "dir66/c.txt",
"fromRevision" : "67",
"fromContentUrl" : "/context/cru/CR-FOO-21/rawcontent/5693/dir66/c.txt",
"toPath" : "dir66/c.txt",
"toRevision" : "671",
"toContentUrl" : "/context/cru/CR-FOO-21/rawcontent/5909/dir66/c.txt",
"patchUrl" : "/contextcru/CR-FOO-21/downloadpatch/6281/patch-9135.patch",
"fileType" : "File",
"commitType" : "Modified",
"authorName" : "evzijst",
"showAsDiff" : false,
"anchorData" : {
"anchorPath" : "branches/branch1",
"anchorRepository" : "REPO",
"stripCount" : 0
},
"commitDate" : 1430207276310,
"expandedRevisions" : [ ]
}, {
"permId" : {
"id" : "CFR-68"
},
"participants" : [ {
"user" : {
"userName" : "fred",
"displayName" : "Fred Eaglesmith",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
}, {
"user" : {
"userName" : "clund",
"displayName" : "Corb Lund",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
} ],
"repositoryName" : "REPO",
"fromPath" : "dir67/b.txt",
"fromRevision" : "68",
"fromContentUrl" : "/context/cru/CR-FOO-21/rawcontent/5696/dir67/b.txt",
"toPath" : "dir67/b.txt",
"toRevision" : "681",
"toContentUrl" : "/context/cru/CR-FOO-21/rawcontent/5789/dir67/b.txt",
"patchUrl" : "/contextcru/CR-FOO-21/downloadpatch/6394/patch-6062.patch",
"fileType" : "File",
"commitType" : "Modified",
"authorName" : "evzijst",
"showAsDiff" : true,
"anchorData" : {
"anchorPath" : "tags/tag1",
"anchorRepository" : "REPO",
"stripCount" : 0
},
"commitDate" : 1430207276310,
"expandedRevisions" : [ ]
}, {
"permId" : {
"id" : "CFR-69"
},
"participants" : [ {
"user" : {
"userName" : "fred",
"displayName" : "Fred Eaglesmith",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
}, {
"user" : {
"userName" : "clund",
"displayName" : "Corb Lund",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
} ],
"repositoryName" : "REPO",
"fromPath" : "dir68/d.txt",
"fromRevision" : "69",
"fromContentUrl" : "/context/cru/CR-FOO-21/rawcontent/5698/dir68/d.txt",
"toPath" : "dir68/d.txt",
"toRevision" : "691",
"toContentUrl" : "/context/cru/CR-FOO-21/rawcontent/6394/dir68/d.txt",
"fileType" : "File",
"commitType" : "Modified",
"authorName" : "evzijst",
"showAsDiff" : false,
"commitDate" : 1430207276310,
"expandedRevisions" : [ ]
}, {
"permId" : {
"id" : "CFR-70"
},
"participants" : [ {
"user" : {
"userName" : "fred",
"displayName" : "Fred Eaglesmith",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
}, {
"user" : {
"userName" : "clund",
"displayName" : "Corb Lund",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
} ],
"repositoryName" : "REPO",
"fromPath" : "dir69/e.txt",
"fromRevision" : "70",
"fromContentUrl" : "/context/cru/CR-FOO-21/rawcontent/5700/dir69/e.txt",
"toPath" : "dir69/e.txt",
"toRevision" : "701",
"toContentUrl" : "/context/cru/CR-FOO-21/rawcontent/6164/dir69/e.txt",
"fileType" : "File",
"commitType" : "Modified",
"authorName" : "evzijst",
"showAsDiff" : true,
"commitDate" : 1430207276311,
"expandedRevisions" : [ ]
}, {
"permId" : {
"id" : "CFR-71"
},
"participants" : [ {
"user" : {
"userName" : "fred",
"displayName" : "Fred Eaglesmith",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
}, {
"user" : {
"userName" : "clund",
"displayName" : "Corb Lund",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
} ],
"repositoryName" : "REPO",
"fromPath" : "dir70/f.txt",
"fromRevision" : "71",
"fromContentUrl" : "/context/cru/CR-FOO-21/rawcontent/5702/dir70/f.txt",
"toPath" : "dir70/f.txt",
"toRevision" : "711",
"toContentUrl" : "/context/cru/CR-FOO-21/rawcontent/6679/dir70/f.txt",
"fileType" : "File",
"commitType" : "Modified",
"authorName" : "evzijst",
"showAsDiff" : false,
"commitDate" : 1430207276311,
"expandedRevisions" : [ ]
} ]
},
"generalComments" : {
"comments" : [ {
"metrics" : {
},
"message" : "I thought you said you were going to *remove* this line?",
"draft" : false,
"deleted" : false,
"defectRaised" : false,
"defectApproved" : false,
"readStatus" : "UNREAD",
"user" : {
"userName" : "joe",
"displayName" : "Joe Bloggs",
"avatarUrl" : "http://foo.com/avatar"
},
"createDate" : "2015-04-28T09:47:56.281+0200",
"permaId" : {
"id" : "CR:1"
},
"replies" : [ ],
"messageAsHtml" : "I thought you said you were going to <b>remove</b> this line?",
"permId" : {
"id" : "CR:1"
},
"parentCommentId" : {
}
} ]
},
"transitions" : {
"transitionData" : [ {
"name" : "action:summarizeReview",
"displayName" : "Summarize"
} ]
},
"actions" : {
"actionData" : [ {
"name" : "action:abandonReview",
"displayName" : "Abandon"
}, {
"name" : "action:approveReview",
"displayName" : "Approve"
}, {
"name" : "action:commentOnReview",
"displayName" : "Comment"
}, {
"name" : "action:completeReview",
"displayName" : "Complete"
}, {
"name" : "action:modifyReviewFiles",
"displayName" : "Edit Review Details"
} ]
}
}A detailedReviewData element containing the attributes of the review, with the details of the review, such as comments (and its wiki rendered html), and review items.
| parameter | value | description |
|---|---|---|
|
id |
the permId of the a review (e.g. "CR-45"). |
Get a list of the actions which the current user is allowed to perform on the review.
This shows actions the user has permission to perform - the review may not be in a suitable state for all these actions to be performed.
available response representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<actions>
<actionData>
<displayName>Abandon</displayName>
<name>action:abandonReview</name>
</actionData>
<actionData>
<displayName>Approve</displayName>
<name>action:approveReview</name>
</actionData>
<actionData>
<displayName>Comment</displayName>
<name>action:commentOnReview</name>
</actionData>
<actionData>
<displayName>Complete</displayName>
<name>action:completeReview</name>
</actionData>
<actionData>
<displayName>Edit Review Details</displayName>
<name>action:modifyReviewFiles</name>
</actionData>
</actions>
The list of all actions in the review's workflow.
{
"actionData" : [ {
"name" : "action:abandonReview",
"displayName" : "Abandon"
}, {
"name" : "action:approveReview",
"displayName" : "Approve"
}, {
"name" : "action:commentOnReview",
"displayName" : "Comment"
}, {
"name" : "action:completeReview",
"displayName" : "Complete"
}, {
"name" : "action:modifyReviewFiles",
"displayName" : "Edit Review Details"
} ]
}The list of all actions in the review's workflow.
| parameter | value | description |
|---|---|---|
|
id |
the permId of the a review (e.g. "CR-45"). |
Get a list of the actions which the current user can perform on this review, given its current state and the user's permissions.
available response representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<transitions>
<transitionData>
<displayName>Summarize</displayName>
<name>action:summarizeReview</name>
</transitionData>
</transitions>
The list of the state transitions that are available in the review's current workflow state.
{
"transitionData" : [ {
"name" : "action:summarizeReview",
"displayName" : "Summarize"
} ]
}The list of the state transitions that are available in the review's current workflow state.
| parameter | value | description |
|---|---|---|
|
id |
the perm id of the review to add the patch to |
acceptable request representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<addChangeset>
<repository>repo1</repository>
<changesets>
<changesetData>
<id>68f730e</id>
</changesetData>
<changesetData>
<id>2b177b2</id>
</changesetData>
</changesets>
</addChangeset>
Example of a request document used to add a changeset to a review
{
"repository" : "repo1",
"changesets" : {
"changesetData" : [ {
"id" : "68f730e"
}, {
"id" : "2b177b2"
} ]
}
}Example of a request document used to add a changeset to a review
available response representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<reviewData>
<allowReviewersToJoin>true</allowReviewersToJoin>
<author>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Joe Krustofski</displayName>
<userName>joe</userName>
</author>
<createDate>2015-04-28T09:47:56.272+0200</createDate>
<creator>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Joe Krustofski</displayName>
<userName>joe</userName>
</creator>
<description>Description or statement of objectives for this example review.</description>
<dueDate>2015-04-29T09:47:56.272+0200</dueDate>
<jiraIssueKey>FOO-6754</jiraIssueKey>
<metricsVersion>4</metricsVersion>
<moderator>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Scott the Moderator</displayName>
<userName>scott</userName>
</moderator>
<name>Example review.</name>
<permaId>
<id>CR-FOO-21</id>
</permaId>
<permaIdHistory>CR-FOO-21</permaIdHistory>
<projectKey>CR-FOO</projectKey>
<type>REVIEW</type>
</reviewData>
The response is the reviewData containing the added changeset
{
"projectKey" : "CR-FOO",
"name" : "Example review.",
"description" : "Description or statement of objectives for this example review.",
"author" : {
"userName" : "joe",
"displayName" : "Joe Krustofski",
"avatarUrl" : "http://foo.com/avatar"
},
"moderator" : {
"userName" : "scott",
"displayName" : "Scott the Moderator",
"avatarUrl" : "http://foo.com/avatar"
},
"creator" : {
"userName" : "joe",
"displayName" : "Joe Krustofski",
"avatarUrl" : "http://foo.com/avatar"
},
"permaId" : {
"id" : "CR-FOO-21"
},
"permaIdHistory" : [ "CR-FOO-21" ],
"type" : "REVIEW",
"allowReviewersToJoin" : true,
"metricsVersion" : 4,
"createDate" : "2015-04-28T09:47:56.272+0200",
"dueDate" : "2015-04-29T09:47:56.272+0200",
"jiraIssueKey" : "FOO-6754"
}The response is the reviewData containing the added changeset
If a repository name is not specified
If the review is at or over allowed content size limit so new changes cannot be added until some other content is removed from review first. Also if the given patch is too large (contains too many files) for a single review.
| parameter | value | description |
|---|---|---|
|
id |
the review id to get the patches for |
Add the revisions in a patch to an existing review.
If the anchor field is filled Crucible will attempt to anchor the patch to the specified repository/path
If the source field is filled Crucible will attempt to add the patch to the existing patch with the given source name. Both patches need to be anchored to the same repository. Use GET reviews-v1/{id}/patch to get a list of valid sources.
acceptable request representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<addPatch>
<patch>Index: emptytests/notempty/a.txt
===================================================================
diff -u -N -r1.31 -r1.32
--- emptytests/notempty/a.txt 22 Sep 2004 00:38:15 -0000 1.31
+++ emptytests/notempty/a.txt 5 Dec 2004 01:04:25 -0000 1.32
@@ -4,4 +4,5 @@
hello there :D
CRU-123
http://madbean.com/blog/
-!
\ No newline at end of file
+!
+foobie
\ No newline at end of file
Index: test/a.txt
===================================================================
diff -u -N -r1.31 -r1.32
--- test/a.txt 22 Sep 2004 00:38:15 -0000 1.31
+++ test/a.txt 5 Dec 2004 01:04:25 -0000 1.32
@@ -4,4 +4,5 @@
hello there :D
CRU-123
http://madbean.com/blog/
-!
\ No newline at end of file
+!
+foobie
\ No newline at end of file</patch>
<anchor>
<anchorPath>/</anchorPath>
<anchorRepository>REPO</anchorRepository>
<stripCount>2</stripCount>
</anchor>
<source>PATCH:10</source>
</addPatch>
Example of a request document used to create a new review with a patch
{
"patch" : "Index: emptytests/notempty/a.txt\n===================================================================\ndiff -u -N -r1.31 -r1.32\n--- emptytests/notempty/a.txt\t22 Sep 2004 00:38:15 -0000\t1.31\n+++ emptytests/notempty/a.txt\t5 Dec 2004 01:04:25 -0000\t1.32\n@@ -4,4 +4,5 @@\n hello there :D\n CRU-123\n http://madbean.com/blog/\n-!\n\\ No newline at end of file\n+!\n+foobie\n\\ No newline at end of file\nIndex: test/a.txt\n===================================================================\ndiff -u -N -r1.31 -r1.32\n--- test/a.txt\t22 Sep 2004 00:38:15 -0000\t1.31\n+++ test/a.txt\t5 Dec 2004 01:04:25 -0000\t1.32\n@@ -4,4 +4,5 @@\n hello there :D\n CRU-123\n http://madbean.com/blog/\n-!\n\\ No newline at end of file\n+!\n+foobie\n\\ No newline at end of file",
"anchor" : {
"anchorPath" : "/",
"anchorRepository" : "REPO",
"stripCount" : 2
},
"source" : "PATCH:10"
}Example of a request document used to create a new review with a patch
available response representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<reviewData>
<allowReviewersToJoin>true</allowReviewersToJoin>
<author>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Joe Krustofski</displayName>
<userName>joe</userName>
</author>
<createDate>2015-04-28T09:47:56.272+0200</createDate>
<creator>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Joe Krustofski</displayName>
<userName>joe</userName>
</creator>
<description>Description or statement of objectives for this example review.</description>
<dueDate>2015-04-29T09:47:56.272+0200</dueDate>
<jiraIssueKey>FOO-6754</jiraIssueKey>
<metricsVersion>4</metricsVersion>
<moderator>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Scott the Moderator</displayName>
<userName>scott</userName>
</moderator>
<name>Example review.</name>
<permaId>
<id>CR-FOO-21</id>
</permaId>
<permaIdHistory>CR-FOO-21</permaIdHistory>
<projectKey>CR-FOO</projectKey>
<type>REVIEW</type>
</reviewData>
The response is the reviewData structure for the review being updated
{
"projectKey" : "CR-FOO",
"name" : "Example review.",
"description" : "Description or statement of objectives for this example review.",
"author" : {
"userName" : "joe",
"displayName" : "Joe Krustofski",
"avatarUrl" : "http://foo.com/avatar"
},
"moderator" : {
"userName" : "scott",
"displayName" : "Scott the Moderator",
"avatarUrl" : "http://foo.com/avatar"
},
"creator" : {
"userName" : "joe",
"displayName" : "Joe Krustofski",
"avatarUrl" : "http://foo.com/avatar"
},
"permaId" : {
"id" : "CR-FOO-21"
},
"permaIdHistory" : [ "CR-FOO-21" ],
"type" : "REVIEW",
"allowReviewersToJoin" : true,
"metricsVersion" : 4,
"createDate" : "2015-04-28T09:47:56.272+0200",
"dueDate" : "2015-04-29T09:47:56.272+0200",
"jiraIssueKey" : "FOO-6754"
}The response is the reviewData structure for the review being updated
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<error>
<code>ReviewContentTooLarge</code>
<message>Attempt to add too many revisions to a review - no more than 800 file revisions are allowed.</message>
<stacktrace>com.atlassian.crucible.spi.services.ReviewContentTooLargeException: Attempt to add too many revisions to a review - no more than 800 file revisions are allowed.
at com.atlassian.crucible.spi.rpc.ReviewExampleDocuments.<clinit>(ReviewExampleDocuments.java:126)
at com.atlassian.fisheye.spi.rpc.ServerExampleDocuments.<clinit>(ServerExampleDocuments.java:10)
at sun.misc.Unsafe.ensureClassInitialized(Native Method)
at sun.reflect.UnsafeFieldAccessorFactory.newFieldAccessor(UnsafeFieldAccessorFactory.java:25)
at sun.reflect.ReflectionFactory.newFieldAccessor(ReflectionFactory.java:122)
at java.lang.reflect.Field.acquireFieldAccessor(Field.java:918)
at java.lang.reflect.Field.getFieldAccessor(Field.java:899)
at java.lang.reflect.Field.get(Field.java:358)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedLinkFromTag(ResourceDocletJsonXml.java:649)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedExample(ResourceDocletJsonXml.java:542)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.createRepresentationDocTypes(ResourceDocletJsonXml.java:453)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.addResponseDoc(ResourceDocletJsonXml.java:428)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.start(ResourceDocletJsonXml.java:196)
at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)
at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
at java.lang.reflect.Method.invoke(Method.java:597)
at com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:269)
at com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:143)
at com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)
at com.sun.tools.javadoc.Start.begin(Start.java:128)
at com.sun.tools.javadoc.Main.execute(Main.java:41)
at com.sun.tools.javadoc.Main.main(Main.java:31)
</stacktrace>
</error>
If the review is at or over allowed content size limit so new changes cannot be added until some other content is removed from review first. Also if the given patch is too large (contains too many files) for a single review.
{
"code" : "ReviewContentTooLarge",
"message" : "Attempt to add too many revisions to a review - no more than 800 file revisions are allowed.",
"stacktrace" : "com.atlassian.crucible.spi.services.ReviewContentTooLargeException: Attempt to add too many revisions to a review - no more than 800 file revisions are allowed.\n\tat com.atlassian.crucible.spi.rpc.ReviewExampleDocuments.<clinit>(ReviewExampleDocuments.java:126)\n\tat com.atlassian.fisheye.spi.rpc.ServerExampleDocuments.<clinit>(ServerExampleDocuments.java:10)\n\tat sun.misc.Unsafe.ensureClassInitialized(Native Method)\n\tat sun.reflect.UnsafeFieldAccessorFactory.newFieldAccessor(UnsafeFieldAccessorFactory.java:25)\n\tat sun.reflect.ReflectionFactory.newFieldAccessor(ReflectionFactory.java:122)\n\tat java.lang.reflect.Field.acquireFieldAccessor(Field.java:918)\n\tat java.lang.reflect.Field.getFieldAccessor(Field.java:899)\n\tat java.lang.reflect.Field.get(Field.java:358)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedLinkFromTag(ResourceDocletJsonXml.java:649)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedExample(ResourceDocletJsonXml.java:542)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.createRepresentationDocTypes(ResourceDocletJsonXml.java:453)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.addResponseDoc(ResourceDocletJsonXml.java:428)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.start(ResourceDocletJsonXml.java:196)\n\tat sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)\n\tat sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)\n\tat sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)\n\tat java.lang.reflect.Method.invoke(Method.java:597)\n\tat com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:269)\n\tat com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:143)\n\tat com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)\n\tat com.sun.tools.javadoc.Start.begin(Start.java:128)\n\tat com.sun.tools.javadoc.Main.execute(Main.java:41)\n\tat com.sun.tools.javadoc.Main.main(Main.java:31)\n"
}If the review is at or over allowed content size limit so new changes cannot be added until some other content is removed from review first. Also if the given patch is too large (contains too many files) for a single review.
Get a list of patches and their details for the given review
available response representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<patchGroups>
<patchGroup>
<displayName>diff1.patch (6 minutes ago)</displayName>
<patches>
<patch>
<fileName>diff1.patch</fileName>
<id>5</id>
<uploadDate>2015-04-28T09:47:56.317+02:00</uploadDate>
<url>crucible/cru/CR-1/downloadpatch/5/diff1.patch</url>
</patch>
</patches>
<sourceName>PATCH:5</sourceName>
</patchGroup>
<patchGroup>
<displayName>diff2-iteration1.patch (46 minutes ago) - 3 iterations</displayName>
<patches>
<patch>
<anchor>
<anchorPath>/</anchorPath>
<anchorRepository>SvnRepository</anchorRepository>
<stripCount>0</stripCount>
</anchor>
<fileName>diff2-iteration1.patch</fileName>
<id>50</id>
<uploadDate>2015-04-28T09:47:56.321+02:00</uploadDate>
<url>crucible/cru/CR-1/downloadpatch/50/diff2-iteration1.patch</url>
</patch>
<patch>
<anchor>
<anchorPath>/</anchorPath>
<anchorRepository>SvnRepository</anchorRepository>
<stripCount>0</stripCount>
</anchor>
<fileName>diff2-iteration2.patch</fileName>
<id>51</id>
<uploadDate>2015-04-28T09:47:56.321+02:00</uploadDate>
<url>crucible/cru/CR-1/downloadpatch/51/diff2-iteration2.patch</url>
</patch>
<patch>
<anchor>
<anchorPath>/</anchorPath>
<anchorRepository>SvnRepository</anchorRepository>
<stripCount>0</stripCount>
</anchor>
<fileName>diff2-iteration3.patch</fileName>
<id>52</id>
<uploadDate>2015-04-28T09:47:56.321+02:00</uploadDate>
<url>crucible/cru/CR-1/downloadpatch/52/diff2-iteration3.patch</url>
</patch>
</patches>
<sourceName>PATCH:50</sourceName>
</patchGroup>
</patchGroups>
{
"patchGroup" : [ {
"patches" : [ {
"id" : 5,
"fileName" : "diff1.patch",
"uploadDate" : 1430207276317,
"url" : "crucible/cru/CR-1/downloadpatch/5/diff1.patch"
} ],
"sourceName" : "PATCH:5",
"displayName" : "diff1.patch (6 minutes ago)"
}, {
"patches" : [ {
"id" : 50,
"fileName" : "diff2-iteration1.patch",
"uploadDate" : 1430207276321,
"anchor" : {
"anchorPath" : "/",
"anchorRepository" : "SvnRepository",
"stripCount" : 0
},
"url" : "crucible/cru/CR-1/downloadpatch/50/diff2-iteration1.patch"
}, {
"id" : 51,
"fileName" : "diff2-iteration2.patch",
"uploadDate" : 1430207276321,
"anchor" : {
"anchorPath" : "/",
"anchorRepository" : "SvnRepository",
"stripCount" : 0
},
"url" : "crucible/cru/CR-1/downloadpatch/51/diff2-iteration2.patch"
}, {
"id" : 52,
"fileName" : "diff2-iteration3.patch",
"uploadDate" : 1430207276321,
"anchor" : {
"anchorPath" : "/",
"anchorRepository" : "SvnRepository",
"stripCount" : 0
},
"url" : "crucible/cru/CR-1/downloadpatch/52/diff2-iteration3.patch"
} ],
"sourceName" : "PATCH:50",
"displayName" : "diff2-iteration1.patch (46 minutes ago) - 3 iterations"
} ]
}| parameter | value | description |
|---|---|---|
|
id |
Old, non-restful name. Kept for backwards compatibility. Exactly the same as POSTing to /{id}/patch
acceptable request representations:
available response representations:
Deprecated
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<error>
<code>ReviewContentTooLarge</code>
<message>Attempt to add too many revisions to a review - no more than 800 file revisions are allowed.</message>
<stacktrace>com.atlassian.crucible.spi.services.ReviewContentTooLargeException: Attempt to add too many revisions to a review - no more than 800 file revisions are allowed.
at com.atlassian.crucible.spi.rpc.ReviewExampleDocuments.<clinit>(ReviewExampleDocuments.java:126)
at com.atlassian.fisheye.spi.rpc.ServerExampleDocuments.<clinit>(ServerExampleDocuments.java:10)
at sun.misc.Unsafe.ensureClassInitialized(Native Method)
at sun.reflect.UnsafeFieldAccessorFactory.newFieldAccessor(UnsafeFieldAccessorFactory.java:25)
at sun.reflect.ReflectionFactory.newFieldAccessor(ReflectionFactory.java:122)
at java.lang.reflect.Field.acquireFieldAccessor(Field.java:918)
at java.lang.reflect.Field.getFieldAccessor(Field.java:899)
at java.lang.reflect.Field.get(Field.java:358)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedLinkFromTag(ResourceDocletJsonXml.java:649)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedExample(ResourceDocletJsonXml.java:542)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.createRepresentationDocTypes(ResourceDocletJsonXml.java:453)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.addResponseDoc(ResourceDocletJsonXml.java:428)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.start(ResourceDocletJsonXml.java:196)
at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)
at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
at java.lang.reflect.Method.invoke(Method.java:597)
at com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:269)
at com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:143)
at com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)
at com.sun.tools.javadoc.Start.begin(Start.java:128)
at com.sun.tools.javadoc.Main.execute(Main.java:41)
at com.sun.tools.javadoc.Main.main(Main.java:31)
</stacktrace>
</error>
If the review is at or over allowed content size limit so new changes cannot be added until some other content is removed from review first. Also if the given patch is too large (contains too many files) for a single review.
{
"code" : "ReviewContentTooLarge",
"message" : "Attempt to add too many revisions to a review - no more than 800 file revisions are allowed.",
"stacktrace" : "com.atlassian.crucible.spi.services.ReviewContentTooLargeException: Attempt to add too many revisions to a review - no more than 800 file revisions are allowed.\n\tat com.atlassian.crucible.spi.rpc.ReviewExampleDocuments.<clinit>(ReviewExampleDocuments.java:126)\n\tat com.atlassian.fisheye.spi.rpc.ServerExampleDocuments.<clinit>(ServerExampleDocuments.java:10)\n\tat sun.misc.Unsafe.ensureClassInitialized(Native Method)\n\tat sun.reflect.UnsafeFieldAccessorFactory.newFieldAccessor(UnsafeFieldAccessorFactory.java:25)\n\tat sun.reflect.ReflectionFactory.newFieldAccessor(ReflectionFactory.java:122)\n\tat java.lang.reflect.Field.acquireFieldAccessor(Field.java:918)\n\tat java.lang.reflect.Field.getFieldAccessor(Field.java:899)\n\tat java.lang.reflect.Field.get(Field.java:358)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedLinkFromTag(ResourceDocletJsonXml.java:649)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedExample(ResourceDocletJsonXml.java:542)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.createRepresentationDocTypes(ResourceDocletJsonXml.java:453)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.addResponseDoc(ResourceDocletJsonXml.java:428)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.start(ResourceDocletJsonXml.java:196)\n\tat sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)\n\tat sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)\n\tat sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)\n\tat java.lang.reflect.Method.invoke(Method.java:597)\n\tat com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:269)\n\tat com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:143)\n\tat com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)\n\tat com.sun.tools.javadoc.Start.begin(Start.java:128)\n\tat com.sun.tools.javadoc.Main.execute(Main.java:41)\n\tat com.sun.tools.javadoc.Main.main(Main.java:31)\n"
}If the review is at or over allowed content size limit so new changes cannot be added until some other content is removed from review first. Also if the given patch is too large (contains too many files) for a single review.
| parameter | value | description |
|---|---|---|
|
id |
the id of the review to add to |
Get a list of reviewers in the review given by the permaid id.
available response representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<reviewers>
<reviewer>
<avatarUrl>http://gravatar.com/url/2</avatarUrl>
<displayName>display name of user2</displayName>
<userName>user2</userName>
<completed>true</completed>
</reviewer>
<reviewer>
<avatarUrl>http://gravatar.com/url/1</avatarUrl>
<displayName>display name of user1</displayName>
<userName>user1</userName>
<completed>false</completed>
</reviewer>
<reviewer>
<avatarUrl>http://gravatar.com/url/4</avatarUrl>
<displayName>display name of user4</displayName>
<userName>user4</userName>
<completed>true</completed>
</reviewer>
<reviewer>
<avatarUrl>http://gravatar.com/url/3</avatarUrl>
<displayName>display name of user3</displayName>
<userName>user3</userName>
<completed>false</completed>
</reviewer>
</reviewers>
A list of reviewers and whether they've completed the review or now.
{
"reviewer" : [ {
"userName" : "user2",
"displayName" : "display name of user2",
"avatarUrl" : "http://gravatar.com/url/2",
"completed" : true
}, {
"userName" : "user1",
"displayName" : "display name of user1",
"avatarUrl" : "http://gravatar.com/url/1",
"completed" : false
}, {
"userName" : "user4",
"displayName" : "display name of user4",
"avatarUrl" : "http://gravatar.com/url/4",
"completed" : true
}, {
"userName" : "user3",
"displayName" : "display name of user3",
"avatarUrl" : "http://gravatar.com/url/3",
"completed" : false
} ]
}A list of reviewers and whether they've completed the review or now.
Adds the given list of reviewers to the review.
acceptable request representations:
| parameter | value | description |
|---|---|---|
|
id |
the review perma id to retrieve reviewers |
Gets a list of completed reviewers.
available response representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<reviewers>
<reviewer>
<avatarUrl>http://gravatar.com/url/2</avatarUrl>
<displayName>display name of user2</displayName>
<userName>user2</userName>
<completed>true</completed>
</reviewer>
<reviewer>
<avatarUrl>http://gravatar.com/url/1</avatarUrl>
<displayName>display name of user1</displayName>
<userName>user1</userName>
<completed>true</completed>
</reviewer>
<reviewer>
<avatarUrl>http://gravatar.com/url/4</avatarUrl>
<displayName>display name of user4</displayName>
<userName>user4</userName>
<completed>true</completed>
</reviewer>
<reviewer>
<avatarUrl>http://gravatar.com/url/3</avatarUrl>
<displayName>display name of user3</displayName>
<userName>user3</userName>
<completed>true</completed>
</reviewer>
</reviewers>
A list of reviewers that have completed the review.
{
"reviewer" : [ {
"userName" : "user2",
"displayName" : "display name of user2",
"avatarUrl" : "http://gravatar.com/url/2",
"completed" : true
}, {
"userName" : "user1",
"displayName" : "display name of user1",
"avatarUrl" : "http://gravatar.com/url/1",
"completed" : true
}, {
"userName" : "user4",
"displayName" : "display name of user4",
"avatarUrl" : "http://gravatar.com/url/4",
"completed" : true
}, {
"userName" : "user3",
"displayName" : "display name of user3",
"avatarUrl" : "http://gravatar.com/url/3",
"completed" : true
} ]
}A list of reviewers that have completed the review.
| parameter | value | description |
|---|---|---|
|
id |
the review perma id to retrieve reviewers |
Gets a list of reviewers that have not completed the review.
available response representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<reviewers>
<reviewer>
<avatarUrl>http://gravatar.com/url/2</avatarUrl>
<displayName>display name of user2</displayName>
<userName>user2</userName>
<completed>false</completed>
</reviewer>
<reviewer>
<avatarUrl>http://gravatar.com/url/1</avatarUrl>
<displayName>display name of user1</displayName>
<userName>user1</userName>
<completed>false</completed>
</reviewer>
<reviewer>
<avatarUrl>http://gravatar.com/url/4</avatarUrl>
<displayName>display name of user4</displayName>
<userName>user4</userName>
<completed>false</completed>
</reviewer>
<reviewer>
<avatarUrl>http://gravatar.com/url/3</avatarUrl>
<displayName>display name of user3</displayName>
<userName>user3</userName>
<completed>false</completed>
</reviewer>
</reviewers>
A list of reviewers that have not completed the review.
{
"reviewer" : [ {
"userName" : "user2",
"displayName" : "display name of user2",
"avatarUrl" : "http://gravatar.com/url/2",
"completed" : false
}, {
"userName" : "user1",
"displayName" : "display name of user1",
"avatarUrl" : "http://gravatar.com/url/1",
"completed" : false
}, {
"userName" : "user4",
"displayName" : "display name of user4",
"avatarUrl" : "http://gravatar.com/url/4",
"completed" : false
}, {
"userName" : "user3",
"displayName" : "display name of user3",
"avatarUrl" : "http://gravatar.com/url/3",
"completed" : false
} ]
}A list of reviewers that have not completed the review.
| parameter | value | description |
|---|---|---|
|
id |
the perma id of the review |
|
|
username |
the name of the reviewer. |
Removes the reviewer from the review.
| parameter | value | description |
|---|---|---|
|
id |
the id of the review (e.g. "CR-362"). |
Returns a list of all the items in a review.
available response representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<reviewItems>
<reviewItem>
<participants>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Fred Eaglesmith</displayName>
<userName>fred</userName>
</user>
<completed>false</completed>
</participant>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Corb Lund</displayName>
<userName>clund</userName>
</user>
<completed>false</completed>
</participant>
</participants>
<permId>
<id>CFR-7453</id>
</permId>
<authorName>evzijst</authorName>
<commitDate>2015-04-28T09:47:56.304+02:00</commitDate>
<commitType>Modified</commitType>
<fileType>File</fileType>
<fromContentUrl>/context/cru/CR-123/rawcontent/5622//project/trunk/pom.xml</fromContentUrl>
<fromPath>/project/trunk/pom.xml</fromPath>
<fromRevision>688</fromRevision>
<repositoryName>REPO</repositoryName>
<showAsDiff>true</showAsDiff>
<toContentUrl>/context/cru/CR-123/rawcontent/5656//project/trunk/pom.xml</toContentUrl>
<toPath>/project/trunk/pom.xml</toPath>
<toRevision>6881</toRevision>
</reviewItem>
</reviewItems>
A list of all the items in the review.
{
"reviewItem" : [ {
"permId" : {
"id" : "CFR-7453"
},
"participants" : [ {
"user" : {
"userName" : "fred",
"displayName" : "Fred Eaglesmith",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
}, {
"user" : {
"userName" : "clund",
"displayName" : "Corb Lund",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
} ],
"repositoryName" : "REPO",
"fromPath" : "/project/trunk/pom.xml",
"fromRevision" : "688",
"fromContentUrl" : "/context/cru/CR-123/rawcontent/5622//project/trunk/pom.xml",
"toPath" : "/project/trunk/pom.xml",
"toRevision" : "6881",
"toContentUrl" : "/context/cru/CR-123/rawcontent/5656//project/trunk/pom.xml",
"fileType" : "File",
"commitType" : "Modified",
"authorName" : "evzijst",
"showAsDiff" : true,
"commitDate" : 1430207276304
} ]
}A list of all the items in the review.
Add the changes between two files in a fisheye repository to the review.
This call includes the Location repsonse header that
contains the URL of the newly created entity.
acceptable request representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<reviewItem>
<participants/>
<permId/>
<revisions size="0"/>
<fromPath>/project/trunk/pom.xml</fromPath>
<fromRevision>688</fromRevision>
<repositoryName>REPO</repositoryName>
<toPath>/project/trunk/pom.xml</toPath>
<toRevision>689</toRevision>
</reviewItem>
{
"permId" : {
},
"participants" : [ ],
"revisions" : {
"size" : 0
},
"repositoryName" : "REPO",
"fromPath" : "/project/trunk/pom.xml",
"fromRevision" : "688",
"toPath" : "/project/trunk/pom.xml",
"toRevision" : "689"
}available response representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<reviewItem>
<participants>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Fred Eaglesmith</displayName>
<userName>fred</userName>
</user>
<completed>false</completed>
</participant>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Corb Lund</displayName>
<userName>clund</userName>
</user>
<completed>false</completed>
</participant>
</participants>
<permId>
<id>CFR-7453</id>
</permId>
<authorName>evzijst</authorName>
<commitDate>2015-04-28T09:47:56.304+02:00</commitDate>
<commitType>Modified</commitType>
<fileType>File</fileType>
<fromContentUrl>/context/cru/CR-123/rawcontent/5622//project/trunk/pom.xml</fromContentUrl>
<fromPath>/project/trunk/pom.xml</fromPath>
<fromRevision>688</fromRevision>
<repositoryName>REPO</repositoryName>
<showAsDiff>true</showAsDiff>
<toContentUrl>/context/cru/CR-123/rawcontent/5656//project/trunk/pom.xml</toContentUrl>
<toPath>/project/trunk/pom.xml</toPath>
<toRevision>6881</toRevision>
</reviewItem>
A reviewItem element containing details of the diff added to the review.
{
"permId" : {
"id" : "CFR-7453"
},
"participants" : [ {
"user" : {
"userName" : "fred",
"displayName" : "Fred Eaglesmith",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
}, {
"user" : {
"userName" : "clund",
"displayName" : "Corb Lund",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
} ],
"repositoryName" : "REPO",
"fromPath" : "/project/trunk/pom.xml",
"fromRevision" : "688",
"fromContentUrl" : "/context/cru/CR-123/rawcontent/5622//project/trunk/pom.xml",
"toPath" : "/project/trunk/pom.xml",
"toRevision" : "6881",
"toContentUrl" : "/context/cru/CR-123/rawcontent/5656//project/trunk/pom.xml",
"fileType" : "File",
"commitType" : "Modified",
"authorName" : "evzijst",
"showAsDiff" : true,
"commitDate" : 1430207276304
}A reviewItem element containing details of the diff added to the review.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<error>
<code>ReviewContentTooLarge</code>
<message>Attempt to add too many revisions to a review - no more than 800 file revisions are allowed.</message>
<stacktrace>com.atlassian.crucible.spi.services.ReviewContentTooLargeException: Attempt to add too many revisions to a review - no more than 800 file revisions are allowed.
at com.atlassian.crucible.spi.rpc.ReviewExampleDocuments.<clinit>(ReviewExampleDocuments.java:126)
at com.atlassian.fisheye.spi.rpc.ServerExampleDocuments.<clinit>(ServerExampleDocuments.java:10)
at sun.misc.Unsafe.ensureClassInitialized(Native Method)
at sun.reflect.UnsafeFieldAccessorFactory.newFieldAccessor(UnsafeFieldAccessorFactory.java:25)
at sun.reflect.ReflectionFactory.newFieldAccessor(ReflectionFactory.java:122)
at java.lang.reflect.Field.acquireFieldAccessor(Field.java:918)
at java.lang.reflect.Field.getFieldAccessor(Field.java:899)
at java.lang.reflect.Field.get(Field.java:358)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedLinkFromTag(ResourceDocletJsonXml.java:649)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedExample(ResourceDocletJsonXml.java:542)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.createRepresentationDocTypes(ResourceDocletJsonXml.java:453)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.addResponseDoc(ResourceDocletJsonXml.java:428)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.start(ResourceDocletJsonXml.java:196)
at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)
at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
at java.lang.reflect.Method.invoke(Method.java:597)
at com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:269)
at com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:143)
at com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)
at com.sun.tools.javadoc.Start.begin(Start.java:128)
at com.sun.tools.javadoc.Main.execute(Main.java:41)
at com.sun.tools.javadoc.Main.main(Main.java:31)
</stacktrace>
</error>
If the review is at or over allowed content size limit so new changes cannot be added until some other content is removed from review first.
{
"code" : "ReviewContentTooLarge",
"message" : "Attempt to add too many revisions to a review - no more than 800 file revisions are allowed.",
"stacktrace" : "com.atlassian.crucible.spi.services.ReviewContentTooLargeException: Attempt to add too many revisions to a review - no more than 800 file revisions are allowed.\n\tat com.atlassian.crucible.spi.rpc.ReviewExampleDocuments.<clinit>(ReviewExampleDocuments.java:126)\n\tat com.atlassian.fisheye.spi.rpc.ServerExampleDocuments.<clinit>(ServerExampleDocuments.java:10)\n\tat sun.misc.Unsafe.ensureClassInitialized(Native Method)\n\tat sun.reflect.UnsafeFieldAccessorFactory.newFieldAccessor(UnsafeFieldAccessorFactory.java:25)\n\tat sun.reflect.ReflectionFactory.newFieldAccessor(ReflectionFactory.java:122)\n\tat java.lang.reflect.Field.acquireFieldAccessor(Field.java:918)\n\tat java.lang.reflect.Field.getFieldAccessor(Field.java:899)\n\tat java.lang.reflect.Field.get(Field.java:358)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedLinkFromTag(ResourceDocletJsonXml.java:649)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedExample(ResourceDocletJsonXml.java:542)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.createRepresentationDocTypes(ResourceDocletJsonXml.java:453)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.addResponseDoc(ResourceDocletJsonXml.java:428)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.start(ResourceDocletJsonXml.java:196)\n\tat sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)\n\tat sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)\n\tat sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)\n\tat java.lang.reflect.Method.invoke(Method.java:597)\n\tat com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:269)\n\tat com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:143)\n\tat com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)\n\tat com.sun.tools.javadoc.Start.begin(Start.java:128)\n\tat com.sun.tools.javadoc.Main.execute(Main.java:41)\n\tat com.sun.tools.javadoc.Main.main(Main.java:31)\n"
}If the review is at or over allowed content size limit so new changes cannot be added until some other content is removed from review first.
| parameter | value | description |
|---|---|---|
|
id |
the id of the review (e.g. "CR-362"). |
Adds a review item for each of the supplied crucibleRevisionData elements.
Provide a list of crucibleRevisionData elements, each one containing the desired shape of the review item. If a crucibleRevisionData element contains a path that already exists (i.e., an existing review item with the same path is in the review), then the crucibleRevisionData element given here will merge the revisions with the existing review item revisions instead of creating a new review item.
acceptable request representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<revisions>
<revisionData>
<rev>688</rev>
<rev>689</rev>
<source>REPO</source>
<path>/project/trunk/pom.xml</path>
</revisionData>
</revisions>
{
"revisionData" : [ {
"source" : "REPO",
"path" : "/project/trunk/pom.xml",
"rev" : [ "688", "689" ]
} ]
}available response representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<detailedReviewData>
<allowReviewersToJoin>true</allowReviewersToJoin>
<author>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Joe Krustofski</displayName>
<userName>joe</userName>
</author>
<createDate>2015-04-28T09:47:56.272+0200</createDate>
<creator>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Joe Krustofski</displayName>
<userName>joe</userName>
</creator>
<description>Description or statement of objectives for this example review.</description>
<dueDate>2015-04-29T09:47:56.272+0200</dueDate>
<jiraIssueKey>FOO-6754</jiraIssueKey>
<metricsVersion>4</metricsVersion>
<moderator>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Scott the Moderator</displayName>
<userName>scott</userName>
</moderator>
<name>Example review.</name>
<permaId>
<id>CR-FOO-21</id>
</permaId>
<permaIdHistory>CR-FOO-21</permaIdHistory>
<projectKey>CR-FOO</projectKey>
<type>REVIEW</type>
<actions>
<actionData>
<displayName>Abandon</displayName>
<name>action:abandonReview</name>
</actionData>
<actionData>
<displayName>Approve</displayName>
<name>action:approveReview</name>
</actionData>
<actionData>
<displayName>Comment</displayName>
<name>action:commentOnReview</name>
</actionData>
<actionData>
<displayName>Complete</displayName>
<name>action:completeReview</name>
</actionData>
<actionData>
<displayName>Edit Review Details</displayName>
<name>action:modifyReviewFiles</name>
</actionData>
</actions>
<generalComments>
<generalCommentData>
<createDate>2015-04-28T09:47:56.281+0200</createDate>
<defectApproved>false</defectApproved>
<defectRaised>false</defectRaised>
<deleted>false</deleted>
<draft>false</draft>
<message>I thought you said you were going to *remove* this line?</message>
<messageAsHtml>I thought you said you were going to <b>remove</b> this line?</messageAsHtml>
<metrics/>
<parentCommentId/>
<readStatus>UNREAD</readStatus>
<replies/>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Joe Bloggs</displayName>
<userName>joe</userName>
</user>
<permId>
<id>CR:1</id>
</permId>
<permaId>
<id>CR:1</id>
</permaId>
</generalCommentData>
</generalComments>
<reviewItems>
<reviewItem>
<participants>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Fred Eaglesmith</displayName>
<userName>fred</userName>
</user>
<completed>false</completed>
</participant>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Corb Lund</displayName>
<userName>clund</userName>
</user>
<completed>false</completed>
</participant>
</participants>
<permId>
<id>CFR-65</id>
</permId>
<anchorData>
<anchorPath>trunk</anchorPath>
<anchorRepository>REPO</anchorRepository>
<stripCount>0</stripCount>
</anchorData>
<authorName>evzijst</authorName>
<commitDate>2015-04-28T09:47:56.310+02:00</commitDate>
<commitType>Modified</commitType>
<fileType>File</fileType>
<fromContentUrl>/context/cru/CR-FOO-21/rawcontent/5687/dir64/a.txt</fromContentUrl>
<fromPath>dir64/a.txt</fromPath>
<fromRevision>65</fromRevision>
<patchUrl>/contextcru/CR-FOO-21/downloadpatch/6238/patch-7126.patch</patchUrl>
<repositoryName>REPO</repositoryName>
<showAsDiff>false</showAsDiff>
<toContentUrl>/context/cru/CR-FOO-21/rawcontent/6675/dir64/a.txt</toContentUrl>
<toPath>dir64/a.txt</toPath>
<toRevision>651</toRevision>
</reviewItem>
<reviewItem>
<participants>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Fred Eaglesmith</displayName>
<userName>fred</userName>
</user>
<completed>false</completed>
</participant>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Corb Lund</displayName>
<userName>clund</userName>
</user>
<completed>false</completed>
</participant>
</participants>
<permId>
<id>CFR-66</id>
</permId>
<anchorData>
<anchorPath>branches/branch1</anchorPath>
<anchorRepository>REPO</anchorRepository>
<stripCount>0</stripCount>
</anchorData>
<authorName>evzijst</authorName>
<commitDate>2015-04-28T09:47:56.310+02:00</commitDate>
<commitType>Modified</commitType>
<fileType>File</fileType>
<fromContentUrl>/context/cru/CR-FOO-21/rawcontent/5690/dir65/d.txt</fromContentUrl>
<fromPath>dir65/d.txt</fromPath>
<fromRevision>66</fromRevision>
<patchUrl>/contextcru/CR-FOO-21/downloadpatch/6273/patch-6173.patch</patchUrl>
<repositoryName>REPO</repositoryName>
<showAsDiff>true</showAsDiff>
<toContentUrl>/context/cru/CR-FOO-21/rawcontent/6085/dir65/d.txt</toContentUrl>
<toPath>dir65/d.txt</toPath>
<toRevision>661</toRevision>
</reviewItem>
<reviewItem>
<participants>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Fred Eaglesmith</displayName>
<userName>fred</userName>
</user>
<completed>false</completed>
</participant>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Corb Lund</displayName>
<userName>clund</userName>
</user>
<completed>false</completed>
</participant>
</participants>
<permId>
<id>CFR-67</id>
</permId>
<anchorData>
<anchorPath>branches/branch1</anchorPath>
<anchorRepository>REPO</anchorRepository>
<stripCount>0</stripCount>
</anchorData>
<authorName>evzijst</authorName>
<commitDate>2015-04-28T09:47:56.310+02:00</commitDate>
<commitType>Modified</commitType>
<fileType>File</fileType>
<fromContentUrl>/context/cru/CR-FOO-21/rawcontent/5693/dir66/c.txt</fromContentUrl>
<fromPath>dir66/c.txt</fromPath>
<fromRevision>67</fromRevision>
<patchUrl>/contextcru/CR-FOO-21/downloadpatch/6281/patch-9135.patch</patchUrl>
<repositoryName>REPO</repositoryName>
<showAsDiff>false</showAsDiff>
<toContentUrl>/context/cru/CR-FOO-21/rawcontent/5909/dir66/c.txt</toContentUrl>
<toPath>dir66/c.txt</toPath>
<toRevision>671</toRevision>
</reviewItem>
<reviewItem>
<participants>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Fred Eaglesmith</displayName>
<userName>fred</userName>
</user>
<completed>false</completed>
</participant>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Corb Lund</displayName>
<userName>clund</userName>
</user>
<completed>false</completed>
</participant>
</participants>
<permId>
<id>CFR-68</id>
</permId>
<anchorData>
<anchorPath>tags/tag1</anchorPath>
<anchorRepository>REPO</anchorRepository>
<stripCount>0</stripCount>
</anchorData>
<authorName>evzijst</authorName>
<commitDate>2015-04-28T09:47:56.310+02:00</commitDate>
<commitType>Modified</commitType>
<fileType>File</fileType>
<fromContentUrl>/context/cru/CR-FOO-21/rawcontent/5696/dir67/b.txt</fromContentUrl>
<fromPath>dir67/b.txt</fromPath>
<fromRevision>68</fromRevision>
<patchUrl>/contextcru/CR-FOO-21/downloadpatch/6394/patch-6062.patch</patchUrl>
<repositoryName>REPO</repositoryName>
<showAsDiff>true</showAsDiff>
<toContentUrl>/context/cru/CR-FOO-21/rawcontent/5789/dir67/b.txt</toContentUrl>
<toPath>dir67/b.txt</toPath>
<toRevision>681</toRevision>
</reviewItem>
<reviewItem>
<participants>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Fred Eaglesmith</displayName>
<userName>fred</userName>
</user>
<completed>false</completed>
</participant>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Corb Lund</displayName>
<userName>clund</userName>
</user>
<completed>false</completed>
</participant>
</participants>
<permId>
<id>CFR-69</id>
</permId>
<authorName>evzijst</authorName>
<commitDate>2015-04-28T09:47:56.310+02:00</commitDate>
<commitType>Modified</commitType>
<fileType>File</fileType>
<fromContentUrl>/context/cru/CR-FOO-21/rawcontent/5698/dir68/d.txt</fromContentUrl>
<fromPath>dir68/d.txt</fromPath>
<fromRevision>69</fromRevision>
<repositoryName>REPO</repositoryName>
<showAsDiff>false</showAsDiff>
<toContentUrl>/context/cru/CR-FOO-21/rawcontent/6394/dir68/d.txt</toContentUrl>
<toPath>dir68/d.txt</toPath>
<toRevision>691</toRevision>
</reviewItem>
<reviewItem>
<participants>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Fred Eaglesmith</displayName>
<userName>fred</userName>
</user>
<completed>false</completed>
</participant>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Corb Lund</displayName>
<userName>clund</userName>
</user>
<completed>false</completed>
</participant>
</participants>
<permId>
<id>CFR-70</id>
</permId>
<authorName>evzijst</authorName>
<commitDate>2015-04-28T09:47:56.311+02:00</commitDate>
<commitType>Modified</commitType>
<fileType>File</fileType>
<fromContentUrl>/context/cru/CR-FOO-21/rawcontent/5700/dir69/e.txt</fromContentUrl>
<fromPath>dir69/e.txt</fromPath>
<fromRevision>70</fromRevision>
<repositoryName>REPO</repositoryName>
<showAsDiff>true</showAsDiff>
<toContentUrl>/context/cru/CR-FOO-21/rawcontent/6164/dir69/e.txt</toContentUrl>
<toPath>dir69/e.txt</toPath>
<toRevision>701</toRevision>
</reviewItem>
<reviewItem>
<participants>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Fred Eaglesmith</displayName>
<userName>fred</userName>
</user>
<completed>false</completed>
</participant>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Corb Lund</displayName>
<userName>clund</userName>
</user>
<completed>false</completed>
</participant>
</participants>
<permId>
<id>CFR-71</id>
</permId>
<authorName>evzijst</authorName>
<commitDate>2015-04-28T09:47:56.311+02:00</commitDate>
<commitType>Modified</commitType>
<fileType>File</fileType>
<fromContentUrl>/context/cru/CR-FOO-21/rawcontent/5702/dir70/f.txt</fromContentUrl>
<fromPath>dir70/f.txt</fromPath>
<fromRevision>71</fromRevision>
<repositoryName>REPO</repositoryName>
<showAsDiff>false</showAsDiff>
<toContentUrl>/context/cru/CR-FOO-21/rawcontent/6679/dir70/f.txt</toContentUrl>
<toPath>dir70/f.txt</toPath>
<toRevision>711</toRevision>
</reviewItem>
</reviewItems>
<transitions>
<transitionData>
<displayName>Summarize</displayName>
<name>action:summarizeReview</name>
</transitionData>
</transitions>
</detailedReviewData>
A detailedReviewData element object with the added crucibleRevisionData elements.
{
"projectKey" : "CR-FOO",
"name" : "Example review.",
"description" : "Description or statement of objectives for this example review.",
"author" : {
"userName" : "joe",
"displayName" : "Joe Krustofski",
"avatarUrl" : "http://foo.com/avatar"
},
"moderator" : {
"userName" : "scott",
"displayName" : "Scott the Moderator",
"avatarUrl" : "http://foo.com/avatar"
},
"creator" : {
"userName" : "joe",
"displayName" : "Joe Krustofski",
"avatarUrl" : "http://foo.com/avatar"
},
"permaId" : {
"id" : "CR-FOO-21"
},
"permaIdHistory" : [ "CR-FOO-21" ],
"type" : "REVIEW",
"allowReviewersToJoin" : true,
"metricsVersion" : 4,
"createDate" : "2015-04-28T09:47:56.272+0200",
"dueDate" : "2015-04-29T09:47:56.272+0200",
"jiraIssueKey" : "FOO-6754",
"reviewItems" : {
"reviewItem" : [ {
"permId" : {
"id" : "CFR-65"
},
"participants" : [ {
"user" : {
"userName" : "fred",
"displayName" : "Fred Eaglesmith",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
}, {
"user" : {
"userName" : "clund",
"displayName" : "Corb Lund",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
} ],
"repositoryName" : "REPO",
"fromPath" : "dir64/a.txt",
"fromRevision" : "65",
"fromContentUrl" : "/context/cru/CR-FOO-21/rawcontent/5687/dir64/a.txt",
"toPath" : "dir64/a.txt",
"toRevision" : "651",
"toContentUrl" : "/context/cru/CR-FOO-21/rawcontent/6675/dir64/a.txt",
"patchUrl" : "/contextcru/CR-FOO-21/downloadpatch/6238/patch-7126.patch",
"fileType" : "File",
"commitType" : "Modified",
"authorName" : "evzijst",
"showAsDiff" : false,
"anchorData" : {
"anchorPath" : "trunk",
"anchorRepository" : "REPO",
"stripCount" : 0
},
"commitDate" : 1430207276310,
"expandedRevisions" : [ ]
}, {
"permId" : {
"id" : "CFR-66"
},
"participants" : [ {
"user" : {
"userName" : "fred",
"displayName" : "Fred Eaglesmith",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
}, {
"user" : {
"userName" : "clund",
"displayName" : "Corb Lund",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
} ],
"repositoryName" : "REPO",
"fromPath" : "dir65/d.txt",
"fromRevision" : "66",
"fromContentUrl" : "/context/cru/CR-FOO-21/rawcontent/5690/dir65/d.txt",
"toPath" : "dir65/d.txt",
"toRevision" : "661",
"toContentUrl" : "/context/cru/CR-FOO-21/rawcontent/6085/dir65/d.txt",
"patchUrl" : "/contextcru/CR-FOO-21/downloadpatch/6273/patch-6173.patch",
"fileType" : "File",
"commitType" : "Modified",
"authorName" : "evzijst",
"showAsDiff" : true,
"anchorData" : {
"anchorPath" : "branches/branch1",
"anchorRepository" : "REPO",
"stripCount" : 0
},
"commitDate" : 1430207276310,
"expandedRevisions" : [ ]
}, {
"permId" : {
"id" : "CFR-67"
},
"participants" : [ {
"user" : {
"userName" : "fred",
"displayName" : "Fred Eaglesmith",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
}, {
"user" : {
"userName" : "clund",
"displayName" : "Corb Lund",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
} ],
"repositoryName" : "REPO",
"fromPath" : "dir66/c.txt",
"fromRevision" : "67",
"fromContentUrl" : "/context/cru/CR-FOO-21/rawcontent/5693/dir66/c.txt",
"toPath" : "dir66/c.txt",
"toRevision" : "671",
"toContentUrl" : "/context/cru/CR-FOO-21/rawcontent/5909/dir66/c.txt",
"patchUrl" : "/contextcru/CR-FOO-21/downloadpatch/6281/patch-9135.patch",
"fileType" : "File",
"commitType" : "Modified",
"authorName" : "evzijst",
"showAsDiff" : false,
"anchorData" : {
"anchorPath" : "branches/branch1",
"anchorRepository" : "REPO",
"stripCount" : 0
},
"commitDate" : 1430207276310,
"expandedRevisions" : [ ]
}, {
"permId" : {
"id" : "CFR-68"
},
"participants" : [ {
"user" : {
"userName" : "fred",
"displayName" : "Fred Eaglesmith",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
}, {
"user" : {
"userName" : "clund",
"displayName" : "Corb Lund",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
} ],
"repositoryName" : "REPO",
"fromPath" : "dir67/b.txt",
"fromRevision" : "68",
"fromContentUrl" : "/context/cru/CR-FOO-21/rawcontent/5696/dir67/b.txt",
"toPath" : "dir67/b.txt",
"toRevision" : "681",
"toContentUrl" : "/context/cru/CR-FOO-21/rawcontent/5789/dir67/b.txt",
"patchUrl" : "/contextcru/CR-FOO-21/downloadpatch/6394/patch-6062.patch",
"fileType" : "File",
"commitType" : "Modified",
"authorName" : "evzijst",
"showAsDiff" : true,
"anchorData" : {
"anchorPath" : "tags/tag1",
"anchorRepository" : "REPO",
"stripCount" : 0
},
"commitDate" : 1430207276310,
"expandedRevisions" : [ ]
}, {
"permId" : {
"id" : "CFR-69"
},
"participants" : [ {
"user" : {
"userName" : "fred",
"displayName" : "Fred Eaglesmith",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
}, {
"user" : {
"userName" : "clund",
"displayName" : "Corb Lund",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
} ],
"repositoryName" : "REPO",
"fromPath" : "dir68/d.txt",
"fromRevision" : "69",
"fromContentUrl" : "/context/cru/CR-FOO-21/rawcontent/5698/dir68/d.txt",
"toPath" : "dir68/d.txt",
"toRevision" : "691",
"toContentUrl" : "/context/cru/CR-FOO-21/rawcontent/6394/dir68/d.txt",
"fileType" : "File",
"commitType" : "Modified",
"authorName" : "evzijst",
"showAsDiff" : false,
"commitDate" : 1430207276310,
"expandedRevisions" : [ ]
}, {
"permId" : {
"id" : "CFR-70"
},
"participants" : [ {
"user" : {
"userName" : "fred",
"displayName" : "Fred Eaglesmith",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
}, {
"user" : {
"userName" : "clund",
"displayName" : "Corb Lund",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
} ],
"repositoryName" : "REPO",
"fromPath" : "dir69/e.txt",
"fromRevision" : "70",
"fromContentUrl" : "/context/cru/CR-FOO-21/rawcontent/5700/dir69/e.txt",
"toPath" : "dir69/e.txt",
"toRevision" : "701",
"toContentUrl" : "/context/cru/CR-FOO-21/rawcontent/6164/dir69/e.txt",
"fileType" : "File",
"commitType" : "Modified",
"authorName" : "evzijst",
"showAsDiff" : true,
"commitDate" : 1430207276311,
"expandedRevisions" : [ ]
}, {
"permId" : {
"id" : "CFR-71"
},
"participants" : [ {
"user" : {
"userName" : "fred",
"displayName" : "Fred Eaglesmith",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
}, {
"user" : {
"userName" : "clund",
"displayName" : "Corb Lund",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
} ],
"repositoryName" : "REPO",
"fromPath" : "dir70/f.txt",
"fromRevision" : "71",
"fromContentUrl" : "/context/cru/CR-FOO-21/rawcontent/5702/dir70/f.txt",
"toPath" : "dir70/f.txt",
"toRevision" : "711",
"toContentUrl" : "/context/cru/CR-FOO-21/rawcontent/6679/dir70/f.txt",
"fileType" : "File",
"commitType" : "Modified",
"authorName" : "evzijst",
"showAsDiff" : false,
"commitDate" : 1430207276311,
"expandedRevisions" : [ ]
} ]
},
"generalComments" : {
"comments" : [ {
"metrics" : {
},
"message" : "I thought you said you were going to *remove* this line?",
"draft" : false,
"deleted" : false,
"defectRaised" : false,
"defectApproved" : false,
"readStatus" : "UNREAD",
"user" : {
"userName" : "joe",
"displayName" : "Joe Bloggs",
"avatarUrl" : "http://foo.com/avatar"
},
"createDate" : "2015-04-28T09:47:56.281+0200",
"permaId" : {
"id" : "CR:1"
},
"replies" : [ ],
"messageAsHtml" : "I thought you said you were going to <b>remove</b> this line?",
"permId" : {
"id" : "CR:1"
},
"parentCommentId" : {
}
} ]
},
"transitions" : {
"transitionData" : [ {
"name" : "action:summarizeReview",
"displayName" : "Summarize"
} ]
},
"actions" : {
"actionData" : [ {
"name" : "action:abandonReview",
"displayName" : "Abandon"
}, {
"name" : "action:approveReview",
"displayName" : "Approve"
}, {
"name" : "action:commentOnReview",
"displayName" : "Comment"
}, {
"name" : "action:completeReview",
"displayName" : "Complete"
}, {
"name" : "action:modifyReviewFiles",
"displayName" : "Edit Review Details"
} ]
}
}A detailedReviewData element object with the added crucibleRevisionData elements.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<error>
<code>IllegalArgument</code>
<message>Invalid input.</message>
<stacktrace>java.lang.IllegalArgumentException: Invalid input.
at com.atlassian.crucible.spi.rpc.ExampleDocuments.<clinit>(ExampleDocuments.java:39)
at sun.misc.Unsafe.ensureClassInitialized(Native Method)
at sun.reflect.UnsafeFieldAccessorFactory.newFieldAccessor(UnsafeFieldAccessorFactory.java:25)
at sun.reflect.ReflectionFactory.newFieldAccessor(ReflectionFactory.java:122)
at java.lang.reflect.Field.acquireFieldAccessor(Field.java:918)
at java.lang.reflect.Field.getFieldAccessor(Field.java:899)
at java.lang.reflect.Field.get(Field.java:358)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedLinkFromTag(ResourceDocletJsonXml.java:649)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedExample(ResourceDocletJsonXml.java:542)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.createRepresentationDocTypes(ResourceDocletJsonXml.java:453)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.addResponseDoc(ResourceDocletJsonXml.java:428)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.start(ResourceDocletJsonXml.java:196)
at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)
at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
at java.lang.reflect.Method.invoke(Method.java:597)
at com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:269)
at com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:143)
at com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)
at com.sun.tools.javadoc.Start.begin(Start.java:128)
at com.sun.tools.javadoc.Main.execute(Main.java:41)
at com.sun.tools.javadoc.Main.main(Main.java:31)
</stacktrace>
</error>
If the repository does not exist for one or more of the given crucibleRevisionData elements, or if one or more of the paths does not exist in the repository specified in the crucibleRevisionData elements, or if a revision specified in the crucibleRevisionData elements does not exist.
{
"code" : "IllegalArgument",
"message" : "Invalid input.",
"stacktrace" : "java.lang.IllegalArgumentException: Invalid input.\n\tat com.atlassian.crucible.spi.rpc.ExampleDocuments.<clinit>(ExampleDocuments.java:39)\n\tat sun.misc.Unsafe.ensureClassInitialized(Native Method)\n\tat sun.reflect.UnsafeFieldAccessorFactory.newFieldAccessor(UnsafeFieldAccessorFactory.java:25)\n\tat sun.reflect.ReflectionFactory.newFieldAccessor(ReflectionFactory.java:122)\n\tat java.lang.reflect.Field.acquireFieldAccessor(Field.java:918)\n\tat java.lang.reflect.Field.getFieldAccessor(Field.java:899)\n\tat java.lang.reflect.Field.get(Field.java:358)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedLinkFromTag(ResourceDocletJsonXml.java:649)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedExample(ResourceDocletJsonXml.java:542)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.createRepresentationDocTypes(ResourceDocletJsonXml.java:453)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.addResponseDoc(ResourceDocletJsonXml.java:428)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.start(ResourceDocletJsonXml.java:196)\n\tat sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)\n\tat sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)\n\tat sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)\n\tat java.lang.reflect.Method.invoke(Method.java:597)\n\tat com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:269)\n\tat com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:143)\n\tat com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)\n\tat com.sun.tools.javadoc.Start.begin(Start.java:128)\n\tat com.sun.tools.javadoc.Main.execute(Main.java:41)\n\tat com.sun.tools.javadoc.Main.main(Main.java:31)\n"
}If the repository does not exist for one or more of the given crucibleRevisionData elements, or if one or more of the paths does not exist in the repository specified in the crucibleRevisionData elements, or if a revision specified in the crucibleRevisionData elements does not exist.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<error>
<code>NotPermitted</code>
<message>Access denied.</message>
<stacktrace>com.atlassian.crucible.spi.services.NotPermittedException: Access denied.
at com.atlassian.crucible.spi.rpc.ExampleDocuments.<clinit>(ExampleDocuments.java:21)
at sun.misc.Unsafe.ensureClassInitialized(Native Method)
at sun.reflect.UnsafeFieldAccessorFactory.newFieldAccessor(UnsafeFieldAccessorFactory.java:25)
at sun.reflect.ReflectionFactory.newFieldAccessor(ReflectionFactory.java:122)
at java.lang.reflect.Field.acquireFieldAccessor(Field.java:918)
at java.lang.reflect.Field.getFieldAccessor(Field.java:899)
at java.lang.reflect.Field.get(Field.java:358)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedLinkFromTag(ResourceDocletJsonXml.java:649)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedExample(ResourceDocletJsonXml.java:542)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.createRepresentationDocTypes(ResourceDocletJsonXml.java:453)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.addResponseDoc(ResourceDocletJsonXml.java:428)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.start(ResourceDocletJsonXml.java:196)
at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)
at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
at java.lang.reflect.Method.invoke(Method.java:597)
at com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:269)
at com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:143)
at com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)
at com.sun.tools.javadoc.Start.begin(Start.java:128)
at com.sun.tools.javadoc.Main.execute(Main.java:41)
at com.sun.tools.javadoc.Main.main(Main.java:31)
</stacktrace>
</error>
If the caller does not have permission to modify the review.
{
"code" : "NotPermitted",
"message" : "Access denied.",
"stacktrace" : "com.atlassian.crucible.spi.services.NotPermittedException: Access denied.\n\tat com.atlassian.crucible.spi.rpc.ExampleDocuments.<clinit>(ExampleDocuments.java:21)\n\tat sun.misc.Unsafe.ensureClassInitialized(Native Method)\n\tat sun.reflect.UnsafeFieldAccessorFactory.newFieldAccessor(UnsafeFieldAccessorFactory.java:25)\n\tat sun.reflect.ReflectionFactory.newFieldAccessor(ReflectionFactory.java:122)\n\tat java.lang.reflect.Field.acquireFieldAccessor(Field.java:918)\n\tat java.lang.reflect.Field.getFieldAccessor(Field.java:899)\n\tat java.lang.reflect.Field.get(Field.java:358)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedLinkFromTag(ResourceDocletJsonXml.java:649)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedExample(ResourceDocletJsonXml.java:542)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.createRepresentationDocTypes(ResourceDocletJsonXml.java:453)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.addResponseDoc(ResourceDocletJsonXml.java:428)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.start(ResourceDocletJsonXml.java:196)\n\tat sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)\n\tat sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)\n\tat sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)\n\tat java.lang.reflect.Method.invoke(Method.java:597)\n\tat com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:269)\n\tat com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:143)\n\tat com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)\n\tat com.sun.tools.javadoc.Start.begin(Start.java:128)\n\tat com.sun.tools.javadoc.Main.execute(Main.java:41)\n\tat com.sun.tools.javadoc.Main.main(Main.java:31)\n"
}If the caller does not have permission to modify the review.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<error>
<code>ReviewContentTooLarge</code>
<message>Attempt to add too many revisions to a review - no more than 800 file revisions are allowed.</message>
<stacktrace>com.atlassian.crucible.spi.services.ReviewContentTooLargeException: Attempt to add too many revisions to a review - no more than 800 file revisions are allowed.
at com.atlassian.crucible.spi.rpc.ReviewExampleDocuments.<clinit>(ReviewExampleDocuments.java:126)
at com.atlassian.fisheye.spi.rpc.ServerExampleDocuments.<clinit>(ServerExampleDocuments.java:10)
at sun.misc.Unsafe.ensureClassInitialized(Native Method)
at sun.reflect.UnsafeFieldAccessorFactory.newFieldAccessor(UnsafeFieldAccessorFactory.java:25)
at sun.reflect.ReflectionFactory.newFieldAccessor(ReflectionFactory.java:122)
at java.lang.reflect.Field.acquireFieldAccessor(Field.java:918)
at java.lang.reflect.Field.getFieldAccessor(Field.java:899)
at java.lang.reflect.Field.get(Field.java:358)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedLinkFromTag(ResourceDocletJsonXml.java:649)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedExample(ResourceDocletJsonXml.java:542)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.createRepresentationDocTypes(ResourceDocletJsonXml.java:453)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.addResponseDoc(ResourceDocletJsonXml.java:428)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.start(ResourceDocletJsonXml.java:196)
at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)
at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
at java.lang.reflect.Method.invoke(Method.java:597)
at com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:269)
at com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:143)
at com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)
at com.sun.tools.javadoc.Start.begin(Start.java:128)
at com.sun.tools.javadoc.Main.execute(Main.java:41)
at com.sun.tools.javadoc.Main.main(Main.java:31)
</stacktrace>
</error>
If the review is at or over allowed content size limit so new changes cannot be added until some other content is removed from review first. Also if the given patch is too large (contains too many files) for a single review.
{
"code" : "ReviewContentTooLarge",
"message" : "Attempt to add too many revisions to a review - no more than 800 file revisions are allowed.",
"stacktrace" : "com.atlassian.crucible.spi.services.ReviewContentTooLargeException: Attempt to add too many revisions to a review - no more than 800 file revisions are allowed.\n\tat com.atlassian.crucible.spi.rpc.ReviewExampleDocuments.<clinit>(ReviewExampleDocuments.java:126)\n\tat com.atlassian.fisheye.spi.rpc.ServerExampleDocuments.<clinit>(ServerExampleDocuments.java:10)\n\tat sun.misc.Unsafe.ensureClassInitialized(Native Method)\n\tat sun.reflect.UnsafeFieldAccessorFactory.newFieldAccessor(UnsafeFieldAccessorFactory.java:25)\n\tat sun.reflect.ReflectionFactory.newFieldAccessor(ReflectionFactory.java:122)\n\tat java.lang.reflect.Field.acquireFieldAccessor(Field.java:918)\n\tat java.lang.reflect.Field.getFieldAccessor(Field.java:899)\n\tat java.lang.reflect.Field.get(Field.java:358)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedLinkFromTag(ResourceDocletJsonXml.java:649)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedExample(ResourceDocletJsonXml.java:542)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.createRepresentationDocTypes(ResourceDocletJsonXml.java:453)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.addResponseDoc(ResourceDocletJsonXml.java:428)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.start(ResourceDocletJsonXml.java:196)\n\tat sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)\n\tat sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)\n\tat sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)\n\tat java.lang.reflect.Method.invoke(Method.java:597)\n\tat com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:269)\n\tat com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:143)\n\tat com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)\n\tat com.sun.tools.javadoc.Start.begin(Start.java:128)\n\tat com.sun.tools.javadoc.Main.execute(Main.java:41)\n\tat com.sun.tools.javadoc.Main.main(Main.java:31)\n"
}If the review is at or over allowed content size limit so new changes cannot be added until some other content is removed from review first. Also if the given patch is too large (contains too many files) for a single review.
| parameter | value | description |
|---|---|---|
|
id |
the id of the review (e.g. "CR-362"). |
Adds the given review item to the review. This will always create a new review item, even if there is an existing one with the same data in the review (in which case the existing item will be replaced).
The response includes the Location HTTP header.
acceptable request representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<reviewItem>
<participants>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Fred Eaglesmith</displayName>
<userName>fred</userName>
</user>
<completed>false</completed>
</participant>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Corb Lund</displayName>
<userName>clund</userName>
</user>
<completed>false</completed>
</participant>
</participants>
<permId>
<id>CFR-7453</id>
</permId>
<authorName>evzijst</authorName>
<commitDate>2015-04-28T09:47:56.304+02:00</commitDate>
<commitType>Modified</commitType>
<fileType>File</fileType>
<fromContentUrl>/context/cru/CR-123/rawcontent/5622//project/trunk/pom.xml</fromContentUrl>
<fromPath>/project/trunk/pom.xml</fromPath>
<fromRevision>688</fromRevision>
<repositoryName>REPO</repositoryName>
<showAsDiff>true</showAsDiff>
<toContentUrl>/context/cru/CR-123/rawcontent/5656//project/trunk/pom.xml</toContentUrl>
<toPath>/project/trunk/pom.xml</toPath>
<toRevision>6881</toRevision>
</reviewItem>
{
"permId" : {
"id" : "CFR-7453"
},
"participants" : [ {
"user" : {
"userName" : "fred",
"displayName" : "Fred Eaglesmith",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
}, {
"user" : {
"userName" : "clund",
"displayName" : "Corb Lund",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
} ],
"repositoryName" : "REPO",
"fromPath" : "/project/trunk/pom.xml",
"fromRevision" : "688",
"fromContentUrl" : "/context/cru/CR-123/rawcontent/5622//project/trunk/pom.xml",
"toPath" : "/project/trunk/pom.xml",
"toRevision" : "6881",
"toContentUrl" : "/context/cru/CR-123/rawcontent/5656//project/trunk/pom.xml",
"fileType" : "File",
"commitType" : "Modified",
"authorName" : "evzijst",
"showAsDiff" : true,
"commitDate" : 1430207276304
}available response representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<reviewItem>
<participants>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Fred Eaglesmith</displayName>
<userName>fred</userName>
</user>
<completed>false</completed>
</participant>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Corb Lund</displayName>
<userName>clund</userName>
</user>
<completed>false</completed>
</participant>
</participants>
<permId>
<id>CFR-7453</id>
</permId>
<authorName>evzijst</authorName>
<commitDate>2015-04-28T09:47:56.304+02:00</commitDate>
<commitType>Modified</commitType>
<fileType>File</fileType>
<fromContentUrl>/context/cru/CR-123/rawcontent/5622//project/trunk/pom.xml</fromContentUrl>
<fromPath>/project/trunk/pom.xml</fromPath>
<fromRevision>688</fromRevision>
<repositoryName>REPO</repositoryName>
<showAsDiff>true</showAsDiff>
<toContentUrl>/context/cru/CR-123/rawcontent/5656//project/trunk/pom.xml</toContentUrl>
<toPath>/project/trunk/pom.xml</toPath>
<toRevision>6881</toRevision>
</reviewItem>
The added review item with the permId set.
{
"permId" : {
"id" : "CFR-7453"
},
"participants" : [ {
"user" : {
"userName" : "fred",
"displayName" : "Fred Eaglesmith",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
}, {
"user" : {
"userName" : "clund",
"displayName" : "Corb Lund",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
} ],
"repositoryName" : "REPO",
"fromPath" : "/project/trunk/pom.xml",
"fromRevision" : "688",
"fromContentUrl" : "/context/cru/CR-123/rawcontent/5622//project/trunk/pom.xml",
"toPath" : "/project/trunk/pom.xml",
"toRevision" : "6881",
"toContentUrl" : "/context/cru/CR-123/rawcontent/5656//project/trunk/pom.xml",
"fileType" : "File",
"commitType" : "Modified",
"authorName" : "evzijst",
"showAsDiff" : true,
"commitDate" : 1430207276304
}The added review item with the permId set.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<error>
<code>ReviewContentTooLarge</code>
<message>Attempt to add too many revisions to a review - no more than 800 file revisions are allowed.</message>
<stacktrace>com.atlassian.crucible.spi.services.ReviewContentTooLargeException: Attempt to add too many revisions to a review - no more than 800 file revisions are allowed.
at com.atlassian.crucible.spi.rpc.ReviewExampleDocuments.<clinit>(ReviewExampleDocuments.java:126)
at com.atlassian.fisheye.spi.rpc.ServerExampleDocuments.<clinit>(ServerExampleDocuments.java:10)
at sun.misc.Unsafe.ensureClassInitialized(Native Method)
at sun.reflect.UnsafeFieldAccessorFactory.newFieldAccessor(UnsafeFieldAccessorFactory.java:25)
at sun.reflect.ReflectionFactory.newFieldAccessor(ReflectionFactory.java:122)
at java.lang.reflect.Field.acquireFieldAccessor(Field.java:918)
at java.lang.reflect.Field.getFieldAccessor(Field.java:899)
at java.lang.reflect.Field.get(Field.java:358)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedLinkFromTag(ResourceDocletJsonXml.java:649)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedExample(ResourceDocletJsonXml.java:542)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.createRepresentationDocTypes(ResourceDocletJsonXml.java:453)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.addResponseDoc(ResourceDocletJsonXml.java:428)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.start(ResourceDocletJsonXml.java:196)
at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)
at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
at java.lang.reflect.Method.invoke(Method.java:597)
at com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:269)
at com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:143)
at com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)
at com.sun.tools.javadoc.Start.begin(Start.java:128)
at com.sun.tools.javadoc.Main.execute(Main.java:41)
at com.sun.tools.javadoc.Main.main(Main.java:31)
</stacktrace>
</error>
If the review is at or over allowed content size limit so new changes cannot be added until some other content is removed from review first. Also if the given patch is too large (contains too many files) for a single review.
{
"code" : "ReviewContentTooLarge",
"message" : "Attempt to add too many revisions to a review - no more than 800 file revisions are allowed.",
"stacktrace" : "com.atlassian.crucible.spi.services.ReviewContentTooLargeException: Attempt to add too many revisions to a review - no more than 800 file revisions are allowed.\n\tat com.atlassian.crucible.spi.rpc.ReviewExampleDocuments.<clinit>(ReviewExampleDocuments.java:126)\n\tat com.atlassian.fisheye.spi.rpc.ServerExampleDocuments.<clinit>(ServerExampleDocuments.java:10)\n\tat sun.misc.Unsafe.ensureClassInitialized(Native Method)\n\tat sun.reflect.UnsafeFieldAccessorFactory.newFieldAccessor(UnsafeFieldAccessorFactory.java:25)\n\tat sun.reflect.ReflectionFactory.newFieldAccessor(ReflectionFactory.java:122)\n\tat java.lang.reflect.Field.acquireFieldAccessor(Field.java:918)\n\tat java.lang.reflect.Field.getFieldAccessor(Field.java:899)\n\tat java.lang.reflect.Field.get(Field.java:358)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedLinkFromTag(ResourceDocletJsonXml.java:649)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedExample(ResourceDocletJsonXml.java:542)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.createRepresentationDocTypes(ResourceDocletJsonXml.java:453)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.addResponseDoc(ResourceDocletJsonXml.java:428)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.start(ResourceDocletJsonXml.java:196)\n\tat sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)\n\tat sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)\n\tat sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)\n\tat java.lang.reflect.Method.invoke(Method.java:597)\n\tat com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:269)\n\tat com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:143)\n\tat com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)\n\tat com.sun.tools.javadoc.Start.begin(Start.java:128)\n\tat com.sun.tools.javadoc.Main.execute(Main.java:41)\n\tat com.sun.tools.javadoc.Main.main(Main.java:31)\n"
}If the review is at or over allowed content size limit so new changes cannot be added until some other content is removed from review first. Also if the given patch is too large (contains too many files) for a single review.
| parameter | value | description |
|---|---|---|
|
id |
a valid review id (e.g. "CR-345"). |
|
|
riId |
a valid review item id (e.g. "CFR-5622"). |
Sets the review item specified by itemId with the given reviewItem. The old review item is discarded. Can only perform this operation if the old review item specified by itemId can be deleted. The old review item's permId is not changed.
acceptable request representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<reviewItem>
<participants>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Fred Eaglesmith</displayName>
<userName>fred</userName>
</user>
<completed>false</completed>
</participant>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Corb Lund</displayName>
<userName>clund</userName>
</user>
<completed>false</completed>
</participant>
</participants>
<permId>
<id>CFR-7453</id>
</permId>
<authorName>evzijst</authorName>
<commitDate>2015-04-28T09:47:56.304+02:00</commitDate>
<commitType>Modified</commitType>
<fileType>File</fileType>
<fromContentUrl>/context/cru/CR-123/rawcontent/5622//project/trunk/pom.xml</fromContentUrl>
<fromPath>/project/trunk/pom.xml</fromPath>
<fromRevision>688</fromRevision>
<repositoryName>REPO</repositoryName>
<showAsDiff>true</showAsDiff>
<toContentUrl>/context/cru/CR-123/rawcontent/5656//project/trunk/pom.xml</toContentUrl>
<toPath>/project/trunk/pom.xml</toPath>
<toRevision>6881</toRevision>
</reviewItem>
Source: crucible.xsd
<xs:complexType name="fisheyeReviewItemData">
<xs:complexContent>
<xs:extension base="reviewItemData">
<xs:sequence>
<xs:element name="anchorData" type="anchorData" minOccurs="0"/>
<xs:element name="authorName" type="xs:string" minOccurs="0"/>
<xs:element name="commitDate" type="xs:dateTime" minOccurs="0"/>
<xs:element name="commitType" type="commitType" minOccurs="0"/>
<xs:element name="expandedRevisions" type="reviewItemRevisionData" nillable="true" minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="fileType" type="fileType" minOccurs="0"/>
<xs:element name="fromContentUrl" type="xs:string" minOccurs="0"/>
<xs:element name="fromPath" type="xs:string" minOccurs="0"/>
<xs:element name="fromRevision" type="xs:string" minOccurs="0"/>
<xs:element name="patchUrl" type="xs:string" minOccurs="0"/>
<xs:element name="repositoryName" type="xs:string" minOccurs="0"/>
<xs:element name="showAsDiff" type="xs:boolean" minOccurs="0"/>
<xs:element name="toContentUrl" type="xs:string" minOccurs="0"/>
<xs:element name="toPath" type="xs:string" minOccurs="0"/>
<xs:element name="toRevision" type="xs:string" minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
{
"permId" : {
"id" : "CFR-7453"
},
"participants" : [ {
"user" : {
"userName" : "fred",
"displayName" : "Fred Eaglesmith",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
}, {
"user" : {
"userName" : "clund",
"displayName" : "Corb Lund",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
} ],
"repositoryName" : "REPO",
"fromPath" : "/project/trunk/pom.xml",
"fromRevision" : "688",
"fromContentUrl" : "/context/cru/CR-123/rawcontent/5622//project/trunk/pom.xml",
"toPath" : "/project/trunk/pom.xml",
"toRevision" : "6881",
"toContentUrl" : "/context/cru/CR-123/rawcontent/5656//project/trunk/pom.xml",
"fileType" : "File",
"commitType" : "Modified",
"authorName" : "evzijst",
"showAsDiff" : true,
"commitDate" : 1430207276304
}Source: crucible.xsd
<xs:complexType name="fisheyeReviewItemData">
<xs:complexContent>
<xs:extension base="reviewItemData">
<xs:sequence>
<xs:element name="anchorData" type="anchorData" minOccurs="0"/>
<xs:element name="authorName" type="xs:string" minOccurs="0"/>
<xs:element name="commitDate" type="xs:dateTime" minOccurs="0"/>
<xs:element name="commitType" type="commitType" minOccurs="0"/>
<xs:element name="expandedRevisions" type="reviewItemRevisionData" nillable="true" minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="fileType" type="fileType" minOccurs="0"/>
<xs:element name="fromContentUrl" type="xs:string" minOccurs="0"/>
<xs:element name="fromPath" type="xs:string" minOccurs="0"/>
<xs:element name="fromRevision" type="xs:string" minOccurs="0"/>
<xs:element name="patchUrl" type="xs:string" minOccurs="0"/>
<xs:element name="repositoryName" type="xs:string" minOccurs="0"/>
<xs:element name="showAsDiff" type="xs:boolean" minOccurs="0"/>
<xs:element name="toContentUrl" type="xs:string" minOccurs="0"/>
<xs:element name="toPath" type="xs:string" minOccurs="0"/>
<xs:element name="toRevision" type="xs:string" minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>available response representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<reviewItem>
<participants>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Fred Eaglesmith</displayName>
<userName>fred</userName>
</user>
<completed>false</completed>
</participant>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Corb Lund</displayName>
<userName>clund</userName>
</user>
<completed>false</completed>
</participant>
</participants>
<permId>
<id>CFR-7453</id>
</permId>
<authorName>evzijst</authorName>
<commitDate>2015-04-28T09:47:56.304+02:00</commitDate>
<commitType>Modified</commitType>
<fileType>File</fileType>
<fromContentUrl>/context/cru/CR-123/rawcontent/5622//project/trunk/pom.xml</fromContentUrl>
<fromPath>/project/trunk/pom.xml</fromPath>
<fromRevision>688</fromRevision>
<repositoryName>REPO</repositoryName>
<showAsDiff>true</showAsDiff>
<toContentUrl>/context/cru/CR-123/rawcontent/5656//project/trunk/pom.xml</toContentUrl>
<toPath>/project/trunk/pom.xml</toPath>
<toRevision>6881</toRevision>
</reviewItem>
The newly created review item, with its itemId set to the new ID.
{
"permId" : {
"id" : "CFR-7453"
},
"participants" : [ {
"user" : {
"userName" : "fred",
"displayName" : "Fred Eaglesmith",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
}, {
"user" : {
"userName" : "clund",
"displayName" : "Corb Lund",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
} ],
"repositoryName" : "REPO",
"fromPath" : "/project/trunk/pom.xml",
"fromRevision" : "688",
"fromContentUrl" : "/context/cru/CR-123/rawcontent/5622//project/trunk/pom.xml",
"toPath" : "/project/trunk/pom.xml",
"toRevision" : "6881",
"toContentUrl" : "/context/cru/CR-123/rawcontent/5656//project/trunk/pom.xml",
"fileType" : "File",
"commitType" : "Modified",
"authorName" : "evzijst",
"showAsDiff" : true,
"commitDate" : 1430207276304
}The newly created review item, with its itemId set to the new ID.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<error>
<code>ReviewContentTooLarge</code>
<message>Attempt to add too many revisions to a review - no more than 800 file revisions are allowed.</message>
<stacktrace>com.atlassian.crucible.spi.services.ReviewContentTooLargeException: Attempt to add too many revisions to a review - no more than 800 file revisions are allowed.
at com.atlassian.crucible.spi.rpc.ReviewExampleDocuments.<clinit>(ReviewExampleDocuments.java:126)
at com.atlassian.fisheye.spi.rpc.ServerExampleDocuments.<clinit>(ServerExampleDocuments.java:10)
at sun.misc.Unsafe.ensureClassInitialized(Native Method)
at sun.reflect.UnsafeFieldAccessorFactory.newFieldAccessor(UnsafeFieldAccessorFactory.java:25)
at sun.reflect.ReflectionFactory.newFieldAccessor(ReflectionFactory.java:122)
at java.lang.reflect.Field.acquireFieldAccessor(Field.java:918)
at java.lang.reflect.Field.getFieldAccessor(Field.java:899)
at java.lang.reflect.Field.get(Field.java:358)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedLinkFromTag(ResourceDocletJsonXml.java:649)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedExample(ResourceDocletJsonXml.java:542)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.createRepresentationDocTypes(ResourceDocletJsonXml.java:453)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.addResponseDoc(ResourceDocletJsonXml.java:428)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.start(ResourceDocletJsonXml.java:196)
at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)
at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
at java.lang.reflect.Method.invoke(Method.java:597)
at com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:269)
at com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:143)
at com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)
at com.sun.tools.javadoc.Start.begin(Start.java:128)
at com.sun.tools.javadoc.Main.execute(Main.java:41)
at com.sun.tools.javadoc.Main.main(Main.java:31)
</stacktrace>
</error>
If the review is at or over allowed content size limit so new changes cannot be added until some other content is removed from review first. Also if the given patch is too large (contains too many files) for a single review.
{
"code" : "ReviewContentTooLarge",
"message" : "Attempt to add too many revisions to a review - no more than 800 file revisions are allowed.",
"stacktrace" : "com.atlassian.crucible.spi.services.ReviewContentTooLargeException: Attempt to add too many revisions to a review - no more than 800 file revisions are allowed.\n\tat com.atlassian.crucible.spi.rpc.ReviewExampleDocuments.<clinit>(ReviewExampleDocuments.java:126)\n\tat com.atlassian.fisheye.spi.rpc.ServerExampleDocuments.<clinit>(ServerExampleDocuments.java:10)\n\tat sun.misc.Unsafe.ensureClassInitialized(Native Method)\n\tat sun.reflect.UnsafeFieldAccessorFactory.newFieldAccessor(UnsafeFieldAccessorFactory.java:25)\n\tat sun.reflect.ReflectionFactory.newFieldAccessor(ReflectionFactory.java:122)\n\tat java.lang.reflect.Field.acquireFieldAccessor(Field.java:918)\n\tat java.lang.reflect.Field.getFieldAccessor(Field.java:899)\n\tat java.lang.reflect.Field.get(Field.java:358)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedLinkFromTag(ResourceDocletJsonXml.java:649)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedExample(ResourceDocletJsonXml.java:542)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.createRepresentationDocTypes(ResourceDocletJsonXml.java:453)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.addResponseDoc(ResourceDocletJsonXml.java:428)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.start(ResourceDocletJsonXml.java:196)\n\tat sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)\n\tat sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)\n\tat sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)\n\tat java.lang.reflect.Method.invoke(Method.java:597)\n\tat com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:269)\n\tat com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:143)\n\tat com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)\n\tat com.sun.tools.javadoc.Start.begin(Start.java:128)\n\tat com.sun.tools.javadoc.Main.execute(Main.java:41)\n\tat com.sun.tools.javadoc.Main.main(Main.java:31)\n"
}If the review is at or over allowed content size limit so new changes cannot be added until some other content is removed from review first. Also if the given patch is too large (contains too many files) for a single review.
| parameter | value | description |
|---|---|---|
|
id |
the PermId of the review to remove the item from (e.g. "CR-345"). |
|
|
riId |
the id of the review item from which to remove the list of revisions (e.g. "CFR-5622"). |
Adds the given list of revisions to the supplied review item, merging if required. For example, if the review
item for a.txt contains revisions 3 to 6, and if:
a.txt will have revisions 3--4--5--6a.txt will have revisions 2--3--6--7a.txt will have revisions 2--3--6a.txt will have revisions 3--6--7a.txt will have revisions 2--3--4--6a.txt will have revisions 3--4--6--7available response representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<reviewItem>
<participants>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Fred Eaglesmith</displayName>
<userName>fred</userName>
</user>
<completed>false</completed>
</participant>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Corb Lund</displayName>
<userName>clund</userName>
</user>
<completed>false</completed>
</participant>
</participants>
<permId>
<id>CFR-7453</id>
</permId>
<authorName>evzijst</authorName>
<commitDate>2015-04-28T09:47:56.304+02:00</commitDate>
<commitType>Modified</commitType>
<fileType>File</fileType>
<fromContentUrl>/context/cru/CR-123/rawcontent/5622//project/trunk/pom.xml</fromContentUrl>
<fromPath>/project/trunk/pom.xml</fromPath>
<fromRevision>688</fromRevision>
<repositoryName>REPO</repositoryName>
<showAsDiff>true</showAsDiff>
<toContentUrl>/context/cru/CR-123/rawcontent/5656//project/trunk/pom.xml</toContentUrl>
<toPath>/project/trunk/pom.xml</toPath>
<toRevision>6881</toRevision>
</reviewItem>
The review item with the added list of revisions.
{
"permId" : {
"id" : "CFR-7453"
},
"participants" : [ {
"user" : {
"userName" : "fred",
"displayName" : "Fred Eaglesmith",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
}, {
"user" : {
"userName" : "clund",
"displayName" : "Corb Lund",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
} ],
"repositoryName" : "REPO",
"fromPath" : "/project/trunk/pom.xml",
"fromRevision" : "688",
"fromContentUrl" : "/context/cru/CR-123/rawcontent/5622//project/trunk/pom.xml",
"toPath" : "/project/trunk/pom.xml",
"toRevision" : "6881",
"toContentUrl" : "/context/cru/CR-123/rawcontent/5656//project/trunk/pom.xml",
"fileType" : "File",
"commitType" : "Modified",
"authorName" : "evzijst",
"showAsDiff" : true,
"commitDate" : 1430207276304
}The review item with the added list of revisions.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<error>
<code>ReviewContentTooLarge</code>
<message>Attempt to add too many revisions to a review - no more than 800 file revisions are allowed.</message>
<stacktrace>com.atlassian.crucible.spi.services.ReviewContentTooLargeException: Attempt to add too many revisions to a review - no more than 800 file revisions are allowed.
at com.atlassian.crucible.spi.rpc.ReviewExampleDocuments.<clinit>(ReviewExampleDocuments.java:126)
at com.atlassian.fisheye.spi.rpc.ServerExampleDocuments.<clinit>(ServerExampleDocuments.java:10)
at sun.misc.Unsafe.ensureClassInitialized(Native Method)
at sun.reflect.UnsafeFieldAccessorFactory.newFieldAccessor(UnsafeFieldAccessorFactory.java:25)
at sun.reflect.ReflectionFactory.newFieldAccessor(ReflectionFactory.java:122)
at java.lang.reflect.Field.acquireFieldAccessor(Field.java:918)
at java.lang.reflect.Field.getFieldAccessor(Field.java:899)
at java.lang.reflect.Field.get(Field.java:358)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedLinkFromTag(ResourceDocletJsonXml.java:649)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedExample(ResourceDocletJsonXml.java:542)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.createRepresentationDocTypes(ResourceDocletJsonXml.java:453)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.addResponseDoc(ResourceDocletJsonXml.java:428)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.start(ResourceDocletJsonXml.java:196)
at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)
at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
at java.lang.reflect.Method.invoke(Method.java:597)
at com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:269)
at com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:143)
at com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)
at com.sun.tools.javadoc.Start.begin(Start.java:128)
at com.sun.tools.javadoc.Main.execute(Main.java:41)
at com.sun.tools.javadoc.Main.main(Main.java:31)
</stacktrace>
</error>
If the review is at or over allowed content size limit so new changes cannot be added until some other content is removed from review first.
{
"code" : "ReviewContentTooLarge",
"message" : "Attempt to add too many revisions to a review - no more than 800 file revisions are allowed.",
"stacktrace" : "com.atlassian.crucible.spi.services.ReviewContentTooLargeException: Attempt to add too many revisions to a review - no more than 800 file revisions are allowed.\n\tat com.atlassian.crucible.spi.rpc.ReviewExampleDocuments.<clinit>(ReviewExampleDocuments.java:126)\n\tat com.atlassian.fisheye.spi.rpc.ServerExampleDocuments.<clinit>(ServerExampleDocuments.java:10)\n\tat sun.misc.Unsafe.ensureClassInitialized(Native Method)\n\tat sun.reflect.UnsafeFieldAccessorFactory.newFieldAccessor(UnsafeFieldAccessorFactory.java:25)\n\tat sun.reflect.ReflectionFactory.newFieldAccessor(ReflectionFactory.java:122)\n\tat java.lang.reflect.Field.acquireFieldAccessor(Field.java:918)\n\tat java.lang.reflect.Field.getFieldAccessor(Field.java:899)\n\tat java.lang.reflect.Field.get(Field.java:358)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedLinkFromTag(ResourceDocletJsonXml.java:649)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedExample(ResourceDocletJsonXml.java:542)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.createRepresentationDocTypes(ResourceDocletJsonXml.java:453)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.addResponseDoc(ResourceDocletJsonXml.java:428)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.start(ResourceDocletJsonXml.java:196)\n\tat sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)\n\tat sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)\n\tat sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)\n\tat java.lang.reflect.Method.invoke(Method.java:597)\n\tat com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:269)\n\tat com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:143)\n\tat com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)\n\tat com.sun.tools.javadoc.Start.begin(Start.java:128)\n\tat com.sun.tools.javadoc.Main.execute(Main.java:41)\n\tat com.sun.tools.javadoc.Main.main(Main.java:31)\n"
}If the review is at or over allowed content size limit so new changes cannot be added until some other content is removed from review first.
Removes the revisions given from the review item in the review specified by the id. If the review item has no more revisions left, it is automatically deleted.
| parameter | value | description |
|---|---|---|
|
id |
review id (e.g. "CR-345"). |
|
|
riId |
review item id (e.g. "CFR-6312"). |
Removes an item from a review.
Returns detailed information for a specific review item.
available response representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<reviewItem>
<participants>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Fred Eaglesmith</displayName>
<userName>fred</userName>
</user>
<completed>false</completed>
</participant>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Corb Lund</displayName>
<userName>clund</userName>
</user>
<completed>false</completed>
</participant>
</participants>
<permId>
<id>CFR-7453</id>
</permId>
<authorName>evzijst</authorName>
<commitDate>2015-04-28T09:47:56.304+02:00</commitDate>
<commitType>Modified</commitType>
<fileType>File</fileType>
<fromContentUrl>/context/cru/CR-123/rawcontent/5622//project/trunk/pom.xml</fromContentUrl>
<fromPath>/project/trunk/pom.xml</fromPath>
<fromRevision>688</fromRevision>
<repositoryName>REPO</repositoryName>
<showAsDiff>true</showAsDiff>
<toContentUrl>/context/cru/CR-123/rawcontent/5656//project/trunk/pom.xml</toContentUrl>
<toPath>/project/trunk/pom.xml</toPath>
<toRevision>6881</toRevision>
</reviewItem>
A single item from a review.
{
"permId" : {
"id" : "CFR-7453"
},
"participants" : [ {
"user" : {
"userName" : "fred",
"displayName" : "Fred Eaglesmith",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
}, {
"user" : {
"userName" : "clund",
"displayName" : "Corb Lund",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
} ],
"repositoryName" : "REPO",
"fromPath" : "/project/trunk/pom.xml",
"fromRevision" : "688",
"fromContentUrl" : "/context/cru/CR-123/rawcontent/5622//project/trunk/pom.xml",
"toPath" : "/project/trunk/pom.xml",
"toRevision" : "6881",
"toContentUrl" : "/context/cru/CR-123/rawcontent/5656//project/trunk/pom.xml",
"fileType" : "File",
"commitType" : "Modified",
"authorName" : "evzijst",
"showAsDiff" : true,
"commitDate" : 1430207276304
}A single item from a review.
| parameter | value | description |
|---|---|---|
|
id |
the review perma-id |
Return all the comments visible to the requesting user for the review.
| parameter | value | description |
|---|---|---|
|
render |
Default: false |
indicate whether to render the wiki text in the returned comments. If set to "true", the comments will contain a <messageAsHtml> element containing the wiki rendered html. |
available response representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<comments>
<generalCommentData>
<createDate>2015-04-28T09:47:56.281+0200</createDate>
<defectApproved>false</defectApproved>
<defectRaised>false</defectRaised>
<deleted>false</deleted>
<draft>false</draft>
<message>I thought you said you were going to *remove* this line?</message>
<messageAsHtml>I thought you said you were going to <b>remove</b> this line?</messageAsHtml>
<metrics/>
<parentCommentId/>
<readStatus>UNREAD</readStatus>
<replies/>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Joe Bloggs</displayName>
<userName>joe</userName>
</user>
<permId>
<id>CR:1</id>
</permId>
<permaId>
<id>CR:1</id>
</permaId>
</generalCommentData>
<generalCommentData>
<createDate>2015-04-28T09:47:56.281+0200</createDate>
<defectApproved>false</defectApproved>
<defectRaised>false</defectRaised>
<deleted>false</deleted>
<draft>false</draft>
<message>I thought you said you were going to *remove* this line?</message>
<messageAsHtml>I thought you said you were going to <b>remove</b> this line?</messageAsHtml>
<metrics/>
<parentCommentId/>
<readStatus>UNREAD</readStatus>
<replies/>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Joe Bloggs</displayName>
<userName>joe</userName>
</user>
<permId>
<id>CR:1</id>
</permId>
<permaId>
<id>CR:1</id>
</permaId>
</generalCommentData>
<versionedLineCommentData>
<createDate>2015-04-28T09:47:56.313+0200</createDate>
<defectApproved>false</defectApproved>
<defectRaised>false</defectRaised>
<deleted>false</deleted>
<draft>false</draft>
<message>*bold* message</message>
<messageAsHtml><p><b>bold</b> message</p></messageAsHtml>
<parentCommentId/>
<readStatus>READ</readStatus>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Fred Veiligheidspet</displayName>
<userName>fred</userName>
</user>
<permaId/>
<reviewItemId>
<id>CRFX-1234</id>
</reviewItemId>
<fromLineRange>10</fromLineRange>
<toLineRange>20</toLineRange>
</versionedLineCommentData>
<versionedLineCommentData>
<createDate>2015-04-28T09:47:56.313+0200</createDate>
<defectApproved>false</defectApproved>
<defectRaised>false</defectRaised>
<deleted>false</deleted>
<draft>false</draft>
<message>*bold* message</message>
<messageAsHtml><p><b>bold</b> message</p></messageAsHtml>
<parentCommentId/>
<readStatus>READ</readStatus>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Fred Veiligheidspet</displayName>
<userName>fred</userName>
</user>
<permaId/>
<reviewItemId>
<id>CRFX-1234</id>
</reviewItemId>
<fromLineRange>10</fromLineRange>
<toLineRange>20</toLineRange>
</versionedLineCommentData>
</comments>
the comments visible to the requesting user
{
"comments" : [ {
"metrics" : {
},
"message" : "I thought you said you were going to *remove* this line?",
"draft" : false,
"deleted" : false,
"defectRaised" : false,
"defectApproved" : false,
"readStatus" : "UNREAD",
"user" : {
"userName" : "joe",
"displayName" : "Joe Bloggs",
"avatarUrl" : "http://foo.com/avatar"
},
"createDate" : "2015-04-28T09:47:56.281+0200",
"permaId" : {
"id" : "CR:1"
},
"replies" : [ ],
"messageAsHtml" : "I thought you said you were going to <b>remove</b> this line?",
"permId" : {
"id" : "CR:1"
},
"parentCommentId" : {
}
}, {
"metrics" : {
},
"message" : "I thought you said you were going to *remove* this line?",
"draft" : false,
"deleted" : false,
"defectRaised" : false,
"defectApproved" : false,
"readStatus" : "UNREAD",
"user" : {
"userName" : "joe",
"displayName" : "Joe Bloggs",
"avatarUrl" : "http://foo.com/avatar"
},
"createDate" : "2015-04-28T09:47:56.281+0200",
"permaId" : {
"id" : "CR:1"
},
"replies" : [ ],
"messageAsHtml" : "I thought you said you were going to <b>remove</b> this line?",
"permId" : {
"id" : "CR:1"
},
"parentCommentId" : {
}
}, {
"message" : "*bold* message",
"draft" : false,
"deleted" : false,
"defectRaised" : false,
"defectApproved" : false,
"readStatus" : "READ",
"user" : {
"userName" : "fred",
"displayName" : "Fred Veiligheidspet",
"avatarUrl" : "http://foo.com/avatar"
},
"createDate" : 1430207276313,
"messageAsHtml" : "<p><b>bold</b> message</p>",
"reviewItemId" : {
"id" : "CRFX-1234"
},
"fromLineRange" : "10",
"toLineRange" : "20"
}, {
"message" : "*bold* message",
"draft" : false,
"deleted" : false,
"defectRaised" : false,
"defectApproved" : false,
"readStatus" : "READ",
"user" : {
"userName" : "fred",
"displayName" : "Fred Veiligheidspet",
"avatarUrl" : "http://foo.com/avatar"
},
"createDate" : 1430207276313,
"messageAsHtml" : "<p><b>bold</b> message</p>",
"reviewItemId" : {
"id" : "CRFX-1234"
},
"fromLineRange" : "10",
"toLineRange" : "20"
} ]
}the comments visible to the requesting user
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<error>
<code>PermaIdFormat</code>
<message>Malformed PermId.</message>
<stacktrace>com.cenqua.crucible.model.PermaIdFormatException: Malformed PermId.
at com.atlassian.crucible.spi.rpc.ExampleDocuments.<clinit>(ExampleDocuments.java:33)
at sun.misc.Unsafe.ensureClassInitialized(Native Method)
at sun.reflect.UnsafeFieldAccessorFactory.newFieldAccessor(UnsafeFieldAccessorFactory.java:25)
at sun.reflect.ReflectionFactory.newFieldAccessor(ReflectionFactory.java:122)
at java.lang.reflect.Field.acquireFieldAccessor(Field.java:918)
at java.lang.reflect.Field.getFieldAccessor(Field.java:899)
at java.lang.reflect.Field.get(Field.java:358)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedLinkFromTag(ResourceDocletJsonXml.java:649)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedExample(ResourceDocletJsonXml.java:542)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.createRepresentationDocTypes(ResourceDocletJsonXml.java:453)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.addResponseDoc(ResourceDocletJsonXml.java:428)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.start(ResourceDocletJsonXml.java:196)
at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)
at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
at java.lang.reflect.Method.invoke(Method.java:597)
at com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:269)
at com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:143)
at com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)
at com.sun.tools.javadoc.Start.begin(Start.java:128)
at com.sun.tools.javadoc.Main.execute(Main.java:41)
at com.sun.tools.javadoc.Main.main(Main.java:31)
</stacktrace>
</error>
if the review perma-id is not well-formed
{
"code" : "PermaIdFormat",
"message" : "Malformed PermId.",
"stacktrace" : "com.cenqua.crucible.model.PermaIdFormatException: Malformed PermId.\n\tat com.atlassian.crucible.spi.rpc.ExampleDocuments.<clinit>(ExampleDocuments.java:33)\n\tat sun.misc.Unsafe.ensureClassInitialized(Native Method)\n\tat sun.reflect.UnsafeFieldAccessorFactory.newFieldAccessor(UnsafeFieldAccessorFactory.java:25)\n\tat sun.reflect.ReflectionFactory.newFieldAccessor(ReflectionFactory.java:122)\n\tat java.lang.reflect.Field.acquireFieldAccessor(Field.java:918)\n\tat java.lang.reflect.Field.getFieldAccessor(Field.java:899)\n\tat java.lang.reflect.Field.get(Field.java:358)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedLinkFromTag(ResourceDocletJsonXml.java:649)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedExample(ResourceDocletJsonXml.java:542)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.createRepresentationDocTypes(ResourceDocletJsonXml.java:453)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.addResponseDoc(ResourceDocletJsonXml.java:428)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.start(ResourceDocletJsonXml.java:196)\n\tat sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)\n\tat sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)\n\tat sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)\n\tat java.lang.reflect.Method.invoke(Method.java:597)\n\tat com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:269)\n\tat com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:143)\n\tat com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)\n\tat com.sun.tools.javadoc.Start.begin(Start.java:128)\n\tat com.sun.tools.javadoc.Main.execute(Main.java:41)\n\tat com.sun.tools.javadoc.Main.main(Main.java:31)\n"
}if the review perma-id is not well-formed
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<error>
<code>NotPermitted</code>
<message>Access denied.</message>
<stacktrace>com.atlassian.crucible.spi.services.NotPermittedException: Access denied.
at com.atlassian.crucible.spi.rpc.ExampleDocuments.<clinit>(ExampleDocuments.java:21)
at sun.misc.Unsafe.ensureClassInitialized(Native Method)
at sun.reflect.UnsafeFieldAccessorFactory.newFieldAccessor(UnsafeFieldAccessorFactory.java:25)
at sun.reflect.ReflectionFactory.newFieldAccessor(ReflectionFactory.java:122)
at java.lang.reflect.Field.acquireFieldAccessor(Field.java:918)
at java.lang.reflect.Field.getFieldAccessor(Field.java:899)
at java.lang.reflect.Field.get(Field.java:358)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedLinkFromTag(ResourceDocletJsonXml.java:649)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedExample(ResourceDocletJsonXml.java:542)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.createRepresentationDocTypes(ResourceDocletJsonXml.java:453)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.addResponseDoc(ResourceDocletJsonXml.java:428)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.start(ResourceDocletJsonXml.java:196)
at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)
at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
at java.lang.reflect.Method.invoke(Method.java:597)
at com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:269)
at com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:143)
at com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)
at com.sun.tools.javadoc.Start.begin(Start.java:128)
at com.sun.tools.javadoc.Main.execute(Main.java:41)
at com.sun.tools.javadoc.Main.main(Main.java:31)
</stacktrace>
</error>
if you are not permitted to view the review
{
"code" : "NotPermitted",
"message" : "Access denied.",
"stacktrace" : "com.atlassian.crucible.spi.services.NotPermittedException: Access denied.\n\tat com.atlassian.crucible.spi.rpc.ExampleDocuments.<clinit>(ExampleDocuments.java:21)\n\tat sun.misc.Unsafe.ensureClassInitialized(Native Method)\n\tat sun.reflect.UnsafeFieldAccessorFactory.newFieldAccessor(UnsafeFieldAccessorFactory.java:25)\n\tat sun.reflect.ReflectionFactory.newFieldAccessor(ReflectionFactory.java:122)\n\tat java.lang.reflect.Field.acquireFieldAccessor(Field.java:918)\n\tat java.lang.reflect.Field.getFieldAccessor(Field.java:899)\n\tat java.lang.reflect.Field.get(Field.java:358)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedLinkFromTag(ResourceDocletJsonXml.java:649)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedExample(ResourceDocletJsonXml.java:542)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.createRepresentationDocTypes(ResourceDocletJsonXml.java:453)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.addResponseDoc(ResourceDocletJsonXml.java:428)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.start(ResourceDocletJsonXml.java:196)\n\tat sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)\n\tat sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)\n\tat sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)\n\tat java.lang.reflect.Method.invoke(Method.java:597)\n\tat com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:269)\n\tat com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:143)\n\tat com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)\n\tat com.sun.tools.javadoc.Start.begin(Start.java:128)\n\tat com.sun.tools.javadoc.Main.execute(Main.java:41)\n\tat com.sun.tools.javadoc.Main.main(Main.java:31)\n"
}if you are not permitted to view the review
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<error>
<code>NotFound</code>
<message>Requested resource not found.</message>
<stacktrace>com.atlassian.crucible.spi.services.NotFoundException: Requested resource not found.
at com.atlassian.crucible.spi.rpc.ExampleDocuments.<clinit>(ExampleDocuments.java:27)
at sun.misc.Unsafe.ensureClassInitialized(Native Method)
at sun.reflect.UnsafeFieldAccessorFactory.newFieldAccessor(UnsafeFieldAccessorFactory.java:25)
at sun.reflect.ReflectionFactory.newFieldAccessor(ReflectionFactory.java:122)
at java.lang.reflect.Field.acquireFieldAccessor(Field.java:918)
at java.lang.reflect.Field.getFieldAccessor(Field.java:899)
at java.lang.reflect.Field.get(Field.java:358)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedLinkFromTag(ResourceDocletJsonXml.java:649)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedExample(ResourceDocletJsonXml.java:542)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.createRepresentationDocTypes(ResourceDocletJsonXml.java:453)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.addResponseDoc(ResourceDocletJsonXml.java:428)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.start(ResourceDocletJsonXml.java:196)
at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)
at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
at java.lang.reflect.Method.invoke(Method.java:597)
at com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:269)
at com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:143)
at com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)
at com.sun.tools.javadoc.Start.begin(Start.java:128)
at com.sun.tools.javadoc.Main.execute(Main.java:41)
at com.sun.tools.javadoc.Main.main(Main.java:31)
</stacktrace>
</error>
if the review does not exist
{
"code" : "NotFound",
"message" : "Requested resource not found.",
"stacktrace" : "com.atlassian.crucible.spi.services.NotFoundException: Requested resource not found.\n\tat com.atlassian.crucible.spi.rpc.ExampleDocuments.<clinit>(ExampleDocuments.java:27)\n\tat sun.misc.Unsafe.ensureClassInitialized(Native Method)\n\tat sun.reflect.UnsafeFieldAccessorFactory.newFieldAccessor(UnsafeFieldAccessorFactory.java:25)\n\tat sun.reflect.ReflectionFactory.newFieldAccessor(ReflectionFactory.java:122)\n\tat java.lang.reflect.Field.acquireFieldAccessor(Field.java:918)\n\tat java.lang.reflect.Field.getFieldAccessor(Field.java:899)\n\tat java.lang.reflect.Field.get(Field.java:358)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedLinkFromTag(ResourceDocletJsonXml.java:649)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedExample(ResourceDocletJsonXml.java:542)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.createRepresentationDocTypes(ResourceDocletJsonXml.java:453)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.addResponseDoc(ResourceDocletJsonXml.java:428)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.start(ResourceDocletJsonXml.java:196)\n\tat sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)\n\tat sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)\n\tat sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)\n\tat java.lang.reflect.Method.invoke(Method.java:597)\n\tat com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:269)\n\tat com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:143)\n\tat com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)\n\tat com.sun.tools.javadoc.Start.begin(Start.java:128)\n\tat com.sun.tools.javadoc.Main.execute(Main.java:41)\n\tat com.sun.tools.javadoc.Main.main(Main.java:31)\n"
}if the review does not exist
Add a general comment to the review.
acceptable request representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<generalCommentData>
<defectApproved>false</defectApproved>
<defectRaised>false</defectRaised>
<deleted>false</deleted>
<draft>true</draft>
<message>I thought you said you were going to remove this line?</message>
<parentCommentId/>
<permId/>
<permaId/>
</generalCommentData>
{
"message" : "I thought you said you were going to remove this line?",
"draft" : true,
"deleted" : false,
"defectRaised" : false,
"defectApproved" : false,
"permaId" : {
},
"permId" : {
},
"parentCommentId" : {
}
}available response representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<generalCommentData>
<createDate>2015-04-28T09:47:56.281+0200</createDate>
<defectApproved>false</defectApproved>
<defectRaised>false</defectRaised>
<deleted>false</deleted>
<draft>false</draft>
<message>I thought you said you were going to *remove* this line?</message>
<messageAsHtml>I thought you said you were going to <b>remove</b> this line?</messageAsHtml>
<metrics/>
<parentCommentId/>
<readStatus>UNREAD</readStatus>
<replies/>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Joe Bloggs</displayName>
<userName>joe</userName>
</user>
<permId>
<id>CR:1</id>
</permId>
<permaId>
<id>CR:1</id>
</permaId>
</generalCommentData>
the newly created comment, with its URI in the Location header
{
"metrics" : {
},
"message" : "I thought you said you were going to *remove* this line?",
"draft" : false,
"deleted" : false,
"defectRaised" : false,
"defectApproved" : false,
"readStatus" : "UNREAD",
"user" : {
"userName" : "joe",
"displayName" : "Joe Bloggs",
"avatarUrl" : "http://foo.com/avatar"
},
"createDate" : "2015-04-28T09:47:56.281+0200",
"permaId" : {
"id" : "CR:1"
},
"replies" : [ ],
"messageAsHtml" : "I thought you said you were going to <b>remove</b> this line?",
"permId" : {
"id" : "CR:1"
},
"parentCommentId" : {
}
}the newly created comment, with its URI in the Location header
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<error>
<code>IllegalState</code>
<message>The review must be open to perform the requested action.</message>
<stacktrace>java.lang.IllegalStateException: The review must be open to perform the requested action.
at com.atlassian.crucible.spi.rpc.ExampleDocuments.<clinit>(ExampleDocuments.java:45)
at sun.misc.Unsafe.ensureClassInitialized(Native Method)
at sun.reflect.UnsafeFieldAccessorFactory.newFieldAccessor(UnsafeFieldAccessorFactory.java:25)
at sun.reflect.ReflectionFactory.newFieldAccessor(ReflectionFactory.java:122)
at java.lang.reflect.Field.acquireFieldAccessor(Field.java:918)
at java.lang.reflect.Field.getFieldAccessor(Field.java:899)
at java.lang.reflect.Field.get(Field.java:358)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedLinkFromTag(ResourceDocletJsonXml.java:649)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedExample(ResourceDocletJsonXml.java:542)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.createRepresentationDocTypes(ResourceDocletJsonXml.java:453)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.addResponseDoc(ResourceDocletJsonXml.java:428)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.start(ResourceDocletJsonXml.java:196)
at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)
at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
at java.lang.reflect.Method.invoke(Method.java:597)
at com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:269)
at com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:143)
at com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)
at com.sun.tools.javadoc.Start.begin(Start.java:128)
at com.sun.tools.javadoc.Main.execute(Main.java:41)
at com.sun.tools.javadoc.Main.main(Main.java:31)
</stacktrace>
</error>
reviewId is not a well-formed review perma-id, or
{
"code" : "IllegalState",
"message" : "The review must be open to perform the requested action.",
"stacktrace" : "java.lang.IllegalStateException: The review must be open to perform the requested action.\n\tat com.atlassian.crucible.spi.rpc.ExampleDocuments.<clinit>(ExampleDocuments.java:45)\n\tat sun.misc.Unsafe.ensureClassInitialized(Native Method)\n\tat sun.reflect.UnsafeFieldAccessorFactory.newFieldAccessor(UnsafeFieldAccessorFactory.java:25)\n\tat sun.reflect.ReflectionFactory.newFieldAccessor(ReflectionFactory.java:122)\n\tat java.lang.reflect.Field.acquireFieldAccessor(Field.java:918)\n\tat java.lang.reflect.Field.getFieldAccessor(Field.java:899)\n\tat java.lang.reflect.Field.get(Field.java:358)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedLinkFromTag(ResourceDocletJsonXml.java:649)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedExample(ResourceDocletJsonXml.java:542)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.createRepresentationDocTypes(ResourceDocletJsonXml.java:453)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.addResponseDoc(ResourceDocletJsonXml.java:428)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.start(ResourceDocletJsonXml.java:196)\n\tat sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)\n\tat sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)\n\tat sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)\n\tat java.lang.reflect.Method.invoke(Method.java:597)\n\tat com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:269)\n\tat com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:143)\n\tat com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)\n\tat com.sun.tools.javadoc.Start.begin(Start.java:128)\n\tat com.sun.tools.javadoc.Main.execute(Main.java:41)\n\tat com.sun.tools.javadoc.Main.main(Main.java:31)\n"
}reviewId is not a well-formed review perma-id, or
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<error>
<code>NotPermitted</code>
<message>Access denied.</message>
<stacktrace>com.atlassian.crucible.spi.services.NotPermittedException: Access denied.
at com.atlassian.crucible.spi.rpc.ExampleDocuments.<clinit>(ExampleDocuments.java:21)
at sun.misc.Unsafe.ensureClassInitialized(Native Method)
at sun.reflect.UnsafeFieldAccessorFactory.newFieldAccessor(UnsafeFieldAccessorFactory.java:25)
at sun.reflect.ReflectionFactory.newFieldAccessor(ReflectionFactory.java:122)
at java.lang.reflect.Field.acquireFieldAccessor(Field.java:918)
at java.lang.reflect.Field.getFieldAccessor(Field.java:899)
at java.lang.reflect.Field.get(Field.java:358)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedLinkFromTag(ResourceDocletJsonXml.java:649)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedExample(ResourceDocletJsonXml.java:542)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.createRepresentationDocTypes(ResourceDocletJsonXml.java:453)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.addResponseDoc(ResourceDocletJsonXml.java:428)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.start(ResourceDocletJsonXml.java:196)
at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)
at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
at java.lang.reflect.Method.invoke(Method.java:597)
at com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:269)
at com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:143)
at com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)
at com.sun.tools.javadoc.Start.begin(Start.java:128)
at com.sun.tools.javadoc.Main.execute(Main.java:41)
at com.sun.tools.javadoc.Main.main(Main.java:31)
</stacktrace>
</error>
if you are not permitted to comment on the review
{
"code" : "NotPermitted",
"message" : "Access denied.",
"stacktrace" : "com.atlassian.crucible.spi.services.NotPermittedException: Access denied.\n\tat com.atlassian.crucible.spi.rpc.ExampleDocuments.<clinit>(ExampleDocuments.java:21)\n\tat sun.misc.Unsafe.ensureClassInitialized(Native Method)\n\tat sun.reflect.UnsafeFieldAccessorFactory.newFieldAccessor(UnsafeFieldAccessorFactory.java:25)\n\tat sun.reflect.ReflectionFactory.newFieldAccessor(ReflectionFactory.java:122)\n\tat java.lang.reflect.Field.acquireFieldAccessor(Field.java:918)\n\tat java.lang.reflect.Field.getFieldAccessor(Field.java:899)\n\tat java.lang.reflect.Field.get(Field.java:358)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedLinkFromTag(ResourceDocletJsonXml.java:649)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedExample(ResourceDocletJsonXml.java:542)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.createRepresentationDocTypes(ResourceDocletJsonXml.java:453)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.addResponseDoc(ResourceDocletJsonXml.java:428)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.start(ResourceDocletJsonXml.java:196)\n\tat sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)\n\tat sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)\n\tat sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)\n\tat java.lang.reflect.Method.invoke(Method.java:597)\n\tat com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:269)\n\tat com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:143)\n\tat com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)\n\tat com.sun.tools.javadoc.Start.begin(Start.java:128)\n\tat com.sun.tools.javadoc.Main.execute(Main.java:41)\n\tat com.sun.tools.javadoc.Main.main(Main.java:31)\n"
}if you are not permitted to comment on the review
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<error>
<code>NotFound</code>
<message>Requested resource not found.</message>
<stacktrace>com.atlassian.crucible.spi.services.NotFoundException: Requested resource not found.
at com.atlassian.crucible.spi.rpc.ExampleDocuments.<clinit>(ExampleDocuments.java:27)
at sun.misc.Unsafe.ensureClassInitialized(Native Method)
at sun.reflect.UnsafeFieldAccessorFactory.newFieldAccessor(UnsafeFieldAccessorFactory.java:25)
at sun.reflect.ReflectionFactory.newFieldAccessor(ReflectionFactory.java:122)
at java.lang.reflect.Field.acquireFieldAccessor(Field.java:918)
at java.lang.reflect.Field.getFieldAccessor(Field.java:899)
at java.lang.reflect.Field.get(Field.java:358)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedLinkFromTag(ResourceDocletJsonXml.java:649)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedExample(ResourceDocletJsonXml.java:542)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.createRepresentationDocTypes(ResourceDocletJsonXml.java:453)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.addResponseDoc(ResourceDocletJsonXml.java:428)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.start(ResourceDocletJsonXml.java:196)
at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)
at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
at java.lang.reflect.Method.invoke(Method.java:597)
at com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:269)
at com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:143)
at com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)
at com.sun.tools.javadoc.Start.begin(Start.java:128)
at com.sun.tools.javadoc.Main.execute(Main.java:41)
at com.sun.tools.javadoc.Main.main(Main.java:31)
</stacktrace>
</error>
if the review does not exist
{
"code" : "NotFound",
"message" : "Requested resource not found.",
"stacktrace" : "com.atlassian.crucible.spi.services.NotFoundException: Requested resource not found.\n\tat com.atlassian.crucible.spi.rpc.ExampleDocuments.<clinit>(ExampleDocuments.java:27)\n\tat sun.misc.Unsafe.ensureClassInitialized(Native Method)\n\tat sun.reflect.UnsafeFieldAccessorFactory.newFieldAccessor(UnsafeFieldAccessorFactory.java:25)\n\tat sun.reflect.ReflectionFactory.newFieldAccessor(ReflectionFactory.java:122)\n\tat java.lang.reflect.Field.acquireFieldAccessor(Field.java:918)\n\tat java.lang.reflect.Field.getFieldAccessor(Field.java:899)\n\tat java.lang.reflect.Field.get(Field.java:358)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedLinkFromTag(ResourceDocletJsonXml.java:649)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedExample(ResourceDocletJsonXml.java:542)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.createRepresentationDocTypes(ResourceDocletJsonXml.java:453)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.addResponseDoc(ResourceDocletJsonXml.java:428)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.start(ResourceDocletJsonXml.java:196)\n\tat sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)\n\tat sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)\n\tat sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)\n\tat java.lang.reflect.Method.invoke(Method.java:597)\n\tat com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:269)\n\tat com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:143)\n\tat com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)\n\tat com.sun.tools.javadoc.Start.begin(Start.java:128)\n\tat com.sun.tools.javadoc.Main.execute(Main.java:41)\n\tat com.sun.tools.javadoc.Main.main(Main.java:31)\n"
}if the review does not exist
| parameter | value | description |
|---|---|---|
|
id |
review perma-id |
| parameter | value | description |
|---|---|---|
|
render |
Default: false |
indicate whether to render the wiki text in the returned comments. If set to "true", the comments will contain a <messageAsHtml> element containing the wiki rendered html. |
available response representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<comments>
<generalCommentData>
<createDate>2015-04-28T09:47:56.281+0200</createDate>
<defectApproved>false</defectApproved>
<defectRaised>false</defectRaised>
<deleted>false</deleted>
<draft>false</draft>
<message>I thought you said you were going to *remove* this line?</message>
<messageAsHtml>I thought you said you were going to <b>remove</b> this line?</messageAsHtml>
<metrics/>
<parentCommentId/>
<readStatus>UNREAD</readStatus>
<replies/>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Joe Bloggs</displayName>
<userName>joe</userName>
</user>
<permId>
<id>CR:1</id>
</permId>
<permaId>
<id>CR:1</id>
</permaId>
</generalCommentData>
<generalCommentData>
<createDate>2015-04-28T09:47:56.281+0200</createDate>
<defectApproved>false</defectApproved>
<defectRaised>false</defectRaised>
<deleted>false</deleted>
<draft>false</draft>
<message>I thought you said you were going to *remove* this line?</message>
<messageAsHtml>I thought you said you were going to <b>remove</b> this line?</messageAsHtml>
<metrics/>
<parentCommentId/>
<readStatus>UNREAD</readStatus>
<replies/>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Joe Bloggs</displayName>
<userName>joe</userName>
</user>
<permId>
<id>CR:1</id>
</permId>
<permaId>
<id>CR:1</id>
</permaId>
</generalCommentData>
</comments>
the comments visible to the requesting user
{
"comments" : [ {
"metrics" : {
},
"message" : "I thought you said you were going to *remove* this line?",
"draft" : false,
"deleted" : false,
"defectRaised" : false,
"defectApproved" : false,
"readStatus" : "UNREAD",
"user" : {
"userName" : "joe",
"displayName" : "Joe Bloggs",
"avatarUrl" : "http://foo.com/avatar"
},
"createDate" : "2015-04-28T09:47:56.281+0200",
"permaId" : {
"id" : "CR:1"
},
"replies" : [ ],
"messageAsHtml" : "I thought you said you were going to <b>remove</b> this line?",
"permId" : {
"id" : "CR:1"
},
"parentCommentId" : {
}
}, {
"metrics" : {
},
"message" : "I thought you said you were going to *remove* this line?",
"draft" : false,
"deleted" : false,
"defectRaised" : false,
"defectApproved" : false,
"readStatus" : "UNREAD",
"user" : {
"userName" : "joe",
"displayName" : "Joe Bloggs",
"avatarUrl" : "http://foo.com/avatar"
},
"createDate" : "2015-04-28T09:47:56.281+0200",
"permaId" : {
"id" : "CR:1"
},
"replies" : [ ],
"messageAsHtml" : "I thought you said you were going to <b>remove</b> this line?",
"permId" : {
"id" : "CR:1"
},
"parentCommentId" : {
}
} ]
}the comments visible to the requesting user
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<error>
<code>PermaIdFormat</code>
<message>Malformed PermId.</message>
<stacktrace>com.cenqua.crucible.model.PermaIdFormatException: Malformed PermId.
at com.atlassian.crucible.spi.rpc.ExampleDocuments.<clinit>(ExampleDocuments.java:33)
at sun.misc.Unsafe.ensureClassInitialized(Native Method)
at sun.reflect.UnsafeFieldAccessorFactory.newFieldAccessor(UnsafeFieldAccessorFactory.java:25)
at sun.reflect.ReflectionFactory.newFieldAccessor(ReflectionFactory.java:122)
at java.lang.reflect.Field.acquireFieldAccessor(Field.java:918)
at java.lang.reflect.Field.getFieldAccessor(Field.java:899)
at java.lang.reflect.Field.get(Field.java:358)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedLinkFromTag(ResourceDocletJsonXml.java:649)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedExample(ResourceDocletJsonXml.java:542)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.createRepresentationDocTypes(ResourceDocletJsonXml.java:453)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.addResponseDoc(ResourceDocletJsonXml.java:428)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.start(ResourceDocletJsonXml.java:196)
at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)
at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
at java.lang.reflect.Method.invoke(Method.java:597)
at com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:269)
at com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:143)
at com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)
at com.sun.tools.javadoc.Start.begin(Start.java:128)
at com.sun.tools.javadoc.Main.execute(Main.java:41)
at com.sun.tools.javadoc.Main.main(Main.java:31)
</stacktrace>
</error>
if the review perma-id is not well-formed
{
"code" : "PermaIdFormat",
"message" : "Malformed PermId.",
"stacktrace" : "com.cenqua.crucible.model.PermaIdFormatException: Malformed PermId.\n\tat com.atlassian.crucible.spi.rpc.ExampleDocuments.<clinit>(ExampleDocuments.java:33)\n\tat sun.misc.Unsafe.ensureClassInitialized(Native Method)\n\tat sun.reflect.UnsafeFieldAccessorFactory.newFieldAccessor(UnsafeFieldAccessorFactory.java:25)\n\tat sun.reflect.ReflectionFactory.newFieldAccessor(ReflectionFactory.java:122)\n\tat java.lang.reflect.Field.acquireFieldAccessor(Field.java:918)\n\tat java.lang.reflect.Field.getFieldAccessor(Field.java:899)\n\tat java.lang.reflect.Field.get(Field.java:358)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedLinkFromTag(ResourceDocletJsonXml.java:649)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedExample(ResourceDocletJsonXml.java:542)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.createRepresentationDocTypes(ResourceDocletJsonXml.java:453)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.addResponseDoc(ResourceDocletJsonXml.java:428)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.start(ResourceDocletJsonXml.java:196)\n\tat sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)\n\tat sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)\n\tat sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)\n\tat java.lang.reflect.Method.invoke(Method.java:597)\n\tat com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:269)\n\tat com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:143)\n\tat com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)\n\tat com.sun.tools.javadoc.Start.begin(Start.java:128)\n\tat com.sun.tools.javadoc.Main.execute(Main.java:41)\n\tat com.sun.tools.javadoc.Main.main(Main.java:31)\n"
}if the review perma-id is not well-formed
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<error>
<code>NotPermitted</code>
<message>Access denied.</message>
<stacktrace>com.atlassian.crucible.spi.services.NotPermittedException: Access denied.
at com.atlassian.crucible.spi.rpc.ExampleDocuments.<clinit>(ExampleDocuments.java:21)
at sun.misc.Unsafe.ensureClassInitialized(Native Method)
at sun.reflect.UnsafeFieldAccessorFactory.newFieldAccessor(UnsafeFieldAccessorFactory.java:25)
at sun.reflect.ReflectionFactory.newFieldAccessor(ReflectionFactory.java:122)
at java.lang.reflect.Field.acquireFieldAccessor(Field.java:918)
at java.lang.reflect.Field.getFieldAccessor(Field.java:899)
at java.lang.reflect.Field.get(Field.java:358)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedLinkFromTag(ResourceDocletJsonXml.java:649)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedExample(ResourceDocletJsonXml.java:542)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.createRepresentationDocTypes(ResourceDocletJsonXml.java:453)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.addResponseDoc(ResourceDocletJsonXml.java:428)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.start(ResourceDocletJsonXml.java:196)
at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)
at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
at java.lang.reflect.Method.invoke(Method.java:597)
at com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:269)
at com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:143)
at com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)
at com.sun.tools.javadoc.Start.begin(Start.java:128)
at com.sun.tools.javadoc.Main.execute(Main.java:41)
at com.sun.tools.javadoc.Main.main(Main.java:31)
</stacktrace>
</error>
if you are not permitted to view the review
{
"code" : "NotPermitted",
"message" : "Access denied.",
"stacktrace" : "com.atlassian.crucible.spi.services.NotPermittedException: Access denied.\n\tat com.atlassian.crucible.spi.rpc.ExampleDocuments.<clinit>(ExampleDocuments.java:21)\n\tat sun.misc.Unsafe.ensureClassInitialized(Native Method)\n\tat sun.reflect.UnsafeFieldAccessorFactory.newFieldAccessor(UnsafeFieldAccessorFactory.java:25)\n\tat sun.reflect.ReflectionFactory.newFieldAccessor(ReflectionFactory.java:122)\n\tat java.lang.reflect.Field.acquireFieldAccessor(Field.java:918)\n\tat java.lang.reflect.Field.getFieldAccessor(Field.java:899)\n\tat java.lang.reflect.Field.get(Field.java:358)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedLinkFromTag(ResourceDocletJsonXml.java:649)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedExample(ResourceDocletJsonXml.java:542)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.createRepresentationDocTypes(ResourceDocletJsonXml.java:453)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.addResponseDoc(ResourceDocletJsonXml.java:428)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.start(ResourceDocletJsonXml.java:196)\n\tat sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)\n\tat sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)\n\tat sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)\n\tat java.lang.reflect.Method.invoke(Method.java:597)\n\tat com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:269)\n\tat com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:143)\n\tat com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)\n\tat com.sun.tools.javadoc.Start.begin(Start.java:128)\n\tat com.sun.tools.javadoc.Main.execute(Main.java:41)\n\tat com.sun.tools.javadoc.Main.main(Main.java:31)\n"
}if you are not permitted to view the review
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<error>
<code>NotFound</code>
<message>Requested resource not found.</message>
<stacktrace>com.atlassian.crucible.spi.services.NotFoundException: Requested resource not found.
at com.atlassian.crucible.spi.rpc.ExampleDocuments.<clinit>(ExampleDocuments.java:27)
at sun.misc.Unsafe.ensureClassInitialized(Native Method)
at sun.reflect.UnsafeFieldAccessorFactory.newFieldAccessor(UnsafeFieldAccessorFactory.java:25)
at sun.reflect.ReflectionFactory.newFieldAccessor(ReflectionFactory.java:122)
at java.lang.reflect.Field.acquireFieldAccessor(Field.java:918)
at java.lang.reflect.Field.getFieldAccessor(Field.java:899)
at java.lang.reflect.Field.get(Field.java:358)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedLinkFromTag(ResourceDocletJsonXml.java:649)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedExample(ResourceDocletJsonXml.java:542)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.createRepresentationDocTypes(ResourceDocletJsonXml.java:453)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.addResponseDoc(ResourceDocletJsonXml.java:428)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.start(ResourceDocletJsonXml.java:196)
at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)
at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
at java.lang.reflect.Method.invoke(Method.java:597)
at com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:269)
at com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:143)
at com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)
at com.sun.tools.javadoc.Start.begin(Start.java:128)
at com.sun.tools.javadoc.Main.execute(Main.java:41)
at com.sun.tools.javadoc.Main.main(Main.java:31)
</stacktrace>
</error>
if the review does not exist
{
"code" : "NotFound",
"message" : "Requested resource not found.",
"stacktrace" : "com.atlassian.crucible.spi.services.NotFoundException: Requested resource not found.\n\tat com.atlassian.crucible.spi.rpc.ExampleDocuments.<clinit>(ExampleDocuments.java:27)\n\tat sun.misc.Unsafe.ensureClassInitialized(Native Method)\n\tat sun.reflect.UnsafeFieldAccessorFactory.newFieldAccessor(UnsafeFieldAccessorFactory.java:25)\n\tat sun.reflect.ReflectionFactory.newFieldAccessor(ReflectionFactory.java:122)\n\tat java.lang.reflect.Field.acquireFieldAccessor(Field.java:918)\n\tat java.lang.reflect.Field.getFieldAccessor(Field.java:899)\n\tat java.lang.reflect.Field.get(Field.java:358)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedLinkFromTag(ResourceDocletJsonXml.java:649)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedExample(ResourceDocletJsonXml.java:542)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.createRepresentationDocTypes(ResourceDocletJsonXml.java:453)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.addResponseDoc(ResourceDocletJsonXml.java:428)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.start(ResourceDocletJsonXml.java:196)\n\tat sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)\n\tat sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)\n\tat sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)\n\tat java.lang.reflect.Method.invoke(Method.java:597)\n\tat com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:269)\n\tat com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:143)\n\tat com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)\n\tat com.sun.tools.javadoc.Start.begin(Start.java:128)\n\tat com.sun.tools.javadoc.Main.execute(Main.java:41)\n\tat com.sun.tools.javadoc.Main.main(Main.java:31)\n"
}if the review does not exist
| parameter | value | description |
|---|---|---|
|
id |
review perma-id |
| parameter | value | description |
|---|---|---|
|
render |
Default: false |
indicate whether to render the wiki text in the returned comments. If set to "true", the comments will contain a <messageAsHtml> element containing the wiki rendered html. |
available response representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<comments>
<generalCommentData>
<createDate>2015-04-28T09:47:56.281+0200</createDate>
<defectApproved>false</defectApproved>
<defectRaised>false</defectRaised>
<deleted>false</deleted>
<draft>false</draft>
<message>I thought you said you were going to *remove* this line?</message>
<messageAsHtml>I thought you said you were going to <b>remove</b> this line?</messageAsHtml>
<metrics/>
<parentCommentId/>
<readStatus>UNREAD</readStatus>
<replies/>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Joe Bloggs</displayName>
<userName>joe</userName>
</user>
<permId>
<id>CR:1</id>
</permId>
<permaId>
<id>CR:1</id>
</permaId>
</generalCommentData>
<generalCommentData>
<createDate>2015-04-28T09:47:56.281+0200</createDate>
<defectApproved>false</defectApproved>
<defectRaised>false</defectRaised>
<deleted>false</deleted>
<draft>false</draft>
<message>I thought you said you were going to *remove* this line?</message>
<messageAsHtml>I thought you said you were going to <b>remove</b> this line?</messageAsHtml>
<metrics/>
<parentCommentId/>
<readStatus>UNREAD</readStatus>
<replies/>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Joe Bloggs</displayName>
<userName>joe</userName>
</user>
<permId>
<id>CR:1</id>
</permId>
<permaId>
<id>CR:1</id>
</permaId>
</generalCommentData>
</comments>
the comments visible to the requesting user
{
"comments" : [ {
"metrics" : {
},
"message" : "I thought you said you were going to *remove* this line?",
"draft" : false,
"deleted" : false,
"defectRaised" : false,
"defectApproved" : false,
"readStatus" : "UNREAD",
"user" : {
"userName" : "joe",
"displayName" : "Joe Bloggs",
"avatarUrl" : "http://foo.com/avatar"
},
"createDate" : "2015-04-28T09:47:56.281+0200",
"permaId" : {
"id" : "CR:1"
},
"replies" : [ ],
"messageAsHtml" : "I thought you said you were going to <b>remove</b> this line?",
"permId" : {
"id" : "CR:1"
},
"parentCommentId" : {
}
}, {
"metrics" : {
},
"message" : "I thought you said you were going to *remove* this line?",
"draft" : false,
"deleted" : false,
"defectRaised" : false,
"defectApproved" : false,
"readStatus" : "UNREAD",
"user" : {
"userName" : "joe",
"displayName" : "Joe Bloggs",
"avatarUrl" : "http://foo.com/avatar"
},
"createDate" : "2015-04-28T09:47:56.281+0200",
"permaId" : {
"id" : "CR:1"
},
"replies" : [ ],
"messageAsHtml" : "I thought you said you were going to <b>remove</b> this line?",
"permId" : {
"id" : "CR:1"
},
"parentCommentId" : {
}
} ]
}the comments visible to the requesting user
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<error>
<code>PermaIdFormat</code>
<message>Malformed PermId.</message>
<stacktrace>com.cenqua.crucible.model.PermaIdFormatException: Malformed PermId.
at com.atlassian.crucible.spi.rpc.ExampleDocuments.<clinit>(ExampleDocuments.java:33)
at sun.misc.Unsafe.ensureClassInitialized(Native Method)
at sun.reflect.UnsafeFieldAccessorFactory.newFieldAccessor(UnsafeFieldAccessorFactory.java:25)
at sun.reflect.ReflectionFactory.newFieldAccessor(ReflectionFactory.java:122)
at java.lang.reflect.Field.acquireFieldAccessor(Field.java:918)
at java.lang.reflect.Field.getFieldAccessor(Field.java:899)
at java.lang.reflect.Field.get(Field.java:358)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedLinkFromTag(ResourceDocletJsonXml.java:649)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedExample(ResourceDocletJsonXml.java:542)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.createRepresentationDocTypes(ResourceDocletJsonXml.java:453)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.addResponseDoc(ResourceDocletJsonXml.java:428)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.start(ResourceDocletJsonXml.java:196)
at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)
at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
at java.lang.reflect.Method.invoke(Method.java:597)
at com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:269)
at com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:143)
at com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)
at com.sun.tools.javadoc.Start.begin(Start.java:128)
at com.sun.tools.javadoc.Main.execute(Main.java:41)
at com.sun.tools.javadoc.Main.main(Main.java:31)
</stacktrace>
</error>
if the review perma-id is not well-formed
{
"code" : "PermaIdFormat",
"message" : "Malformed PermId.",
"stacktrace" : "com.cenqua.crucible.model.PermaIdFormatException: Malformed PermId.\n\tat com.atlassian.crucible.spi.rpc.ExampleDocuments.<clinit>(ExampleDocuments.java:33)\n\tat sun.misc.Unsafe.ensureClassInitialized(Native Method)\n\tat sun.reflect.UnsafeFieldAccessorFactory.newFieldAccessor(UnsafeFieldAccessorFactory.java:25)\n\tat sun.reflect.ReflectionFactory.newFieldAccessor(ReflectionFactory.java:122)\n\tat java.lang.reflect.Field.acquireFieldAccessor(Field.java:918)\n\tat java.lang.reflect.Field.getFieldAccessor(Field.java:899)\n\tat java.lang.reflect.Field.get(Field.java:358)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedLinkFromTag(ResourceDocletJsonXml.java:649)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedExample(ResourceDocletJsonXml.java:542)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.createRepresentationDocTypes(ResourceDocletJsonXml.java:453)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.addResponseDoc(ResourceDocletJsonXml.java:428)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.start(ResourceDocletJsonXml.java:196)\n\tat sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)\n\tat sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)\n\tat sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)\n\tat java.lang.reflect.Method.invoke(Method.java:597)\n\tat com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:269)\n\tat com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:143)\n\tat com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)\n\tat com.sun.tools.javadoc.Start.begin(Start.java:128)\n\tat com.sun.tools.javadoc.Main.execute(Main.java:41)\n\tat com.sun.tools.javadoc.Main.main(Main.java:31)\n"
}if the review perma-id is not well-formed
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<error>
<code>NotPermitted</code>
<message>Access denied.</message>
<stacktrace>com.atlassian.crucible.spi.services.NotPermittedException: Access denied.
at com.atlassian.crucible.spi.rpc.ExampleDocuments.<clinit>(ExampleDocuments.java:21)
at sun.misc.Unsafe.ensureClassInitialized(Native Method)
at sun.reflect.UnsafeFieldAccessorFactory.newFieldAccessor(UnsafeFieldAccessorFactory.java:25)
at sun.reflect.ReflectionFactory.newFieldAccessor(ReflectionFactory.java:122)
at java.lang.reflect.Field.acquireFieldAccessor(Field.java:918)
at java.lang.reflect.Field.getFieldAccessor(Field.java:899)
at java.lang.reflect.Field.get(Field.java:358)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedLinkFromTag(ResourceDocletJsonXml.java:649)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedExample(ResourceDocletJsonXml.java:542)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.createRepresentationDocTypes(ResourceDocletJsonXml.java:453)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.addResponseDoc(ResourceDocletJsonXml.java:428)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.start(ResourceDocletJsonXml.java:196)
at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)
at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
at java.lang.reflect.Method.invoke(Method.java:597)
at com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:269)
at com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:143)
at com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)
at com.sun.tools.javadoc.Start.begin(Start.java:128)
at com.sun.tools.javadoc.Main.execute(Main.java:41)
at com.sun.tools.javadoc.Main.main(Main.java:31)
</stacktrace>
</error>
if you are not permitted to view the review
{
"code" : "NotPermitted",
"message" : "Access denied.",
"stacktrace" : "com.atlassian.crucible.spi.services.NotPermittedException: Access denied.\n\tat com.atlassian.crucible.spi.rpc.ExampleDocuments.<clinit>(ExampleDocuments.java:21)\n\tat sun.misc.Unsafe.ensureClassInitialized(Native Method)\n\tat sun.reflect.UnsafeFieldAccessorFactory.newFieldAccessor(UnsafeFieldAccessorFactory.java:25)\n\tat sun.reflect.ReflectionFactory.newFieldAccessor(ReflectionFactory.java:122)\n\tat java.lang.reflect.Field.acquireFieldAccessor(Field.java:918)\n\tat java.lang.reflect.Field.getFieldAccessor(Field.java:899)\n\tat java.lang.reflect.Field.get(Field.java:358)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedLinkFromTag(ResourceDocletJsonXml.java:649)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedExample(ResourceDocletJsonXml.java:542)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.createRepresentationDocTypes(ResourceDocletJsonXml.java:453)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.addResponseDoc(ResourceDocletJsonXml.java:428)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.start(ResourceDocletJsonXml.java:196)\n\tat sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)\n\tat sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)\n\tat sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)\n\tat java.lang.reflect.Method.invoke(Method.java:597)\n\tat com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:269)\n\tat com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:143)\n\tat com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)\n\tat com.sun.tools.javadoc.Start.begin(Start.java:128)\n\tat com.sun.tools.javadoc.Main.execute(Main.java:41)\n\tat com.sun.tools.javadoc.Main.main(Main.java:31)\n"
}if you are not permitted to view the review
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<error>
<code>NotFound</code>
<message>Requested resource not found.</message>
<stacktrace>com.atlassian.crucible.spi.services.NotFoundException: Requested resource not found.
at com.atlassian.crucible.spi.rpc.ExampleDocuments.<clinit>(ExampleDocuments.java:27)
at sun.misc.Unsafe.ensureClassInitialized(Native Method)
at sun.reflect.UnsafeFieldAccessorFactory.newFieldAccessor(UnsafeFieldAccessorFactory.java:25)
at sun.reflect.ReflectionFactory.newFieldAccessor(ReflectionFactory.java:122)
at java.lang.reflect.Field.acquireFieldAccessor(Field.java:918)
at java.lang.reflect.Field.getFieldAccessor(Field.java:899)
at java.lang.reflect.Field.get(Field.java:358)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedLinkFromTag(ResourceDocletJsonXml.java:649)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedExample(ResourceDocletJsonXml.java:542)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.createRepresentationDocTypes(ResourceDocletJsonXml.java:453)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.addResponseDoc(ResourceDocletJsonXml.java:428)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.start(ResourceDocletJsonXml.java:196)
at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)
at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
at java.lang.reflect.Method.invoke(Method.java:597)
at com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:269)
at com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:143)
at com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)
at com.sun.tools.javadoc.Start.begin(Start.java:128)
at com.sun.tools.javadoc.Main.execute(Main.java:41)
at com.sun.tools.javadoc.Main.main(Main.java:31)
</stacktrace>
</error>
if the review does not exist
{
"code" : "NotFound",
"message" : "Requested resource not found.",
"stacktrace" : "com.atlassian.crucible.spi.services.NotFoundException: Requested resource not found.\n\tat com.atlassian.crucible.spi.rpc.ExampleDocuments.<clinit>(ExampleDocuments.java:27)\n\tat sun.misc.Unsafe.ensureClassInitialized(Native Method)\n\tat sun.reflect.UnsafeFieldAccessorFactory.newFieldAccessor(UnsafeFieldAccessorFactory.java:25)\n\tat sun.reflect.ReflectionFactory.newFieldAccessor(ReflectionFactory.java:122)\n\tat java.lang.reflect.Field.acquireFieldAccessor(Field.java:918)\n\tat java.lang.reflect.Field.getFieldAccessor(Field.java:899)\n\tat java.lang.reflect.Field.get(Field.java:358)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedLinkFromTag(ResourceDocletJsonXml.java:649)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedExample(ResourceDocletJsonXml.java:542)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.createRepresentationDocTypes(ResourceDocletJsonXml.java:453)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.addResponseDoc(ResourceDocletJsonXml.java:428)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.start(ResourceDocletJsonXml.java:196)\n\tat sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)\n\tat sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)\n\tat sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)\n\tat java.lang.reflect.Method.invoke(Method.java:597)\n\tat com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:269)\n\tat com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:143)\n\tat com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)\n\tat com.sun.tools.javadoc.Start.begin(Start.java:128)\n\tat com.sun.tools.javadoc.Main.execute(Main.java:41)\n\tat com.sun.tools.javadoc.Main.main(Main.java:31)\n"
}if the review does not exist
| parameter | value | description |
|---|---|---|
|
id |
the review perma id |
|
|
riId |
the review item id. |
| parameter | value | description |
|---|---|---|
|
render |
Default: false |
indicate whether to render the wiki text in the returned comments. If set to "true", the comments will contain a <messageAsHtml> element containing the wiki rendered html. |
available response representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<comments>
<generalCommentData>
<createDate>2015-04-28T09:47:56.281+0200</createDate>
<defectApproved>false</defectApproved>
<defectRaised>false</defectRaised>
<deleted>false</deleted>
<draft>false</draft>
<message>I thought you said you were going to *remove* this line?</message>
<messageAsHtml>I thought you said you were going to <b>remove</b> this line?</messageAsHtml>
<metrics/>
<parentCommentId/>
<readStatus>UNREAD</readStatus>
<replies/>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Joe Bloggs</displayName>
<userName>joe</userName>
</user>
<permId>
<id>CR:1</id>
</permId>
<permaId>
<id>CR:1</id>
</permaId>
</generalCommentData>
<generalCommentData>
<createDate>2015-04-28T09:47:56.281+0200</createDate>
<defectApproved>false</defectApproved>
<defectRaised>false</defectRaised>
<deleted>false</deleted>
<draft>false</draft>
<message>I thought you said you were going to *remove* this line?</message>
<messageAsHtml>I thought you said you were going to <b>remove</b> this line?</messageAsHtml>
<metrics/>
<parentCommentId/>
<readStatus>UNREAD</readStatus>
<replies/>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Joe Bloggs</displayName>
<userName>joe</userName>
</user>
<permId>
<id>CR:1</id>
</permId>
<permaId>
<id>CR:1</id>
</permaId>
</generalCommentData>
<versionedLineCommentData>
<createDate>2015-04-28T09:47:56.313+0200</createDate>
<defectApproved>false</defectApproved>
<defectRaised>false</defectRaised>
<deleted>false</deleted>
<draft>false</draft>
<message>*bold* message</message>
<messageAsHtml><p><b>bold</b> message</p></messageAsHtml>
<parentCommentId/>
<readStatus>READ</readStatus>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Fred Veiligheidspet</displayName>
<userName>fred</userName>
</user>
<permaId/>
<reviewItemId>
<id>CRFX-1234</id>
</reviewItemId>
<fromLineRange>10</fromLineRange>
<toLineRange>20</toLineRange>
</versionedLineCommentData>
<versionedLineCommentData>
<createDate>2015-04-28T09:47:56.313+0200</createDate>
<defectApproved>false</defectApproved>
<defectRaised>false</defectRaised>
<deleted>false</deleted>
<draft>false</draft>
<message>*bold* message</message>
<messageAsHtml><p><b>bold</b> message</p></messageAsHtml>
<parentCommentId/>
<readStatus>READ</readStatus>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Fred Veiligheidspet</displayName>
<userName>fred</userName>
</user>
<permaId/>
<reviewItemId>
<id>CRFX-1234</id>
</reviewItemId>
<fromLineRange>10</fromLineRange>
<toLineRange>20</toLineRange>
</versionedLineCommentData>
</comments>
the comments visible to the requesting user
{
"comments" : [ {
"metrics" : {
},
"message" : "I thought you said you were going to *remove* this line?",
"draft" : false,
"deleted" : false,
"defectRaised" : false,
"defectApproved" : false,
"readStatus" : "UNREAD",
"user" : {
"userName" : "joe",
"displayName" : "Joe Bloggs",
"avatarUrl" : "http://foo.com/avatar"
},
"createDate" : "2015-04-28T09:47:56.281+0200",
"permaId" : {
"id" : "CR:1"
},
"replies" : [ ],
"messageAsHtml" : "I thought you said you were going to <b>remove</b> this line?",
"permId" : {
"id" : "CR:1"
},
"parentCommentId" : {
}
}, {
"metrics" : {
},
"message" : "I thought you said you were going to *remove* this line?",
"draft" : false,
"deleted" : false,
"defectRaised" : false,
"defectApproved" : false,
"readStatus" : "UNREAD",
"user" : {
"userName" : "joe",
"displayName" : "Joe Bloggs",
"avatarUrl" : "http://foo.com/avatar"
},
"createDate" : "2015-04-28T09:47:56.281+0200",
"permaId" : {
"id" : "CR:1"
},
"replies" : [ ],
"messageAsHtml" : "I thought you said you were going to <b>remove</b> this line?",
"permId" : {
"id" : "CR:1"
},
"parentCommentId" : {
}
}, {
"message" : "*bold* message",
"draft" : false,
"deleted" : false,
"defectRaised" : false,
"defectApproved" : false,
"readStatus" : "READ",
"user" : {
"userName" : "fred",
"displayName" : "Fred Veiligheidspet",
"avatarUrl" : "http://foo.com/avatar"
},
"createDate" : 1430207276313,
"messageAsHtml" : "<p><b>bold</b> message</p>",
"reviewItemId" : {
"id" : "CRFX-1234"
},
"fromLineRange" : "10",
"toLineRange" : "20"
}, {
"message" : "*bold* message",
"draft" : false,
"deleted" : false,
"defectRaised" : false,
"defectApproved" : false,
"readStatus" : "READ",
"user" : {
"userName" : "fred",
"displayName" : "Fred Veiligheidspet",
"avatarUrl" : "http://foo.com/avatar"
},
"createDate" : 1430207276313,
"messageAsHtml" : "<p><b>bold</b> message</p>",
"reviewItemId" : {
"id" : "CRFX-1234"
},
"fromLineRange" : "10",
"toLineRange" : "20"
} ]
}the comments visible to the requesting user
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<error>
<code>PermaIdFormat</code>
<message>Malformed PermId.</message>
<stacktrace>com.cenqua.crucible.model.PermaIdFormatException: Malformed PermId.
at com.atlassian.crucible.spi.rpc.ExampleDocuments.<clinit>(ExampleDocuments.java:33)
at sun.misc.Unsafe.ensureClassInitialized(Native Method)
at sun.reflect.UnsafeFieldAccessorFactory.newFieldAccessor(UnsafeFieldAccessorFactory.java:25)
at sun.reflect.ReflectionFactory.newFieldAccessor(ReflectionFactory.java:122)
at java.lang.reflect.Field.acquireFieldAccessor(Field.java:918)
at java.lang.reflect.Field.getFieldAccessor(Field.java:899)
at java.lang.reflect.Field.get(Field.java:358)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedLinkFromTag(ResourceDocletJsonXml.java:649)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedExample(ResourceDocletJsonXml.java:542)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.createRepresentationDocTypes(ResourceDocletJsonXml.java:453)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.addResponseDoc(ResourceDocletJsonXml.java:428)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.start(ResourceDocletJsonXml.java:196)
at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)
at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
at java.lang.reflect.Method.invoke(Method.java:597)
at com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:269)
at com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:143)
at com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)
at com.sun.tools.javadoc.Start.begin(Start.java:128)
at com.sun.tools.javadoc.Main.execute(Main.java:41)
at com.sun.tools.javadoc.Main.main(Main.java:31)
</stacktrace>
</error>
if the review perma-id is not well-formed
{
"code" : "PermaIdFormat",
"message" : "Malformed PermId.",
"stacktrace" : "com.cenqua.crucible.model.PermaIdFormatException: Malformed PermId.\n\tat com.atlassian.crucible.spi.rpc.ExampleDocuments.<clinit>(ExampleDocuments.java:33)\n\tat sun.misc.Unsafe.ensureClassInitialized(Native Method)\n\tat sun.reflect.UnsafeFieldAccessorFactory.newFieldAccessor(UnsafeFieldAccessorFactory.java:25)\n\tat sun.reflect.ReflectionFactory.newFieldAccessor(ReflectionFactory.java:122)\n\tat java.lang.reflect.Field.acquireFieldAccessor(Field.java:918)\n\tat java.lang.reflect.Field.getFieldAccessor(Field.java:899)\n\tat java.lang.reflect.Field.get(Field.java:358)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedLinkFromTag(ResourceDocletJsonXml.java:649)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedExample(ResourceDocletJsonXml.java:542)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.createRepresentationDocTypes(ResourceDocletJsonXml.java:453)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.addResponseDoc(ResourceDocletJsonXml.java:428)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.start(ResourceDocletJsonXml.java:196)\n\tat sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)\n\tat sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)\n\tat sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)\n\tat java.lang.reflect.Method.invoke(Method.java:597)\n\tat com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:269)\n\tat com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:143)\n\tat com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)\n\tat com.sun.tools.javadoc.Start.begin(Start.java:128)\n\tat com.sun.tools.javadoc.Main.execute(Main.java:41)\n\tat com.sun.tools.javadoc.Main.main(Main.java:31)\n"
}if the review perma-id is not well-formed
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<error>
<code>NotPermitted</code>
<message>Access denied.</message>
<stacktrace>com.atlassian.crucible.spi.services.NotPermittedException: Access denied.
at com.atlassian.crucible.spi.rpc.ExampleDocuments.<clinit>(ExampleDocuments.java:21)
at sun.misc.Unsafe.ensureClassInitialized(Native Method)
at sun.reflect.UnsafeFieldAccessorFactory.newFieldAccessor(UnsafeFieldAccessorFactory.java:25)
at sun.reflect.ReflectionFactory.newFieldAccessor(ReflectionFactory.java:122)
at java.lang.reflect.Field.acquireFieldAccessor(Field.java:918)
at java.lang.reflect.Field.getFieldAccessor(Field.java:899)
at java.lang.reflect.Field.get(Field.java:358)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedLinkFromTag(ResourceDocletJsonXml.java:649)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedExample(ResourceDocletJsonXml.java:542)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.createRepresentationDocTypes(ResourceDocletJsonXml.java:453)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.addResponseDoc(ResourceDocletJsonXml.java:428)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.start(ResourceDocletJsonXml.java:196)
at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)
at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
at java.lang.reflect.Method.invoke(Method.java:597)
at com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:269)
at com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:143)
at com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)
at com.sun.tools.javadoc.Start.begin(Start.java:128)
at com.sun.tools.javadoc.Main.execute(Main.java:41)
at com.sun.tools.javadoc.Main.main(Main.java:31)
</stacktrace>
</error>
if you are not permitted to view the review
{
"code" : "NotPermitted",
"message" : "Access denied.",
"stacktrace" : "com.atlassian.crucible.spi.services.NotPermittedException: Access denied.\n\tat com.atlassian.crucible.spi.rpc.ExampleDocuments.<clinit>(ExampleDocuments.java:21)\n\tat sun.misc.Unsafe.ensureClassInitialized(Native Method)\n\tat sun.reflect.UnsafeFieldAccessorFactory.newFieldAccessor(UnsafeFieldAccessorFactory.java:25)\n\tat sun.reflect.ReflectionFactory.newFieldAccessor(ReflectionFactory.java:122)\n\tat java.lang.reflect.Field.acquireFieldAccessor(Field.java:918)\n\tat java.lang.reflect.Field.getFieldAccessor(Field.java:899)\n\tat java.lang.reflect.Field.get(Field.java:358)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedLinkFromTag(ResourceDocletJsonXml.java:649)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedExample(ResourceDocletJsonXml.java:542)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.createRepresentationDocTypes(ResourceDocletJsonXml.java:453)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.addResponseDoc(ResourceDocletJsonXml.java:428)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.start(ResourceDocletJsonXml.java:196)\n\tat sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)\n\tat sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)\n\tat sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)\n\tat java.lang.reflect.Method.invoke(Method.java:597)\n\tat com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:269)\n\tat com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:143)\n\tat com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)\n\tat com.sun.tools.javadoc.Start.begin(Start.java:128)\n\tat com.sun.tools.javadoc.Main.execute(Main.java:41)\n\tat com.sun.tools.javadoc.Main.main(Main.java:31)\n"
}if you are not permitted to view the review
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<error>
<code>NotFound</code>
<message>Requested resource not found.</message>
<stacktrace>com.atlassian.crucible.spi.services.NotFoundException: Requested resource not found.
at com.atlassian.crucible.spi.rpc.ExampleDocuments.<clinit>(ExampleDocuments.java:27)
at sun.misc.Unsafe.ensureClassInitialized(Native Method)
at sun.reflect.UnsafeFieldAccessorFactory.newFieldAccessor(UnsafeFieldAccessorFactory.java:25)
at sun.reflect.ReflectionFactory.newFieldAccessor(ReflectionFactory.java:122)
at java.lang.reflect.Field.acquireFieldAccessor(Field.java:918)
at java.lang.reflect.Field.getFieldAccessor(Field.java:899)
at java.lang.reflect.Field.get(Field.java:358)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedLinkFromTag(ResourceDocletJsonXml.java:649)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedExample(ResourceDocletJsonXml.java:542)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.createRepresentationDocTypes(ResourceDocletJsonXml.java:453)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.addResponseDoc(ResourceDocletJsonXml.java:428)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.start(ResourceDocletJsonXml.java:196)
at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)
at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
at java.lang.reflect.Method.invoke(Method.java:597)
at com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:269)
at com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:143)
at com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)
at com.sun.tools.javadoc.Start.begin(Start.java:128)
at com.sun.tools.javadoc.Main.execute(Main.java:41)
at com.sun.tools.javadoc.Main.main(Main.java:31)
</stacktrace>
</error>
if the review does not exist
{
"code" : "NotFound",
"message" : "Requested resource not found.",
"stacktrace" : "com.atlassian.crucible.spi.services.NotFoundException: Requested resource not found.\n\tat com.atlassian.crucible.spi.rpc.ExampleDocuments.<clinit>(ExampleDocuments.java:27)\n\tat sun.misc.Unsafe.ensureClassInitialized(Native Method)\n\tat sun.reflect.UnsafeFieldAccessorFactory.newFieldAccessor(UnsafeFieldAccessorFactory.java:25)\n\tat sun.reflect.ReflectionFactory.newFieldAccessor(ReflectionFactory.java:122)\n\tat java.lang.reflect.Field.acquireFieldAccessor(Field.java:918)\n\tat java.lang.reflect.Field.getFieldAccessor(Field.java:899)\n\tat java.lang.reflect.Field.get(Field.java:358)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedLinkFromTag(ResourceDocletJsonXml.java:649)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedExample(ResourceDocletJsonXml.java:542)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.createRepresentationDocTypes(ResourceDocletJsonXml.java:453)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.addResponseDoc(ResourceDocletJsonXml.java:428)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.start(ResourceDocletJsonXml.java:196)\n\tat sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)\n\tat sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)\n\tat sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)\n\tat java.lang.reflect.Method.invoke(Method.java:597)\n\tat com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:269)\n\tat com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:143)\n\tat com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)\n\tat com.sun.tools.javadoc.Start.begin(Start.java:128)\n\tat com.sun.tools.javadoc.Main.execute(Main.java:41)\n\tat com.sun.tools.javadoc.Main.main(Main.java:31)\n"
}if the review does not exist
This call includes the Location repsonse header that contains the URL of the newly created entity.
acceptable request representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<versionedLineCommentData>
<createDate>2015-04-28T09:47:56.313+0200</createDate>
<defectApproved>false</defectApproved>
<defectRaised>false</defectRaised>
<deleted>false</deleted>
<draft>false</draft>
<message>*bold* message</message>
<messageAsHtml><p><b>bold</b> message</p></messageAsHtml>
<parentCommentId/>
<readStatus>READ</readStatus>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Fred Veiligheidspet</displayName>
<userName>fred</userName>
</user>
<permaId/>
<reviewItemId>
<id>CRFX-1234</id>
</reviewItemId>
<fromLineRange>10</fromLineRange>
<toLineRange>20</toLineRange>
</versionedLineCommentData>
Source: crucible.xsd
<xs:element name="versionedLineCommentData" type="versionedLineCommentData"/>
{
"message" : "*bold* message",
"draft" : false,
"deleted" : false,
"defectRaised" : false,
"defectApproved" : false,
"readStatus" : "READ",
"user" : {
"userName" : "fred",
"displayName" : "Fred Veiligheidspet",
"avatarUrl" : "http://foo.com/avatar"
},
"createDate" : 1430207276313,
"messageAsHtml" : "<p><b>bold</b> message</p>",
"reviewItemId" : {
"id" : "CRFX-1234"
},
"fromLineRange" : "10",
"toLineRange" : "20"
}Source: crucible.xsd
<xs:element name="versionedLineCommentData" type="versionedLineCommentData"/>
available response representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<versionedLineCommentData>
<createDate>2015-04-28T09:47:56.313+0200</createDate>
<defectApproved>false</defectApproved>
<defectRaised>false</defectRaised>
<deleted>false</deleted>
<draft>false</draft>
<message>*bold* message</message>
<messageAsHtml><p><b>bold</b> message</p></messageAsHtml>
<parentCommentId/>
<readStatus>READ</readStatus>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Fred Veiligheidspet</displayName>
<userName>fred</userName>
</user>
<permaId/>
<reviewItemId>
<id>CRFX-1234</id>
</reviewItemId>
<fromLineRange>10</fromLineRange>
<toLineRange>20</toLineRange>
</versionedLineCommentData>
the returned comment
{
"message" : "*bold* message",
"draft" : false,
"deleted" : false,
"defectRaised" : false,
"defectApproved" : false,
"readStatus" : "READ",
"user" : {
"userName" : "fred",
"displayName" : "Fred Veiligheidspet",
"avatarUrl" : "http://foo.com/avatar"
},
"createDate" : 1430207276313,
"messageAsHtml" : "<p><b>bold</b> message</p>",
"reviewItemId" : {
"id" : "CRFX-1234"
},
"fromLineRange" : "10",
"toLineRange" : "20"
}the returned comment
| parameter | value | description |
|---|---|---|
|
id |
the review perma-id (e.g. "CR-45"). |
|
|
cId |
the comment to reply to |
Gets the replies to the given comment.
| parameter | value | description |
|---|---|---|
|
render |
Default: false |
true if the comments should also be rendered into html, into the element <messageAsHtml> |
available response representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<comments>
<generalCommentData>
<createDate>2015-04-28T09:47:56.281+0200</createDate>
<defectApproved>false</defectApproved>
<defectRaised>false</defectRaised>
<deleted>false</deleted>
<draft>false</draft>
<message>I thought you said you were going to *remove* this line?</message>
<messageAsHtml>I thought you said you were going to <b>remove</b> this line?</messageAsHtml>
<metrics/>
<parentCommentId/>
<readStatus>UNREAD</readStatus>
<replies/>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Joe Bloggs</displayName>
<userName>joe</userName>
</user>
<permId>
<id>CR:1</id>
</permId>
<permaId>
<id>CR:1</id>
</permaId>
</generalCommentData>
<generalCommentData>
<createDate>2015-04-28T09:47:56.281+0200</createDate>
<defectApproved>false</defectApproved>
<defectRaised>false</defectRaised>
<deleted>false</deleted>
<draft>false</draft>
<message>I thought you said you were going to *remove* this line?</message>
<messageAsHtml>I thought you said you were going to <b>remove</b> this line?</messageAsHtml>
<metrics/>
<parentCommentId/>
<readStatus>UNREAD</readStatus>
<replies/>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Joe Bloggs</displayName>
<userName>joe</userName>
</user>
<permId>
<id>CR:1</id>
</permId>
<permaId>
<id>CR:1</id>
</permaId>
</generalCommentData>
</comments>
the comments visible to the requesting user
{
"comments" : [ {
"metrics" : {
},
"message" : "I thought you said you were going to *remove* this line?",
"draft" : false,
"deleted" : false,
"defectRaised" : false,
"defectApproved" : false,
"readStatus" : "UNREAD",
"user" : {
"userName" : "joe",
"displayName" : "Joe Bloggs",
"avatarUrl" : "http://foo.com/avatar"
},
"createDate" : "2015-04-28T09:47:56.281+0200",
"permaId" : {
"id" : "CR:1"
},
"replies" : [ ],
"messageAsHtml" : "I thought you said you were going to <b>remove</b> this line?",
"permId" : {
"id" : "CR:1"
},
"parentCommentId" : {
}
}, {
"metrics" : {
},
"message" : "I thought you said you were going to *remove* this line?",
"draft" : false,
"deleted" : false,
"defectRaised" : false,
"defectApproved" : false,
"readStatus" : "UNREAD",
"user" : {
"userName" : "joe",
"displayName" : "Joe Bloggs",
"avatarUrl" : "http://foo.com/avatar"
},
"createDate" : "2015-04-28T09:47:56.281+0200",
"permaId" : {
"id" : "CR:1"
},
"replies" : [ ],
"messageAsHtml" : "I thought you said you were going to <b>remove</b> this line?",
"permId" : {
"id" : "CR:1"
},
"parentCommentId" : {
}
} ]
}the comments visible to the requesting user
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<error>
<code>PermaIdFormat</code>
<message>Malformed PermId.</message>
<stacktrace>com.cenqua.crucible.model.PermaIdFormatException: Malformed PermId.
at com.atlassian.crucible.spi.rpc.ExampleDocuments.<clinit>(ExampleDocuments.java:33)
at sun.misc.Unsafe.ensureClassInitialized(Native Method)
at sun.reflect.UnsafeFieldAccessorFactory.newFieldAccessor(UnsafeFieldAccessorFactory.java:25)
at sun.reflect.ReflectionFactory.newFieldAccessor(ReflectionFactory.java:122)
at java.lang.reflect.Field.acquireFieldAccessor(Field.java:918)
at java.lang.reflect.Field.getFieldAccessor(Field.java:899)
at java.lang.reflect.Field.get(Field.java:358)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedLinkFromTag(ResourceDocletJsonXml.java:649)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedExample(ResourceDocletJsonXml.java:542)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.createRepresentationDocTypes(ResourceDocletJsonXml.java:453)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.addResponseDoc(ResourceDocletJsonXml.java:428)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.start(ResourceDocletJsonXml.java:196)
at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)
at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
at java.lang.reflect.Method.invoke(Method.java:597)
at com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:269)
at com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:143)
at com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)
at com.sun.tools.javadoc.Start.begin(Start.java:128)
at com.sun.tools.javadoc.Main.execute(Main.java:41)
at com.sun.tools.javadoc.Main.main(Main.java:31)
</stacktrace>
</error>
if the review perma-id is not well-formed
{
"code" : "PermaIdFormat",
"message" : "Malformed PermId.",
"stacktrace" : "com.cenqua.crucible.model.PermaIdFormatException: Malformed PermId.\n\tat com.atlassian.crucible.spi.rpc.ExampleDocuments.<clinit>(ExampleDocuments.java:33)\n\tat sun.misc.Unsafe.ensureClassInitialized(Native Method)\n\tat sun.reflect.UnsafeFieldAccessorFactory.newFieldAccessor(UnsafeFieldAccessorFactory.java:25)\n\tat sun.reflect.ReflectionFactory.newFieldAccessor(ReflectionFactory.java:122)\n\tat java.lang.reflect.Field.acquireFieldAccessor(Field.java:918)\n\tat java.lang.reflect.Field.getFieldAccessor(Field.java:899)\n\tat java.lang.reflect.Field.get(Field.java:358)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedLinkFromTag(ResourceDocletJsonXml.java:649)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedExample(ResourceDocletJsonXml.java:542)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.createRepresentationDocTypes(ResourceDocletJsonXml.java:453)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.addResponseDoc(ResourceDocletJsonXml.java:428)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.start(ResourceDocletJsonXml.java:196)\n\tat sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)\n\tat sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)\n\tat sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)\n\tat java.lang.reflect.Method.invoke(Method.java:597)\n\tat com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:269)\n\tat com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:143)\n\tat com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)\n\tat com.sun.tools.javadoc.Start.begin(Start.java:128)\n\tat com.sun.tools.javadoc.Main.execute(Main.java:41)\n\tat com.sun.tools.javadoc.Main.main(Main.java:31)\n"
}if the review perma-id is not well-formed
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<error>
<code>NotPermitted</code>
<message>Access denied.</message>
<stacktrace>com.atlassian.crucible.spi.services.NotPermittedException: Access denied.
at com.atlassian.crucible.spi.rpc.ExampleDocuments.<clinit>(ExampleDocuments.java:21)
at sun.misc.Unsafe.ensureClassInitialized(Native Method)
at sun.reflect.UnsafeFieldAccessorFactory.newFieldAccessor(UnsafeFieldAccessorFactory.java:25)
at sun.reflect.ReflectionFactory.newFieldAccessor(ReflectionFactory.java:122)
at java.lang.reflect.Field.acquireFieldAccessor(Field.java:918)
at java.lang.reflect.Field.getFieldAccessor(Field.java:899)
at java.lang.reflect.Field.get(Field.java:358)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedLinkFromTag(ResourceDocletJsonXml.java:649)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedExample(ResourceDocletJsonXml.java:542)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.createRepresentationDocTypes(ResourceDocletJsonXml.java:453)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.addResponseDoc(ResourceDocletJsonXml.java:428)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.start(ResourceDocletJsonXml.java:196)
at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)
at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
at java.lang.reflect.Method.invoke(Method.java:597)
at com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:269)
at com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:143)
at com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)
at com.sun.tools.javadoc.Start.begin(Start.java:128)
at com.sun.tools.javadoc.Main.execute(Main.java:41)
at com.sun.tools.javadoc.Main.main(Main.java:31)
</stacktrace>
</error>
if you are not permitted to view the review
{
"code" : "NotPermitted",
"message" : "Access denied.",
"stacktrace" : "com.atlassian.crucible.spi.services.NotPermittedException: Access denied.\n\tat com.atlassian.crucible.spi.rpc.ExampleDocuments.<clinit>(ExampleDocuments.java:21)\n\tat sun.misc.Unsafe.ensureClassInitialized(Native Method)\n\tat sun.reflect.UnsafeFieldAccessorFactory.newFieldAccessor(UnsafeFieldAccessorFactory.java:25)\n\tat sun.reflect.ReflectionFactory.newFieldAccessor(ReflectionFactory.java:122)\n\tat java.lang.reflect.Field.acquireFieldAccessor(Field.java:918)\n\tat java.lang.reflect.Field.getFieldAccessor(Field.java:899)\n\tat java.lang.reflect.Field.get(Field.java:358)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedLinkFromTag(ResourceDocletJsonXml.java:649)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedExample(ResourceDocletJsonXml.java:542)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.createRepresentationDocTypes(ResourceDocletJsonXml.java:453)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.addResponseDoc(ResourceDocletJsonXml.java:428)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.start(ResourceDocletJsonXml.java:196)\n\tat sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)\n\tat sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)\n\tat sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)\n\tat java.lang.reflect.Method.invoke(Method.java:597)\n\tat com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:269)\n\tat com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:143)\n\tat com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)\n\tat com.sun.tools.javadoc.Start.begin(Start.java:128)\n\tat com.sun.tools.javadoc.Main.execute(Main.java:41)\n\tat com.sun.tools.javadoc.Main.main(Main.java:31)\n"
}if you are not permitted to view the review
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<error>
<code>NotFound</code>
<message>Requested resource not found.</message>
<stacktrace>com.atlassian.crucible.spi.services.NotFoundException: Requested resource not found.
at com.atlassian.crucible.spi.rpc.ExampleDocuments.<clinit>(ExampleDocuments.java:27)
at sun.misc.Unsafe.ensureClassInitialized(Native Method)
at sun.reflect.UnsafeFieldAccessorFactory.newFieldAccessor(UnsafeFieldAccessorFactory.java:25)
at sun.reflect.ReflectionFactory.newFieldAccessor(ReflectionFactory.java:122)
at java.lang.reflect.Field.acquireFieldAccessor(Field.java:918)
at java.lang.reflect.Field.getFieldAccessor(Field.java:899)
at java.lang.reflect.Field.get(Field.java:358)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedLinkFromTag(ResourceDocletJsonXml.java:649)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedExample(ResourceDocletJsonXml.java:542)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.createRepresentationDocTypes(ResourceDocletJsonXml.java:453)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.addResponseDoc(ResourceDocletJsonXml.java:428)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.start(ResourceDocletJsonXml.java:196)
at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)
at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
at java.lang.reflect.Method.invoke(Method.java:597)
at com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:269)
at com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:143)
at com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)
at com.sun.tools.javadoc.Start.begin(Start.java:128)
at com.sun.tools.javadoc.Main.execute(Main.java:41)
at com.sun.tools.javadoc.Main.main(Main.java:31)
</stacktrace>
</error>
if the review does not exist
{
"code" : "NotFound",
"message" : "Requested resource not found.",
"stacktrace" : "com.atlassian.crucible.spi.services.NotFoundException: Requested resource not found.\n\tat com.atlassian.crucible.spi.rpc.ExampleDocuments.<clinit>(ExampleDocuments.java:27)\n\tat sun.misc.Unsafe.ensureClassInitialized(Native Method)\n\tat sun.reflect.UnsafeFieldAccessorFactory.newFieldAccessor(UnsafeFieldAccessorFactory.java:25)\n\tat sun.reflect.ReflectionFactory.newFieldAccessor(ReflectionFactory.java:122)\n\tat java.lang.reflect.Field.acquireFieldAccessor(Field.java:918)\n\tat java.lang.reflect.Field.getFieldAccessor(Field.java:899)\n\tat java.lang.reflect.Field.get(Field.java:358)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedLinkFromTag(ResourceDocletJsonXml.java:649)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedExample(ResourceDocletJsonXml.java:542)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.createRepresentationDocTypes(ResourceDocletJsonXml.java:453)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.addResponseDoc(ResourceDocletJsonXml.java:428)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.start(ResourceDocletJsonXml.java:196)\n\tat sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)\n\tat sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)\n\tat sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)\n\tat java.lang.reflect.Method.invoke(Method.java:597)\n\tat com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:269)\n\tat com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:143)\n\tat com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)\n\tat com.sun.tools.javadoc.Start.begin(Start.java:128)\n\tat com.sun.tools.javadoc.Main.execute(Main.java:41)\n\tat com.sun.tools.javadoc.Main.main(Main.java:31)\n"
}if the review does not exist
Adds a reply to the given comment. This call includes the Location repsonse header that
contains the URL of the newly created entity.
acceptable request representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<generalCommentData>
<defectApproved>false</defectApproved>
<defectRaised>false</defectRaised>
<deleted>false</deleted>
<draft>true</draft>
<message>I thought you said you were going to remove this line?</message>
<parentCommentId/>
<permId/>
<permaId/>
</generalCommentData>
{
"message" : "I thought you said you were going to remove this line?",
"draft" : true,
"deleted" : false,
"defectRaised" : false,
"defectApproved" : false,
"permaId" : {
},
"permId" : {
},
"parentCommentId" : {
}
}available response representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<generalCommentData>
<createDate>2015-04-28T09:47:56.281+0200</createDate>
<defectApproved>false</defectApproved>
<defectRaised>false</defectRaised>
<deleted>false</deleted>
<draft>false</draft>
<message>I thought you said you were going to *remove* this line?</message>
<messageAsHtml>I thought you said you were going to <b>remove</b> this line?</messageAsHtml>
<metrics/>
<parentCommentId/>
<readStatus>UNREAD</readStatus>
<replies/>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Joe Bloggs</displayName>
<userName>joe</userName>
</user>
<permId>
<id>CR:1</id>
</permId>
<permaId>
<id>CR:1</id>
</permaId>
</generalCommentData>
the newly created comment, with its URI in the Location header
{
"metrics" : {
},
"message" : "I thought you said you were going to *remove* this line?",
"draft" : false,
"deleted" : false,
"defectRaised" : false,
"defectApproved" : false,
"readStatus" : "UNREAD",
"user" : {
"userName" : "joe",
"displayName" : "Joe Bloggs",
"avatarUrl" : "http://foo.com/avatar"
},
"createDate" : "2015-04-28T09:47:56.281+0200",
"permaId" : {
"id" : "CR:1"
},
"replies" : [ ],
"messageAsHtml" : "I thought you said you were going to <b>remove</b> this line?",
"permId" : {
"id" : "CR:1"
},
"parentCommentId" : {
}
}the newly created comment, with its URI in the Location header
| parameter | value | description |
|---|---|---|
|
id |
the review perma-id (e.g. "CR-45"). |
For the effective user, mark all comments in a review as read (except those marked as leave unread).
available response representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<detailedReviewData>
<allowReviewersToJoin>true</allowReviewersToJoin>
<author>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Joe Krustofski</displayName>
<userName>joe</userName>
</author>
<createDate>2015-04-28T09:47:56.272+0200</createDate>
<creator>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Joe Krustofski</displayName>
<userName>joe</userName>
</creator>
<description>Description or statement of objectives for this example review.</description>
<dueDate>2015-04-29T09:47:56.272+0200</dueDate>
<jiraIssueKey>FOO-6754</jiraIssueKey>
<metricsVersion>4</metricsVersion>
<moderator>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Scott the Moderator</displayName>
<userName>scott</userName>
</moderator>
<name>Example review.</name>
<permaId>
<id>CR-FOO-21</id>
</permaId>
<permaIdHistory>CR-FOO-21</permaIdHistory>
<projectKey>CR-FOO</projectKey>
<type>REVIEW</type>
<actions>
<actionData>
<displayName>Abandon</displayName>
<name>action:abandonReview</name>
</actionData>
<actionData>
<displayName>Approve</displayName>
<name>action:approveReview</name>
</actionData>
<actionData>
<displayName>Comment</displayName>
<name>action:commentOnReview</name>
</actionData>
<actionData>
<displayName>Complete</displayName>
<name>action:completeReview</name>
</actionData>
<actionData>
<displayName>Edit Review Details</displayName>
<name>action:modifyReviewFiles</name>
</actionData>
</actions>
<generalComments>
<generalCommentData>
<createDate>2015-04-28T09:47:56.281+0200</createDate>
<defectApproved>false</defectApproved>
<defectRaised>false</defectRaised>
<deleted>false</deleted>
<draft>false</draft>
<message>I thought you said you were going to *remove* this line?</message>
<messageAsHtml>I thought you said you were going to <b>remove</b> this line?</messageAsHtml>
<metrics/>
<parentCommentId/>
<readStatus>UNREAD</readStatus>
<replies/>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Joe Bloggs</displayName>
<userName>joe</userName>
</user>
<permId>
<id>CR:1</id>
</permId>
<permaId>
<id>CR:1</id>
</permaId>
</generalCommentData>
</generalComments>
<reviewItems>
<reviewItem>
<participants>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Fred Eaglesmith</displayName>
<userName>fred</userName>
</user>
<completed>false</completed>
</participant>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Corb Lund</displayName>
<userName>clund</userName>
</user>
<completed>false</completed>
</participant>
</participants>
<permId>
<id>CFR-65</id>
</permId>
<anchorData>
<anchorPath>trunk</anchorPath>
<anchorRepository>REPO</anchorRepository>
<stripCount>0</stripCount>
</anchorData>
<authorName>evzijst</authorName>
<commitDate>2015-04-28T09:47:56.310+02:00</commitDate>
<commitType>Modified</commitType>
<fileType>File</fileType>
<fromContentUrl>/context/cru/CR-FOO-21/rawcontent/5687/dir64/a.txt</fromContentUrl>
<fromPath>dir64/a.txt</fromPath>
<fromRevision>65</fromRevision>
<patchUrl>/contextcru/CR-FOO-21/downloadpatch/6238/patch-7126.patch</patchUrl>
<repositoryName>REPO</repositoryName>
<showAsDiff>false</showAsDiff>
<toContentUrl>/context/cru/CR-FOO-21/rawcontent/6675/dir64/a.txt</toContentUrl>
<toPath>dir64/a.txt</toPath>
<toRevision>651</toRevision>
</reviewItem>
<reviewItem>
<participants>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Fred Eaglesmith</displayName>
<userName>fred</userName>
</user>
<completed>false</completed>
</participant>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Corb Lund</displayName>
<userName>clund</userName>
</user>
<completed>false</completed>
</participant>
</participants>
<permId>
<id>CFR-66</id>
</permId>
<anchorData>
<anchorPath>branches/branch1</anchorPath>
<anchorRepository>REPO</anchorRepository>
<stripCount>0</stripCount>
</anchorData>
<authorName>evzijst</authorName>
<commitDate>2015-04-28T09:47:56.310+02:00</commitDate>
<commitType>Modified</commitType>
<fileType>File</fileType>
<fromContentUrl>/context/cru/CR-FOO-21/rawcontent/5690/dir65/d.txt</fromContentUrl>
<fromPath>dir65/d.txt</fromPath>
<fromRevision>66</fromRevision>
<patchUrl>/contextcru/CR-FOO-21/downloadpatch/6273/patch-6173.patch</patchUrl>
<repositoryName>REPO</repositoryName>
<showAsDiff>true</showAsDiff>
<toContentUrl>/context/cru/CR-FOO-21/rawcontent/6085/dir65/d.txt</toContentUrl>
<toPath>dir65/d.txt</toPath>
<toRevision>661</toRevision>
</reviewItem>
<reviewItem>
<participants>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Fred Eaglesmith</displayName>
<userName>fred</userName>
</user>
<completed>false</completed>
</participant>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Corb Lund</displayName>
<userName>clund</userName>
</user>
<completed>false</completed>
</participant>
</participants>
<permId>
<id>CFR-67</id>
</permId>
<anchorData>
<anchorPath>branches/branch1</anchorPath>
<anchorRepository>REPO</anchorRepository>
<stripCount>0</stripCount>
</anchorData>
<authorName>evzijst</authorName>
<commitDate>2015-04-28T09:47:56.310+02:00</commitDate>
<commitType>Modified</commitType>
<fileType>File</fileType>
<fromContentUrl>/context/cru/CR-FOO-21/rawcontent/5693/dir66/c.txt</fromContentUrl>
<fromPath>dir66/c.txt</fromPath>
<fromRevision>67</fromRevision>
<patchUrl>/contextcru/CR-FOO-21/downloadpatch/6281/patch-9135.patch</patchUrl>
<repositoryName>REPO</repositoryName>
<showAsDiff>false</showAsDiff>
<toContentUrl>/context/cru/CR-FOO-21/rawcontent/5909/dir66/c.txt</toContentUrl>
<toPath>dir66/c.txt</toPath>
<toRevision>671</toRevision>
</reviewItem>
<reviewItem>
<participants>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Fred Eaglesmith</displayName>
<userName>fred</userName>
</user>
<completed>false</completed>
</participant>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Corb Lund</displayName>
<userName>clund</userName>
</user>
<completed>false</completed>
</participant>
</participants>
<permId>
<id>CFR-68</id>
</permId>
<anchorData>
<anchorPath>tags/tag1</anchorPath>
<anchorRepository>REPO</anchorRepository>
<stripCount>0</stripCount>
</anchorData>
<authorName>evzijst</authorName>
<commitDate>2015-04-28T09:47:56.310+02:00</commitDate>
<commitType>Modified</commitType>
<fileType>File</fileType>
<fromContentUrl>/context/cru/CR-FOO-21/rawcontent/5696/dir67/b.txt</fromContentUrl>
<fromPath>dir67/b.txt</fromPath>
<fromRevision>68</fromRevision>
<patchUrl>/contextcru/CR-FOO-21/downloadpatch/6394/patch-6062.patch</patchUrl>
<repositoryName>REPO</repositoryName>
<showAsDiff>true</showAsDiff>
<toContentUrl>/context/cru/CR-FOO-21/rawcontent/5789/dir67/b.txt</toContentUrl>
<toPath>dir67/b.txt</toPath>
<toRevision>681</toRevision>
</reviewItem>
<reviewItem>
<participants>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Fred Eaglesmith</displayName>
<userName>fred</userName>
</user>
<completed>false</completed>
</participant>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Corb Lund</displayName>
<userName>clund</userName>
</user>
<completed>false</completed>
</participant>
</participants>
<permId>
<id>CFR-69</id>
</permId>
<authorName>evzijst</authorName>
<commitDate>2015-04-28T09:47:56.310+02:00</commitDate>
<commitType>Modified</commitType>
<fileType>File</fileType>
<fromContentUrl>/context/cru/CR-FOO-21/rawcontent/5698/dir68/d.txt</fromContentUrl>
<fromPath>dir68/d.txt</fromPath>
<fromRevision>69</fromRevision>
<repositoryName>REPO</repositoryName>
<showAsDiff>false</showAsDiff>
<toContentUrl>/context/cru/CR-FOO-21/rawcontent/6394/dir68/d.txt</toContentUrl>
<toPath>dir68/d.txt</toPath>
<toRevision>691</toRevision>
</reviewItem>
<reviewItem>
<participants>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Fred Eaglesmith</displayName>
<userName>fred</userName>
</user>
<completed>false</completed>
</participant>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Corb Lund</displayName>
<userName>clund</userName>
</user>
<completed>false</completed>
</participant>
</participants>
<permId>
<id>CFR-70</id>
</permId>
<authorName>evzijst</authorName>
<commitDate>2015-04-28T09:47:56.311+02:00</commitDate>
<commitType>Modified</commitType>
<fileType>File</fileType>
<fromContentUrl>/context/cru/CR-FOO-21/rawcontent/5700/dir69/e.txt</fromContentUrl>
<fromPath>dir69/e.txt</fromPath>
<fromRevision>70</fromRevision>
<repositoryName>REPO</repositoryName>
<showAsDiff>true</showAsDiff>
<toContentUrl>/context/cru/CR-FOO-21/rawcontent/6164/dir69/e.txt</toContentUrl>
<toPath>dir69/e.txt</toPath>
<toRevision>701</toRevision>
</reviewItem>
<reviewItem>
<participants>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Fred Eaglesmith</displayName>
<userName>fred</userName>
</user>
<completed>false</completed>
</participant>
<participant>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Corb Lund</displayName>
<userName>clund</userName>
</user>
<completed>false</completed>
</participant>
</participants>
<permId>
<id>CFR-71</id>
</permId>
<authorName>evzijst</authorName>
<commitDate>2015-04-28T09:47:56.311+02:00</commitDate>
<commitType>Modified</commitType>
<fileType>File</fileType>
<fromContentUrl>/context/cru/CR-FOO-21/rawcontent/5702/dir70/f.txt</fromContentUrl>
<fromPath>dir70/f.txt</fromPath>
<fromRevision>71</fromRevision>
<repositoryName>REPO</repositoryName>
<showAsDiff>false</showAsDiff>
<toContentUrl>/context/cru/CR-FOO-21/rawcontent/6679/dir70/f.txt</toContentUrl>
<toPath>dir70/f.txt</toPath>
<toRevision>711</toRevision>
</reviewItem>
</reviewItems>
<transitions>
<transitionData>
<displayName>Summarize</displayName>
<name>action:summarizeReview</name>
</transitionData>
</transitions>
</detailedReviewData>
The full, detailed review, reflecting the changes.
{
"projectKey" : "CR-FOO",
"name" : "Example review.",
"description" : "Description or statement of objectives for this example review.",
"author" : {
"userName" : "joe",
"displayName" : "Joe Krustofski",
"avatarUrl" : "http://foo.com/avatar"
},
"moderator" : {
"userName" : "scott",
"displayName" : "Scott the Moderator",
"avatarUrl" : "http://foo.com/avatar"
},
"creator" : {
"userName" : "joe",
"displayName" : "Joe Krustofski",
"avatarUrl" : "http://foo.com/avatar"
},
"permaId" : {
"id" : "CR-FOO-21"
},
"permaIdHistory" : [ "CR-FOO-21" ],
"type" : "REVIEW",
"allowReviewersToJoin" : true,
"metricsVersion" : 4,
"createDate" : "2015-04-28T09:47:56.272+0200",
"dueDate" : "2015-04-29T09:47:56.272+0200",
"jiraIssueKey" : "FOO-6754",
"reviewItems" : {
"reviewItem" : [ {
"permId" : {
"id" : "CFR-65"
},
"participants" : [ {
"user" : {
"userName" : "fred",
"displayName" : "Fred Eaglesmith",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
}, {
"user" : {
"userName" : "clund",
"displayName" : "Corb Lund",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
} ],
"repositoryName" : "REPO",
"fromPath" : "dir64/a.txt",
"fromRevision" : "65",
"fromContentUrl" : "/context/cru/CR-FOO-21/rawcontent/5687/dir64/a.txt",
"toPath" : "dir64/a.txt",
"toRevision" : "651",
"toContentUrl" : "/context/cru/CR-FOO-21/rawcontent/6675/dir64/a.txt",
"patchUrl" : "/contextcru/CR-FOO-21/downloadpatch/6238/patch-7126.patch",
"fileType" : "File",
"commitType" : "Modified",
"authorName" : "evzijst",
"showAsDiff" : false,
"anchorData" : {
"anchorPath" : "trunk",
"anchorRepository" : "REPO",
"stripCount" : 0
},
"commitDate" : 1430207276310,
"expandedRevisions" : [ ]
}, {
"permId" : {
"id" : "CFR-66"
},
"participants" : [ {
"user" : {
"userName" : "fred",
"displayName" : "Fred Eaglesmith",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
}, {
"user" : {
"userName" : "clund",
"displayName" : "Corb Lund",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
} ],
"repositoryName" : "REPO",
"fromPath" : "dir65/d.txt",
"fromRevision" : "66",
"fromContentUrl" : "/context/cru/CR-FOO-21/rawcontent/5690/dir65/d.txt",
"toPath" : "dir65/d.txt",
"toRevision" : "661",
"toContentUrl" : "/context/cru/CR-FOO-21/rawcontent/6085/dir65/d.txt",
"patchUrl" : "/contextcru/CR-FOO-21/downloadpatch/6273/patch-6173.patch",
"fileType" : "File",
"commitType" : "Modified",
"authorName" : "evzijst",
"showAsDiff" : true,
"anchorData" : {
"anchorPath" : "branches/branch1",
"anchorRepository" : "REPO",
"stripCount" : 0
},
"commitDate" : 1430207276310,
"expandedRevisions" : [ ]
}, {
"permId" : {
"id" : "CFR-67"
},
"participants" : [ {
"user" : {
"userName" : "fred",
"displayName" : "Fred Eaglesmith",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
}, {
"user" : {
"userName" : "clund",
"displayName" : "Corb Lund",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
} ],
"repositoryName" : "REPO",
"fromPath" : "dir66/c.txt",
"fromRevision" : "67",
"fromContentUrl" : "/context/cru/CR-FOO-21/rawcontent/5693/dir66/c.txt",
"toPath" : "dir66/c.txt",
"toRevision" : "671",
"toContentUrl" : "/context/cru/CR-FOO-21/rawcontent/5909/dir66/c.txt",
"patchUrl" : "/contextcru/CR-FOO-21/downloadpatch/6281/patch-9135.patch",
"fileType" : "File",
"commitType" : "Modified",
"authorName" : "evzijst",
"showAsDiff" : false,
"anchorData" : {
"anchorPath" : "branches/branch1",
"anchorRepository" : "REPO",
"stripCount" : 0
},
"commitDate" : 1430207276310,
"expandedRevisions" : [ ]
}, {
"permId" : {
"id" : "CFR-68"
},
"participants" : [ {
"user" : {
"userName" : "fred",
"displayName" : "Fred Eaglesmith",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
}, {
"user" : {
"userName" : "clund",
"displayName" : "Corb Lund",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
} ],
"repositoryName" : "REPO",
"fromPath" : "dir67/b.txt",
"fromRevision" : "68",
"fromContentUrl" : "/context/cru/CR-FOO-21/rawcontent/5696/dir67/b.txt",
"toPath" : "dir67/b.txt",
"toRevision" : "681",
"toContentUrl" : "/context/cru/CR-FOO-21/rawcontent/5789/dir67/b.txt",
"patchUrl" : "/contextcru/CR-FOO-21/downloadpatch/6394/patch-6062.patch",
"fileType" : "File",
"commitType" : "Modified",
"authorName" : "evzijst",
"showAsDiff" : true,
"anchorData" : {
"anchorPath" : "tags/tag1",
"anchorRepository" : "REPO",
"stripCount" : 0
},
"commitDate" : 1430207276310,
"expandedRevisions" : [ ]
}, {
"permId" : {
"id" : "CFR-69"
},
"participants" : [ {
"user" : {
"userName" : "fred",
"displayName" : "Fred Eaglesmith",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
}, {
"user" : {
"userName" : "clund",
"displayName" : "Corb Lund",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
} ],
"repositoryName" : "REPO",
"fromPath" : "dir68/d.txt",
"fromRevision" : "69",
"fromContentUrl" : "/context/cru/CR-FOO-21/rawcontent/5698/dir68/d.txt",
"toPath" : "dir68/d.txt",
"toRevision" : "691",
"toContentUrl" : "/context/cru/CR-FOO-21/rawcontent/6394/dir68/d.txt",
"fileType" : "File",
"commitType" : "Modified",
"authorName" : "evzijst",
"showAsDiff" : false,
"commitDate" : 1430207276310,
"expandedRevisions" : [ ]
}, {
"permId" : {
"id" : "CFR-70"
},
"participants" : [ {
"user" : {
"userName" : "fred",
"displayName" : "Fred Eaglesmith",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
}, {
"user" : {
"userName" : "clund",
"displayName" : "Corb Lund",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
} ],
"repositoryName" : "REPO",
"fromPath" : "dir69/e.txt",
"fromRevision" : "70",
"fromContentUrl" : "/context/cru/CR-FOO-21/rawcontent/5700/dir69/e.txt",
"toPath" : "dir69/e.txt",
"toRevision" : "701",
"toContentUrl" : "/context/cru/CR-FOO-21/rawcontent/6164/dir69/e.txt",
"fileType" : "File",
"commitType" : "Modified",
"authorName" : "evzijst",
"showAsDiff" : true,
"commitDate" : 1430207276311,
"expandedRevisions" : [ ]
}, {
"permId" : {
"id" : "CFR-71"
},
"participants" : [ {
"user" : {
"userName" : "fred",
"displayName" : "Fred Eaglesmith",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
}, {
"user" : {
"userName" : "clund",
"displayName" : "Corb Lund",
"avatarUrl" : "http://foo.com/avatar"
},
"completed" : false
} ],
"repositoryName" : "REPO",
"fromPath" : "dir70/f.txt",
"fromRevision" : "71",
"fromContentUrl" : "/context/cru/CR-FOO-21/rawcontent/5702/dir70/f.txt",
"toPath" : "dir70/f.txt",
"toRevision" : "711",
"toContentUrl" : "/context/cru/CR-FOO-21/rawcontent/6679/dir70/f.txt",
"fileType" : "File",
"commitType" : "Modified",
"authorName" : "evzijst",
"showAsDiff" : false,
"commitDate" : 1430207276311,
"expandedRevisions" : [ ]
} ]
},
"generalComments" : {
"comments" : [ {
"metrics" : {
},
"message" : "I thought you said you were going to *remove* this line?",
"draft" : false,
"deleted" : false,
"defectRaised" : false,
"defectApproved" : false,
"readStatus" : "UNREAD",
"user" : {
"userName" : "joe",
"displayName" : "Joe Bloggs",
"avatarUrl" : "http://foo.com/avatar"
},
"createDate" : "2015-04-28T09:47:56.281+0200",
"permaId" : {
"id" : "CR:1"
},
"replies" : [ ],
"messageAsHtml" : "I thought you said you were going to <b>remove</b> this line?",
"permId" : {
"id" : "CR:1"
},
"parentCommentId" : {
}
} ]
},
"transitions" : {
"transitionData" : [ {
"name" : "action:summarizeReview",
"displayName" : "Summarize"
} ]
},
"actions" : {
"actionData" : [ {
"name" : "action:abandonReview",
"displayName" : "Abandon"
}, {
"name" : "action:approveReview",
"displayName" : "Approve"
}, {
"name" : "action:commentOnReview",
"displayName" : "Comment"
}, {
"name" : "action:completeReview",
"displayName" : "Complete"
}, {
"name" : "action:modifyReviewFiles",
"displayName" : "Edit Review Details"
} ]
}
}The full, detailed review, reflecting the changes.
| parameter | value | description |
|---|---|---|
|
id |
the review perma id |
|
|
cId |
the comment perma id. |
Mark the given comment as read for the user used to make this POST.
available response representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<generalCommentData>
<createDate>2015-04-28T09:47:56.281+0200</createDate>
<defectApproved>false</defectApproved>
<defectRaised>false</defectRaised>
<deleted>false</deleted>
<draft>false</draft>
<message>I thought you said you were going to *remove* this line?</message>
<messageAsHtml>I thought you said you were going to <b>remove</b> this line?</messageAsHtml>
<metrics/>
<parentCommentId/>
<readStatus>READ</readStatus>
<replies/>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Joe Bloggs</displayName>
<userName>joe</userName>
</user>
<permId>
<id>CR:1</id>
</permId>
<permaId>
<id>CR:1</id>
</permaId>
</generalCommentData>
{
"metrics" : {
},
"message" : "I thought you said you were going to *remove* this line?",
"draft" : false,
"deleted" : false,
"defectRaised" : false,
"defectApproved" : false,
"readStatus" : "READ",
"user" : {
"userName" : "joe",
"displayName" : "Joe Bloggs",
"avatarUrl" : "http://foo.com/avatar"
},
"createDate" : "2015-04-28T09:47:56.281+0200",
"permaId" : {
"id" : "CR:1"
},
"replies" : [ ],
"messageAsHtml" : "I thought you said you were going to <b>remove</b> this line?",
"permId" : {
"id" : "CR:1"
},
"parentCommentId" : {
}
}| parameter | value | description |
|---|---|---|
|
id |
the review perma id for the comment |
|
|
cId |
the comment perma id |
Marks the comment as leave unread to the current user - it will not automatically be marked as read by crucible.
available response representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<generalCommentData>
<createDate>2015-04-28T09:47:56.281+0200</createDate>
<defectApproved>false</defectApproved>
<defectRaised>false</defectRaised>
<deleted>false</deleted>
<draft>false</draft>
<message>I thought you said you were going to *remove* this line?</message>
<messageAsHtml>I thought you said you were going to <b>remove</b> this line?</messageAsHtml>
<metrics/>
<parentCommentId/>
<readStatus>UNREAD</readStatus>
<replies/>
<user>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Joe Bloggs</displayName>
<userName>joe</userName>
</user>
<permId>
<id>CR:1</id>
</permId>
<permaId>
<id>CR:1</id>
</permaId>
</generalCommentData>
{
"metrics" : {
},
"message" : "I thought you said you were going to *remove* this line?",
"draft" : false,
"deleted" : false,
"defectRaised" : false,
"defectApproved" : false,
"readStatus" : "UNREAD",
"user" : {
"userName" : "joe",
"displayName" : "Joe Bloggs",
"avatarUrl" : "http://foo.com/avatar"
},
"createDate" : "2015-04-28T09:47:56.281+0200",
"permaId" : {
"id" : "CR:1"
},
"replies" : [ ],
"messageAsHtml" : "I thought you said you were going to <b>remove</b> this line?",
"permId" : {
"id" : "CR:1"
},
"parentCommentId" : {
}
}| parameter | value | description |
|---|---|---|
|
id |
The review perma id |
|
|
cId |
the reply's parent comment perma id |
|
|
rId |
the perma id of the reply to delete |
Updates a reply with the given newComment.
acceptable request representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<generalCommentData>
<defectApproved>false</defectApproved>
<defectRaised>false</defectRaised>
<deleted>false</deleted>
<draft>true</draft>
<message>I thought you said you were going to remove this line?</message>
<parentCommentId/>
<permId/>
<permaId/>
</generalCommentData>
{
"message" : "I thought you said you were going to remove this line?",
"draft" : true,
"deleted" : false,
"defectRaised" : false,
"defectApproved" : false,
"permaId" : {
},
"permId" : {
},
"parentCommentId" : {
}
}Deletes the reply.
| parameter | value | description |
|---|---|---|
|
id |
the review perma id to look for draft comments |
Publishes all the draft comments of the current user.
| parameter | value | description |
|---|---|---|
|
id |
the review perma id |
|
|
cId |
the comment perma id |
publishes the given draft comment.
| parameter | value | description |
|---|---|---|
|
id |
the review perma id |
Completes the review for the current user
| parameter | value | description |
|---|---|---|
|
id |
the review perma id |
Uncompletes the review for the current user.
| parameter | value | description |
|---|---|---|
|
id |
the review perma-id (e.g. "CR-45"). |
Change the state of a review by performing an action on it.
| parameter | value | description |
|---|---|---|
|
action |
the string representation of the action to perform. Valid actions are:
|
available response representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<reviewData>
<allowReviewersToJoin>true</allowReviewersToJoin>
<author>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Joe Krustofski</displayName>
<userName>joe</userName>
</author>
<createDate>2015-04-28T09:47:56.272+0200</createDate>
<creator>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Joe Krustofski</displayName>
<userName>joe</userName>
</creator>
<description>Description or statement of objectives for this example review.</description>
<dueDate>2015-04-29T09:47:56.272+0200</dueDate>
<jiraIssueKey>FOO-6754</jiraIssueKey>
<metricsVersion>4</metricsVersion>
<moderator>
<avatarUrl>http://foo.com/avatar</avatarUrl>
<displayName>Scott the Moderator</displayName>
<userName>scott</userName>
</moderator>
<name>Example review.</name>
<permaId>
<id>CR-FOO-21</id>
</permaId>
<permaIdHistory>CR-FOO-21</permaIdHistory>
<projectKey>CR-FOO</projectKey>
<type>REVIEW</type>
</reviewData>
The review object containing the details of the review, including its new state.
{
"projectKey" : "CR-FOO",
"name" : "Example review.",
"description" : "Description or statement of objectives for this example review.",
"author" : {
"userName" : "joe",
"displayName" : "Joe Krustofski",
"avatarUrl" : "http://foo.com/avatar"
},
"moderator" : {
"userName" : "scott",
"displayName" : "Scott the Moderator",
"avatarUrl" : "http://foo.com/avatar"
},
"creator" : {
"userName" : "joe",
"displayName" : "Joe Krustofski",
"avatarUrl" : "http://foo.com/avatar"
},
"permaId" : {
"id" : "CR-FOO-21"
},
"permaIdHistory" : [ "CR-FOO-21" ],
"type" : "REVIEW",
"allowReviewersToJoin" : true,
"metricsVersion" : 4,
"createDate" : "2015-04-28T09:47:56.272+0200",
"dueDate" : "2015-04-29T09:47:56.272+0200",
"jiraIssueKey" : "FOO-6754"
}The review object containing the details of the review, including its new state.
| parameter | value | description |
|---|---|---|
|
id |
the review perma id to close. it should be in the open state. |
Closes the given review with the summary given.
acceptable request representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<closeReviewSummary>
<summary>summary of the review.</summary>
</closeReviewSummary>
{
"summary" : "summary of the review."
}available response representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<reviewData>
<metricsVersion>0</metricsVersion>
<permaId>
<id>CR-1234</id>
</permaId>
<summary>summary of the review.</summary>
</reviewData>
A summary of the review.
{
"permaId" : {
"id" : "CR-1234"
},
"summary" : "summary of the review.",
"metricsVersion" : 0
}A summary of the review.
| parameter | value | description |
|---|---|---|
|
id |
the review perma id to remind about. it should be in the open state. |
Returns a list of all repositories. This includes plugin provided repositories
| parameter | value | description |
|---|---|---|
|
name |
filter repositories by name, only repositories of names containing this value would be returned if value was provided. Case insensitive. |
|
|
enabled |
filter repositories by enabled flag. Only enabled/disabled repositories would be returned accordingly if value was provided. |
|
|
available |
filter repositories by its availability. Only available/unavailable repositories would be returned accordingly if value was provided. |
|
|
type |
filter repositories by type. Allowed values: cvs, svn, p4, git, hg, plugin (for light SCM repositories). Parameter can be specified more than once. |
|
|
limit |
Default: 10000 |
maximum number of repositories to be returned. |
available response representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<repositories>
<repoData xsi:type="svnRepositoryData" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<available>true</available>
<enabled>true</enabled>
<name>Foo Repository</name>
<type>svn</type>
<path>/foo</path>
<url>http://localhost/svn</url>
</repoData>
<repoData xsi:type="pluginRepositoryData" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<available>true</available>
<enabled>true</enabled>
<name>CSLite</name>
<type>plugin</type>
<description>Crucible SCM plugin repository for the CS repository.</description>
<hasChangelogBrowser>true</hasChangelogBrowser>
<hasDirectoryBrowser>true</hasDirectoryBrowser>
<pluginKey>CSL</pluginKey>
<stateDescription>available</stateDescription>
</repoData>
</repositories>
Listing of all FishEye and Crucible SCM repositories that are accessible to the caller of this resource.
{
"repoData" : [ {
"name" : "Foo Repository",
"type" : "svn",
"enabled" : true,
"available" : true,
"url" : "http://localhost/svn",
"path" : "/foo"
}, {
"name" : "CSLite",
"type" : "plugin",
"enabled" : true,
"available" : true,
"description" : "Crucible SCM plugin repository for the CS repository.",
"stateDescription" : "available",
"pluginKey" : "CSL",
"hasDirectoryBrowser" : true,
"hasChangelogBrowser" : true
} ]
}Listing of all FishEye and Crucible SCM repositories that are accessible to the caller of this resource.
| parameter | value | description |
|---|---|---|
|
revision |
the SCM revision string. |
|
|
repo |
name of the Crucible SCM plugin repository. |
|
|
path |
the path of a file. |
Returns the raw content of the specified file revision as a binary stream. No attempt is made to identify the content type and no mime type is provided.
available response representations:
The raw content of the specified file revision. Crucible currently does not provide a mime type.
| parameter | value | description |
|---|---|---|
|
repo |
name of the Crucible SCM plugin repository. |
|
|
path |
only show change sets which contain at least one revision with a path under this path. Changesets with some revisions outside this path still include all revisions. i.e. Revisions outside the path are *not* excluded from the change set. |
Represents a sorted list of changesets, newest first.
Note that when providing a path, use a trailing slash in the request url to indicate that it is a directory (use a "/" for the root directory of the repository). This may be necessary for some SCM plugins (including svn-light).
| parameter | value | description |
|---|---|---|
|
oldestCsid |
only return change sets after this change set. If omitted there is no restriction. |
|
|
includeOldest |
include the change set with id "from" in the change sets returned. |
|
|
newestCsid |
only return change sets before this change set. If omitted there is no restriction. |
|
|
includeNewest |
include the change set with id "to" in the change sets returned. |
|
|
max |
return only the newest change sets, to a maximum of maxChangesets. |
available response representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<changes olderChangeSetsExist="false" newerChangeSetsExist="true">
<change author="joe" date="2015-04-28T09:48:00.349+02:00" csid="345">
<link rel="self" href="http://localhost:8060/crucible/rest-service/repositories-v1/change/REPO/345"/>
<comment>Commit message</comment>
<revision revision="345" path="trunk/pom.xml">
<link rel="self" href="http://localhost:8060/crucible/rest-service/repositories-v1/REPO/345/trunk/pom.xml"/>
<details/>
<diffRevision/>
<link rel="history" href="http://localhost:8060/crucible/rest-service/repositories-v1/history/REPO/345/trunk/pom.xml"/>
</revision>
<revision revision="345" path="trunk/pom.xml">
<link rel="self" href="http://localhost:8060/crucible/rest-service/repositories-v1/REPO/345/trunk/pom.xml"/>
<details/>
<diffRevision/>
<link rel="history" href="http://localhost:8060/crucible/rest-service/repositories-v1/history/REPO/345/trunk/pom.xml"/>
</revision>
</change>
<change author="joe" date="2015-04-28T09:48:00.349+02:00" csid="234">
<link rel="self" href="http://localhost:8060/crucible/rest-service/repositories-v1/change/REPO/234"/>
<comment>Commit message</comment>
<revision revision="234" path="trunk/pom.xml">
<link rel="self" href="http://localhost:8060/crucible/rest-service/repositories-v1/REPO/234/trunk/pom.xml"/>
<details/>
<diffRevision/>
<link rel="history" href="http://localhost:8060/crucible/rest-service/repositories-v1/history/REPO/234/trunk/pom.xml"/>
</revision>
<revision revision="234" path="trunk/pom.xml">
<link rel="self" href="http://localhost:8060/crucible/rest-service/repositories-v1/REPO/234/trunk/pom.xml"/>
<details/>
<diffRevision/>
<link rel="history" href="http://localhost:8060/crucible/rest-service/repositories-v1/history/REPO/234/trunk/pom.xml"/>
</revision>
</change>
</changes>
A collection of change sets. To expand
both <details> and <diffRevision> of the revision elements
inside the individual changesets, use: ?expand=change.revision.*
{
"newerChangeSetsExist" : true,
"olderChangeSetsExist" : false,
"change" : [ {
"csid" : "345",
"date" : 1430207280349,
"author" : "joe",
"comment" : "Commit message",
"link" : {
"href" : "http://localhost:8060/crucible/rest-service/repositories-v1/change/REPO/345",
"rel" : "self"
},
"revision" : [ {
"path" : "trunk/pom.xml",
"revision" : "345",
"details" : {
},
"diffRevision" : {
},
"link" : {
"href" : "http://localhost:8060/crucible/rest-service/repositories-v1/history/REPO/345/trunk/pom.xml",
"rel" : "history"
}
}, {
"path" : "trunk/pom.xml",
"revision" : "345",
"details" : {
},
"diffRevision" : {
},
"link" : {
"href" : "http://localhost:8060/crucible/rest-service/repositories-v1/history/REPO/345/trunk/pom.xml",
"rel" : "history"
}
} ]
}, {
"csid" : "234",
"date" : 1430207280349,
"author" : "joe",
"comment" : "Commit message",
"link" : {
"href" : "http://localhost:8060/crucible/rest-service/repositories-v1/change/REPO/234",
"rel" : "self"
},
"revision" : [ {
"path" : "trunk/pom.xml",
"revision" : "234",
"details" : {
},
"diffRevision" : {
},
"link" : {
"href" : "http://localhost:8060/crucible/rest-service/repositories-v1/history/REPO/234/trunk/pom.xml",
"rel" : "history"
}
}, {
"path" : "trunk/pom.xml",
"revision" : "234",
"details" : {
},
"diffRevision" : {
},
"link" : {
"href" : "http://localhost:8060/crucible/rest-service/repositories-v1/history/REPO/234/trunk/pom.xml",
"rel" : "history"
}
} ]
} ]
}A collection of change sets. To expand
both <details> and <diffRevision> of the revision elements
inside the individual changesets, use: ?expand=change.revision.*
| parameter | value | description |
|---|---|---|
|
name |
name of a FishEye or Crucible SCM plugin repository. |
For backward compatibility we provide this method, but repositories should be referred to just by their name.
available response representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<svnRepositoryData>
<available>true</available>
<enabled>true</enabled>
<name>Foo Repository</name>
<type>svn</type>
<path>/foo</path>
<url>http://localhost/svn</url>
</svnRepositoryData>
Description of a Subversion repository provided by FishEye.
{
"name" : "Foo Repository",
"type" : "svn",
"enabled" : true,
"available" : true,
"url" : "http://localhost/svn",
"path" : "/foo"
}Description of a Subversion repository provided by FishEye.
| parameter | value | description |
|---|---|---|
|
name |
name of the Crucible SCM plugin repository. |
Returns the details of the repository with the specified name. When the repository exists, but the user has no access to it (possibly because the user is not authenticated), a 401 is returned.
The supplied repository name can be either a Crucible SCM plugin repository, or a FishEye repository.
available response representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<svnRepositoryData>
<available>true</available>
<enabled>true</enabled>
<name>Foo Repository</name>
<type>svn</type>
<path>/foo</path>
<url>http://localhost/svn</url>
</svnRepositoryData>
Example of a repository element. Possible return documents include:
SvnRepositoryDataCvsRepositoryDataP4RepositoryDataGitRepositoryDataPluginRepositoryData - represents Crucible SCM repositories provided by SCM plugins.
Source: crucible.xsd
<xs:complexType name="repositoryData">
<xs:sequence>
<xs:element name="available" type="xs:boolean"/>
<xs:element name="enabled" type="xs:boolean"/>
<xs:element name="name" type="xs:string" minOccurs="0"/>
<xs:element name="type" type="xs:string" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
{
"name" : "Foo Repository",
"type" : "svn",
"enabled" : true,
"available" : true,
"url" : "http://localhost/svn",
"path" : "/foo"
}Example of a repository element. Possible return documents include:
SvnRepositoryDataCvsRepositoryDataP4RepositoryDataGitRepositoryDataPluginRepositoryData - represents Crucible SCM repositories provided by SCM plugins.
Source: crucible.xsd
<xs:complexType name="repositoryData">
<xs:sequence>
<xs:element name="available" type="xs:boolean"/>
<xs:element name="enabled" type="xs:boolean"/>
<xs:element name="name" type="xs:string" minOccurs="0"/>
<xs:element name="type" type="xs:string" minOccurs="0"/>
</xs:sequence>
</xs:complexType>| parameter | value | description |
|---|---|---|
|
repo |
name of the Crucible SCM plugin repository. |
|
|
path |
path to a directory. When path represents a file name, the result is unspecified. |
Lists the contents of the specified directory.
available response representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<listing path="trunk">
<dir path="trunk/src">
<link rel="self" href="http://localhost:8060/crucible/rest-service/repositories-v1/browse/REPO/trunk/src"/>
</dir>
<dir path="trunk/test">
<link rel="self" href="http://localhost:8060/crucible/rest-service/repositories-v1/browse/REPO/trunk/test"/>
</dir>
<file revision="1234" path="trunk/pom.xml">
<link rel="self" href="http://localhost:8060/crucible/rest-service/repositories-v1/REPO/1234//trunk/pom.xml"/>
<details/>
<diffRevision/>
<link rel="history" href="http://localhost:8060/crucible/rest-service/repositories-v1/history/REPO/1234/trunk/pom.xml"/>
<link rel="content" href="http://localhost:8060/crucible/rest-service/repositories-v1/content/REPO/1234/trunk/pom.xml"/>
</file>
</listing>
Repository directory listing result containing files and directories.
Every item contains a <link self=""/> perma link. Following this for a file it will give you the details for that file (containing the same information as the <file/> element in this result document). Following the link on a directory will give you a new dir listing.
Other links:
MediaType.APPLICATION_OCTET_STREAM.
{
"path" : "trunk",
"dir" : [ {
"path" : "trunk/src",
"link" : {
"href" : "http://localhost:8060/crucible/rest-service/repositories-v1/browse/REPO/trunk/src",
"rel" : "self"
}
}, {
"path" : "trunk/test",
"link" : {
"href" : "http://localhost:8060/crucible/rest-service/repositories-v1/browse/REPO/trunk/test",
"rel" : "self"
}
} ],
"file" : [ {
"path" : "trunk/pom.xml",
"revision" : "1234",
"details" : {
},
"diffRevision" : {
},
"link" : {
"href" : "http://localhost:8060/crucible/rest-service/repositories-v1/content/REPO/1234/trunk/pom.xml",
"rel" : "content"
}
} ]
}Repository directory listing result containing files and directories.
Every item contains a <link self=""/> perma link. Following this for a file it will give you the details for that file (containing the same information as the <file/> element in this result document). Following the link on a directory will give you a new dir listing.
Other links:
MediaType.APPLICATION_OCTET_STREAM.
| parameter | value | description |
|---|---|---|
|
revision |
the SCM revision string. |
|
|
repo |
name of the Crucible SCM plugin repository. |
|
|
path |
the path of a file or versioned directory (note that versioned directories are not supported by all SCM plugins). |
Represents the details of a versioned entity (file or directory). This resource can be reached by following the file's self-link from a browse result.
Note that most responses support title expansion to minimize the costs of accessing the resources. Since file meta data is not always provided by SCM plugins, it is not expanded by default in the rest responses. Use title expansion to explicitly make Crucible include it.
The xml root element declares which elements are expandable (in this
response: details and diffRevision). To expand both, use:
?expand=details,diffRevision
available response representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<file revision="1234" path="trunk/pom.xml">
<link rel="self" href="http://localhost:8060/crucible/rest-service/repositories-v1/REPO/1234//trunk/pom.xml"/>
<details/>
<diffRevision/>
<link rel="history" href="http://localhost:8060/crucible/rest-service/repositories-v1/history/REPO/1234/trunk/pom.xml"/>
<link rel="content" href="http://localhost:8060/crucible/rest-service/repositories-v1/content/REPO/1234/trunk/pom.xml"/>
</file>
a versioned file.
{
"path" : "trunk/pom.xml",
"revision" : "1234",
"details" : {
},
"diffRevision" : {
},
"link" : {
"href" : "http://localhost:8060/crucible/rest-service/repositories-v1/content/REPO/1234/trunk/pom.xml",
"rel" : "content"
}
}a versioned file.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<error>
<code>NotPermitted</code>
<message>Access denied.</message>
<stacktrace>com.atlassian.crucible.spi.services.NotPermittedException: Access denied.
at com.atlassian.crucible.spi.rpc.ExampleDocuments.<clinit>(ExampleDocuments.java:21)
at sun.misc.Unsafe.ensureClassInitialized(Native Method)
at sun.reflect.UnsafeFieldAccessorFactory.newFieldAccessor(UnsafeFieldAccessorFactory.java:25)
at sun.reflect.ReflectionFactory.newFieldAccessor(ReflectionFactory.java:122)
at java.lang.reflect.Field.acquireFieldAccessor(Field.java:918)
at java.lang.reflect.Field.getFieldAccessor(Field.java:899)
at java.lang.reflect.Field.get(Field.java:358)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedLinkFromTag(ResourceDocletJsonXml.java:649)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedExample(ResourceDocletJsonXml.java:542)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.createRepresentationDocTypes(ResourceDocletJsonXml.java:453)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.addResponseDoc(ResourceDocletJsonXml.java:428)
at com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.start(ResourceDocletJsonXml.java:196)
at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)
at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
at java.lang.reflect.Method.invoke(Method.java:597)
at com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:269)
at com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:143)
at com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)
at com.sun.tools.javadoc.Start.begin(Start.java:128)
at com.sun.tools.javadoc.Main.execute(Main.java:41)
at com.sun.tools.javadoc.Main.main(Main.java:31)
</stacktrace>
</error>
when the caller does not have permission to access this resource.
{
"code" : "NotPermitted",
"message" : "Access denied.",
"stacktrace" : "com.atlassian.crucible.spi.services.NotPermittedException: Access denied.\n\tat com.atlassian.crucible.spi.rpc.ExampleDocuments.<clinit>(ExampleDocuments.java:21)\n\tat sun.misc.Unsafe.ensureClassInitialized(Native Method)\n\tat sun.reflect.UnsafeFieldAccessorFactory.newFieldAccessor(UnsafeFieldAccessorFactory.java:25)\n\tat sun.reflect.ReflectionFactory.newFieldAccessor(ReflectionFactory.java:122)\n\tat java.lang.reflect.Field.acquireFieldAccessor(Field.java:918)\n\tat java.lang.reflect.Field.getFieldAccessor(Field.java:899)\n\tat java.lang.reflect.Field.get(Field.java:358)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedLinkFromTag(ResourceDocletJsonXml.java:649)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.getSerializedExample(ResourceDocletJsonXml.java:542)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.createRepresentationDocTypes(ResourceDocletJsonXml.java:453)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.addResponseDoc(ResourceDocletJsonXml.java:428)\n\tat com.sun.jersey.wadl.resourcedoc.ResourceDocletJsonXml.start(ResourceDocletJsonXml.java:196)\n\tat sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)\n\tat sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)\n\tat sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)\n\tat java.lang.reflect.Method.invoke(Method.java:597)\n\tat com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:269)\n\tat com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:143)\n\tat com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)\n\tat com.sun.tools.javadoc.Start.begin(Start.java:128)\n\tat com.sun.tools.javadoc.Main.execute(Main.java:41)\n\tat com.sun.tools.javadoc.Main.main(Main.java:31)\n"
}when the caller does not have permission to access this resource.
| parameter | value | description |
|---|---|---|
|
revision |
the SCM revision string. |
|
|
repo |
name of the Crucible SCM plugin repository. |
|
|
path |
the path of a file or versioned directory (note that versioned directories are not supported by all SCM plugins). |
Represents the history of a versioned entity.
available response representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<history path="trunk/pom.xml">
<revision revision="7" path="trunk/pom.xml">
<link rel="self" href="http://localhost:8060/crucible/rest-service/repositories-v1/REPO/7/trunk/pom.xml"/>
<details/>
<diffRevision/>
<link rel="history" href="http://localhost:8060/crucible/rest-service/repositories-v1/history/REPO/7/trunk/pom.xml"/>
</revision>
<revision revision="4" path="trunk/pom.xml">
<link rel="self" href="http://localhost:8060/crucible/rest-service/repositories-v1/REPO/4/trunk/pom.xml"/>
<details/>
<diffRevision/>
<link rel="history" href="http://localhost:8060/crucible/rest-service/repositories-v1/history/REPO/4/trunk/pom.xml"/>
</revision>
<revision revision="3" path="trunk/pom.xml">
<link rel="self" href="http://localhost:8060/crucible/rest-service/repositories-v1/REPO/3/trunk/pom.xml"/>
<details/>
<diffRevision/>
<link rel="history" href="http://localhost:8060/crucible/rest-service/repositories-v1/history/REPO/3/trunk/pom.xml"/>
</revision>
</history>
Revision history for a versioned SCM entity.
Use title expansion if you want to force Crucible to populate each revision record with full meta data (expensive, as this is a 1-plus-n operation).
Since the expandable <details> and <diffRevision> elements
are burried more deeply in the xml hierarchy, use: ?expand=revision.details.
Note that a history response does not distinguish between files and
directories. Instead, every record is a <revision>. This is
because the Crucible SCM api does not provide enough information to
tell the difference. Only when full meta data is provided (which a
plugin is not required to include in most operations) you can infer the
type by looking for the filetype property.
{
"path" : "trunk/pom.xml",
"revision" : [ {
"path" : "trunk/pom.xml",
"revision" : "7",
"details" : {
},
"diffRevision" : {
},
"link" : {
"href" : "http://localhost:8060/crucible/rest-service/repositories-v1/history/REPO/7/trunk/pom.xml",
"rel" : "history"
}
}, {
"path" : "trunk/pom.xml",
"revision" : "4",
"details" : {
},
"diffRevision" : {
},
"link" : {
"href" : "http://localhost:8060/crucible/rest-service/repositories-v1/history/REPO/4/trunk/pom.xml",
"rel" : "history"
}
}, {
"path" : "trunk/pom.xml",
"revision" : "3",
"details" : {
},
"diffRevision" : {
},
"link" : {
"href" : "http://localhost:8060/crucible/rest-service/repositories-v1/history/REPO/3/trunk/pom.xml",
"rel" : "history"
}
} ]
}Revision history for a versioned SCM entity.
Use title expansion if you want to force Crucible to populate each revision record with full meta data (expensive, as this is a 1-plus-n operation).
Since the expandable <details> and <diffRevision> elements
are burried more deeply in the xml hierarchy, use: ?expand=revision.details.
Note that a history response does not distinguish between files and
directories. Instead, every record is a <revision>. This is
because the Crucible SCM api does not provide enough information to
tell the difference. Only when full meta data is provided (which a
plugin is not required to include in most operations) you can infer the
type by looking for the filetype property.
| parameter | value | description |
|---|---|---|
|
revision |
the SCM revision string. |
|
|
repo |
name of the Crucible SCM plugin repository. |
Represents a particular changeset.
available response representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<change author="joe" date="2015-04-28T09:48:00.349+02:00" csid="345">
<link rel="self" href="http://localhost:8060/crucible/rest-service/repositories-v1/change/REPO/345"/>
<comment>Commit message</comment>
<revision revision="345" path="trunk/pom.xml">
<link rel="self" href="http://localhost:8060/crucible/rest-service/repositories-v1/REPO/345/trunk/pom.xml"/>
<details/>
<diffRevision/>
<link rel="history" href="http://localhost:8060/crucible/rest-service/repositories-v1/history/REPO/345/trunk/pom.xml"/>
</revision>
<revision revision="345" path="trunk/pom.xml">
<link rel="self" href="http://localhost:8060/crucible/rest-service/repositories-v1/REPO/345/trunk/pom.xml"/>
<details/>
<diffRevision/>
<link rel="history" href="http://localhost:8060/crucible/rest-service/repositories-v1/history/REPO/345/trunk/pom.xml"/>
</revision>
</change>
A single change set.
A change set describes the contents of a single commit on a Crucible SCM repository and includes changes to one or more files and or directories. Note that versioned directories are not supported by all SCM systems. For that reason the response does not distinguish between files and directories but instead, every record is a <revision>.
Use title expansion if you want to force Crucible to populate each revision record with full meta data (expensive, as this is a 1-plus-n operation).
Since the expandable <details> and <diffRevision> elements
are burried more deeply in the xml hierarchy, use: ?expand=revision.*.
{
"csid" : "345",
"date" : 1430207280349,
"author" : "joe",
"comment" : "Commit message",
"link" : {
"href" : "http://localhost:8060/crucible/rest-service/repositories-v1/change/REPO/345",
"rel" : "self"
},
"revision" : [ {
"path" : "trunk/pom.xml",
"revision" : "345",
"details" : {
},
"diffRevision" : {
},
"link" : {
"href" : "http://localhost:8060/crucible/rest-service/repositories-v1/history/REPO/345/trunk/pom.xml",
"rel" : "history"
}
}, {
"path" : "trunk/pom.xml",
"revision" : "345",
"details" : {
},
"diffRevision" : {
},
"link" : {
"href" : "http://localhost:8060/crucible/rest-service/repositories-v1/history/REPO/345/trunk/pom.xml",
"rel" : "history"
}
} ]
}A single change set.
A change set describes the contents of a single commit on a Crucible SCM repository and includes changes to one or more files and or directories. Note that versioned directories are not supported by all SCM systems. For that reason the response does not distinguish between files and directories but instead, every record is a <revision>.
Use title expansion if you want to force Crucible to populate each revision record with full meta data (expensive, as this is a 1-plus-n operation).
Since the expandable <details> and <diffRevision> elements
are burried more deeply in the xml hierarchy, use: ?expand=revision.*.