Jump to

• Request
• Response

updateEnrichmentMap

put

/ccadmin/v1/enrichmentMaps/{id}

Update the attribute mappings from an external source to an internal item type (profile or account).

Request

Supported Media Types

• application/json

Path Parameters

• id: string
  The ID of the map.

Header Parameters

• X-CCAsset-Language(optional): string
  The asset language of the request.

Body ()

Root Schema : updateEnrichmentMap_request

Type: object

Show Source

• configMap(optional): object configMap
  An array of mappings
• IDGraphRuleName(optional): string
  Name of the IDGraphRule object that has been configured in Unity
• source(optional): string
  Name of the source
• subRuleName(optional): string
  Name of the subRule that has been configured in the DSV in Unity
• target(optional): string
  Name of the target

{
    "properties":{
        "configMap":{
            "description":"An array of mappings",
            "type":"object",
            "properties":{
                "targetName":{
                    "description":"Name of an attribute from the target",
                    "type":"string"
                },
                "sourceType":{
                    "description":"Data type of an attribute from the source",
                    "type":"string"
                },
                "sourceName":{
                    "description":"Name of an attribute from the source",
                    "type":"string"
                }
            }
        },
        "IDGraphRuleName":{
            "description":"Name of the IDGraphRule object that has been configured in Unity",
            "type":"string"
        },
        "source":{
            "description":"Name of the source",
            "type":"string"
        },
        "target":{
            "description":"Name of the target",
            "type":"string"
        },
        "subRuleName":{
            "description":"Name of the subRule that has been configured in the DSV in Unity",
            "type":"string"
        }
    },
    "example":{
        "IDGraphRuleName":"mockIdGraphRuleName1",
        "configMap":[
            {
                "targetName":"numberOfOrders",
                "sourceType":"integer",
                "sourceName":"unity_numberOfOrders"
            },
            {
                "targetName":"email",
                "sourceType":"string",
                "sourceName":"unity_email"
            },
            {
                "targetName":"taxExempt",
                "sourceType":"boolean",
                "sourceName":"unity_taxExempt"
            }
        ],
        "source":"customer",
        "target":"profile",
        "subRuleName":"mockSubRuleName"
    }
}

Example:

{
    "IDGraphRuleName":"mockIdGraphRuleName1",
    "configMap":[
        {
            "targetName":"numberOfOrders",
            "sourceType":"integer",
            "sourceName":"unity_numberOfOrders"
        },
        {
            "targetName":"email",
            "sourceType":"string",
            "sourceName":"unity_email"
        },
        {
            "targetName":"taxExempt",
            "sourceType":"boolean",
            "sourceName":"unity_taxExempt"
        }
    ],
    "source":"customer",
    "target":"profile",
    "subRuleName":"mockSubRuleName"
}

Nested Schema : configMap

Type: object

An array of mappings

Show Source

• sourceName(optional): string
  Name of an attribute from the source
• sourceType(optional): string
  Data type of an attribute from the source
• targetName(optional): string
  Name of an attribute from the target

