General information

The DataService web service in bpm'online is based on the ServiceStack .NET framework.

ServiceStack is a framework for creating Microsoft .NET and Mono web services and web applications. It is an alternative to frameworks like WCF, ASP.NET MVC and ASP.NET Web API. ServiceStack is particularly suitable for the development of REST web services. With ServiceStack, you can quickly create an API that can be hosted on any hosting server (IIS, Windows Service, Self-host or Mono).

ServiceStack main features:

• Endpoints like in REST and SOAP
• Auto-configuration of data formats, including XML, JSON, HTML, CSV, and JSV
• Plain-old CLR objects (POCO) as incoming and outgoing objects
• Validation and simple syntax
• Inversion of Control (IoC) container
• Object-Relational Mapping (ORM)
• Сaching mechanism (Memcached and Redis are supported)
• Lack of external libraries.

The bpm'online application DataService service

The DataService data contract list can be found by running the following query:

// DataService query string format.
http(s)://[Bpm'online application address]/[Configuration number]/dataservice/metadata
// DataService query string example.
http(s)://example.bpmonline.com/0/dataservice/metadata

In the query result, a page appears with a complete list of supported DataService data contracts (Fig. 1). Most of the classes of the data contracts presented by the DataService service have a service purpose and are not recommended for use by third-party developers.

Fig. 1 The bpm'online DataService contract data list

The full list and description of the DataService data contracts is displayed on table 1.

Table 1. The bpm'online application DataService services

See Also