Page Comparison

...

Universal Controller supports the following RESTful-based web services for Database Connection operations, which are listed alphabetically on this page.

Formatting specifications for each web service, including details about property requirements, are provided.

...

	Description
URI	http://host_name/uc/resources/databaseconnection
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	Status 200 /OK Successfully created the Database Connection with sysId {sysId}. Status 400 /Bad Request Create Database Connection failed. A duplicate value has been detected. Name must be unique.
Database Connection Properties	See 63543501 Database Connection Properties, below.

Anchor

	Create a Database Connection Example Request
	Create a Database Connection Example Request

...

XML Request

JSON Request

Expand

title	XML Request

<databaseConnection retainSysIds="true">
    <credentials />
    <dbDescription />
    <dbDriver>com.mysql.jdbc.Driver</dbDriver>
    <dbMaxRows />
    <dbType>My SQL</dbType>
    <dbUrl>jdbc:mysql://localhost:3306/uc</dbUrl>
    <name>Database Connection 1</name>
    <opswiseGroups />
    <sysId>62701879a6264107bb757a952bcc65cc</sysId>
</databaseConnection>

Expand

title	JSON Request

{
    "credentials": null,'
    "dbDescription": null,
    "dbDriver": "com.mysql.jdbc.Driver",
    "dbMaxRows": null,
    "dbType": "My SQL",
    "dbUrl": "jdbc:mysql://localhost:3306/uc",
    "name": "Database Connection 1",
    "opswiseGroups": null,
    "retainSysIds": true,
    "sysId": "62701879a6264107bb757a952bcc65cc"
}

...

	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	Status 200 /OK Database Connection deleted successfully. Status 400 /Bad Request Mutual exclusion violation. Cannot specify `connectionname` and `connectionid` at the same time. Status 404 /Not Found a Database Connection with {name/id} "test" does not exist.

...

	Description
URI	http://host_name/uc/resources/databaseconnection/list
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 63543501 Database Connection Properties.

Anchor

	List Database Connections Example Response
	List Database Connections Example Response

...

XML Response

JSON Response

Expand

title	XML Response

<databaseConnections>  
    <databaseConnection exportReleaseLevel="7.2.0.0" exportTable="ops_database_connection" version="3">
        <credentials />
        <dbDescription />
        <dbDriver>com.mysql.jdbc.Driver</dbDriver>
        <dbMaxRows />
        <dbType>My SQL</dbType>
        <dbUrl>jjdbc:mysql://localhost:3306/uc</dbUrl>
        <name>Database Connection 1</name>
        <opswiseGroups />
        <sysId>62701879a6264107bb757a952bcc65cc</sysId>
    </databaseConnection>
    <databaseConnection exportReleaseLevel="7.2.0.0" exportTable="ops_database_connection" version="6">
        <credentials />
        <dbDescription />
        <dbDriver>com.mysql.jdbc.Driver</dbDriver>
        <dbMaxRows />
        <dbType>My SQL</dbType>
        <dbUrl>jdbc:mysql://localhost:3306/uc</dbUrl>
        <name>Database Connection 2</name>
        <opswiseGroups />
        <sysId>3d7a03053ad64de1b21b6849e6deafd9</sysId>
    </databaseConnection>
<databaseConnections>

Expand

title	JSON Response

[ 
    {
    "credentials": null,
    "dbDriver": "com.mysql.jdbc.Driver",
    "dbMaxRows": null,
    "dbType": "My SQL",
    "dbUrl": "jdbc:mysql://localhost:3306/uc",
    "dbDescription": null,
    "exportReleaseLevel": "7.2.0.0",
    "exportTable": "ops_database_connection",
    "name": "Database Connection 1",
    "opswiseGroups": null,
    "sysId": "62701879a6264107bb757a952bcc65cc",
    "version": 3
    },
    {
    "credentials": null,
    "dbDescription": null,
    "dbDriver": "com.mysql.jdbc.Driver",
    "dbMaxRows": null,
    "dbType": "My SQL",
    "dbUrl": "jdbc:mysql://localhost:3306/uc",
    "exportReleaseLevel": "7.2.0.0",
    "exportTable": "ops_database_connection",
    "name": "Database Connection 2",
    "opswiseGroups": null,
    "sysId": "3d7a03053ad64de1b21b6849e6deafd9",
    "version": 6
    }
]

...

	Description
URI	http://host_name/uc/resources/databaseconnection
HTTP Method	PUT
Description	Modifies the Database Connection specified by the `sysId`.
Example URI	http://localhost:8080/uc/resources/databaseconnection
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 63543501 Database Connection Properties.
Example Response	Status 200 /OK Successfully updated the Database Connection with sysId <sysId> to version <version>.

...

XML Request

JSON Request

Expand

title	XML Request

<databaseConnection>
    <credentials />
    <dbDescription />
    <dbDriver>com.mysql.jdbc.Driver</dbDriver>
    <dbMaxRows />
    <dbType>My SQL</dbType>
    <dbUrl>jdbc:mysql://localhost:3306/uc</dbUrl>
    <name>Database Connection 1</name>
    <opswiseGroups>
        <opswiseGroup>Accounting</opswiseGroup>
    </opswiseGroups>
    <sysId>62701879a6264107bb757a952bcc65cc</sysId>
</databaseConnection>

Expand

title	JSON Request

{
    "credentials": null,
    "dbDescription": null,
    "dbDriver": "com.mysql.jdbc.Driver",
    "dbMaxRows": null,
    "dbType": "My SQL",
    "dbUrl": "jdbc:mysql://localhost:3306/uc",
    "name": "Database Connection 1",
    "opswiseGroups": [ "Accounting" ],
    "sysId": "62701879a6264107bb757a952bcc65cc"
}

...

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 63543501 Database Connection Properties.

Anchor

	Read a Database Connection URI Parameters
	Read a Database Connection URI Parameters

...

XML Response

JSON Response

Expand

title	XML Response

<databaseConnection exportReleaseLevel="7.2.0.0" exportTable="ops_database_connection" retainSysIds="true" version="1">
    <credentials />
    <dbDescription />
    <dbDriver>com.mysql.jdbc.Driver</dbDriver>
    <dbMaxRows />
    <dbType>My SQL</dbType>
    <dbUrl>jdbc:mysql://localhost:3306/uc</dbUrl>
    <name>Database Connection 1</name>
    <opswiseGroups />
    <sysId>62701879a6264107bb757a952bcc65cc</sysId>
</databaseConnection>

Expand

title	JSON Response

{
    "credentials": null,
    "dbDescription": null,
    "dbDriver": "com.mysql.jdbc.Driver",
    "dbMaxRows": null,
    "dbType": "My SQL",
    "dbUrl": "jdbc:mysql://localhost:3306/uc",
    "exportReleaseLevel": "7.2.0.0",
    "exportTable": "ops_database_connection",
    "name": "Database Connection 1",
    "opswiseGroups": null,
    "retainSysIds": true,
    "sysId": "62701879a6264107bb757a952bcc65cc",
    "version": 1
}

...

Versions Compared

Old Version 2

New Version Current

Key