Create a rate dimension
post
/fscmRestApi/resources/11.13.18.05/rateDimensions
Request
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.
-
Upsert-Mode:
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
Description: string
Title:
Description
Maximum Length:1000
The additional details added by the user related to rate dimensions. -
Name(required): string
Title:
Name
Maximum Length:80
The name of the rate dimension. -
OrgId: integer
(int64)
Title:
Business Unit
The unique identifier of the business unit. The value can be updated from a list of acceptable values in the Manage Business Units task in Setup and Maintenance. -
RateDimensionTiers: array
Rate Dimension - Tiers
Title:
Rate Dimension - Tiers
The rate dimensions tiers resource is used to create, update, or delete the association of tiers to a rate dimension. It can also be used to display all the details of the tiers in a dimension. -
RateDimensionType: string
Title:
Type
Maximum Length:30
Default Value:AMOUNT
The unit of measurement for a rate dimension. Possible values include AMOUNT, EXPRESSION, PERCENT, and STRING. The default value is AMOUNT. A list of acceptable values is defined in the lookup CN_DIM_UNIT_CODE. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
Nested Schema : Rate Dimension - Tiers
Type:
array
Title:
Rate Dimension - Tiers
The rate dimensions tiers resource is used to create, update, or delete the association of tiers to a rate dimension. It can also be used to display all the details of the tiers in a dimension.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
MaximumAmount: number
Title:
To
The maximum amount of the rate dimension. If the rate dimension is percentage, then the maximum amount is converted to a number (by dividing it by 100). For example, if the rate dimension is percentage, and the minimum amount is 20% then is it converted to 20. -
MaximumExpressionId: integer
(int64)
Title:
To
This is a unique identifier for maximum expression. This represents the rate dimension ending tier where tiers are expressions. -
MinimumAmount: number
Title:
From
The minimum amount of the rate dimension. If the rate dimension is percentage, then the minimum amount is converted to a number (by dividing it by 100). For example, if the rate dimension is percentage, and the minimum amount is 10% then is it converted to 10. -
MinimumExpressionId: integer
(int64)
Title:
From
This is a unique identifier for minimum expression. This represents the rate dimension starting tier where tiers are expressions. -
RateDimensionId: integer
(int64)
The unique identifier of a rate dimension record.
-
StringValue: string
Title:
String
Maximum Length:30
The alphanumeric value of a rate dimension tier with type set as string.
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 : rateDimensions-item-response
Type:
Show Source
object
-
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. -
Description: string
Title:
Description
Maximum Length:1000
The additional details added by the user related to rate dimensions. -
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 associated with the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Title:
Name
Maximum Length:80
The name of the rate dimension. -
NumberTier: integer
(int64)
Title:
Number of Tiers
Read Only:true
Default Value:0
The number of tiers for rate dimensions. The default value is 0. -
OrgId: integer
(int64)
Title:
Business Unit
The unique identifier of the business unit. The value can be updated from a list of acceptable values in the Manage Business Units task in Setup and Maintenance. -
RateDimensionId: integer
(int64)
Read Only:
true
The unique identifier for the rate dimension record. -
RateDimensionTiers: array
Rate Dimension - Tiers
Title:
Rate Dimension - Tiers
The rate dimensions tiers resource is used to create, update, or delete the association of tiers to a rate dimension. It can also be used to display all the details of the tiers in a dimension. -
RateDimensionType: string
Title:
Type
Maximum Length:30
Default Value:AMOUNT
The unit of measurement for a rate dimension. Possible values include AMOUNT, EXPRESSION, PERCENT, and STRING. The default value is AMOUNT. A list of acceptable values is defined in the lookup CN_DIM_UNIT_CODE. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Rate Dimension - Tiers
Type:
array
Title:
Rate Dimension - Tiers
The rate dimensions tiers resource is used to create, update, or delete the association of tiers to a rate dimension. It can also be used to display all the details of the tiers in a dimension.
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.
Nested Schema : rateDimensions-RateDimensionTiers-item-response
Type:
Show Source
object
-
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. -
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 associated to the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MaximumAmount: number
Title:
To
The maximum amount of the rate dimension. If the rate dimension is percentage, then the maximum amount is converted to a number (by dividing it by 100). For example, if the rate dimension is percentage, and the minimum amount is 20% then is it converted to 20. -
MaximumExpressionId: integer
(int64)
Title:
To
This is a unique identifier for maximum expression. This represents the rate dimension ending tier where tiers are expressions. -
MaximumExpressionName: string
Title:
To
Read Only:true
The name of the maximum expression. -
MinimumAmount: number
Title:
From
The minimum amount of the rate dimension. If the rate dimension is percentage, then the minimum amount is converted to a number (by dividing it by 100). For example, if the rate dimension is percentage, and the minimum amount is 10% then is it converted to 10. -
MinimumExpressionId: integer
(int64)
Title:
From
This is a unique identifier for minimum expression. This represents the rate dimension starting tier where tiers are expressions. -
MinimumExpressionName: string
Title:
From
Read Only:true
The name of the minimum expression. -
RateDimensionId: integer
(int64)
The unique identifier of a rate dimension record.
-
RateDimTierId: integer
(int64)
Read Only:
true
The unique identifier of a rate dimension tier. -
StringValue: string
Title:
String
Maximum Length:30
The alphanumeric value of a rate dimension tier with type set as string. -
TierSequence: integer
(int32)
Title:
Sequence
Read Only:true
The specified order of a tier within a rate dimension.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- BusinessUnitPVO
-
The business units list of values resource is used to view the list of defined business units.
- CnLookupRateDimensionTypeVO
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DCN_DIM_UNIT_CODE
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:
- RateDimensionTiers
-
Operation: /fscmRestApi/resources/11.13.18.05/rateDimensions/{RateDimensionId}/child/RateDimensionTiersParameters:
- RateDimensionId:
$request.path.RateDimensionId
The rate dimensions tiers resource is used to create, update, or delete the association of tiers to a rate dimension. It can also be used to display all the details of the tiers in a dimension. - RateDimensionId:
Examples
The following example shows how to create a rate dimension with rate dimension tier by submitting a POST request on the REST resource using cURL.
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/rateDimensions
Example of Request Body
The following example shows the contents of the request body in JSON format.
{ "Name": "Sales Amount", "RateDimensionType": "AMOUNT", "OrgId": 204, "RateDimensionTiers" : [ { "MinimumAmount": 0, "MaximumAmount": 1000 } ], "RateDimensionTiers" : [ { "MinimumAmount": 1000, "MaximumAmount": 2000 } ], "RateDimensionTiers" : [ { "MinimumAmount": 2000, "MaximumAmount": 3000 } ], "RateDimensionTiers" : [ { "MinimumAmount": 3000, "MaximumAmount": 4000 } ] }
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "RateDimensionId": 300100089584737, "Name": "Sales Amount", "Description": null, "RateDimensionType": "AMOUNT", "OrgId": 204, "NumberTier": 4, "LastUpdateDate": "2017-04-12T18:22:48+05:30", "LastUpdateLogin": "4CF735A3F3680DD9E053CB90B10A476E", "LastUpdatedBy": "OIC_PLAN_ADMIN_OPERATIONS", "CreatedBy": "OIC_PLAN_ADMIN_OPERATIONS", "CreationDate": "2017-04-12T18:22:48+05:30", "RateDimensionTiers": [ { "RateDimTierId": 300100089584738, "RateDimensionId": 300100089584737, "TierSequence": 1, "MinimumAmount": 0, "MaximumAmount": 1000, "StringValue": null, "MinimumExpressionId": null, "MaximumExpressionId": null, "MinimumExpressionName": null, "MaximumExpressionName": null, "CreatedBy": "OIC_PLAN_ADMIN_OPERATIONS", "CreationDate": "2017-04-12T18:22:48+05:30", "LastUpdateDate": "2017-04-12T18:22:48+05:30", "LastUpdateLogin": "4CF735A3F3680DD9E053CB90B10A476E", "LastUpdatedBy": "OIC_PLAN_ADMIN_OPERATIONS", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateDimensions/300100089584737/child/RateDimensionTiers/300100089584738", "name": "RateDimensionTiers", "kind": "item", "properties": {"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000003737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"} }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateDimensions/300100089584737/child/RateDimensionTiers/300100089584738", "name": "RateDimensionTiers", "kind": "item" }, { "rel": "parent", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateDimensions/300100089584737", "name": "rateDimensions", "kind": "item" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateDimensions/300100089584737/child/RateDimensionTiers/300100089584738/lov/MinimumExpressionVO", "name": "MinimumExpressionVO", "kind": "collection" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateDimensions/300100089584737/child/RateDimensionTiers/300100089584738/lov/MaximumExpressionVO", "name": "MaximumExpressionVO", "kind": "collection" } ] }, { "RateDimTierId": 300100089584739, "RateDimensionId": 300100089584737, "TierSequence": 2, "MinimumAmount": 1000, "MaximumAmount": 2000, "StringValue": null, "MinimumExpressionId": null, "MaximumExpressionId": null, "MinimumExpressionName": null, "MaximumExpressionName": null, "CreatedBy": "OIC_PLAN_ADMIN_OPERATIONS", "CreationDate": "2017-04-12T18:22:48+05:30", "LastUpdateDate": "2017-04-12T18:22:48+05:30", "LastUpdateLogin": "4CF735A3F3680DD9E053CB90B10A476E", "LastUpdatedBy": "OIC_PLAN_ADMIN_OPERATIONS", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateDimensions/300100089584737/child/RateDimensionTiers/300100089584739", "name": "RateDimensionTiers", "kind": "item", "properties": {"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000003737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"} }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateDimensions/300100089584737/child/RateDimensionTiers/300100089584739", "name": "RateDimensionTiers", "kind": "item" }, { "rel": "parent", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateDimensions/300100089584737", "name": "rateDimensions", "kind": "item" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateDimensions/300100089584737/child/RateDimensionTiers/300100089584739/lov/MinimumExpressionVO", "name": "MinimumExpressionVO", "kind": "collection" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateDimensions/300100089584737/child/RateDimensionTiers/300100089584739/lov/MaximumExpressionVO", "name": "MaximumExpressionVO", "kind": "collection" } ] }, { "RateDimTierId": 300100089584740, "RateDimensionId": 300100089584737, "TierSequence": 3, "MinimumAmount": 2000, "MaximumAmount": 3000, "StringValue": null, "MinimumExpressionId": null, "MaximumExpressionId": null, "MinimumExpressionName": null, "MaximumExpressionName": null, "CreatedBy": "OIC_PLAN_ADMIN_OPERATIONS", "CreationDate": "2017-04-12T18:22:48+05:30", "LastUpdateDate": "2017-04-12T18:22:48+05:30", "LastUpdateLogin": "4CF735A3F3680DD9E053CB90B10A476E", "LastUpdatedBy": "OIC_PLAN_ADMIN_OPERATIONS", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateDimensions/300100089584737/child/RateDimensionTiers/300100089584740", "name": "RateDimensionTiers", "kind": "item", "properties": {"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000003737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"} }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateDimensions/300100089584737/child/RateDimensionTiers/300100089584740", "name": "RateDimensionTiers", "kind": "item" }, { "rel": "parent", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateDimensions/300100089584737", "name": "rateDimensions", "kind": "item" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateDimensions/300100089584737/child/RateDimensionTiers/300100089584740/lov/MinimumExpressionVO", "name": "MinimumExpressionVO", "kind": "collection" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateDimensions/300100089584737/child/RateDimensionTiers/300100089584740/lov/MaximumExpressionVO", "name": "MaximumExpressionVO", "kind": "collection" } ] }, { "RateDimTierId": 300100089584741, "RateDimensionId": 300100089584737, "TierSequence": 4, "MinimumAmount": 3000, "MaximumAmount": 4000, "StringValue": null, "MinimumExpressionId": null, "MaximumExpressionId": null, "MinimumExpressionName": null, "MaximumExpressionName": null, "CreatedBy": "OIC_PLAN_ADMIN_OPERATIONS", "CreationDate": "2017-04-12T18:22:48+05:30", "LastUpdateDate": "2017-04-12T18:22:48+05:30", "LastUpdateLogin": "4CF735A3F3680DD9E053CB90B10A476E", "LastUpdatedBy": "OIC_PLAN_ADMIN_OPERATIONS", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateDimensions/300100089584737/child/RateDimensionTiers/300100089584741", "name": "RateDimensionTiers", "kind": "item", "properties": {"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000003737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"} }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateDimensions/300100089584737/child/RateDimensionTiers/300100089584741", "name": "RateDimensionTiers", "kind": "item" }, { "rel": "parent", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateDimensions/300100089584737", "name": "rateDimensions", "kind": "item" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateDimensions/300100089584737/child/RateDimensionTiers/300100089584741/lov/MinimumExpressionVO", "name": "MinimumExpressionVO", "kind": "collection" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateDimensions/300100089584737/child/RateDimensionTiers/300100089584741/lov/MaximumExpressionVO", "name": "MaximumExpressionVO", "kind": "collection" } ] } ], "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateDimensions/300100089584737", "name": "rateDimensions", "kind": "item", "properties": {"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000002737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"} }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateDimensions/300100089584737", "name": "rateDimensions", "kind": "item" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateDimensions/300100089584737/lov/BusinessUnitPVO", "name": "BusinessUnitPVO", "kind": "collection" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateDimensions/300100089584737/lov/CnLookupRateDimensionTypeVO", "name": "CnLookupRateDimensionTypeVO", "kind": "collection" } ] }