getABTestCampaignElements
get
/ccadmin/v1/abTestCampaigns/{abTestCampaignId}/elements
Gets a list of elements for the specified A/B Test Campaign.
Request
Supported Media Types
- application/json
Path Parameters
-
abTestCampaignId: string
The A/B Test Campaign ID.
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 element 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 elements.
-
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 : getABTestCampaignElements_response
Type:
Show Source
object
-
items(optional):
array items
The returned list of items.
Nested Schema : items
Type:
Show Source
object
-
description(optional):
string
The description of the A/B Test Campaign Element.
-
id(optional):
string
The ID of the A/B Test Campaign Element.
-
name(optional):
string
The name of the A/B Test Campaign Element.
Example Response (application/json)
{
"total":2,
"totalResults":2,
"offset":0,
"limit":200,
"links":[
{
"rel":"self",
"href":"http://localhost:9080/ccadminui/v1/abTestCampaigns/MDkzODcy/elements?actions=%5Bobject%20Object%5D%2C%5Bobject%20Object%5D"
}
],
"sort":[
{
"property":"displayName",
"order":"asc"
}
],
"items":[
{
"name":"Element1",
"description":"",
"id":"MjM5MTgy"
},
{
"name":"Element2",
"description":"",
"id":"MjM5MTgz"
}
]
}
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:
Show Source
object
-
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
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
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