Update a pay group
patch
/fscmRestApi/resources/11.13.18.05/incentiveCompensationPayGroups/{PayGroupId}
Request
Path Parameters
-
PayGroupId(required): integer(int64)
The unique identifier of the pay group.
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
Description: string
Title:
Pay Group Description
Maximum Length:999
A brief description of the pay group. -
EndDate: string
(date)
Title:
End Date
The date when the pay group becomes inactive. The acceptable format is yyyy-mm-dd. -
OrgId: integer
(int64)
Title:
Business Unit
The unique identifier of the business unit to which the pay group belongs. Review the business unit ID for a business unit using the Setup and Maintenance, Define Business Units task. If the Business Unit ID column is not displayed, then click the View menu to add the Business Unit ID column. -
PayGroupAssignments: array
Pay Group Assignments
Title:
Pay Group Assignments
The pay group assignments resource is used to view, create, update or delete an incentive compensation assignments for pay group. -
PayGroupId: integer
(int64)
The unique identifier of the pay group.
-
PayGroupName: string
Title:
Name
Maximum Length:80
The name of the incentive compensation pay group. The combination of the name and business unit must be unique. -
PayGroupRoles: array
Pay Group Roles
Title:
Pay Group Roles
The pay group roles resource is used to view, create, update, and delete an incentive compensation role assignment for a pay group. -
PayGroupType: string
Title:
Pay Group Type
Maximum Length:30
The code indicating the type of pay group, for example, for payroll or for payables. Possible values include ORACLE_PAYROLL and ORACLE_AP. A list of acceptable values is defined in the lookup CN_PAY_GROUP_TYPE. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task. -
StartDate: string
(date)
Title:
Start Date
The date when the pay group becomes active. The acceptable format is yyyy-mm-dd.
Nested Schema : Pay Group Assignments
Type:
array
Title:
Pay Group Assignments
The pay group assignments resource is used to view, create, update or delete an incentive compensation assignments for pay group.
Show Source
Nested Schema : Pay Group Roles
Type:
array
Title:
Pay Group Roles
The pay group roles resource is used to view, create, update, and delete an incentive compensation role assignment for a pay group.
Show Source
Nested Schema : incentiveCompensationPayGroups-PayGroupAssignments-item-patch-request
Type:
Show Source
object
-
EndDate: string
(date)
Title:
End Date
The date when the assignment for a pay group becomes inactive. The acceptable format is yyyy-mm-dd. -
ParticipantId: integer
(int64)
Title:
Participant Identifier
The unique identifier for a participant. -
StartDate: string
(date)
Title:
Start Date
The date when the assignment becomes active. The acceptable format is yyyy-mm-dd.
Nested Schema : incentiveCompensationPayGroups-PayGroupRoles-item-patch-request
Type:
Show Source
object
-
EndDate: string
(date)
Title:
End Date
The date when the role assignment for a pay group becomes inactive. The acceptable format is yyyy-mm-dd. The date must be equal to or earlier than the pay group end date. The default value is the pay group end date. -
PayGroupId: integer
(int64)
The unique identifier of the pay group.
-
RoleId: integer
(int64)
Title:
Name
The unique identifier of a pay group role. -
StartDate: string
(date)
Title:
Start Date
The date when the role assignment for a pay group becomes active. The acceptable format is yyyy-mm-dd. The date must be equal to or later than the pay group start date. The default value is the pay group start 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 : incentiveCompensationPayGroups-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the pay group. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the pay group is created. -
Description: string
Title:
Pay Group Description
Maximum Length:999
A brief description of the pay group. -
EndDate: string
(date)
Title:
End Date
The date when the pay group becomes inactive. The acceptable format is yyyy-mm-dd. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the pay group was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the pay group. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrgId: integer
(int64)
Title:
Business Unit
The unique identifier of the business unit to which the pay group belongs. Review the business unit ID for a business unit using the Setup and Maintenance, Define Business Units task. If the Business Unit ID column is not displayed, then click the View menu to add the Business Unit ID column. -
PayGroupAssignments: array
Pay Group Assignments
Title:
Pay Group Assignments
The pay group assignments resource is used to view, create, update or delete an incentive compensation assignments for pay group. -
PayGroupId: integer
(int64)
The unique identifier of the pay group.
-
PayGroupName: string
Title:
Name
Maximum Length:80
The name of the incentive compensation pay group. The combination of the name and business unit must be unique. -
PayGroupRoles: array
Pay Group Roles
Title:
Pay Group Roles
The pay group roles resource is used to view, create, update, and delete an incentive compensation role assignment for a pay group. -
PayGroupType: string
Title:
Pay Group Type
Maximum Length:30
The code indicating the type of pay group, for example, for payroll or for payables. Possible values include ORACLE_PAYROLL and ORACLE_AP. A list of acceptable values is defined in the lookup CN_PAY_GROUP_TYPE. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task. -
StartDate: string
(date)
Title:
Start Date
The date when the pay group becomes active. The acceptable format is yyyy-mm-dd.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Pay Group Assignments
Type:
array
Title:
Pay Group Assignments
The pay group assignments resource is used to view, create, update or delete an incentive compensation assignments for pay group.
Show Source
Nested Schema : Pay Group Roles
Type:
array
Title:
Pay Group Roles
The pay group roles resource is used to view, create, update, and delete an incentive compensation role assignment for a pay group.
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.
Nested Schema : incentiveCompensationPayGroups-PayGroupAssignments-item-response
Type:
Show Source
object
-
AnalystId: integer
(int64)
Title:
Analyst
Read Only:true
The unique identifier of the analyst assigned to the pay group. -
AnalystName: string
Title:
Analyst Name
Read Only:true
Maximum Length:360
The name of the analyst assigned to the pay group. -
AssignmentType: string
Title:
Assignment Type
Read Only:true
The assignment type for the pay group. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the pay group assignment. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the pay group assignment is created. -
EndDate: string
(date)
Title:
End Date
The date when the assignment for a pay group becomes inactive. The acceptable format is yyyy-mm-dd. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the pay group assignment was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the pay group assignment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ParticipantId: integer
(int64)
Title:
Participant Identifier
The unique identifier for a participant. -
ParticipantName: string
Title:
Participant Name
Read Only:true
Maximum Length:360
The name of the participant in incentive compensation. -
ParticipantPayGroupId: integer
(int64)
The unique identifier of the participant pay group assignment record.
-
PersonNumber: string
Title:
Person Number
Read Only:true
Maximum Length:30
The Fusion HCM specific identifier that uniquely identifies a person in the application, regardless of their relationship to the enterprise. It does not have any relation to any national identifier component. -
RoleId: integer
(int64)
Read Only:
true
The unique identifier off the pay group role. -
RoleName: string
Title:
Role Name
Read Only:true
Maximum Length:60
The name of the role. -
StartDate: string
(date)
Title:
Start Date
The date when the assignment becomes active. The acceptable format is yyyy-mm-dd.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : incentiveCompensationPayGroups-PayGroupRoles-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the pay group role assignment. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the pay group role assignment is created. -
EndDate: string
(date)
Title:
End Date
The date when the role assignment for a pay group becomes inactive. The acceptable format is yyyy-mm-dd. The date must be equal to or earlier than the pay group end date. The default value is the pay group end date. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the pay group role assignment was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the pay group role assignment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PayGroupId: integer
(int64)
The unique identifier of the pay group.
-
RoleDescription: string
Title:
Role Description
Read Only:true
Maximum Length:120
A brief description of the pay group role. -
RoleId: integer
(int64)
Title:
Name
The unique identifier of a pay group role. -
RoleName: string
Title:
Role Name
Read Only:true
Maximum Length:60
The name of the pay group role. -
RolePayGroupId: integer
(int64)
The unique identifier of the role associated with a pay group.
-
StartDate: string
(date)
Title:
Start Date
The date when the role assignment for a pay group becomes active. The acceptable format is yyyy-mm-dd. The date must be equal to or later than the pay group start date. The default value is the pay group start date.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- BusinessUnitPVO
-
The list of values containing the unique identifiers of the business units.
The following properties are defined on the LOV link relation:- Source Attribute: OrgId; Target Attribute: OrganizationId
- Display Attribute: Name
- CnLookupPayGroupTypeVO
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DCN_PAY_GROUP_TYPE
The list of values for the type of pay group.
The following properties are defined on the LOV link relation:- Source Attribute: PayGroupType; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- PayGroupAssignments
-
Parameters:
- PayGroupId:
$request.path.PayGroupId
The pay group assignments resource is used to view, create, update or delete an incentive compensation assignments for pay group. - PayGroupId:
- PayGroupRoles
-
Operation: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPayGroups/{PayGroupId}/child/PayGroupRolesParameters:
- PayGroupId:
$request.path.PayGroupId
The pay group roles resource is used to view, create, update, and delete an incentive compensation role assignment for a pay group. - PayGroupId: