Versions Compared

Old Version 1

changes.mady.by.user Former user

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.

...

dbUrl

 
JSON

panel

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.

dbUrl - Database

Connection URL

URL of the database

Valid Values:Default is

  • As String = MySQL (
1).

Y

Anchor
dbUrl - Database
  • or My SQL), As Value = 1
  • As String = MS SQL Server, As Value = 2
  • As String = Oracle, As Value = 3
  • As String = DB2, As Value = 4
  • As String = Sybase SQL Anywhere, As Value = 5
  • As String = Other, As Value = 6


Default is MySQL (1).

Y

Anchor
name dbUrl - Databasename
dbUrl - Database
namedbUrl

Connection NameName used within the Controller to identify this Database ConnectionURL

URL of the database.


Y

Business Services that this record belongs to.
 
XML

Panel
Anchor
opswiseGroups exportReleaseLevel - DatabaseopswiseGroups
exportReleaseLevel - Database
opswiseGroups

Member of Business Services

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
retainSysIds name - DatabaseretainSysIds
name - Database
nameretainSysIds

n/a

Specification for whether or not the Create a Database Connection web service will persist the sysId property

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


Panel
<opswiseGroups>
      <opswiseGroup>group1</opswiseGroup>
      <opswiseGroup>group2</opswiseGroup>
</opswiseGroups>


 
JSON


Panel
"opswiseGroups": ["group1","group2"]



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.

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


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

...

XML Response

JSON Response


Expand
titleXML Response


<databaseConnections>  
    <databaseConnection   <databaseConnectionexportReleaseLevel="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
titleJSON Response


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

    "dbUrlexportTable": "jdbc:mysql://localhost:3306/ucops_database_connection",
    "name": "Database Connection 2",
    "opswiseGroups": null,
    "sysId": "3d7a03053ad64de1b21b6849e6deafd9",
    "version": 6
    }
]


...

Anchor
Read a Database Connection Example Response
Read a Database Connection Example Response
Read a Database Connection: Example Response

<databaseConnection

XML Response

JSON Response

Expand
titleXML Response

Response


Expand
titleXML 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
titleJSON 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
}


...