[go: up one dir, main page]
Scribd
Upload
264 views9 pages

Sicf Tutorial Part3

This document provides instructions for creating a RESTful API service using SAP's SICF (SAP Internet Communication Framework). The key steps include: 1. Creating data structures and table types to represent the request and response payloads. 2. Creating a ZIF_REST interface to define request handling and response methods. 3. Developing handler and request classes that retrieve data from SAP systems and return it in JSON format via the REST API. 4. Configuring a node in transaction SICF to expose the API and test the GET and POST methods.

Uploaded by

Daniel
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
264 views9 pages

Sicf Tutorial Part3

This document provides instructions for creating a RESTful API service using SAP's SICF (SAP Internet Communication Framework). The key steps include: 1. Creating data structures and table types to represent the request and response payloads. 2. Creating a ZIF_REST interface to define request handling and response methods. 3. Developing handler and request classes that retrieve data from SAP systems and return it in JSON format via the REST API. 4. Configuring a node in transaction SICF to expose the API and test the GET and POST methods.

Uploaded by

Daniel
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 9

04/07/23, 12:26 Writing a SICF service | SAP Blogs

F 3. Creating a Handler Class


ai 4. Creating the class for a GET Request
le
d 5. Creating the class for a POST Request
to
6. Creating a node in transaction SICF
lo
a 7. Testing the GET service
d
pl 8. Testing the POST service
u
gi 1.     Creating a structure and table type
n:
i Let’s create a structure for the entries we want to get later on.
m
a
g
e
fr
o
m
u
rl
ht
tp
s:
//  
bl
o Create a table type for that structure.
g
s.
s
a
p.
c
o
m
/
w
p
-
in  
cl
u
d
e
2.    Creating the ZIF_REST Interface.
s/
js To start off with, let’s create an interface in ‘SE24’ (if it doesn’t exist yet) which we
/ti will use for almost all classes in this guide. The interface consists of two methods,
n one for the request and one for the response.
y
m
c
e/
pl
u
gi
n
s/
i
m
a
g
e/  
pl
u
https://blogs.sap.com/2018/06/28/writing-a-sicf-service/ 2/18
04/07/23, 12:26 Writing a SICF service | SAP Blogs

Copy the following code to your method


‘IF_HTTP_EXTENSION~HANDLE_REQUEST’.

It will execute the ‘GET_REST’ method to get the class we want to execute to get
or process the data.

METHOD IF_HTTP_EXTENSION~HANDLE_REQUEST.

******************************************************************
" VARIABLES
******************************************************************
DATA: LO_REST_CLASS TYPE REF TO ZIF_REST.
DATA: LO_ERROR TYPE REF TO CX_ROOT.
DATA: LV_REASON TYPE STRING.

******************************************************************
" GET THE CLASS OBJECT
******************************************************************
TRY.

LO_REST_CLASS ?= GET_REST( IO_SERVER = SERVER ).

******************************************************************
" EXECUTE THE RETRIEVED CLASS
******************************************************************
LO_REST_CLASS->HANDLE_REQUEST( ).

******************************************************************
" ERROR
******************************************************************
CATCH CX_ROOT INTO LO_ERROR.

LV_REASON = LO_ERROR->GET_TEXT( ).
SERVER->RESPONSE->SET_STATUS( CODE = 500
REASON = LV_REASON ).

ENDTRY.

ENDMETHOD.​

https://blogs.sap.com/2018/06/28/writing-a-sicf-service/ 4/18
04/07/23, 12:26 Writing a SICF service | SAP Blogs

Your class will now have the first two methods below. Add two new methods:
‘GET_EQUIPMENTS’ and ‘CONSTRUCTOR’.

Add the following parameters to ‘GET_EQUIPMENTS’. This will pass the request
and return the equipments we will retrieve.

Add the following parameters to ‘CONSTRUCTOR’. This will instantiate the class
when called upon.

Open method ‘HANDLE_REQUEST’. This method will be executed from the


handler class (‘ZCL_REST_TEST’).

It will first get the equipments which will be converted to a JSON String. The
String will then be added as output of this method.

METHOD ZIF_REST~HANDLE_REQUEST.

******************************************************************

https://blogs.sap.com/2018/06/28/writing-a-sicf-service/ 6/18
04/07/23, 12:26 Writing a SICF service | SAP Blogs

Now open method ‘CONSTRUCTOR’ and add following code. This method will
instantiate the request and response when the class is called.

METHOD CONSTRUCTOR.

ME->ZIF_REST~RESPONSE = IO_RESPONSE.
ME->ZIF_REST~REQUEST = IO_REQUEST.

ENDMETHOD.

Now open method ‘GET_EQUIPMENTS’. This method will select an equipment


which number is equals to the header parameter.

METHOD GET_EQUIPMENTS.

******************************************************************
" VARIABLES
******************************************************************
DATA: LV_EQUI_NUMBER TYPE EQUNR.

******************************************************************
" GET HEADER PARAMETERS VALUE FROM URL
******************************************************************
LV_EQUI_NUMBER = ME->ZIF_REST~REQUEST->GET_FORM_FIELD('equnr').
UNPACK LV_EQUI_NUMBER TO LV_EQUI_NUMBER.

