HomeContactInformationChangesWebAddresses
Retrieve all existing web addresses staged for update by the parent business process
Workday Resource Information
Retrieve an existing web address as it exists when staged by the parent business process.Secured by: Person Data: Home Web Address, Self-Service: Home Web Address
Scope: Contact Information
Aggregate Fields
The cmdlet represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is.
This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.
Usage_UsedFor_Aggregate
[{
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}]
Columns
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
Id of the instance |
| HomeContactInformationChange_Id [KEY] | String | False |
The ID of the change process, must be set in all queries. |
| Url | String | False |
Supported for: SELECT, INSERT, UPDATE. The complete URL address for the web address. |
| Usage_Comment | String | False |
Supported for: SELECT, INSERT, UPDATE. The description for a given communication method. |
| Usage_Primary | Bool | False |
Supported for: SELECT, INSERT, UPDATE. True if the communication method has any primary usage type. |
| Usage_Public | Bool | False |
Supported for: SELECT, INSERT, UPDATE. True if the communication method is public. If no results are returned, the communication method is private. |
| Usage_UsageType_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. Id of the instance |
| Usage_UsedFor_Aggregate | String | False |
Supported for: SELECT, INSERT, UPDATE. A JSON aggregate. Usage behaviors for the communication method, such as mailing, billing shipping etc. |
| PrimaryOnly_Prompt | Bool | False |
If true, returns only the IDs of the person's primary web addresses. |
| PublicOnly_Prompt | Bool | False |
If true, returns only the IDs of the person's public web addresses. |
| UsageType_Prompt | String | False |
Specifies usage type, such as home or work. Only used if the service provides access to multiple usage types from the same endpoint. |
| UsedFor_Prompt | String | False |
Specifies usage behavior, such as mailing, billing, or shipping. |