SystemCheckInteractiveStartV2
SystemCheckInteractiveStartV2 starts an interactive test run. It produces a simple test document to verify that the KCM installation is up and running and can produce documents as intended. This document can be retrieved using SystemCheckInteractiveGetV2 with the returned ccmsessionid field (see SystemCheckInteractiveGetV1).
The request requires the following fields next to the standard fields.
|
Field |
Type |
Description |
|
text |
message |
Text to be added to the test. |
The response contains the following fields in addition to the standard fields.
|
Field |
Type |
Description |
|
ccmsessiondid |
sessionid |
The KCM Contract Manager session identifier to be used by SystemCheckInteractiveGetV2 to retrieve the resulting document. |
|
url |
url |
A URL that is relative to the base URL of Kofax Communications Manager. Example: https://<kcm server>:443/ccm/ All relative URLs that are returned are relative to this base URL. With this URL, the interactive process can be started. |