Jump to

• Request
• Response

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: 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

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

{
    "type":"object",
    "properties":{
        "IncentiveFormulaId":{
            "title":"Incentive Formula ID",
            "type":"integer",
            "description":"The unique identifier of the incentive formula record. There can be only one incentive formula for one plan component.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "InputExpressionId":{
            "title":"Input Expression ID",
            "type":"integer",
            "description":"The unique identifier of the input expression for the rate dimension of a rate table.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "InputExpressionName":{
            "title":"Input Expression Name",
            "maxLength":160,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "RateDimSequence":{
            "title":"Sequence",
            "type":"integer",
            "description":"The order of the input expressions for the rate table.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SplitFlag":{
            "title":"Split",
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "default":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 : planComponents-planComponentIncentiveFormulas-planComponentRateDimensionalInputs-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "title":"Created By",
            "maxLength":255,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "IncentiveFormulaId":{
            "title":"Incentive Formula ID",
            "type":"integer",
            "description":"The unique identifier of the incentive formula record. There can be only one incentive formula for one plan component.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InputExpressionDescription":{
            "title":"Input Expression Description",
            "maxLength":1000,
            "type":"string",
            "description":"The description of the input expression entered while creating the expression.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InputExpressionId":{
            "title":"Input Expression ID",
            "type":"integer",
            "description":"The unique identifier of the input expression for the rate dimension of a rate table.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InputExpressionName":{
            "title":"Input Expression Name",
            "maxLength":160,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The session login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanComponentId":{
            "type":"integer",
            "description":"The unique identifier of the plan component record within a business unit.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanComponentInputExpressionId":{
            "title":"Plan Component Input Expression Id",
            "type":"integer",
            "description":"The unique identifier of the input expression record for the plan component.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PlanComponentRateDimensionalInputsDeleteFlag":{
            "type":"boolean",
            "description":"Indicates whether the rate dimension input can be deleted.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-queryable":false
        },
        "RateDimName":{
            "title":"Dimension Name",
            "type":"integer",
            "description":"The name of the rate dimension. A rate table can have one or more rate dimensions.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RateDimSequence":{
            "title":"Sequence",
            "type":"integer",
            "description":"The order of the input expressions for the rate table.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SplitFlag":{
            "title":"Split",
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "default":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"
    }
}

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

ExpressionUsagesVO

Operation: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressionUsagesLOV

The expression usages list of values resource is used to view the list of expression usages which indicate where an expression can be used.

Back to Top