Communities
A collaborative platform to connect and grow with like-minded Informaticans across the globe
Product Communities
Connect and collaborate with Informatica experts and champions
Discussions
Have a question? Start a Discussion and get immediate answers you are looking for
User Groups
Customer-organized groups that meet online and in-person. Join today to network, share ideas, and get tips on how to get the most out of Informatica
Get Started
Community Guidelines
Knowledge Center
Troubleshooting documents, product guides, how to videos, best practices, and more
Knowledge Base
One-stop self-service portal for solutions, FAQs, Whitepapers, How Tos, Videos, and more
Support TV
Video channel for step-by-step instructions to use our products, best practices, troubleshooting tips, and much more
Documentation
Information library of the latest product documents
Velocity (Best Practices)
Best practices and use cases from the Implementation team
Learn
Rich resources to help you leverage full capabilities of our products
Trainings
Role-based training programs for the best ROI
Certifications
Get certified on Informatica products. Free, Foundation, or Professional
Product Learning Paths
Free and unlimited modules based on your expertise level and journey
Resources
Library of content to help you leverage the best of Informatica products
Tech Tuesdays Webinars
Most popular webinars on product architecture, best practices, and more
Product Availability Matrix
Product Availability Matrix statements of Informatica products
SupportFlash
Monthly support newsletter
Support Documents
Informatica Support Guide and Statements, Quick Start Guides, and Cloud Product Description Schedule
Product Lifecycle
End of Life statements of Informatica products
Ideas
Events
Change Request Tracking
Marketplace
English
  • Data Integration
  • All Products

Table of Contents

Search

  1. Preface
  2. Informatica Intelligent Cloud Services REST API
  3. Platform REST API version 2 resources
  4. Platform REST API version 3 resources
  5. Data Integration REST API
  6. File Ingestion and Replication REST API
  7. Streaming Ingestion and Replication REST API
  8. Model Serve REST API
  9. RunAJob utility
  10. ParamSetCli utility
  11. REST API codes
  12. REST API resource quick references

REST API Reference

REST API Reference

Back Next

Mapping tasks

Mapping
 tasks

Use this resource to request the details of a
mapping
 task. You can also create, update, or delete a
mapping
 task.
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, federated task ID, or task name. To find the federated task ID, use the lookup resource. The federated task ID is the value of the id field in the lookup response.
Use one of the following URIs: 
/api/v2/mttask/<id>
/api/v2/mttask/frs/<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:
Field
Type
Description
id
String
Task ID.
orgId
String
Organization ID.
name
String
Task name.
agentId
String
Agent that runs the task.
runtimeEnvironmentId
String
Runtime environment used for the task.
maxLogs
Long
Number of session log files and import log files
Data Integration
 retains.
description
String
Description.
createTime
Date/time
Time the task was created.
updateTime
Date/time
Last time the task was updated.
createdBy
String
User who created the task.
updatedBy
String
User who last updated the task.
schemaMode
String
Mode in which
Data Integration
 refreshes the data object schema.
