Jump to

• Request
• Response
• Examples

Create/update mapping

put

/api/{version}/mapping

Versions Supported:

v4

Request

There are no request parameters for this operation.

Supported Media Types

• application/xml; charset=UTF-8
• application/json; charset=UTF-8

Request Body - application/xml; charset=UTF-8 ()

Mapping details to be added or modified.

Root Schema : schema

Type: object

Show Source

• createdBy(optional): integer(int64)
• createdOn(optional): object createdOn
• editable(optional): string
• hasCompanyAttributes(optional): string
• isdefault(optional): boolean
• mapAttribute(optional): array mapAttribute
• mapDesc(optional): string
• mapId(optional): integer(int64)
• mapMode(optional): string
• mapName(optional): string
• mapType(optional): string
• modifiedBy(optional): integer(int64)
• modifiedOn(optional): object modifiedOn
• objectType(optional): string

{
    "properties":{
        "createdBy":{
            "format":"int64",
            "type":"integer"
        },
        "createdOn":{
            "type":"object"
        },
        "editable":{
            "type":"string"
        },
        "hasCompanyAttributes":{
            "type":"string"
        },
        "isdefault":{
            "type":"boolean"
        },
        "mapAttribute":{
            "items":{
                "$ref":"#/components/schemas/MappingAttributes"
            },
            "type":"array"
        },
        "mapDesc":{
            "type":"string"
        },
        "mapId":{
            "format":"int64",
            "type":"integer"
        },
        "mapMode":{
            "type":"string"
        },
        "mapName":{
            "type":"string"
        },
        "mapType":{
            "type":"string"
        },
        "modifiedBy":{
            "format":"int64",
            "type":"integer"
        },
        "modifiedOn":{
            "type":"object"
        },
        "objectType":{
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : createdOn

Type: object

Nested Schema : mapAttribute

Type: array

Show Source

• Array of: object MappingAttributes

{
    "items":{
        "$ref":"#/components/schemas/MappingAttributes"
    },
    "type":"array"
}

Nested Schema : modifiedOn

Type: object

Nested Schema : MappingAttributes

Type: object

Show Source

• active(optional): string
• daasAttributeDesc(optional): string
• daasAttributeDisp(optional): string
• daasAttributeId(optional): integer(int64)
• daasAttributeMsgKey(optional): string
• daasAttributeName(optional): string
• daasAttributeType(optional): string
• daasObjectName(optional): string
• enrichRuleName(optional): string
• groups(optional): integer(int64)
• outputHeaderName(optional): string
• sortOrder(optional): integer(int64)
• sourceArributeType(optional): string
• sourceAttributeDisp(optional): string
• sourceAttributeId(optional): integer(int64)
• sourceAttributeMsgKey(optional): string
• sourceAttributeName(optional): string
• sourceAttributeType(optional): string
• sourceObjectName(optional): string
• targetArributeType(optional): string
• targetAttributeDisp(optional): string
• targetAttributeDisplayName(optional): string
• targetAttributeId(optional): integer(int64)
• targetAttributeMsgKey(optional): string
• targetAttributeName(optional): string
• targetAttributeType(optional): string
• targetObjectName(optional): string

{
    "properties":{
        "active":{
            "type":"string"
        },
        "daasAttributeDesc":{
            "type":"string"
        },
        "daasAttributeDisp":{
            "type":"string"
        },
        "daasAttributeId":{
            "format":"int64",
            "type":"integer"
        },
        "daasAttributeMsgKey":{
            "type":"string"
        },
        "daasAttributeName":{
            "type":"string"
        },
        "daasAttributeType":{
            "type":"string"
        },
        "daasObjectName":{
            "type":"string"
        },
        "enrichRuleName":{
            "type":"string"
        },
        "groups":{
            "format":"int64",
            "type":"integer"
        },
        "outputHeaderName":{
            "type":"string"
        },
        "sortOrder":{
            "format":"int64",
            "type":"integer"
        },
        "sourceArributeType":{
            "type":"string"
        },
        "sourceAttributeDisp":{
            "type":"string"
        },
        "sourceAttributeId":{
            "format":"int64",
            "type":"integer"
        },
        "sourceAttributeMsgKey":{
            "type":"string"
        },
        "sourceAttributeName":{
            "type":"string"
        },
        "sourceAttributeType":{
            "type":"string"
        },
        "sourceObjectName":{
            "type":"string"
        },
        "targetArributeType":{
            "type":"string"
        },
        "targetAttributeDisp":{
            "type":"string"
        },
        "targetAttributeDisplayName":{
            "type":"string"
        },
        "targetAttributeId":{
            "format":"int64",
            "type":"integer"
        },
        "targetAttributeMsgKey":{
            "type":"string"
        },
        "targetAttributeName":{
            "type":"string"
        },
        "targetAttributeType":{
            "type":"string"
        },
        "targetObjectName":{
            "type":"string"
        }
    },
    "type":"object"
}

Request Body - application/json; charset=UTF-8 ()

Mapping details to be added or modified.

Root Schema : schema

Type: object

Show Source

• createdBy(optional): integer(int64)
• createdOn(optional): object createdOn
• editable(optional): string
• hasCompanyAttributes(optional): string
• isdefault(optional): boolean
• mapAttribute(optional): array mapAttribute
• mapDesc(optional): string
• mapId(optional): integer(int64)
• mapMode(optional): string
• mapName(optional): string
• mapType(optional): string
• modifiedBy(optional): integer(int64)
• modifiedOn(optional): object modifiedOn
• objectType(optional): string

{
    "properties":{
        "createdBy":{
            "format":"int64",
            "type":"integer"
        },
        "createdOn":{
            "type":"object"
        },
        "editable":{
            "type":"string"
        },
        "hasCompanyAttributes":{
            "type":"string"
        },
        "isdefault":{
            "type":"boolean"
        },
        "mapAttribute":{
            "items":{
                "$ref":"#/components/schemas/MappingAttributes"
            },
            "type":"array"
        },
        "mapDesc":{
            "type":"string"
        },
        "mapId":{
            "format":"int64",
            "type":"integer"
        },
        "mapMode":{
            "type":"string"
        },
        "mapName":{
            "type":"string"
        },
        "mapType":{
            "type":"string"
        },
        "modifiedBy":{
            "format":"int64",
            "type":"integer"
        },
        "modifiedOn":{
            "type":"object"
        },
        "objectType":{
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : createdOn

Type: object

Nested Schema : mapAttribute

Type: array

Show Source

• Array of: object MappingAttributes

{
    "items":{
        "$ref":"#/components/schemas/MappingAttributes"
    },
    "type":"array"
}

Nested Schema : modifiedOn

Type: object

Nested Schema : MappingAttributes

Type: object

Show Source

• active(optional): string
• daasAttributeDesc(optional): string
• daasAttributeDisp(optional): string
• daasAttributeId(optional): integer(int64)
• daasAttributeMsgKey(optional): string
• daasAttributeName(optional): string
• daasAttributeType(optional): string
• daasObjectName(optional): string
• enrichRuleName(optional): string
• groups(optional): integer(int64)
• outputHeaderName(optional): string
• sortOrder(optional): integer(int64)
• sourceArributeType(optional): string
• sourceAttributeDisp(optional): string
• sourceAttributeId(optional): integer(int64)
• sourceAttributeMsgKey(optional): string
• sourceAttributeName(optional): string
• sourceAttributeType(optional): string
• sourceObjectName(optional): string
• targetArributeType(optional): string
• targetAttributeDisp(optional): string
• targetAttributeDisplayName(optional): string
• targetAttributeId(optional): integer(int64)
• targetAttributeMsgKey(optional): string
• targetAttributeName(optional): string
• targetAttributeType(optional): string
• targetObjectName(optional): string

{
    "properties":{
        "active":{
            "type":"string"
        },
        "daasAttributeDesc":{
            "type":"string"
        },
        "daasAttributeDisp":{
            "type":"string"
        },
        "daasAttributeId":{
            "format":"int64",
            "type":"integer"
        },
        "daasAttributeMsgKey":{
            "type":"string"
        },
        "daasAttributeName":{
            "type":"string"
        },
        "daasAttributeType":{
            "type":"string"
        },
        "daasObjectName":{
            "type":"string"
        },
        "enrichRuleName":{
            "type":"string"
        },
        "groups":{
            "format":"int64",
            "type":"integer"
        },
        "outputHeaderName":{
            "type":"string"
        },
        "sortOrder":{
            "format":"int64",
            "type":"integer"
        },
        "sourceArributeType":{
            "type":"string"
        },
        "sourceAttributeDisp":{
            "type":"string"
        },
        "sourceAttributeId":{
            "format":"int64",
            "type":"integer"
        },
        "sourceAttributeMsgKey":{
            "type":"string"
        },
        "sourceAttributeName":{
            "type":"string"
        },
        "sourceAttributeType":{
            "type":"string"
        },
        "sourceObjectName":{
            "type":"string"
        },
        "targetArributeType":{
            "type":"string"
        },
        "targetAttributeDisp":{
            "type":"string"
        },
        "targetAttributeDisplayName":{
            "type":"string"
        },
        "targetAttributeId":{
            "format":"int64",
            "type":"integer"
        },
        "targetAttributeMsgKey":{
            "type":"string"
        },
        "targetAttributeName":{
            "type":"string"
        },
        "targetAttributeType":{
            "type":"string"
        },
        "targetObjectName":{
            "type":"string"
        }
    },
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/xml; charset=UTF-8
• application/json; charset=UTF-8

200 Response

Success

Body ()

Root Schema : schema

Type: object

Mapping details.

Show Source

• createdBy(optional): integer(int64)
• createdOn(optional): object createdOn
• editable(optional): string
• hasCompanyAttributes(optional): string
• isdefault(optional): boolean
• mapAttribute(optional): array mapAttribute
• mapDesc(optional): string
• mapId(optional): integer(int64)
• mapMode(optional): string
• mapName(optional): string
• mapType(optional): string
• modifiedBy(optional): integer(int64)
• modifiedOn(optional): object modifiedOn
• objectType(optional): string

{
    "properties":{
        "createdBy":{
            "format":"int64",
            "type":"integer"
        },
        "createdOn":{
            "type":"object"
        },
        "editable":{
            "type":"string"
        },
        "hasCompanyAttributes":{
            "type":"string"
        },
        "isdefault":{
            "type":"boolean"
        },
        "mapAttribute":{
            "items":{
                "$ref":"#/components/schemas/MappingAttributes"
            },
            "type":"array"
        },
        "mapDesc":{
            "type":"string"
        },
        "mapId":{
            "format":"int64",
            "type":"integer"
        },
        "mapMode":{
            "type":"string"
        },
        "mapName":{
            "type":"string"
        },
        "mapType":{
            "type":"string"
        },
        "modifiedBy":{
            "format":"int64",
            "type":"integer"
        },
        "modifiedOn":{
            "type":"object"
        },
        "objectType":{
            "type":"string"
        }
    },
    "description":"Mapping details.",
    "type":"object"
}

Nested Schema : createdOn

Type: object

Nested Schema : mapAttribute

Type: array

Show Source

• Array of: object MappingAttributes

{
    "items":{
        "$ref":"#/components/schemas/MappingAttributes"
    },
    "type":"array"
}

Nested Schema : modifiedOn

Type: object

Nested Schema : MappingAttributes

Type: object

Show Source

• active(optional): string
• daasAttributeDesc(optional): string
• daasAttributeDisp(optional): string
• daasAttributeId(optional): integer(int64)
• daasAttributeMsgKey(optional): string
• daasAttributeName(optional): string
• daasAttributeType(optional): string
• daasObjectName(optional): string
• enrichRuleName(optional): string
• groups(optional): integer(int64)
• outputHeaderName(optional): string
• sortOrder(optional): integer(int64)
• sourceArributeType(optional): string
• sourceAttributeDisp(optional): string
• sourceAttributeId(optional): integer(int64)
• sourceAttributeMsgKey(optional): string
• sourceAttributeName(optional): string
• sourceAttributeType(optional): string
• sourceObjectName(optional): string
• targetArributeType(optional): string
• targetAttributeDisp(optional): string
• targetAttributeDisplayName(optional): string
• targetAttributeId(optional): integer(int64)
• targetAttributeMsgKey(optional): string
• targetAttributeName(optional): string
• targetAttributeType(optional): string
• targetObjectName(optional): string

{
    "properties":{
        "active":{
            "type":"string"
        },
        "daasAttributeDesc":{
            "type":"string"
        },
        "daasAttributeDisp":{
            "type":"string"
        },
        "daasAttributeId":{
            "format":"int64",
            "type":"integer"
        },
        "daasAttributeMsgKey":{
            "type":"string"
        },
        "daasAttributeName":{
            "type":"string"
        },
        "daasAttributeType":{
            "type":"string"
        },
        "daasObjectName":{
            "type":"string"
        },
        "enrichRuleName":{
            "type":"string"
        },
        "groups":{
            "format":"int64",
            "type":"integer"
        },
        "outputHeaderName":{
            "type":"string"
        },
        "sortOrder":{
            "format":"int64",
            "type":"integer"
        },
        "sourceArributeType":{
            "type":"string"
        },
        "sourceAttributeDisp":{
            "type":"string"
        },
        "sourceAttributeId":{
            "format":"int64",
            "type":"integer"
        },
        "sourceAttributeMsgKey":{
            "type":"string"
        },
        "sourceAttributeName":{
            "type":"string"
        },
        "sourceAttributeType":{
            "type":"string"
        },
        "sourceObjectName":{
            "type":"string"
        },
        "targetArributeType":{
            "type":"string"
        },
        "targetAttributeDisp":{
            "type":"string"
        },
        "targetAttributeDisplayName":{
            "type":"string"
        },
        "targetAttributeId":{
            "format":"int64",
            "type":"integer"
        },
        "targetAttributeMsgKey":{
            "type":"string"
        },
        "targetAttributeName":{
            "type":"string"
        },
        "targetAttributeType":{
            "type":"string"
        },
        "targetObjectName":{
            "type":"string"
        }
    },
    "type":"object"
}

404 Response

Requested resource could not be found.

500 Response

An unexpected error occurred during request.

Back to Top

Examples

Example Request:

/api/v4/mapping/

Example Request Body:

{"mapId":0,"mapName":"ComExpCRMMapTgtImportSRG1427874543362_1589456503233","mapDesc":"Company Export CRM Mapping with Company Daas Attributes and corresponding fusion_Crm_import attributes","mapMode":"CRM","mapType":"Export","editable":"Y","createdBy":0,"modifiedBy":0,"objectType":"Company","mapAttribute":[{"sourceAttributeId":0,"daasAttributeId":"11766","daasAttributeName":"externalId","daasAttributeType":"FIELD","targetAttributeId":10069,"targetAttributeName":"PartyId","enrichRuleName":"UPDATE","sortOrder":0},{"sourceAttributeId":0,"daasAttributeId":"11608","daasAttributeName":"name.tradename","daasAttributeType":"FIELD","targetAttributeId":10070,"targetAttributeName":"PartyOrigSystem","enrichRuleName":"UPDATE","sortOrder":0},{"sourceAttributeId":0,"daasAttributeId":"11605","daasAttributeName":"id","daasAttributeType":"FIELD","targetAttributeId":10071,"targetAttributeName":"PartyOrigSystemReference","enrichRuleName":"UPDATE","sortOrder":0},{"sourceAttributeId":0,"daasAttributeId":"11612","daasAttributeName":"location.city","daasAttributeType":"FIELD","targetAttributeId":10325,"targetAttributeName":"DataCloudStatus","enrichRuleName":"UPDATE","sortOrder":0},{"sourceAttributeId":0,"daasAttributeId":"11633","daasAttributeName":"company.an_sles_cc","daasAttributeType":"FIELD","targetAttributeId":10296,"targetAttributeName":"OrganizationName","enrichRuleName":"UPDATE","sortOrder":0},{"sourceAttributeId":0,"daasAttributeId":"11630","daasAttributeName":"company.sales_volume","daasAttributeType":"FIELD","targetAttributeId":10308,"targetAttributeName":"PrefFunctionalCurrency","enrichRuleName":"UPDATE","sortOrder":0},{"sourceAttributeId":0,"daasAttributeId":"11629","daasAttributeName":"info.fax_number","daasAttributeType":"FIELD","targetAttributeId":10261,"targetAttributeName":"CurrFyPotentialRevenue","enrichRuleName":"UPDATE","sortOrder":0}]}

Example Output:

{"createdBy":"1","createdOn":"2014-03-28 09:37:13.35621","editable":"Y","mapAttribute":[{"daasAttributeDisp":"Business Name","daasAttributeId":"11386","daasAttributeMsgKey":"BUSINESS_NAME","daasAttributeName":"name.display_name","daasAttributeType":"FIELD","daasObjectName":"COMPANY","enrichRuleName":"UPDATE","sortOrder":"1","sourceAttributeDisp":"BusinessName","sourceAttributeId":"0","sourceAttributeName":"BusinessName","targetAttributeId":"0"},{"daasAttributeDisp":"City","daasAttributeId":"11393","daasAttributeMsgKey":"CITY","daasAttributeName":"location.city","daasAttributeType":"FIELD","daasObjectName":"COMPANY","enrichRuleName":"UPDATE","sortOrder":"2","sourceAttributeDisp":"City","sourceAttributeId":"0","sourceAttributeName":"City","targetAttributeId":"0"},{"daasAttributeDesc":"DUNSNumber","daasAttributeDisp":"DUNSNumber","daasAttributeId":"11388","daasAttributeMsgKey":"DUNSNUMBER","daasAttributeName":"company.duns_number","daasAttributeType":"FIELD","daasObjectName":"COMPANY","enrichRuleName":"UPDATE","sortOrder":"3","sourceAttributeDisp":"dunsnumber","sourceAttributeId":"0","sourceAttributeName":"dunsnumber","targetAttributeId":"0"}],"mapId":"10022","mapName":"testCompany1","mapType":"ENRICH","modifiedBy":"1","modifiedOn":"2014-03-28 09:46:25.833645","objectType":"COMPANY"}

Error Response Details:

{"errorMessage":"DCS-3034 : An error occurred while saving the map because input contains an attribute for which attribute type is not specified. Action: Update the input map request and try again"}

Back to Top