Assign a performance goal
post
/hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/performanceGoals/{performanceGoalsUniqID}/action/goalAssignAction
Assigns a performance goal to the selected employees.
Request
Path Parameters
-
GoalPlanId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
-
performanceGoalsUniqID(required): string
This is the hash key of the attributes which make up the composite key--- GoalId and GoalPlanGoalId ---for the Performance Goals resource and used to uniquely identify an instance of Performance Goals. The client should not generate the hash key value. Instead, the client should query on the Performance Goals collection resource with a filter on the primary key values in order to navigate to a specific instance of Performance Goals.
For example: performanceGoals?q=GoalId=<value1>;GoalPlanGoalId=<value2>
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
- application/vnd.oracle.adf.action+json
Root Schema : schema
Type:
Show Source
object
-
AllowKeyAttrFlag: string
Indicates if goal assignees can update the key attributes of the assigned goal.
-
GoalPlanId: number
Unique identifier for the goal plan to which the performance goal needs to be assigned.
-
InputPayloadRest: array
InputPayloadRest
List of employees who need to be assigned the performance goal.
-
ReviewPeriodId: number
Unique identifier for the review period.
Nested Schema : InputPayloadRest
Type:
array
List of employees who need to be assigned the performance goal.
Show Source
-
Array of:
object items
Additional Properties Allowed: additionalProperties
Response
Supported Media Types
- application/json
- application/vnd.oracle.adf.actionresult+json
Default Response
The following table describes the default response for this task.
Root Schema : schema
Type:
Show Source
object
-
result(required): object
result
Additional Properties Allowed: additionalPropertiesReturn value from the custom action after assigning a performance goal.
Nested Schema : result
Type:
object
Additional Properties Allowed
Show Source
Return value from the custom action after assigning a performance goal.