Jump to

• Request
• Response
• Examples

Get details for map ID

get

/api/{version}/mapping/{mapId}

Versions Supported:

v4

Request

Path Parameters

• mapId: string
  mapId ID of the map to be retrieved.

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

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/id1

Example Output:

{
"createdBy": "3",
"createdOn": "2014-03-28 09:09:39.787788",
"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"
}],
"mapId": "10253",
"mapName": "testmap",
"mapType": "ENRICH",
"modifiedBy": "3",
"modifiedOn": "2014-03-28 09:09:39.787788",
"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