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

REST APIs Swagger (or similar) spec.

are there specs (e.g. swagger) of RTC REST APIs available?
If not , any plans?
When not, what is the best documentation available about the rest apis?

0 votes



One answer

Permanent link
This one?
https://jazz.net/wiki/bin/view/Main/ReportsRESTAPI

0 votes

Comments

AFAIK reporting APIs cover only retrieval of information.
A Restful application must cover also adding, updating and deleting.

"REST" is a loose concept. If you are looking for the full CRUD capability, you should use the OSLC API.
https://jazz.net/wiki/bin/view/Main/WorkItemAPIsForOSLCCM20

OSLC does not cover everytinhg. There are many REST APIs on RTC (and others?) besides OSLC like the xample provided: Report Rest API.


No matter which type, which ones are public? Which ones are documented? Following any standard?

If you just call them HTTP APIs, then there will be no confusion (:-).
To my knowledge, only the OSLC HTTP APIs are "public" (i.e. guaranteed to work from release to release).   You can reverse engineer the other HTTP APIs by watching the HTTP traffic from client to server, or by reading the code.   Those other HTTP APIs tend to be stable (nobody wants to redo client code unless they have to), but unlike the public APIs, are subject to change when necessary.

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
× 10,938
× 479

Question asked: May 24 '16, 5:12 a.m.

Question was seen: 3,225 times

Last updated: Jun 05 '16, 6:50 p.m.

Confirmation Cancel Confirm