It's all about the answers!

Ask a question

Upload Assets to RPENG Document Builder


1
1
Alex Beckert (332) | asked Mar 28, 4:42 a.m.

I want to upload Document Builder Assets like templates, stylesheets and script (javascript) to the Document Builder by the REST API. Why we do not:

a) manually do this by the webfrontend? We have to sync SVN, Q-system and P-system putting the revision number into the report description for traceabiity reason. This is very time consuming and risky. (e.g forgott to change description with new revision number, ...)
b) do this by the RPE Studio (Publishing Document Studio)? This is only usefull to get assets from a server, change it and deploy it back to the same server but can not be deployed to other server. Additionally, without the usage of SVN no new revision gets created and traceablity gets lost.

Is there any API Documentation which such a POST or PUT commnd should look like to deploy assets to the Document Builder? Any help is appreciated.

2 answers



permanent link
Pierre Bentkowski (131517) | answered Aug 23, 5:02 p.m.
Do not think that currently exist.
I suggest creating an IBM Ideas: https://ideas.ibm.com/
Requesting a API to manage Doc Builder Asserts

Putting the link of your idea in a comment would allow others to vote.


permanent link
Suad Kajtazovic (2611) | answered Aug 25, 10:42 a.m.
edited Aug 25, 10:58 a.m.

There is an API, which is used by the Document Builder web client too. You can find a but outdated description of it at https://jazz.net/wiki/bin/view/Main/RPEAPIDocumentation.

However, I think the simplest way is to extract the API calls used by the Document Builder web client from your browser.

Here are some of them:

List avaiable reports:

method:GET
URI: https://[server:port]/rpeng/api/reports

Report details:
method:GET,
URI:https://[server:port]/rpeng/api/reports/{report_id}

 List available connections:
method: GET
URI: https://[server:port]/rpeng/api/connections

Connection details:
method: GET
URI: https://[server:port]/rpeng/api/connections/{connection_id}

List available jobs:
method: GET
URI: https://[server:port]/rpeng/api/jobs

Job details:
method: GET
URI: https://[server:port]/rpeng/api/jobs/{job_id}

Trigger a document generation with pre-set connections:
method: POST
URI: https://[server:port]/rpeng/api/jobs
Form params: 
'reporturl': 'https://[server:port]/rpeng/api/reports/{report_id}', 
'previewlimit': '0', 
'shared': 'false', 
'owners': '', 
'tags':'',
'parentFolderId':''
Headers:  
'Accept':'text/plain, /; q=0.01', 
'Content-Type':'application/x-www-form-urlencoded; charset=UTF-8', 
'Accept-Encoding': 'gzip, deflate, br', 
'x-com-ibm-team-pub':'0'

Your answer


Register or to post your answer.


Dashboards and work items are no longer publicly available, so some links may be invalid. We now provide similar information through other means. Learn more here.