Create an excluded worker for the goal plan
post
/hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/perfGoalExcludedWorkers
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
-
Effective-Of:
This header accepts a string value. The string is a semi-colon separated list of
= . It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers. -
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)
Unique identifier for the assignment of the worker excluded from the goal plan.
-
MassRequestExemptionId: integer
(int64)
Name of the excluded worker's manager.
-
PersonId: integer
(int64)
Title:
Person
Unique identifier for the mass request hierarchy. -
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-perfGoalExcludedWorkers-item-response
Type:
Show Source
object
-
AssignmentId: integer
(int64)
Unique identifier for the assignment of the worker excluded from the goal plan.
-
AssignmentName: string
Title:
Assignment Name
Read Only:true
Maximum Length:80
Name of the excluded worker's assignment. -
AssignmentNumber: string
Title:
Assignment Number
Read Only:true
Maximum Length:30
Assignment number of the excluded worker. -
AssignmentStatusType: string
Title:
Assignment Status
Read Only:true
Maximum Length:30
Status type for the assignment of the excluded worker. -
BusinessTitle: string
Title:
Job
Read Only:true
Maximum Length:255
Business title of the excluded worker. -
CreatedBy: string
Read Only:
true
Maximum Length:64
Name of the person who excluded the worker from the goal plan assignment. -
CreationDate: string
(date-time)
Read Only:
true
Date the worker was excluded from the goal plan assignment. -
DepartmentName: string
Title:
Department
Read Only:true
Maximum Length:255
Name of the excluded worker's department. -
DisplayName: string
Title:
Name
Read Only:true
Maximum Length:240
Display name of the worker who's excluded from the goal plan assignment. -
LastUpdateDate: string
(date-time)
Read Only:
true
Global user ID of the excluded worker. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
Date the details of the worker excluded from the goal plan was last updated. -
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 person who last updated the details of the worker who's excluded from the goal plan assignment. -
MassRequestExemptionId: integer
(int64)
Name of the excluded worker's manager.
-
MassRequestHierarchyId: integer
(int64)
Read Only:
true
Default Value:-1
Type of manager that excluded the worker. -
PersonId: integer
(int64)
Title:
Person
Unique identifier for the mass request hierarchy. -
PersonNumber: string
Title:
Person Number
Read Only:true
Maximum Length:30
Unique identifier for the mass goal plan assignment. -
PositionName: string
Title:
Position
Read Only:true
Maximum Length:255
Unique identifier for the excluded worker. -
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.