REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience

Update a rate table rate

patch

/fscmRestApi/resources/11.13.18.05/participantCompensationPlans/{participantCompensationPlansUniqID}/child/ParticipantPlanComponents/{ParticipantPlanComponentId}/child/ParticipantPlanComponentRateTables/{ParticipantPlanComponentRateTableId}/child/ParticipantRateTableRates/{ParticipantRateTableRateId}

Request

Path Parameters

ParticipantPlanComponentId(required): integer(int64)

The unique identifier of the plan component associated with the participant compensation plan.
ParticipantPlanComponentRateTableId(required): integer(int64)

The unique identifier of the rate table associated with the participant plan component.
ParticipantRateTableRateId(required): integer(int64)

The unique identifier of the rate associated with the participant rate table.
participantCompensationPlansUniqID(required): string

This is the hash key of the attributes which make up the composite key for the Participant Compensation Plans resource and used to uniquely identify an instance of Participant Compensation Plans. The client should not generate the hash key value. Instead, the client should query on the Participant Compensation Plans collection resource in order to navigate to a specific instance of Participant Compensation Plans to get the hash key.

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

Root Schema : schema

Type: object

Show Source

Rate: number

Title: Rate

The output value of the rate table used to calculate the earning rate. This value is a percent or an amount depending on the rate table type set for the rate table. If the rate table type is percent, then the value stored here needs to be divided by 100 to get the actual value. For example, if the rate table type is percent and the rate value is 10%, then 10 is the output value.

{
    "type":"object",
    "properties":{
        "Rate":{
            "title":"Rate",
            "type":"number",
            "description":"The output value of the rate table used to calculate the earning rate. This value is a percent or an amount depending on the rate table type set for the rate table. If the rate table type is percent, then the value stored here needs to be divided by 100 to get the actual value. For example, if the rate table type is percent and the rate value is 10%, then 10 is the output value.",
            "nullable":true
        }
    }
}

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 : participantCompensationPlans-ParticipantPlanComponents-ParticipantPlanComponentRateTables-ParticipantRateTableRates-item-response

Type: object

Show Source

CreatedBy: string

Read Only: true

Maximum Length: 64

The user who created the participant rate table.
CreationDate: string (date-time)

Read Only: true

The date when the participant rate table was created.
LastUpdateDate: string (date-time)

Read Only: true

The date when the participant rate table was last updated.
LastUpdatedBy: string

Read Only: true

Maximum Length: 64

The user who last updated the participant rate table.
links: array Links

Title: Links

The link relations associated with the resource instance.
ParticipantPlanComponentRateTableId: integer (int64)

Read Only: true

The unique identifier of the participant rate table.
ParticipantRateTableRateId: integer (int64)

The unique identifier of the rate associated with the participant rate table.
Rate: number

Title: Rate

The output value of the rate table used to calculate the earning rate. This value is a percent or an amount depending on the rate table type set for the rate table. If the rate table type is percent, then the value stored here needs to be divided by 100 to get the actual value. For example, if the rate table type is percent and the rate value is 10%, then 10 is the output value.
RateDimension10Id: integer

The unique identifier of the tenth dimension associated with the rate. Used only when the rate table has ten dimensions.
RateDimension10Name: string

Title: Name

Read Only: true

The name of the tenth dimension.
RateDimension10TierId: integer

The unique identifier of the tier for the tenth dimension associated with the rate.
RateDimension10TierSequence: integer

Title: Sequence

Read Only: true

The tier sequence number within the dimension.
RateDimension1Id: integer

The unique identifier of the first dimension associated with the rate.
RateDimension1Name: string

Title: Name

Read Only: true

The name of the first dimension.
RateDimension1TierId: integer

The unique identifier of the tier for the first dimension associated with the rate.
RateDimension1TierSequence: integer

Title: Sequence

Read Only: true

The tier sequence number within the dimension.
RateDimension2Id: integer

The unique identifier of the second dimension associated with the rate. Used only when the rate table has at least two dimensions.
RateDimension2Name: string

Title: Name

Read Only: true

The name of the second dimension.
RateDimension2TierId: integer

The unique identifier of the tier for the second dimension associated with the rate.
RateDimension2TierSequence: integer

