Where can I find a documentation of Crucible REST API?

Hi,

I found this official page http://docs.atlassian.com/fisheye-crucible/2.6.0/wadl/crucible.html - but many things are not described.

For example: How can I add a reviewItem or a reviewer? I can see the REST URL but I need a scheme or at least an example too. The acceptable request representations links are not able to expand :-(

Is there an alternativ documentation? - with google I had no luck.

Kind regards,

christian

3 answers

1 accepted

What about the POST variant of

/rest-service/reviews-v1/{id}/reviewers

This is described in the WADL file.

The structure of the reviewers list is described in the XSD file:

http://docs.atlassian.com/fisheye-crucible/latest/wadl/crucible.xsd

The list type

<xs:complexType name="reviewers">
<xs:sequence>
<xs:element name="reviewer" type="reviewerData" nillable="true" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>

The individual entries:

<xs:complexType name="reviewerData">
<xs:complexContent>
<xs:extension base="userData">
<xs:sequence>
<xs:element name="completed" type="xs:boolean"/>
<xs:element name="completionStatusChangeDate" type="xs:long" minOccurs="0"/>
<xs:element name="timeSpent" type="xs:long" minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>

The base type (userData):

<xs:complexType name="userData">
<xs:sequence>
<xs:element name="avatarUrl" type="xs:string" minOccurs="0"/>
<xs:element name="displayName" type="xs:string" minOccurs="0"/>
<xs:element name="userName" type="xs:string" minOccurs="0"/>
</xs:sequence>
</xs:complexType>

Thanks for your answers. That helps me a lot!

Unfortunatly that entry I want to see is missing. How can I add a reviewer to a review?

0 vote

This works for me to add a reviewer.

wget http://localhost:6060/foo/rest-service/reviews-v1/CR-1/reviewers --post-data=user1,user2 --header='Content-type: application/json' --http-user=admin --http-password=admin --auth-no-challenge --no-http-keep-alive

Thanks for your answers. That helps me a lot!

Suggest an answer

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

How to earn badges on the Atlassian Community

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

Learn more
Community showcase
Published Thursday in Marketplace Apps

Tips on how to choose the best estimation method for your planning

Planning and grooming sessions all come with their own sets of rules. Team members meet to estimate stories or other work items, all according to an agreed-upon process. And with every session comes ...

68 views 0 11
Read article

Atlassian User Groups

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

Find a group

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

Find my local user group

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

Start an AUG

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

Groups near you