Get a development goal
get
/hcmRestApi/resources/11.13.18.05/searchDevGoals/{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=
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 : searchDevGoals-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
Date when the development goal was actually completed. -
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. -
AssignmentId: integer
(int64)
Title:
Assignment ID
Unique identifier for the assignment of the person who's assigned the development goal. -
AssignmentName: string
Title:
Assignment Name
Read Only:true
Maximum Length:80
Assignment name of the person who's assigned the development goal. -
AssignmentNumber: string
Title:
Assignment Number
Read Only:true
Maximum Length:30
Assignment number of the person who's assigned the development goal. -
AssignmentType: string
Title:
Assignment Type
Read Only:true
Maximum Length:30
Assignment type of the person who's assigned the development goal. -
BusinessUnitId: integer
(int64)
Read Only:
true
Unique identifier for the business unit of the person who's assigned the development goal. -
BusinessUnitName: string
Title:
Business Unit
Read Only:true
Maximum Length:240
Name of the business unit of the person who's 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. -
DepartmentId: integer
(int64)
Read Only:
true
Unique identifier for the department of the person who's assigned the development goal. -
DepartmentName: string
Title:
Department
Read Only:true
Maximum Length:240
Name of the department of the person who's assigned the development goal. -
Description: string
Title:
Description
Maximum Length:4000
Description for the development goal. -
DisplayName: string
Title:
Name
Read Only:true
Maximum Length:240
Display name of the person who's assigned the development goal. -
GoalApprovalState: string
Maximum Length:
30
Search Development Goals -
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. -
JobName: string
Title:
Job
Read Only:true
Maximum Length:240
Job name of the person who's assigned the development goal. -
LastModifiedBy: integer
(int64)
Title:
Updated By
User who last updated 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. -
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. -
LocationId: integer
(int64)
Read Only:
true
Unique identifier for the location of the person who's assigned the development goal. -
LocationName: string
Title:
Display Name
Read Only:true
Maximum Length:240
Name of the location of the person who's assigned the development goal. -
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. -
PositionName: string
Title:
Position
Read Only:true
Maximum Length:240
Position name 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
-
Operation: /hcmRestApi/resources/11.13.18.05/searchDevGoals/{GoalId}/action/checkGoalInPDAndCheckInDocParameters:
- GoalId:
$request.path.GoalId
- GoalId:
- copyGoal
-
Parameters:
- GoalId:
$request.path.GoalId
Copies the attributes of a development goal and creates a new development goal. - GoalId:
- goalAssignAction
-
Parameters:
- GoalId:
$request.path.GoalId
Assigns a development goal to the selected employees. - GoalId: