Retrieve Performance Documents
You can retrieve the performance document of an employee or for all your team members.
- View the Performance Document for a single employee.
- View the status of Performance Documents for your entire team.
View Performance Document for a Single Employee
To retrieve the latest performance document, you can search the payload using the available parameters, such as LatestPerformanceDocument, Person ID, and PersonNumber.
For example, Mark wants to know if John has completed his performance document.
Steps
To retrieve a performance document, query performance evaluations using a query parameter such as Evaluation ID.
Example of URL
/hcmRestApi/resources/11.13.18.05/performanceEvaluations?onlyData=true
/hcmRestApi/resources/11.13.18.05/performanceEvaluations?onlyData=true&q=EvaluationId=300100185767067
Example of Request
/hcmRestApi/resources/11.13.18.05/performanceEvaluations?onlyData=true&q=EvaluationId=300100185767067
Use the URL above to get performance document details where evaluation ID is 300100185767067.
"items": [
{
"EvaluationId": 300100185767067,
"PersonId": 10000000123,
"PersonNumber": "123",
"PerformanceDocumentName": "Annual Evaluation 2019"
}
]
Retrieve the Latest Performance Documents for Your Entire Team
You can get information on Performance Documents for your entire team.
Steps
To retrieve multiple Performance Documents, query performance evaluations by using a query parameter such as LatestPerformanceDocument.
Example of URL
hcmRestApi/resources/11.13.18.05/performanceEvaluations?onlyData=true&expand=EvalRole&finder=findByPerformanceEvaluationAttr;LatestPerformanceDocument=Y
Example of Request
hcmRestApi/resources/11.13.18.05/performanceEvaluations?onlyData=true&expand=EvalRole&finder=findByPerformanceEvaluationAttr;LatestPerformanceDocument=Y
Use the URL above to get all latest Performance Documents for your entire team.
"items": [
{
"EvaluationId": 300100185767067,
"PersonId": 10000000123,
"PersonNumber": "123",
"PerformanceDocumentName": "Annual Evaluation 2019",
"EvalRole": [
{
"EvalRoleId": 300100181066238
},
{
"EvalRoleId": 300100181066240
},
{
"EvalRoleId": 300100181066242
},
{
"EvalRoleId": 300100181066243
}
]
}
],