HCL Compass REST API troubleshooting

Troubleshooting for various restrictions and known issues when using the HCL Compass REST API.

Note: Use of the REST API server is not supported in an on premises environment, such as on Windows and Linux. To use the HCL Compass REST API server in a supported environment, deploy the HCL Compass REST API server to a Kubernetes environment. For more information, see Getting Started with HCL Compass on HCL SoFy.
Scaling HCL Compass on Docker requires a longer timeout than the default value
The default HCL Flexnet license timeout is 10 seconds. To scale HCL Compass on Docker, set the license timeout to 60 seconds by using the following command:
export CQ_DIAG_BEHAVIOR='FN_params="timeout_conn=60;timeout_data=60"' 
Oracle connection errors with large number of concurrent API calls
If you see Oracle connection errors in HCL Compass REST API responses, such as ORA-12518: TNS:listener could not hand off client connection, then the Oracle instance may not have enough connections available to use. Contact your DBA or consult Oracle documentation to increase the number of connections for your Oracle instance.
Errors when using Japanese characters as field names in the REST API
Field names are predefined in the database. Japanese characters should only be used in field values. Do not use Japanese characters in field names inside the REST API. For example:

To insert Japanese characters without changing the field name:

{
   "fields": [
      {
         "name": "Headline",
         "value": "不好意"
      },
      {
         "name": "Severity",
         "value": "2-重要"
      }
   ]
}

The following example returns an error and illustrates incorrect usage:

{
   "fields": [
      {
         "name": "見出し",
         "value": "this is a test sample"
      },
      {
         "name": "重要度",
         "value": "2-重要"
      }
   ]
}