...
Universal Controller supports the following RESTful-based web services for Database Connection operations, which are listed alphabetically on this page.
- Database Connection Web Services#Create Create a Database ConnectionDatabase Connection Web Services#Delete
- Delete a Database Connection
- Database Connection Web Services#List List Database ConnectionsDatabase
- Connection Web Services#Modify Modify a Database ConnectionDatabase Connection Web Services#Read
- Read a Database Connection
Formatting specifications for each web service, including details about property requirements, are provided.
...
Description | |
---|---|
URI | |
HTTP Method | POST |
Description | Creates an Database Connection. |
Example URI | http://localhost:8080/uc/resources/databaseconnection |
Consumes Content-Type | application/xml, application/json |
Produces Content-Type | n/a |
Example Request | See Create a Database Connection: Example Request, below. |
Example Response |
|
Database Connection Properties | See Database Connection Web Services#Database Connection Properties, below. |
Anchor | ||||
---|---|---|---|---|
|
...
Property | UI Field Name | Description | Specifications | Required | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
credentials | Credentials | Credentials for this Database Connection. | N | |||||||||||||
dbDescription | Description | Description of this record. | N | |||||||||||||
dbDriver | Driver | Name of the JDBC driver. | Y | |||||||||||||
dbMaxRows | Maximum Rows | If necessary, specifies a limit to the number of rows you want returned by the SQL statement. | N | |||||||||||||
dbType | Database Type | Type of Database. | Valid Values: <ul>
<li>
Default is MySQL (1). | Y | ||||||||||||
dbUrl | Connection URL | URL of the database. | Y | |||||||||||||
exportReleaseLevel | n/a | Universal Controller release that the record was exported from. | read only | N | ||||||||||||
exportTable | n/a | Record table information. | read only | N | ||||||||||||
name | Connection Name | Name used within the Controller to identify this Database Connection. | Y | |||||||||||||
opswiseGroups | Member of Business Services | Business Services that this record belongs to.
| N | |||||||||||||
retainSysIds | n/a | Specification for whether or not the Create a Database Connection web service will persist the Html bobswift |
| Valid values: true/false (default is true). | N | |||||||||||
sysId | n/a | System ID field in the database for this Database Connection record. | Persisted only if retainSysIds is set to true. | N |
...
Description | |
---|---|
URI | |
HTTP Method | GET |
Description | Retrieves information on all Database Connections. |
Example URI | http://localhost:8080/uc/resources/databaseconnection/list |
Authentication | HTTP Basic |
Consumes Content-Type | n/a |
Produces Content-Type | application/xml, application/json |
Example Response | See List Database Connections: Example Response, below. |
Database Connection Properties | See Database Connection Web Services#Database Connection Properties. |
Anchor | ||||
---|---|---|---|---|
|
...
Description | |
---|---|
URI | |
HTTP Method | PUT |
Description | Modifies the Database Connection specified by the |
Example URI | |
Consumes Content-Type | application/xml, application/json |
Produces Content-Type | n/a |
Example Request | See Modify a Database Connection: Example Request, below. |
Database Connection Properties | See Database Connection Web Services#Database Connection Properties. |
Example Response |
|
...
URI | http://host_name/uc/resources/databaseconnection |
HTTP Method | GET |
Description | Retrieves information on a specific Database Connection. |
URI Parameters | See Read a Database Connection: URI Parameters, below. |
Example URI | http://localhost:8080/uc/resources/databaseconnection?connectionname=Test4 |
Consumes Content-Type | n/a |
Produces Content-Type | application/xml, application/json |
Example Response | See Read a Database Connection: Example Response, below. |
Database Connection Properties | See Database Connection Web Services#Database Connection Properties. |
Anchor | ||||
---|---|---|---|---|
|
...