Jump to

• Request
• Response

getABTestCampaignElementVariants

get

/ccadmin/v1/abTestCampaigns/{abTestCampaignId}/elements/{elementId}/variants

Gets a list of variants for the specified element in the specified A/B Test Campaign.

Request

Supported Media Types

• application/json

Path Parameters

• abTestCampaignId(required): string
  The A/B Test Campaign ID.
• elementId(required): string
  The element ID.

Query Parameters

• fields: string
  This controls which fields are returned in the response body. For example, to include the ID and displayName for each variant in the list, you can send fields=items.id,items.displayName.
• limit: integer
  This is the field to specify the number of records to be fetched per REST call.
• offset: integer
  This field specifies the offset/starting index from which data to be fetched.
• q: string
  This field specifies the query used to limit variants.
• sort: string
  This field specifies the sort order of the list to be fetched.
• totalResults: boolean
  Indicates if the total results should be included in the response.

Back to Top

Response

Supported Media Types

• application/json

200 Response

The following model is returned when operation succeeds.

Body ()

Root Schema : getABTestCampaignElementVariants_response

Type: object

Show Source

• items: array items
  The returned list of items.

{
    "properties":{
        "items":{
            "description":"The returned list of items.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "elementId":{
                        "description":"The ID of the element to which this variant belongs.",
                        "type":"string"
                    },
                    "displayName":{
                        "description":"The variant display name.",
                        "type":"string"
                    },
                    "abTestCampaignId":{
                        "description":"The id of the A/B Test Campaign to which this variant belongs.",
                        "type":"string"
                    },
                    "id":{
                        "description":"The ID of the variant.",
                        "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":{
            "elementId":{
                "description":"The ID of the element to which this variant belongs.",
                "type":"string"
            },
            "displayName":{
                "description":"The variant display name.",
                "type":"string"
            },
            "abTestCampaignId":{
                "description":"The id of the A/B Test Campaign to which this variant belongs.",
                "type":"string"
            },
            "id":{
                "description":"The ID of the variant.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• abTestCampaignId: string
  The id of the A/B Test Campaign to which this variant belongs.
• displayName: string
  The variant display name.
• elementId: string
  The ID of the element to which this variant belongs.
• id: string
  The ID of the variant.

{
    "type":"object",
    "properties":{
        "elementId":{
            "description":"The ID of the element to which this variant belongs.",
            "type":"string"
        },
        "displayName":{
            "description":"The variant display name.",
            "type":"string"
        },
        "abTestCampaignId":{
            "description":"The id of the A/B Test Campaign to which this variant belongs.",
            "type":"string"
        },
        "id":{
            "description":"The ID of the variant.",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "total":2,
    "totalResults":2,
    "offset":0,
    "limit":250,
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccadminui/v1/abTestCampaigns/MDkzODcy/elements/MjM5MTgy/variants?actions=%5Bobject%20Object%5D%2C%5Bobject%20Object%5D"
        }
    ],
    "sort":[
        {
            "property":"displayName",
            "order":"asc"
        }
    ],
    "items":[
        {
            "elementId":"MjM5MTgy",
            "displayName":"Default",
            "abTestCampaignId":"MDkzODcy",
            "id":"5MTgyMjM"
        },
        {
            "elementId":"MjM5MTgy",
            "displayName":"E1 - V1",
            "abTestCampaignId":"MDkzODcy",
            "id":"zODcyMDk"
        }
    ]
}

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| |------------------|------------------| |54011|An error occurred querying variants.|

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