Jump to

• Request
• Response
• Examples

Get a list of seeded and custom mappings

get

/api/{version}/mapping/list

Versions Supported:

v4

Request

Query Parameters

• mapmode(required): string
• maptype(required): string
  Map type can be Export or Enrich.
• objecttype(required): string
  Specify 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

list of mappings

Show Source

• mapping: array mapping
• mappings: array mappings

{
    "properties":{
        "mappings":{
            "items":{
                "$ref":"#/components/schemas/Mapping"
            },
            "type":"array"
        },
        "mapping":{
            "items":{
                "$ref":"#/components/schemas/Mapping"
            },
            "type":"array"
        }
    },
    "description":"list of mappings",
    "type":"object"
}

Nested Schema : mapping

Type: array

Show Source

• Array of: object Mapping

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

Nested Schema : mappings

Type: array

Show Source

• Array of: object Mapping

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

Nested Schema : Mapping

Type: object

Show Source

• createdBy: integer (int64)
• createdOn: object createdOn
• editable: string
• hasCompanyAttributes: string
• isdefault: boolean
• mapAttribute: array mapAttribute
• mapDesc: string
• mapId: integer (int64)
• mapMode: string
• mapName: string
• mapType: string
• modifiedBy: integer (int64)
• modifiedOn: object modifiedOn
• objectType: 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: string
• daasAttributeDesc: string
• daasAttributeDisp: string
• daasAttributeId: integer (int64)
• daasAttributeMsgKey: string
• daasAttributeName: string
• daasAttributeType: string
• daasObjectName: string
• enrichRuleName: string
• groups: integer (int64)
• outputHeaderName: string
• sortOrder: integer (int64)
• sourceArributeType: string
• sourceAttributeDisp: string
• sourceAttributeId: integer (int64)
• sourceAttributeMsgKey: string
• sourceAttributeName: string
• sourceAttributeType: string
• sourceObjectName: string
• targetArributeType: string
• targetAttributeDisp: string
• targetAttributeDisplayName: string
• targetAttributeId: integer (int64)
• targetAttributeMsgKey: string
• targetAttributeName: string
• targetAttributeType: string
• targetObjectName: 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 Requests:

/api/v4/mapping/list?objecttype=COMPANY&maptype=enrich
/api/v4/mapping/list?sorttype=CONTACT&maptype=enrich
/api/v4/mapping/list?objecttype=COMPANY&maptype=export
/api/v4/mapping/list?sorttype=CONTACT&maptype=export
/api/v4/mapping/list?sorttype=CONTACT&maptype=export&mapmode=MARKETING_CLOUD

Example Output:

{
"mappings": [{
"createdBy": "0",
"createdOn": "2014-03-21 09:36:39.632337",
"editable": "N",
"mapDesc": "SalesCloudCompanyExport",
"mapId": "10000",
"mapMode": "CRM",
"mapName": "SalesCloudCompanyExport",
"mapType": "EXPORT",
"modifiedBy": "0",
"modifiedOn": "",
"objectType": "COMPANY"
}, {
"createdBy": "0",
"createdOn": "2014-03-21 09:36:39.642353",
"editable": "N",
"mapDesc": "CompanyExport",
"mapId": "10004",
"mapMode": "GENERIC",
"mapName": "CompanyExport",
"mapType": "EXPORT",
"modifiedBy": "0",
"modifiedOn": "",
"objectType": "COMPANY"
}]
}

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