4/25/24, 10:44 AM How to Download exported data file using API?

— Cloud Customer Connect

Interested in joining? Complete your registration by providing Areas of Interest here. Register

Cloud Customer Connect

Planning

Ask a question  Start typing

Back to Planning

How to Download exported data file using API?

Gayathri Nagubandi Senior Software Engineer Member

Jan 13, 2023 2:27PM 10 comments

Summary:

I need to down load file from EPBCS to my local computer using RestAPI

Content (required):

I have exported data using export Job and it is available in inbox/outbox folder and need to
download using REST API

Version (include the version you are using, if applicable):

Code Snippet (add any code snippets that support your topic, if applicable):
Tagged: PBCS, EPBCS

https://community.oracle.com/customerconnect/discussion/661280/how-to-download-exported-data-file-using-api 1/8
4/25/24, 10:44 AM How to Download exported data file using API? — Cloud Customer Connect

Flag Like

Answers

Stu G-Oracle Silver Crown

Jan 13, 2023 4:18PM

Have a look at this in the documentation and see if it helps....

REST API for Oracle Enterprise Performance Management Cloud

https://docs.oracle.com/en/cloud/saas/enterprise-performance-management-common/prest/down…
Downloads a file from the repository to the current directory in the local environment.

Regards

Stu

Flag 2 Like

Gayathri Nagubandi Senior Software Engineer Member

Jan 19, 2023 4:46PM

As per the document using the same URL to download the file but getting Authorization error.

I am having full access to the application.

Flag Like

Fred_Mamadjanov ES&A Consulting Associate Bronze Medal

Jan 19, 2023 4:55PM

Hi Gayathri,

https://community.oracle.com/customerconnect/discussion/661280/how-to-download-exported-data-file-using-api 2/8
4/25/24, 10:44 AM How to Download exported data file using API? — Cloud Customer Connect

qq: Do you have enabled the traditional sign-method for that user?

Thanks,

Fred

Flag Like

Gayathri Nagubandi Senior Software Engineer Member

Jan 20, 2023 10:09AM

Yes, enabled. Also tried with Admin id but getting same issue

Flag Like

Amith Consultant Bronze Crown

Jan 20, 2023 4:02PM

If you are looking to download the file using REST API, it will not be as regular file download .
where a download session starts and it keeps downloading until full file is downloaded,
through rest api it returns octet stream reference of data, which means, if it is txt or csv file it
shows content on browser from where you hit the download part, or through postman, if you
are using EPM Automate it takes care of downloading the file as it downloads the file in
chunks, and appends to main file to make it full file.

In short you cant download a file from EPM using groovy in EPM, but if you are using EPM
Automate from your local system or If you install Groovy on your local system and calling rest
api through groovy , then it should work.

Flag 1 Like

Reshu Gupta Business Analyst Red Ribbon

Jan 9, 2024 2:01PM

https://community.oracle.com/customerconnect/discussion/661280/how-to-download-exported-data-file-using-api 3/8
4/25/24, 10:44 AM How to Download exported data file using API? — Cloud Customer Connect

REST API.docx
Uploaded Jan 9, 2024 424.92 KB

I am trying to use Rest API for file "Download" functionality within the EPM application, I have
delved into the API as indicated below. I would like to share a few key observations and look for
help, as I am not seeing any response from REST API.

Please refer attached document for a more detailed issue understanding.

Flag Like

Amith Consultant Bronze Crown

Jan 9, 2024 5:08PM

It does not work with / you have to replace / with %5C escape character for EPM to interpret it
as a file under a folder, otherwise it thinks inbox/filename as a single word filename.

As an example for you i have created 2 files - 1. uploaded in standard inbox 2. uploaded in DM
inbox

https://community.oracle.com/customerconnect/discussion/661280/how-to-download-exported-data-file-using-api 4/8
4/25/24, 10:44 AM How to Download exported data file using API? — Cloud Customer Connect

You will see file in inbox is referred to as below to read the contents.

interop/rest/11.1.2.3.600/applicationsnapshots/inbox%5CSampleDownLoadFileDMInbox.txt
/contents

If you put / in payload you will see it as Not Found.

Hope this helps.

https://community.oracle.com/customerconnect/discussion/661280/how-to-download-exported-data-file-using-api 5/8
4/25/24, 10:44 AM How to Download exported data file using API? — Cloud Customer Connect

Flag 1 Like

NarayananS EPM Gold Medal

Jan 9, 2024 9:48PM edited Jan 9, 2024 9:56PM

Files in inbox/outbox can be accessed by GET calls and if it is directly under outbox then omit
'logs...log'

To download DM log file from Outbox (appname.log also works with single GET) as I see
inbox is already provided.

https://YourURL:443/interop/rest/v1/applicationsnapshots/outbox%5Clogs%5CXXXX.log/con
tents (where XXXX is the log file name)

https://YourURL:443/interop/rest/v1/applicationsnapshots/outbox%5Clogs%5CXXX.log/cont
ents/randomnumber (response of first GET, randomnumber will be returned from the call
itself and XXXX is the log file name)

https://YourURL:443/interop/rest/v1/applicationsnapshots/outbox%5Clogs%5CXXXX.log/con
tents/randomnumber/contents (response of second GET,randomnumber will be returned
from the call itself and XXXX is the log file name)

To download file as part of DM Data load rule (if filename is provided in options for
download)

https://YourURL/interop/rest/11.1.2.3.600/applicationsnapshots/filename.csv/contents

Flag Like

Reshu Gupta Business Analyst Red Ribbon

Jan 10, 2024 8:33PM

Thank you for your prompt reply. I have a question about downloading the file named
"07~OracleR12_Fixed_Assets.csv" from the DM folder- inbox/OracleR12_Fixed_Assets. I am
refering for document (REST API.docx) that I uploaded, but I don't see the "%5C" character in
the file name. Does the "~" character also cause any issues?

Please let me know if I am doing something wrong.

https://community.oracle.com/customerconnect/discussion/661280/how-to-download-exported-data-file-using-api 6/8
4/25/24, 10:44 AM How to Download exported data file using API? — Cloud Customer Connect

Let me know if i am missing something.

thanks

Flag Like

NarayananS EPM Gold Medal

Jan 10, 2024 9:26PM edited Jan 10, 2024 10:11PM

%5C is the interpretation for slash when using REST API in these cases. Just replace / with %5C
in your GET Calls

Flag Like

Leave a Comment

Type…

Save Draft Post Comment

English Español Français 日本語

https://community.oracle.com/customerconnect/discussion/661280/how-to-download-exported-data-file-using-api 7/8
4/25/24, 10:44 AM How to Download exported data file using API? — Cloud Customer Connect

© 2024 Oracle | Site Map Contact Us Privacy / Do Not Sell My Info

Community Integrity Policy Cookie Preferences Ad Choices Careers

https://community.oracle.com/customerconnect/discussion/661280/how-to-download-exported-data-file-using-api 8/8