Cmdlets for Workday

Build 24.0.9060

PeoplePublicContactInformation

Retrieves a person's public contact information.

Workday Resource Information

Retrieves public contact information for the person with the specified ID.

Secured by: REST API Public

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.

Addresses_Aggregate


[{
  addressLine1: Text /* Address Line 1 for the address. */
  addressLine1Local: Text /* Local Address Line 1 for the address. */
  addressLine2: Text /* Address Line 2 for the address. */
  addressLine2Local: Text /* Local Address Line 2 for the address. */
  addressLine3: Text /* Address Line 3 for the address. */
  addressLine3Local: Text /* Local Address Line 3 for the address. */
  addressLine4: Text /* Address Line 4 for the address. */
  addressLine4Local: Text /* Local Address Line 4 for the address. */
  addressLine5: Text /* Address Line 5 for the address. */
  addressLine5Local: Text /* Local Address Line 5 for the address. */
  addressLine6: Text /* Address Line 6 for the address. */
  addressLine6Local: Text /* Local Address Line 6 for the address. */
  addressLine7: Text /* Address Line 7 for the address. */
  addressLine7Local: Text /* Local Address Line 7 for the address. */
  addressLine8: Text /* Address Line 8 for the address. */
  addressLine8Local: Text /* Local Address Line 8 for the address. */
  addressLine9: Text /* Address Line 9 for the address. */
  addressLine9Local: Text /* Local Address Line 9 for the address. */
  city: Text /* City for the address. */
  cityLocal: Text /* City - Local for the address. */
  citySubdivision1: Text /* City Subdivision 1 for the address. */
  citySubdivision1Local: Text /* City Subdivision 1 - Local for the address. */
  citySubdivision2: Text /* City Subdivision 2 for the address. */
  citySubdivision2Local: Text /* City Subdivision 2 - Local for the address. */
  country: { /* \~Country\~ */
      descriptor: Text /* A preview of the instance */
      id: Text /* Id of the instance */
  }
  countryCity: { /* \~Country\~ City */
      descriptor: Text /* A preview of the instance */
      id: Text /* Id of the instance */
  }
  countryRegion: { /* Country Region */
      descriptor: Text /* A preview of the instance */
      id: Text /* Id of the instance */
  }
  effective: Date /* The Effective Date for the address. */
  fullFormattedAddress: Text /* Full Formatted Address */
  fullFormattedLocalAddress: Text /* Full Formatted Local Address */
  id: Text /* Id of the instance */
  postalCode: Text /* The postal code for the address. */
  regionSubdivision1: Text /* Region Subdivision 1 for the address. */
  regionSubdivision1Local: Text /* Region Subdivision 1 - Local for the address. */
  regionSubdivision2: Text /* Region Subdivision 2 for the address. */
  usage: { /* Address Instance Referenced */
      primary: Boolean /* True if the communication method has any  primary usage type. */
      public: Boolean /* True if the communication method is public. If no results are returned, the communication method is private. */
      usageType: { /* Returns the usage type for a given communication method. */
          descriptor: Text /* A preview of the instance */
          id: Text /* Id of the instance */
      }
      usedFor: [{
          descriptor: Text /* A preview of the instance */
          id: Text /* Id of the instance */
      }]
  }
}]

Emails_Aggregate


[{
  emailAddress: Text /* The email address. */
  emailComment: Text /* Comment associated with the email. */
  id: Text /* Id of the instance */
  usage: { /* Current e-mail interface for the e-mail reference */
      primary: Boolean /* True if the communication method has any  primary usage type. */
      public: Boolean /* True if the communication method is public. If no results are returned, the communication method is private. */
      usageType: { /* Returns the usage type for a given communication method. */
          descriptor: Text /* A preview of the instance */
          id: Text /* Id of the instance */
      }
      usedFor: [{
          descriptor: Text /* A preview of the instance */
          id: Text /* Id of the instance */
      }]
  }
}]

InstantMessengers_Aggregate


[{
  comment: Text /* The comment associated with the instant messenger account. */
  id: Text /* Id of the instance */
  type: { /* Instant Messenger Type */
      descriptor: Text /* A preview of the instance */
  }
  usage: { /* Instant Messenger for the Instant Messenger Reference */
      primary: Boolean /* True if the communication method has any  primary usage type. */
      public: Boolean /* True if the communication method is public. If no results are returned, the communication method is private. */
      usageType: { /* Returns the usage type for a given communication method. */
          descriptor: Text /* A preview of the instance */
          id: Text /* Id of the instance */
      }
      usedFor: [{
          descriptor: Text /* A preview of the instance */
          id: Text /* Id of the instance */
      }]
  }
  userName: Text /* The instant messenger account username. */
}]

PhoneNumbers_Aggregate


[{
  completePhoneNumber: Text /* The complete phone number. */
  countryPhoneCode: { /* Phone \~country\~ */
      country: { /* \~Country\~ Phone Code for \~Country\~ */
          descriptor: Text /* A preview of the instance */
          id: Text /* Id of the instance */
      }
      countryPhoneCode: Text /* The phone code for a country. */
      descriptor: Text /* A preview of the instance */
      id: Text /* Id of the instance */
  }
  descriptor: Text /* A preview of the instance */
  deviceType: { /* Phone device type */
      descriptor: Text /* A preview of the instance */
      id: Text /* Id of the instance */
  }
  extension: Text /* The phone extension. */
  id: Text /* Id of the instance */
  usage: { /* Current phone for the reference */
      primary: Boolean /* True if the communication method has any  primary usage type. */
      public: Boolean /* True if the communication method is public. If no results are returned, the communication method is private. */
      usageType: { /* Returns the usage type for a given communication method. */
          descriptor: Text /* A preview of the instance */
          id: Text /* Id of the instance */
      }
      usedFor: [{
          descriptor: Text /* A preview of the instance */
          id: Text /* Id of the instance */
      }]
  }
}]

WebAddresses_Aggregate


[{
  comment: Text /* The comment associated with the web address. */
  id: Text /* Id of the instance */
  url: Text /* The complete URL address for the web address. */
  usage: { /* Current web address interface for the web address reference */
      primary: Boolean /* True if the communication method has any  primary usage type. */
      public: Boolean /* True if the communication method is public. If no results are returned, the communication method is private. */
      usageType: { /* Returns the usage type for a given communication method. */
          descriptor: Text /* A preview of the instance */
          id: Text /* Id of the instance */
      }
      usedFor: [{
          descriptor: Text /* A preview of the instance */
          id: Text /* Id of the instance */
      }]
  }
}]

Columns

Name Type Description
People_Id [KEY] String The Workday ID of the People that owns this.
Addresses_Aggregate String Supported for: SELECT. A JSON aggregate. The public address references for the person.
Emails_Aggregate String Supported for: SELECT. A JSON aggregate. The public email references for the person.
InstantMessengers_Aggregate String Supported for: SELECT. A JSON aggregate. The public instant messenger account references for the person.
PhoneNumbers_Aggregate String Supported for: SELECT. A JSON aggregate. The public phone number references for the person.
WebAddresses_Aggregate String Supported for: SELECT. A JSON aggregate. The public web address references for the person.
Universal_ID_Prompt String Only used when a People_Id filter is not provided. The Universal ID of the person you want to retrieve.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060