errorTaskEmail
Object that includes the taskEmail object for error notifications
id
String
Included in taskEmail object for errorTaskEmail.
ID.
emails
String
Included in taskEmail object for errorTaskEmail.
Email address that receives email notification when a task fails to complete.
successTaskEmail
Object that includes the taskEmail object for success notifications.
id
String
Included in taskEmail object for successTaskEmail.
ID.
emails
String
Included in taskEmail object for successTaskEmail.
Email address that receives email notification when a task completes successfully.
warningTaskEmail
Object that includes the taskEmail object for warning notifications.
id
String
Included in taskEmail object for warningTaskEmail.
ID.
emails
String
Included in taskEmail object for warningTaskEmail.
Email address that receives email notification when a task completes with errors.
parameters
Parameters associated with the task. Includes attributes in the mtTaskParameter object for each parameter.
id
Long
Included in the mtTaskParameter object.
Parameter ID.
name
String
Included in the mtTaskParameter object.
Parameter name.
type
String
Included in the mtTaskParameter object.
Parameter type.
text
String
Included in the mtTaskParameter object.
Parameter value.
label
String
Included in the mtTaskParameter object.
Parameter label.
description
String
Included in the mtTaskParameter object.
Parameter description.
sourceConnectionId
String
Included in the mtTaskParameter object.
Source connection ID.
targetConnectionId
String
Included in the mtTaskParameter object.
Target connection ID.
lookupConnectionId
String
Included in the mtTaskParameter object.
Lookup connection ID.
transfConnectionId
String
Included in the mtTaskParameter object.
Connection ID of mapplet. Reserved for future use.
midstreamConnectionId
String
Included in the mtTaskParameter object.
Connection ID of midstream transformation.
sourceObject
String
Included in the mtTaskParameter object.
Source object name.
sourceObjectLabel
String
Included in the mtTaskParameter object.
Source object label.
targetObject
String
Included in the mtTaskParameter object.
Target object name.
targetObjectLabel
String
Included in the mtTaskParameter object.
Target object label.
lookupObject
String
Included in the mtTaskParameter object.
Lookup object name.
lookupObjectLabel
String
Included in the mtTaskParameter object.
Lookup object label.
midstreamObject
String
Included in the mtTaskParameter object.
Midstream object name.
midstreamObjectLabel
String
Included in the mtTaskParameter object.
Midstream object label.
newObject
Boolean
Included in the mtTaskParameter object.
Whether the application creates a new flat file target. Returns True when it creates a target.
newObjectName
String
Included in the mtTaskParameter object.
Name of the flat file target.
operationType
String
Included in the mtTaskParameter object.
The task operation for the target.
truncateTarget
Boolean
Included in the mtTaskParameter object.
Whether the application truncates a database target before writing to it. Returns True when it truncates the target.
srcFFAttrs
Included in the mtTaskParameter object.
Object that contains the source file attributes in the flatFileAttrs object.
tgtFFAttrs
Included in the mtTaskParameter object.
Object that contains the target file attributes in the flatFileAttrs object.
lkpFFAttrs
Included in the mtTaskParameter object.
Object that contains the lookup file attributes in the flatFileAttrs object.
flatFileAttrs
Object that includes attributes for the source, target, and lookup files.
id
Long
Included in the flatFileAttrs object.
Field ID.
delimiter
String
Included in the flatFileAttrs object.
Character used to separate fields
textQualifier
String
Included in the flatFileAttrs object.
Quote character that defines the boundaries of text strings
escapeChar
String
Included in the flatFileAttrs object.
Character immediately preceding a field delimiter character embedded in an unquoted string, or immediately preceding the quote character in a quoted string
headerLineNo
Int
Included in the flatFileAttrs object.
Number of header lines
firstDataRow
Int
Included in the flatFileAttrs object.
The row number where the data begins in the file.
rowDelimiter
Int
Included in the flatFileAttrs object.
Line break character. Returns the decimal code for an ASCII character.
consecutiveDelimiter
Boolean
Included in the flatFileAttrs object.
Indicates whether one or more consecutive delimiters are treated as one.
multiDelimitersAsAnd
Boolean
Included in the flatFileAttrs object.
If the delimiter is more than one character, indicates whether the characters are treated as a single delimiter or multiple delimiters.
customFuncCfg
Included in the mtTaskParameter object.
Object that defines configuration for mapplets used in the task. Includes attributes in the customFuncConfig object for each mapplet.
id
Long
Included in the customFuncConfig object.
Mapplet ID.
connections
Included in the customFuncConfig object.
Object to define connections used in a mapplet. Includes information in the pcsConnection object for each connection.
id
Long
Included in the pcsConnection object.
name
String
Included in the pcsConnection object.
Connection name.
type
String
Included in the pcsConnection object.
Connection type.
subtype
String
Included in the pcsConnection object.
Connection subtype.
description
String
Included in the pcsConnection object.
Description of the connection.
connectionId
String
Included in the pcsConnection object.
Connection ID.
showBusinessNames
Boolean
Included in the mtTaskParameter object.
Whether the task displays business names. Returns True when it shows business names.
naturalOrder
Boolean
Included in the mtTaskParameter object.
The order that the task uses to display fields. Returns True for the order returned by the connection. Returns False for alphabetic order.
isRESTModernSource
Boolean
Included in the mtTaskParameter object.
Always set to True to enable extended objects.
customQuery
String
Included in the mtTaskParameter object.
The custom query specified in Mapping Designer or
mapping
 task query options.
