Get a list of seeded and custom mappings
get
/api/{version}/mapping/list
Versions Supported:
v4
Request
Query Parameters
-
mapmode: string
-
maptype: string
Map type can be Export or Enrich.
-
objecttype: string
Specify type of object; for example, company or contact.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/xml; charset=UTF-8
- application/json; charset=UTF-8
200 Response
Success
Nested Schema : Mapping
Type:
Show Source
object
-
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
Nested Schema : createdOn
Type:
object
Nested Schema : modifiedOn
Type:
object
Nested Schema : MappingAttributes
Type:
Show Source
object
-
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
404 Response
Requested resource could not be found.
500 Response
An unexpected error occurred during request.
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