Versions Compared

Old Version 2

changes.mady.by.user IT Stonebranch

Saved on

compared with

New Version Current

changes.mady.by.user Stonebranch

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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 Database Connection Web Services#Database Connection Properties, below.

Anchor
Create a Database Connection Example Request
Create a Database Connection Example Request
Create a Database Connection: Example Request

...

<ul> <li> If <b>retainSysIds</b>
  • If retainSysIds="true"
  • and
<code>sysId</code>
  • sysId is
  • included
  • in
  • the
  • request
/response, <code>sysId</code> will be persisted to the database. <li> If <b>retainSysIds</b>
  • /response, sysId will be persisted to the database.
  • If retainSysIds="false"
and <code>sysId</code> is included in the
  • and sysId is included in the request/response,
<code>sysId</code>
  • sysId will
  • be
  • ignored;
  • it
  • will
  • be
  • autogenerated
  • by
  • the
  • Controller.
</ul>


Property

UI Field Name

Description

Specifications

Required

Anchor
credentials - Database
credentials - Database
credentials

Credentials

Credentials for this Database Connection.


N

Anchor
dbDescription - Database
dbDescription - Database
dbDescription

Description

Description of this record.


N

Anchor
dbDriver - Database
dbDriver - Database
dbDriver

Driver

Name of the JDBC driver.


Y

Anchor
dbMaxRows - Database
dbMaxRows - Database
dbMaxRows

Maximum Rows

If necessary, specifies a limit to the number of rows you want returned by the SQL statement.


N

Anchor
dbType - Database
dbType - Database
dbType

Database Type

Type of Database.

Valid Values:

html-bobswift

<ul> <li>


  • As
  • String
  • =
  • MySQL
  • (or
  • My
  • SQL),
  • As
  • Value
  • =
  • 1
<li>


  • As
  • String
  • =
  • MS
  • SQL
  • Server,
  • As
  • Value
  • =
  • 2
<li>


  • As
  • String
  • =
  • Oracle,
  • As
  • Value
  • =
  • 3
<li>


  • As
  • String
  • =
  • DB2,
  • As
  • Value
  • =
  • 4
<li>


  • As
  • String
  • =
  • Sybase
  • SQL
  • Anywhere,
  • As
  • Value
  • =
  • 5
<li>


  • As
  • String
  • =
  • Other,
  • As
  • Value
  • =
  • 6
</ul>


Default is MySQL (1).

Y

Anchor
dbUrl - Database
dbUrl - Database
dbUrl

Connection URL

URL of the database.


Y

Anchor
exportReleaseLevel - Database
exportReleaseLevel - Database
exportReleaseLevel

n/a

Universal Controller release that the record was exported from.

read onlyN

Anchor
exportTable - Database
exportTable - Database
exportTable

n/aRecord table information.read onlyN

Anchor
name - Database
name - Database
name

Connection Name

Name used within the Controller to identify this Database Connection.


Y

Anchor
opswiseGroups - Database
opswiseGroups - Database
opswiseGroups

Member of Business Services

Business Services that this record belongs to.
 
XML


<pre> &lt;opswiseGroups&gt; &lt;opswiseGroup&gt;group1&lt;/opswiseGroup&gt;
<opswiseGroups>
      <opswiseGroup>group1</opswiseGroup>
&lt;opswiseGroup&gt;group2&lt;/opswiseGroup&gt; &lt;/opswiseGroups&gt; </pre>
<opswiseGroup>group2</opswiseGroup>
</opswiseGroups>
Panel
Html bobswift


 
JSON


html-bobswift
Panel
<pre> 
"opswiseGroups": ["group1","group2"]
</pre>


N
 Anchor
retainSysIds - Database
retainSysIds - Database
retainSysIds
n/a
Specification for whether or not the Create a Database Connection web service will persist the sysId property.
 Html bobswift
 Note
titleNote
In XML web services, retainSysIds is specified as an attribute in the <databaseConnection> element.

Valid values: true/false (default is true).
N
 Anchor
sysId - Database
sysId - Database
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://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 Database Connection  Web Services#Database Connection  Properties.
 Anchor
List Database Connections Example Response
List Database Connections Example Response
List Database Connections: Example Response
...

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 Database  Connection Web Services#Database  Connection Properties.
Example Response
  • Status 200 /OK
    Successfully updated the Database Connection with sysId <sysId> to version <version>.
...
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
Read a Database Connection URI Parameters
Read a Database Connection URI Parameters
Read a Database Connection: URI Parameters
...