SAP Connection Web Services

Owned by Former user (Deleted)
Last updated: Jan 25, 2023 by Stonebranch (Deactivated)
8 min read

Overview

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

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

Create an SAP Connection


Description

URI

http://host_name/uc/resources/sapconnection

HTTP Method

POST

Description

Creates an SAP Connection.

Example URI

http://localhost:8080/uc/resources/sapconnection

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.

Create an SAP Connection: Example Request

XML Request

JSON Request

 XML 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>
 JSON 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"
}

Delete an SAP Connection


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

http://localhost:8080/uc/resources/sapconnection?connectionname=Test4

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.

Delete an SAP Connection: URI Parameters

Parameter

Description

Specifications

Required

Mutually Exclusive With

connectionid

ID used within the Controller to identify this SAP Connection.

String; URI parameter.

Y
(unless connectionname
is specified)

connectionname

connectionname

Name used within the Controller to identify this SAP Connection.

String; URI parameter.

Y
(unless connectionid
is specified)

connectionid

List SAP Connections


Description

URI

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

HTTP Method

GET

Description

Retrieves information on all SAP Connections.

Example URI

http://localhost:8080/uc/resources/sapconnection/list

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 SAP Connection Properties.

List SAP Connections: Example Response

XML Response

JSON Response

 XML 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>
 JSON 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
    }
]

Modify an SAP Connection


Description

URI

http://host_name/uc/resources/sapconnection

HTTP Method

PUT

Description

Modifies the SAP Connection specified by the sysId.

Example URI

http://localhost:8080/uc/resources/sapconnection

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>.

Modify an SAP Connection: Example Request

XML Request

JSON Request

 XML 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>
 JSON 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"
}

Read an SAP Connection

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

http://localhost:8080/uc/resources/sapconnection?connectionname=Test4

Example Response

See Read an SAP Connection: Example Response, below.

SAP Connection Properties

See SAP Connection Properties.

Read an SAP Connection: URI Parameters

Parameter

Description

Specifications

Required

Mutually Exclusive With

connectionid

ID used within the Controller to identify this SAP Connection.

String; URI parameter.

Y
(unless connectionname
is specified)

connectionname

connectionname

Name used within the Controller to identify this SAP Connection.

String; URI parameter.

Y
(unless connectionid
is specified)

connectionid

Read an SAP Connection: Example Response

XML Response

JSON Response

 XML 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>
 JSON 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
}

SAP Connection Properties

Property

UI Field Name

Description

Specifications

Required

description

Description

Description of this record.


N

exportReleaseLevel

n/a

Universal Controller release that the record was exported from.

read onlyN

exportTable

n/aRecord table information.read onlyN

name

Connection Name

Name used within the Controller to identify this SAP Connection.


Y

opswiseGroups

Member of Business Services

Business Services that this record belongs to.
 
XML

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

 
JSON

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


N

retainSysIds

n/a

Specification for whether or not the Create an SAP 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

In XML web services, retainSysIds is specified as an attribute in the <sapConnection> element.

Valid values: true/false (default is true).

N

sapAshost

Application Server

If connectionType = Specific Application Server; Host name of an SAP application server. If the path to the server goes through SAP routers, prefix the host name with the SAP router string.


Y

sapClient

Client

If connectionType = Specific Application Server; SAP Client number.


Y

sapConnectionType

Connection Type

Type of SAP Connection.

Valid Values:

  • As String = Specific Application Server, As Value = 1
  • As String = Load Balancing, As Value = 2

Y

sapGroup

Group

If connectionType = Load Balancing; Host name of the message server.


N

sapGwhost

Gateway

If connectionType = Specific Application Server; Host name of the SAP gateway.


N

sapGwserv

Gateway Service

If connectionType = Specific Application Server; Service name of the SAP gateway.


N

sapMshost

Message Server

If connectionType = Load Balancing; Application servers group name.


Y

sapMysapsso2

Single Sign-On Ticket

Path to a file that contains the actual value for the MYSAPSSO2 parameter.


N

sapR3name

System ID

If connectionType = Load Balancing; System ID of the SAP system to which you want to connect.


Y

sapSaprouter

SAProuter

SAProuter parameter.


N

sapSncLib

SNC Library

SNC_LIB parameter; Path to the third-party security library for SNC.


N

sapSncMode

SNC Mode

SNC_MODE parameter; Specification for whether or not SNC is activated.

Valid Values:

  • As String = Off, As Value = 0
  • As String = On, As Value = 1

N

sapSncMyname

SNC My Name

SNC_MYNAME parameter; Token/identifier representing the external RFC program.


N

sapSncPartnername

SNC Partner Name

SNC_PARTNERNAME parameter; Token/identifier representing the back-end system.


N

sapSncQop

SNC Quality of Protection

SNC_QOP parameter.

Valid Values:

  • As String = Authentication Only, As Value = 1
  • As String = Integrity Protection, As Value = 2
  • As String = Privacy Protection, As Value = 3
  • As String = Default Protection, As Value = 8
  • As String = Maximum Protection, As Value = 9

N

sapSncSso

SNC Single Sign-On

SNC_SSO parameter; Specification for whether or not to use single sign-on for SNC.

Valid Values:

  • As String = No, As Value = 0
  • As String = Yes, As Value = 1

N

sapSysnr

System Number

If connectionType = Specific Application Server; SYSNR parameter.


Y

sapUseSymbolicNames

Use Symbolic Names

If connectionType = Load Balancing; USE_SYMBOLIC_NAMES parameter; Specification for whether or not to use symbolic service names.

Valid Values:

  • As String = Off, As Value = 0
  • As String = On, As Value = 1

N

sapX509cert

X.509 Certificate

Path to a file that contains the actual value for the X509CERT parameter.


Y

sysId

UUID

System ID field in the database for this SAP Connection record.

Persisted only if retainSysIds is set to true.

N