Update a rate dimensional input
patch
/fscmRestApi/resources/11.13.18.05/planComponents/{planComponentsUniqID}/child/planComponentIncentiveFormulas/{IncentiveFormulaId}/child/planComponentRateDimensionalInputs/{PlanComponentInputExpressionId}
Request
Path Parameters
-
IncentiveFormulaId(required): integer(int64)
The unique identifier for the incentive formula record. There can be only one incentive formula for one plan component.
-
PlanComponentInputExpressionId(required): integer(int64)
The unique identifier of the input expression record for the plan component.
-
planComponentsUniqID(required): string
This is the hash key of the attributes which make up the composite key--- PlanComponentId and OrgId ---for the Plan Components resource and used to uniquely identify an instance of Plan Components. The client should not generate the hash key value. Instead, the client should query on the Plan Components collection resource with a filter on the primary key values in order to navigate to a specific instance of Plan Components.
For example: planComponents?q=PlanComponentId=<value1>;OrgId=<value2>
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
IncentiveFormulaId: integer
(int64)
Title:
Incentive Formula ID
The unique identifier of the incentive formula record. There can be only one incentive formula for one plan component. -
InputExpressionId: integer
(int64)
Title:
Input Expression ID
The unique identifier of the input expression for the rate dimension of a rate table. -
InputExpressionName: string
Title:
Input Expression Name
Maximum Length:160
The name of the input expression for the rate dimension of a rate table used in the plan component. The input expression drives a value to evaluate from the transaction and matches the results with the corresponding rate table dimension. -
RateDimSequence: integer
(int64)
Title:
Sequence
The order of the input expressions for the rate table. -
SplitFlag: boolean
Title:
Split
Maximum Length:1
Default Value:false
When splitting the rate across tiers, the split option can apply to only one rate dimension input expression. This specifies which rate dimension input expression (rate dimension) to use. Possible values are FALSE and TRUE. The default value is FALSE.
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 : planComponents-planComponentIncentiveFormulas-planComponentRateDimensionalInputs-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
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. -
IncentiveFormulaId: integer
(int64)
Title:
Incentive Formula ID
The unique identifier of the incentive formula record. There can be only one incentive formula for one plan component. -
InputExpressionDescription: string
Title:
Input Expression Description
Read Only:true
Maximum Length:1000
The description of the input expression entered while creating the expression. -
InputExpressionId: integer
(int64)
Title:
Input Expression ID
The unique identifier of the input expression for the rate dimension of a rate table. -
InputExpressionName: string
Title:
Input Expression Name
Maximum Length:160
The name of the input expression for the rate dimension of a rate table used in the plan component. The input expression drives a value to evaluate from the transaction and matches the results with the corresponding rate table dimension. -
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:255
The user who last updated the record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The session login of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PlanComponentId: integer
Read Only:
true
The unique identifier of the plan component record within a business unit. -
PlanComponentInputExpressionId: integer
(int64)
Title:
Plan Component Input Expression Id
The unique identifier of the input expression record for the plan component. -
PlanComponentRateDimensionalInputsDeleteFlag: boolean
Read Only:
true
Default Value:false
Indicates whether the rate dimension input can be deleted. -
RateDimName: integer
Title:
Dimension Name
Read Only:true
The name of the rate dimension. A rate table can have one or more rate dimensions. -
RateDimSequence: integer
(int64)
Title:
Sequence
The order of the input expressions for the rate table. -
SplitFlag: boolean
Title:
Split
Maximum Length:1
Default Value:false
When splitting the rate across tiers, the split option can apply to only one rate dimension input expression. This specifies which rate dimension input expression (rate dimension) to use. Possible values are FALSE and TRUE. The default value is FALSE.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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.
Links
- ExpressionUsagesVO
-
The expression usages list of values resource is used to view the list of expression usages which indicate where an expression can be used.