Analytic connection: Update

Note: LOCKED.
This API is extremely reliable and will not be broken unless absolutely necessary.

Method

PUT

Path

/qrs/analyticconnection/{id}

Description

Update the configuration for an analytic connection.

To update an analytic connection:

  1. Call the qrs/analyticconnection API endpoint to retrieve the configuration for the analytic connection: GET qrs/analyticconnection/{id} where {id} is the ID of the analytic connection that you want to update.
  2. Copy the entire response body and paste it into a text editor.
  3. Update the configuration in the text editor according to your needs.
  4. Copy and paste the contents from the text editor into the request body of the PUT qrs/analyticconnection/{id} call.
  5. Note: You must always include the entity ID and modifiedDate when performing an update. The entity ID of the body and of the URL must match. See Updating an entity.

Body

{ "id": "91d351b7-1adf-446e-9b97-1fa5ab2cabec", "createdDate": "2017-04-03T12:39:59.159Z", "modifiedDate": "2017-04-03T14:32:01.040Z", "modifiedByUserName": "INTERNAL\\sa_repository", "customProperties": [], "name": "MyAnalyticConnection", "host": "abc.com", "port": 8082, "certificateFilePath": "path_to_certificate\\cert.pem", "reconnectTimeout": 10, "requestTimeout": 10, "privileges": null, "impactSecurityAccess": false, "schemaPath": "AnalyticConnection" }

Return value

{ "id": "91d351b7-1adf-446e-9b97-1fa5ab2cabec", "createdDate": "2017-04-03T12:39:59.159Z", "modifiedDate": "2017-04-03T14:57:06.748Z", "modifiedByUserName": "INTERNAL\\sa_repository", "customProperties": [], "name": "MyAnalyticConnection", "host": "abc.com", "port": 8082, "certificateFilePath": "path_to_certificate\\cert.pem", "reconnectTimeout": 10, "requestTimeout": 10, "privileges": null, "impactSecurityAccess": false, "schemaPath": "AnalyticConnection" }

Optional parameters

-

Did this information help you?

Can you tell us why it did not help you and how we can improve it?