SmartObject Services

This content applies to legacy components (such as K2 Studio and K2 for Visual Studio), legacy assemblies, legacy services or legacy functionality. If you have upgraded from K2 blackpearl 4.7 to K2 Five, these items may still be available in your environment. These legacy items may not be available in new installations of K2 Five. These legacy items may also not be available, supported, or behave as described, in future updates or versions of K2. Please see the legacy component support policy for more information about support for these components.

K2 SmartObject Services provide WCF and RESTful web service endpoints for SmartObjects. In essence, these services provide platform-independent, URL-based access to SmartObject methods.

K2 provides both WCF and REST services for SmartObject methods.

The WCF services are generally used for .NET solutions with server-side processing, and they provide strongly-typed access to SmartObjects. The service supports SOAP and ATOM formats and is accessible over HTTP or HTTPS.

The REST services are mostly used when developers want to interact with SmartObjects in a technology other than .NET (for example, jQuery) or do not wish to add a reference to a service to their .NET project. The REST services support XML, ATOM and JSON output formats, and you can specify which format you want returned with a query string options appended to the service endpoint.

The main difference between the WCF SmartObjects services and the REST SmartObject services is that the REST services expose each method of the selected SmartObjects as a separate endpoint. This means that developers will access the methods by submitting GET requests to a specific URI. The URI would point to a specific method for a specific SmartObject.

Please see the following topics for more information on the architecture, configuration and use of the SmartObject services: