Database Connection Web Services
Overview
Universal Controller supports the following RESTful-based web services for Database Connection operations, which are listed alphabetically on this page.
- Create a Database Connection
- Delete a Database Connection
- List Database Connections
- Modify a Database Connection
- Read a Database Connection
Formatting specifications for each web service, including details about property requirements, are provided.
Create a Database Connection
|
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 Properties, below. |
Create a Database Connection: Example Request
XML Request |
JSON Request |
---|---|
|
|
Database Connection Properties
Property |
UI Field Name |
Description |
Specifications |
Required |
---|---|---|---|---|
|
Credentials |
Credentials for this Database Connection. |
|
N |
|
Description |
Description of this record. |
|
N |
|
Driver |
Name of the JDBC driver. |
|
Y |
|
Maximum Rows |
If necessary, specifies a limit to the number of rows you want returned by the SQL statement. |
|
N |
|
Database Type |
Type of Database. |
Valid Values:
Default is MySQL (1). |
Y |
|
Connection URL |
URL of the database. |
|
Y |
|
n/a |
Universal Controller release that the record was exported from. |
read only | N |
|
n/a | Record table information. | read only | N |
|
Connection Name |
Name used within the Controller to identify this Database Connection. |
|
Y |
|
Member of Business Services |
Business Services that this record belongs to. <opswiseGroups> <opswiseGroup>group1</opswiseGroup> <opswiseGroup>group2</opswiseGroup> </opswiseGroups> "opswiseGroups": ["group1","group2"] |
|
N |
|
n/a |
Specification for whether or not the Create a Database Connection web service will persist the
Note In XML web services, |
Valid values: true/false (default is true). |
N |
|
n/a |
System ID field in the database for this Database Connection record. |
Persisted only if retainSysIds is set to true. |
N |
Delete a Database Connection
|
Description |
---|---|
URI |
http://host_name/uc/resources/databaseconnection |
HTTP Method |
DELETE |
Description |
Deletes a Database Connection. |
URI Parameters |
See Delete a Database Connection: URI Parameters, below. |
Example URI |
http://localhost:8080/uc/resources/databaseconnection?connectionname=Test4 |
Example Response |
|
Delete a Database Connection: URI Parameters
Parameter |
Description |
Specifications |
Required |
Mutually Exclusive With |
---|---|---|---|---|
|
ID used within the Controller to identify this Database Connection. |
String; URI parameter. |
Y |
|
|
Name used within the Controller to identify this Database Connection. |
String; URI parameter. |
Y |
|
List Database Connections
|
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 |
List Database Connections: Example Response
XML Response |
JSON Response |
---|---|
|
|
Modify a Database Connection
|
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 |
|
Example Response |
|
Modify a Database Connection: Example Request
XML Request |
JSON Request |
---|---|
|
|
Read a Database Connection
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 |
Read a Database Connection: URI Parameters
Parameter |
Description |
Specifications |
Required |
Mutually Exclusive With |
---|---|---|---|---|
|
ID used within the Controller to identify this Database Connection. |
String; URI parameter. |
Y |
|
|
Name used within the Controller to identify this Database Connection. |
String; URI parameter. |
Y |
|
Read a Database Connection: Example Response
XML Response |
JSON Response |
---|---|
|
|