Thu Aug 18, 2022 11:48 am
Login Register Lost Password? Contact Us

Please Note: The HPCC Systems forums are moving to Stack Overflow. We invite you to post your questions on Stack Overflow utilizing the tag hpcc-ecl ( This legacy forum will be active and monitored during our transition to Stack Overflow but will become read only beginning September 1, 2022.


Topics specific to the use of the ECL IDE

Mon Jan 20, 2014 6:34 pm Change Time Zone

Do you have an API for HPCC (and documents)? We have tools that historically talk directly to the system and would like to continue to function this way. Preferably a REST API.

thank you,
Posts: 2
Joined: Mon Jan 20, 2014 6:19 pm

Tue Jan 21, 2014 6:54 am Change Time Zone

Most of the client tools talk to the ESP layer via SOAP (and now JSON). There isn't an official API (well not documented as such), but its the same interface that can be called via ECL.

To get you you started take a look at:
This page will list the available Actions on the WsWorkunits Service. If you are using SOAP, you can get the WSDL from the top link on the page.

To open a test form for an Action simply open an URL similar to this:
(WUQuery will list all the workunits). You can now at least "play" with the API.

The next thing to know is that ESP will accept queries in many different formats (XML, JSON (GET, POST)) and will return the data in HTML, XML or JSON based on the request.

HTML Is basically the ECL Watch page associated with that Action.
XML can be requested by adding a "rawxml_=1" parameter to the call.
JSON can be requested by tweaking the target URL to: http://X.X.X.X:8010/WsWorkunits/WUQuery.json

So at a simple level if you want to get a list of all the WUs submittied to hthor as a JSON string you can just open this URL in your browser:
http://X.X.X.X:8010/WsWorkunits/WUQuery ... ster=hthor

Armed with this knowledge you can see how things like the ECL Playground work by simply monitoring the network traffic in chrome/IE.

I know this is only scratching the surface, but I hope it helps...
Posts: 291
Joined: Thu May 12, 2011 9:40 am

Return to ECL IDE

Who is online

Users browsing this forum: No registered users and 1 guest