Search Work Addresses
Retrieve the work addresses for a specific worker ID in Workday.
Options
| Field | Definition | Type | Required |
|---|---|---|---|
|
Result Set |
Choose a method to filter search results:
|
Dropdown |
TRUE |
Input
| Field | Definition | Type | Required |
|---|---|---|---|
|
Search Criteria |
|||
|
Person ID |
Unique identifier of the person. |
Text |
TRUE |
|
Effective |
The effective date for the person's addresses, using the YYYY-MM-DD format. |
Date & Time |
FALSE |
|
Primary Only |
If True, the search returns only the person's primary addresses. |
True/False |
FALSE |
|
Public Only |
If True, the search returns only the person's public addresses. |
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.
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 |
|
Address ID |
Unique identifier of the address. |
Text |
|
Address Line 1 |
First line of the address. |
Text |
|
Address Line 2 |
Second line of the address. |
Text |
|
City |
City for the address. |
Text |
|
Postal Code |
The postal code for the address. |
Text |
|
Region Subdivision 1 |
Regional subdivision 1 for the address. |
Text |
|
Region Subdivision 2 |
Regional subdivision 2 for the address. |
Text |
|
City Subdivision 1 |
City subdivision 1 for the address. |
Text |
|
City Subdivision 2 |
City subdivision 2 for the address. |
Text |
|
Effective |
The effective date for the address. |
Date & Time |
|
Usage |
Object |
|
|
Usage Type |
The usage type for a given communication method. |
Object |
|
Usage Type ID |
Unique identifier of the usage type. |
Text |
|
Usage Type Descriptor |
A preview of the item, as described in the Workday object. |
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, such as mailing, billing, or shipping. |
List of Objects |
|
Used For ID |
Unique identifier for the Used For resource. |
Text |
|
Used For Descriptor |
A preview of the item, as described in the Workday object. |
Text |
|
Country |
Object |
|
|
Country ID |
Unique identifier for the country. |
Text |
|
Country Descriptor |
A preview of the instance. |
Text |
|
Country Region |
Object |
|
|
Country Region ID |
Unique identifier for the country region. |
Text |
|
Country Region Descriptor |
A preview of the instance. |
Text |
|
Country City |
Object |
|
|
Country City ID |
Unique identifier for the country city. |
Text |
|
Country City Descriptor |
A preview of the instance. |
Text |
|
Addresses |
Each object contains the details for an individual work address. 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.
|
Number |