Initialize API

The initialize API serves as an entry point for Packaged CCE system setup. It allows you to:

Start setup tasks for system configuration.
Check the initialization status of the system.

URL

https://<server>/unifiedconfig/config/initialize

Operations

list: Lists information about the system initialization status.
update: Starts a system initialization.

Parameters

name: The name of the startup task.
state: The state of the task. Values are:
- NOT_STARTED
- PROCESSING
- FAILED_NEEDS_RETRY: Occurs when an initialization task that does not require uninitialization fails. Correct the errors then invoke the Initialize API again.
- FAILED: Occurs when a task that requires uninitialization fails. Correct the errors, and then invoke the Uninitialize API. After a successful uninitialization, the initialization request can be made again.
- SUCCEEDED

Example Get Response

Code Snippet

Copy<results>
   <state>FAILED</state>
   <initializationStatuses>
      <initializationStatus>
         <state>NOT_STARTED</state>
         <name>JtapiClientTask</name>
      </initializationStatus>
      <initializationStatus>
         <state>FAILED</state>
         <name>PGUserTask</name>
         <apiErrors>
             <apiError>
                 <errorType>errorConnectAXL</errorType>
                 <errorMessage>There is no UCM AXL service defined yet</errorMessage>
             </apiError>
          </apiErrors>
      </initializationStatus>
   </initializationStatuses>
</results>