overriddenFields
Included in the mtTaskParameter object.
Changes to field metadata in the
mapping
 task. Includes information in the mtTaskOverriddenField object for each overridden field.
name
String
Included in the mtTaskOverriddenField object.
Field name.
type
String
Included in the mtTaskOverriddenField object.
Field type.
precision
Int
Included in the mtTaskOverriddenField object.
Length of the field in bytes.
scale
Int
Included in the mtTaskOverriddenField object.
Number of digits after the decimal point for numeric values.
platformType
String
Included in the mtTaskOverriddenField object.
Platform data type for the field.
tgtFieldRefs
String
Included in the mtTaskParameter object.
Salesforce field reference IDs.
extendedObject
Included in the mtTaskParameter object.
The source or target with more than one object joined.
targetUpdateColumns
String
Included in the mtTaskParameter object.
List of column names used to update records in the target object.
runtimeAttrs
String
Included in the mtTaskParameter object.
Advanced connection properties for connections used in a task.
Use a runtimeAttrs object to define key-value pairs of advanced connection properties. Use an entry object for each key-value pair.
For the attribute name, use the advanced connection property name as displayed in the
Data Integration
 user interface.
For more information about advanced connection properties, see the
Data Integration
 help.
dataFormat
Included in the mtTaskParameter object.
Data format provided by the connector.
Includes attributes in the dataFormat object for each connector.
The dataFormat object is not applicable to all connectors. To see if dataFormat is applicable to the connectors you are using, see the help for the relevant connectors.
formatId
Included in the dataFormat object.
Data format type provided by the connector, such as FLAT, AVRO, PARQUET, JSON, or XML.
dataFormatAttributes
Included in the dataFormat object.
Format attributes for the data format type. For example, for a flat file, the dataFormatAttributes object includes values such as escapeChar, delimiter, and qualifier.
sequences
Defines values for the Sequence transformation. Includes the sequenceDefinition object for each sequence transformation.
txName
String
Included in the sequenceDefinition object.
Name of the Sequence transformation.
initialValue
String
Included in the sequenceDefinition object.
The initial value of the sequence.
currentValue
String
Included in the sequenceDefinition object.
The value used for the last row added to the transformation.
inOutParameters
In-out parameter used in the task. Includes a mtTaskInOutParameter object for each in-out parameter.
id
Long
Included in the mtTaskInOutParameter object.
Parameter ID.
name
String
Included in the mtTaskInOutParameter object.
Parameter name.
description
String
Included in the mtTaskInOutParameter object.
Description of the parameter.
initialValue
String
Included in the mtTaskInOutParameter object.
Initial value for the parameter.
datatype
String
Included in the mtTaskInOutParameter object.
Data type of the parameter.
precision
String
Included in the mtTaskInOutParameter object.
Precision of the parameter.
scale
String
Included in the mtTaskInOutParameter object.
Scale of the parameter.
retentionPolicy
String
Included in the mtTaskInOutParameter object.
Determines when the task retains the current value.
aggregationType
String
Included in the mtTaskInOutParameter object.
Determines the final current value of the parameter when the task runs.
currentValue
String
Included in the mtTaskInOutParameter object.
Current value for the parameter.
lastRunTime
Date/time
Time the task last run.
masterTemplateId
String
Visio template ID. Returned when a Visio template is the basis of the task.
mappingId
String
Mapping ID. Returned when a mapping is the basis for the task.
scheduleId
String
Schedule associated with the task, if any.
shortDescription
String
The first 50 characters of the description.
sessionProperties
String
Advanced session properties associated with the task.
Includes advanced session properties in a sessionProperties object.
outboundMessageUrlToken
String
Outbound message URL token for the task, if it exists.
outboundMessageUrlQueueTime
Long
Outbound message URL queue time for the task, if it exists.
preProcessingCmd
String
Command to run before the task.
postProcessingCmd
String
Command to run after the task completes.
parameterFileName
String
The name of the parameter file used in the task.
verbose
Boolean
Whether
Data Integration
 generates additional data in the logs to use for troubleshooting purposes. Returns True or False.
