Understanding REST API Endpoints for PeopleSoft HR Common Utility Services (hcmcommonutilities)
This topic lists the REST resources and methods for the HR Common Utility Services API (hcmcommonutilities). Use this API to retrieve employee country and business partner contact details. The HR Common Utility Services API can be used with any of the delivered HCM skills.
This table lists the delivered API resources used with the HR Common Utility Services API.
|
API Resource |
Description |
|---|---|
|
API resource to retrieve employee country details. |
|
|
API resource to retrieve business partner contact details. |
API resource to retrieve employee country details.
Method: GET
Path: /usercountry
|
Request Parameters |
Description |
|---|---|
|
None available. |
N/A |
|
Response Parameters |
Response Result Type |
Description |
|---|---|---|
|
countryCD |
Success |
Country code of the current user. |
|
countryName |
Success |
Country name of the current user. |
API resource to retrieve business partner contact details.
Method: GET
Path: /businesspartner/{partnerType}
|
Request Parameters |
Description |
|---|---|
|
partnerType |
Partner type. Partner type denotes the functional mode being used. This service retrieves the details of the business partner based on the partner type value given |
|
Response Parameters |
Response Result Type |
Description |
|---|---|---|
|
bpDesignation |
Success |
Business partner title. |
|
bpEmail |
Success |
Business partner email. |
|
bpName |
Success |
Business partner name. |
|
bpPhone |
Success |
Business partner phone number. |