Get a development goal
get
/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.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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.
There's no request body for this operation.
Back to TopResponse
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:
StatusMaximum Length:30Indicates if the development goal is active or not. -
ActualCompletionDate: string
(date)
Title:
Actual Completion DateActual completion date of development goal. -
AllowKeyAttrUpdateFlag: boolean
Title:
Allow Workers to Update Key AttributesMaximum Length:30Default Value:trueIndicates if managers or workers can update the key attributes of a development goal. -
AssignedByPersonId: integer
(int64)
Title:
Created ByUnique identifier for the person who assigned the development goal. -
CategoryCode: string
Title:
CategoryMaximum Length:30Category code of a development goal. -
CategoryMeaning: string
Title:
CategoryRead Only:trueMaximum Length:255Category for the development goal. -
Comments: string
(byte)
Title:
Goal-specific CommentsComments for the development goal. -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64User who created the development goal. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueDate the development goal was created. -
Description: string
Title:
DescriptionMaximum Length:4000Description for the development goal. -
GoalApprovalState: string
Maximum Length:
30Approval state of the development goal. -
GoalId: integer
(int64)
Title:
Goal IDUnique identifier for the development goal. -
GoalName: string
Title:
Goal NameMaximum Length:400Name of the development goal. -
GoalSourceCode: string
Title:
SourceMaximum Length:30Source 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 TypeMaximum Length:30Default Value:ACTIVEVersion code of the development goal. -
LastModifiedDate: string
(date-time)
Title:
Last UpdatedDate the development goal was last modified. -
LastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueDate the development goal was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64User who last updated the development goal. -
LevelCode: string
Title:
LevelMaximum Length:30Code that indicates the development goal level. -
LevelMeaning: string
Title:
LevelRead Only:trueMaximum Length:255Level of the development goal. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LoggedInPersonType: string
Read Only:
trueMaximum Length:255Person type of the logged in person. -
MassRequestId: integer
(int64)
Unique identifier for the mass assignment request for development goals.
-
PercentComplete: string
Title:
Completion PercentageMaximum Length:30Goal completion percentage code. -
PersonId: integer
(int64)
Title:
Person IDUnique identifier for the person who's assigned the development goal. -
PersonNumber: string
Title:
Person NumberRead Only:trueMaximum Length:30Person number of the person who's assigned the development goal. -
PriorityCode: string
Title:
PriorityMaximum Length:30Default Value:MEDIUMPriority code of the development goal. -
PriorityMeaning: string
Title:
PriorityRead Only:trueMaximum Length:255Priority of the development goal. -
PrivateFlag: boolean
Title:
PrivateMaximum Length:30Default Value:falseIndicates if the development goal is private or not. -
RequestContext: string
Maximum Length:
30Indicates 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 DateStart date of the development goal. -
Status: string
Title:
StatusMaximum Length:30Default Value:NOT_STARTEDStatus code of the development goal. -
StatusMeaning: string
Read Only:
trueMaximum Length:255Meaning of status code of development goal. -
SuccessCriteria: string
(byte)
Title:
Success CriteriaSuccess criteria of the development goal. -
TargetCompletionDate: string
(date)
Title:
Target Completion DateTarget completion date for the development goal.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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: