Mapping

Use this resource to request the details for a mapping or the details of all mappings in the organization.

GET Request

You can request the following information using a mapping GET request:
Details of all mappings in the organization.
Details for a particular mapping.
An image of a mapping

Details of all mappings in the organization

To request the details of all mappings in the organization, use the following URI:

/api/v2/mapping

Details for a particular mapping

To request the details of a particular mapping, include the mapping ID or mapping name in the URI. Use one of the following URIs:

/api/v2/mapping/<id>
/api/v2/mapping/name/<name>

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

/api/v2/mapping/name/my%20mapping

You can also request a specific mapping by name with the following URI:

/api/v2/mapping/search?name=<name>

Image of a mapping

To request an image of a mapping, specify the mapping ID and whether the mapping is deployed or not. Use the following URI:

/api/v2/mapping/<id>/image?deployed=<true|false>

For example:

/api/v2/mapping/N0A1700000000001J/image?deployed=true

GET Response

If successful, returns the mapping object for the requested mapping.
If you request the details for all mappings, returns the mapping object for every mapping in the organization without parameter details.
Returns the error object if errors occur.
The mapping object 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

Last time the mapping was updated.

createdBy

User who created the mapping.

updatedBy

String

User who last updated the mapping.

bundleObjectId

String

ID of the bundle that includes the mapping, if applicable.

bundleVersion

String

Version of the bundle that includes the mapping, if applicable.

templateId

String

ID of the template created internally to represent the mapping.

deployTime

Time the mapping was deployed.

hasParameters

Indicates if the mapping includes parameters. Returns true or false.

valid

Indicates if the mapping is valid. Returns true or false.

fixedConnection

Indicates if the mapping is valid. Returns true or false.

hasParametersDeployed

Indicates if the mapping has fixed connections. Returns true or false.

fixedConnectionDeployed

Indicates if the mapping has fixed connections. Returns true or false.

deployedTemplateId

String

ID of the template created internally to represent the deployed mapping.

tasks

Number of tasks that use the mapping.

parameters

Parameters used in the mapping. Includes an mtTaskParameter object for each parameter.

id

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

description

String

Included in the mtTaskParameter object.
Parameter description.

customFuncId

String

Mapplet ID for mapplet type parameters.

uiProperties

String

Included in the mtParameter object.
Display property for the parameter. Includes the following information:
cnxtype. Connection type for the parameter.
logcnx. Logical connection.
order. Display order.
wizstep. Wizard step to display the parameter.
default. Default value.
visible. Whether the parameter is visible.
editable. Whether the parameter is editable.
required. Whether the parameter is required.
paramtype. UI control type for string parameters. Returns one of the following responses:
Condition. Filter condition input control.
Expression. Expression editor input control.
Field. Field selection input control.
Fieldmap. Field mapping input control. Includes the following attributes:
lefttitle. Left title for the field mapping display.
righttitle. Right title for the field mapping display.
leftfs. Set of fields to display in the left table of the field mapping display.
rightfs. Set of fields to display in the right table of the field mapping display.
leftfilter. Regular expression to limit the fields that display in the left table of the field mapping display.
rightfilter. Regular expression to limit the fields that display in the right table of the field mapping display.
staticlist. List of fields to display on the right side of the field mapping display.

inOutParameters

In-out parameter used in the mapping. Includes a mtTaskInOutParameter object for each in-out parameter.

id

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 run

currentValue

String

Included in the mtTaskInOutParameter object.
Current value for the parameter

mappingPreviewFileRecordId

String

ID of the image file that is used when previewing a mappin

deployedMappingPreviewFileRecordId

String

ID of the image file that is used when previewing a deployed mapping.

references

Reference information. Returns the reference object, which includes the following attributes:

refObjectId

String

Included in the reference object.

refType

String

Included in the reference object.

To request mapping details for all mappings in the organization, you might use the following request:

GET <serverUrl>/api/v2/mapping 
Accept: application/xml
icSessionId: <icSessionId>