Title: Sequence

Read Only: true

The tier sequence number within the dimension.
RateDimension3Id: integer

The unique identifier of the third dimension associated with the rate. Used only when the rate table has at least three dimensions.
RateDimension3Name: string

Title: Name

Read Only: true

The name of the third dimension.
RateDimension3TierId: integer

The unique identifier of the tier for the third dimension associated with the rate.
RateDimension3TierSequence: integer

Title: Sequence

Read Only: true

The tier sequence number within the dimension.
RateDimension4Id: integer

The unique identifier of the fourth dimension associated with the rate. Used only when the rate table has at least four dimensions.
RateDimension4Name: string

Title: Name

Read Only: true

The name of the fourth dimension.
RateDimension4TierId: integer

The unique identifier of the tier for the fourth dimension associated with the rate.
RateDimension4TierSequence: integer

Title: Sequence

Read Only: true

The tier sequence number within the dimension.
RateDimension5Id: integer

The unique identifier of the fifth dimension associated with the rate. Used only when the rate table has at least five dimensions.
RateDimension5Name: string

Title: Name

Read Only: true

The name of the fifth dimension.
RateDimension5TierId: integer

The unique identifier of the tier for the fifth dimension associated with the rate.
RateDimension5TierSequence: integer

Title: Sequence

Read Only: true

The tier sequence number within the dimension.
RateDimension6Id: integer

The unique identifier of the sixth dimension associated with the rate. Used only when the rate table has at least six dimensions.
RateDimension6Name: string

Title: Name

Read Only: true

The name of the sixth dimension.
RateDimension6TierId: integer

The unique identifier of the tier for the sixth dimension associated with the rate.
RateDimension6TierSequence: integer

Title: Sequence

Read Only: true

The tier sequence number within the dimension.
RateDimension7Id: integer

The unique identifier of the seventh dimension associated with the rate. Used only when the rate table has at least seven dimensions.
RateDimension7Name: string

Title: Name

Read Only: true

The name of the seventh dimension.
RateDimension7TierId: integer

The unique identifier of the tier for the seventh dimension associated with the rate.
RateDimension7TierSequence: integer

Title: Sequence

Read Only: true

The tier sequence number within the dimension.
RateDimension8Id: integer

The unique identifier of the eighth dimension associated with the rate. Used only when the rate table has at least eight dimensions.
RateDimension8Name: string

Title: Name

Read Only: true

The name of the eighth dimension.
RateDimension8TierId: integer

The unique identifier of the tier for the eighth dimension associated with the rate.
RateDimension8TierSequence: integer

Title: Sequence

Read Only: true

The tier sequence number within the dimension.
RateDimension9Id: integer

The unique identifier of the ninth dimension associated with the rate. Used only when the rate table has at least nine dimensions.
RateDimension9Name: string

Title: Name

Read Only: true

The name of the ninth dimension.
RateDimension9TierId: integer

The unique identifier of the tier for the ninth dimension associated with the rate.
RateDimension9TierSequence: integer

Title: Sequence

Read Only: true

The tier sequence number within the dimension.
RateTableId: integer (int64)

Read Only: true

The unique identifier of the rate table associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan.
RateTableRateId: integer (int64)

Read Only: true

