1. REST API for Oracle Commerce Cloud 22C
  2. Tasks
  3. Admin
  4. A/B Test Campaigns

updateABTestCampaign

put

/ccadmin/v1/abTestCampaigns/{abTestCampaignId}

This operation is used to update the A/B Test Campaign with action mapping data.

Request

Supported Media Types
Path Parameters
Body ()
Root Schema : updateABTestCampaign_request
Type: object
Show Source
Nested Schema : actions
Type: array
The actions associated with the A/B Test Campaign.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : mappings
Type: array
Mappings associated with this action.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : mappingValue
Type: object
The value for the mapping.
Show Source
Nested Schema : conditions
Type: array
The conditions used to determine if a match occurs.
Show Source
Nested Schema : ids
Type: array
The list of item ids to match.
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top

Response

Supported Media Types

200 Response

The following model is returned when operation succeeds.
Body ()
Root Schema : updateABTestCampaign_response
Type: object
Show Source
Nested Schema : actions
Type: array
The actions associated with the A/B Test Campaign.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : mappings
Type: array
Mappings associated with this action. This array can only contain one value.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : mappingValue
Type: object
The value for the mapping.
Show Source
Nested Schema : conditions
Type: array
The conditions used to determine if a match occurs. Optional. Only required when the mappingType is productPageConditions or collectionPageConditions. Can't be empty.
Show Source
Nested Schema : ids
Type: array
The list of item ids to match. Optional. Only required when the mappingType is productPage or collectionPage. Can't be empty.
Show Source
Nested Schema : items
Type: object
Show Source
Example Response (application/json)
{
    "updatedAtExternal":"2022-04-12T20:23:34.000Z",
    "publishedAtExternal":null,
    "name":"Chucks SS Test Campaign 2",
    "links":[
        {
            "rel":"overview",
            "href":"https://cb-eu.maxymiser.com/campaignBuilder/2381/93872"
        },
        {
            "rel":"self",
            "href":"http://localhost:9080/ccadminui/v1/abTestCampaigns/MDkzODcy"
        }
    ],
    "state":"Implementing",
    "id":"MDkzODcy",
    "actions":[
        {
            "actionType":"Sales_Amount",
            "mappings":[
            ],
            "isPrimary":true,
            "name":"SA1",
            "description":null,
            "id":"200012"
        },
        {
            "actionType":"Page_Impressions",
            "mappings":[
                {
                    "mappingId":"500005",
                    "mappingValue":{
                        "value":"aboutUs",
                        "operator":"startswith"
                    },
                    "mappingType":"pageUrl"
                }
            ],
            "isPrimary":false,
            "name":"View1",
            "description":null,
            "id":"200013"
        },
        {
            "actionType":"Page_Impressions",
            "mappings":[
                {
                    "mappingId":"500006",
                    "mappingValue":{
                        "itemType":"category",
                        "conditions":[
                            {
                                "property":"displayName",
                                "locale":"en",
                                "value":"collectionName",
                                "operator":"eq"
                            },
                            {
                                "property":"id",
                                "value":[
                                    "id1",
                                    "id2",
                                    "id3"
                                ],
                                "operator":"isoneof"
                            },
                            {
                                "property":"description",
                                "operator":"exists"
                            },
                            {
                                "property":"description",
                                "locale":"en",
                                "value":"Home",
                                "operator":"contains"
                            }
                        ],
                        "operator":"all"
                    },
                    "mappingType":"collectionPageConditions"
                }
            ],
            "isPrimary":false,
            "name":"View2 Renamed",
            "description":null,
            "id":"200016"
        },
        {
            "actionType":"Sales_Quantity",
            "mappings":[
            ],
            "isPrimary":false,
            "name":"SQ1",
            "description":null,
            "id":"200015"
        }
    ],
    "campaignLastEditedInternal":"2022-04-14T16:49:24.250Z"
}

412 Response

ETag mismatch. Asset has been updated by another user.

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| |------------------|------------------| |41000|There is no A/B Test Campaign with specified ID.| |41047|An error occurred while trying to sync the A/B Test Campaign.| |41006|A/B Test Campaign ID is null.| |41003|A/B Test Campaign repository has not been initialized.| |41014|Unable to update an A/B Test Campaign with because it doesn't exist.| |41015|Actions object in A/B Test Campaign data is either null or is not in the form of a List.| |41016|An element in the actions object is not in the form of a Map.| |41043|The action ID is invalid because it does not exist within campaign.| |41041|Mappings in action "{0}" are not in the form of a List or are null.| |41007|An error occurred while trying to access the A/B Test Campaign repository.| |41032|Missing action mapping.| |41033|Missing action mapping value.| |41034|The collection can not be empty.| |41035|Property data type not recognized.| |41036|Invalid catalog rule operator key.| |41037|The condition value is invalid for the operator.|
Body ()
Root Schema : errorModel
Type: object
Show Source
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top