An API marked as "deprecated" has been restructured and modified, with new classes and methods which provide similar functionality. Whenever possible, you should modify your application to remove references to deprecated methods and classes and use the new alternatives.

/kettle/addTrans (Deprecated)

Overview

Uploads and executes transformation configuration XML file.

POST

Uploads xml file containing transformation and transformation_execution_configuration (wrapped in transformation_configuration tag) to be executed and executes it. Method relies on the input parameter to determine if xml or html reply should be produced. The transformation_configuration xml is transferred within request body. transformation name of the executed transformation will be returned in the Response object or message describing error occurred. To determine if the call successful or not you should rely on result parameter in response.

/kettle/transImage

Overview

Generates PNG image of the specified transformation currently present on Carte server. Transformation name and Carte transformation ID (optional) are used for specifying which transformation to get information for. Response is a binary of the PNG image.

GET

Example Request:

GET /kettle/transImage?name=dummy-trans

POST

Content-Type: application/x-www-form-urlencoded should be set to use POST.

Example Request:

POST /kettle/transImage/
POST body
name=dummy-trans

Parameters

name

description

type

name

Name of the transformation to be used for image generation.

query

id

Carte id of the transformation to be used for image generation.

query, optional

Response Body

binary streak:

image

media types:

image/png

A binary PNG image or empty response is presented if no transformation is found.

Status Codes

code

description

200

Request was processed.

500

Internal server error occurs during request processing.

/kettle/executeTrans

Overview

Executes transformation from the specified repository. Connects to the repository provided as a parameter, loads the transformation from it, and executes it. Empty response is returned or response contains output of an error happened during the transformation execution. Response contains ERROR result if error happened during transformation execution.

All the other parameters will be sent to the transformation for using as variables. When necessary you can add custom parameters to the request. They will be used to set the transformation variables values..

query

Response Body

element:

(custom)

media types:

application/xml

Response contains error output of the transformation executed or nothing if the execution was successful.

Example Error Response:

<webresult>
<result>ERROR</result>
<message>Unexpected error executing the transformation:
org.pentaho.di.core.exception.KettleException:
Unable to find transformation 'dummy-trans.ktr' in directory
:/home/admin
at
org.pentaho.di.www.ExecuteTransServlet.loadTransformation(ExecuteTransServlet.java:214)
at org.pentaho.di.www.ExecuteTransServlet.doGet(ExecuteTransServlet.java:104)
at javax.servlet.http.HttpServlet.service(HttpServlet.java:707)
at javax.servlet.http.HttpServlet.service(HttpServlet.java:820)
at org.mortbay.jetty.servlet.ServletHolder.handle(ServletHolder.java:511)
at org.mortbay.jetty.servlet.ServletHandler.handle(ServletHandler.java:390)
at org.mortbay.jetty.servlet.SessionHandler.handle(SessionHandler.java:182)
at org.mortbay.jetty.handler.ContextHandler.handle(ContextHandler.java:765)
at org.mortbay.jetty.handler.ContextHandlerCollection.handle(ContextHandlerCollection.java:230)
at org.mortbay.jetty.handler.HandlerCollection.handle(HandlerCollection.java:114)
at org.mortbay.jetty.handler.HandlerWrapper.handle(HandlerWrapper.java:152)
at org.mortbay.jetty.Server.handle(Server.java:326)
at org.mortbay.jetty.HttpConnection.handleRequest(HttpConnection.java:536)
at org.mortbay.jetty.HttpConnection$RequestHandler.headerComplete(HttpConnection.java:915)
at org.mortbay.jetty.HttpParser.parseNext(HttpParser.java:539)
at org.mortbay.jetty.HttpParser.parseAvailable(HttpParser.java:212)
at org.mortbay.jetty.HttpConnection.handle(HttpConnection.java:405)
at org.mortbay.jetty.bio.SocketConnector$Connection.run(SocketConnector.java:228)
at org.mortbay.thread.QueuedThreadPool$PoolThread.run(QueuedThreadPool.java:582)
</message>
<id/>
</webresult>

Status Codes

/kettle/cleanupTrans

Overview

Method is used for cleaning previously uploaded transformation by its name on Carte server. There are two modes for this method: 1) Clean the server sockets only or 2) Clean everything, including the transformation.

GET

Example Request:

GET /kettle/cleanupTrans/?name=dummy-trans2&xml=Y

POST

Content-Type: application/x-www-form-urlencoded should be set to use POST.

Status Codes

/kettle/registerTrans

Overview

Uploads and executes transformation configuration XML file to the server.

POST

Uploads xml file containing transformation and transformation_execution_configuration (wrapped in transformation_configuration tag) to be executed and executes it. Method relies on the input parameter to determine if xml or html reply should be produced. The transformation_configuration xml is transferred within request body. transformation name of the executed transformation will be returned in the Response object or message describing error occurred. To determine if the call successful or not you should rely on result parameter in response.