Jump to

• Request
• Response
• Examples

Update an incentive compensation role

patch

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

Request

Path Parameters

• RoleId(required): integer(int64)
  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

• 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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AccessType: string
  Title: Access Type

  Maximum Length: 30

  Default Value: INDIVIDUAL
• ActiveFlag: boolean
  Title: Active

  Maximum Length: 1

  Default Value: true
• RoleDescription: string
  Title: Role Description

  Maximum Length: 120
• RoleName: string
  Title: Name

  Maximum Length: 60
• RoleParticipants: array Role - Participants
  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.

{
    "type":"object",
    "properties":{
        "AccessType":{
            "title":"Access Type",
            "maxLength":30,
            "type":"string",
            "description":"",
            "nullable":false,
            "default":"INDIVIDUAL",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"",
            "nullable":false,
            "default":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RoleDescription":{
            "title":"Role Description",
            "maxLength":120,
            "type":"string",
            "description":"",
            "nullable":true
        },
        "RoleName":{
            "title":"Name",
            "maxLength":60,
            "type":"string",
            "description":"",
            "nullable":false
        },
        "RoleParticipants":{
            "title":"Role - Participants",
            "type":"array",
            "description":"The role - participants resource is used to view, create, update, and delete the participants that can be assigned an incentive compensation role.",
            "items":{
                "$ref":"#/components/schemas/incentiveCompensationRoles-RoleParticipants-item-patch-request"
            }
        }
    }
}

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

• Array of: object schema

{
    "title":"Role - Participants",
    "type":"array",
    "description":"The role - participants resource is used to view, create, update, and delete the participants that can be assigned an incentive compensation role.",
    "items":{
        "$ref":"#/components/schemas/incentiveCompensationRoles-RoleParticipants-item-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• EndDateActive: string (date)
  Title: Assignment End Date
• PreserveRoleAssignmentFlag: boolean
  Title: Preserve Assignment
• StartDateActive: string (date)
  Title: Assignment Start Date

{
    "type":"object",
    "properties":{
        "EndDateActive":{
            "title":"Assignment End Date",
            "type":"string",
            "description":"",
            "format":"date",
            "nullable":true
        },
        "PreserveRoleAssignmentFlag":{
            "title":"Preserve Assignment",
            "type":"boolean",
            "description":"",
            "nullable":true
        },
        "StartDateActive":{
            "title":"Assignment Start Date",
            "type":"string",
            "description":"",
            "format":"date",
            "nullable":false
        }
    }
}

Back to Top

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.

Body ()

Root Schema : incentiveCompensationRoles-item-response

Type: object

Show Source

• AccessType: string
  Title: Access Type

  Maximum Length: 30

  Default Value: INDIVIDUAL
• ActiveFlag: boolean
  Title: Active

  Maximum Length: 1

  Default Value: true
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RoleDescription: string
  Title: Role Description

  Maximum Length: 120
• RoleId: integer (int64)
• RoleName: string
  Title: Name

  Maximum Length: 60
• RoleParticipants: array Role - Participants
  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.

{
    "type":"object",
    "properties":{
        "AccessType":{
            "title":"Access Type",
            "maxLength":30,
            "type":"string",
            "description":"",
            "nullable":false,
            "default":"INDIVIDUAL",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"",
            "nullable":false,
            "default":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RoleDescription":{
            "title":"Role Description",
            "maxLength":120,
            "type":"string",
            "description":"",
            "nullable":true,
            "x-queryable":true
        },
        "RoleId":{
            "type":"integer",
            "description":"",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "RoleName":{
            "title":"Name",
            "maxLength":60,
            "type":"string",
            "description":"",
            "nullable":false,
            "x-queryable":true
        },
        "RoleParticipants":{
            "title":"Role - Participants",
            "type":"array",
            "description":"The role - participants resource is used to view, create, update, and delete the participants that can be assigned an incentive compensation role.",
            "items":{
                "$ref":"#/components/schemas/incentiveCompensationRoles-RoleParticipants-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

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

• Array of: object incentiveCompensationRoles-RoleParticipants-item-response

{
    "title":"Role - Participants",
    "type":"array",
    "description":"The role - participants resource is used to view, create, update, and delete the participants that can be assigned an incentive compensation role.",
    "items":{
        "$ref":"#/components/schemas/incentiveCompensationRoles-RoleParticipants-item-response"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : incentiveCompensationRoles-RoleParticipants-item-response

Type: object

Show Source

• ActiveFlag: boolean
  Title: Active

  Read Only: true

  Maximum Length: 1
• AnalystName: string
  Title: Analyst

  Read Only: true

  Maximum Length: 360
• CompensationEndDate: string (date)
  Title: Compensation End Date

  Read Only: true
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true
• EndDateActive: string (date)
  Title: Assignment End Date
• HoldPaymentFlag: boolean
  Title: Hold payment

  Read Only: true

  Maximum Length: 1
• HRPersonNumber: string
  Title: Person Number

  Read Only: true

  Maximum Length: 30
• HRPrimaryWorkerNumber: string
  Title: Worker Number

  Read Only: true

  Maximum Length: 30
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OrgId: integer (int64)
  Title: Business Unit

  Read Only: true
• ParticipantId: integer (int64)
  Title: Participant Name
• ParticipantName: string
  Title: Participant Name

  Read Only: true

  Maximum Length: 360
• ParticipantRoleId: integer (int64)
• ParticipantType: string
  Title: Type

  Read Only: true

  Maximum Length: 60
• PartyNumber: string
  Title: Party Number

  Read Only: true

  Maximum Length: 30
• PayeeOnly: string
  Title: Payee Only

  Read Only: true

  Maximum Length: 1
• PreserveRoleAssignmentFlag: boolean
  Title: Preserve Assignment
• RoleId: integer (int64)
  Title: Name
• StartDateActive: string (date)
  Title: Assignment Start Date

{
    "type":"object",
    "properties":{
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AnalystName":{
            "title":"Analyst",
            "maxLength":360,
            "type":"string",
            "description":"",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CompensationEndDate":{
            "title":"Compensation End Date",
            "type":"string",
            "description":"",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "ParticipantId"
                ]
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDateActive":{
            "title":"Assignment End Date",
            "type":"string",
            "description":"",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "HRPersonNumber":{
            "title":"Person Number",
            "maxLength":30,
            "type":"string",
            "description":"",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HRPrimaryWorkerNumber":{
            "title":"Worker Number",
            "maxLength":30,
            "type":"string",
            "description":"",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HoldPaymentFlag":{
            "title":"Hold payment",
            "maxLength":1,
            "type":"boolean",
            "description":"",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrgId":{
            "title":"Business Unit",
            "type":"integer",
            "description":"",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "ParticipantId":{
            "title":"Participant Name",
            "type":"integer",
            "description":"",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":18
            },
            "x-queryable":true
        },
        "ParticipantName":{
            "title":"Participant Name",
            "maxLength":360,
            "type":"string",
            "description":"",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParticipantRoleId":{
            "type":"integer",
            "description":"",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ParticipantType":{
            "title":"Type",
            "maxLength":60,
            "type":"string",
            "description":"",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PartyNumber":{
            "title":"Party Number",
            "maxLength":30,
            "type":"string",
            "description":"",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PayeeOnly":{
            "title":"Payee Only",
            "maxLength":1,
            "type":"string",
            "description":"",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PreserveRoleAssignmentFlag":{
            "title":"Preserve Assignment",
            "type":"boolean",
            "description":"",
            "nullable":true,
            "x-queryable":true
        },
        "RoleId":{
            "title":"Name",
            "type":"integer",
            "description":"",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "StartDateActive":{
            "title":"Assignment Start Date",
            "type":"string",
            "description":"",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

CnLookupAccessTypeVO

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

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

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

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

Operation: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles/{RoleId}/child/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