DataService web service
Glossary Item Box
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 a service 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
Service | Description |
---|---|
SchemaDesignerRequest | Schema designer request class Not recommended to use. |
EntitySchema | Object schema class. Not recommended to use. |
ClientUnitSchema | Client schema class. Not recommended to use. |
RemoveEntitySchemaRequest | Remove object schema request. Not recommended to use. |
RemoveClientUnitSchemaRequest | Remove client schema request. Not recommended to use. |
EntitySchemaRequest | Receive object schema instance request. Not recommended to use. |
ClientUnitSchemaRequest | Receive client object schema instance request. Not recommended to use. |
ProcessUserTaskSchemaRequest | Receive business process user action schema request. Not recommended to use. |
UpdatePackageSchemaDataRequest | Receive package schema data update request. Not recommended to use. |
ProcessSchemaRequest | Receive process schema instance request. Not recommended to use. |
ContractProcessSchema | Process schema contract class. Not recommended to use. |
RemoveProcessSchemaRequest | Remove process schema request. Not recommended to use. |
InsertQuery | Add section record query class. |
UpdateQuery | Update section record query class. |
DeleteQuery | Delete section record query class. |
SelectQuery | Select section record query class. |
BatchQuery | Package query class. |
UserProfile | User profile class. Not recommended to use. |
QueryProfile | Query profile class. Not recommended to use. |
QuerySysSettings | Receive system settings list request. Not recommended to use. |
PostSysSettingsValue | Set system setting value class. Not recommended to use. |
PostSysSettingsValues | Set system setting values class. Not recommended to use. |
Filters | Filter class. |
QueryModuleDescriptors | Receive module descriptors query class. Not recommended to use. |
ClientLoggerDataContract | Client log data class. Not recommended to use. |
PostClientLog | Client log post class. Not recommended to use. |
UploadFile | File upload class. Not recommended to use. |
GetTelephonyConfig | Receive telephony configuration settings class. Not recommended to use. |
InsertSysSettingRequest | Add system setting query class. Not recommended to use. |
UpdateSysSettingRequest | Edit system setting query class. Not recommended to use. |
DeleteSysSettingRequest | Delete system setting query class. Not recommended to use. |
GetTests | Receive all Unit tests class. Not recommended to use. |
RunTests | Run Unit tests class. Not recommended to use. |