connRuntimeAttrs
Included in the mtTaskParameter parameter. Includes an mtTaskConnRuntimeAttr object for each connector.
The connRuntimeAttrs object applies to the CDC connectors.
id
String
Included in the mtTaskConnRuntimeAttr object.
Internal id for each mtTaskConnRuntimeAttr object.
name
String
Included in the mtTaskConnRuntimeAttr object.
The internal ID of a connection runtime attribute for a CDC connector.
value
String
Included in the mtTaskConnRuntimeAttr object.
The value associated with the name attribute.
connectionID
String
Included in the mtTaskConnRuntimeAttr object.
The CDC connection ID.

POST request

To create a
mapping
 task, use the following URI: 
/api/v2/mttask/
If you want to specify a location for the task, include the container ID in the request. If the container ID isn't included in the request, the task is created in the Default folder. You can find the container ID for a project or folder in the
Data Integration
 user interface. On the
Explore
 page, select the folder. In the URL, the last string of characters is the container ID.
For example, in the following URL, the container ID is dH2DuGJYda7ijgW4Sm32sR: 
https://na1.dm-us.informaticacloud.com/diUI/products/integrationDesign/main/Explore/dH2DuGJYda7ijgW4Sm32sR
To update a
mapping
 task, include the task ID or federated task ID in the URI. To find the federated task ID, use the lookup resource. The federated task ID is the value of the id field in the lookup response.
Use one of the following URIs: 
/api/v2/mttask/<id>
/api/v2/mttask/frs/<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:
Collection
Key Fields
mtTaskInOutParameter
name
sequenceDefinition
txName
mtTaskOverriddenField
name
mtTaskParameter
name
type
objects
name
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:
Field
Type
Required
Description
name
String
Name of the task.
containerId
String
ID of the project or folder to contain the task.
If not included in the request, the task is created in the Default folder.
description
String
Description of the task.
runtimeEnvironmentId
String
Yes
ID of the runtime environment used for the task.
mappingId
String
Required when a mapping is the basis for task.
ID of the mapping used in the task.
scheduleId
String
Schedule associated with the task, if any.
sessionProperties
String
Advanced session properties. Use a sessionProperties object to define key-value pairs of advanced session properties. Use an entry object for each key-value pair.
For the attribute name, use the advanced session property name as displayed in the
Data Integration
 user interface.
schemaMode
String
Mode in which
Data Integration
 refreshes the data object schema.
Use one of the following values:
  • async
  • dynamic
Default is async.
If you run multiple mapping tasks at the same time,
Data Integration
 picks up the latest schema regardless of the schema mode.