{
    "description":"An array of mappings",
    "type":"object",
    "properties":{
        "targetName":{
            "description":"Name of an attribute from the target",
            "type":"string"
        },
        "sourceType":{
            "description":"Data type of an attribute from the source",
            "type":"string"
        },
        "sourceName":{
            "description":"Name of an attribute from the source",
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : updateEnrichmentMap_response

Type: object

Show Source

• configMap(optional): object configMap
  An array of mappings
• IDGraphRuleName(optional): string
  Name of the IDGraphRule object that has been configured in Unity
• source(optional): string
  Name of the source
• subRuleName(optional): string
  Name of the subRule that has been configured in the DSV in Unity
• target(optional): string
  Name of the target

{
    "properties":{
        "configMap":{
            "description":"An array of mappings",
            "type":"object",
            "properties":{
                "targetName":{
                    "description":"Name of an attribute from the target",
                    "type":"string"
                },
                "sourceType":{
                    "description":"Data type of an attribute from the source",
                    "type":"string"
                },
                "sourceName":{
                    "description":"Name of an attribute from the source",
                    "type":"string"
                }
            }
        },
        "IDGraphRuleName":{
            "description":"Name of the IDGraphRule object that has been configured in Unity",
            "type":"string"
        },
        "source":{
            "description":"Name of the source",
            "type":"string"
        },
        "target":{
            "description":"Name of the target",
            "type":"string"
        },
        "subRuleName":{
            "description":"Name of the subRule that has been configured in the DSV in Unity",
            "type":"string"
        }
    }
}

Nested Schema : configMap

Type: object

An array of mappings

Show Source

• sourceName(optional): string
  Name of an attribute from the source
• sourceType(optional): string
  Data type of an attribute from the source
• targetName(optional): string
  Name of an attribute from the target

{
    "description":"An array of mappings",
    "type":"object",
    "properties":{
        "targetName":{
            "description":"Name of an attribute from the target",
            "type":"string"
        },
        "sourceType":{
            "description":"Data type of an attribute from the source",
            "type":"string"
        },
        "sourceName":{
            "description":"Name of an attribute from the source",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "IDGraphRuleName":"mockIdGraphRuleName1",
    "configMap":[
        {
            "targetName":"numberOfOrders",
            "sourceType":"integer",
            "targetType":"int",
            "sourceName":"unity_numberOfOrders"
        },
        {
            "targetName":"email",
            "sourceType":"string",
            "targetType":"string",
            "sourceName":"unity_email"
        },
        {
            "targetName":"taxExempt",
            "sourceType":"boolean",
            "targetType":"boolean",
            "sourceName":"unity_taxExempt"
        }
    ],
    "source":"customer",
    "target":"profile",
    "subRuleName":"mockSubRuleName"
}

Default Response

The error response. The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud: |Error Code|Description| |------------------|------------------| |55200|The request was missing the required attribute mapping data in the body.| |55201|An error occurred while trying to access the source attribute data map.| |55202|{0} is not a supported property data type. Supported data types are: {1}.| |55203|{0} is not a supported property data type. Supported data types are: {1}.| |55205|A non-empty profile map ID is required.| |55206|Profile Maps repository is not initialized.| |55207|Unable to find a profile map with id: {0}.| |55208|Corresponding types {0} for source and {1} for target are incompatible. The compatible types are: {2}.| |55209|IDGraph Rule with name {0} does not exist. Please enter an existing IDGraphRule name or create a new one.| |55210|Data Source View object with name {0} does not exist. Please enter an existing DSV name or create a new one.| |55211|Attribute {0} is not in the DSV. Please include it by modifying the DSV object or exclude it from the mapping.| |55212|Subrule with name {0} does not exist. Please enter an existing subRule name or modify the IDGraphRule object with name {1} to include it.| |55213|UnityProfileSyncService was not initialized.|

Body ()

Root Schema : errorModel

Type: object

Show Source

• devMessage(optional): string
  An optional non-localized message containing technical information for developers
• errorCode(optional): string
  The numerical code identifying the error
• errors(optional): array errors
  An optional list of errors if multiple errors were encountered
• message(optional): string
  The localized message describing the error
• moreInfo(optional): string
  An optional non-localized message with more information
• o:errorPath(optional): string
  An optional machine readable description of where the error occurred
• status(optional): string
  The HTTP status code
• type(optional): string
  The URI to the HTTP state code definition

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• devMessage(optional): string
  An optional non-localized message containing technical information for developers
• errorCode(optional): string
  The numerical code identifying the error
• message(optional): string
  The localized message describing the error
• moreInfo(optional): string
  An optional non-localized message with more information
• o:errorPath(optional): string
  An optional machine readable description of where the error occurred
• status(optional): string
  The HTTP status code

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top