REST API Reference

Back Next

Getting advanced connection property details

You can get the details about advanced properties for source, target, and lookup connections in a

mapping

task. Use this resource to get details about the advanced connection properties even if the properties aren't overridden in the

mapping

task.

GET Request

Use one of the following URIs to get details about advanced connection properties.

Advanced properties for all connections in a mapping task: To include advanced properties for all of the source, target, and lookup connections in the task, use the following URI:
api/v2/mttask/mergedRuntimeAttributes/<mapping task ID>
Advanced properties for a particular connection: To include advanced properties for a particular connection, include
?paramId=<paramId>
in the URI, for example:
/api/v2/mttask/mergedRuntimeAttributes/<mttaskId>?paramId=<paramId>; To get the paramId, use the mttask resource.

GET Response

If successful, returns details about advanced connection properties in the

mapping

task.

Returns the error object if errors occur.

The response includes the following attributes:

Field	Type	Description
name	String	Name of the advanced property.
value	String	Configured value of the advanced property.
overriddenInMct	Boolean	Indicates whether the property value was overridden in the mapping task.
default value	String	Default value of the advanced property.

GET Example

To request advanced properties for a particular connection in a

mapping

task, you might use the following request:

GET <serverUrl>/api/v2/mttask/mergedRuntimeAttributes/0152ZV0Z0000000000H0?paramId=13841
Content-type: application/xml
Accept: application/xml
icSessionId: ABCdOrJmd6YUtmK123

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

{
    "13841": [
        "ArrayList",
        [
            {
                "@type": "connectorRuntimeAttrMetaData",
                "name": "Thousand Separator",
                "value": "None",
                "overriddenInMct": false,
                "defaultValue": "None"
            },
            {
                "@type": "connectorRuntimeAttrMetaData",
                "name": "Header Options",
                "value": "Output Field Names",
                "overriddenInMct": false,
                "defaultValue": "Output Field Names"
            },
            {
                "@type": "connectorRuntimeAttrMetaData",
                "name": "Create Target Directory",
                "value": "false",
                "overriddenInMct": false,
                "defaultValue": "NO"
            },
            {
                "@type": "connectorRuntimeAttrMetaData",
                "name": "Output Type",
                "value": "File",
                "overriddenInMct": false,
                "defaultValue": "File"
            },
            {
                "@type": "connectorRuntimeAttrMetaData",
                "name": "Output file directory",
                "value": "/root",
                "overriddenInMct": false,
                "defaultValue": ""
            },
            {
                "@type": "connectorRuntimeAttrMetaData",
                "name": "Decimal Separator",
                "value": ".",
                "overriddenInMct": false,
                "defaultValue": "."
            },
            {
                "@type": "connectorRuntimeAttrMetaData",
                "name": "Append if Exists",
                "value": "false",
                "overriddenInMct": false,
                "defaultValue": "NO"
            },
            {
                "@type": "connectorRuntimeAttrMetaData",
                "name": "Output filename",
                "value": "sample_merge_data",
                "overriddenInMct": false,
                "defaultValue": ""
            }
        ]
    ]
}

Rename Saved Search

Table of Contents

REST API Reference

REST API Reference

Getting advanced connection property details

Getting advanced connection property details

GET Request

GET Response

GET Example