Search Workers

Retrieve a collection of workers and their current staffing information 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
Include Terminated Workers	Include terminated workers in the output.	True/False	FALSE
Name	Search by the worker's name. The search is case-insensitive.	Text	FALSE
Worker ID	Search by the worker's ID. The search is case-insensitive.	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 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
Worker Resource ID	Unique identifier of the worker.	Text
Worker Resource Descriptor	A preview of the item, as described in the Workday object.	Text
Worker ID	The Employee ID or Contingent Worker ID for the worker.	Text
Primary Job		Object
Job ID	Unique identifier of the job.	Text
Job Descriptor	A preview of the item, as described in the Workday object.	Text
Business Title	The business title for the position.	Text
Supervisory Organization	The supervisory organization for the position.	Object
Supervisory Organization ID	Unique identifier of the supervisory organization.	Text
Supervisory Organization Descriptor	A preview of the item, as described in the Workday object.	Text
Job Type	The position's job type, which can be one of the following values: Primary Additional Job International Assignment If the position isn't effective, the card returns no value. The Primary and Additional Job fields are effective dated, due to the Switch Primary Job business process. An International Assignment can't be switched to a Primary job.	Object
Job Type Descriptor	A preview of the item, as described in the Workday object.	Text
Job Profile	The job profile for the position.	Object
Job Profile ID	Unique identifier of the job profile.	Text
Job Profile Descriptor	A preview of the item, as described in the Workday object.	Text
Location	The location associated with the filled position or position restrictions. When associated with position restrictions, the location returned is in the following order: the location on the effective job requisition, hiring restrictions, and the primary location of the supervisory organization.	Object
Location ID	Unique identifier of the location.	Text
Location Descriptor	A preview of the item, as described in the Workday object.	Text
Country	Returns the country from the primary address for the location.	Object
Country Descriptor	A preview of the item, as described in the Workday object.	Text
Work Space	The work space associated with the position.	Object
Location Chain	Location chain of the work space.	Text
Work Space ID	Unique identifier of the work space.	Text
Work Space Descriptor	A preview of the item, as described in the Workday object.	Text
Person		Object
Person ID	Unique identifier of the person.	Text
Phone	Returns the primary public work phone number for the worker.	Text
Email	Returns the public primary work email address for the worker.	Text
Worker Type		Object
Worker Type ID	Unique identifier of the worker type.	Text
Worker Type Descriptor	A preview of the item, as described in the Workday object.	Text
Worker Type Href	A link to the instance.	Text
Additional Jobs		List of Objects
Business Title	The business title for the position.	Text
Supervisory Organization	The supervisory organization for the position.	Object
Supervisory Organization ID	Unique identifier of the supervisory organization.	Text
Supervisory Organization Descriptor	A preview of the item, as described in the Workday object.	Text
Job Type	The position's job type, which can be one of the following values: Primary Additional Job International Assignment If the position isn't effective, the card returns no value. The Primary and Additional Job fields are effective dated, due to the Switch Primary Job business process. An International Assignment can't be switched to a Primary job.	Object
Job Type Descriptor	A preview of the item, as described in the Workday object.	Text
Job Profile	The job profile for the position.	Object
Job Profile ID	Unique identifier of the job profile.	Text
Job Profile Descriptor	A preview of the item, as described in the Workday object.	Text
Location	The location associated with the filled position or position restrictions. When associated with position restrictions, the location returned is in the following order: the location on the effective job requisition, hiring restrictions, and the primary location of the supervisory organization.	Object
Location ID	Unique identifier of the location.	Text
Location Descriptor	A preview of the item, as described in the Workday object.	Text
Country	Returns the country from the primary address for the location.	Object
Country Descriptor	A preview of the item, as described in the Workday object.	Text
Work Space	The work space associated with the position.	Object
Location Chain	Location chain of the work space.	Text
Work Space ID	Unique identifier of the work space.	Text
Work Space Descriptor	A preview of the item, as described in the Workday object.	Text
Workers	Each object contains the details for an individual worker. 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 Workers

Options

Input

Output

Related topics