1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. Roles

Update an incentive compensation role

patch

/fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles/{RoleId}

Request

Path Parameters
  • 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
  • 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".
  • 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
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
Nested Schema : Role - Participants
Type: array
Title: Role - Participants
The role - participants resource is used to view, create, update, and delete the participants that can be assigned an incentive compensation role.
Show Source
Nested Schema : schema
Type: object
Show Source
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : incentiveCompensationRoles-item-response
Type: object
Show Source
Nested Schema : Role - Participants
Type: array
Title: Role - Participants
The role - participants resource is used to view, create, update, and delete the participants that can be assigned an incentive compensation role.
Show Source
Nested Schema : incentiveCompensationRoles-RoleParticipants-item-response
Type: object
Show Source
Links
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.
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.
RoleParticipants
Parameters:
  • 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.
Back to Top

Examples

The following example shows how to update a specific role by submitting a PATCH request on the REST resource using cURL.

cURL Command

curl -u <username:password> \ -X PATCH -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles/300100089785736/

Example of Request Body

The following example shows the contents of the request body in JSON format.

{
  "RoleName": "Sales Representative Role",
  "ActiveFlag": false
}

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
  "RoleName": "Sales Representative Role",
  "ActiveFlag": false,
  "RoleId": 300100089785736,
  "RoleDescription": "This role consists of sales members on the ground",
  "CreatedBy": "OIC_MGR_OPERATIONS",
  "CreationDate": "2017-03-16T17:16:44+05:30",
  "LastUpdatedBy": "OIC_MGR_OPERATIONS",
  "LastUpdateDate": "2017-03-16T19:26:39+05:30",
  "LastUpdateLogin": "4AC7DE6005D2570AE0537F90B10A3DBA",
  "AccessType": "INDIVIDUAL",
  "links": [
    {
      "rel": "self",
      "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles/300100089785736",
      "name": "roles",
      "kind": "item",
      "properties": {
        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000003737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
      }
    },
    {
      "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"
    },
    {
      "rel": "child",
      "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles/300100089785736/child/RoleParticipants",
      "name": "RoleParticipants",
      "kind": "collection"
    }
  ]
}
Back to Top