Get all performance goals
get
/hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/performanceGoals
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=
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 -
finder: string
Used as a predefined finder to search the collection.
Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables- PrimaryKey Finds a performance goal that matches the primary key criteria specified.
Finder Variables- GoalId; integer; Unique identifier for a performance goal.
- GoalPlanGoalId; integer; Unique identifier for the performance goal in the goal plan.
- findByGoalId Finds a performance goal that has a specified Goal ID.
Finder Variables- GoalId; integer; Unique identifier for a performance goal.
- findByObjectId Finds the performance goal that matches the specified performance goal identifier after loading the approval data from the transaction store.
Finder Variables- AssignmentId; integer; Unique identifier for the assignment of the person who's assigned the 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; 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.
- GoalId; integer; Unique identifier for the performance goal submitted for approval.
- GoalPlanId; integer; Unique identifier of the goal plan.
- ObjectId; integer; Unique identifier for the goal plan assigned to the employee.
- PersonId; integer; Unique identifier of the person who's assigned the performance goal.
- ReviewPeriodId; integer; Unique identifier for the review period.
- findGoalByEvaluationId Finds a performance goal that matches the specified performance document ID.
Finder Variables- EvaluationId; integer; Unique identifier for the performance document that includes the performance goals section.
- GoalId; integer; Unique identifier for the performance goal that's included in the performance document.
- PrimaryKey Finds a performance goal that matches the primary key criteria specified.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
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 -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- ActualCompletionDate; string; Actual completion date of the performance goal.
- AllowDelGoalCode; string; Indicates if managers or workers can delete the performance goal.
- AllowDelGoalFlag; boolean; Indicates if managers or workers can delete the performance goal.
- AllowKeyAttrUpdateFlag; boolean; Indicates if managers or workers can update the key attributes of a performance goal.
- AssignedByPersonId; integer; Unique identifier for the HR specialist or manager who assigns the performance goal.
- AssignmentId; integer; Unique identifier for the job assignment of a worker.
- AssignmentNumber; string; Unique assignment number for a worker assignment.
- CategoryCode; string; Category code of a performance goal.
- CategoryMeaning; string; 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; 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.
- Description; string; Description of the performance goal.
- DisplaySequence; integer; Display sequence of goals in the goal plan.
- GoalApprovalState; string; Approval state of the goal.
- GoalId; integer; Unique identifier for a performance goal.
- GoalName; string; Name of the performance goal.
- GoalPlanGoalId; integer; Unique identifier for the performance goal in the goal plan.
- GoalPlanId; integer; Unique identifier of the goal plan.
- GoalSourceCode; string; 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; Code that indicates the goal's subtype.
- GoalSubtypeMeaning; string; Code used in HCM_LOOKUPS for the goal's subtype.
- GoalVersionTypeCode; string; Version type code of the performance goal.
- LevelCode; string; Code that indicates the performance goal level.
- LevelMeaning; string; Performance goal level, which can be Target or Stretch.
- LongDescription; string; Long description of the performance goal.
- MassRequestId; integer; Unique identifier for the mass assignment or mass share request.
- PercentCompletion; string; Completion percentage of the performance goal.
- PersonId; integer; Unique identifier for the worker who's assigned the performance goal.
- PersonNumber; string; Person number of the worker who's assigned the performance goal.
- PriorityCode; string; Priority code of the performance goal.
- PriorityMeaning; string; Priority of the performance goal, which can be High, Medium, or Low.
- PrivateFlag; boolean; Indicates if the performance goal is private or not.
- PublishDate; string; The date the performance goal was published as an organization goal.
- PublishedFlag; boolean; Indicates whether the current goal has been published as an organization goal.
- RelatedLink; string; Related link of the performance goal.
- RequestContext; string; 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.
- ReviewPeriodId; integer; Unique Identifier for the review period that the goal plan of the performance goal is associated with.
- StartDate; string; Start date of the performance goal.
- StatusCode; string; Code that indicates the status of the performance goal.
- StatusMeaning; string; Status of the performance goal.
- TargetCompletionDate; string; Targeted completion date of the performance goal.
- Weighting; number; Weight of the performance goal.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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 : goalPlans-performanceGoals
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested 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
Title:
Meaning
Read Only:true
Maximum Length:80
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. -
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:80
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:80
Performance goal level, which can be Target or Stretch. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
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:80
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. -
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. -
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:80
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
- buildBipReportUrlForGoals
-
Parameters:
- GoalPlanId:
$request.path.GoalPlanId
Generates the report URL for performance or development goals. - GoalPlanId:
- getPerformanceGoalDetails
-
Parameters:
- GoalPlanId:
$request.path.GoalPlanId
Gets details of a performance goal. - GoalPlanId:
- getPerformanceLibraryGoalDetails
-
Parameters:
- GoalPlanId:
$request.path.GoalPlanId
Gets all details of the specified performance library goal. - GoalPlanId:
- goalApprovalTransactionData
-
Parameters:
- GoalPlanId:
$request.path.GoalPlanId
Gets performance goal plan approval transaction status data and optionally loads the transaction data. - GoalPlanId:
- prepareApprovalTxnForSubmission
-
Parameters:
- GoalPlanId:
$request.path.GoalPlanId
Clears existing comments and removes files attached to the performance goals approval request. - GoalPlanId:
- savePerfGoalApproval
-
Parameters:
- GoalPlanId:
$request.path.GoalPlanId
Saves data of a performance goal and its associated tasks and measurements for processing approvals. - GoalPlanId:
- submitEss
-
Operation: /hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/performanceGoals/action/submitEssParameters:
- GoalPlanId:
$request.path.GoalPlanId
Submits mass assignment process for performance goals that matches the specified mass assignment request ID. - GoalPlanId: