topic Re: REST API in Alfresco Archive

REST API

erictice — Fri, 05 Jun 2009 15:13:38 GMT

In using the REST 3.0 API I am finding that the documentation is somewhat incomplete. For example, in the rules services the Add Action Item Queue would logically have a number of inputs, but they are not listed as they are under content. Is there a more detailed doc out there?

Re: REST API

mwildam — Fri, 12 Jun 2009 13:20:21 GMT

You are not the only one finding it incomplete.

And mostly there is even no example given.

Somewhat frustrating… :x

Re: REST API

erictice — Fri, 12 Jun 2009 14:13:35 GMT

Yes. It seems that they want the community to update it as they ferret out the answers. I will do some of that. It would be helpful for people to add examples of how to implement the services. I will add how you might call it from Java to some as I get farther along to assure that others don't have the same problems.

Re: REST API

mwildam — Mon, 15 Jun 2009 06:42:22 GMT

Yes. It seems that they want the community to update it as they ferret out the answers.

I would rather tend think they want to sell training lessons. :wink:

Re: REST API

jpfi — Mon, 15 Jun 2009 07:45:37 GMT

Hi guys,
that has nothing to do with "selling training sessions". You don't receive a full API documentation in an official training.
You're using Open Source Software & OS is build on contribution. If you miss sth. –> add it.
This wiki content (http://wiki.alfresco.com/wiki/Repository_RESTful_API_Reference) is simply generated by calling http://<host>:<port>/alfresco/service/index/all.mediawiki?url=/api&desc=Public
JSON Input, of POST commands isn't listed because it is not part of desc.xml-files. This is a weakness, but you'll find all you need in the source code (js and ftl-files).
Cheers, jan

Re: REST API

mwildam — Mon, 15 Jun 2009 07:48:20 GMT

To add something I would first need to find out or find somebody who knows how to do/solve an actual/particular problem… :wink:

Re: REST API

jpfi — Mon, 15 Jun 2009 08:06:02 GMT

hi,
yub, of course but you should stop blaming alfresco in these cases.
cheers, jan

Re: REST API

mwildam — Mon, 15 Jun 2009 08:59:00 GMT

hi,
yub, of course but you should stop blaming alfresco in these cases.
cheers, jan

Apart from the attached smiley to the comment you are referring to, you are right - I should not blame Alfresco for the fact that there is still a lot to do. Thanks for the reminder. When I really start blaming, it looks different - so I shouldn't either start.

Have a nice day.

Re: REST API

jpfi — Mon, 15 Jun 2009 09:02:37 GMT

d'accord :wink:

Re: REST API

mwildam — Mon, 15 Jun 2009 09:21:41 GMT

BTW: I have added the appropriate notes to the documentation.

Re: REST API

mikeh — Mon, 15 Jun 2009 09:31:21 GMT

BTW: I have added the appropriate notes to the documentation.

Thank you.

Mike

Re: REST API

erictice — Mon, 15 Jun 2009 13:36:17 GMT

Thank you for the comments. All I was asking for was a complete list of all in and out params for the services.

Re: REST API

mwildam — Mon, 15 Jun 2009 13:46:44 GMT

This is, where I started: http://wiki.alfresco.com/wiki/Repository_RESTful_API_Reference
However, it took me a lot of trial & error to figure out only the login and logout. For those I have added notes, but I guess there is more lack of documentation.

Another tip, that might help is using your local Alfresco installation to get information - see sample below for login:
http://localhost:8080/alfresco/service/script/org/alfresco/repository/login.post

http://localhost:8080/alfresco/service/script/org/alfresco/repository/login.post‍