Implementing an external data service by using the REST protocol

Edit online
Draft comment:
This topic is shared by BAW, CP4BA. Last updated on 2025-03-13 12:15
To use external data with your solution, you must create a service that implements the external data service REST protocol. This protocol provides for the communication between Case Client and the external data source.

About this task

In addition to implementing the REST protocol, the external data service must implement any authentication that is required by the external data source.

Procedure

To implement an external data service:

  1. Implement the POST method for the particular object type resource.
    This method is called automatically by the REST protocol in response to requests from Case Client to create or modify a case. The external data service must submit the data for the case properties that it manages back to the REST protocol in the response to the POST method.
  2. If the service modified any attributes for the case properties that it manages, retrieve the property attributes.
    To retrieve property attributes, you can use the Content Platform Engine Java™ protocol or IBM® CMIS for Content Cortex in the external data service.
  3. If the external data service needs to authenticate users, configure authentication for users.