REST API Reference

Back Next

Creating a hierarchical mapper

To create a hierarchical mapper, send a POST request and specify the hierarchical mapper details.

POST request

Use the following URI to create the hierarchical mapper:

/h2h/api/v1/create/<hierarchical mapper ID>

The following table describes the fields in the POST request:

Field	Type	Description
name	String	Name of the hierarchical mapper.
description	String	Description of the hierarchical mapper.
projectName	String	Project where you want to save the hierarchical mapper.
projectFolderPath	String	Folder within the project where you want to save the hierarchical mapper.
sourceXsd	String	Source XSD file, such as EDI832__20190322_140316.xsd
sourceXsdDependencies	Array	List of dependencies for the source XSD file.
targetXsd	String	Target XSD file, such as X12_4010_810.xsd
targetXsdDependencies	Array	List of dependencies for the target XSD file.
sourceRoot	String	Name of the root element in the source.
targetRoot	String	Name of the root element in the target.
variables		Details about variables. The variables object includes the name, type, list indicator, and initial value.
name	String	Variable name.
type	String	Variable data type.
list	Boolean	True or false.
initialValue	String	Initial value of the variable.
statements	String	Comma-separated list of statements in the hierarchical mapper.
encodedService	String	Base64-encoded ZIP file that contains the source and target XSD files for the source and target schemas, as well as the dependencies of those XSD files.

POST response

If successful, the API creates the hierarchical mapper.

POST request example

The following example shows a request to create a hierarchical mapper:

POST <serverUrl>/h2h/api/v1/service/create
IDS-SESSION-ID: 689EaCniaW9b0YgwET5DwU
Content-Type: application/json

{
    "name": "MigAsset2",
    "description": "Migrated service",
    "projectName": "Interfor_Mapping",
    "projectFolderPath": "C:_Informatica_XMap_Interfor",
    "sourceXsd": "EDI_810_0_2_0_2_0_0.xsd",
    "sourceXsdDependencies": [],
    "targetXsd": "X12_4010_810_schema_restricted_0_0_0_1_0_0_0_0_0_1.xsd",
    "targetXsdDependencies": [
        "X12_4010_810_schema_segments_restricted_0_1_0_2_0_1_0_1_0_2.xsd"
    ],
    "sourceRoot": "DTedi810",
    "targetRoot": "x12:interchanges",
    "variables": [
        {
            "name": "IT_CTR",
            "type": "xs:integer",
            "list": false,
            "initalValue": "0"
        },
        {
            "name": "CTT_1",
            "type": "xs:integer",
            "list": false,
            "initalValue": "0"
        }
    ],
    "statements": "[{\"output\":\"interchange/x12:TS_810\",\"mode\":\"Add\",\"input\":\".\",\"onFail\":\"propagate\",\"statementType\":\"Group\",\"name\":\"INPUT_LOOP\",\"skip\":true,\"statements\":[{\"output\":\"ST\",\"mode\":\"Add\",\"input\":\"InvoiceHeader\",\"onFail\":\"Skip\",\"statementType\":\"Group\",\"name\":\"ST\",\"skip\":true,\"statements\":[{\"output\":\"R01\",\"mode\":\"Add\",\"input\":\"'810'\",\"onFail\":\"propagate\",\"statementType\":\"Map\",\"name\":\"1\",\"skip\":false,\"statements\":[],\"statementNumber\":3},{\"output\":\"R02\",\"mode\":\"Add\",\"input\":\"invNum\",\"onFail\":\"propagate\",\"statementType\":\"Map\",\"name\":\"2- for now it's default value\",\"skip\":false,\"statements\":[],\"statementNumber\":4}],\"statementNumber\":2},{\"output\":\"BIG\",\"mode\":\"Add\",\"input\":\"InvoiceHeader\",\"onFail\":\"Skip\",\"statementType\":\"Group\",\"name\":\"BIG\",\"skip\":true,\"statements\":[{\"output\":\"R01\",\"mode\":\"Add\",\"input\":\"replace(invDate,'-','')\",\"onFail\":\"propagate\",\"statementType\":\"Map\",\"name\":\"1\",\"skip\":false,\"statements\":[],\"statementNumber\":6},{\"output\":\"R02\",\"mode\":\"Add\",\"input\":\"invNum\",\"onFail\":\"propagate\",\"statementType\":\"Map\",\"name\":\"2\",\"skip\":false,\"statementNumber\":7},[...]",
    "encodedService": "UEsDBBQACAgIALiUSlkAAAAAAAAAAAAAAAAdAAAAb[...]"
}

The statement and encoded service values are truncated for brevity.

Hierarchical mappers

Download Guide

Watch

Comments

Cloud Data Integration Homepage