Is the Rest API docuemntation available for Rational Jazz Team Server 6.0?

mario vece (11●1) | asked Oct 21 '16, 7:07 a.m.

Hi,

I wish to retrieve the information of a work item using Rest API but I don't find an up to date documentation.

The version of the Rational Jazz Team Server is 6.0.

Could anyone help me on this issue?

Thanks in advance.

Best regards,

Mario

One answer

Most liked answers ↑|Newest answers|Oldest answers

permanent link

Donald Nong (14.5k●3●14) | answered Oct 23 '16, 8:35 p.m.

The API specification remains stable across version. You should be able to just follow what is currently available.
https://jazz.net/wiki/bin/view/Main/WorkItemAPIsForOSLCCM20
https://jazz.net/wiki/bin/view/Main/ReportsRESTAPI

Or do you have problems with retrieving certain information?

Comments

mario vece commented Oct 28 '16, 11:53 a.m. | edited Oct 30 '16, 7:17 p.m.

Hi,

I checked the documentation and I was able to retrieve information of a specific work Item but, I need to retrieve the same information that I can retrieve via query from the RTC web page.

More in details, I wish to retrieve information from RTC filtering by TYPE(i.e.: story), RELEASE(i.e.: FY17-Q1), BUSINESS AREA(i.e.: DCPP), but I cannot find out how to do it following the same documentation.

Could anyone support me about this issue?

Thanks in advance for your support.

Best Regards,

Mario

Donald Nong commented Oct 30 '16, 7:17 p.m.

Which API are you using? Reportable REST API or the OSLC API? They are quite different in implementation.

mario vece commented Nov 08 '16, 11:19 a.m.

Using Rest API we wish to retrieve the workItems filtering on custom attributes but we get:

Error 500:CRRED0135E:Illegal filter.The field 'workitem/allExtensions/key' may not be used in a filter because it returns multiple values.

Find below details of a request that works:

Resource:/ccm1/rpt/repository/workitem?fields=workitem/workItem[type/id=defect]/(id|allExtensions/*)

In the response we see:

<key>com.acn.diip.defect.release</key>

<displayValue>FY16-Q2</displayValue>...

<key>com.acn.diip.defect.businessarea</key>

<displayValue>DCPP...

So we wish to add also the filter conditions:

(allExtensions/key='com.acn.diip.defect.businessarea' and allExtensions/displayValue='DCPP')or(allExtensions/key='com.acn.diip.defect.release'...

Could you please support us?Thanks

Donald Nong commented Nov 08 '16, 6:28 p.m.

Unfortunately I don't have a solution for that. I think it's the limitation how RTC can parse the filter to an underlying query. As the error suggests, it refuses to work with multi-valued attributes.

mario vece commented Nov 09 '16, 9:59 a.m.

HI Donald,

I can execute a query on RTC web that is exactly what I wish to do via REST API.

Is it possible to run the query via http and then get the result in response?

Thanks,

Mario

Donald Nong commented Nov 09 '16, 7:28 p.m.

You're talking about the work item query, which cannot be the same as the REST API. If you just want to run the same work item query, you can do it.
https://jazz.net/forum/questions/218828/how-can-i-run-a-stored-query-with-input-parameter-with-rest-api

showing 5 of 6 show 1 more comments

It's all about the answers!

Related questions

Is the Rest API docuemntation available for Rational Jazz Team Server 6.0?

One answer

Your answer