Update a participant role
patch
/fscmRestApi/resources/11.13.18.05/incentiveCompensationParticipants/{incentiveCompensationParticipantsUniqID}/child/ParticipantRoles/{ParticipantRoleId}
Request
Path Parameters
-
ParticipantRoleId(required): integer(int64)
The unique identifier for the participant role.
-
incentiveCompensationParticipantsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Participants resource and used to uniquely identify an instance of Participants. The client should not generate the hash key value. Instead, the client should query on the Participants collection resource in order to navigate to a specific instance of Participants to get the hash key.
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
-
EndDateActive: string
(date)
Title:
Role End Date
The date when the role assignment ends for that participant. The format is yyyy-mm-dd. -
PreserveRoleAssignmentFlag: boolean
Title:
Preserve Assignment
Indicates whether to keep the role assignment and to prevent update by the automatic the role assignment process. Possible values include TRUE to prevent update. In cases where the Role is added manually to participants, the Preserve Assignment is set as True, and FALSE to allow update. -
StartDateActive: string
(date)
Title:
Role Start Date
The date when the role assignment starts for a participant. This is a mandatory field. The format is yyyy-mm-dd.
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 : incentiveCompensationParticipants-ParticipantRoles-item-response
Type:
Show Source
object
-
AccessType: string
Title:
Access Type
Read Only:true
Maximum Length:30
Default Value:INDIVIDUAL
The lookup code that represents the access type, such as manager or individual. Possible values include INDIVIDUAL which specifies that the participant access is individual, and MANAGER which specifies that the participant access is manager. The default value is INDIVIDUAL. A list of acceptable values is defined in the lookup CN_ACCESS_TYPE. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the record was created. -
EndDateActive: string
(date)
Title:
Role End Date
The date when the role assignment ends for that participant. The format is yyyy-mm-dd. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The session login of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ParticipantId: integer
(int64)
Title:
Participant Identifier
The unique identifier of the participant record. -
ParticipantRoleId: integer
(int64)
Title:
Participant Role ID
The unique identifier for the participant role. -
PreserveRoleAssignmentFlag: boolean
Title:
Preserve Assignment
Indicates whether to keep the role assignment and to prevent update by the automatic the role assignment process. Possible values include TRUE to prevent update. In cases where the Role is added manually to participants, the Preserve Assignment is set as True, and FALSE to allow update. -
RoleId: integer
(int64)
Title:
Role ID
The unique identifier for a role assigned to a participant record. -
RoleName: string
Title:
Role Name
Read Only:true
Maximum Length:60
The name of the role. -
StartDateActive: string
(date)
Title:
Role Start Date
The date when the role assignment starts for a participant. This is a mandatory field. The format is yyyy-mm-dd.
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
- CnLookupAccessTypeVO
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DCN_ACCESS_TYPE
The list of values containing the lookup codes that represent the access type, such as a manager or individual. Possible values include INDIVIDUAL which specifies that the participant access is individual, and MANAGER which specifies that the participant access is manager. The default value is INDIVIDUAL.
The following properties are defined on the LOV link relation:- Source Attribute: AccessType; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- RolesVO
-
Parameters:
- finder:
SearchActiveRoles
The list of values containing the unique identifiers of roles.
The following properties are defined on the LOV link relation:- Source Attribute: RoleId; Target Attribute: RoleId
- Display Attribute: RoleName
- finder: