REST API for Oracle Commerce Cloud 22D

getABTestCampaigns

get

/ccadmin/v1/abTestCampaigns

Get the list of A/B Test Campaigns.

Request

Supported Media Types

application/json

Query Parameters

fields(optional): string

This controls which fields are returned in the response body. For example, to include the ID and Name for each campaign in the list, you can send fields=items.id,items.name.
limit(optional): integer

This is the field to specify the number of records to be fetched per REST call.
offset(optional): integer

This field specifies the offset/starting index from which data to be fetched.
q(optional): string

This field specifies the query used to limit campaigns.
sort(optional): string

This field specifies the sort order of the list to be fetched.
totalResults(optional): boolean

Indicates if the total results should be included in the response.

Response

Supported Media Types

application/json

200 Response

The following model is returned when operation succeeds.

Root Schema : getABTestCampaigns_response

Type: object

Show Source

items(optional): array items

The returned list of items.

{
    "properties":{
        "items":{
            "description":"The returned list of items.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "updatedAtExternal":{
                        "description":"A string representing the latest update date and time of the A/B Test Campaign in UTC format in the external system.",
                        "type":"string"
                    },
                    "isServerSide":{
                        "description":"A flag that indicates whether the A/B Test Campaign is a server-side one.",
                        "type":"boolean"
                    },
                    "publishedAtExternal":{
                        "description":"An optional string representing the latest publish date and time of the A/B Test Campaign in UTC format in the external system.",
                        "type":"string"
                    },
                    "name":{
                        "description":"The name of the A/B Test Campaign.",
                        "type":"string"
                    },
                    "links":{
                        "description":"Links associated with the A/B Test Campaign, including overview and optionally performance.",
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "rel":{
                                    "description":"The link type.",
                                    "type":"string"
                                },
                                "href":{
                                    "description":"The href for the link.",
                                    "type":"string"
                                }
                            }
                        }
                    },
                    "id":{
                        "description":"The ID of the A/B Test Campaign.",
                        "type":"string"
                    },
                    "state":{
                        "description":"The state of the A/B Test Campaign.\nAllowed Values: [ \"Implementing\", \"NotCollectingData\", \"Live\", \"Paused\", \"Stopped\" ].",
                        "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":{
            "updatedAtExternal":{
                "description":"A string representing the latest update date and time of the A/B Test Campaign in UTC format in the external system.",
                "type":"string"
            },
            "isServerSide":{
                "description":"A flag that indicates whether the A/B Test Campaign is a server-side one.",
                "type":"boolean"
            },
            "publishedAtExternal":{
                "description":"An optional string representing the latest publish date and time of the A/B Test Campaign in UTC format in the external system.",
                "type":"string"
            },
            "name":{
                "description":"The name of the A/B Test Campaign.",
                "type":"string"
            },
            "links":{
                "description":"Links associated with the A/B Test Campaign, including overview and optionally performance.",
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "rel":{
                            "description":"The link type.",
                            "type":"string"
                        },
                        "href":{
                            "description":"The href for the link.",
                            "type":"string"
                        }
                    }
                }
            },
            "id":{
                "description":"The ID of the A/B Test Campaign.",
                "type":"string"
            },
            "state":{
                "description":"The state of the A/B Test Campaign.\nAllowed Values: [ \"Implementing\", \"NotCollectingData\", \"Live\", \"Paused\", \"Stopped\" ].",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

id(optional): string

The ID of the A/B Test Campaign.
isServerSide(optional): boolean

A flag that indicates whether the A/B Test Campaign is a server-side one.
links(optional): array links

Links associated with the A/B Test Campaign, including overview and optionally performance.
name(optional): string

The name of the A/B Test Campaign.
publishedAtExternal(optional): string

An optional string representing the latest publish date and time of the A/B Test Campaign in UTC format in the external system.
state(optional): string

The state of the A/B Test Campaign. Allowed Values: [ "Implementing", "NotCollectingData", "Live", "Paused", "Stopped" ].
updatedAtExternal(optional): string

A string representing the latest update date and time of the A/B Test Campaign in UTC format in the external system.

{
    "type":"object",
    "properties":{
        "updatedAtExternal":{
            "description":"A string representing the latest update date and time of the A/B Test Campaign in UTC format in the external system.",
            "type":"string"
        },
        "isServerSide":{
            "description":"A flag that indicates whether the A/B Test Campaign is a server-side one.",
            "type":"boolean"
        },
        "publishedAtExternal":{
            "description":"An optional string representing the latest publish date and time of the A/B Test Campaign in UTC format in the external system.",
            "type":"string"
        },
        "name":{
            "description":"The name of the A/B Test Campaign.",
            "type":"string"
        },
        "links":{
            "description":"Links associated with the A/B Test Campaign, including overview and optionally performance.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "rel":{
                        "description":"The link type.",
                        "type":"string"
                    },
                    "href":{
                        "description":"The href for the link.",
                        "type":"string"
                    }
                }
            }
        },
        "id":{
            "description":"The ID of the A/B Test Campaign.",
            "type":"string"
        },
        "state":{
            "description":"The state of the A/B Test Campaign.\nAllowed Values: [ \"Implementing\", \"NotCollectingData\", \"Live\", \"Paused\", \"Stopped\" ].",
            "type":"string"
        }
    }
}

Nested Schema : links

Type: array

Links associated with the A/B Test Campaign, including overview and optionally performance.

Show Source

Array of: object items

{
    "description":"Links associated with the A/B Test Campaign, including overview and optionally performance.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "rel":{
                "description":"The link type.",
                "type":"string"
            },
            "href":{
                "description":"The href for the link.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

href(optional): string

The href for the link.
rel(optional): string

The link type.

{
    "type":"object",
    "properties":{
        "rel":{
            "description":"The link type.",
            "type":"string"
        },
        "href":{
            "description":"The href for the link.",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "total":3,
    "totalResults":3,
    "offset":0,
    "limit":200,
    "links":[
        {
            "rel":"campaigns",
            "href":"https://ui-eu.maxymiser.com/CampaignBuilder/site-products_demo_env-com/2381?showListCampaign=true"
        },
        {
            "rel":"self",
            "href":"http://localhost:9080/ccadminui/v1/abTestCampaigns"
        }
    ],
    "sort":[
        {
            "property":"displayName",
            "order":"asc"
        }
    ],
    "items":[
        {
            "updatedAtExternal":"2021-05-10T18:48:19.0000000Z",
            "isServerSide":false,
            "publishedAtExternal":"2021-05-10T18:48:19.0000000Z",
            "name":"Demo4",
            "links":[
                {
                    "rel":"overview",
                    "href":"https://cb-eu.maxymiser.com/campaignBuilder/2381/87797"
                },
                {
                    "rel":"performance",
                    "href":"https://report-eu.maxymiser.com/site-products_demo_env-com/2381/campaign-Demo4/87797/CampaignPerformanceReport"
                }
            ],
            "id":"MDg3Nzk3",
            "state":"Live"
        },
        {
            "updatedAtExternal":"2021-05-17T17:32:50.0000000Z",
            "isServerSide":false,
            "name":"VCS",
            "links":[
                {
                    "rel":"overview",
                    "href":"https://cb-eu.maxymiser.com/campaignBuilder/2381/88927"
                }
            ],
            "id":"MDg4OTI3",
            "state":"Implementing"
        },
        {
            "updatedAtExternal":"2021-12-20T23:08:21.0000000Z",
            "isServerSide":true,
            "name":"Server-side Campaign",
            "links":[
                {
                    "rel":"overview",
                    "href":"https://cb-eu.maxymiser.com/campaignBuilder/2381/88996"
                }
            ],
            "id":"MDg4OTk2",
            "state":"Implementing"
        }
    ]
}

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| |------------------|------------------| |41028|Unable to retrieve OAuth token.| |41026|The Campaign Management URL is not valid.| |60051|Error during Campaign Management request.| |41022|Error during Campaign Management request.| |41044|Failing retried request.|

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