REST API Reference

Back Next

dynamictask

Use this resource to request the details of a

dynamic mapping

task. You can also create, update, or delete a

dynamic mapping

task.

To request details or to update a dynamic task that already exists, you need the task ID. You can get the task ID using the V3 lookup resource. To lookup object details with the V3 lookup resource, use the following URI:

/saas/public/core/v3/lookup

Include BATCH_MAPPING as the object type as shown in the following example:

{
  "objects": [
    {
      "path": "Default/DMT_API",
      "type": "BATCH_MAPPING"
    }
  ]
}

The response returns details about the objects in the path as shown in the following example:

{
  "objects": [
    {
      "id": "7H67JPHH9Y4g7Hm7JyL5K2",
      "path": "Default/DMT_API",
      "type": "BATCH_MAPPING",
      "description": "",
      "updatedBy": "rl.ma",
      "updateTime": "2021-08-27T23:45:14Z"
    }
  ]
}

For more information about using the V3 lookup resource, see Lookup.

You can also find the task ID by opening the task in the Data Integration user interface. In the URL, the last string of characters in the task ID.

For example, in the following URL, the task ID is 771b8ZpTcfreXm8n5RZUQ5:

https://na1.dm-us.informaticacloud.com/diUI/products/integrationDesign/main/dynamicmapping/771b8ZpTcfreXm8n5RZUQ5

GET request

To request the details of a

dynamic mapping

task, use the task ID.

Use the following URI to request the details of a

dynamic mapping

task:

/batch-mapping/api/v1/dynamictask/<id>

GET response

Returns the dynamictask object for the requested task ID.

Returns the error object if errors occurred.

The following table describes the attributes in a dynamictask object:

Field	Type	Description
name	String	Name of the dynamic mapping task.
mappingId	String	ID of the mapping used in the task.
mappingDocType	String	Type of mapping used in the task.
runtimeEnvironmentId	String	Runtime environment used for the task.
groups		Groups in the dynamic mapping task.
groupName	String	Included in the group object. Name of the group.
enabled	Boolean	Included in the group object. Whether the group is enabled or not. Returns true when the group is enabled.
parameters		Parameters in the dynamic mapping task.
name	String	Included in the parameter object. Name of the parameter.
type	String	Included in the parameter object. Type of parameter.
txName	String	Included in the parameter object. Name of the transformation that uses the parameter.
uniqueName	String	Included in the parameter object. Transformation name and parameter name. If no transformation name is present, then parameter name.
scope	String	Included in the parameter object. Scope of the parameter, either DEFAULT or LOCAL.
label	String	Included in the parameter object. Parameter label.
description	String	Included in the parameter object. Parameter description.
retentionPolicy	String	Included in the parameter object. Applicable to in-out parameters. Determines when the task retains the current parameter value.
aggregationType	String	Included in the parameter object. Applicable to in-out parameters. Type of calculation the parameter performs.
job		Jobs in the dynamic mapping task.
jobName	String	Included in the job object. Name of the job.
jobType	String	Included in the job object. Type of job, either USER or DEFAULT.
enabled	Boolean	Included in the job object. Determines if the job is enabled. Default is false.
stopOnError	Boolean	Included in the job object. Stops the job when it encounters an error. Default is false.
stopOnWarning	Boolean	Included in the job object. Stops the job when it encounters a warning. Default is false.
preProcessingCmds	Sting	Included in the job object. List of commands to run before the task.
postProcessingCmds	String	Included in the job object. List of commands to run after the task.
advSessionProperties	Map	Included in the job object. Map of the advanced session properties that are set for the job.
group	String	Included in the job object. Name of the group that the job belongs to.
paramValueBindings		Included in the job object. Parameter attributes in the job.
paramDefnRef	Sting	Included in the paramValueBindings object. Unique name of the parameter.
type	String	Included in the paramValueBindings object. Type of parameter. Value can be one of the following types: Connection String Source Target INOUT Sequence
connection		Attributes for connection type parameters.
connectionId	String	Included in the paramValueBindings object. Connection ID.
connectionType	String	Included in the paramValueBindings object. Type of connection.
runtimeAttrs	Map	Included in the paramValueBindings object. Runtime attributes for the connection.
oprRuntimeAttrs	Map	Included in the paramValueBindings object. Read/write runtime attributes.
source		Attributes for source type parameters.
sourceObject	Object	Included in the paramValueBindings object. Source object.
advancedFilterExpression	String	Included in the paramValueBindings object. Advanced filter condition.
filterFields	List of objects	Included in the paramValueBindings object. List of filter fields.
sortFields	List of objects	Included in the paramValueBindings object. List of sort fields.
srcFFAttrs	Object	Included in the paramValueBindings object. Flat file attributes.
ccmDataFormat	Object	Included in the paramValueBindings object. Data format
customQuery	String	Included in the paramValueBindings object. Custom query
handleSpecialChars	Boolean	Included in the paramValueBindings object. Determines if the task can use special characters.
runtimeAttrs	Map	Included in the paramValueBindings object. Runtime Attributes
oprRuntimeAttrs	Map	Included in the paramValueBindings object. Read/write runtime attributes.
string		Attributes for string type parameters.
text	String	Included in the paramValueBindings object. Text value for the parameter.
target		Attributes for target type parameters.
objectName	String	Included in the paramValueBindings object. Name of the existing target object.
objectLabel	String	Included in the paramValueBindings object. Label of the existing target object.
newObjectName	String	Included in the paramValueBindings object. Name of the new target file.
truncateTarget	Boolean	Included in the paramValueBindings object. Determines if Data Integration truncates the target.
bulkApiDBTarget	Boolean	Included in the paramValueBindings object. Determines if bulk API is used.
operationType	String	Included in the paramValueBindings object. Task operation.
tgtFFAttrs	String	Included in the paramValueBindings object. Flat file attributes.
tgtObjectAttributes	Map	Included in the paramValueBindings object. Target object attributes.
runtimeAttrs	Map	Included in the paramValueBindings object. Run time attributes
oprRuntimeAttrs	Map	Included in the paramValueBindings object. Read/write runtime attributes.
ccmDataFormat	Object	Included in the paramValueBindings object. Data format for CCI targets.
dynamicFileName	Boolean	Included in the paramValueBindings object. Determines if the target file name is dynamic.
handleSpecialChars	Boolean	Included in the paramValueBindings object. Determines if the target object handles special characters.
INOUT		Attributes for INOUT type parameters.
initialValue	String	Included in the paramValueBindings object. Initial value of the in-out parameter.
datatype	String	Included in the paramValueBindings object. Data type of the parameter.
precision	String	Included in the paramValueBindings object. Precision of the parameter.
scale	String	Included in the paramValueBindings object. Scale of the parameter.
retentionPolicy	String	Included in the paramValueBindings object. Determines when the task retains the current parameter value.
aggregationType	String	Included in the paramValueBindings object. Type of calculation the parameter performs.
currentValue	String	Included in the paramValueBindings object. Current value of the in-out parameter.
sequence		Attributes for sequence type parameters.
txName	String	Included in the paramValueBindings object. Name of the Sequence Generator transformation.
initialValue	String	Included in the paramValueBindings object. Initial value of the Sequence Generator transformation.
value	String	Included in the paramValueBindings object. Current value of the Sequence Generator transformation.

POST request

To create a dynamic mapping task, use the following URI:

/batch-mapping/api/v1/dynamictask

If you want to specify a location for the task, include the container ID as a query parameter 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 in 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

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

Field	Type	Required	Description
name	String	Yes	Name of the dynamic mapping task.
mappingId	String	Yes	ID of the mapping used in the task.
mappingDocType	String	Yes	Type of mapping used in the task. Include one of the following types: MAPPING. Use for mappings outside of advanced mode. AT_SCALE_MAPPING. Use for mappings in advanced mode.
runtimeEnvironmentId	String	Yes	Runtime environment used for the task.
groups			Groups in the dynamic mapping task.
groupName	String	Yes	Include in the group object. Name of the group.
enabled	Boolean		Include in the group object. Determines if the group is enabled or not.
parameters			Parameters in the dynamic mapping task.
name	String	Yes	Include in the parameters object. Name of the parameter in the mapping.
type	String	Yes	Include in the parameters object. Type of parameter. Include one of the following types: SOURCE_CONNECTION SOURCE_OBJECT TARGET_CONNECTION TARGET_OBJECT LOOKUP_CONNECTION LOOKUP_OBJECT TRANSFORM_CONNECTION STRING GROUPBY FIELD EXPRESSION EXPRESSION_FIELDS CONDITION FIELD_MAPPING SORTLIST INOUT_INT INOUT_BIGINT INOUT_STRING INOUT_TEXT INOUT_DECIMAL INOUT_DOUBLE INOUT_DATETIME SEQUENCE
txName	String		Include in the parameters object. Name of the transformation that uses the parameter.
uniqueName	String	Yes	Include in the parameters object. Transformation name and parameter name. If no transformation name is present, then parameter name.
Scope	String	Yes	Include in the parameters object. Scope of the parameter, either default or local.
label	String		Include in the parameters object. Parameter label.
description	String		Include in the parameters object. Parameter description.
retentionPolicy	String		Include in the parameters object. Applicable to in-out parameters. Determines when the task retains the current parameter value. Use one of the following values: ON_SUCCESS_OR_WARNING ON_SUCCESS ON_WARNING NEVER
aggregationType	String		Include in the parameters object. Applicable to in-out parameters. Type of calculation the parameter performs. Use one of the following values: MAX MIN COUNT
job			Jobs in the dynamic mapping task.
jobName	String	Yes	Include in the job object. Name of the job.
jobType	String	Yes	Include in the job object. Type of job. Use either USER or DEFAULT.
enabled	Boolean		Include in the job object. Determines if the job is enabled. Default is false.
stopOnError	Boolean		Include in the job object. Stops the job when it encounters an error. Default is false.
stopOnWarning	Boolean		Include in the job object. Stops the job when it encounters a warning. Default is false.
preProcessingCmds	String		Include in the job object. List of commands to run before the task.
postProcessingCmds	String		Include in the job object. List of commands to run after the task.
advSessionProperties	Map		Include in the job object. Map of the advanced session properties that are set for the job.
group	String	Yes	Include in the job object. Name of the group that the job belongs to.
paramValueBindings			Parameter attributes in each job.
paramDefnRef	Sting	Yes	Include in the paramValueBindings object. Unique name of the parameter.
type	String	Yes	Include in the paramValueBindings object. Type of parameter. Use one of the following types: Connection String Source Target INOUT Sequence
connection			Attributes for connection type parameters.
connectionId	String		Include in the paramValueBindings object. Connection ID.
connectionType	String		Include in the paramValueBindings object. Type of connection. Use one of the following types: SOURCE TARGET LOOKUP TRANSFORM
runtimeAttrs	Map		Include in the paramValueBindings object. Runtime attributes for the connection.
oprRuntimeAttrs	Map		Include in the paramValueBindings object. Read/write runtime attributes.
source			Attributes for source type parameters.
sourceObject	Object		Include in the paramValueBindings object. Source object.
advancedFilterExpression	String		Include in the paramValueBindings object. Advanced filter condition.
filterFields	List of objects		Include in the paramValueBindings object. List of filter fields.
sortFields	List of objects		Include in the paramValueBindings object. List of sort fields.
srcFFAttrs	Object		Include in the paramValueBindings object. Flat file attributes.
ccmDataFormat	Object		Include in the paramValueBindings object. Data format for CCI sources.
customQuery	String		Include in the paramValueBindings object. Custom query.
handleSpecialChars	Boolean		Include in the paramValueBindings object. Determines if the task can use special characters.
runtimeAttrs	Map		Include in the paramValueBindings object. Runtime attributes for the source.
oprRuntimeAttrs	Map		Include in the paramValueBindings object. Read/write runtime attributes.
string			Attributes for string type parameters.
text	String		Include in the paramValueBindings object. Text value for parameter.
target			Attributes for target type parameters.
objectName	String		Include in the paramValueBindings object. Name of the existing target object.
objectLabel	String		Include in the paramValueBindings object. Label of the existing target object.
newObjectName	String		Include in the paramValueBindings object. Name of the new target file.
truncateTarget	Boolean		Include in the paramValueBindings object. Determines if Data Integration truncates the target.
bulkApiDBTarget	Boolean		Include in the paramValueBindings object. Determines if bulk API is used.
operationType	String		Include in the paramValueBindings object. Task operation.
tgtFFAttrs	String		Include in the paramValueBindings object. Flat file attributes.
tgtObjectAttributes	Map		Include in the paramValueBindings object. Target object attributes.
runtimeAttrs	Map		Include in the paramValueBindings object. Run time attributes.
oprRuntimeAttrs	Map		Include in the paramValueBindings object. Read/write runtime attributes.
ccmDataFormat	Object		Include in the paramValueBindings object. Data format for CCI targets.
dynamicFileName	Boolean		Include in the paramValueBindings object. Determines if the target file name is dynamic.
handleSpecialChars	Boolean		Include in the paramValueBindings object. Determines if the target object handles special characters.
INOUT			Attributes for INOUT type parameters.
initialValue	String		Include in the paramValueBindings object. Initial value of the in-out parameter.
datatype	String		Include in the paramValueBindings object. Data type of the parameter.
precision	String		Include in the paramValueBindings object. Precision of the parameter.
scale	String		Include in the paramValueBindings object. Scale of the parameter.
retentionPolicy	String		Include in the paramValueBindings object. Determines when the task retains the current parameter value. Use one of the following values: ON_SUCCESS_OR_WARNING ON_SUCCESS ON_WARNING NEVER
aggregationType	String		Include in the paramValueBindings object. Type of calculation the parameter performs. Use one of the following values: MAX MIN COUNT
currentValue	String		Include in the paramValueBindings object. Current value of the in-out parameter.
sequence			Attributes for sequence type parameters.
txName	String		Include in the paramValueBindings object. Name of the Sequence Generator transformation.
initialValue	String		Include in the paramValueBindings object. Initial value of the Sequence Generator transformation.
value	String		Include in the paramValueBindings object. Current value of the Sequence Generator transformation.

POST response

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

PUT request

To update a dynamic mapping task, include the task ID as shown in the following example:

/batch-mapping/api/v1/dynamictask/<Id>

When you update a dynamic mapping task, include the same attributes as a POST request.

PUT response

Returns the task ID, state, and any validation errors as shown in the following example:

{
  "frsId": "1JVMWZjVPMhKY4SdxcGd60",
  "state": "VALID",
  "validationErrors": []
}

DELETE request

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

/batch-mapping/api/v1/dynamictask/<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 dynamic mapping task with the REST API, you might use the following request:

POST https://na1.dm-us.informaticacloud.com/batch-mapping/api/v1/dynamictask
Content-Type: application/json
Accept: application/json
IDS-SESSION-ID: jpaybAKQMsmdt7vLJ02z0s
{  
	"orgId": "2ij4X7Pd63ibnquEQyy9wA",  
	"name": "DMT_API",  
	"description": "",  
	"mappingId": "01003Y1700000000005X",  
	"mappingDocType": "MAPPING",  
	"runtimeEnvironmentId": "01003Y25000000000004",  
	"scheduleId": null,  
	"state": "VALID",  
	"groups": [    
		{
      "groupName": "Group_1",
      "enabled": true
   },
   {
      "groupName": "Group_2",
      "enabled": false
    }
 ],
  "parameters": [
    {
      "uniqueName": "Source:SrcCon",
      "name": "SrcCon",
      "txName": "Source",
      "type": "SOURCE_CONNECTION",
      "scope": "DEFAULT",
      "label": null,
      "description": "",
      "retentionPolicy": null,
      "aggregationType": null
    },
    {
      "uniqueName": "Source:SrcObj",
      "name": "SrcObj",
      "txName": "Source",
      "type": "SOURCE_OBJECT",
      "scope": "LOCAL",
      "label": null,
      "description": "",
      "retentionPolicy": null,
      "aggregationType": null
    },
    {
      "uniqueName": "Target:TrgCon",
      "name": "TrgCon",
      "txName": "Target",
      "type": "TARGET_CONNECTION",
      "scope": "DEFAULT",
      "label": null,
      "description": "",
      "retentionPolicy": null,
      "aggregationType": null
    },
    {
      "uniqueName": "Target:TrgObj",
      "name": "TrgObj",
      "txName": "Target",
      "type": "TARGET_OBJECT",
      "scope": "LOCAL",
      "label": null,
      "description": "",
      "retentionPolicy": null,
      "aggregationType": null
    },
    {
      "uniqueName": "Lookup:Lkcon",
      "name": "Lkcon",
      "txName": "Lookup",
      "type": "LOOKUP_CONNECTION",
      "scope": "DEFAULT",
      "label": null,
      "description": "",
      "retentionPolicy": null,
      "aggregationType": null
    },
    {
      "uniqueName": "Lookup:lkObj",
      "name": "lkObj",
      "txName": "Lookup",
      "type": "LOOKUP_OBJECT",
      "scope": "DEFAULT",
      "label": null,
      "description": "",
      "retentionPolicy": null,
      "aggregationType": null
    },
    {
      "uniqueName": "Lkp",
      "name": "Lkp",
      "txName": null,
      "type": "EXPRESSION",
      "scope": "LOCAL",
      "label": null,
      "description": "",
      "retentionPolicy": null,
      "aggregationType": null
    },
    {
      "uniqueName": "ExParam",
      "name": "ExParam",
      "txName": null,
      "type": "EXPRESSION",
      "scope": "LOCAL",
      "label": null,
      "description": "",
      "retentionPolicy": null,
      "aggregationType": null
    }
  ],
  "jobs": [
    {
      "jobUUID": "ae1lR3k2ccYgXNeFQe4DIT",
      "jobName": "<Default>",
      "jobType": "DEFAULT",
      "enabled": false,
      "stopOnError": false,
      "stopOnWarning": false,
      "preProcessingCmds": [],
      "postProcessingCmds": [],
      "advSessionProperties": {},
      "paramValueBindings": [
        {
          "type": "Connection",
          "paramDefnRef": "Source:SrcCon",
          "connectionId": "01003Y0B000000000006",
          "connectionType": null,
          "runtimeAttrs": {},
          "oprRuntimeAttrs": {}
        },
        {
          "type": "Connection",
          "paramDefnRef": "Target:TrgCon",
          "connectionId": "01003Y0B00000000001Q",
          "connectionType": null,
          "runtimeAttrs": {},
          "oprRuntimeAttrs": {}
        },
        {
          "type": "Connection",
          "paramDefnRef": "Lookup:Lkcon",
          "connectionId": "01003Y0B00000000001Q",
          "connectionType": null,
          "runtimeAttrs": {},
          "oprRuntimeAttrs": {}
        },
        {
          "type": "Source",
          "paramDefnRef": "Lookup:lkObj",
          "sourceObject": {
            "name": "EMP",
            "label": "EMP",
            "metadataUpdated": false
          },
          "advancedFilterExpression": null,
          "userDefinedJoin": null,
          "filterFields": [],
          "sortFields": [],
          "srcFFAttrs": null,
          "overriddenFields": [],
          "ccmDataFormat": null,
          "customQuery": null,
          "handleSpecialChars": false,
          "runtimeAttrs": {},
          "oprRuntimeAttrs": {}
        }
      ],
      "group": null
    },
    {
      "jobUUID": "21rswJo8MnOgUTtfCq96AR",
      "jobName": "Job_1",
      "jobType": "USER",
      "enabled": true,
      "stopOnError": false,
      "stopOnWarning": false,
      "preProcessingCmds": [],
      "postProcessingCmds": [],
      "advSessionProperties": {},
      "paramValueBindings": [
        {
          "type": "Source",
          "paramDefnRef": "Source:SrcObj",
          "sourceObject": {
            "name": "employee.csv",
            "label": "employee.csv",
            "metadataUpdated": false
          },
          "advancedFilterExpression": null,
          "userDefinedJoin": null,
          "filterFields": [],
          "sortFields": [],
          "srcFFAttrs": null,
          "overriddenFields": [],
          "ccmDataFormat": null,
          "customQuery": null,
          "handleSpecialChars": false,
          "runtimeAttrs": {},
          "oprRuntimeAttrs": {}
        },
        {
          "type": "Target",
          "paramDefnRef": "Target:TrgObj",
          "objectName": "CONTACT",
          "objectLabel": "CONTACT",
          "newObjectName": null,
          "truncateTarget": false,
          "bulkApiDBTarget": false,
          "operationType": null,
          "tgtFieldRefs": {},
          "targetUpdateColumns": [],
          "tgtFFAttrs": null,
          "tgtObjectAttributes": {},
          "runtimeAttrs": {},
          "oprRuntimeAttrs": {},
          "handleSpecialChars": false,
          "ccmDataFormat": null,
          "dynamicFileName": false
        },
        {
          "type": "String",
          "paramDefnRef": "Lkp",
          "text": " EMP_ID||EMP_NAME"
        },
        {
          "type": "String",
          "paramDefnRef": "ExParam",
          "text": " IsNull(EMP_ID)"
        }
      ],
      "group": "Group_1"
    },
    {
      "jobUUID": "6pavcOH4kwZewe1XL1khoF",
      "jobName": "Job_2",
      "jobType": "USER",
      "enabled": true,
      "stopOnError": false,
      "stopOnWarning": false,
      "preProcessingCmds": [],
      "postProcessingCmds": [],
      "advSessionProperties": {},
      "paramValueBindings": [
        {
          "type": "Source",
          "paramDefnRef": "Source:SrcObj",
          "sourceObject": {
            "name": "Boston_Customers.csv",
            "label": "Boston_Customers.csv",
            "metadataUpdated": false
          },
          "advancedFilterExpression": null,
          "userDefinedJoin": null,
          "filterFields": [],
          "sortFields": [],
          "srcFFAttrs": null,
          "overriddenFields": [],
          "ccmDataFormat": null,
          "customQuery": null,
          "handleSpecialChars": false,
          "runtimeAttrs": {},
          "oprRuntimeAttrs": {}
        },
        {
          "type": "Target",
          "paramDefnRef": "Target:TrgObj",
          "objectName": "CUSTINFO_TYPE",
          "objectLabel": "CUSTINFO_TYPE",
          "newObjectName": null,
          "truncateTarget": false,
          "bulkApiDBTarget": false,
          "operationType": null,
          "tgtFieldRefs": {},
          "targetUpdateColumns": [],
          "tgtFFAttrs": null,
          "tgtObjectAttributes": {},
          "runtimeAttrs": {},
          "oprRuntimeAttrs": {},
          "handleSpecialChars": false,
          "ccmDataFormat": null,
          "dynamicFileName": false
        },
        {
          "type": "String",
          "paramDefnRef": "Lkp",
          "text": "NAME=Firstname"
        },
        {
          "type": "String",
          "paramDefnRef": "ExParam",
          "text": "Firstname||Lastname"
        }
      ],
      "group": "Group_2"
    }
  ]
}

Dynamic mapping tasks

Download Guide

Watch

Comments

Cloud Data Integration Homepage