Versions Compared

Key

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

...


Description

URI

http://host_name/uc/resources/sapconnection

HTTP Method

POST

Description

Creates an SAP Connection.

Example URI

Consumes Content-Type

application/xml, application/json

Produces Content-Type

n/a

Example Request

See Create an SAP Connection: Example Request, below.

Example Response

  • Status 200 /OK
    Successfully created the SAP Connection with sysId {sysId}.
  • Status 400 /Bad Request
    Create SAP Connection failed. A duplicate value has been detected. Name must be unique.

SAP Connection Properties

See SAP Connection Properties, below.

...

XML Request

JSON Request


Expand
titleXML Request


<sapConnection retainSysIds="true">
    <description>description</description>
    <name>SAP Connection 1</name>
    <opswiseGroups />
    <sapAshost />
    <sapClient />
    <sapConnectionType>Load Balancing</sapConnectionType>
    <sapGroup>groupa</sapGroup>
    <sapGwhost>ABC</sapGwhost>
    <sapGwserv>test</sapGwserv>
    <sapMshost>server</sapMshost>
    <sapMysapsso2>>D:\ellen\qa\uc\testdir\new.data</sapMysapsso2>
    <sapR3name>777</sapR3name>
    <sapSaprouter>/H/192.168.30.17/S/3297/H/155.56.59.11</sapSaprouter>
    <sapSncLib>/qa/durability_export</sapSncLib>
    <sapSncMode>Off </sapSncMode>
    <sapSncMyname>my_test_name</sapSncMyname>
    <sapSncPartnername>partnername</sapSncPartnername>
    <sapSncQop>Integrity Protection</sapSncQop>
    <sapSncSso>No</sapSncSso>
    <sapSysnr />
    <sapUseSymbolicNames>Yes</sapUseSymbolicNames>
    <sapX509cert>D:\ellen\qa\uc\testdir\ecu.txt</sapX509cert>
    <sysId>1c6a3b42f2704ae8b3f2b62cc5f867c9</sysId>
</sapConnection>



Expand
titleJSON Request


{
    "description": null,
    "name": "SAP Connection 1",
    "opswiseGroups": [],
    "retainSysIds": true,
    "sapAshost": null,
    "sapClient": null,
    "sapConnectionType": "Load Balancing",
    "sapGroup": "groupa",
    "sapGwhost": "ABC",
    "sapGwserv": "test",
    "sapMshost": "server",
    "sapMysapsso2": "D:\\ellen\\qa\\uc\\testdir\\new.data",
    "sapR3name": "777",
    "sapSaprouter": "/H/192.168.30.17/S/3297/H/155.56.59.11",
    "sapSncLib": "/qa/durability_export",
    "sapSncMode": "Off",
    "sapSncMyname": "my_test_name",
    "sapSncPartnername": "partnername",
    "sapSncQop": "Integrity Protection",
    "sapSncSso": "No",
    "sapSysnr": null,
    "sapUseSymbolicNames": "Yes",
    "sapX509cert": "D:\\ellen\\qa\\uc\\testdir\\ecu.txt",
    "sysId": "1c6a3b42f2704ae8b3f2b62cc5f867c9"
}


...


Description

URI

http://host_name/uc/resources/sapconnection

HTTP Method

DELETE

Description

Deletes an SAP Connection.

URI Parameters

See Delete an SAP Connection: URI Parameters, below.

Example URI

Example Response

  • Status 200 /OK
    SAP Connection deleted successfully.
  • Status 400 /Bad Request
    Mutual exclusion violation. Cannot specify connectionname and connectionid at the same time.
  • Status 404 /Not Found
    An SAP Connection with {name/id} "test" does not exist.

...


Description

URI

http://host_name/uc/resources/sapconnection/list

HTTP Method

GET

Description

Retrieves information on all SAP Connections.

Example URI

Authentication

HTTP Basic

Consumes Content-Type

n/a

Produces Content-Type

application/xml, application/json

Example Response

See List SAP Connections: Example Response, below.

SAP Connection Properties

See 12779556 SAP Connection Properties.

Anchor
List SAP Connections Example Response
List SAP Connections Example Response
List SAP Connections: Example Response

XML Response

JSON Response


Expand
titleXML Response


