Filtered Lists- A Detailed Walkthrough

Overview

Filtered Lists are lists created with custom-defined criteria containing attributes, operators, and other filters. You associate a list with a business object, a subscriber, and conditions that form your criteria of the list. You can run lists within a business process to easily identify the object records that qualify your criteria and use the lists for specific tasks.

Filtered lists are used in many areas, such as assigning Journeys to a target audience, sending learning recommendations through Grow, and assigning learning based on employment attributes — such as location, business unit, and department — or previous learning completion history.

Security

To enable Filtered Lists, you need to set up Oracle Search with specific indexes existing for all objects (refer to Setup Oracle Search for the details)

To manage lists, you need the HRC_MANAGE_HCM_LISTS_PRIV functional privilege.

To create system lists that are available across the organization, you need the HRC_MANAGE_HCM_SYSTEM_LISTS_PRIV functional privilege.

Navigation

My Client Group>Filtered List

Key Terminology

• Object: Select the category of elements that the list returns. For example, Workers or Learning Items.
• Subscriber: Select the application that the list is used in. For example, use a list to return learning items within the Skills Advisor application. You can create multiple lists with the same subscriber.
• Conditions: Define the criteria that the list uses to return results. You can build a list that uses a criteria set with multiple conditions and operators to suit your business needs.

Filtered List (hcmLists) REST API details

Get Ritwick Chatterjee’s stories in your inbox

Join Medium for free to get updates from this writer.

Remember me for faster sign in

Explanation of Filtered List (hcmLists) REST API End Point

/hcmRestApi/resources/11.13.18.05/hcmLists

Key Attributes

The main attributes used to configure a list include:

• Name: The name of the filtered list.
• ObjectName: The code identifying the type of HCM object the list contains.
• Subscriber: The code identifying the subscriber associated with the list.
• Description: A description of the list’s purpose.
• Active: Indicates whether the list is active, using Y or N.
• ListScope: Defines whether the list is private (USER) or public (PUBLIC).
• OwnerId: The person identifier of the list owner.
• Type: Identifies the extraction method: OSCS, RODS, or RODS_AND_OSCS.
• Criteria: Stores the filter definition as an attachment.

The ListId identifies the list and is used to retrieve or update an individual record.

Use GET to download the existing criteria, POST to create a new list, PUT to add criteria and update attributes, and DELETE to remove the criteria or list.

Retrieve Existing Filtered List (hcmLists) details

https://iazbqy-dev2.fa.ocs.oraclecloud.com/hcmRestApi/resources/11.13.18.05/hcmLists?q=Name='IP Active employee with JC 60409513 in Pine Hill Mill location'

Note down the criteria endpoint from the previous search to retrieve criteria details

https://iazbqy-dev2.fa.ocs.oraclecloud.com/hcmRestApi/resources/11.13.18.05/hcmLists/300000399095824/enclosure/Criteria

Create a New Filtered List (hcmLists)

It's divided into 2 steps. In step 1, we create the body and then in step 2, we add the criteria. Note down the criteria endpoint from step 1 before executing stept 2.

Method : POST
Header
Content-Type:Application/json
Accept:Application/json

Endpoint: https://iazbqy-dev2.fa.ocs.oraclecloud.com/hcmRestApi/resources/11.13.18.05/hcmLists

Body
{
  "Name": "IP Active employee with JC 60409513 in Pine Hill Mill location REST API",
  "Description": "IP Active employee with JC 60409513 in Pine Hill Mill location REST API V1",
  "ObjectName": "WORKER_ASSIGNMENT_EXTRACT",
  "Subscriber": "LEARNING",
  "Active": "Y",
  "ListScope": "PUBLIC",
  "Criteria": ""
}

Method:PUT
EndPoint:https://iazbqy-dev2.fa.ocs.oraclecloud.com/hcmRestApi/resources/11.13.18.05/hcmLists/300000449466361/enclosure/Criteria
Content-Type:application/octet-stream
HeaderBody
{"filters":[{"operator":"is_one_of","name":"JobCode","terms":["300000009260064"]},{"operator":"is_one_of","name":"LocationName","terms":["300000009067063"]},{"operator":"is_one_of","name":"AssignmentUserStatus","terms":["1"]}]}

Conclusion

In this document, I explained how we use Filtered List and REST API payload that we can use to automate the creation and maintenance of Filtered list.