Jump to

• Request
• Response
• Examples

Get default settings for maptype, objecttype and mapMode

get

/api/{version}/mapping/default

Versions Supported

v4

Request

Query Parameters

• mapMode: string
  Map mode can be GENERIC or CRM.
• mapType: string
  Map type can be Export or Enrich.
• objType: string
  Specify the type of object; for example, company or contact.

There's no request body for this operation.

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

Default 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":"Default 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/default?objType=CONTACT&mapType=export&mapMode=Generic
/api/v4/mapping/default?objType=COMPANY&mapType=export&mapMode=Generic

Example Output:

{"createdBy": "0","createdOn": "2014-03-25 08:50:14.890216","editable": "N","mapAttribute": [{
"daasAttributeDisp": "PersonId",
"daasAttributeId": "11498",
"daasAttributeMsgKey": "PERSON_ID",
"daasAttributeName": "id",
"daasAttributeType": "FIELD",
"daasObjectName": "COMPANY_CONTACT",
"enrichRuleName": "UPDATE",
"sortOrder": "1",
"sourceAttributeId": "0",
"targetAttributeId": "0"
}, {
"daasAttributeDisp": "ContactDirectPhone",
"daasAttributeId": "11512",
"daasAttributeMsgKey": "DIRECT_PHONE",
"daasAttributeName": "info.phone_number",
"daasAttributeType": "FIELD",
"daasObjectName": "COMPANY_CONTACT",
"enrichRuleName": "UPDATE",
"sortOrder": "2",
"sourceAttributeId": "0",
"targetAttributeId": "0"
}, {
"daasAttributeDisp": "EmailAddress",
"daasAttributeId": "11513",
"daasAttributeMsgKey": "PRIMARY_EMAIL",
"daasAttributeName": "name.mail",
"daasAttributeType": "FIELD",
"daasObjectName": "COMPANY_CONTACT",
"enrichRuleName": "UPDATE",
"sortOrder": "3",
"sourceAttributeId": "0",
"targetAttributeId": "0"
}, {
"daasAttributeDisp": "CoofficialId",
"daasAttributeId": "11500",
"daasAttributeMsgKey": "COOFFICIAL_ID",
"daasAttributeName": "person.co_official_id",
"daasAttributeType": "FIELD",
"daasObjectName": "COMPANY_CONTACT",
"enrichRuleName": "UPDATE",
"sortOrder": "4",
"sourceAttributeId": "0",
"targetAttributeId": "0"
}, {
"daasAttributeDisp": "ContactWorkPhone",
"daasAttributeId": "11510",
"daasAttributeMsgKey": "COMPANY_PHONE",
"daasAttributeName": "person.company_phone",
"daasAttributeType": "FIELD",
"daasObjectName": "COMPANY_CONTACT",
"enrichRuleName": "UPDATE",
"sortOrder": "5",
"sourceAttributeId": "0",
"targetAttributeId": "0"
}, {
"daasAttributeDisp": "CompanyPhoneExtension",
"daasAttributeId": "11511",
"daasAttributeMsgKey": "COMPANY_PHONE_EXTENSION",
"daasAttributeName": "person.company_phone_extn",
"daasAttributeType": "FIELD",
"daasObjectName": "COMPANY_CONTACT",
"enrichRuleName": "UPDATE",
"sortOrder": "6",
"sourceAttributeId": "0",
"targetAttributeId": "0"
}, {
"daasAttributeDisp": "CompanyRoleId",
"daasAttributeId": "11501",
"daasAttributeMsgKey": "COMPANY_ROLE_ID",
"daasAttributeName": "person.company_role_id",
"daasAttributeType": "FIELD",
"daasObjectName": "COMPANY_CONTACT",
"enrichRuleName": "UPDATE",
"sortOrder": "7",
"sourceAttributeId": "0",
"targetAttributeId": "0"
}, {
"daasAttributeDisp": "MrcCode",
"daasAttributeId": "11509",
"daasAttributeMsgKey": "MRC_CODE",
"daasAttributeName": "person.dnb_mrc_code",
"daasAttributeType": "FIELD",
"daasObjectName": "COMPANY_CONTACT",
"enrichRuleName": "UPDATE",
"sortOrder": "8",
"sourceAttributeId": "0",
"targetAttributeId": "0"
}, {
"daasAttributeDisp": "PremiumProductCode",
"daasAttributeId": "11514",
"daasAttributeMsgKey": "PREMIUM_PRODUCT_CODE",
"daasAttributeName": "person.dnb_premium_product_code",
"daasAttributeType": "FIELD",
"daasObjectName": "COMPANY_CONTACT",
"enrichRuleName": "UPDATE",
"sortOrder": "9",
"sourceAttributeId": "0",
"targetAttributeId": "0"
}, {
"daasAttributeDisp": "FirstName",
"daasAttributeId": "11503",
"daasAttributeMsgKey": "FIRST_NAME",
"daasAttributeName": "person.first_name",
"daasAttributeType": "FIELD",
"daasObjectName": "COMPANY_CONTACT",
"enrichRuleName": "UPDATE",
"sortOrder": "10",
"sourceAttributeId": "0",
"targetAttributeId": "0"
}, {
"daasAttributeDisp": "Gender",
"daasAttributeId": "11506",
"daasAttributeMsgKey": "GENDER",
"daasAttributeName": "person.gender_code",
"daasAttributeType": "FIELD",
"daasObjectName": "COMPANY_CONTACT",
"enrichRuleName": "UPDATE",
"sortOrder": "11",
"sourceAttributeId": "0",
"targetAttributeId": "0"
}, {
"daasAttributeDisp": "LastName",
"daasAttributeId": "11505",
"daasAttributeMsgKey": "LAST_NAME",
"daasAttributeName": "person.last_name",
"daasAttributeType": "FIELD",
"daasObjectName": "COMPANY_CONTACT",
"enrichRuleName": "UPDATE",
"sortOrder": "12",
"sourceAttributeId": "0",
"targetAttributeId": "0"
}, {
"daasAttributeDisp": "MiddleName",
"daasAttributeId": "11504",
"daasAttributeMsgKey": "MIDDLE_NAME",
"daasAttributeName": "person.middle_name",
"daasAttributeType": "FIELD",
"daasObjectName": "COMPANY_CONTACT",
"enrichRuleName": "UPDATE",
"sortOrder": "13",
"sourceAttributeId": "0",
"targetAttributeId": "0"
}, {
"daasAttributeDisp": "Parent DUNSNumber ",
"daasAttributeId": "11499",
"daasAttributeMsgKey": "PARENT_DUNSNUMBER",
"daasAttributeName": "person.parent_duns",
"daasAttributeType": "FIELD",
"daasObjectName": "COMPANY_CONTACT",
"enrichRuleName": "UPDATE",
"sortOrder": "14",
"sourceAttributeId": "0",
"targetAttributeId": "0"
}, {
"daasAttributeDisp": "Prefix",
"daasAttributeId": "11502",
"daasAttributeMsgKey": "PREFIX",
"daasAttributeName": "person.prefix",
"daasAttributeType": "FIELD",
"daasObjectName": "COMPANY_CONTACT",
"enrichRuleName": "UPDATE",
"sortOrder": "15",
"sourceAttributeId": "0",
"targetAttributeId": "0"
}, {
"daasAttributeDisp": "Suffix",
"daasAttributeId": "11507",
"daasAttributeMsgKey": "SUFFIX",
"daasAttributeName": "person.suffix",
"daasAttributeType": "FIELD",
"daasObjectName": "COMPANY_CONTACT",
"enrichRuleName": "UPDATE",
"sortOrder": "16",
"sourceAttributeId": "0",
"targetAttributeId": "0"
}, {
"daasAttributeDisp": "Title",
"daasAttributeId": "11508",
"daasAttributeMsgKey": "TITLE",
"daasAttributeName": "person.title",
"daasAttributeType": "FIELD",
"daasObjectName": "COMPANY_CONTACT",
"enrichRuleName": "UPDATE",
"sortOrder": "17",
"sourceAttributeId": "0",
"targetAttributeId": "0"
}, {
"daasAttributeDisp": "Street Address1",
"daasAttributeId": "11519",
"daasAttributeMsgKey": "STREET_ADDRESS1",
"daasAttributeName": "location.address1",
"daasAttributeType": "FIELD",
"daasObjectName": "COMPANY_CONTACT",
"enrichRuleName": "UPDATE",
"sortOrder": "18",
"sourceAttributeId": "0",
"targetAttributeId": "0"
}, {
"daasAttributeDisp": "City",
"daasAttributeId": "11521",
"daasAttributeMsgKey": "CITY",
"daasAttributeName": "location.city",
"daasAttributeType": "FIELD",
"daasObjectName": "COMPANY_CONTACT",
"enrichRuleName": "UPDATE",
"sortOrder": "19",
"sourceAttributeId": "0",
"targetAttributeId": "0"
}, {
"daasAttributeDisp": "State",
"daasAttributeId": "11522",
"daasAttributeMsgKey": "STATE",
"daasAttributeName": "location.state",
"daasAttributeType": "FIELD",
"daasObjectName": "COMPANY_CONTACT",
"enrichRuleName": "UPDATE",
"sortOrder": "20",
"sourceAttributeId": "0",
"targetAttributeId": "0"
}, {
"daasAttributeDisp": "PostalCode",
"daasAttributeId": "11523",
"daasAttributeMsgKey": "POSTALCODE",
"daasAttributeName": "location.postal_code",
"daasAttributeType": "FIELD",
"daasObjectName": "COMPANY_CONTACT",
"enrichRuleName": "UPDATE",
"sortOrder": "21",
"sourceAttributeId": "0",
"targetAttributeId": "0"
}, {
"daasAttributeDisp": "Country",
"daasAttributeId": "11524",
"daasAttributeMsgKey": "COUNTRY",
"daasAttributeName": "location.country",
"daasAttributeType": "FIELD",
"daasObjectName": "COMPANY_CONTACT",
"enrichRuleName": "UPDATE",
"sortOrder": "22",
"sourceAttributeId": "0",
"targetAttributeId": "0"
}, {
"daasAttributeDisp": "OrganizationName",
"daasAttributeId": "11518",
"daasAttributeMsgKey": "ORGANIZATIONNAME",
"daasAttributeName": "info.organization_name",
"daasAttributeType": "FIELD",
"daasObjectName": "COMPANY_CONTACT",
"enrichRuleName": "UPDATE",
"sortOrder": "23",
"sourceAttributeId": "0",
"targetAttributeId": "0"
}],"mapDesc": "ContactExport","mapId": "10005","mapMode": "GENERIC","mapName": "ContactExport","mapType": "EXPORT","modifiedBy": "0","modifiedOn": "","objectType": "CONTACT"}

Error Response Details:

{"errorMessage": "DCS-1 : The version of the service is not supported. Action: Provide the supported version for accessing the service." }

Back to Top