<sapConnections>
    <sapConnection exportReleaseLevel="7.2.0.0" exportTable="ops_sap_connection" version="7">
    <description>description</description>
    <name>SAP Connection 1</name>
    <opswiseGroups />
    <sapAshost />
    <sapClient />
    <sapConnectionType>Load Balancing</sapConnectionType>
    <sapGroup>groupa</sapGroup>
    <sapGwhost>ABC</sapGwhost>
    <sapGwserv>test</sapGwserv>
    <sapMshost>server</sapMshost>
    <sapMysapsso2>>D:\ellen\qa\uc\testdir\new.data</sapMysapsso2>
    <sapR3name>777</sapR3name>
    <sapSaprouter>/H/192.168.30.17/S/3297/H/155.56.59.11</sapSaprouter>
    <sapSncLib>/qa/durability_export</sapSncLib>
    <sapSncMode>Off </sapSncMode>
    <sapSncMyname>my_est_name</sapSncMyname>
    <sapSncPartnername>partnername</sapSncPartnername>
    <sapSncQop>Integrity Protection</sapSncQop>
    <sapSncSso>No</sapSncSso>
    <sapSysnr />
    <sapUseSymbolicNames>Yes</sapUseSymbolicNames>
    <sapX509cert>D:\ellen\qa\uc\testdir\ecu.txt</sapX509cert>
    <sysId>1c6a3b42f2704ae8b3f2b62cc5f867c9</sysId>
    </sapConnection>
    <sapConnection exportReleaseLevel="7.2.0.0" exportTable="ops_sap_connection" version="2">
    <description>description</description>
    <name>SAP Connection 1</name>
    <opswiseGroups />
    <sapAshost />
    <sapClient />
    <sapConnectionType>Load Balancing</sapConnectionType>
    <sapGroup>groupa</sapGroup>
    <sapGwhost>ABC</sapGwhost>
    <sapGwserv>test</sapGwserv>
    <sapMshost>server</sapMshost>
    <sapMysapsso2>>D:\ellen\qa\uc\testdir\new.data</sapMysapsso2>
    <sapR3name>777</sapR3name>
    <sapSaprouter>/H/192.168.30.17/S/3297/H/155.56.59.11</sapSaprouter>
    <sapSncLib>/qa/durability_export</sapSncLib>
    <sapSncMode>Off</sapSncMode>
    <sapSncMyname>my_test_name</sapSncMyname>
    <sapSncPartnername>partnername</sapSncPartnername>
    <sapSncQop>Integrity Protection</sapSncQop>
    <sapSncSso>No</sapSncSso>
    <sapSysnr />
    <sapUseSymbolicNames>Yes</sapUseSymbolicNames>
    <sapX509cert>D:\ellen\qa\uc\testdir\ecu.txt</sapX509cert>
    <sysId>3d7a03053ad64de1b21b6849e6deafd9</sysId>
    </sapConnection>
<sapConnections>



Expand
titleJSON Response


[ {
    "description": null,
"exportReleaseLevel": "7.2.0.0",
"exportTable": "ops_sap_connection", "name": "SAP Connection 1", "opswiseGroups": [], "retainSysIds": true, "sapAshost": null, "sapClient": null, "sapConnectionType": "Load Balancing", "sapGroup": "groupa", "sapGwhost": "ABC", "sapGwserv": "test", "sapMshost": "server", "sapMysapsso2": "D:\\ellen\\qa\\uc\\testdir\\new.data", "sapR3name": "777", "sapSaprouter": "/H/192.168.30.17/S/3297/H/155.56.59.11", "sapSncLib": "/qa/durability_export", "sapSncMode": "Off", "sapSncMyname": "my_test_name", "sapSncPartnername": "partnername", "sapSncQop": "Integrity Protection", "sapSncSso": "No", "sapSysnr": null, "sapUseSymbolicNames": "Yes", "sapX509cert": "D:\\ellen\\qa\\uc\\testdir\\ecu.txt", "sysId": "1c6a3b42f2704ae8b3f2b62cc5f867c9" "version": 7 }, { "description": null,
"exportReleaseLevel": "7.2.0.0",
"exportTable": "ops_sap_connection", "name": "SAP Connection 1", "opswiseGroups": [], "retainSysIds": true, "sapAshost": null, "sapClient": null, "sapConnectionType": "Load Balancing", "sapGroup": "groupa", "sapGwhost": "ABC", "sapGwserv": "test", "sapMshost": "server", "sapMysapsso2": "D:\\ellen\\qa\\uc\\testdir\\new.data", "sapR3name": "777", "sapSaprouter": "/H/192.168.30.17/S/3297/H/155.56.59.11", "sapSncLib": "/qa/durability_export", "sapSncMode": "Off", "sapSncMyname": "my_test_name", "sapSncPartnername": "partnername", "sapSncQop": "Integrity Protection", "sapSncSso": "No", "sapSysnr": null, "sapUseSymbolicNames": "Yes", "sapX509cert": "D:\\ellen\\qa\\uc\\testdir\\ecu.txt", "sysId": "3d7a03053ad64de1b21b6849e6deafd9" "version": 2 } ]


...


Description

URI

http://host_name/uc/resources/sapconnection

HTTP Method

PUT

Description

Modifies the SAP Connection specified by the sysId.

Example URI

Consumes Content-Type

application/xml, application/json

Produces Content-Type

n/a

Example Request

See Modify an SAP Connection: Example Request, below.

SAP Connection Properties

See SAP Connection Properties.

Example Response

  • Status 200 /OK
    Successfully updated the SAP Connection with sysId <sysId> to version <version>.

...

XML Request

JSON Request


Expand
titleXML Request


