The login cookie contains the Authentication token. Leave the cookie field empty
if you are already authenticated, unless you intend to put a token value.
Add the limit parameter, which defines the number of results that will be returned
in the pagination parameter.
Add the offset, which defines the pagination parameter and the starting point from
which results will be returned.
Add the ruleType, which is the parameter to filter rules based on
the Personalization rule type.
Note: As of HCL DX Container Update and CF200,
Personalization Visibility rules and Profiler rule are
supported.
For example:
Response structure details:
The response structure will get the list of all the Visibility and Profiler rules
details. The example below shows the response for one Personalization
rule:
List of Personalization rules in the Personalization interface:In the example API response structure below, the list of Visibility and Profiler
rules available in the Folder created under the Workspace interface is presented:
The following example shows how to execute the Get Personalization Rules List REST
API to return the total list of rules available through the Personalization interface
Workspace and Folder.
parentId is the main attribute to use to find the difference between
the rules available in the Workspace and Folder:
Workspace parentId always starts with a hyphen ("-").
Example:
"parentId": "_6QR_0048AAQUGF0A1T2A_18L"
Folder parentId always starts without a hyphen ("-").
The login cookie contains the Authentication token. Leave the cookie field empty
if you are already authenticated, unless you intend to put a token value.
Obtain the Get Personalization Rule ID details using the REST API GET
all command, as shown in the following example:
Response structure details:
When the GET request is executed by providing the rule-id, the response gets the rule
details.
In the example response structure details below, it shows results
for rule-id, rule-description, rule-title, rule-Type,
and rule-contents:
{
"id": "ce285ec1-af9e-485b-8911-ab454946a104",
"description": "This is Test rule.",
"title": "TestRule",
"ruleType": "Visibility Rule",
"contents":
}
Success and Error Messages:
Error Code
Means
200
This code is returned when the rules details are obtained
successfully.
401
This code is returned when the LtpaToken is invalid or
expired.
403
This code is returned when access is restricted for user.
404
This code is returned when the Rule UUID is not found or invalid.
500
This code is returned when an internal server error occurs.
Invoke (POST) the Personalization ID rule
This API is used to invoke a Personalization rule using rule-id.
The login cookie contains the Authentication token. Leave the cookie field empty
if you are already authenticated, unless you intend to put a token value.
Invoke the Personalization rule as shown in the example below:
Response Structure for Visibility rule:
The response structure presents the details
of ruleId, title, ruleType and result,
as shown below:
For example, the image below shows the use of the API to create a Visibility
Rule ruleType called TestRule with a condition that the
current date is November 16, 2021, and when executed,
the result shows as Show:
When you modify the rule condition of the example from the current date (November 16,
2021) to a different date (November 17, 2021), and when executed,
the result shows as Hide, the response structure is
shown as follows:
Response Structure for Profiler:
The response structure presents the details of ruleID,
title, ruleType, and result, as
shown below:
For example, the image below shows the use of the API to create a Profiler
ruleType called Profile User Example with a condition that
assumes current Weekday is Tuesday, and when executed, the
result shows as an array as Profile 2, the response
structure is as follows:
When you modify the rule to satisfy conditions for multiple profiles and on execution,
the result shows in an array as Profile 1 and Profile
2, the response structure is as follows:
When you modify the rule to satisfy conditions for multiple profiles, but request to
get first profile that satisfies the condition and on execution, the result shows in an
array as Profile 1, the response structure is as follows:
When you modify the rule to not satisfy any condition and on execution, the
result shows in an array as Profile 3, the response
structure is as follows:
When you modify the rule to not satisfy any condition, but you removed the profile
otherwise and on execution, the result shows an empty array as
[], the response structure is as follows:
Success and Error Messages:
Error Code
Means
200
This code is returned when the API is executed with rule result
successfully.
401
This code is returned when the LtpaToken is invalid or
expired.
403
This code is returned access is restricted for users.
404
This code is returned when the Rule UUID is not found or invalid.
500
This code is returned when internal server error occurs.
Create (POST) a new Personalization rule
This API is used to create a new Personalization rule.
The login cookie contains the Authentication token. Leave the cookie field empty
if you are already authenticated, unless you intend to put a token value.
(Required) Provide the title and
ruleType of the new Personalization rule.
(Optional) Provide the description and caseInsensitive
of the mew Personalization rule.
(Optional) Provide the parentId in the location where we
want to create the new Personalization rule in. By default, it will create in
Workspace. Refer to the section below on how to get the parentId.
Provide the contents of the rule. Refer to Personalization API contents
details below for a detailed explanation of contents and its
conditions.
Select the resource and document information as shown below.Figure 1. Go to Applications menu > Personalization > Business rules > resource id
> Document info
Success and Error Messages:
Error Code
Means
200
This code is returned when the Personalization rule is created
successfully.
400
This bad request error code is returned when input parameters are
invalid or missing.
401
This code is returned when the LtpaToken is invalid or
expired.
403
This code is returned when access is restricted for users.
404
This code is returned when you are trying to create a Personalization
rule with an already existing title.
500
This code is returned when internal server error occurs.
Update (PUT) an existing Personalization rule
This API is used to update an existing Personalization rule.
The login cookie contains the Authentication token. Leave the cookie field empty
if you are already authenticated, unless you intend to put a token value.
Provide the Rule-id of the Personalization rule that is to be
updated.
Select the desired ruleType in example request body for
reference.
Provide the key value pairs of the rule which you want to update in the request
body.
Sample request payload for updating a Visibility rule:
Select the resource and document information as shown below.Figure 2. Go to Applications menu > Personalization > Business rules > resource id >
Document info
Note: Updating a ruleType is restricted.
Success and Error Messages:
Error Code
Means
200
This code is returned when the Personalization rule is updated
successfully.
400
This bad request error code is returned when input parameters are invalid
or missing.
401
This code is returned when the LtpaToken is invalid or
expired.
403
This code is returned when access is restricted for users.
404
This code is returned when you are trying to update a Personalization
rule with an already existing title.
500
This code is returned when internal server error occurs.
GET dynamic properties
This API endpoint is used to get dynamic properties from all resource types.
Each dynamic property is represented as an object in each resource type, which includes the
property name (i.e. attr1) and its displayName and
propertyType.
The login cookie contains the Authentication token. Leave the cookie field empty
if you are already authenticated, unless you intend to put a token value.
Get the dynamic properties for a selected resource type using the REST API
GET all command.
For example, the dynamic properties added in one of the resource type
Action Count looks like this:
To get the dynamic properties of the resource type Action Count,
the list of properties is returned in the specific resource type as an
object:
Response for the GET all dynamic properties call, which lists all the properties
created under each resource type, is shown below:
Different types of resource types for dynamic properties comprise of
Action Count, User, Category
Count, Request, Shared Data,
Portlet Attributes, Render Parameter and
Session.
Different types of allowed property types for dynamic properties comprise of
Text, Date, Time,
Timestamp, Number, Decimal
Number, Boolean, List,
Person, and Group.
This code is returned when the list of dynamic properties is obtained
successfully
401
This code is returned when the LtpaToken is invalid or
expired.
403
This code is returned access is restricted for users.
409
This code is returned when the dynamic property you are trying to
update already has an existing property.
500
This code is returned when internal server error occurs.
Update (PUT) dynamic properties
This API endpoint is used to update dynamic properties for all resource types.
You can update the property object, which includes property name (i.e.
attr1) and its displayName and
propertyType in the request payload, along with the ones received from
your GET request.
Note:displayName and propertyType is mandatory for each
dynamic property.
The login cookie contains the Authentication token. Leave the cookie field empty
if you are already authenticated, unless you intend to put a token value.
Add or remove dynamic properties from the payload as mentioned in the example
above.
Response structure details:
Response structure is the same with the response structure for a GET all dynamic
properties API call, which lists all the properties created under each resource
type:
Different types of resource types for dynamic properties comprise of
Action Count, User, Category
Count, Request, Shared Data,
Portlet Attributes, Render Parameter, and
Session.
Different types of allowed property types for dynamic properties comprise of
Text, Date, Time,
Timestamp, Number, Decimal
Number, Boolean, List,
Person, and Group.
The login cookie contains the Authentication token. Leave the cookie field empty
if you are already authenticated, unless you intend to put a token value.
Provide the rule-id of the rule you wish to delete.
For example:
Response Structure Details:
The response structure is a success message that says the rule with the provided ID
is deleted successfully, just like in this example shown
below:
{
"message": rule with id: 880bb281-bb82-489c-a220-56104f0f638d deleted successfully
}
Success and Error Messages:
Error Code
Means
200
This code is returned when the Personalization rule is deleted
successfully.
401
This code is returned when the LtpaToken is invalid or
expired.
403
This code is returned access is restricted for users.
404
This code is returned when the Rule UUID is not found or invalid.
500
This code is returned when internal server error occurs.
To get the dynamic properties of the resource type