Installation (REST API for SAP Solution Manager)

Technical requirements

To use the REST API, you need SAP Solution Manager version 7.20 or higher. The Solution Manager must be accessible via HTTP or HTTPS to use the API.

Importing the add-on into SAP Solution Manager

The delivery package of the add-on consists of a ZIP archive with two transport requests and the file "ReadMe_EN.txt" which contains information about the request numbers (TRKORRs) and their contents. One of the requests contains the client-independent objects, the other one the client-dependent objects.

Transfer the data files and cofiles (two of each) into the corresponding transport directories and import them into the main client of the SAP Solution Manager (usually client 100) using transaction STMS. If the requests are not imported together (as a subset), make sure that the request with the client-independent objects is imported before the request with the client-dependent objects.

All delivered objects are located in the /GAL/ namespace and are organized in various packages. The client-specific customizing transport only contains contents for tables included in the transport with the client-independent objects. Neither SAP objects nor customizing settings are changed or overwritten during the import.

For more information on importing transport requests and transaction STMS, see the relevant documentation for SAP Solution Manager or Netweaver Application Server.

Activating the web service

After the import, the service that is now available must be activated. To do this, call transaction SICF and activate the service "/gal/solman/api/rest/1" via the context menu.

To be able to use the delivered endpoints, the corresponding service must be activated in the Solution Manager using transaction SICF. To do this, expand the nodes default_host/gal/solman/api/rest/1 and open the context menu on node "1" using the right mouse button. In the context menu, select the "Activate Service" entry.

Confirm the activation in the next popup by clicking the "Yes" button, where a hierarchy symbol is displayed on the left, to also activate all relevant parent services.

Proposal for authorization role of a communication user

The necessary authorizations result from the activities in Solution Manager that are to be controlled via the REST API. Below is an example proposal for an authorization role.

Authorization object	Description	Field	Description	Value
B_BUPA_RLT	Business Partner: BP Roles	ACTVT	Activity	02, 03
		RLTYP	BP Role	*
B_USERSTAT	Status Management: Set/Delete User Status	ACTVT	Activity	01, 06
		BERSL	Authorization key	*
		OBTYP	Object Category	‚ ‘, COH, COI
		STSMA	Status Profile	*
S_RFC_ADM	Administration for RFC Destination	ACTVT	Activity	03
		ICF_VALUE	Internet Communication Framework Values	*
		RFCDEST	Logical Destination	*
		RFCTYPE	Type of Entry	2, 3, G, H, I, Lm M, S, T, X
S_BTCH_JOB	Batch Processing: Operations on Background Jobs	JOBACTION	Job operations	LIST, PROT, RELE, SHO
		JOBGROUP	Summary of jobs for a group	*
S_GUI	Authorization for GUI activities	ACTVT	Activity	04, 60, 61
S_TABU_RFC	Client Comparison and Copy: Data Export with RFC	ACTVT	Activity	03
CRM_ACT	Authorization Object CRM Order – Business Object Activity	ACTVT	Activity	45
CRM_APPRVL	Authorization Object for Approval Process	ACTVT	Activity	01, 02, 03, 06
CRM_ORD_LP	Authorization Object CRM Order – Visibility in Org. Model	ACTVT	Activity	01, 02, 03
		CHECK_LEV	Scope	*
		PR_TYPE	Business Transaction Type	*
CRM_ORD_PR	Authorization OBject CRM Order – Business Transaction Type	ACTVT	Activity	01, 02, 03
		PR_TYPE	Business Transaction Type	*
CRM_TXT_ID	CRM: Text ID	ACTVT	Activity	02, 03
		TEXTID	Text ID	*
		TEXTOBJECT	Texts: application object	CRM_ORDERH
D_SOLMAN	SAP Solution Manager – Start	ACTVT	Activity	16
SM_CM_FUNC	Change Management: cycle dependent function Authorization	BRANCH_NM	Branch Name	*
		CM_ACTVT	Activity	*
		CYCLE_TYPE	Change-Cycle Type	*
		SUB_LAND	Solution Name	*
SM_FIELD	Authorization Object for UI object control	PR_TYPE	Business Transaction Type	*
		UI_OBJECT	Field Name	*
SM_SDK_ACT	Service Desk: allowed actions during message processing	SMSDACTION	Allowed actions	DSPR
SM_SDOC	Solution Documntation	ACTVT	Activity	03
		SBRA	Branch	*
		SLAN	Solution	*
		SMUDAREA	Authorization Area	DEFAULT
		SMUDAUTHGR	Authorization Group	DEFAULT
SM_PPF	Authorization to control the display of PPF actions	ACTVT	Activity	03
		SM_PPF	Name of Action Defintion	*