Create an included worker for the goal plan
post
/hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/perfGoalIncludedWorkers
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=
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AssignmentId: integer
(int64)
Title:
Manager Assignment
Unique identifier for the assignment of the worker included in the goal plan. -
CascadingLevel: integer
(int64)
Title:
Assignees
Code that determines which employees reporting to the requester will be assigned the performance goals in the goal plan. The performance goals can be assigned only to the requester, all direct reports of the requester, requester and their direct reports, all persons reporting to the requester, and requester and all persons reporting to the requester. -
MassRequestHierarchyId: integer
(int64)
Title:
Mass Request Hierarchy ID
Unique identifier for the mass request hierarchy. -
PersonId: integer
(int64)
Title:
Person
Unique identifier of the worker included in the goal plan. -
SysEffectiveDate: string
(date)
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-perfGoalIncludedWorkers-item-response
Type:
Show Source
object
-
AssignmentId: integer
(int64)
Title:
Manager Assignment
Unique identifier for the assignment of the worker included in the goal plan. -
AssignmentName: string
Title:
Assignment Name
Read Only:true
Maximum Length:80
Name of the assignment of the worker included in the goal plan. -
AssignmentNumber: string
Title:
Assignment Number
Read Only:true
Maximum Length:30
Assignment number of the worker included in the goal plan. -
AssignmentStatusType: string
Title:
Assignment Status
Read Only:true
Maximum Length:30
Assignment status type of the worker included in the goal plan. -
BusinessTitle: string
Title:
Job
Read Only:true
Maximum Length:255
Business title of the worker included in the goal plan. -
CascadingLevel: integer
(int64)
Title:
Assignees
Code that determines which employees reporting to the requester will be assigned the performance goals in the goal plan. The performance goals can be assigned only to the requester, all direct reports of the requester, requester and their direct reports, all persons reporting to the requester, and requester and all persons reporting to the requester. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who added the worker to the goal plan. -
CreationDate: string
(date-time)
Read Only:
true
Date the worker was included in the goal plan. -
DepartmentName: string
Title:
Department
Read Only:true
Maximum Length:255
Name of the department that the included worker belongs to. -
DirectsCount: integer
Read Only:
true
Count of direct reports of a manager. -
DisplayName: string
Title:
Name
Read Only:true
Maximum Length:240
Display name of the included worker. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date the details of the worker included in the goal plan was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who last updated the details of the worker included in the goal plan. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ManagerName: string
Title:
Manager Name
Read Only:true
Maximum Length:255
Name of the manager of the included worker. -
MassRequestHierarchyId: integer
(int64)
Title:
Mass Request Hierarchy ID
Unique identifier for the mass request hierarchy. -
PersonId: integer
(int64)
Title:
Person
Unique identifier of the worker included in the goal plan. -
PersonNumber: string
Title:
Person Number
Read Only:true
Maximum Length:30
Person number of the worker included in the goal plan. -
PositionName: string
Title:
Position
Read Only:true
Maximum Length:255
Name of the position of the worker included in the goal plan. -
SysEffectiveDate: string
(date)
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.