It's all about the answers!

Ask a question

Work Item REST API to create Trac-like Feedback System?


Li-Te Cheng (161) | asked Sep 12 '07, 2:00 p.m.
Hi,

A few of my colleagues have deployed end-user-facing web sites with a simple feedback page tied directly to the Trac bug-tracking system. This approach seems to have gathered much input from regular users.

The simple feedback page does the following:

1. users need to enter guest or personal credentials to login
2. users can view existing work items or review their past submitted work items on their status
3. one-click hyperlinks that generate a work item form with certain fields already prepopulated, so the author can focus on writing a description, not picking fields.

Jazz can already handle #1 and #2 out of the box... what I was wondering is if there is a REST API to handle #3?

e.g. in Trac, these one-click links are displayed as:

---

Found a bug in XYZ?

Show-stopper!
(link to http.../newticket?component=bugs&owner=<email address>&severity=blocker)

annoying
(link to http.../newticket?component=bugs&owner=<email address>&severity=major)

quirky
(link to http.../newticket?component=bugs&owner=<email address>&severity=minor)


Want a feature?

must-have!
(link to http.../newticket?component=feature-requests&owner=<email address>&priority=highest)

would love
(link to http.../newticket?component=feature-requests&owner=<email address>&priority=normal)

in a perfect world...
(link to http.../newticket?component=feature-requests&owner=<email address>&priority=low)

---

This kind of capability would be useful for products bundled with a simple web form for user feedback that ties directly back into the Jazz work item system.

Thanks in advance,

Li-Te

5 answers



permanent link
Todd Lainhart (40611) | answered Sep 12 '07, 3:33 p.m.
FORUM MODERATOR / JAZZ DEVELOPER
I'm not sure what you're asking for in "#3". Could you describe your
needs in terms of PUT/POST/GET, and pseudo-URIs?

I'm confused as to whether or not you're trying to build a Trac-like
system using existing Jazz APIs, or if you're asking for enhancements to
the WebUI.

-- Todd

li-te_cheng wrote:
Hi,

A few of my colleagues have deployed end-user-facing web sites with a
simple feedback page tied directly to the Trac bug-tracking system.
This approach seems to have gathered much input from regular users.

The simple feedback page does the following:

1. users need to enter guest or personal credentials to login
2. users can view existing work items or review their past submitted
work items on their status
3. one-click hyperlinks that generate a work item form with certain
fields already prepopulated, so the author can focus on writing a
description, not picking fields.

Jazz can already handle #1 and #2 out of the box... what I was
wondering is if there is a REST API to handle #3?

e.g. in Trac, these one-click links are displayed as:

---

Found a bug in XYZ?

Show-stopper!
(link to http.../newticket?component=bugs&owner=<email
address>&severity=blocker)

annoying
(link to http.../newticket?component=bugs&owner=<email
address>&severity=major)

quirky
(link to http.../newticket?component=bugs&owner=<email
address>&severity=minor)


Want a feature?

must-have!
(link to
http.../newticket?component=feature-requests&owner=<email
address>&priority=highest)

would love
(link to
http.../newticket?component=feature-requests&owner=<email
address>&priority=normal)

in a perfect world...
(link to
http.../newticket?component=feature-requests&owner=<email
address>&priority=low)

---

This kind of capability would be useful for products bundled with a
simple web form for user feedback that ties directly back into the
Jazz work item system.

Thanks in advance,

Li-Te

permanent link
Li-Te Cheng (161) | answered Sep 12 '07, 5:28 p.m.
Hi Todd,

> I'm not sure what you're asking for in "#3".
> Could you describe your
> needs in terms of PUT/POST/GET, and pseudo-URIs?

Basically, I'm interested in a simple way to specify work item fields as part of a URI to generate a work item form in the Web UI.

With Trac today, you can create HTML that looks like this:

---

<html>
<body>

Found a bug in the Work Item UI?<p/>

Yes, I found a bug that is a... <p/>

<a href="http:.../newticket?component=bugs-workItemUI&owner=lainhart@jazz.net&severity=blocker">Show-stopper!</a> <p/>

<a href="http:.../newticket?component=bugs-workItemUI&owner=lainhart@jazz.net&severity=major">Annoying</a> <p/>

<a href="http:.../newticket?component=bugs-workItemUI&owner=lainhart@jazz.net&severity=minor">Quirky</a> <p/>

Want a new feature in the Work Item UI?<p/>

Yes, I would like to propose a feature that is a... <p/>

<a href="http:.../newticket?component=feature-requests-workItemUI&owner=lainhart@jazz.net&priority=highest">must-have!</a><p/>

<a href="http:.../newticket?component=feature-requests-workItemUI&owner=lainhart@jazz.net&priority=normal">would love</a><p/>

<a href="http:.../newticket?component=feature-requests-workItemUI&owner=lainhart@jazz.net&priority=low">in a perfect world...</a><p/>

</body>
</html>

---

Trac uses a single URI to bring up a new work item form, i.e.

http:.../newticket

and specify certain fields to be prefilled:

http:.../newticket?component=...&owner=...&priority=...&severity=...

In the above example, this is all done via GET. I'd imagine this would also work equally well as a POST.

In Jazz, I can see you can do this to bring up a new work item form:

https://jazz.net/jazz/web/projects/Jazz%20Project#perspective=Work%20Items&action=newWorkItem

but I don't see how to prefill the fields with a single URI. For example,

https://jazz.net/jazz/web/projects/Jazz%20Project#perspective=Work%20Items&action=newWorkItem&severity=Major&type=Enhancement

doesn't create a new work item with the severity set to Major and the type set to Enhancement.

Is there already something available that can do this? Or would this be considered a server-side extension?

Thanks,

Li-Te

permanent link
Todd Lainhart (40611) | answered Sep 14 '07, 4:41 p.m.
FORUM MODERATOR / JAZZ DEVELOPER
Hi Li-Te -

I understand now. Currently there is no support in the WebUI for what
you ask for. If this is important for you, you should create an
enhancement request.

-- Todd

li-te_cheng wrote:
Hi Todd,

I'm not sure what you're asking for in "#3".
Could you describe your
needs in terms of PUT/POST/GET, and pseudo-URIs?

Basically, I'm interested in a simple way to specify work item fields
as part of a URI to generate a work item form in the Web UI.

With Trac today, you can create HTML that looks like this:

---

html
body

Found a bug in the Work Item UI?<p/

Yes, I found a bug that is a... <p/

a
href="http:.../newticket?component=bugs-workItemUI&owner=lainhart@jazz.net&severity=blocker">Show-stopper!</a
p/

a
href="http:.../newticket?component=bugs-workItemUI&owner=lainhart@jazz.net&severity=major">Annoying</a
p/

a
href="http:.../newticket?component=bugs-workItemUI&owner=lainhart@jazz.net&severity=minor">Quirky</a
p/

Want a new feature in the Work Item UI?<p/

Yes, I would like to propose a feature that is a... <p/

a
href="http:.../newticket?component=feature-requests-workItemUI&owner=lainhart@jazz.net&priority=highest">must-have!</a><p/

a
href="http:.../newticket?component=feature-requests-workItemUI&owner=lainhart@jazz.net&priority=normal">would
love</a><p/

a
href="http:.../newticket?component=feature-requests-workItemUI&owner=lainhart@jazz.net&priority=low">in
a perfect world...</a><p/

/body
/html

---

Trac uses a single URI to bring up a new work item form, i.e.

http:.../newticket

and specify certain fields to be prefilled:


http:.../newticket?component=...&owner=...&priority=...&severity=...

In the above example, this is all done via GET. I'd imagine this
would also work equally well as a POST.

In Jazz, I can see you can do this to bring up a new work item form:


https://jazz.net/jazz/web/projects/Jazz%20Project#perspective=Work%20Items&action=newWorkItem

but I don't see how to prefill the fields with a single URI. For
example,


https://jazz.net/jazz/web/projects/Jazz%20Project#perspective=Work%20Items&action=newWorkItem&severity=Major&type=Enhancement

doesn't create a new work item with the severity set to Major and the
type set to Enhancement.

Is there already something available that can do this? Or would this
be considered a server-side extension?

Thanks,

Li-Te

permanent link
Li-Te Cheng (161) | answered Sep 17 '07, 9:08 a.m.
Ok, will do.

Thanks!

Li-Te

permanent link
Matthias Böhmer (1462019) | answered Dec 20 '09, 3:15 p.m.
Is this possible now? I want to enable end-users to file bugs directly into jazz.

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.