CIMPLICITY Configuration REST API Web Service
CIMPLICITY Configuration REST API Web Service / All Operations Resource Group / /projects/{projectId}/SQLConnections (Post)
Post/projects/{projectId}/SQLConnections
Description
Creates or updates an array of sql connections in the project
Parameters
NameDescriptionData Type
the id of the projectstring
Request (application/json)

The request body is of type object.

Overview

SQLDefaultConnections : Array[CimSQLConnection]
ConnectionType : CimSQLConnectionType
ODBCDataSource : string
UserID : string
Passsword : string
ReconnectWaitPeriod : integer
ReconnectWaitUnit : CimTimeUnitEnum
EnableStoreAndForward : boolean
MaxNumberOfStoredRecord : number
SQLTableConnections : Array[CimSQLTableConnection]
Table_id : string
SQLConnection : CimSQLConnection
ConnectionType : CimSQLConnectionType
ODBCDataSource : string
UserID : string
Passsword : string
ReconnectWaitPeriod : integer
ReconnectWaitUnit : CimTimeUnitEnum
EnableStoreAndForward : boolean
MaxNumberOfStoredRecord : number
Dynamic : boolean
200 Response

The response body is of type ItemsPostResponse.

The SQL connection configuration is successful.

Overview

ItemsPostResponse
The results of the create/update/delete operations.
NumSuccesses : number
NumFailures : number
WarningsMask : integer
ItemResults : Array[ItemResult]
Success : boolean
StatusDetails : integer
WarningsMask : integer
Message : string
Fault Responses
FaultDescription
This fault returns a response body of type ProblemDetails.
Error if objects not found
This fault returns a response body of type .
General error
See Also