It's all about the answers!

Ask a question

URI template for reading a workItem with REST API


Nicolas Dangeville (31632525) | asked Oct 01 '08, 6:54 a.m.
JAZZ DEVELOPER
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

3 answers



permanent link
Patrick Streule (4.9k21) | answered Oct 02 '08, 3:57 a.m.
JAZZ DEVELOPER
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

permanent link
Nicolas Dangeville (31632525) | answered Oct 03 '08, 4:19 a.m.
JAZZ DEVELOPER
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

permanent link
Patrick Streule (4.9k21) | answered Oct 03 '08, 4:40 a.m.
JAZZ DEVELOPER
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

Your answer


Register or 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.