In this topic, you will learn how to use the web service endpoint in edoc contract to create a contract that already exists in an ECM system but is not yet available in edoc contract with its contract properties.
The required ECM ID is sent as a parameter in the URL to the web service endpoint using the POST method. The properties are then retrieved from the ECM and synchronized with edoc contract.
An API key is required for authentication at the web service endpoint. You must adjust the API key in edoc automate before deploying and releasing the app.
How to customize the API key in edoc automate
-
In edoc automate, go to App details in the navigation bar and open the app variables in the workspace.
-
Replace the value of the variable rest_api.contract_create_document.api_key with a new API key.
Use the following URL to access the web service endpoint for creating a contract:
-
For any ECM system, use this URL: https://<app-server>/apps/ws/edoc-contract/create-document/<ECM-ID>
Replace the placeholder <ECM-ID> with the document ID from the ECM system (e.g. A000039803).