Troubleshooting 500 internal server error on REST API PATCH: updating connection parameters

[ihoryokhym]

Troubleshooting 500 internal server error on REST API PATCH: updating connection parameters

Step-by-Step Guide: 

1. Identify the Cause of the Error:
   
• The 500 Internal Server Error typically arises from trying to use outdated API endpoints for updating connections after recent platform upgrades.
2. Check Release Notes:
   
• Refer to the latest release notes for insights into recent changes that might impact the API endpoints. Recent updates may have altered the behavior of certain endpoints.
• Example release notes link: Release Notes.
  
  
3. Switch to Connection Manager APIs:
   
   • To list current connections, use GET /connections.
   • To update connections, apply the PATCH method under the correct section for Connection Management.
     
• The changes may relate to a new feature, the Connection Manager, which mandates using its specific API set.
• Navigate to API version 2.0 -> Connection Management section:
  
  
4. Verify Connection Parameters:
   
• Ensure your PATCH request includes the appropriate parameter structure, like provider, schema, parameters, Server, UserName, Database, etc., to avert further API errors.
• Example JSON structure for connection parameters:

{
  "connection": {
    "provider": "sql",
    "schema": "Dashboard",
    "parameters": {
      "Password": "password",
      "ApiVersion": 2,
      "Server": "server",
      "UserName": "username",
      "port": "1433",
      "DefaultDatabase": "",
      "encrypt": false,
      "AdditionalParameters": "",
      "Schema": "",
      "Database": "database"
    }
  }
}

Switching to the updated Connection Manager API methods and ensuring accurate parameter configuration can resolve the 500 Internal Server Error when modifying connections in Sisense REST API. If problems remain unresolved, enabling access for support can facilitate targeted troubleshooting.

Refrences

For more detailed information, you can visit:

Connection Management API Documentation: API Documentation

Sisense Release Notes: Release Notes