Search Workers

Search for worker records in Oracle HCM.

Options

Field	Definition	Type	Required
Result Set	Choose a method to filter search results: First Matching Record: Returns the first record that matches. First 10 Matching Records: Returns the first 10 matching records. Stream Matching Records: Passes all matching records from your parent flow to a helper flow. A Streaming input section is added to the card from which you can select a helper flow for streaming and adding custom extensible fields.	Dropdown	TRUE

Field

Definition

Type

Required

Result Set

Choose a method to filter search results:

First Matching Record: Returns the first record that matches.
First 10 Matching Records: Returns the first 10 matching records.
Stream Matching Records: Passes all matching records from your parent flow to a helper flow. A Streaming input section is added to the card from which you can select a helper flow for streaming and adding custom extensible fields.

Dropdown

TRUE

Input

Field	Definition	Type	Required
Worker
Expand All Fields	Determines whether the card should return data for all fields in the Raw Output. Returning all data can exceed the memory limit for flow execution logs. Set to False if you don't need the Raw Output.	True/False	TRUE
Email Address	Email address of the person.	Text	FALSE
Full Name	Person's full name.	Text	FALSE
Display Name	Person's display name.	Text	FALSE
List Name	Person's listed name.	Text	FALSE
Person Number	A number assigned to a person to uniquely identify them.	Text	FALSE
Person ID	Surrogate identifier for the person.	Number	FALSE
Applicant Number	Applicant number in the external application.	Text	FALSE
Country of Birth	Country of birth of the person. Valid values can be found through the Countries List of Values API.	Text	FALSE
Start Date	Start date of the employment period.	Text	FALSE
Termination Date	Last date of the employment period.	Text	FALSE
Department Name	The name of the department for the worker's assignment. Valid values can be found through the Departments List of Values API.	Text	FALSE
Department ID	A unique identifier for the worker's department.	Number	FALSE
Business Unit Name	The name of the business unit for the worker's assignment. Valid values can be found through the Business Units List of Values API.	Text	FALSE
Business Unit ID	A unique identifier for the business unit of the worker's assignment.	Number	FALSE
Country Code	The country code of the phone number. Valid values can be found through the Countries List of Values API.	Text	FALSE
Custom Search Criteria	Any custom search criteria that you want to add. See the Oracle HCM API documentation.	Text	FALSE
Streaming
Flow	Click Choose Flow to browse and select a helper flow where the search results will be streamed, then click Choose to confirm. Optionally, click the empty field under Click or drop here to create and add custom extensible fields that pass data to the helper flow. These fields are added as key/value pairs under the State output object in the helper flow. This field appears when you select Stream Matching Records from the Result Set option.	Flow	TRUE
Record Limit	Specify the number of records to stream. When the Limit field is set to greater than 0, records greater than 0 and up to the maximum number of records specified are returned. When the Limit field is empty or not selected, all records are streamed. The default value is 50000. The valid range is from 1 through 50000. This field appears when you select Stream Matching Records from the Result Set option.	Number	FALSE

Output

Field	Definition	Type
Result
Workers	Each object contains the details for an individual worker. This field appears when you select First 10 Matching Records from the Result Set option.	List of Objects
Raw Output	The raw output returned by the Oracle HCM API.	Object
Worker ID	This is a hash key of the attributes that make up the composite key for a worker's resource. It's used to uniquely identify an instance of a worker.	Text
Person Number	A number assigned to a person to uniquely identify them.	Text
Person ID	Surrogate identifier for the person.	Number
Applicant Number	Applicant number in the external application.	Text
Correspondence Language	Preferred language for communication. Valid values can be found through the Common Lookups API.	Text
Name Uniq ID	This is a hash key of the attributes that make up the composite key for a name resource. It's used to uniquely identify a worker's name.	Text
First Name	Person's first name.	Text
Last Name	Person's family name.	Text
Middle Names	Person's middle names.	Text
Display Name	Person's display name.	Text
Addresses		List of Objects
Address Uniq ID	This is a hash key of the attributes that make up the composite key for the addresses resource. It's used to uniquely identify an address.	Text
Address Line 1	First line of the primary mail address.	Text
Town or City	Town or city in which the address is located.	Text
Region 1	Primary region in which the address is located.	Text
Region 2	Secondary region within the primary region.	Text
Postal Code	The postal code of the primary mail address.	Text
Country	Country in which the address is located. Valid values can be found through the Countries List of Values API.	Text
Address Type	Type of address. Valid values can be found through the Common Lookups API.	Text
Emails		List of Objects
Email Address ID	Surrogate identifier for the email address of the person.	Number
Email Address	Email address of the person.	Text
Email Type	Type of email, for example work or personal. Valid values can be found through the Common Lookups API.	Text
Other Communication Accounts		List of Objects
Delivery Method ID	This unique key is the person's delivery method identifier.	Number
Account Name	Name of the account.	Text
Provider	Provider of the account, for example Facebook or X. Valid values can be found through the Common Lookups API.	Text
Phones		List of Objects
Phone ID	This unique key is the person's phone identifier.	Number
Country Code Number	The country code of the phone number. Valid values can be found through the Countries List of Values API.	Text
Area Code	Area code of the phone number.	Text
Phone Number	Phone number associated with the Phone Type.	Text
Extension	Extension number for the phone.	Text
Phone Type	Type of phone number, for example Work or Home. Valid values can be found through the Common Lookups API.	Text
Work Relationships		List of Objects
Period of Service ID	This unique key is the person's period of service identifier.	Number
Worker Type	Worker type for the period of service, for example Employee (E), Contingent Worker (C), Pending Worker (P), or Nonworker (N). Valid values can be found through the Common Lookups API.	Text
Worker Number	The unique identifier for the worker.	Text
Assignments		List of Objects
Assignment Uniq ID	This is a hash key of the attributes that make up the composite key for the worker's assignment. It's used to uniquely identify an assignment for a worker.	Text
Business Title	The business title for the worker's assignment.	Text
Business Unit Name	The name of the business unit for the worker's assignment. Valid values can be found through the Business Units List of Values API.	Text
Business Unit ID	A unique identifier for the business unit of the worker's assignment.	Number
Department Name	The name of the department for the worker's assignment. Valid values can be found through the Departments List of Values API.	Text
Department ID	A unique identifier for the worker's department.	Number
Records Streamed	Number of records streamed in a streaming flow. This field appears when you select Stream Matching Records from the Result Set option.	Number

Search Workers

Options

Input

Output

Related topics