This GET operation returns the details of a plan target based on the XRefCode that you enter.
Role feature access: HCM Anywhere > Web Services > Patch/Post/Delete Plan Targets
The operation uses the following base URL:
https://www.dayforcehcm.com/api/CompanyName/V1/PlanTargets
Parameters
Consumers can retrieve plan targets data using the following parameters:
| Parameter | Description |
|---|---|
|
planTargetXRefCode |
Filter by plan target XRefCode. |
|
orgUnitXRefCode |
Filter by organization unit XRefCode. |
|
kpiXRefCode |
(Optional) Filter by KPI XRefCode. |
| zoneXRefCode | (Optional) Filter by zone XRefCode. |
| isActive | Return only active plan targets. |
Response
The response from this request will contain data from the referenced XRefCode. Here is an example response:
{
"Data": [
{
"PlanTargetXRefCode": "string",
"Name": "string",
"Description": "string",
"EffectiveStart": "2023-02-01T15:49:31.219Z",
"EffectiveEnd": "2023-02-01T15:49:31.219Z",
"TargetValue": 0,
"KpiXRefCode": "string",
"ZoneXRefCode": "string",
"DaysOfWeek": [
"string"
],
"OrgUnitXRefCodes": [
"string"
],
"CreationOrgUnitXRefCode": "string"
}
],
"ProcessResults": [
{
"Code": "string",
"Context": "string",
"Level": "string",
"Message": "string"
}
]
}
You can also add and update plan targets using the POST and PATCH verbs. See POST and PATCH Plan Targets.