The unique identifier of the rate associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan.

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the participant rate table.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the participant rate table was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the participant rate table was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the participant rate table.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParticipantPlanComponentRateTableId":{
            "type":"integer",
            "description":"The unique identifier of the participant rate table.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ParticipantRateTableRateId":{
            "type":"integer",
            "description":"The unique identifier of the rate associated with the participant rate table.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Rate":{
            "title":"Rate",
            "type":"number",
            "description":"The output value of the rate table used to calculate the earning rate. This value is a percent or an amount depending on the rate table type set for the rate table. If the rate table type is percent, then the value stored here needs to be divided by 100 to get the actual value. For example, if the rate table type is percent and the rate value is 10%, then 10 is the output value.",
            "nullable":true,
            "x-queryable":true
        },
        "RateDimension10Id":{
            "type":"integer",
            "description":"The unique identifier of the tenth dimension associated with the rate. Used only when the rate table has ten dimensions.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "RateTableId"
                ]
            },
            "x-queryable":true
        },
        "RateDimension10Name":{
            "title":"Name",
            "type":"string",
            "description":"The name of the tenth dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RateDimension10TierId":{
            "type":"integer",
            "description":"The unique identifier of the tier for the tenth dimension associated with the rate.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RateDimension10TierSequence":{
            "title":"Sequence",
            "type":"integer",
            "description":"The tier sequence number within the dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RateDimension1Id":{
            "type":"integer",
            "description":"The unique identifier of the first dimension associated with the rate.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "RateTableId"
                ]
            },
            "x-queryable":true
        },
        "RateDimension1Name":{
            "title":"Name",
            "type":"string",
            "description":"The name of the first dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RateDimension1TierId":{
            "type":"integer",
            "description":"The unique identifier of the tier for the first dimension associated with the rate.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RateDimension1TierSequence":{
            "title":"Sequence",
            "type":"integer",
            "description":"The tier sequence number within the dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RateDimension2Id":{
            "type":"integer",
            "description":"The unique identifier of the second dimension associated with the rate. Used only when the rate table has at least two dimensions.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "RateTableId"
                ]
            },
            "x-queryable":true
        },
        "RateDimension2Name":{
            "title":"Name",
            "type":"string",
            "description":"The name of the second dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RateDimension2TierId":{
            "type":"integer",
            "description":"The unique identifier of the tier for the second dimension associated with the rate.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RateDimension2TierSequence":{
            "title":"Sequence",
            "type":"integer",
            "description":"The tier sequence number within the dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RateDimension3Id":{
            "type":"integer",
            "description":"The unique identifier of the third dimension associated with the rate. Used only when the rate table has at least three dimensions.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "RateTableId"
                ]
            },
            "x-queryable":true
        },
        "RateDimension3Name":{
            "title":"Name",
            "type":"string",
            "description":"The name of the third dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RateDimension3TierId":{
            "type":"integer",
            "description":"The unique identifier of the tier for the third dimension associated with the rate.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RateDimension3TierSequence":{
            "title":"Sequence",
            "type":"integer",
            "description":"The tier sequence number within the dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RateDimension4Id":{
            "type":"integer",
            "description":"The unique identifier of the fourth dimension associated with the rate. Used only when the rate table has at least four dimensions.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "RateTableId"
                ]
            },
            "x-queryable":true
        },
        "RateDimension4Name":{
            "title":"Name",
            "type":"string",
            "description":"The name of the fourth dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RateDimension4TierId":{
            "type":"integer",
            "description":"The unique identifier of the tier for the fourth dimension associated with the rate.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RateDimension4TierSequence":{
            "title":"Sequence",
            "type":"integer",
            "description":"The tier sequence number within the dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RateDimension5Id":{
            "type":"integer",
            "description":"The unique identifier of the fifth dimension associated with the rate. Used only when the rate table has at least five dimensions.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "RateTableId"
                ]
            },
            "x-queryable":true
        },
        "RateDimension5Name":{
            "title":"Name",
            "type":"string",
            "description":"The name of the fifth dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RateDimension5TierId":{
            "type":"integer",
            "description":"The unique identifier of the tier for the fifth dimension associated with the rate.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RateDimension5TierSequence":{
            "title":"Sequence",
            "type":"integer",
            "description":"The tier sequence number within the dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RateDimension6Id":{
            "type":"integer",
            "description":"The unique identifier of the sixth dimension associated with the rate. Used only when the rate table has at least six dimensions.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "RateTableId"
                ]
            },
            "x-queryable":true
        },
        "RateDimension6Name":{
            "title":"Name",
            "type":"string",
            "description":"The name of the sixth dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RateDimension6TierId":{
            "type":"integer",
            "description":"The unique identifier of the tier for the sixth dimension associated with the rate.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RateDimension6TierSequence":{
            "title":"Sequence",
            "type":"integer",
            "description":"The tier sequence number within the dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RateDimension7Id":{
            "type":"integer",
            "description":"The unique identifier of the seventh dimension associated with the rate. Used only when the rate table has at least seven dimensions.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "RateTableId"
                ]
            },
            "x-queryable":true
        },
        "RateDimension7Name":{
            "title":"Name",
            "type":"string",
            "description":"The name of the seventh dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RateDimension7TierId":{
            "type":"integer",
            "description":"The unique identifier of the tier for the seventh dimension associated with the rate.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RateDimension7TierSequence":{
            "title":"Sequence",
            "type":"integer",
            "description":"The tier sequence number within the dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RateDimension8Id":{
            "type":"integer",
            "description":"The unique identifier of the eighth dimension associated with the rate. Used only when the rate table has at least eight dimensions.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "RateTableId"
                ]
            },
            "x-queryable":true
        },
        "RateDimension8Name":{
            "title":"Name",
            "type":"string",
            "description":"The name of the eighth dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RateDimension8TierId":{
            "type":"integer",
            "description":"The unique identifier of the tier for the eighth dimension associated with the rate.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RateDimension8TierSequence":{
            "title":"Sequence",
            "type":"integer",
            "description":"The tier sequence number within the dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RateDimension9Id":{
            "type":"integer",
            "description":"The unique identifier of the ninth dimension associated with the rate. Used only when the rate table has at least nine dimensions.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "RateTableId"
                ]
            },
            "x-queryable":true
        },
        "RateDimension9Name":{
            "title":"Name",
            "type":"string",
            "description":"The name of the ninth dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RateDimension9TierId":{
            "type":"integer",
            "description":"The unique identifier of the tier for the ninth dimension associated with the rate.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RateDimension9TierSequence":{
            "title":"Sequence",
            "type":"integer",
            "description":"The tier sequence number within the dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RateTableId":{
            "type":"integer",
            "description":"The unique identifier of the rate table associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RateTableRateId":{
            "type":"integer",
            "description":"The unique identifier of the rate associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "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"
    }
}

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."
        }
    }
}

Links

RateDimensionLookupVO1

Operation: /fscmRestApi/resources/11.13.18.05/rateTables

The list of values containing the unique identifiers of rate dimensions in sequence 1 of the rate table.

The following properties are defined on the LOV link relation:

Source Attribute: RateDimension1Id; Target Attribute: RateDimensionId
Display Attribute: RateDimensionId, RateDimensionName, RateDimensionType, RateDimensionSequence

RateDimensionLookupVO10

Operation: /fscmRestApi/resources/11.13.18.05/rateTables

The list of values containing the unique identifiers of rate dimensions in sequence 10 of the rate table.

The following properties are defined on the LOV link relation:

Source Attribute: RateDimension10Id; Target Attribute: RateDimensionId
Display Attribute: RateDimensionId, RateDimensionName, RateDimensionType, RateDimensionSequence

RateDimensionLookupVO2

Operation: /fscmRestApi/resources/11.13.18.05/rateTables

The list of values containing the unique identifiers of rate dimensions in sequence 2 of the rate table.

The following properties are defined on the LOV link relation:

Source Attribute: RateDimension2Id; Target Attribute: RateDimensionId
Display Attribute: RateDimensionId, RateDimensionName, RateDimensionType, RateDimensionSequence

RateDimensionLookupVO3

Operation: /fscmRestApi/resources/11.13.18.05/rateTables

The list of values containing the unique identifiers of rate dimensions in sequence 3 of the rate table.

The following properties are defined on the LOV link relation:

Source Attribute: RateDimension3Id; Target Attribute: RateDimensionId
Display Attribute: RateDimensionId, RateDimensionName, RateDimensionType, RateDimensionSequence

RateDimensionLookupVO4

Operation: /fscmRestApi/resources/11.13.18.05/rateTables

The list of values containing the unique identifiers of rate dimensions in sequence 4 of the rate table.

The following properties are defined on the LOV link relation:

Source Attribute: RateDimension4Id; Target Attribute: RateDimensionId
Display Attribute: RateDimensionId, RateDimensionName, RateDimensionType, RateDimensionSequence

RateDimensionLookupVO5

Operation: /fscmRestApi/resources/11.13.18.05/rateTables

The list of values containing the unique identifiers of rate dimensions in sequence 5 of the rate table.

The following properties are defined on the LOV link relation:

Source Attribute: RateDimension5Id; Target Attribute: RateDimensionId
Display Attribute: RateDimensionId, RateDimensionName, RateDimensionType, RateDimensionSequence

RateDimensionLookupVO6

Operation: /fscmRestApi/resources/11.13.18.05/rateTables

The list of values containing the unique identifiers of rate dimensions in sequence 6 of the rate table.

The following properties are defined on the LOV link relation:

Source Attribute: RateDimension6Id; Target Attribute: RateDimensionId
Display Attribute: RateDimensionId, RateDimensionName, RateDimensionType, RateDimensionSequence

RateDimensionLookupVO7

Operation: /fscmRestApi/resources/11.13.18.05/rateTables

The list of values containing the unique identifiers of rate dimensions in sequence 7 of the rate table.

The following properties are defined on the LOV link relation:

Source Attribute: RateDimension7Id; Target Attribute: RateDimensionId
Display Attribute: RateDimensionId, RateDimensionName, RateDimensionType, RateDimensionSequence

RateDimensionLookupVO8

Operation: /fscmRestApi/resources/11.13.18.05/rateTables

The list of values containing the unique identifiers of rate dimensions in sequence 8 of the rate table.

The following properties are defined on the LOV link relation:

Source Attribute: RateDimension8Id; Target Attribute: RateDimensionId
Display Attribute: RateDimensionId, RateDimensionName, RateDimensionType, RateDimensionSequence

RateDimensionLookupVO9

Operation: /fscmRestApi/resources/11.13.18.05/rateTables

The list of values containing the unique identifiers of rate dimensions in sequence 9 of the rate table.

The following properties are defined on the LOV link relation:

Source Attribute: RateDimension9Id; Target Attribute: RateDimensionId
Display Attribute: RateDimensionId, RateDimensionName, RateDimensionType, RateDimensionSequence

RateDimensionTierLookupVO1

Operation: /fscmRestApi/resources/11.13.18.05/rateTables

The list of values containing the unique identifiers of rate dimensions tiers in sequence 1 of the rate table.

The following properties are defined on the LOV link relation:

Source Attribute: RateDimension1TierId; Target Attribute: RateDimensionTierId
Display Attribute: RateDimensionId, TierSequence, RateDimensionTierId, MaximumAmount, MinimumAmount, MinimumExpressionId, MaximumExpressionId, StringValue

RateDimensionTierLookupVO10

Operation: /fscmRestApi/resources/11.13.18.05/rateTables

The list of values containing the unique identifiers of rate dimensions tiers in sequence 10 of the rate table.

The following properties are defined on the LOV link relation:

Source Attribute: RateDimension10TierId; Target Attribute: RateDimensionTierId
Display Attribute: RateDimensionId, TierSequence, RateDimensionTierId, MaximumAmount, MinimumAmount, MinimumExpressionId, MaximumExpressionId, StringValue

RateDimensionTierLookupVO2

Operation: /fscmRestApi/resources/11.13.18.05/rateTables

The list of values containing the unique identifiers of rate dimensions tiers in sequence 2 of the rate table.

The following properties are defined on the LOV link relation:

Source Attribute: RateDimension2TierId; Target Attribute: RateDimensionTierId
Display Attribute: RateDimensionId, TierSequence, RateDimensionTierId, MaximumAmount, MinimumAmount, MinimumExpressionId, MaximumExpressionId, StringValue

RateDimensionTierLookupVO3

Operation: /fscmRestApi/resources/11.13.18.05/rateTables

The list of values containing the unique identifiers of rate dimensions tiers in sequence 3 of the rate table.

The following properties are defined on the LOV link relation:

Source Attribute: RateDimension3TierId; Target Attribute: RateDimensionTierId
Display Attribute: RateDimensionId, TierSequence, RateDimensionTierId, MaximumAmount, MinimumAmount, MinimumExpressionId, MaximumExpressionId, StringValue

RateDimensionTierLookupVO4

Operation: /fscmRestApi/resources/11.13.18.05/rateTables

The list of values containing the unique identifiers of rate dimensions tiers in sequence 4 of the rate table.

The following properties are defined on the LOV link relation:

Source Attribute: RateDimension4TierId; Target Attribute: RateDimensionTierId
Display Attribute: RateDimensionId, TierSequence, RateDimensionTierId, MaximumAmount, MinimumAmount, MinimumExpressionId, MaximumExpressionId, StringValue

RateDimensionTierLookupVO5

Operation: /fscmRestApi/resources/11.13.18.05/rateTables

The list of values containing the unique identifiers of rate dimensions tiers in sequence 5 of the rate table.

The following properties are defined on the LOV link relation:

Source Attribute: RateDimension5TierId; Target Attribute: RateDimensionTierId
Display Attribute: RateDimensionId, TierSequence, RateDimensionTierId, MaximumAmount, MinimumAmount, MinimumExpressionId, MaximumExpressionId, StringValue

RateDimensionTierLookupVO6

Operation: /fscmRestApi/resources/11.13.18.05/rateTables

The list of values containing the unique identifiers of rate dimensions tiers in sequence 6 of the rate table.

The following properties are defined on the LOV link relation:

Source Attribute: RateDimension6TierId; Target Attribute: RateDimensionTierId
Display Attribute: RateDimensionId, TierSequence, RateDimensionTierId, MaximumAmount, MinimumAmount, MinimumExpressionId, MaximumExpressionId, StringValue

RateDimensionTierLookupVO7

Operation: /fscmRestApi/resources/11.13.18.05/rateTables

The list of values containing the unique identifiers of rate dimensions tiers in sequence 7 of the rate table.

The following properties are defined on the LOV link relation:

Source Attribute: RateDimension7TierId; Target Attribute: RateDimensionTierId
Display Attribute: RateDimensionId, TierSequence, RateDimensionTierId, MaximumAmount, MinimumAmount, MinimumExpressionId, MaximumExpressionId, StringValue

RateDimensionTierLookupVO8

Operation: /fscmRestApi/resources/11.13.18.05/rateTables

The list of values containing the unique identifiers of rate dimensions tiers in sequence 8 of the rate table.

The following properties are defined on the LOV link relation:

Source Attribute: RateDimension8TierId; Target Attribute: RateDimensionTierId
Display Attribute: RateDimensionId, TierSequence, RateDimensionTierId, MaximumAmount, MinimumAmount, MinimumExpressionId, MaximumExpressionId, StringValue

RateDimensionTierLookupVO9

Operation: /fscmRestApi/resources/11.13.18.05/rateTables

The list of values containing the unique identifiers of rate dimensions tiers in sequence 9 of the rate table.

The following properties are defined on the LOV link relation:

Source Attribute: RateDimension9TierId; Target Attribute: RateDimensionTierId
Display Attribute: RateDimensionId, TierSequence, RateDimensionTierId, MaximumAmount, MinimumAmount, MinimumExpressionId, MaximumExpressionId, StringValue

Examples

The following example shows how to update a rate table rate by submitting a patch request using cURL.

cURL Command

curl -u
                username:password \ -X PATCH \
                "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/participantCompensationPlans/300100123456789/child/ParticipantPlanComponents/300100987654321/child/ParticipantPlanComponentRateTables/300100112233445/child/ParticipantRateTableRates/300100556677889"
                \ -H "Content-Type: application/json" \

Example of Request Body

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

{
        "Rate": 15
      }

Example of Response Body

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

{
  "ParticipantRateTableRateId": 300100556677889,
  "ParticipantPlanComponentRateTableId": 300100112233445,
  "Rate": 15,
  "LastUpdatedBy": "SALES_ADMIN",
  "LastUpdateDate": "2026-03-18T10:15:30Z"
}

Note:

You can get values for parameters to update a rate table rate as follows:

ParticipantCompensationPlansUniqID PARTICIPANT_PLAN_NUMBER in cn_srp_comp_plans_all
ParticipantPlanComponentId SRP_PLAN_COMPONENT_ID in cn_srp_plan_components_all
ParticipantPlanComponentRateTableId/SRP_FORM_RATE_TABLE_ID in cn_srp_form_rate_tables_all
ParticipantRateTableRateId RATE_TABLE_VALUE_ID in cn_rate_table_values_all