SAP Connection Web Services
Overview
Universal Controller supports the following RESTful-based web services for SAP Connection operations, which are listed alphabetically on this page.
- Create an SAP Connection
- Delete an SAP Connection
- List SAP Connections
- Modify an SAP Connection
- Read an SAP Connection
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 |
|
Consumes Content-Type |
application/xml, application/json |
Produces Content-Type |
n/a |
Example Request |
See Create an SAP Connection: Example Request, below. |
Example Response |
|
SAP Connection Properties |
See SAP Connection Properties, below. |
Create an SAP Connection: Example Request
XML Request |
JSON Request |
---|---|
|
|
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 |
|
Example Response |
|
Delete an SAP Connection: URI Parameters
Parameter |
Description |
Specifications |
Required |
Mutually Exclusive With |
---|---|---|---|---|
|
ID used within the Controller to identify this SAP Connection. |
String; URI parameter. |
Y |
|
|
Name used within the Controller to identify this SAP Connection. |
String; URI parameter. |
Y |
|
List SAP Connections
|
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 |
List SAP Connections: Example Response
XML Response |
JSON Response |
---|---|
|
|
Modify an SAP Connection
|
Description |
---|---|
URI |
http://host_name/uc/resources/sapconnection |
HTTP Method |
PUT |
Description |
Modifies the SAP Connection specified by the |
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 |
|
Modify an SAP Connection: Example Request
XML Request |
JSON Request |
---|---|
|
|
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 |
|
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 |
---|---|---|---|---|
|
ID used within the Controller to identify this SAP Connection. |
String; URI parameter. |
Y |
|
|
Name used within the Controller to identify this SAP Connection. |
String; URI parameter. |
Y |
|
Read an SAP Connection: Example Response
XML Response |
JSON Response |
---|---|
|
|
SAP Connection Properties
Property |
UI Field Name |
Description |
Specifications |
Required |
---|---|---|---|---|
|
Description |
Description of this record. |
|
N |
|
n/a |
Universal Controller release that the record was exported from. |
read only | N |
|
n/a | Record table information. | read only | N |
|
Connection Name |
Name used within the Controller to identify this SAP Connection. |
|
Y |
|
Member of Business Services |
Business Services that this record belongs to. <opswiseGroups> <opswiseGroup>group1</opswiseGroup> <opswiseGroup>group2</opswiseGroup> </opswiseGroups> "opswiseGroups": ["group1","group2"] |
|
N |
|
n/a |
Specification for whether or not the Create an SAP Connection web service will persist the
Note In XML web services, |
Valid values: true/false (default is true). |
N |
|
Application Server |
If |
|
Y |
|
Client |
If |
|
Y |
|
Connection Type |
Type of SAP Connection. |
Valid Values:
|
Y |
|
Group |
If |
|
N |
|
Gateway |
If |
|
N |
|
Gateway Service |
If |
|
N |
|
Message Server |
If |
|
Y |
|
Single Sign-On Ticket |
Path to a file that contains the actual value for the MYSAPSSO2 parameter. |
|
N |
|
System ID |
If |
|
Y |
|
SAProuter |
SAProuter parameter. |
|
N |
|
SNC Library |
SNC_LIB parameter; Path to the third-party security library for SNC. |
|
N |
|
SNC Mode |
SNC_MODE parameter; Specification for whether or not SNC is activated. |
Valid Values:
|
N |
|
SNC My Name |
SNC_MYNAME parameter; Token/identifier representing the external RFC program. |
|
N |
|
SNC Partner Name |
SNC_PARTNERNAME parameter; Token/identifier representing the back-end system. |
|
N |
|
SNC Quality of Protection |
SNC_QOP parameter. |
Valid Values:
|
N |
|
SNC Single Sign-On |
SNC_SSO parameter; Specification for whether or not to use single sign-on for SNC. |
Valid Values:
|
N |
|
System Number |
If |
|
Y |
|
Use Symbolic Names |
If |
Valid Values:
|
N |
|
X.509 Certificate |
Path to a file that contains the actual value for the X509CERT parameter. |
|
Y |
|
UUID |
System ID field in the database for this SAP Connection record. |
Persisted only if retainSysIds is set to true. |
N |