Mtttask

Note...
You cannot use the REST API to create a mapping task based on a mapping that includes a mapplet.

GET Request

To request the details of a mapping task, you can use the task ID or task name. Use one of the following URIs:

/api/v2/mttask/<id>

/api/v2/mttask/name/<name>

If you use the task name in the URI and the task name includes a space, replace the space with %20. For example:

/api/v2/mttask/name/task%20name

GET Response

Returns the mtTask object for the requested task ID or task name.
Returns the error object if errors occurred.
The following table describes attributes in an mtTask object:

POST Request

To update a mapping task, use a mapping task ID in the following URI. To create a mapping task, omit the optional task ID.

/api/v2/mttask/<id>

You can submit a partial update using partial mode. If you want to update a field that is within a collection using partial mode, you must include the key field for the collection. The following table lists the collections in the mttask resource and the corresponding key fields:

To submit a request using partial mode, use a JSON request and include the following line in the header:

Update-Mode=PARTIAL

The following table describes the attributes you can include in an mtTask object:

POST Response

If successful, returns the mtTask object that you created or updated. Returns the error object if errors occur.

DELETE Request

To delete a mapping task, use the task ID in the following URI:

/api/v2/mttask/<id>

DELETE Response

Returns the 200 response code if the request is successful.
Returns the error object if errors occur.

POST Example

To create a new mapping task with XML, you might use the following request:

POST <serverUrl>/api/v2/mttask
Content-Type: application/xml
Accept: application/xml
icSessionId: <icSessionId>

<mtTask>
  <errorTaskEmail>
    <taskEmail>
      <emails>[email protected], [email protected]</emails>
    </taskEmail>
  </errorTaskEmail>
  <successTaskEmail>
    <taskEmail>
      <emails>[email protected]</emails>
    </taskEmail>
  </successTaskEmail>
  <warningTaskEmail>
    <taskEmail>
      <emails>[email protected], [email protected]</emails>
    </taskEmail>
  </warningTaskEmail>
  <parameters>
    <mtTaskParameter>
      <name>sort convert plugin</name>
      <type>MAPPLET</type>
    </mtTaskParameter>
  </parameters>
  <parameters>
    <mtTaskParameter>
      <name>DB lookup</name>
      <type>LOOKUP</type>
    </mtTaskParameter>
  </parameters>
  <sessionProperties>
      <entry>
         <key>Java Classpath</key>
         <value>C:/test/classpathnew</value>
      </entry>
      <entry>
         <key>Pushdown Optimization</key>
         <value>To Source</value>
      </entry>
      <entry>
         <key>Write Backward Compatible Session Log File</key>
         <value>no</value>
      </entry>
   </sessionProperties>
  <runtimeEnvironmentId>00000398D00000004</runtimeEnvironmentId>
  <sequences>
    <sequenceDefinition>
      <txName>SeqGen1</txName>
      <initialValue>1</initialValue>
      <currentValue>62</currentValue>
    </sequenceDefinition>
  </sequences>
  <preProcessingCmd>echo CurrentDate is 'date'</preProcessingCmd>
  <postProcessingCmd>echo PR-PostProcess</postProcessingCmd>
  <masterTemplateId>00034234M00000R</masterTemplateId>
</mtTask>

A successful request returns the mtTask object.

Mask Rule Parameter Attributes for Masking Techniques

Define the parameter attribute values of a mask rule parameter when you run the mapping task. The attributes that you define depend on the masking technique that you apply.

For example, to mask a billing city field with the Substitution City masking technique, define the following attributes:

[
  {
    "referenceField": "BillingCity",
    "pcType": "string",
    "precision": 40,
    "paramMap": {
      "isSeeded": "TRUE",
      "seedValue": "190",
      "dicName": "informatica_mask_us_towns.dic",
      "outputPort": "TOWNNAMES",
    },
    "maskingType": "Substitution City"
  }
]

The following table lists the attributes that you define for each masking technique:

Mask Rule Parameter Attribute Values

Define the required parameter attribute values when you run the mapping task.

The following table describes the attributes and values that you define for the mask rule parameter: