REST API Reference

Back Next

Getting transformation details

You can get the details for all the transformations in a mapping or details for the transformations of a particular type in a mapping.

Get request

Use one of the following URIs to get transformation details.

Details for all the transformations in a mapping: To include transformation details for all of the transformations in the mapping, use one of the following URIs:
/api/v2/mapping/additionalTransformationInfo/<mapping ID>
/api/v2/mapping/additionalTransformationInfoByName/<mapping name>
Details for transformations of a particular transformation type in a mapping: To include transformation details for a particular transformation type, include
?txType=<transformation type>
in the URI, for example:
/api/v2/mapping/additionalTransformationInfoByName/m_MyMapping?txType=Sequence

GET Response

If successful, returns transformation details for the mapping. Details can include transformation advanced properties such as tracing level and sequence information if a Sequence transformation is included in the mapping.

If any advanced properties are specified for a transformation, the response includes all of the advanced property values for the transformation. If no advanced properties are specified for a transformation, the response doesn't include values for the advanced properties even though default values are used.

Returns the error object if errors occur.

The response includes the following attributes:

Field	Type	Description
id	String	Mapping ID.
orgId	String	Organization ID.
name	String	Mapping name.
description	String	Description of the mapping.
createTime	Date/time	Time the mapping was created.
updateTime	Date/time	Last time the mapping was updated.
createdBy	String	User who created the mapping.
updatedBy	String	User who last updated the mapping.
templateId	String	ID of the template created internally to represent the mapping.
valid	Boolean	Indicates if the mapping is valid. Returns true or false.
additionalAttributes		Additional mapping attributes.
specialCharacterSupport	Boolean	Returned in the additionalAttributes object. Whether the mapping supports special characters in field names or replaces special characters with an underscore (_).
allowMaxFieldLength	Boolean	Returned in the additionalAttributes object. Whether the mapping allows field names up to 255 characters. Names exceeding 255 characters are truncated. Default is false.
transformations	Object	Advanced transformation properties and sequence details.
transformationProperties	Object	Properties for each transformation in the mapping, or for a specific transformation type, if requested.
name	String	Transformation name.
txType	String	Transformation type.
advancedProperties	Object	Returned in the transformationProperties object. Advanced properties for the transformation. The properties included in the response vary based on the transformation type and connection type.
sequences	Object	Sequence information for the mapping, if the mapping includes a Sequence transformation.
sequenceStateDefinition	Object	Properties for each Sequence transformation in the mapping.
name	String	Name of the Sequence transformation
txType	String	Transformation type.
cycle	Boolean	Whether the mapping task cycles through the sequence range.
endValue	String	Maximum value that the mapping task generates.
incrementBy	String	The difference between two consecutive values in a generated sequence.
numberOfCachedValues	String	Number of sequential values the mapping task caches for each run.
reset	Boolean	Whether reset is enabled.
sharedSequenceId	String	ID of the shared sequence, if enabled.
initialValue	String	Initial value of the sequence.
cycleStartValue	String	Start value of the generated sequence that you want the mapping task to use.
useSharedSequence	Boolean	Whether the Sequence transformation uses a shared sequence.

GET Example

To request details for all transformations in a particular mapping, you might use the following request:

GET <serverUrl>/api/v2/mapping/additionalTransformationInfoByName/m_Mapping26 
Content-type: application/xml
Accept: application/xml
icSessionId: ABCdOrJmd6YUtmK123

If successful, you might receive a response similar the to following example:

{
    "@type": "mappingAdditionalInfo",
    "id": "0100001700000000123G",
    "orgId": "012300",
    "name": "m_Mapping26",
    "description": "",
    "createTime": "2026-03-27T00:35:37.000Z",
    "updateTime": "2026-03-27T00:35:37.000Z",
    "createdBy": "orguser",
    "updatedBy": "orguser",
    "autoExpireObject": false,
    "templateId": "stringIdentity:0100000X0000000123IY",
    "valid": false,
    "documentType": "MAPPING",
    "additionalAttributes": {
        "specialCharacterSupport": false,
        "allowMaxFieldLength": false
    },
    "transformations": [
        {
            "@type": "transformationProperties",
            "name": "Source",
            "txType": "TmplSource",
            "advancedProperties": {
                "Tracing Level": "Verbose Data"
            }
        },
        {
            "@type": "transformationProperties",
            "name": "Target",
            "txType": "TmplTarget",
            "advancedProperties": {
                "Thousand Separator": ",",
                "Datetime Format": "",
                "Forward Rejected Rows": "true",
                "Decimal Separator": ","
            }
        },
        {
            "@type": "transformationProperties",
            "name": "Sequence",
            "txType": "TmplGenerator",
            "advancedProperties": {
                "Tracing Level": "Verbose Data",
                "Optional": "true"
            }
        },
        {
            "@type": "transformationProperties",
            "name": "Expression",
            "txType": "TmplExpression",
            "advancedProperties": {
                "Tracing Level": "Verbose Initialization",
                "Optional": "true"
            }
        },
        {
            "@type": "transformationProperties",
            "name": "Lookup",
            "txType": "TmplLookup",
            "advancedProperties": {
                "Cache File Name Prefix": "",
                "Lookup Index Cache Size": "AUTO",
                "Optional": "true",
                "Lookup cache persistent": "false",
                "Lookup source is static": "false",
                "Lookup Sql Override": "",
                "Update Dynamic Cache Condition": "TRUE",
                "Re-cache from lookup source": "false",
                "Lookup caching enabled": "true",
                "Insert Else Update": "false",
                "Tracing Level": "Verbose Initialization",
                "Lookup Data Cache Size": "AUTO",
                "Subsecond Precision": "6",
                "Lookup cache directory name": "$PMCacheDir",
                "Output Old Value On Update": "false",
                "Lookup Source Filter": "",
                "Dynamic Lookup Cache": "false",
                "Pre-build lookup cache": "AUTO",
                "Synchronize dynamic cache": "false"
            }
        }
    ],
    "sequences": [
        {
            "@type": "sequenceStateDefinition",
            "name": "Sequence",
            "txType": "TmplGenerator",
            "cycle": false,
            "endValue": "9223372036854775807",
            "incrementBy": "3",
            "numberOfCachedValues": "150",
            "reset": false,
            "sharedSequenceId": "",
            "initialValue": "2",
            "cycleStartValue": "0",
            "useSharedSequence": false
        }
    ]
}

Rename Saved Search

Table of Contents

REST API Reference

REST API Reference

Getting transformation details

Getting transformation details

Get request

GET Response

GET Example