REST API Guide

REST API Guide

API Call and Request Body Syntax

API Call and Request Body Syntax

Use a REST API call to run a Data Transformation service.
Use the following URL for the REST API call, where <Service_Name> is the name of the Data Transformation service that the API runs:
http://localhost:8080/DTRestApi/informatica/dt/transform/v0.1/<Service_Name>
You can provide a request body in JSON to the REST API call. The following table describes the request body objects:
Object
Arguments
input
Specify a default input port for the Data Transformation service.
The object has following arguments:
  • type
    :
    FILE
    or
    BUFFER
    . The input type determines whether the input is data or a source file path.
  • value
    : If the
    type
    is
    FILE
    , the value is the input file path. If the
    type
    is
    BUFFER
    , the value is a text string
output
Specify a default output port for the Data Transformation service.
The object has following arguments:
  • type
    :
    FILE
    or
    BUFFER
    . The output type determines whether the output is provided as a buffer or saved to a target file path.
  • value
    : If the
    type
    is
    FILE
    , the value is the output file path. If the
    type
    is
    BUFFER
    , the value does not have to be specified and can be removed.
additionalInputs
Specify additional input ports for the Data Transformation service. A call can contain up to 15 input ports.
The object has following arguments:
  • name
    : The name of the additional input port.
  • type
    :
    FILE
    or
    BUFFER
  • value
    : If the
    type
    is
    FILE
    , the value is the input file path. If the
    type
    is
    BUFFER
    , the value is a text string.
additionalOutputs
Specify additional output ports for the Data Transformation service. A call can contain up to 15 output ports.
The object has following arguments:
  • name
    : The name of the additional output port.
  • type
    :
    FILE
    or
    BUFFER
  • value
    : If the
    type
    is
    FILE
    , the value is the output file path. If the
    type
    is
    BUFFER
    , the value is empty.
serviceParameters
Provides the Data Transformation service with values to apply to variables in the service parameter ports. A call can contain up to 15 service parameters.
The object has following arguments:
  • name
    : The name of the service parameter.
  • value
    : The value of the service parameter.

Request Body Syntax Example

The following code contains the request body syntax:
{ "input": { "type": "FILE", "value": "C:\Files\Meida\r99315.txt" }, "output": { "type": "BUFFER", }, "additionalInputs": [ { "name": "SecondBill", "type": "FILE", "value": "C:\Files\Meida\r43615.txt" } ], "serviceParameters": [ { "name": "LastPayment", "value": "1037" } ] }