errorTaskEmail
Object that includes the taskEmail object for error notifications
id
String
Include in taskEmail object for errorTaskEmail.
ID.
emails
String
Include in taskEmail object for errorTaskEmail.
Email address that receives email notification when a task fails to complete.
successTaskEmail
Object that includes the taskEmail object for success notifications.
id
String
Include in taskEmail object for successTaskEmail.
ID.
emails
String
Include in taskEmail object for successTaskEmail.
Email address that receives email notification when a task completes successfully.
warningTaskEmail
Object that includes the taskEmail object for warning notifications.
id
String
Include in taskEmail object for warningTaskEmail.
ID.
emails
String
Include in taskEmail object for warningTaskEmail.
Email address that receives email notification when a task completes with errors.
parameters
Parameters associated with the task. Use an mtTaskParameter object to define the following attributes for each parameter.
id
Long
Include in the mtTaskParameter object.
System generated parameter ID. You cannot update this value
name
String
Include in the mtTaskParameter object.
Parameter name. Key field for the mtTaskParameter collection.
type
String
Include in the mtTaskParameter object.
Parameter type. Key field for the mtTaskParameter collection. Use one of the following values:
  • STRING
  • SOURCE
  • TARGET
  • MAPPLET
  • LOOKUP
text
String
Include in the mtTaskParameter object.
Parameter value.
label
String
Include in the mtTaskParameter object.
Parameter label.
description
String
Include in the mtTaskParameter object.
Parameter description.
sourceConnectionId
String
Include in the mtTaskParameter object.
Source connection ID.
targetConnectionId
String
Include in the mtTaskParameter object.
Target connection ID.
lookupConnectionId
String
Include in the mtTaskParameter object.
Lookup connection ID.
newFlatFile
Boolean
Include in the mtTaskParameter object.
Whether
Data Integration
 creates a new flat file target. Use one of the following values:
  • True.
  • False.
flatFileName
String
Include in the mtTaskParameter object.
Name of the flat file target.
newObject
Boolean
Include in the mtTaskParameter object.
Whether the application creates a new flat file target. Returns True when it creates a target.
newObjectName
String
Include in the mtTaskParameter object.
Name of the flat file target.
operationType
String
Include in the mtTaskParameter object.
The task operation for the target.
Use one of the following values:
  • Insert
  • Upsert
  • Update
  • Delete
  • Rowbased
