# Carte APIs Transformations
Provides web services to create, update, and delete transformations. Calls for getting images, statuses and starting, pausing, preparing, and stopping transformations are also included.
## Upload and execute transformation
> \*\*DEPRECATED\*\*: This endpoint is deprecated and may be removed in future versions.\
> \
> Uploads and executes transformation configuration XML file.\
> 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.\
> \
> \*\*Example Request:\*\*\
> \`\`\`\
> POST /kettle/addTrans/?xml=Y\
> \`\`\`\
> Request body should contain xml containing transformation\_configuration (transformation and\
> transformation\_execution\_configuration wrapped in transformation\_configuration tag).
````json
{"openapi":"3.0.3","info":{"title":"Pentaho Data Integration and Analytics","version":"0.0.1"},"tags":[{"name":"Carte APIs - Transformations","description":"Provides web services to create, update, and delete transformations. Calls for getting images, statuses and starting, pausing, preparing, and stopping transformations are also included."}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic","description":"HTTP Basic Authentication"}},"schemas":{"WebResult":{"type":"object","description":"Standard response format for most Carte operations","properties":{"result":{"type":"string","enum":["OK","ERROR"],"description":"Result status of the operation"},"message":{"type":"string","description":"Human readable message describing the result"},"id":{"type":"string","description":"Unique identifier for the created/modified resource"}},"xml":{"name":"webresult"}},"ErrorResponse":{"type":"object","description":"Error response format","properties":{"result":{"type":"string","enum":["ERROR"],"description":"Always ERROR for error responses"},"message":{"type":"string","description":"Error message describing what went wrong"},"exception":{"type":"string","description":"Exception details if available"}},"xml":{"name":"webresult"}}}},"paths":{"/kettle/addTrans":{"post":{"tags":["Carte APIs - Transformations"],"summary":"Upload and execute transformation","deprecated":true,"description":"**DEPRECATED**: This endpoint is deprecated and may be removed in future versions.\n\nUploads and executes transformation configuration XML file.\nUploads xml file containing transformation and transformation_execution_configuration\n(wrapped in transformation_configuration tag) to be executed and executes it. Method relies\non the input parameter to determine if xml or html reply should be produced. The transformation_configuration xml is\ntransferred within request body.\n\n**Example Request:**\n```\nPOST /kettle/addTrans/?xml=Y\n```\nRequest body should contain xml containing transformation_configuration (transformation and\ntransformation_execution_configuration wrapped in transformation_configuration tag).\n","parameters":[{"name":"xml","in":"query","description":"Boolean flag set to either Y or N describing if xml or html reply should be produced.","required":false,"schema":{"type":"string","enum":["Y","N"],"default":"N"}}],"requestBody":{"required":true,"description":"XML containing transformation_configuration (transformation and transformation_execution_configuration wrapped in transformation_configuration tag)","content":{"application/xml":{"schema":{"type":"string","description":"Transformation configuration XML"}}}},"responses":{"200":{"description":"Request was processed and XML response is returned","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/WebResult"}}}},"500":{"description":"Internal server error occurs during request processing","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
````
## Generate transformation image
> 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.\
> \
> \*\*Example Request:\*\*\
> \`\`\`\
> GET /kettle/transImage?name=dummy-trans\
> \`\`\`
````json
{"openapi":"3.0.3","info":{"title":"Pentaho Data Integration and Analytics","version":"0.0.1"},"tags":[{"name":"Carte APIs - Transformations","description":"Provides web services to create, update, and delete transformations. Calls for getting images, statuses and starting, pausing, preparing, and stopping transformations are also included."}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic","description":"HTTP Basic Authentication"}},"schemas":{"ErrorResponse":{"type":"object","description":"Error response format","properties":{"result":{"type":"string","enum":["ERROR"],"description":"Always ERROR for error responses"},"message":{"type":"string","description":"Error message describing what went wrong"},"exception":{"type":"string","description":"Exception details if available"}},"xml":{"name":"webresult"}}}},"paths":{"/kettle/transImage":{"get":{"tags":["Carte APIs - Transformations"],"summary":"Generate transformation image","description":"Generates PNG image of the specified transformation currently present on Carte server.\nTransformation name and Carte transformation ID (optional) are used for specifying which\ntransformation to get information for. Response is a binary of the PNG image.\n\n**Example Request:**\n```\nGET /kettle/transImage?name=dummy-trans\n```\n","parameters":[{"name":"name","in":"query","description":"Name of the transformation to be used for image generation.","required":true,"schema":{"type":"string"}},{"name":"id","in":"query","description":"Carte id of the transformation to be used for image generation.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Request was processed","content":{"image/png":{"schema":{"type":"string","format":"binary","description":"Binary PNG image"}}}},"500":{"description":"Internal server error occurs during request processing","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
````
## Get transformation status
> Retrieves status of the specified transformation. Status is returned as HTML or XML output\
> depending on the input parameters. Status contains information about last execution of the transformation.\
> \
> \*\*Example Request:\*\*\
> \`\`\`\
> GET /kettle/transStatus/?name=dummy-trans\&xml=Y\
> \`\`\`
````json
{"openapi":"3.0.3","info":{"title":"Pentaho Data Integration and Analytics","version":"0.0.1"},"tags":[{"name":"Carte APIs - Transformations","description":"Provides web services to create, update, and delete transformations. Calls for getting images, statuses and starting, pausing, preparing, and stopping transformations are also included."}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic","description":"HTTP Basic Authentication"}},"schemas":{"ErrorResponse":{"type":"object","description":"Error response format","properties":{"result":{"type":"string","enum":["ERROR"],"description":"Always ERROR for error responses"},"message":{"type":"string","description":"Error message describing what went wrong"},"exception":{"type":"string","description":"Exception details if available"}},"xml":{"name":"webresult"}}}},"paths":{"/kettle/transStatus":{"get":{"tags":["Carte APIs - Transformations"],"summary":"Get transformation status","description":"Retrieves status of the specified transformation. Status is returned as HTML or XML output\ndepending on the input parameters. Status contains information about last execution of the transformation.\n\n**Example Request:**\n```\nGET /kettle/transStatus/?name=dummy-trans&xml=Y\n```\n","parameters":[{"name":"name","in":"query","description":"Name of the transformation to be used for status generation.","required":true,"schema":{"type":"string"}},{"name":"xml","in":"query","description":"Boolean flag which defines output format Y forces XML output to be generated. HTML is returned otherwise.","required":false,"schema":{"type":"string","enum":["Y","N"],"default":"N"}},{"name":"id","in":"query","description":"Carte id of the transformation to be used for status generation.","required":false,"schema":{"type":"string"}},{"name":"from","in":"query","description":"Start line number of the execution log to be included into response.","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Request was processed","content":{"text/xml":{"schema":{"type":"string","description":"XML response containing transformation status details"}},"text/html":{"schema":{"type":"string","description":"HTML response containing transformation status details"}}}},"500":{"description":"Internal server error occurs during request processing","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
````
## Prepare transformation for execution
> Prepares previously loaded transformation for execution.\
> Method is used for preparing previously uploaded transformation for execution by its name.\
> \
> \*\*Example Request:\*\*\
> \`\`\`\
> GET /kettle/prepareExec/?name=dummy-trans2\&xml=Y\
> \`\`\`
````json
{"openapi":"3.0.3","info":{"title":"Pentaho Data Integration and Analytics","version":"0.0.1"},"tags":[{"name":"Carte APIs - Transformations","description":"Provides web services to create, update, and delete transformations. Calls for getting images, statuses and starting, pausing, preparing, and stopping transformations are also included."}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic","description":"HTTP Basic Authentication"}},"schemas":{"WebResult":{"type":"object","description":"Standard response format for most Carte operations","properties":{"result":{"type":"string","enum":["OK","ERROR"],"description":"Result status of the operation"},"message":{"type":"string","description":"Human readable message describing the result"},"id":{"type":"string","description":"Unique identifier for the created/modified resource"}},"xml":{"name":"webresult"}},"ErrorResponse":{"type":"object","description":"Error response format","properties":{"result":{"type":"string","enum":["ERROR"],"description":"Always ERROR for error responses"},"message":{"type":"string","description":"Error message describing what went wrong"},"exception":{"type":"string","description":"Exception details if available"}},"xml":{"name":"webresult"}}}},"paths":{"/kettle/prepareExec":{"get":{"tags":["Carte APIs - Transformations"],"summary":"Prepare transformation for execution","description":"Prepares previously loaded transformation for execution.\nMethod is used for preparing previously uploaded transformation for execution by its name.\n\n**Example Request:**\n```\nGET /kettle/prepareExec/?name=dummy-trans2&xml=Y\n```\n","parameters":[{"name":"name","in":"query","description":"Name of the transformation to be prepared for execution.","required":true,"schema":{"type":"string"}},{"name":"xml","in":"query","description":"Boolean flag which sets the output format required. Use Y to receive XML response.","required":true,"schema":{"type":"string","enum":["Y","N"]}},{"name":"id","in":"query","description":"Carte transformation ID of the transformation to be prepared for execution.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Request was processed","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/WebResult"}},"text/html":{"schema":{"type":"string","description":"HTML response containing operation result"}}}},"500":{"description":"Internal server error occurs during request processing","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
````
## Start transformation execution
> Starts transformation. If the transformation is not ready, an error is returned.\
> \
> \*\*Example Request:\*\*\
> \`\`\`\
> GET /kettle/startExec/?name=dummy-trans\&xml=Y\
> \`\`\`
````json
{"openapi":"3.0.3","info":{"title":"Pentaho Data Integration and Analytics","version":"0.0.1"},"tags":[{"name":"Carte APIs - Transformations","description":"Provides web services to create, update, and delete transformations. Calls for getting images, statuses and starting, pausing, preparing, and stopping transformations are also included."}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic","description":"HTTP Basic Authentication"}},"schemas":{"WebResult":{"type":"object","description":"Standard response format for most Carte operations","properties":{"result":{"type":"string","enum":["OK","ERROR"],"description":"Result status of the operation"},"message":{"type":"string","description":"Human readable message describing the result"},"id":{"type":"string","description":"Unique identifier for the created/modified resource"}},"xml":{"name":"webresult"}},"ErrorResponse":{"type":"object","description":"Error response format","properties":{"result":{"type":"string","enum":["ERROR"],"description":"Always ERROR for error responses"},"message":{"type":"string","description":"Error message describing what went wrong"},"exception":{"type":"string","description":"Exception details if available"}},"xml":{"name":"webresult"}}}},"paths":{"/kettle/startExec":{"get":{"tags":["Carte APIs - Transformations"],"summary":"Start transformation execution","description":"Starts transformation. If the transformation is not ready, an error is returned.\n\n**Example Request:**\n```\nGET /kettle/startExec/?name=dummy-trans&xml=Y\n```\n","parameters":[{"name":"name","in":"query","description":"Name of the transformation to be executed.","required":true,"schema":{"type":"string"}},{"name":"xml","in":"query","description":"Boolean flag which sets the output format required. Use Y to receive XML response.","required":false,"schema":{"type":"string","enum":["Y","N"],"default":"N"}},{"name":"id","in":"query","description":"Carte transformation ID of the transformation to be executed. This parameter is optional when xml=Y is used.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Request was processed","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/WebResult"}},"text/html":{"schema":{"type":"string","description":"HTML response containing operation result"}}}},"500":{"description":"Internal server error occurs during request processing","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
````
## Execute transformation
> Executes transformation previously uploaded to Carte server.\
> \
> \*\*Example Request:\*\*\
> \`\`\`\
> GET /kettle/startTrans/?name=dummy-trans\&xml=Y\
> \`\`\`
````json
{"openapi":"3.0.3","info":{"title":"Pentaho Data Integration and Analytics","version":"0.0.1"},"tags":[{"name":"Carte APIs - Transformations","description":"Provides web services to create, update, and delete transformations. Calls for getting images, statuses and starting, pausing, preparing, and stopping transformations are also included."}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic","description":"HTTP Basic Authentication"}},"schemas":{"WebResult":{"type":"object","description":"Standard response format for most Carte operations","properties":{"result":{"type":"string","enum":["OK","ERROR"],"description":"Result status of the operation"},"message":{"type":"string","description":"Human readable message describing the result"},"id":{"type":"string","description":"Unique identifier for the created/modified resource"}},"xml":{"name":"webresult"}},"ErrorResponse":{"type":"object","description":"Error response format","properties":{"result":{"type":"string","enum":["ERROR"],"description":"Always ERROR for error responses"},"message":{"type":"string","description":"Error message describing what went wrong"},"exception":{"type":"string","description":"Exception details if available"}},"xml":{"name":"webresult"}}}},"paths":{"/kettle/startTrans":{"get":{"tags":["Carte APIs - Transformations"],"summary":"Execute transformation","description":"Executes transformation previously uploaded to Carte server.\n\n**Example Request:**\n```\nGET /kettle/startTrans/?name=dummy-trans&xml=Y\n```\n","parameters":[{"name":"name","in":"query","description":"Name of the transformation to be executed.","required":true,"schema":{"type":"string"}},{"name":"xml","in":"query","description":"Boolean flag which sets the output format required. Use Y to receive XML response.","required":false,"schema":{"type":"string","enum":["Y","N"],"default":"N"}},{"name":"id","in":"query","description":"Carte transformation ID of the transformation to be executed. This parameter is optional when xml=Y is used.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Request was processed","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/WebResult"}},"text/html":{"schema":{"type":"string","description":"HTML response containing operation result"}}}},"500":{"description":"Internal server error occurs during request processing","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
````
## Execute transformation from repository
> Execute transformation from enterprise repository. Repository should be configured in Carte xml file.\
> Response contains ERROR result if error happened during transformation execution.\
> \
> \*\*Example Request:\*\*\
> \`\`\`\
> GET /kettle/runTrans?trans=home%2Fadmin%2Fdummy-trans\&level=Debug\
> \`\`\`
````json
{"openapi":"3.0.3","info":{"title":"Pentaho Data Integration and Analytics","version":"0.0.1"},"tags":[{"name":"Carte APIs - Transformations","description":"Provides web services to create, update, and delete transformations. Calls for getting images, statuses and starting, pausing, preparing, and stopping transformations are also included."}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic","description":"HTTP Basic Authentication"}},"schemas":{"WebResult":{"type":"object","description":"Standard response format for most Carte operations","properties":{"result":{"type":"string","enum":["OK","ERROR"],"description":"Result status of the operation"},"message":{"type":"string","description":"Human readable message describing the result"},"id":{"type":"string","description":"Unique identifier for the created/modified resource"}},"xml":{"name":"webresult"}},"ErrorResponse":{"type":"object","description":"Error response format","properties":{"result":{"type":"string","enum":["ERROR"],"description":"Always ERROR for error responses"},"message":{"type":"string","description":"Error message describing what went wrong"},"exception":{"type":"string","description":"Exception details if available"}},"xml":{"name":"webresult"}}}},"paths":{"/kettle/runTrans":{"get":{"tags":["Carte APIs - Transformations"],"summary":"Execute transformation from repository","description":"Execute transformation from enterprise repository. Repository should be configured in Carte xml file.\nResponse contains ERROR result if error happened during transformation execution.\n\n**Example Request:**\n```\nGET /kettle/runTrans?trans=home%2Fadmin%2Fdummy-trans&level=Debug\n```\n","parameters":[{"name":"trans","in":"query","description":"Full path to the transformation in repository.","required":true,"schema":{"type":"string"}},{"name":"level","in":"query","description":"Logging level to be used for transformation execution (i.e. Debug).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Request was processed","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/WebResult"}},"text/html":{"schema":{"type":"string","description":"HTML response containing operation result"}}}},"500":{"description":"Internal server error occurs during request processing","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
````
## Execute transformation from repository
> 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.\
> \
> \*\*Example Request:\*\*\
> \`\`\`\
> GET /kettle/executeTrans/?rep=my\_repository\&user=my\_user\&pass=my\_password\&trans=my\_trans\&level=INFO\
> \`\`\`
````json
{"openapi":"3.0.3","info":{"title":"Pentaho Data Integration and Analytics","version":"0.0.1"},"tags":[{"name":"Carte APIs - Transformations","description":"Provides web services to create, update, and delete transformations. Calls for getting images, statuses and starting, pausing, preparing, and stopping transformations are also included."}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic","description":"HTTP Basic Authentication"}},"schemas":{"WebResult":{"type":"object","description":"Standard response format for most Carte operations","properties":{"result":{"type":"string","enum":["OK","ERROR"],"description":"Result status of the operation"},"message":{"type":"string","description":"Human readable message describing the result"},"id":{"type":"string","description":"Unique identifier for the created/modified resource"}},"xml":{"name":"webresult"}},"ErrorResponse":{"type":"object","description":"Error response format","properties":{"result":{"type":"string","enum":["ERROR"],"description":"Always ERROR for error responses"},"message":{"type":"string","description":"Error message describing what went wrong"},"exception":{"type":"string","description":"Exception details if available"}},"xml":{"name":"webresult"}}}},"paths":{"/kettle/executeTrans":{"get":{"tags":["Carte APIs - Transformations"],"summary":"Execute transformation from repository","description":"Executes transformation from the specified repository.\nConnects to the repository provided as a parameter, loads the transformation from it and executes it.\nEmpty response is returned or response contains output of an error happened during the transformation execution.\nResponse contains ERROR result if error happened during transformation execution.\n\n**Example Request:**\n```\nGET /kettle/executeTrans/?rep=my_repository&user=my_user&pass=my_password&trans=my_trans&level=INFO\n```\n","parameters":[{"name":"rep","in":"query","description":"Repository id to connect to.","required":true,"schema":{"type":"string"}},{"name":"user","in":"query","description":"User name to be used to connect to repository.","required":true,"schema":{"type":"string"}},{"name":"pass","in":"query","description":"User password to be used to connect to repository.","required":true,"schema":{"type":"string"}},{"name":"trans","in":"query","description":"Transformation name to be loaded and executed.","required":true,"schema":{"type":"string"}},{"name":"level","in":"query","description":"Logging level to be used for transformation execution.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Request was processed","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/WebResult"}},"text/html":{"schema":{"type":"string","description":"HTML response containing operation result"}}}},"500":{"description":"Internal server error occurs during request processing","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
````
## Pause transformation
> Pauses transformation to be executed.\
> Method is used for pausing running transformation by its name.\
> \
> \*\*Example Request:\*\*\
> \`\`\`\
> GET /kettle/pauseTrans/?name=dummy-trans\&xml=Y\
> \`\`\`
````json
{"openapi":"3.0.3","info":{"title":"Pentaho Data Integration and Analytics","version":"0.0.1"},"tags":[{"name":"Carte APIs - Transformations","description":"Provides web services to create, update, and delete transformations. Calls for getting images, statuses and starting, pausing, preparing, and stopping transformations are also included."}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic","description":"HTTP Basic Authentication"}},"schemas":{"WebResult":{"type":"object","description":"Standard response format for most Carte operations","properties":{"result":{"type":"string","enum":["OK","ERROR"],"description":"Result status of the operation"},"message":{"type":"string","description":"Human readable message describing the result"},"id":{"type":"string","description":"Unique identifier for the created/modified resource"}},"xml":{"name":"webresult"}},"ErrorResponse":{"type":"object","description":"Error response format","properties":{"result":{"type":"string","enum":["ERROR"],"description":"Always ERROR for error responses"},"message":{"type":"string","description":"Error message describing what went wrong"},"exception":{"type":"string","description":"Exception details if available"}},"xml":{"name":"webresult"}}}},"paths":{"/kettle/pauseTrans":{"get":{"tags":["Carte APIs - Transformations"],"summary":"Pause transformation","description":"Pauses transformation to be executed.\nMethod is used for pausing running transformation by its name.\n\n**Example Request:**\n```\nGET /kettle/pauseTrans/?name=dummy-trans&xml=Y\n```\n","parameters":[{"name":"name","in":"query","description":"Name of the transformation to be paused.","required":true,"schema":{"type":"string"}},{"name":"xml","in":"query","description":"Boolean flag which sets the output format required. Use Y to receive XML response.","required":false,"schema":{"type":"string","enum":["Y","N"],"default":"N"}},{"name":"id","in":"query","description":"Carte transformation ID of the transformation to be paused. This parameter is optional when xml=Y is used.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Request was processed","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/WebResult"}},"text/html":{"schema":{"type":"string","description":"HTML response containing operation result"}}}},"500":{"description":"Internal server error occurs during request processing","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
````
## Stop transformation
> Stops transformation execution on Carte server.\
> \
> \*\*Example Request:\*\*\
> \`\`\`\
> GET /kettle/stopTrans/?name=dummy-trans\&xml=Y\
> \`\`\`
````json
{"openapi":"3.0.3","info":{"title":"Pentaho Data Integration and Analytics","version":"0.0.1"},"tags":[{"name":"Carte APIs - Transformations","description":"Provides web services to create, update, and delete transformations. Calls for getting images, statuses and starting, pausing, preparing, and stopping transformations are also included."}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic","description":"HTTP Basic Authentication"}},"schemas":{"WebResult":{"type":"object","description":"Standard response format for most Carte operations","properties":{"result":{"type":"string","enum":["OK","ERROR"],"description":"Result status of the operation"},"message":{"type":"string","description":"Human readable message describing the result"},"id":{"type":"string","description":"Unique identifier for the created/modified resource"}},"xml":{"name":"webresult"}},"ErrorResponse":{"type":"object","description":"Error response format","properties":{"result":{"type":"string","enum":["ERROR"],"description":"Always ERROR for error responses"},"message":{"type":"string","description":"Error message describing what went wrong"},"exception":{"type":"string","description":"Exception details if available"}},"xml":{"name":"webresult"}}}},"paths":{"/kettle/stopTrans":{"get":{"tags":["Carte APIs - Transformations"],"summary":"Stop transformation","description":"Stops transformation execution on Carte server.\n\n**Example Request:**\n```\nGET /kettle/stopTrans/?name=dummy-trans&xml=Y\n```\n","parameters":[{"name":"name","in":"query","description":"Name of the transformation to be stopped.","required":true,"schema":{"type":"string"}},{"name":"xml","in":"query","description":"Boolean flag which sets the output format required. Use Y to receive XML response.","required":false,"schema":{"type":"string","enum":["Y","N"],"default":"N"}},{"name":"id","in":"query","description":"Carte transformation ID of the transformation to be stopped. This parameter is optional when xml=Y is used.","required":false,"schema":{"type":"string"}},{"name":"inputOnly","in":"query","description":"Boolean flag indicates which steps to stop. Use Y to Stop input processing","required":false,"schema":{"type":"string","enum":["Y","N"]}}],"responses":{"200":{"description":"Request was processed","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/WebResult"}},"text/html":{"schema":{"type":"string","description":"HTML response containing operation result"}}}},"500":{"description":"Internal server error occurs during request processing","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
````
## Remove transformation
> Removes specified transformation from Carte server.\
> \
> \*\*Example Request:\*\*\
> \`\`\`\
> GET /kettle/removeTrans/?name=dummy-trans\&xml=Y\
> \`\`\`
````json
{"openapi":"3.0.3","info":{"title":"Pentaho Data Integration and Analytics","version":"0.0.1"},"tags":[{"name":"Carte APIs - Transformations","description":"Provides web services to create, update, and delete transformations. Calls for getting images, statuses and starting, pausing, preparing, and stopping transformations are also included."}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic","description":"HTTP Basic Authentication"}},"schemas":{"WebResult":{"type":"object","description":"Standard response format for most Carte operations","properties":{"result":{"type":"string","enum":["OK","ERROR"],"description":"Result status of the operation"},"message":{"type":"string","description":"Human readable message describing the result"},"id":{"type":"string","description":"Unique identifier for the created/modified resource"}},"xml":{"name":"webresult"}},"ErrorResponse":{"type":"object","description":"Error response format","properties":{"result":{"type":"string","enum":["ERROR"],"description":"Always ERROR for error responses"},"message":{"type":"string","description":"Error message describing what went wrong"},"exception":{"type":"string","description":"Exception details if available"}},"xml":{"name":"webresult"}}}},"paths":{"/kettle/removeTrans":{"get":{"tags":["Carte APIs - Transformations"],"summary":"Remove transformation","description":"Removes specified transformation from Carte server.\n\n**Example Request:**\n```\nGET /kettle/removeTrans/?name=dummy-trans&xml=Y\n```\n","parameters":[{"name":"name","in":"query","description":"Name of the transformation to be removed.","required":true,"schema":{"type":"string"}},{"name":"xml","in":"query","description":"Boolean flag which sets the output format required. Use Y to receive XML response.","required":false,"schema":{"type":"string","enum":["Y","N"],"default":"N"}},{"name":"id","in":"query","description":"Carte transformation ID of the transformation to be removed. This parameter is optional when xml=Y is used.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Request was processed","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/WebResult"}},"text/html":{"schema":{"type":"string","description":"HTML response containing operation result"}}}},"500":{"description":"Internal server error occurs during request processing","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
````
## Clean up transformation
> Cleans up transformation on Carte server.\
> 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.\
> \
> \*\*Example Request:\*\*\
> \`\`\`\
> GET /kettle/cleanupTrans/?name=dummy-trans2\&xml=Y\
> \`\`\`
````json
{"openapi":"3.0.3","info":{"title":"Pentaho Data Integration and Analytics","version":"0.0.1"},"tags":[{"name":"Carte APIs - Transformations","description":"Provides web services to create, update, and delete transformations. Calls for getting images, statuses and starting, pausing, preparing, and stopping transformations are also included."}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic","description":"HTTP Basic Authentication"}},"schemas":{"WebResult":{"type":"object","description":"Standard response format for most Carte operations","properties":{"result":{"type":"string","enum":["OK","ERROR"],"description":"Result status of the operation"},"message":{"type":"string","description":"Human readable message describing the result"},"id":{"type":"string","description":"Unique identifier for the created/modified resource"}},"xml":{"name":"webresult"}},"ErrorResponse":{"type":"object","description":"Error response format","properties":{"result":{"type":"string","enum":["ERROR"],"description":"Always ERROR for error responses"},"message":{"type":"string","description":"Error message describing what went wrong"},"exception":{"type":"string","description":"Exception details if available"}},"xml":{"name":"webresult"}}}},"paths":{"/kettle/cleanupTrans":{"get":{"tags":["Carte APIs - Transformations"],"summary":"Clean up transformation","description":"Cleans up transformation on Carte server.\nMethod is used for cleaning previously uploaded transformation by its name on Carte server. There are\ntwo modes for this method: 1) Clean the server sockets only or 2) Clean everything, including the transformation.\n\n**Example Request:**\n```\nGET /kettle/cleanupTrans/?name=dummy-trans2&xml=Y\n```\n","parameters":[{"name":"name","in":"query","description":"Name of the transformation to be cleaned.","required":true,"schema":{"type":"string"}},{"name":"xml","in":"query","description":"Boolean flag which sets the output format required. Use Y to receive XML response.","required":false,"schema":{"type":"string","enum":["Y","N"],"default":"N"}},{"name":"id","in":"query","description":"Carte transformation ID of the transformation to be cleaned.","required":false,"schema":{"type":"string"}},{"name":"sockets","in":"query","description":"Boolean flag which indicates if full clean up or sockets only is required. Use Y to clean just sockets.","required":false,"schema":{"type":"string","enum":["Y","N"]}}],"responses":{"200":{"description":"Request was processed","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/WebResult"}},"text/html":{"schema":{"type":"string","description":"HTML response containing operation result"}}}},"500":{"description":"Internal server error occurs during request processing","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
````
## Sniff step metadata and data
> Sniff metadata and data from the specified step of the specified transformation.\
> \
> \*\*Example Request:\*\*\
> \`\`\`\
> GET /kettle/sniffStep?trans=dummy-trans\&step=tf\&xml=Y\&lines=10\
> \`\`\`
````json
{"openapi":"3.0.3","info":{"title":"Pentaho Data Integration and Analytics","version":"0.0.1"},"tags":[{"name":"Carte APIs - Transformations","description":"Provides web services to create, update, and delete transformations. Calls for getting images, statuses and starting, pausing, preparing, and stopping transformations are also included."}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic","description":"HTTP Basic Authentication"}},"schemas":{"ErrorResponse":{"type":"object","description":"Error response format","properties":{"result":{"type":"string","enum":["ERROR"],"description":"Always ERROR for error responses"},"message":{"type":"string","description":"Error message describing what went wrong"},"exception":{"type":"string","description":"Exception details if available"}},"xml":{"name":"webresult"}}}},"paths":{"/kettle/sniffStep":{"get":{"tags":["Carte APIs - Transformations"],"summary":"Sniff step metadata and data","description":"Sniff metadata and data from the specified step of the specified transformation.\n\n**Example Request:**\n```\nGET /kettle/sniffStep?trans=dummy-trans&step=tf&xml=Y&lines=10\n```\n","parameters":[{"name":"trans","in":"query","description":"Name of the transformation containing required step.","required":true,"schema":{"type":"string"}},{"name":"stepName","in":"query","description":"Name of the transformation step to collect data for.","required":true,"schema":{"type":"string"}},{"name":"copynr","in":"query","description":"Copy number of the step to be used for collecting data. If not provided 0 is used.","required":false,"schema":{"type":"integer","default":0}},{"name":"type","in":"query","description":"Type of the data to be collected (input or output).","required":false,"schema":{"type":"string","enum":["input","output"]}},{"name":"xml","in":"query","description":"Boolean flag which sets the output format required. Use Y to receive XML response.","required":false,"schema":{"type":"string","enum":["Y","N"],"default":"N"}},{"name":"id","in":"query","description":"Carte id of the transformation to be used for step lookup.","required":false,"schema":{"type":"string"}},{"name":"lines","in":"query","description":"Number of lines to collect. If not provided 0 is used.","required":false,"schema":{"type":"integer","default":0}}],"responses":{"200":{"description":"Request was processed","content":{"text/xml":{"schema":{"type":"string","description":"XML response containing step metadata and data"}},"text/html":{"schema":{"type":"string","description":"HTML response containing step metadata and data"}}}},"500":{"description":"Internal server error occurs during request processing","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
````
## Uploads and executes transformation configuration XML file to the server.
> 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.\
> \
> \*\*Example Request:\*\*\
> \`\`\`\
> POST /kettle/registerTrans/?xml=Y\
> \`\`\`\
> Request body should contain xml containing transformation\_configuration (transformation and\
> transformation\_execution\_configuration wrapped in transformation\_configuration tag).
````json
{"openapi":"3.0.3","info":{"title":"Pentaho Data Integration and Analytics","version":"0.0.1"},"tags":[{"name":"Carte APIs - Transformations","description":"Provides web services to create, update, and delete transformations. Calls for getting images, statuses and starting, pausing, preparing, and stopping transformations are also included."}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic","description":"HTTP Basic Authentication"}},"schemas":{"WebResult":{"type":"object","description":"Standard response format for most Carte operations","properties":{"result":{"type":"string","enum":["OK","ERROR"],"description":"Result status of the operation"},"message":{"type":"string","description":"Human readable message describing the result"},"id":{"type":"string","description":"Unique identifier for the created/modified resource"}},"xml":{"name":"webresult"}},"ErrorResponse":{"type":"object","description":"Error response format","properties":{"result":{"type":"string","enum":["ERROR"],"description":"Always ERROR for error responses"},"message":{"type":"string","description":"Error message describing what went wrong"},"exception":{"type":"string","description":"Exception details if available"}},"xml":{"name":"webresult"}}}},"paths":{"/kettle/registerTrans":{"post":{"tags":["Carte APIs - Transformations"],"summary":"Uploads and executes transformation configuration XML file to the server.","deprecated":true,"description":"Uploads xml file containing transformation and transformation_execution_configuration (wrapped in transformation_configuration\ntag) to be executed and executes it. Method relies on the input parameter to determine if xml or html reply should be produced.\nThe transformation_configuration xml is transferred within request body. transformation name of the executed\ntransformation will be returned in the Response object or message describing error occurred. To determine if the call\nsuccessful or not you should rely on result parameter in response.\n\n**Example Request:**\n```\nPOST /kettle/registerTrans/?xml=Y\n```\nRequest body should contain xml containing transformation_configuration (transformation and\ntransformation_execution_configuration wrapped in transformation_configuration tag).\n","parameters":[{"name":"xml","in":"query","description":"Boolean flag set to either Y or N describing if xml or html reply should be produced.","required":false,"schema":{"type":"string","enum":["Y","N"],"default":"N"}}],"requestBody":{"required":true,"description":"XML containing transformation_configuration (transformation and transformation_execution_configuration wrapped in transformation_configuration tag)","content":{"application/xml":{"schema":{"type":"string","description":"Transformation configuration XML"}}}},"responses":{"200":{"description":"Request was processed and XML response is returned","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/WebResult"}}}},"500":{"description":"Internal server error occurs during request processing","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
````
---
# Agent Instructions: Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://docs.pentaho.com/rest-api/carte-apis-transformations.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.