Jazz Forum Welcome to the Jazz Community Forum Connect and collaborate with IBM Engineering experts and users

URI template for reading a workItem with REST API

I would like to do a simple test of the RESTful API for the workitems. I've
found this document in the wiki
https://jazz.net/wiki/bin/view/Main/ResourceOrientedArchitecture that is
really helpful to understand the concept and behaviour, but I can't find
easily a URI that I could customize with my server properties that would
help me experiment with other functions.

Could you give me a sample URI ? I'm trying to obtain the XML representation
of a given workitem.

Many thanks,

Nicolas

0 votes



3 answers

Permanent link
I would like to do a simple test of the RESTful API for the workitems. I've
found this document in the wiki
https://jazz.net/wiki/bin/view/Main/ResourceOrientedArchitecture that is
really helpful to understand the concept and behaviour, but I can't find
easily a URI that I could customize with my server properties that would
help me experiment with other functions.

Could you give me a sample URI ? I'm trying to obtain the XML representation
of a given workitem.

The URL structure that you are referring to is:

https://<server>:<port>/jazz/resource/itemName/com.ibm.team.workitem.WorkItem/<id>?_mediaType=text/xml
(Instead of appending the _mediaType, you can set an HTTP header
"Accept: text/html")

However, we do *not* recommend to rely on this XML format for purposes
other than experiments. It is a representation of the internal EMF
structure and thus subject to change.

However, we are in the process of exploring and developing a stable
public REST API for work items.

Regards,
Patrick
Jazz Work Item Team

0 votes


Permanent link
Thanks, Patrick.

Will the new REST API for work-items be available in 1.01 or in 1.1 ?

Regards,

Nicolas

"Patrick Streule" <patrick_streule> wrote in message
news:gc1uts$d02$1@localhost.localdomain...
I would like to do a simple test of the RESTful API for the workitems.
I've found this document in the wiki
https://jazz.net/wiki/bin/view/Main/ResourceOrientedArchitecture that is
really helpful to understand the concept and behaviour, but I can't find
easily a URI that I could customize with my server properties that would
help me experiment with other functions.

Could you give me a sample URI ? I'm trying to obtain the XML
representation of a given workitem.

The URL structure that you are referring to is:

https://<server>:<port>/jazz/resource/itemName/com.ibm.team.workitem.WorkItem/<id>?_mediaType=text/xml
(Instead of appending the _mediaType, you can set an HTTP header "Accept:
text/html")

However, we do *not* recommend to rely on this XML format for purposes
other than experiments. It is a representation of the internal EMF
structure and thus subject to change.

However, we are in the process of exploring and developing a stable public
REST API for work items.

Regards,
Patrick
Jazz Work Item Team

0 votes


Permanent link
Will the new REST API for work-items be available in 1.01 or in 1.1 ?

It is planned for 1.1

Regards,
Patrick
Jazz Work Item Team

0 votes

Your answer

Register or log in to post your answer.

Dashboards and work items are no longer publicly available, so some links may be invalid. We now provide similar information through other means. Learn more here.

Search context
Follow this question

By Email: 

Once you sign in you will be able to subscribe for any updates here.

By RSS:

Answers
Answers and Comments
Question details

Question asked: Oct 01 '08, 6:54 a.m.

Question was seen: 5,457 times

Last updated: Oct 01 '08, 6:54 a.m.

Confirmation Cancel Confirm