Search Work Phones

Retrieve the work phone information for a specific worker ID in Workday.

Options

Field	Definition	Type	Required
Result Set	Choose a method to filter search results: First Matching Record: Returns the first record that matches. First 100 Matching Records: Returns the first 100 matching records. Stream Matching Records: Passes all matching records from your parent flow to a helper flow. Selecting this option adds a Streaming input section to the card where you can select a helper flow for streaming and add 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 100 Matching Records: Returns the first 100 matching records.
Stream Matching Records: Passes all matching records from your parent flow to a helper flow.

Selecting this option adds a Streaming input section to the card where you can select a helper flow for streaming and add custom extensible fields.

Dropdown

TRUE

Input

Field	Definition	Type	Required
Search Criteria
Person ID	Unique identifier of the person.	Text	TRUE
Primary Only	If True, the search only returns the person's primary phone numbers.	True/False	FALSE
Public Only	If True, the search only returns the person's public phone numbers.	True/False	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 Record Limit field is set to 0, the stream returns no records. When the Record Limit field is set to greater than 0, the stream returns up to the maximum number specified. When the Record Limit field is empty, null, or not selected, the stream returns all records. The default value is 500000. The valid range is from 0 to 500000. This field appears when you select Stream Matching Records from the Result Set option.	Number	FALSE

Output

Field	Definition	Type
Result
Raw Output	The raw output that Workday returns.	Object
Phone ID	Unique identifier of the phone.	Text
Phone Descriptor	A preview of the item, as described in the Workday object.	Text
Complete Phone Number	The complete phone number.	Text
Extension	The phone extension.	Text
Country Phone Code		Object
Country Phone Code	The phone code for a country.	Text
Country Phone Code ID	The unique identifier for the country phone code.	Text
Country Phone Code Descriptor	A preview of the instance.	Text
Country	The country for the phone code.	Object
Country ID	The unique identifier for the country.	Text
Country Descriptor	A preview of the instance.	Text
Usage		Object
Usage Type	Returns the usage type for a given communication method.	Object
Usage Type ID	The unique identifier of the usage type.	Text
Usage Type Descriptor	A preview of the instance.	Text
Primary	True if the communication method has any primary usage type.	True/False
Public	True if the communication method is public. If no results are returned, the communication method is private.	True/False
Used For	Usage behaviors for the communication method. For example mailing, billing, or shipping.	List of Objects
Used For ID	The unique identifier for the Used For resource.	Text
Used For Descriptor	A preview of the instance.	Text
Device Type		Object
Device Type ID	The unique identifier of the device type.	Text
Device Type Descriptor	A preview of the instance.	Text
Phones	Each object contains the details for an individual work phone. This field appears when you select First 100 Matching Records from the Result Set option.	List of Objects
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 Work Phones

Options

Input

Output

Related topics