Update a performance goal
patch
/hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/performanceGoals/{performanceGoalsUniqID}
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/json
Root Schema : schema
Type:
Show Source
object
-
ActualCompletionDate: string
(date)
Title:
Actual Completion Date
Actual completion date of the performance goal. -
AllowDelGoalCode: string
Title:
Allow managers to delete this goal
Maximum Length:30
Indicates if managers or workers can delete the performance goal. -
AllowDelGoalFlag: boolean
Title:
Allow managers to delete this goal
Maximum Length:30
Indicates if managers or workers can delete the performance goal. -
AllowKeyAttrUpdateFlag: boolean
Title:
Allow Workers to Update Key Attributes
Maximum Length:30
Default Value:true
Indicates if managers or workers can update the key attributes of a performance goal. -
AssignmentId: integer
(int64)
Title:
Assignment ID
Unique identifier for the job assignment of a worker. -
CategoryCode: string
Title:
Category
Maximum Length:30
Category code of a performance goal. -
ChildObjectId: integer
Unique identifier for the child data associated with the performance goal. It can be either the identifier of the goal task or goal measurement.
-
ChildObjectName: string
Maximum Length:
255
Name of the child object that needs to be returned after loading data from the transaction data store. It can be either perfGoalTasks or perfGoalMeasurements. -
Comments: string
(byte)
Title:
Goal-specific Comments
Comments added to a performance goal. -
Description: string
Title:
Description
Maximum Length:4000
Description of the performance goal. -
DisplaySequence: integer
(int32)
Display sequence of goals in the goal plan.
-
GoalApprovalState: string
Maximum Length:
30
Approval state of the goal. -
GoalName: string
Title:
Goal Name
Maximum Length:400
Name of the performance goal. -
GoalSubTypeCode: string
Title:
Subtype
Maximum Length:30
Code that indicates the goal's subtype. -
GoalVersionTypeCode: string
Title:
Goal Version Type
Maximum Length:30
Default Value:ACTIVE
Version type code of the performance goal. -
LevelCode: string
Title:
Level
Maximum Length:30
Code that indicates the performance goal level. -
LongDescription: string
(byte)
Title:
Description
Long description of the performance goal. -
PercentCompletion: string
Title:
Completion Percentage
Maximum Length:30
Completion percentage of the performance goal. -
PriorityCode: string
Title:
Priority
Maximum Length:30
Priority code of the performance goal. -
PrivateFlag: boolean
Title:
Private
Maximum Length:30
Default Value:false
Indicates if the performance goal is private or not. -
PublishDate: string
(date-time)
Title:
Publication Date
The date the performance goal was published as an organization goal. -
PublishedFlag: boolean
Title:
Published
Maximum Length:30
Indicates whether the current goal has been published as an organization goal. -
ReferenceGoalId: integer
(int64)
Title:
Goal ID
Unique identifier for the performance goal in the goal plan. -
RelatedLink: string
Title:
Related Link
Maximum Length:4000
Related link of the performance goal. -
RequiredGPGId: string
Unique identifier for the performance goal in the goal plan.
-
RequiresApprovalState: string
Approval state of the goal.
-
RequiresApprovalStatus: string
Indicates whether the goal requires an approval status. Valid values are Y and N.
-
ReviewPeriodId: integer
(int64)
Unique Identifier for the review period that the goal plan of the performance goal is associated with.
-
StartDate: string
(date)
Title:
Start Date
Start date of the performance goal. -
StatusCode: string
Title:
Status
Maximum Length:30
Default Value:NOT_STARTED
Code that indicates the status of the performance goal. -
SuccessCriteria: string
(byte)
Title:
Success Criteria
Success criteria of the performance goal. -
TargetCompletionDate: string
(date)
Title:
Target Completion Date
Targeted completion date of the performance goal. -
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 : goalPlans-performanceGoals-item-response
Type:
Show Source
object
-
ActualCompletionDate: string
(date)
Title:
Actual Completion Date
Actual completion date of the performance goal. -
AllowDelGoalCode: string
Title:
Allow managers to delete this goal
Maximum Length:30
Indicates if managers or workers can delete the performance goal. -
AllowDelGoalFlag: boolean
Title:
Allow managers to delete this goal
Maximum Length:30
Indicates if managers or workers can delete the performance goal. -
AllowKeyAttrUpdateFlag: boolean
Title:
Allow Workers to Update Key Attributes
Maximum Length:30
Default Value:true
Indicates if managers or workers can update the key attributes of a performance goal. -
AssignedByPersonId: integer
(int64)
Title:
Created By
Unique identifier for the HR specialist or manager who assigns the performance goal. -
AssignmentId: integer
(int64)
Title:
Assignment ID
Unique identifier for the job assignment of a worker. -
AssignmentNumber: string
Title:
Assignment Number
Read Only:true
Maximum Length:30
Unique assignment number for a worker assignment. -
CategoryCode: string
Title:
Category
Maximum Length:30
Category code of a performance goal. -
CategoryMeaning: string
Read Only:
true
Maximum Length:255
Description for the associated category code of a performance goal. -
ChildObjectId: integer
Unique identifier for the child data associated with the performance goal. It can be either the identifier of the goal task or goal measurement.
-
ChildObjectName: string
Maximum Length:
255
Name of the child object that needs to be returned after loading data from the transaction data store. It can be either perfGoalTasks or perfGoalMeasurements. -
Comments: string
(byte)
Title:
Goal-specific Comments
Comments added to a performance goal. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
User who created the performance goal. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date the performance goal was created. -
Description: string
Title:
Description
Maximum Length:4000
Description of the performance goal. -
DisplaySequence: integer
(int32)
Display sequence of goals in the goal plan.
-
GoalApprovalState: string
Maximum Length:
30
Approval state of the goal. -
GoalId: integer
(int64)
Title:
Goal ID
Unique identifier for a performance goal. -
GoalName: string
Title:
Goal Name
Maximum Length:400
Name of the performance goal. -
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. -
GoalPlanWeightEnabled: string
Read Only:
true
Indicates whether weights are enabled for the goals in the goal plan. -
GoalSourceCode: string
Title:
Source
Maximum Length:30
Source code that indicates who created the performance goal. A performance goal can be created by a worker, a manager, or an HR specialist. -
GoalSubTypeCode: string
Title:
Subtype
Maximum Length:30
Code that indicates the goal's subtype. -
GoalSubtypeMeaning: string
Title:
Subtype
Read Only:true
Maximum Length:255
Code used in HCM_LOOKUPS for the goal's subtype. -
GoalVersionTypeCode: string
Title:
Goal Version Type
Maximum Length:30
Default Value:ACTIVE
Version type code of the performance goal. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
Date the performance goal was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
User who last updated the performance goal. -
LevelCode: string
Title:
Level
Maximum Length:30
Code that indicates the performance goal level. -
LevelMeaning: string
Title:
Level
Read Only:true
Maximum Length:255
Performance goal level, which can be Target or Stretch. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LoggedInPersonType: string
Read Only:
true
Maximum Length:255
Unique person identifier for the logged in person. -
LongDescription: string
(byte)
Title:
Description
Long description of the performance goal. -
MassRequestId: integer
(int64)
Unique identifier for the mass assignment or mass share request.
-
PercentCompletion: string
Title:
Completion Percentage
Maximum Length:30
Completion percentage of the performance goal. -
PersonId: integer
(int64)
Title:
Person ID
Unique identifier for the worker who's assigned the performance goal. -
PersonNumber: string
Title:
Person Number
Read Only:true
Maximum Length:30
Person number of the worker who's assigned the performance goal. -
PriorityCode: string
Title:
Priority
Maximum Length:30
Priority code of the performance goal. -
PriorityMeaning: string
Title:
Priority
Read Only:true
Maximum Length:255
Priority of the performance goal, which can be High, Medium, or Low. -
PrivateFlag: boolean
Title:
Private
Maximum Length:30
Default Value:false
Indicates if the performance goal is private or not. -
PublishDate: string
(date-time)
Title:
Publication Date
The date the performance goal was published as an organization goal. -
PublishedFlag: boolean
Title:
Published
Maximum Length:30
Indicates whether the current goal has been published as an organization goal. -
ReferenceGoalId: integer
(int64)
Title:
Goal ID
Unique identifier for the performance goal in the goal plan. -
RelatedLink: string
Title:
Related Link
Maximum Length:4000
Related link of the performance goal. -
RequestContext: string
Maximum Length:
30
Page from which the performance goal was created. Performance goals can be created on the employee's Goals page, the manager page, or the goal administrator page. -
RequiredGPGId: string
Unique identifier for the performance goal in the goal plan.
-
RequiresApprovalState: string
Approval state of the goal.
-
RequiresApprovalStatus: string
Indicates whether the goal requires an approval status. Valid values are Y and N.
-
ReviewPeriodId: integer
(int64)
Unique Identifier for the review period that the goal plan of the performance goal is associated with.
-
StartDate: string
(date)
Title:
Start Date
Start date of the performance goal. -
StatusCode: string
Title:
Status
Maximum Length:30
Default Value:NOT_STARTED
Code that indicates the status of the performance goal. -
StatusMeaning: string
Title:
Status
Read Only:true
Maximum Length:255
Status of the performance goal. -
SuccessCriteria: string
(byte)
Title:
Success Criteria
Success criteria of the performance goal. -
TargetCompletionDate: string
(date)
Title:
Target Completion Date
Targeted completion date of the performance goal. -
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.
Links
- GoalStatusCommonLookupLOVVO
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DHRG_GOAL_STATUS
The following properties are defined on the LOV link relation:- Source Attribute: StatusCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- checkGoalInPDAndCheckInDoc
-
Parameters:
- GoalPlanId:
$request.path.GoalPlanId
- performanceGoalsUniqID:
$request.path.performanceGoalsUniqID
Checks if the performance goal's evaluated in 1 or more performance documents and included in 1 or more check-in documents. - GoalPlanId:
- copyGoal
-
Parameters:
- GoalPlanId:
$request.path.GoalPlanId
- performanceGoalsUniqID:
$request.path.performanceGoalsUniqID
Copies a performance goal and creates a new performance goal that has the same attributes as the goal that's copied. - GoalPlanId:
- goalAssignAction
-
Parameters:
- GoalPlanId:
$request.path.GoalPlanId
- performanceGoalsUniqID:
$request.path.performanceGoalsUniqID
Assigns a performance goal to the selected employees. - GoalPlanId: