Platform Configuration Fields Data v2

This API is similar to the v1 Platform Configuration Fields className API with added support of filtering data by KeyValue. The fields and keyValues are dependent on the class in question - expected key values are listed along with the supported classes below.

This API uses pre-defined Views in the UKG Pro database to retrieve the data whereas the v1 version of this API uses functions to retrieve the data.
UKG Pro service account must have "View" role for the "Personnel Integration" Web Service.
Supported classes:

  1. Address (takes value of an employee Id as keyValue)
  2. Person (takes value of an employee Id as keyValue)
  3. Employee (takes value of an employee Id as keyValue)
  4. PhoneNumber (takes value of an employee Id as keyValue)
  5. Employment (takes value of an employee Id and a company code as keyValue. Accepted format for keyValue employeeId:companyCode)
  6. Location (takes value of a location code as keyValue)
  7. Job (takes value of a job code as keyValue)
  8. OrgLevel1 (takes value of an org code as keyValue)
  9. OrgLevel2 (takes value of an org code as keyValue)
  10. OrgLevel3 (takes value of an org code as keyValue)
  11. OrgLevel4 (takes value of an org code as keyValue)
  12. InternationalEmployee (takes value of an employee Id and a country code as keyValue. Accepted format for keyValue employeeId:countryCode)
  13. Contacts (takes value of a SystemId as keyValue)

    Classes NOT supported:
  14. ComponentCompany
  15. PersonNames (fields of this class are available in class Person)
Language
Credentials
Basic
base64
:
URL