Customer List Filters

The labels that are used to identify the filters in the Customer List are translatable. Therefore, before creating any new filter, you must add the standard lookup information for the new filters, which includes both labels and helper text.

New lookup codes should be added to the standard lookup type ORA_UER_CUSTOMER_LIST_FILTERS for filter labels, and lookup codes for helper text should be added to ORA_UER_CUST_LST_HLPER_TEXT.

For information about adding new lookup codes, see Create and Edit Lookups.

Note:

Before you begin, complete the steps listed in Generate the Access Token.

Use the code samples in this table to create, modify, or delete filters and sub-filters:

Task Configuration
Create a new filter

API: https://<HOST>:<PORT>/api/CXIPlatformService/v1/CXIReferenceEntity/customerListFilters

Method: POST

Payload:

{
    "items": [
        {
            "operation": "create",
            "data": {
                "id": "<Unique ID>",
                "name": "<Name of the filter>", // Eg. Name
                "label": "<Lookup code>" // Newly created lookup code
                "targetSystem": "<Target System>", // Eg. CX, CCS. CX if it is fusion
                "helperText": "<Helper Text Lookup code>" // Newly created lookup code
                "value": "<Query>", // API query
                
            }
        }
    ]
}
Example Payload:
{
    "items": [
        {
            "operation": "create",
            "data": {
                "id": "ORA_CLF_NAME_NAME",
                "name": "Name",
                "label": "ORA_UER_NAME",
                "targetSystem": "CX",
                "helperText": "ORA_UER_NAME_HELPER_TXT",
                "value": "{\"op\":\"$co\",\"attribute\":\"PartyName\",\"value\":\"${value?replace(' ', '*')}\"}"
            }
        }
    ]
}
Create a new sub-filter

API: https://<HOST>:<PORT>/api/CXIPlatformService/v1/CXIReferenceEntity/customerListFilters/<Filter ID>/child/customerListSubFilters

Method: POST

Payload:

{
    "items": [
        {
            "operation": "create",
            "data": {
                "id": "<Unique ID>",
                "name": "<Name of the filter>", // Eg. Name
                "targetSystem": "<Target System>", // Eg. CX, CCS. CX if it is fusion
                "helperText": "<Helper Text Lookup code>" // Newly created lookup code
                "value": "<Query>", // API query
                "label": "<Lookup code>" // Newly create lookup code
            }
        }
    ]
}
Example Payload:
{
    "items": [
        {
            "operation": "create",
            "data": {
                "id": "ORA_CLF_SUB_CNTCT_NAME",
                "name": "ContactName",
                "targetSystem": "CX",
                "helperText": "ORA_UER_PRI_ACC_NMBR_HLPR_TXT",
                "value": "{\"op\":\"$co\",\"attribute\":\"PrimaryContact.PartyName\",\"value\":\"${value}\"}",
                "label": "ORA_UER_PRIOR_ACC_NUMBER"
            }
        }
    ]
}
Modify a filter

API: https://<HOST>:<PORT>/api/CXIPlatformService/v1/CXIReferenceEntity/customerListFilters

Method: POST

Payload:

{
    "items": [
        {
            "operation": "update",
            "data": {
                "id": "<Filter ID to be modified>" // Mandatory
                "value": "<New Query>", // Sample field to be modified
            }
        }
    ]
}
Example Payload:
{
    "items": [
        {
            "operation": "update",
            "data": {
                "id": "ORA_CLF_NAME_NAME",
                "value": "{\"op\":\"$co\",\"attribute\":\"PartyNameNew\",\"value\":\"${value}\"}",
            }
        }
    ]
}
Modify a sub-filter

API: https://<HOST>:<PORT>/api/CXIPlatformService/v1/CXIReferenceEntity/customerListFilters/<Filter ID>/child/customerListSubFilters

Method: POST

Payload:

{
    "items": [
        {
            "operation": "update",
            "data": {
                "id": "<Filter ID to be modified>", // Mandatory
                "value": "<New Query>", // Sample field to be modified
            }
        }
    ]
}
Example Payload:
{
    "items": [
        {
            "operation": "update",
            "data": {
                "id": "ORA_CLF_SUB_CNTCT_NAME",
                "value": "{\"op\":\"$co\",\"attribute\":\"PrimaryContact.PartyNameNew\",\"value\":\"${value}\"}"
            }
        }
    ]
}
Delete a filter

API: https://<HOST>:<PORT>/api/CXIPlatformService/v1/CXIReferenceEntity/customerListFilters

Method: POST

Payload:

{
    "items": [
        {
            "operation": "delete",
            "data": {
                "id": "<ID of the filter to be deleted>" // Mandatory
            }
        }
    ]
}
Example Payload:
{
    "items": [
        {
            "operation": "delete",
            "data": {
                "id": "ORA_CLF_NAME_NAME"
            }
        }
    ]
}
Delete a sub-filter

API: https://<HOST>:<PORT>/api/CXIPlatformService/v1/CXIReferenceEntity/customerListFilters/<Filter ID>/child/customerListSubFilters

Method: POST

Payload:

{
    "items": [
        {
            "operation": "delete",
            "data": {
                "id": "<ID of the sub-filter to be deleted>" // Mandatory
            }
        }
    ]
}
Example Payload:
{
    "items": [
        {
            "operation": "delete",
            "data": {
                "id": "ORA_CLF_SUB_CNTCT_NAME"
            }
        }
    ]
}

Parent topic: View, Edit and Add Reference Types