Calls

The CcmComposerUIAPIV1 API exposes one main call, which is CcmComposerUIAPIV1.Run.Start. It has the following parameters:

• starturl. String. An absolute URL to KCM Core, which is the absolute version of the relative URL that was retrieved through the web services call. This URL is accessed from the browser on the client machine. The base of this URL has to be clear to the specific network environment.
• sessionid. String. The session identifier retrieved through the web services call.
• jobid. String. An identifier of the specific run. Only used to identify the run in logs and on callbacks.
• elementid. String. The HTML ID of the element on the page that contains the user interaction for the document composition process.
• callbacks. CcmComposerUIAPIV1.Model.RunCallbacks. An object that exposes a number of callbacks that is called to notify the business application of an event.
• options. CcmComposerUIAPIV1.Model.RunOptions. An object containing some additional options.

The call returns true or false. Any subsequent information is passed through the callbacks.

Also, the API exposes CcmComposerUIAPIV1.Version.Get. This returns the version object with the following attributes:

• version. String. The software version of the API.
• build. String. The build number of the API.