Context Service Configuration API

Context Service Configuration API

Use the Context Service Configuration API to configure Context Service settings for SocialMiner.

URL

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

Operations

  • get: Gets the Context Service configuration data, using the URL https://<server>/unifiedconfig/config/contextservice.

  • update: Updates the Context Service configuration data.

Parameters

  • proxyUrl: URL of the proxy server. The default is an empty string. Optional.

  • maxRetries: The maximum number of times that the system attempts the operation. This parameter must be set to 1.

  • timeout: The amount of time, in milliseconds, that the system waits before abandoning the attempt to perform the operation. The default is 1200 ms. The values are 200 - 15000 ms. Optional.

  • labMode: Whether the Context Service is in lab mode. The default is false. Optional.

Example Get Response

 <contextServiceConfig>
   <proxyUrl>http://example.com:80</proxyUrl>
   <maxRetries>1</maxRetries>
   <timeout>10000</timeout> 
   <labMode>false</labMode>
</contextServiceConfig>

Following are the REST responses received during execution of REST API to configure the Context Service for CVP or Finesse:

  • Success - Configuration changes persist in AW DB and synchronized with respective devices.

    Code: 200

    Response: Successfully saved

  • Partial Success - Configuration changes persist in AW DB, but failed to synchronize with one or more devices of CVP and/or Finesse.

    Code: 201

    Response: Configuration update failed for one or more devices. (This occurs when the AW DB is updated but Sync with CVP or Finesse failed.)

    Code: 503

    Response: The server is currently busy. Please try again later. (This occurs when data synchronization to a device is in progress.)

    Example API error:
    <apiErrors>
    <apiError>
    <errorMessage>Configuration update failed for one or more devices.</errorMessage>
    <errorType>PARTIAL_SUCCESS</errorType>
    </apiError>
    </apiErrors>
    
  • Failure- The configuration updates to AW DB is failed.