<sapConnection>
    <description>description</description>
    <name>SAP Connection 1</name>
    <opswiseGroups />
    <sapAshost />
    <sapClient />
    <sapConnectionType>Load Balancing</sapConnectionType>
    <sapGroup>groupa</sapGroup>
    <sapGwhost>ABC</sapGwhost>
    <sapGwserv>test</sapGwserv>
    <sapMshost>server</sapMshost>
    <sapMysapsso2>>D:\ellen\qa\uc\testdir\new.data</sapMysapsso2>
    <sapR3name>777</sapR3name>
    <sapSaprouter>/H/192.168.30.17/S/3297/H/155.56.59.11</sapSaprouter>
    <sapSncLib>/qa/durability_export</sapSncLib>
    <sapSncMode>Off </sapSncMode>
    <sapSncMyname>my_test_name</sapSncMyname>
    <sapSncPartnername>partnername</sapSncPartnername>
    <sapSncQop>Integrity Protection</sapSncQop>
    <sapSncSso>No</sapSncSso>
    <sapSysnr />
    <sapUseSymbolicNames>Yes</sapUseSymbolicNames>
    <sapX509cert>D:\ellen\qa\uc\testdir\ecu.txt</sapX509cert>
    <sysId>1c6a3b42f2704ae8b3f2b62cc5f867c9</sysId>
</sapConnection>



Expand
titleJSON Request


{
    "description": null,
    "name": "SAP Connection 1",
    "opswiseGroups": [],
    "retainSysIds": true,
    "sapAshost": null,
    "sapClient": null,
    "sapConnectionType": "Load Balancing",
    "sapGroup": "groupa",
    "sapGwhost": "ABC",
    "sapGwserv": "test",
    "sapMshost": "server",
    "sapMysapsso2": "D:\\ellen\\qa\\uc\\testdir\\new.data",
    "sapR3name": "777",
    "sapSaprouter": "/H/192.168.30.17/S/3297/H/155.56.59.11",
    "sapSncLib": "/qa/durability_export",
    "sapSncMode": "Off",
    "sapSncMyname": "my_test_name",
    "sapSncPartnername": "partnername",
    "sapSncQop": "Integrity Protection",
    "sapSncSso": "No",
    "sapSysnr": null,
    "sapUseSymbolicNames": "Yes",
    "sapX509cert": "D:\\ellen\\qa\\uc\\testdir\\ecu.txt",
    "sysId": "1c6a3b42f2704ae8b3f2b62cc5f867c9"
}


...

URI

http://host_name/uc/resources/sapconnection

HTTP Method

GET

Description

Retrieves information on a specific SAP Connection.

URI Parameters

See Read an SAP Connection: URI Parameters, below.

Example URI

Example Response

See Read an SAP Connection: Example Response, below.

SAP Connection Properties

See SAP Connection Properties.

...

XML Response

JSON Response


Expand
titleXML Response


<sapConnection exportReleaseLevel="7.2.0.0" exportTable="ops_sap_connection" retainSysIds="true" version="1">
    <description>description</description>
    <name>SAP Connection 1</name>
    <opswiseGroups />
    <sapAshost />
    <sapClient />
    <sapConnectionType>Load Balancing</sapConnectionType>
    <sapGroup>groupa</sapGroup>
    <sapGwhost>ABC</sapGwhost>
    <sapGwserv>test</sapGwserv>
    <sapMshost>server</sapMshost>
    <sapMysapsso2>>D:\ellen\qa\uc\testdir\new.data</sapMysapsso2>
    <sapR3name>777</sapR3name>
    <sapSaprouter>/H/192.168.30.17/S/3297/H/155.56.59.11</sapSaprouter>
    <sapSncLib>/qa/durability_export</sapSncLib>
    <sapSncMode>Off </sapSncMode>
    <sapSncMyname>my_test_name</sapSncMyname>
    <sapSncPartnername>partnername</sapSncPartnername>
    <sapSncQop>Integrity Protection</sapSncQop>
    <sapSncSso>No</sapSncSso>
    <sapSysnr />
    <sapUseSymbolicNames>Yes</sapUseSymbolicNames>
    <sapX509cert>D:\ellen\qa\uc\testdir\ecu.txt</sapX509cert>
    <sysId>1c6a3b42f2704ae8b3f2b62cc5f867c9</sysId>
</sapConnection>



Expand
titleJSON Response


{
    "description": null,
"exportReleaseLevel": "7.2.0.0",
"exportTable": "ops_sap_connection", "name": "SAP Connection 1", "opswiseGroups": [], "retainSysIds": true, "sapAshost": null, "sapClient": null, "sapConnectionType": "Load Balancing", "sapGroup": "groupa", "sapGwhost": "ABC", "sapGwserv": "test", "sapMshost": "server", "sapMysapsso2": "D:\\ellen\\qa\\uc\\testdir\\new.data", "sapR3name": "777", "sapSaprouter": "/H/192.168.30.17/S/3297/H/155.56.59.11", "sapSncLib": "/qa/durability_export", "sapSncMode": "Off", "sapSncMyname": "my_test_name", "sapSncPartnername": "partnername", "sapSncQop": "Integrity Protection", "sapSncSso": "No", "sapSysnr": null, "sapUseSymbolicNames": "Yes", "sapX509cert": "D:\\ellen\\qa\\uc\\testdir\\ecu.txt", "sysId": "1c6a3b42f2704ae8b3f2b62cc5f867c9" "version": 1 }


...