OrangeScape Developer Community

A community for Application Developers on OrangeScape's Platform-as-a-Service

Exposing Orangescape via Web service

We’ve seen how to access external resources via web services from Orangescape. You can read about it here and here.  Sometimes you might want to do the reverse, access Orangescape from external applications.  You can do the same with web services.  


By Default everything in Orangescape is exposed as web service.  Orangescape exposes as both SOAP based and REST web service.  Here we will see how to go about with SOAP based.


To get the WSDL for a particular model, the url would be of the following structure.  

  http://<appspot / server url>/<applicationId>/1/<modelId>/<ActivityId>/<modelId>?wsdl


If you find it difficult to understand, in your runtime, goto a queue of a model and copy the url.  The structure would be as follows,

  http://<appspot url>/<applicationId>/1/<modelId>/<ActivityId>?mimetype=text/htmlnow you can change it to the format mentioned above.


Now you can use this wsdl url in your soap client / application to access Orangescape.


While accessing by default all the fields and two actions (Update & Submit) are exposed.  If you need access to your actions, you will need to add them to the default form of that model, and then those too will be available to be invoked via web service.

 



You can access records of a model by either the system generated unique id (SheetId) or by a unique value which you had set (SheetName).  As you can see in the screenshot above, i have requested for the record with the sheetname value India, and the response shows the values for all fields of the model Country with SheetName India.  To update a value to a particular field, send the value in the request and it will be updated.

 



Similarly if you use the submit request, the value will be updated and submited in the workflow.  If you have any other actions added to the default form, they too will come up in the actions list, which you can use, in a similar fashion.

Views: 295

Comment

You need to be a member of OrangeScape Developer Community to add comments!

Join OrangeScape Developer Community

Comment by Kamal.S on March 27, 2014 at 3:06pm
Comment by Anbarasan on April 26, 2013 at 12:51pm

Hi Amit,

Yes you can specify it in Soap UI.  First create a integration user & password in the application.  then in soap ui add a header Authorization with the value as integrationUser:password encoded as base64

Comment by amitp.kpitcummins on April 24, 2013 at 6:15pm

Hi Anbarasan,

I am using SOAPUi to access OS web service , but while running its shows "Unable to authenticate.Auth info not present as part of the header" 

Do we need to provide username/password in header ? if so then i can provide it in SOAPUI please share the steps

~Amit Patil 

Comment by Anbarasan on January 28, 2013 at 1:38pm

Hi Brad,

For REST you can make use of the api from this link

If you have any questions, please post it in the forums.

Comment by Brad Cooper on January 27, 2013 at 10:16am

Hello Anbarasan,

Thank you for the informative post, as it seems to be the main post regarding OrangeScape's web service exposure capabilities, can you append it with information and/or examples regarding the REST URI format?

Also, as a note to developers, you may want to use https over http as you'll be required to pass the username/password for the integration account in the request header.

© 2017   Created by OrangeScape Technologies.   Powered by

Badges  |  Report an Issue  |  Terms of Service