Jump to

• Request
• Response

listEnrichmentMaps

get

/ccadmin/v1/enrichmentMaps

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

Request

Supported Media Types

• application/json

Header Parameters

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : listEnrichmentMaps_response

Type: object

Show Source

• items: array items
  The returned list of items.
• limit: integer
  Maximum number of maps to be fetched.
• offset: integer
  The starting index of the returned maps.
• sort: array sort
  The sort used for the returned maps.
• total: integer
  Total number of maps
• totalResults: integer
  Total number of maps

{
    "properties":{
        "total":{
            "description":"Total number of maps",
            "type":"integer"
        },
        "totalResults":{
            "description":"Total number of maps",
            "type":"integer"
        },
        "offset":{
            "description":"The starting index of the returned maps.",
            "type":"integer"
        },
        "limit":{
            "description":"Maximum number of maps to be fetched.",
            "type":"integer"
        },
        "sort":{
            "description":"The sort used for the returned maps.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "property":{
                        "description":"The property sorted on.",
                        "type":"string"
                    },
                    "order":{
                        "description":"The sort order: either asc or desc.",
                        "type":"string"
                    }
                }
            }
        },
        "items":{
            "description":"The returned list of items.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "repositoryId":{
                        "description":"The Id of the map",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: array

The returned list of items.

Show Source

• Array of: object items

{
    "description":"The returned list of items.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "repositoryId":{
                "description":"The Id of the map",
                "type":"string"
            }
        }
    }
}

Nested Schema : sort

Type: array

The sort used for the returned maps.

Show Source

• Array of: object items

{
    "description":"The sort used for the returned maps.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "property":{
                "description":"The property sorted on.",
                "type":"string"
            },
            "order":{
                "description":"The sort order: either asc or desc.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• repositoryId: string
  The Id of the map

{
    "type":"object",
    "properties":{
        "repositoryId":{
            "description":"The Id of the map",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• order: string
  The sort order: either asc or desc.
• property: string
  The property sorted on.

{
    "type":"object",
    "properties":{
        "property":{
            "description":"The property sorted on.",
            "type":"string"
        },
        "order":{
            "description":"The sort order: either asc or desc.",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "total":1,
    "totalResults":1,
    "offset":0,
    "limit":250,
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccadminui/v1/enrichmentMaps"
        }
    ],
    "sort":[
        {
            "property":"id",
            "order":"asc"
        }
    ],
    "items":[
        {
            "repositoryId":"unity-account"
        },
        {
            "repositoryId":"unity-profile"
        }
    ]
}

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

Body ()

Root Schema : errorModel

Type: object

Show Source

• devMessage: string
  An optional non-localized message containing technical information for developers
• errorCode: string
  The numerical code identifying the error
• errors: array errors
  An optional list of errors if multiple errors were encountered
• message: string
  The localized message describing the error
• moreInfo: string
  An optional non-localized message with more information
• o:errorPath: string
  An optional machine readable description of where the error occurred
• status: string
  The HTTP status code
• type: 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: string
  An optional non-localized message containing technical information for developers
• errorCode: string
  The numerical code identifying the error
• message: string
  The localized message describing the error
• moreInfo: string
  An optional non-localized message with more information
• o:errorPath: string
  An optional machine readable description of where the error occurred
• status: 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