******************************************************************
" GET EQUIPMENTS SELECT
******************************************************************
SELECT EQUI~EQUNR, EQKT~EQKTX
FROM EQUI AS EQUI
LEFT OUTER JOIN EQKT AS EQKT ON EQKT~EQUNR EQ EQUI~EQUNR
INTO TABLE @ET_EQUIPMENTS
WHERE EQUI~EQUNR EQ @LV_EQUI_NUMBER
AND EQKT~SPRAS EQ 'E'.

ENDMETHOD.

5.    Creating the class for a POST Request


Go to ‘SE24’ and create a new class ‘ZCL_REST_TEST_POST’ and add interface
‘ZIF_REST’.

https://blogs.sap.com/2018/06/28/writing-a-sicf-service/ 8/18
04/07/23, 12:26 Writing a SICF service | SAP Blogs

DATA: LT_EQUIS TYPE TABLE OF TYPE_EQUI.

DATA: LR_DESERIALIZER TYPE REF TO CL_TREX_JSON_DESERIALIZER.


DATA: LV_JSON_BODY TYPE STRING.
DATA: LV_STRING_WRITER TYPE REF TO CL_SXML_STRING_WRITER.
DATA: LV_XSTRING TYPE XSTRING.

CREATE OBJECT LR_DESERIALIZER.

******************************************************************
" JSON TO ABAP DATA
******************************************************************
LV_JSON_BODY = ME->ZIF_REST~REQUEST->GET_CDATA( ).

LR_JSON_DESERIALIZER->DESERIALIZE(
EXPORTING
JSON = LV_JSON_BODY
IMPORTING
ABAP = LS_EQUI ).

APPEND LS_EQUI TO LT_EQUIS.

******************************************************************
" CREATE OBJECT
******************************************************************
"DO WHATEVER YOU NEED TO DO HERE WITH THE DATA !!!

******************************************************************
" CONVERT INPUT TO JSON STRING
******************************************************************
LV_STRING_WRITER = CL_SXML_STRING_WRITER=>CREATE( TYPE = IF_SXML=>C
CALL TRANSFORMATION ID SOURCE ARRAY = LT_EQUIS RESULT XML LV_STRING
LV_XSTRING = LV_STRING_WRITER->GET_OUTPUT( ).

******************************************************************
" RETURN CREATED OBJECT AS RESPONSE (CONVENTION)
******************************************************************
ME->ZIF_REST~RESPONSE->SET_DATA( DATA = LV_XSTRING ).

ENDMETHOD.

Now open method ‘SET_RESPONSE’ and add following code. This method will be
executed when ‘HANDLE_REQUEST’ has finished. It will return the data as a
String.

https://blogs.sap.com/2018/06/28/writing-a-sicf-service/ 10/18
04/07/23, 12:26 Writing a SICF service | SAP Blogs

Navigate to the ‘Hander List’ tab and add the handler we created
(‘ZCL_REST_TEST’).

Make sure you save the service properly.

Go back to the node list and right click the node you created and click ‘Activate
service’.

https://blogs.sap.com/2018/06/28/writing-a-sicf-service/ 12/18
04/07/23, 12:26 Writing a SICF service | SAP Blogs

You’ll get the posted object as result.

That’s all there is to it. Thank you for reading and if there is any feedback or
comments at all, you should definitely let me know since this is the first blog I’ve
ever written.

Alert Moderator

Assigned Tags

SAP NetWeaver

ABAP Development

NW ABAP Web Services

abap

netweaver

sap

Similar Blog Posts 


Creating a GOS attachment with SAPUI5
By Matthijs Mennens Jul 06, 2018

Creating a DMS attachment with SAPUI5


By Matthijs Mennens Jul 03, 2018

https://blogs.sap.com/2018/06/28/writing-a-sicf-service/ 14/18
04/07/23, 12:26 Writing a SICF service | SAP Blogs

Thanks for your feedback. I really appreciate it.

Like 0 | Reply | Alert Moderator | Share

Riaan Steenkamp
September 20, 2018 at 11:16 am

Thank you so much for this.

I've read dozens of posts and this is the only one that properly addresses this issue - You helped me when
no one else could.

Great post!

Like 0 | Reply | Alert Moderator | Share

Matthijs Mennens | Blog Post Author


September 27, 2018 at 9:33 am

You’re very welcome.

Thank you for your kind words.

Like 0 | Reply | Alert Moderator | Share

Sonia Trepanier
March 13, 2020 at 7:11 pm

Wow Great Post! And very well explained!

As mentioned by another, I've read many posts but this one was very clear and complete with what I
wanted to do!

Thank you so much!

Like 0 | Reply | Alert Moderator | Share

Rafael Martinez
September 21, 2021 at 9:40 am

https://blogs.sap.com/2018/06/28/writing-a-sicf-service/ 16/18
04/07/23, 12:26 Writing a SICF service | SAP Blogs

GEORGI KOZINAKOV
April 24, 2023 at 7:00 pm

Is there any free "sandbox" SAP server where we can try the SICF service (or other SAP services)?

Like 0 | Reply | Alert Moderator | Share

Add Comment

Find us on

Privacy Terms of Use

Legal Disclosure Copyright

Trademark Preferências de cookies

Newsletter Support

https://blogs.sap.com/2018/06/28/writing-a-sicf-service/ 18/18

You might also like