Documentation for RT REST API

Hi
I found the wiki page on the API at
http://wiki.bestpractical.com/view/REST and I have looked at the CLI
page and played with the CLI interface.

It seems to me that the REST API is missing a lot. For example I don’t
see any way of adding an attachment through the REST API. Is this a
short-fall in the API or just the documentation?

I presume the documentation is missing since the CLI (which uses the
REST API) allows one to do more than is documented in the REST API wiki.

Where can I get documentation for what is possible through the API please?

Regards
Ian

Hi
Well I found out that the CLI tool ‘rt’ is written in Perl and contains
documentation that helps me to test the CLI, and by inference it should
be possible to do everything I want with the REST API.

Unless I reverse engineer the API or put some monitoring on the HTTP
requests I still can’t find any complete documentation on the REST API
unless anyone can help?

Regards
Ian

icydee wrote:

I add attachments through the REST API. Unfortunately its not well
documented, I had to read the source code from the CLI myself to figure out
how to make it work, at least for the storing of attachments. I had to deduce
the encoding parts in order to get attachments out without making two HTTP calls.

I wrote what I learned into a convenience library for ruby called rt-client.
It’s available on rubyforge and you can install it with “gem install
rt-client” if you are a ruby person. I think the ruby code is a lot easier to
decipher than the perl, and thus possibly serves as better documentation, at
least for the parts I coded. There may be even more to the API that I haven’t
figured out yet, but what I’ve done will at least get you attachments.

http://rt-client.rubyforge.org/ for the documentation on my library, and to
figure out the REST interface for attachments read the source. The storing of
attachments is done in the compose() method, and the reading of them in
get_attachment().

icydee wrote:

Hi
Well I found out that the CLI tool ‘rt’ is written in Perl and contains
documentation that helps me to test the CLI, and by inference it should
be possible to do everything I want with the REST API.

Unless I reverse engineer the API or put some monitoring on the HTTP
requests I still can’t find any complete documentation on the REST API
unless anyone can help?

Regards
Ian

icydee wrote:

Hi
I found the wiki page on the API at
http://wiki.bestpractical.com/view/REST and I have looked at the CLI
page and played with the CLI interface.

It seems to me that the REST API is missing a lot. For example I don’t
see any way of adding an attachment through the REST API. Is this a
short-fall in the API or just the documentation?

I presume the documentation is missing since the CLI (which uses the
REST API) allows one to do more than is documented in the REST API wiki.

Where can I get documentation for what is possible through the API please?

Regards
Ian


http://lists.bestpractical.com/cgi-bin/mailman/listinfo/rt-users

Community help: http://wiki.bestpractical.com
Commercial support: sales@bestpractical.com

Discover RT’s hidden secrets with RT Essentials from O’Reilly Media.
Buy a copy at http://rtbook.bestpractical.com


http://lists.bestpractical.com/cgi-bin/mailman/listinfo/rt-users

Community help: http://wiki.bestpractical.com
Commercial support: sales@bestpractical.com

Discover RT’s hidden secrets with RT Essentials from O’Reilly Media.
Buy a copy at http://rtbook.bestpractical.com

– ============================
Tom Lahti
BIT Statement LLC

(425)251-0833 x 117
http://www.bitstatement.net/
– ============================