listAudienceRuleProperties
get
/ccadmin/v1/audienceRuleProperties
List Audience Rule Properties. Retrieve the properties available for building Audience rules.
Request
Supported Media Types
- application/json
Query Parameters
-
limit(optional): integer
This is the field to specify the number of records to be fetched per REST call. The default value is 40. If limit > 250, the server will convert it to 250 without returning an error.
-
offset(optional): integer
This field specifies the offset/starting index from which data to be fetched. The default is 0.
-
sort(optional): string
This field specifies the sort order of the list to be fetched. The format is <attribute>:<asc|desc>.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : listAudienceRuleProperties_response
Type:
Show Source
object
-
items(optional):
array items
The returned list of items.
-
limit(optional):
integer
Maximum number of results to be fetched.
-
offset(optional):
integer
The starting index of the returned results.
-
totalResults(optional):
integer
The total number of results that match the request parameters.
Nested Schema : items
Type:
Show Source
object
-
category(optional):
string
Either profile or internalAudience. The former indicates that this is a profile property. The latter indicates that this is the special enumList of all the Audiences.
-
categoryDisplayName(optional):
string
Either Profile or Audience. The former indicates that this is a profile property. The latter indicates that this is the special enumList of all the Audiences.
-
displayName(optional):
string
The property display name.
-
enumList(optional):
object enumList
The only Audience rule property of type EnumList in v1 will be the internal Audiences list, which will always appear as a link. This will be null for other types.
-
enums(optional):
array enums
The available choices for enum type properties. This will be null for other types.
-
name(optional):
string
The property name.
-
type(optional):
string
Either String, Enum, EnumList or Boolean.
Nested Schema : enumList
Type:
object
The only Audience rule property of type EnumList in v1 will be the internal Audiences list, which will always appear as a link. This will be null for other types.
Show Source
-
links(optional):
array links
This points to the endpoint which returns the list of options for this enum list.
Nested Schema : enums
Type:
array
The available choices for enum type properties. This will be null for other types.
Show Source
Nested Schema : links
Type:
array
This points to the endpoint which returns the list of options for this enum list.
Show Source
Nested Schema : items
Type:
Show Source
object
-
href(optional):
string
The url of the endpoint to use to get the list of options for this enum list.
-
rel(optional):
string
This will always be self.
Nested Schema : items
Type:
Show Source
object
-
displayName(optional):
string
The display name of the enum option.
-
id(optional):
integer
The id of the enum option.
Example Response (application/json)
{
"totalResults":3,
"offset":0,
"limit":40,
"links":[
{
"rel":"self",
"href":"http://localhost:9080/ccadminui/v1/audienceRuleProperties"
}
],
"items":[
{
"enums":[
{
"displayName":"Female",
"id":"female"
},
{
"displayName":"Male",
"id":"male"
}
],
"displayName":"Gender",
"name":"gender",
"type":"Enum"
},
{
"enums":null,
"displayName":"homeAddress.state",
"name":"homeAddress.state",
"type":"String"
},
{
"enumList":{
"links":[
{
"rel":"self",
"href":"ccadmin/v1/audiences?fields=id,displayName"
}
]
},
"displayName":"Audiences this user must be a member of",
"name":"audienceList",
"source":"internalAudiences",
"type":"EnumList"
}
]
}
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|
|------------------|------------------|
|54001|There was an error retrieving property descriptors from the profile repository.|
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