The Rowbased value corresponds to the Data Driven value in the user interface.
dataDrivenCondition
String
Include in the mtTaskParameter object.
Applicable when operationType is Rowbased.
Defines expressions that flag rows for an insert, update, delete, or reject operation. For example:
IIF(ISNULL (ISDELETED), DD_INSERT
truncateTarget
Boolean
Include in the mtTaskParameter object.
Whether the application truncates a database target before writing to it. Use one of the following values:
  • True.
  • False.
srcFFAttrs
Include in the mtTaskParameter object.
Object for the source file attributes. Include the attributes in the flatFileAttrs object.
tgtFFAttrs
Include in the mtTaskParameter object.
Object for the target file attributes. Include the attributes in the flatFileAttrs object.
lkpFFAttrs
Include in the mtTaskParameter object.
Object for the lookup file attributes. Include the attributes in the flatFileAttrs object.
flatFileAttrs
Object to hold attributes for the source, target, and lookup files.
id
Long
Include in the flatFileAttrs object.
Field ID.
delimiter
String
Include in the flatFileAttrs object.
Character used to separate fields.
textQualifier
String
Include in the flatFileAttrs object.
Quote character that defines the boundaries of text strings.
escapeChar
String
Include in the flatFileAttrs object.
Character immediately preceding a field delimiter character embedded in an unquoted string, or immediately preceding the quote character in a quoted string.
headerLineNo
Int
Include in the flatFileAttrs object.
Number of header lines.
firstDataRow
Int
Include in the flatFileAttrs object.
The row number where the data begins in the file.
rowDelimiter
Int
Include in the flatfileAttrs object.
Line break character. Enter the decimal code for an ASCII character between 1 and 32.
Default is 10, which is the line feed character.
consecutiveDelimiter
Boolean
Included in the flatFileAttrs object.
Indicates whether one or more consecutive delimiters are treated as one. Default is false.
multiDelimitersAsAnd
Boolean
Included in the flatFileAttrs object.
If the delimiter is more than one character, indicates whether the characters are treated as a single delimiter or multiple delimiters. Default is true.
customFuncCfg
Include in the mtTaskParameter object.
Object to define configuration for mapplets used in the task. Use a customFuncConfig object to define each mapplet.
id
Long
Include in the customFuncConfig object.
Mapplet ID.
connections
Include in the customFuncConfig object.
Object to define connections used in a mapplet. Use a pcsConnection object for each connection.
For more information about connections, see connection.
id
Long
Include in the pcsConnection object.
name
String
Include in the pcsConnection object.
Connection name.
type
String
Include in the pcsConnection object.
Connection type.
subtype
String
Include in the pcsConnection object.
Connection subtype.
description
String
Include in the pcsConnection object.
Description of the connection.
connectionId
String
Include in the pcsConnection object.
Connection ID.
overriddenFields
Include in the mtTaskParameter object.
Changes to field metadata in the
mapping
 task. Use the mtTaskOverriddenField object for each overridden field.
name
String
Include in the mtTaskOverriddenField object.
Field name. Key field for the mtTaskOverriddenField collection.
type
String
Include in the mtTaskOverriddenField object.
Field type.
precision
Int
Include in the mtTaskOverriddenField object.
Length of the field in bytes.
scale
Int
Include in the mtTaskOverriddenField object.
Number of digits after the decimal point for numeric values.
platformType
String
Include in the mtTaskOverriddenField object.
Platform data type for the field.
tgtFieldRefs
String
Include in the mtTaskParameter object.
Salesforce field reference IDs.
runtimeAttrs
String
Include in the mtTaskParameter object.
Advanced connection properties for connections used in a task.
Use a runtimeAttrs object to define key-value pairs of advanced connection properties. Use an entry object for each key-value pair.
For the attribute name, use the advanced connection property name as displayed in the
Data Integration
 user interface.
For more information about advanced connection properties, see the
Data Integration
 help.
parameterFileName
String
Include in the mtTaskParameter object.
Name of the parameter file used in the task.
parameterFileDir
String
Include in the mtTaskParameter object.
Path for the directory that contains the parameter file.
dataFormat
Include in the mtTaskParameter object.
Data format provided by the connector.
Include attributes in the dataFormat object for each connector.
The dataFormat object is not applicable to all connectors. To see if dataFormat is applicable to the connectors you are using, see the help for the relevant connectors.
formatId
String
Include in the dataFormat object.
Data format type provided by the connector, such as FLAT, AVRO, PARQUET, JSON, or XML.
fwConfigId
String
Required when formatID is set to Flat and fixed-width mode is used.
Include in the dataFormat object.
Valid fixed-width format ID.
dataFormatAttributes
String
Include in the dataFormat object.
Format attributes for the data format type. For example, for a flat file data format, the dataFormatAttributes object includes values such as escapeChar, delimiter, and qualifier.
inOutParameters
In-out parameter used in the task. Include an mtTaskInOutParameter object for each in-out parameter.
id
Long
Include in the mtTaskInOutParameter object.
Parameter ID.
name
String
Include in the mtTaskInOutParameter object.
Parameter name. Key field in the mtTaskInOutParameter collection.
description
String
Include in the mtTaskInOutParameter object.
Description of the parameter.
initialValue
String
Include in the mtTaskInOutParameter object.
Initial value for the parameter.
datatype
String
Include in the mtTaskInOutParameter object.
Data type of the parameter.
precision
String
Include in the mtTaskInOutParameter object.
Precision of the parameter.
scale
String
Include in the mtTaskInOutParameter object.
Scale of the parameter.
retentionPolicy
String
Include in the mtTaskInOutParameter object.
Determines when the task retains the current value. Include one of the following values:
  • ON_SUCCESS_OR_WARNING
  • ON_SUCCESS
  • ON_WARNING
  • NEVER
aggregationType
String
Include in the mtTaskInOutParameter object.
Determines the final current value of the parameter when the task runs.
currentValue
String
Include in the mtTaskInOutParameter object.
Current value for the parameter.
masterTemplateId
String
Required when task uses a Visio template.
ID of the Visio template used in the task.
outboundMessageUrlToken
String
Outbound message URL token for the task, if it exists.
outboundMessageUrlQueueTime
Long
Outbound message URL queue time for the task, if it exists.
preProcessingCmd
String
Command to run before the task.
postProcessingCmd
String
Command to run after the task completes.
maxLogs
Long
Number of session log files and import log files to retain. By default,
Data Integration
 stores each type of log file for 10 runs before it overwrites the log files for new runs.
verbose
Boolean
Whether to generate additional data in the logs to use for troubleshooting purposes. Use True or False.
agentId
String
Agent that runs the task.
sequences
Defines values for the Sequence transformation. Use a sequenceDefinition object for each sequence transformation.
txName
String
Include in the sequenceDefinition object.
Name of the Sequence transformation. Key field in the sequenceDefinition collection.
initialValue
String
Include in the sequenceDefinition object.
The initial value of the sequence.
currentValue
String
Include in the sequenceDefinition object.
The value used for the last row added to the transformation.
connRuntimeAttrs
Include in the mtTaskParameter parameter. Include an mtTaskConnRuntimeAttr object for each CDC connector for which runtime attributes will be changed.
The connRuntimeAttrs object applies to the CDC connectors.
id
String
Required for connRuntimeAttrs object.
Include in the mtTaskConnRuntimeAttr object.
Include the internal ID of the mtTaskConnRuntimeAttr object.
name
String
Required for mtTaskConnRuntimeAttr.
Include in the mtTaskConnRuntimeAttr object.
Use one of the following names for the runtime attributes:
  • 101 for Maximum Rows Per Commit.
  • 102 for Minimum Rows Per Commit.
  • 103 for Maximum Latency in Seconds.
  • 104 for Real-time Flush Latency in Milliseconds.
  • 105 for Restart Point.
  • 106 for Restart Revision.
  • 107 for UOW Count.
  • 108 for Update as Delete or Insert.
  • 110 for Restart Option.
value
String
Include in the mtTaskConnRuntimeAttr object.
Use a valid value for the specified attribute name:
  • Maximum Rows Per Commit. 0 to 999999999.
  • Minimum Rows Per Commit. 0 to 999999999.
  • Maximum Latency in Seconds. 2 to 360.
  • Real-time Flush Latency in Milliseconds. -1 to 999999999.
  • Restart Point. Set in conjunction with the Restart Option. 0 for earliest available. An empty string for end of log. A valid timestamp for specific timestamp in the log. A valid PWX Token to restart at a specific token in the log.
  • Restart Revision. A valid revision number from 0 to 2147483647.
  • UOW Count. -1 to 999999999.
  • Update as Delete or Insert. 0 to process as update. 1 to process as delete and insert.
  • Restart Option. Set in conjunction with the Restart Point. 0 for earliest available. 1 for end of log. 2 for time-based. 3 for PWX token.
connectionID
String
Required for mtTaskConnRuntimeAttr object.
Include in the mtTaskConnRuntimeAttr object.
Include the CDC connection ID.

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>
You cannot use the federated task ID to delete a
mapping
 task.

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_dev@company.com, email2_dev@company.com</emails>
    </taskEmail>
  </errorTaskEmail>
  <successTaskEmail>
    <taskEmail>
      <emails>reviewer@company.com</emails>
    </taskEmail>
  </successTaskEmail>
  <warningTaskEmail>
    <taskEmail>
      <emails>email_dev@company.com, email2_dev@company.com</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.
0 COMMENTS
We’d like to hear from you!