Update a development goal
patch
/hcmRestApi/resources/11.13.18.05/devGoalsMassAssignProcess/{devGoalsMassAssignProcessUniqID}/child/devGoals/{GoalId}
Request
Path Parameters
-
GoalId(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=
-
devGoalsMassAssignProcessUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Development Goals Mass Assignment Process resource and used to uniquely identify an instance of Development Goals Mass Assignment Process. The client should not generate the hash key value. Instead, the client should query on the Development Goals Mass Assignment Process collection resource in order to navigate to a specific instance of Development Goals Mass Assignment Process 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
-
ActiveFlag: boolean
Title:
Status
Maximum Length:30
Indicates if the development goal is active or not. -
ActualCompletionDate: string
(date)
Title:
Actual Completion Date
Actual completion date of development 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 development goal. -
AssignedByPersonId: integer
(int64)
Title:
Created By
Unique identifier for the person who assigned the development goal. -
CategoryCode: string
Title:
Category
Maximum Length:30
Category code of a development goal. -
Comments: string
(byte)
Title:
Goal-specific Comments
Comments for the development goal. -
Description: string
Title:
Description
Maximum Length:4000
Description for the development goal. -
GoalApprovalState: string
Maximum Length:
30
Approval state of the development goal. -
GoalName: string
Title:
Goal Name
Maximum Length:400
Name of the development goal. -
GoalSourceCode: string
Title:
Source
Maximum Length:30
Source code that indicates who created the development goal. A development goal can be created by a worker, a manager, or an HR specialist. -
GoalVersionTypeCode: string
Title:
Goal Version Type
Maximum Length:30
Default Value:ACTIVE
Version code of the development goal. -
LastModifiedDate: string
(date-time)
Title:
Last Updated
Date the development goal was last modified. -
LevelCode: string
Title:
Level
Maximum Length:30
Code that indicates the development goal level. -
PercentComplete: string
Title:
Completion Percentage
Maximum Length:30
Goal completion percentage code. -
PriorityCode: string
Title:
Priority
Maximum Length:30
Default Value:MEDIUM
Priority code of the development goal. -
PrivateFlag: boolean
Title:
Private
Maximum Length:30
Default Value:false
Indicates if the development goal is private or not. -
RequiresApprovalStatus: string
Indicates if the development goal needs to be approved.
-
StartDate: string
(date)
Title:
Start Date
Start date of the development goal. -
Status: string
Title:
Status
Maximum Length:30
Default Value:NOT_STARTED
Status code of the development goal. -
SuccessCriteria: string
(byte)
Title:
Success Criteria
Success criteria of the development goal. -
TargetCompletionDate: string
(date)
Title:
Target Completion Date
Target completion date for the development 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 : devGoalsMassAssignProcess-devGoals-item-response
Type:
Show Source
object
-
ActiveFlag: boolean
Title:
Status
Maximum Length:30
Indicates if the development goal is active or not. -
ActualCompletionDate: string
(date)
Title:
Actual Completion Date
Actual completion date of development 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 development goal. -
AssignedByPersonId: integer
(int64)
Title:
Created By
Unique identifier for the person who assigned the development goal. -
CategoryCode: string
Title:
Category
Maximum Length:30
Category code of a development goal. -
CategoryMeaning: string
Title:
Category
Read Only:true
Maximum Length:255
Category for the development goal. -
Comments: string
(byte)
Title:
Goal-specific Comments
Comments for the development goal. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
User who created the development goal. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date the development goal was created. -
Description: string
Title:
Description
Maximum Length:4000
Description for the development goal. -
GoalApprovalState: string
Maximum Length:
30
Approval state of the development goal. -
GoalId: integer
(int64)
Title:
Goal ID
Unique identifier for the development goal. -
GoalName: string
Title:
Goal Name
Maximum Length:400
Name of the development goal. -
GoalSourceCode: string
Title:
Source
Maximum Length:30
Source code that indicates who created the development goal. A development goal can be created by a worker, a manager, or an HR specialist. -
GoalVersionTypeCode: string
Title:
Goal Version Type
Maximum Length:30
Default Value:ACTIVE
Version code of the development goal. -
LastModifiedDate: string
(date-time)
Title:
Last Updated
Date the development goal was last modified. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
Date the development goal was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
User who last updated the development goal. -
LevelCode: string
Title:
Level
Maximum Length:30
Code that indicates the development goal level. -
LevelMeaning: string
Title:
Level
Read Only:true
Maximum Length:255
Level of the development goal. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MassRequestId: integer
(int64)
Unique identifier for the mass assignment request for development goals.
-
PercentComplete: string
Title:
Completion Percentage
Maximum Length:30
Goal completion percentage code. -
PersonId: integer
(int64)
Title:
Person ID
Unique identifier for the person who's assigned the development goal. -
PersonNumber: string
Title:
Person Number
Read Only:true
Maximum Length:30
Person number of the person who's assigned the development goal. -
PriorityCode: string
Title:
Priority
Maximum Length:30
Default Value:MEDIUM
Priority code of the development goal. -
PriorityMeaning: string
Title:
Priority
Read Only:true
Maximum Length:255
Priority of the development goal. -
PrivateFlag: boolean
Title:
Private
Maximum Length:30
Default Value:false
Indicates if the development goal is private or not. -
RequestContext: string
Maximum Length:
30
Indicates the flow from which the development goal was created. The goal could have been added from a Talent Review meeting or by mass assignment. -
RequiresApprovalStatus: string
Indicates if the development goal needs to be approved.
-
StartDate: string
(date)
Title:
Start Date
Start date of the development goal. -
Status: string
Title:
Status
Maximum Length:30
Default Value:NOT_STARTED
Status code of the development goal. -
StatusMeaning: string
Read Only:
true
Maximum Length:255
Meaning of status code of development goal. -
SuccessCriteria: string
(byte)
Title:
Success Criteria
Success criteria of the development goal. -
TargetCompletionDate: string
(date)
Title:
Target Completion Date
Target completion date for the development 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
- checkGoalInPDAndCheckInDoc
-
Parameters:
- GoalId:
$request.path.GoalId
- devGoalsMassAssignProcessUniqID:
$request.path.devGoalsMassAssignProcessUniqID
Checks if the development goal's evaluated in 1 or more performance documents and included in 1 or more check-in documents. - GoalId:
- copyGoal
-
Parameters:
- GoalId:
$request.path.GoalId
- devGoalsMassAssignProcessUniqID:
$request.path.devGoalsMassAssignProcessUniqID
Copies the attributes of a development goal and creates a new development goal. - GoalId:
- goalAssignAction
-
Parameters:
- GoalId:
$request.path.GoalId
- devGoalsMassAssignProcessUniqID:
$request.path.devGoalsMassAssignProcessUniqID
Assigns a development goal to the selected employees. - GoalId: