Create an incentive compensation role
/fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles
Request
-
Metadata-Context: string
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: string
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: string
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.
- application/json
object-
AccessType: string
Title:
Access TypeMaximum Length:30Default Value:INDIVIDUAL -
ActiveFlag: boolean
Title:
ActiveMaximum Length:1Default Value:true -
RoleDescription: string
Title:
Role DescriptionMaximum Length:120 -
RoleId: integer
(int64)
-
RoleName(required): string
Title:
NameMaximum Length:60 -
RoleParticipants: array
Role - Participants
Title:
Role - ParticipantsThe role - participants resource is used to view, create, update, and delete the participants that can be assigned an incentive compensation role.
arrayRole - Participantsobject-
EndDateActive: string
(date)
Title:
Assignment End Date -
ParticipantId: integer
(int64)
Title:
Participant Name -
ParticipantRoleId: integer
(int64)
-
PreserveRoleAssignmentFlag: boolean
Title:
Preserve Assignment -
RoleId: integer
(int64)
Title:
Name -
StartDateActive: string
(date)
Title:
Assignment Start Date
Response
- application/json
Default Response
-
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.
object-
AccessType: string
Title:
Access TypeMaximum Length:30Default Value:INDIVIDUAL -
ActiveFlag: boolean
Title:
ActiveMaximum Length:1Default Value:true -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64 -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:true -
LastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:true -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64 -
LastUpdateLogin: string
Title:
Last Update LoginRead Only:trueMaximum Length:32 -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
RoleDescription: string
Title:
Role DescriptionMaximum Length:120 -
RoleId: integer
(int64)
-
RoleName: string
Title:
NameMaximum Length:60 -
RoleParticipants: array
Role - Participants
Title:
Role - ParticipantsThe role - participants resource is used to view, create, update, and delete the participants that can be assigned an incentive compensation role.
arrayLinksarrayRole - Participantsobject-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]The name of the relation to the resource instance. Example: self.
object-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
object-
ActiveFlag: boolean
Title:
ActiveRead Only:trueMaximum Length:1 -
AnalystName: string
Title:
AnalystRead Only:trueMaximum Length:360 -
CompensationEndDate: string
(date)
Title:
Compensation End DateRead Only:true -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64 -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:true -
EndDateActive: string
(date)
Title:
Assignment End Date -
HoldPaymentFlag: boolean
Title:
Hold paymentRead Only:trueMaximum Length:1 -
HRPersonNumber: string
Title:
Person NumberRead Only:trueMaximum Length:30 -
HRPrimaryWorkerNumber: string
Title:
Worker NumberRead Only:trueMaximum Length:30 -
LastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:true -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64 -
LastUpdateLogin: string
Title:
Last Update LoginRead Only:trueMaximum Length:32 -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
OrgId: integer
(int64)
Title:
Business UnitRead Only:true -
ParticipantId: integer
(int64)
Title:
Participant Name -
ParticipantName: string
Title:
Participant NameRead Only:trueMaximum Length:360 -
ParticipantRoleId: integer
(int64)
-
ParticipantType: string
Title:
TypeRead Only:trueMaximum Length:60 -
PartyNumber: string
Title:
Party NumberRead Only:trueMaximum Length:30 -
PayeeOnly: string
Title:
Payee OnlyRead Only:trueMaximum Length:1 -
PreserveRoleAssignmentFlag: boolean
Title:
Preserve Assignment -
RoleId: integer
(int64)
Title:
Name -
StartDateActive: string
(date)
Title:
Assignment Start Date
arrayLinks- CnLookupAccessTypeVO
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DCN_ACCESS_TYPE
The standard lookups list of values resource is used to query the list of values of standard lookups, which list the available codes and translated meanings. Standard lookups are defined in the standard lookups view and store lookup codes that support reference data sharing. - finder:
- CnLookupYesNoVO
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DCN_YES_NO
The standard lookups list of values resource is used to query the list of values of standard lookups, which list the available codes and translated meanings. Standard lookups are defined in the standard lookups view and store lookup codes that support reference data sharing. - finder:
- RoleParticipants
-
Operation: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles/{RoleId}/child/RoleParticipantsParameters:
- RoleId:
$request.path.RoleId
The role - participants resource is used to view, create, update, and delete the participants that can be assigned an incentive compensation role. - RoleId:
Examples
The following example shows how to create a role by submitting a POST request on the REST resource using cURL.
Create a Role without assigning participants
cURL Command
curl --user
sales_cloud_user -X POST -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles/
Example of Request Body
The following example shows the contents of the request body in JSON format.
{
"RoleName": "Sales Representative Role",
"ActiveFlag": true,
"RoleDescription": "All sales members in our team",
"AccessType": "INDIVIDUAL"
}
Example of Response Body
The following example shows the contents of the response body in JSON format.
{
"RoleName": "Sales Representative Role",
"ActiveFlag": true,
"RoleId": 300100089784737,
"RoleDescription": "All sales members in our team",
"CreatedBy": "OIC_MGR_OPERATIONS",
"CreationDate": "2017-03-16T15:39:40+05:30",
"LastUpdatedBy": "OIC_MGR_OPERATIONS",
"LastUpdateDate": "2017-03-16T15:39:40+05:30",
"LastUpdateLogin": "4AC7DE6005D2570AE0537F90B10A3DBA",
"AccessType": "INDIVIDUAL",
"links": [
{
"rel": "self",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles/300100089784737",
"name": "roles",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000003737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles/300100089784737",
"name": "roles",
"kind": "item"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles/300100089784737/lov/CnLookupYesNoVO",
"name": "CnLookupYesNoVO",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles/300100089784737/lov/CnLookupAccessTypeVO",
"name": "CnLookupAccessTypeVO",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles/300100089784737/child/RoleParticipants",
"name": "RoleParticipants",
"kind": "collection"
}
]
}
Create a Role with assigned participants
cURL Command
curl -u <username:password> \ -X POST -d @example_request_payload.json
https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles/300100089785736/child/RoleParticipants/300100089785737
Example of Request Body
The following example shows the contents of the request body in JSON format.
{
"RoleName": "Sales Representatives",
"ActiveFlag": true,
"RoleDescription": "All sales members in our team",
"AccessType": "INDIVIDUAL",
"RoleParticipants" : [
{
"StartDateActive": "2015-01-01",
"ParticipantId": 2001,
"EndDateActive": "2015-12-31",
"PreserveRoleAssignmentFlag": "true"
}
],
"RoleParticipants" : [
{
"StartDateActive": "2015-01-01",
"ParticipantId": 2002,
"EndDateActive": "2015-12-31",
"PreserveRoleAssignmentFlag": "true"
}
]
}
Example of Response Body
The following example shows the contents of the response body in JSON format.
{
"RoleName": "Sales Representatives",
"ActiveFlag": true,
"RoleId": 300100089785736,
"RoleDescription": "All sales members in our team",
"CreatedBy": "OIC_MGR_OPERATIONS",
"CreationDate": "2017-03-16T17:16:44+05:30",
"LastUpdatedBy": "OIC_MGR_OPERATIONS",
"LastUpdateDate": "2017-03-16T17:16:44+05:30",
"LastUpdateLogin": "4AC7DE6005D2570AE0537F90B10A3DBA",
"AccessType": "INDIVIDUAL",
"RoleParticipants": [
{
"ParticipantRoleId": 300100089785737,
"StartDateActive": "2015-01-01",
"ParticipantId": 2001,
"RoleId": 300100089785736,
"LastUpdateLogin": "4AC7DE6005D2570AE0537F90B10A3DBA",
"LastUpdatedBy": "OIC_MGR_OPERATIONS",
"LastUpdateDate": "2017-03-16T17:16:44+05:30",
"CreationDate": "2017-03-16T17:16:44+05:30",
"CreatedBy": "OIC_MGR_OPERATIONS",
"EndDateActive": "2015-12-31",
"ActiveFlag": true,
"HRPrimaryWorkerNumber": null,
"ParticipantType": "PARTICIPANT",
"PartyNumber": "300100005347180",
"CompensationEndDate": null,
"HoldPaymentFlag": false,
"OrgId": 204,
"HRPersonNumber": null,
"PayeeOnly": "N",
"ParticipantName": "IC_PARTY_VO_20111202135553",
"AnalystName": null,
"PreserveRoleAssignmentFlag": "true",
"links": [
{
"rel": "self",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles/300100089785736/child/RoleParticipants/300100089785737",
"name": "RoleParticipants",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000004737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles/300100089785736/child/RoleParticipants/300100089785737",
"name": "RoleParticipants",
"kind": "item"
},
{
"rel": "parent",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles/300100089785736",
"name": "roles",
"kind": "item"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles/300100089785736/child/RoleParticipants/300100089785737/lov/BusinessUnitPVO",
"name": "BusinessUnitPVO",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles/300100089785736/child/RoleParticipants/300100089785737/lov/ParticipantsVO",
"name": "ParticipantsVO",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles/300100089785736/child/RoleParticipants/300100089785737/lov/CnLookupParticipantTypeVO",
"name": "CnLookupParticipantTypeVO",
"kind": "collection"
}
]
},
{
"ParticipantRoleId": 300100089785738,
"StartDateActive": "2015-01-01",
"ParticipantId": 2002,
"RoleId": 300100089785736,
"LastUpdateLogin": "4AC7DE6005D2570AE0537F90B10A3DBA",
"LastUpdatedBy": "OIC_MGR_OPERATIONS",
"LastUpdateDate": "2017-03-16T17:16:44+05:30",
"CreationDate": "2017-03-16T17:16:44+05:30",
"CreatedBy": "OIC_MGR_OPERATIONS",
"EndDateActive": "2015-12-31",
"ActiveFlag": true,
"HRPrimaryWorkerNumber": null,
"ParticipantType": "PARTICIPANT",
"PartyNumber": "300100005347187",
"CompensationEndDate": null,
"HoldPaymentFlag": false,
"OrgId": 204,
"HRPersonNumber": null,
"PayeeOnly": "N",
"ParticipantName": "IC_PARTY_VO_20111202141139",
"AnalystName": null,
"PreserveRoleAssignmentFlag": "true",
"links": [
{
"rel": "self",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles/300100089785736/child/RoleParticipants/300100089785738",
"name": "RoleParticipants",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000004737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles/300100089785736/child/RoleParticipants/300100089785738",
"name": "RoleParticipants",
"kind": "item"
},
{
"rel": "parent",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles/300100089785736",
"name": "roles",
"kind": "item"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles/300100089785736/child/RoleParticipants/300100089785738/lov/BusinessUnitPVO",
"name": "BusinessUnitPVO",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles/300100089785736/child/RoleParticipants/300100089785738/lov/ParticipantsVO",
"name": "ParticipantsVO",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles/300100089785736/child/RoleParticipants/300100089785738/lov/CnLookupParticipantTypeVO",
"name": "CnLookupParticipantTypeVO",
"kind": "collection"
}
]
}
],
"links": [
{
"rel": "self",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles/300100089785736",
"name": "roles",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000003737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles/300100089785736",
"name": "roles",
"kind": "item"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles/300100089785736/lov/CnLookupYesNoVO",
"name": "CnLookupYesNoVO",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles/300100089785736/lov/CnLookupAccessTypeVO",
"name": "CnLookupAccessTypeVO",
"kind": "collection"
}
]
}