Update weight of a goal
patch
/hcmRestApi/resources/11.13.18.05/goalPlanGoalWeights/{goalPlanGoalWeightsUniqID}
Request
Path Parameters
-
goalPlanGoalWeightsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Goal Plan Goal Weights resource and used to uniquely identify an instance of Goal Plan Goal Weights. The client should not generate the hash key value. Instead, the client should query on the Goal Plan Goal Weights collection resource in order to navigate to a specific instance of Goal Plan Goal Weights to get the hash key.
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/json
Root Schema : schema
Type:
Show Source
object
-
ActionType: string
Maximum Length:
80
Indicates the type of the process, which can be mass assignment or mass sharing of performance goals. -
AssignmentId: integer
(int64)
Unique identifier for the job assignment of a worker.
-
GoalGPGId: integer
(int64)
Unique identifier for a performance goal.
-
GoalPlanId: integer
(int64)
Title:
Goal Plan Name
Unique identifier of the goal plan. -
PriorityCode: string
Title:
Priority
Maximum Length:30
Priority code of the performance goal. -
ReviewPeriodId: integer
(int64)
Unique Identifier for the review period that the goal plan of the performance goal is associated with.
-
TargetGoalPlanId: integer
Unique identifier of the goal plan.
-
TargetReviewPeriod: integer
Unique Identifier for the review period that the goal plan of the performance goal is associated with.
-
Weighting: number
Title:
Weight
Weight of the performance goal.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
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.
Root Schema : goalPlanGoalWeights-item-response
Type:
Show Source
object
-
ActionType: string
Maximum Length:
80
Indicates the type of the process, which can be mass assignment or mass sharing of performance goals. -
AssignmentId: integer
(int64)
Unique identifier for the job assignment of a worker.
-
GoalApprovalState: string
Read Only:
true
Maximum Length:30
Indicates if the performance goal is approved or not. -
GoalGPGId: integer
(int64)
Unique identifier for a performance goal.
-
GoalId: integer
(int64)
Title:
Goal ID
Read Only:true
Unique identifier for a performance goal. -
GoalName: string
Title:
Goal Name
Read Only:true
Maximum Length:400
Name of the performance goal. -
GoalPlanAssignmentId: integer
(int64)
Read Only:
true
Unique identifier for the goal plan assignment. -
GoalPlanGoalId: integer
(int64)
Unique identifier for the performance goal in the goal plan.
-
GoalPlanId: integer
(int64)
Title:
Goal Plan Name
Unique identifier of the goal plan. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PriorityCode: string
Title:
Priority
Maximum Length:30
Priority code of the performance goal. -
ReviewPeriodId: integer
(int64)
Unique Identifier for the review period that the goal plan of the performance goal is associated with.
-
StatusCode: string
Title:
Status
Read Only:true
Maximum Length:30
Default Value:NOT_STARTED
Status code of the performance goal. -
TargetGoalPlanId: integer
Unique identifier of the goal plan.
-
TargetReviewPeriod: integer
Unique Identifier for the review period that the goal plan of the performance goal is associated with.
-
Weighting: number
Title:
Weight
Weight of the performance goal.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.