Update a payment plan role
patch
/fscmRestApi/resources/11.13.18.05/incentiveCompensationPaymentPlans/{PaymentPlanId}/child/PaymentPlanRoles/{RolePaymentPlanId}
Request
Path Parameters
-
PaymentPlanId(required): integer(int64)
The unique identifier of the payment plan.
-
RolePaymentPlanId(required): integer(int64)
The unique identifier of the role associated with a payment plan.
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
-
EndDate: string
(date)
Title:
End Date
The date when the role assignment for a payment plan becomes inactive. The acceptable format is yyyy-mm-dd. The date must be equal to or earlier than the payment plan end date. -
PaymentPlanId: integer
(int64)
The unique identifier of the payment plan.
-
RoleId: integer
(int64)
The unique identifier off the payment plan role.
-
StartDate: string
(date)
Title:
Start Date
The date when the role assignment for a payment plan becomes active. The acceptable format is yyyy-mm-dd. The date must be equal to or later than the payment plan 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 : incentiveCompensationPaymentPlans-PaymentPlanRoles-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the payment plan role assignment. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the payment plan role assignment is created. -
Description: string
Title:
Role Description
Read Only:true
Maximum Length:120
A brief description of the payment plan role. -
EndDate: string
(date)
Title:
End Date
The date when the role assignment for a payment plan becomes inactive. The acceptable format is yyyy-mm-dd. The date must be equal to or earlier than the payment plan end date. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the payment plan role assignment was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the payment plan role assignment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PaymentPlanId: integer
(int64)
The unique identifier of the payment plan.
-
RoleId: integer
(int64)
The unique identifier off the payment plan role.
-
RoleName: string
Title:
Role Name
Read Only:true
Maximum Length:60
The name of the role. -
RolePaymentPlanId: integer
(int64)
The unique identifier of the role associated with a payment plan.
-
StartDate: string
(date)
Title:
Start Date
The date when the role assignment for a payment plan becomes active. The acceptable format is yyyy-mm-dd. The date must be equal to or later than the payment plan start 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.
Links
- RoleVO
-
The list of values containing the unique identifiers of the incentive compensation roles.
The following properties are defined on the LOV link relation:- Source Attribute: RoleId; Target Attribute: RoleId
- Display Attribute: RoleName, RoleId, AccessType