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:

FieldTypeDescription
idStringMapping ID.
orgIdStringOrganization ID.
nameStringMapping name.
descriptionStringDescription of the mapping.
createTimeDate/timeTime the mapping was created.
updateTimeLast time the mapping was updated.
createdByUser who created the mapping.
updatedByStringUser who last updated the mapping.
bundleObjectIdStringID of the bundle that includes the mapping, if applicable.
bundleVersionStringVersion of the bundle that includes the mapping, if applicable.
templateIdStringID of the template created internally to represent the mapping.
deployTimeTime the mapping was deployed.
hasParametersIndicates if the mapping includes parameters. Returns true or false.
validIndicates if the mapping is valid. Returns true or false.
fixedConnectionIndicates if the mapping is valid. Returns true or false.
hasParametersDeployedIndicates if the mapping has fixed connections. Returns true or false.
fixedConnectionDeployedIndicates if the mapping has fixed connections. Returns true or false.
deployedTemplateIdStringID of the template created internally to represent the deployed mapping.
tasksNumber of tasks that use the mapping.
parametersParameters used in the mapping. Includes an mtTaskParameter object for each parameter.
idIncluded in the mtTaskParameter object.
Parameter ID.
nameStringIncluded in the mtTaskParameter object.
Parameter name.
typeStringIncluded in the mtTaskParameter object.
Parameter type
descriptionStringIncluded in the mtTaskParameter object.
Parameter description.
customFuncIdStringMapplet ID for mapplet type parameters.
uiPropertiesStringIncluded 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.
inOutParametersIn-out parameter used in the mapping. Includes a mtTaskInOutParameter object for each in-out parameter.
idIncluded in the mtTaskInOutParameter object.
Parameter ID
nameStringIncluded in the mtTaskInOutParameter object.
Parameter name.
descriptionStringIncluded in the mtTaskInOutParameter object.
Description of the parameter
initialValueStringIncluded in the mtTaskInOutParameter object.
Initial value for the parameter
datatypeStringIncluded in the mtTaskInOutParameter object.
Data type of the parameter.
precisionStringIncluded in the mtTaskInOutParameter object.
Precision of the parameter.
scaleStringIncluded in the mtTaskInOutParameter object.
Scale of the parameter.
retentionPolicyStringIncluded in the mtTaskInOutParameter object.
Determines when the task retains the current value.
aggregationTypeStringIncluded in the mtTaskInOutParameter object.
Determines the final current value of the parameter when the task run
currentValueStringIncluded in the mtTaskInOutParameter object.
Current value for the parameter
mappingPreviewFileRecordIdStringID of the image file that is used when previewing a mappin
deployedMappingPreviewFileRecordIdStringID of the image file that is used when previewing a deployed mapping.
referencesReference information. Returns the reference object, which includes the following attributes:
refObjectIdStringIncluded in the reference object.
refTypeStringIncluded 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>