{"id":7759,"date":"2025-09-07T02:34:06","date_gmt":"2025-09-06T21:04:06","guid":{"rendered":"https:\/\/www.sapewmhelp.com\/?question=how-to-create-api-to-download-an-excel-sheet"},"modified":"2025-09-07T02:34:06","modified_gmt":"2025-09-06T21:04:06","slug":"how-to-create-api-to-download-an-excel-sheet","status":"publish","type":"question","link":"https:\/\/www.sapewmhelp.com\/?question=how-to-create-api-to-download-an-excel-sheet","title":{"rendered":"How to create API to download an Excel sheet"},"content":{"rendered":"

create a CDS view<\/p>\n

custom Entity:<\/p>\n

@EndUserText.label:<\/span> ‘template Download’<\/span><\/p>\n

@ObjectModel:<\/span> {<\/span><\/p>\n

query:<\/span> {<\/span><\/p>\n

implementedBy:<\/span> ‘ABAP: ZCL_DOWN_TEMPLATE’<\/span><\/p>\n

}<\/span><\/p>\n

}<\/span><\/p>\n

define<\/span> root<\/span> custom<\/span> entity<\/span> ZCHM__TMP_DWN<\/span><\/p>\n

{<\/span><\/p>\n

key<\/span> docnum<\/span> :<\/span> abap<\/span>.<\/span>char<\/span>(<\/span>10<\/span>);<\/span><\/p>\n

comp_code<\/span> :<\/span> abap<\/span>.<\/span>char<\/span>(<\/span>4<\/span>);<\/span><\/p>\n

sales_org<\/span> :<\/span> abap<\/span>.<\/span>char<\/span>(<\/span>4<\/span>);<\/span><\/p>\n

distr_chn<\/span> :<\/span> abap<\/span>.<\/span>char<\/span>(<\/span>2<\/span>);<\/span><\/p>\n

division<\/span> :<\/span> abap<\/span>.<\/span>char<\/span>(<\/span>2<\/span>);<\/span><\/p>\n

ref_doc<\/span> :<\/span> abap<\/span>.<\/span>char<\/span>(<\/span>20<\/span>);<\/span><\/p>\n

currency<\/span> :<\/span> abap<\/span>.<\/span>char<\/span>(<\/span>8<\/span>);<\/span><\/p>\n

ref_item<\/span> :<\/span> abap<\/span>.<\/span>char<\/span>(<\/span>10<\/span>);<\/span><\/p>\n

material<\/span> :<\/span> abap<\/span>.<\/span>char<\/span>(<\/span>40<\/span>);<\/span><\/p>\n

matl_group<\/span> :<\/span> abap<\/span>.<\/span>char<\/span>(<\/span>9<\/span>);<\/span><\/p>\n

net_amount<\/span> :<\/span> abap<\/span>.<\/span>char<\/span>(<\/span>40<\/span>);<\/span><\/p>\n

gross<\/span> :<\/span> abap<\/span>.<\/span>char<\/span>(<\/span>15<\/span>);<\/span><\/p>\n

quantity<\/span> :<\/span> abap<\/span>.<\/span>char<\/span>(<\/span>13<\/span>);<\/span><\/p>\n

price_unit<\/span> :<\/span> abap<\/span>.<\/span>char<\/span>(<\/span>5<\/span>);<\/span><\/p>\n

bill_unit<\/span> :<\/span> abap<\/span>.<\/span>char<\/span>(<\/span>3<\/span>);<\/span><\/p>\n

file_content<\/span> :<\/span> abap<\/span>.<\/span>string<\/span>(<\/span> 999999999<\/span> );<\/span><\/p>\n

}<\/span><\/p>\n

 <\/p>\n

then Create a Class where you can write you logic to create the template and pass the file content to the front end.<\/p>\n

 <\/p>\n

\n
\n

CLASS<\/span> <\/span>zcl_down_template<\/span> DEFINITION<\/span><\/p>\n

PUBLIC FINAL<\/span><\/p>\n

CREATE PUBLIC.<\/span><\/p>\n

PUBLIC SECTION.<\/span><\/p>\n

INTERFACES <\/span>if_rap_query_provider<\/span>.<\/span><\/p>\n

PRIVATE SECTION.<\/span><\/p>\n

TYPES: BEGIN OF <\/span>lty_template<\/span>,<\/span><\/p>\n

<\/span>docnum<\/span> TYPE <\/span>c<\/span> LENGTH <\/span>40<\/span>,<\/span><\/p>\n

<\/span>Process_type<\/span> TYPE <\/span>c<\/span> LENGTH <\/span>40<\/span>,<\/span><\/p>\n

<\/span>comp_code<\/span> TYPE <\/span>c<\/span> LENGTH <\/span>40<\/span>,<\/span><\/p>\n

<\/span>sales_org<\/span> TYPE <\/span>c<\/span> LENGTH <\/span>40<\/span>,<\/span><\/p>\n

<\/span>distr_chn<\/span> TYPE <\/span>c<\/span> LENGTH <\/span>40<\/span>,<\/span><\/p>\n

<\/span>division<\/span> TYPE <\/span>c<\/span> LENGTH <\/span>40<\/span>,<\/span><\/p>\n

<\/span>ref_doc<\/span> TYPE <\/span>c<\/span> LENGTH <\/span>40<\/span>,<\/span><\/p>\n

<\/span>currency<\/span> TYPE <\/span>c<\/span> LENGTH <\/span>40<\/span>,<\/span><\/span><\/p>\n

<\/span>material<\/span> TYPE <\/span>c<\/span> LENGTH <\/span>40<\/span>,<\/span><\/p>\n

<\/span>matl_group<\/span> TYPE <\/span>c<\/span> LENGTH <\/span>40<\/span>,<\/span><\/p>\n

<\/span>net_amount<\/span> TYPE <\/span>c<\/span> LENGTH <\/span>40<\/span>,<\/span><\/p>\n

<\/span>gross<\/span> TYPE <\/span>c<\/span> LENGTH <\/span>40<\/span>,<\/span><\/p>\n

<\/span>quantity<\/span> TYPE <\/span>c<\/span> LENGTH <\/span>40<\/span>,<\/span><\/p>\n

<\/span>price_unit<\/span> TYPE <\/span>c<\/span> LENGTH <\/span>40<\/span>,<\/span><\/p>\n

<\/span>bill_unit<\/span> TYPE <\/span>c<\/span> LENGTH <\/span>40<\/span>,<\/span><\/span><\/p>\n

END OF <\/span>lty_template<\/span>.<\/span><\/p>\n

DATA <\/span>et_result<\/span> TYPE TABLE OF <\/span>lty_template<\/span>.<\/span><\/p>\n

DATA <\/span>es_result<\/span> TYPE <\/span>lty_template<\/span>.<\/span><\/p>\n

DATA <\/span>et_res<\/span> TYPE TABLE OF z<\/span>tmp_dwn<\/span>.<\/span><\/p>\n

DATA <\/span>es_res<\/span> TYPE <\/span>ztmp_dwn<\/span>.<\/span><\/span><\/p>\n

ENDCLASS<\/span>.<\/span><\/p>\n

CLASS <\/span>zcl_down_template<\/span> IMPLEMENTATION.<\/span><\/p>\n

METHOD <\/span>if_rap_query_provider<\/span>~<\/span>select<\/span>.<\/span><\/p>\n

<\/span>” TODO: variable is assigned but never used (ABAP cleaner)<\/span><\/p>\n

DATA(<\/span>lr_skip<\/span>) = <\/span>io_request<\/span>-><\/span>get_paging<\/span>( )-><\/span>get_offset<\/span>( ).<\/span><\/p>\n

<\/span>” TODO: variable is assigned but never used (ABAP cleaner)<\/span><\/p>\n

DATA(<\/span>lr_top<\/span>) = <\/span>io_request<\/span>-><\/span>get_paging<\/span>( )-><\/span>get_page_size<\/span>( ).<\/span><\/p>\n

DATA <\/span>lv_index_root<\/span> TYPE <\/span>i<\/span> VALUE <\/span>1<\/span>.<\/span><\/p>\n

DATA <\/span>lo_document<\/span> TYPE REF TO <\/span>if_xco_xlsx_wa_document<\/span>.<\/span><\/p>\n

DATA <\/span>lo_sheet<\/span> TYPE REF TO <\/span>if_xco_xlsx_wa_worksheet<\/span>.<\/span><\/p>\n

DATA <\/span>lv_sheet_name<\/span> TYPE <\/span>string<\/span>.<\/span><\/p>\n

<\/span>lv_sheet_name<\/span> = |<\/span>Download_Template_<\/span>{ <\/span>cl_abap_context_info<\/span>=><\/span>get_system_date<\/span>( ) }|.<\/span><\/p>\n

<\/span>lo_document<\/span> = <\/span>xco_cp_xlsx<\/span>=><\/span>document<\/span>-><\/span>empty<\/span>( )-><\/span>write_access<\/span>( ).<\/span><\/p>\n

<\/span>lo_sheet<\/span> = <\/span>lo_document<\/span>-><\/span>get_workbook<\/span>( )-><\/span>worksheet<\/span>-><\/span>at_position<\/span>( <\/span>lv_index_root<\/span> ).<\/span><\/p>\n

<\/span>lo_sheet<\/span>-><\/span>set_name<\/span>( <\/span>iv_name<\/span> = <\/span>lv_sheet_name<\/span> ).<\/span><\/p>\n

<\/span>et_result<\/span> = VALUE #( <\/span>( <\/span>docnum<\/span> = <\/span>‘ID’<\/span> <\/span>Process_type<\/span> = <\/span>‘Template’<\/span> )<\/span><\/p>\n

( <\/span>docnum<\/span> = <\/span>‘DOCNUM’<\/span><\/p>\n

<\/span>Process_type<\/span> = <\/span>‘PAYTYPE’<\/span><\/p>\n

<\/span>comp_code<\/span> = <\/span>‘COMP_CODE’<\/span><\/p>\n

<\/span>sales_org<\/span> = <\/span>‘SALES_ORG’<\/span><\/p>\n

<\/span>distr_chn<\/span> = <\/span>‘DISTR_CHAN’<\/span><\/p>\n

<\/span>division<\/span> = <\/span>‘DIVISION’<\/span><\/p>\n

<\/span>ref_doc<\/span> = <\/span>‘REF_DOC’<\/span><\/p>\n

<\/span>currency<\/span> = <\/span>‘CURRENCY’<\/span><\/span><\/p>\n

<\/span>material<\/span> = <\/span>‘MATERIAL’<\/span><\/p>\n

<\/span>matl_group<\/span> = <\/span>‘MATL_GROUP’<\/span><\/p>\n

<\/span>net_amount<\/span> = <\/span>‘NET_AMOUNT’<\/span><\/p>\n

<\/span>gross<\/span> = <\/span>‘GROSS’<\/span><\/p>\n

<\/span>quantity<\/span> = <\/span>‘QUANTITY’<\/span><\/p>\n

<\/span>price_unit<\/span> = <\/span>‘PRICE_UNIT’<\/span><\/p>\n

<\/span>bill_unit<\/span> = <\/span>‘BILL_UNIT’<\/span>)<\/span><\/p>\n

( <\/span>docnum<\/span> = <\/span>‘*Document Number(10)’<\/span><\/p>\n

<\/span>Process_type<\/span> = <\/span>‘*Process Type(4)’<\/span><\/p>\n

<\/span>comp_code<\/span> = <\/span>‘*Company Code(4)’<\/span><\/p>\n

<\/span>sales_org<\/span> = <\/span>‘*Sales Organization(4)’<\/span><\/p>\n

<\/span>distr_chn<\/span> = <\/span>‘*Distribution Channel(2)’<\/span><\/p>\n

<\/span>division<\/span> = <\/span>‘*Division’<\/span><\/p>\n

<\/span>ref_doc<\/span> = <\/span>‘*Reference Document’<\/span><\/p>\n

<\/span>currency<\/span> = <\/span>‘*Currency’<\/span><\/span><\/p>\n

<\/span>ref_item<\/span> = <\/span>‘*Item No(10)’<\/span><\/p>\n

<\/span>material<\/span> = <\/span>‘*Material(40)’<\/span><\/p>\n

<\/span>matl_group<\/span> = <\/span>‘Material Group(9)’<\/span><\/p>\n

<\/span>net_amount<\/span> = <\/span>‘NetAmount(15)’<\/span><\/p>\n

<\/span>gross<\/span> = <\/span>‘Gross(15)’<\/span><\/p>\n

<\/span>quantity<\/span> = <\/span>‘Quantuity(13)’<\/span><\/p>\n

<\/span>price_unit<\/span> = <\/span>‘PriceUnit(5)’<\/span><\/p>\n

<\/span>bill_unit<\/span> = <\/span>‘BillUnit(3)’<\/span><\/span> ) ).<\/span><\/p>\n

 <\/p>\n

DATA(<\/span>lo_pattern<\/span>) = <\/span>xco_cp_xlsx_selection<\/span>=><\/span>pattern_builder<\/span>-><\/span>simple_from_to<\/span>( )-><\/span>get_pattern<\/span>( ).<\/span><\/p>\n

<\/span>lo_sheet<\/span>-><\/span>select<\/span>( <\/span>lo_pattern<\/span><\/p>\n

)-><\/span>row_stream<\/span>(<\/span><\/p>\n

)-><\/span>operation<\/span>-><\/span>write_from<\/span>( REF #( <\/span>et_result<\/span> )<\/span><\/p>\n

)-><\/span>execute<\/span>( ).<\/span><\/p>\n

DATA(<\/span>ld_excel<\/span>) = <\/span>lo_document<\/span>-><\/span>get_file_content<\/span>( ).<\/span><\/p>\n

DATA(<\/span>lv_base64_encoding<\/span>) = <\/span>xco_cp<\/span>=><\/span>xstring<\/span>( <\/span>ld_excel<\/span> )-><\/span>as_string<\/span>( <\/span>xco_cp_binary<\/span>=><\/span>text_encoding<\/span>-><\/span>base64<\/span> )-><\/span>value<\/span>.<\/span><\/p>\n

<\/span>es_res<\/span>–<\/span>file_content<\/span> = <\/span>lv_base64_encoding<\/span>.<\/span><\/p>\n

APPEND <\/span>es_res<\/span> TO <\/span>et_res<\/span>.<\/span><\/p>\n

IF <\/span>io_request<\/span>-><\/span>is_total_numb_of_rec_requested<\/span>( ).<\/span><\/p>\n

<\/span>io_response<\/span>-><\/span>set_total_number_of_records<\/span>( <\/span>lines<\/span>( <\/span>et_res<\/span> ) ).<\/span><\/p>\n

ENDIF.<\/span><\/p>\n

IF <\/span>io_request<\/span>-><\/span>is_data_requested<\/span>( ).<\/span><\/p>\n

<\/span>io_response<\/span>-><\/span>set_data<\/span>( <\/span>et_res<\/span> ).<\/span><\/p>\n

ENDIF.<\/span><\/p>\n

ENDMETHOD.<\/span><\/p>\n

ENDCLASS.<\/span><\/p>\n<\/div>\n<\/div>\n

 <\/p>\n

Now activate the class and expose it the service definition and at last create a web API v4 and pass the URL to the front person to fetch and download the excel sheet.<\/p>\n","protected":false},"author":3,"featured_media":0,"comment_status":"open","ping_status":"closed","template":"","question-category":[173],"question_tags":[178,201,199,200,177],"class_list":["post-7759","question","type-question","status-publish","hentry","question-category-cdsviews","question_tags-abap","question_tags-btp","question_tags-cds","question_tags-rap","question_tags-sap"],"_links":{"self":[{"href":"https:\/\/www.sapewmhelp.com\/index.php?rest_route=\/wp\/v2\/question\/7759","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.sapewmhelp.com\/index.php?rest_route=\/wp\/v2\/question"}],"about":[{"href":"https:\/\/www.sapewmhelp.com\/index.php?rest_route=\/wp\/v2\/types\/question"}],"author":[{"embeddable":true,"href":"https:\/\/www.sapewmhelp.com\/index.php?rest_route=\/wp\/v2\/users\/3"}],"replies":[{"embeddable":true,"href":"https:\/\/www.sapewmhelp.com\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=7759"}],"wp:attachment":[{"href":"https:\/\/www.sapewmhelp.com\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=7759"}],"wp:term":[{"taxonomy":"question-category","embeddable":true,"href":"https:\/\/www.sapewmhelp.com\/index.php?rest_route=%2Fwp%2Fv2%2Fquestion-category&post=7759"},{"taxonomy":"question_tags","embeddable":true,"href":"https:\/\/www.sapewmhelp.com\/index.php?rest_route=%2Fwp%2Fv2%2Fquestion_tags&post=7759"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}