Skip to content
/ workday-person-java-sdk Public

Workday is a global leader in cloud applications for finance and HR, empowering businesses with AI-driven solutions. Trusted by over 10,000 organizations worldwide, including Fortune 500 companies. Workday's Java SDK for Person API generated by Konfig (https://konfigthis.com/).

0 stars 0 forks Branches Tags Activity
Star
Notifications You must be signed in to change notification settings

konfig-sdks/workday-person-java-sdk

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
api
api
 
 
docs
docs
 
 
gradle/wrapper
gradle/wrapper
 
 
src
src
 
 
.gitignore
.gitignore
 
 
README.md
README.md
 
 
build.gradle
build.gradle
 
 
build.sbt
build.sbt
 
 
gradle.properties
gradle.properties
 
 
gradlew
gradlew
 
 
gradlew.bat
gradlew.bat
 
 
header.png
header.png
 
 
pom.xml
pom.xml
 
 
settings.gradle
settings.gradle
 
 

Repository files navigation

Visit Workday

Workday

The Person REST APIs enable you to access information about the worker person, including country-specific configuration information about name components.

Requirements

Building the API client library requires:

  1. Java 1.8+
  2. Maven (3.8.3+)/Gradle (7.2+)

If you are adding this library to an Android Application or Library:

  1. Android 8.0+ (API Level 26+)

Installation

Maven users

Add this dependency to your project's POM:

<dependency>
  <groupId>com.konfigthis</groupId>
  <artifactId>workday-person-java-sdk</artifactId>
  <version>v4</version>
  <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your build.gradle:

// build.gradle
repositories {
  mavenCentral()
}

dependencies {
   implementation "com.konfigthis:workday-person-java-sdk:v4"
}

Android users

Make sure your build.gradle file as a minSdk version of at least 26:

// build.gradle
android {
    defaultConfig {
        minSdk 26
    }
}

Also make sure your library or application has internet permissions in your AndroidManifest.xml:

<!--AndroidManifest.xml-->
<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:tools="http://schemas.android.com/tools">
    <uses-permission android:name="android.permission.INTERNET"/>
</manifest>

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

  • target/workday-person-java-sdk-v4.jar
  • target/lib/*.jar

Getting Started

Please follow the installation instruction and execute the following Java code:

import com.konfigthis.client.ApiClient;
import com.konfigthis.client.ApiException;
import com.konfigthis.client.ApiResponse;
import com.konfigthis.client.WorkdayPerson;
import com.konfigthis.client.Configuration;
import com.konfigthis.client.model.*;
import com.konfigthis.client.api.PromptValuesApi;
import java.util.List;
import java.util.Map;
import java.util.UUID;

public class Example {
  public static void main(String[] args) {
    Configuration configuration = new Configuration();
    configuration.host = "https://<tenantHostname>/person/v4";
    WorkdayPerson client = new WorkdayPerson(configuration);
    Long limit = 56L; // The maximum number of objects in a single response. The default and maximum is 1000.
    Long offset = 56L; // The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.
    String person = "person_example";
    try {
      MULTIPLEINSTANCEMODELREFERENCE result = client
              .promptValues
              .getAllowedCountryData()
              .limit(limit)
              .offset(offset)
              .person(person)
              .execute();
      System.out.println(result);
      System.out.println(result.getTotal());
      System.out.println(result.getData());
    } catch (ApiException e) {
      System.err.println("Exception when calling PromptValuesApi#getAllowedCountryData");
      System.err.println("Status code: " + e.getStatusCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }

    // Use .executeWithHttpInfo() to retrieve HTTP Status Code, Headers and Request
    try {
      ApiResponse<MULTIPLEINSTANCEMODELREFERENCE> response = client
              .promptValues
              .getAllowedCountryData()
              .limit(limit)
              .offset(offset)
              .person(person)
              .executeWithHttpInfo();
      System.out.println(response.getResponseBody());
      System.out.println(response.getResponseHeaders());
      System.out.println(response.getStatusCode());
      System.out.println(response.getRoundTripTime());
      System.out.println(response.getRequest());
    } catch (ApiException e) {
      System.err.println("Exception when calling PromptValuesApi#getAllowedCountryData");
      System.err.println("Status code: " + e.getStatusCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Documentation for API Endpoints

All URIs are relative to https://<tenantHostname>/person/v4

Class Method HTTP request Description
PromptValuesApi getAllowedCountryData GET /values/personalInformationCountry/allowedCountry
PromptValuesApi getCountryPhoneCodes GET /values/commonPhone/countryPhoneCodes
PromptValuesApi getHereditaryValues GET /values/nameComponents/hereditary
PromptValuesApi getInstances GET /values/nameComponents/religious
PromptValuesApi getInstances_0 GET /values/nameComponents/honorary
PromptValuesApi getInstances_1 GET /values/countryComponents/countryCity
PromptValuesApi getInstances_2 GET /values/nameComponents/social
PromptValuesApi getInstances_3 GET /values/countryComponents/country
PromptValuesApi getInstances_4 GET /values/nameComponents/academic
PromptValuesApi getInstances_5 GET /values/countryComponents/countryRegion
PromptValuesApi getOptions GET /values/nameComponents/royal
PromptValuesApi getOptions_0 GET /values/nameComponents/salutation
PromptValuesApi getOptions_1 GET /values/nameComponents/professional
PromptValuesApi getPhoneDeviceTypes GET /values/commonPhone/phoneDeviceTypes
PromptValuesApi getTitleComponents GET /values/nameComponents/title
PromptValuesApi listCountryData GET /values/personalInformationCountry/populatedCountry
CountriesApi getAddressComponents GET /countries/{ID}/addressComponents Retrieves the allowed address components and their configuration for the Country and a given Address Configuration Format. The webServiceAlias of the returned address components map to the enterable fields when submitting address data in other POST/PUT/PATCH operations.
CountriesApi getCollectionInformation GET /countries Retrieves a collection of information about countries.
CountriesApi getInfo GET /countries/{ID} Retrieves information about a country.
CountriesApi getNameComponents GET /countries/{ID}/nameComponents Retrieves a collection of configuration information about name components.
HomeContactInformationChangesApi createEmailAddress POST /homeContactInformationChanges/{ID}/emailAddresses
HomeContactInformationChangesApi createInstantMessenger POST /homeContactInformationChanges/{ID}/instantMessengers
HomeContactInformationChangesApi createNewAddress POST /homeContactInformationChanges/{ID}/addresses
HomeContactInformationChangesApi createPhoneNumber POST /homeContactInformationChanges/{ID}/phoneNumbers
HomeContactInformationChangesApi createWebAddress POST /homeContactInformationChanges/{ID}/webAddresses
HomeContactInformationChangesApi getAddressAsStaged GET /homeContactInformationChanges/{ID}/addresses/{subresourceID} An address as it exists staged for update by the parent business process.
HomeContactInformationChangesApi getAddressesStaged GET /homeContactInformationChanges/{ID}/addresses Retrieve all existing addresses staged for update by the parent business process
HomeContactInformationChangesApi getEmailAddress GET /homeContactInformationChanges/{ID}/emailAddresses/{subresourceID} An email address as it exists staged for update by the parent business process.
HomeContactInformationChangesApi getEventInformation GET /homeContactInformationChanges/{ID}
HomeContactInformationChangesApi getInstantMessenger GET /homeContactInformationChanges/{ID}/instantMessengers/{subresourceID} An instant messenger as it exists staged for update by the parent business process.
HomeContactInformationChangesApi getPhoneNumbers GET /homeContactInformationChanges/{ID}/phoneNumbers Retrieve all existing phone numbers staged for update by the parent business process
HomeContactInformationChangesApi getStagedEmailAddresses GET /homeContactInformationChanges/{ID}/emailAddresses Retrieve all existing addresses staged for update by the parent business process
HomeContactInformationChangesApi getStagedInstantMessengers GET /homeContactInformationChanges/{ID}/instantMessengers Retrieve all existing instant messengers staged for update by the parent business process
HomeContactInformationChangesApi getStagedPhoneNumber GET /homeContactInformationChanges/{ID}/phoneNumbers/{subresourceID} A phone number as it exists staged for update by the parent business process.
HomeContactInformationChangesApi getWebAddress GET /homeContactInformationChanges/{ID}/webAddresses/{subresourceID} A web address as it exists staged for update by the parent business process.
HomeContactInformationChangesApi getWebAddressesStaged GET /homeContactInformationChanges/{ID}/webAddresses Retrieve all existing web addresses staged for update by the parent business process
HomeContactInformationChangesApi removeAddress DELETE /homeContactInformationChanges/{ID}/addresses/{subresourceID}
HomeContactInformationChangesApi removeEmailAddress DELETE /homeContactInformationChanges/{ID}/emailAddresses/{subresourceID}
HomeContactInformationChangesApi removeInstantMessenger DELETE /homeContactInformationChanges/{ID}/instantMessengers/{subresourceID}
HomeContactInformationChangesApi removePhoneNumber DELETE /homeContactInformationChanges/{ID}/phoneNumbers/{subresourceID}
HomeContactInformationChangesApi removeWebAddress DELETE /homeContactInformationChanges/{ID}/webAddresses/{subresourceID}
HomeContactInformationChangesApi submitChange POST /homeContactInformationChanges/{ID}/submit Submit the specified contact change ID.
HomeContactInformationChangesApi updateAddress PUT /homeContactInformationChanges/{ID}/addresses/{subresourceID}
HomeContactInformationChangesApi updateEmailAddress PATCH /homeContactInformationChanges/{ID}/emailAddresses/{subresourceID}
HomeContactInformationChangesApi updateInstantMessenger PATCH /homeContactInformationChanges/{ID}/instantMessengers/{subresourceID}
HomeContactInformationChangesApi updatePhoneNumber PATCH /homeContactInformationChanges/{ID}/phoneNumbers/{subresourceID}
HomeContactInformationChangesApi updateWebAddress PATCH /homeContactInformationChanges/{ID}/webAddresses/{subresourceID}
PeopleApi getAdditionalName GET /people/{ID}/additionalNames/{subresourceID} Retrieves an additional name.
PeopleApi getAdditionalNames GET /people/{ID}/additionalNames Retrieves a collection of additional names.
PeopleApi getById GET /people/{ID} Retrieves a person in your Workday tenant.
PeopleApi getHomeAddress GET /people/{ID}/homeAddresses/{subresourceID} Retrieves a home address.
PeopleApi getHomeAddresses GET /people/{ID}/homeAddresses Retrieves a collection of home addresses.
PeopleApi getHomeEmail GET /people/{ID}/homeEmails/{subresourceID} Retrieves a home email address.
PeopleApi getHomeEmails GET /people/{ID}/homeEmails Retrieves a collection of home email addresses.
PeopleApi getHomeInstantMessengerUsername GET /people/{ID}/homeInstantMessengers/{subresourceID} Retrieves a home instant messenger account username.
PeopleApi getHomeInstantMessengers GET /people/{ID}/homeInstantMessengers Retrieves a collection of home instant messenger account usernames.
PeopleApi getHomePhone GET /people/{ID}/homePhones/{subresourceID} Retrieves a home phone number.
PeopleApi getHomePhones GET /people/{ID}/homePhones Retrieves a collection of home phone numbers.
PeopleApi getHomeWebAddress GET /people/{ID}/homeWebAddresses/{subresourceID} Retrieves a home web address.
PeopleApi getHomeWebAddresses GET /people/{ID}/homeWebAddresses Retrieves a collection of home web addresses.
PeopleApi getLegalName GET /people/{ID}/legalName/{subresourceID} Retrieves the legal name instance.
PeopleApi getLegalName_0 GET /people/{ID}/legalName Retrieves the legal name instance.
PeopleApi getNamePronunciation GET /people/{ID}/audioNamePronunciation/{subresourceID} Retrieves an Audio Name Pronunciation
PeopleApi getNamePronunciations GET /people/{ID}/audioNamePronunciation Retrieves a collection of Audio Name Pronunciations
PeopleApi getPersonById GET /people Retrieves a person in your Workday tenant.
PeopleApi getPersonalInfo GET /people/{ID}/personalInformation Retrieves a collection of personal information.
PeopleApi getPersonalInfo_0 GET /people/{ID}/personalInformation/{subresourceID} Retrieves a person's personal information.
PeopleApi getPersonalPhoto GET /people/{ID}/photos/{subresourceID} Retrieves a personal photo.
PeopleApi getPersonalPhotos GET /people/{ID}/photos Retrieves a collection of personal photos.
PeopleApi getPreferredName GET /people/{ID}/preferredName Retrieves the preferred name instance.
PeopleApi getPreferredName_0 GET /people/{ID}/preferredName/{subresourceID} Retrieves the preferred name instance.
PeopleApi getPublicContactInformation GET /people/{ID}/publicContactInformation/{subresourceID} Retrieves a person's public contact information.
PeopleApi getPublicContactInformation_0 GET /people/{ID}/publicContactInformation Retrieves a collection of public contact information.
PeopleApi getWorkAddress GET /people/{ID}/workAddresses/{subresourceID} Retrieves a work address.
PeopleApi getWorkAddresses GET /people/{ID}/workAddresses Retrieves a collection of work addresses.
PeopleApi getWorkEmail GET /people/{ID}/workEmails/{subresourceID} Retrieves a work email address.
PeopleApi getWorkEmails GET /people/{ID}/workEmails Retrieves a collection of work email addresses.
PeopleApi getWorkInstantMessengerUsername GET /people/{ID}/workInstantMessengers/{subresourceID} Retrieves a work instant messenger account username.
PeopleApi getWorkInstantMessengerUsernames GET /people/{ID}/workInstantMessengers Retrieves a collection of work instant messenger accounts usernames.
PeopleApi getWorkPhone GET /people/{ID}/workPhones/{subresourceID} Retrieves a work phone number.
PeopleApi getWorkPhones GET /people/{ID}/workPhones Retrieves a collection of work phone numbers.
PeopleApi getWorkWebAddress GET /people/{ID}/workWebAddresses/{subresourceID} Retrieves a work web address.
PeopleApi getWorkWebAddresses GET /people/{ID}/workWebAddresses Retrieves a collection of work web addresses.
PhoneValidationApi validatePhoneNumber POST /phoneValidation Validates phone number data to ensure it is valid for Workday.
WorkContactInformationChangesApi createAddress POST /workContactInformationChanges/{ID}/addresses
WorkContactInformationChangesApi createEmailAddress POST /workContactInformationChanges/{ID}/emailAddresses
WorkContactInformationChangesApi createInstantMessenger POST /workContactInformationChanges/{ID}/instantMessengers
WorkContactInformationChangesApi createPhoneNumber POST /workContactInformationChanges/{ID}/phoneNumbers
WorkContactInformationChangesApi createStagedWebAddress POST /workContactInformationChanges/{ID}/webAddresses
WorkContactInformationChangesApi getAddressAsStaged GET /workContactInformationChanges/{ID}/addresses/{subresourceID} An address as it exists staged for update by the parent business process.
WorkContactInformationChangesApi getAddressesStaged GET /workContactInformationChanges/{ID}/addresses Retrieve all existing addresses staged for update by the parent business process
WorkContactInformationChangesApi getEmailAddress GET /workContactInformationChanges/{ID}/emailAddresses/{subresourceID} An email address as it exists staged for update by the parent business process.
WorkContactInformationChangesApi getEventInfo GET /workContactInformationChanges/{ID}
WorkContactInformationChangesApi getPhoneNumber GET /workContactInformationChanges/{ID}/phoneNumbers/{subresourceID} A phone number as it exists staged for update by the parent business process.
WorkContactInformationChangesApi getPhoneNumbers GET /workContactInformationChanges/{ID}/phoneNumbers Retrieve all existing phone numbers staged for update by the parent business process
WorkContactInformationChangesApi getStagedEmailAddresses GET /workContactInformationChanges/{ID}/emailAddresses Retrieve all existing addresses staged for update by the parent business process
WorkContactInformationChangesApi getStagedInstantMessenger GET /workContactInformationChanges/{ID}/instantMessengers/{subresourceID} An instant messenger as it exists staged for update by the parent business process.
WorkContactInformationChangesApi getStagedInstantMessengers GET /workContactInformationChanges/{ID}/instantMessengers Retrieve all existing instant messengers staged for update by the parent business process
WorkContactInformationChangesApi getWebAddress GET /workContactInformationChanges/{ID}/webAddresses/{subresourceID} A web address as it exists staged for update by the parent business process.
WorkContactInformationChangesApi getWebAddressesStaged GET /workContactInformationChanges/{ID}/webAddresses Retrieve all existing web addresses staged for update by the parent business process
WorkContactInformationChangesApi removeAddress DELETE /workContactInformationChanges/{ID}/addresses/{subresourceID}
WorkContactInformationChangesApi removeEmailAddress DELETE /workContactInformationChanges/{ID}/emailAddresses/{subresourceID}
WorkContactInformationChangesApi removeInstantMessenger DELETE /workContactInformationChanges/{ID}/instantMessengers/{subresourceID}
WorkContactInformationChangesApi removePhoneNumber DELETE /workContactInformationChanges/{ID}/phoneNumbers/{subresourceID}
WorkContactInformationChangesApi removeWebAddress DELETE /workContactInformationChanges/{ID}/webAddresses/{subresourceID}
WorkContactInformationChangesApi submit POST /workContactInformationChanges/{ID}/submit Submit the specified contact change ID.
WorkContactInformationChangesApi updateAddress PUT /workContactInformationChanges/{ID}/addresses/{subresourceID}
WorkContactInformationChangesApi updateAlternateWorkLocation PATCH /workContactInformationChanges/{ID}
WorkContactInformationChangesApi updateEmailAddress PATCH /workContactInformationChanges/{ID}/emailAddresses/{subresourceID}
WorkContactInformationChangesApi updateInstantMessenger PATCH /workContactInformationChanges/{ID}/instantMessengers/{subresourceID}
WorkContactInformationChangesApi updatePhoneNumber PATCH /workContactInformationChanges/{ID}/phoneNumbers/{subresourceID}
WorkContactInformationChangesApi updateWebAddress PATCH /workContactInformationChanges/{ID}/webAddresses/{subresourceID}

Documentation for Models

Author

This Java package is automatically generated by Konfig

About

Workday is a global leader in cloud applications for finance and HR, empowering businesses with AI-driven solutions. Trusted by over 10,000 organizations worldwide, including Fortune 500 companies. Workday's Java SDK for Person API generated by Konfig (https://konfigthis.com/).

Resources

Readme
Activity
Custom properties

Stars

0 stars

Watchers

1 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Languages