It's all about the answers!

Ask a question

REST APIs Swagger (or similar) spec.


diogo cruz (21512) | asked May 24 '16, 5:12 a.m.
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?

One answer



permanent link
Donald Nong (14.4k313) | answered May 25 '16, 11:04 p.m.
This one?
https://jazz.net/wiki/bin/view/Main/ReportsRESTAPI

Comments
diogo cruz commented May 27 '16, 4:07 a.m.

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


Donald Nong commented May 29 '16, 9:38 p.m.

"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


diogo cruz commented Jun 03 '16, 4:05 a.m.

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?


Geoffrey Clemm commented Jun 05 '16, 6:50 p.m.
FORUM ADMINISTRATOR / FORUM MODERATOR / JAZZ DEVELOPER

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 to post your answer.