REST API Migration Guide

Multi-platform support in DPE Nano Services requires to move the service protocol from Windows Communication Foundation (WCF) to a REST API.
This guide gives you some hints how to migrate 3rd party clients and custom workflows.

Migrate 3rd party clients to REST

The result of the endpoint “api/health” indicates whether the backend is “isNano=true”.
In this case you must use the REST API. Note, for easier migration we have also equipped the classic DPE with all REST endpoints.

Migrate custom Workflows to REST

The standard workflow templates provided by DAVID Systems switch automatically between WCF or REST communication based on the used backend.
In the case of DPE Nano Services REST communication must be used.

Custom workflow templates need to be changed to use WCF or REST endpoints based on the backend services.
How to:

1. Define a new boolean Argument UseRestForDpeAccess with default False.
   The Workflow Editor and the Workflow Server will set this to True for DPE Nano Services.

2. If your workflow calls DPE Services directly via .Net proxy classes based on a ProxyContainer you need to change this to REST with using the HttpGet activity.

3. Example: This workflow uses for WCF the proxy method David.Dpe.ContentService.ContentServiceProxy.EasyGetEntries. For REST the endpoint api/entries is used.